Pyrope is a Node.js promise-based ORM for GraphQL and AWS DynamoDB.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
lib
scripts
.babelrc
.env.test
.gitignore
.travis.yml
README.md
esdoc.json
package.json

README.md

Pyrope

Travis build Codecov coverage Documentation npm version npm licence semantic-release Commitizen friendly

Pyrope is a Node.js promise-based ORM for GraphQL and AWS DynamoDB.

Under development. Not intended for production use. Watch on github to be notified about new releases. Coming soon.

Introduction

This project came into being in response to a lack of solutions to manage AWS DynamoDB through GraphQL, specifically in a Serverless architecture.

Handy to use as resolvers to Queries and Mutations.

Use your existing GraphQL types and get out of the box:

  1. CRUD operations with automatic uuid, createdAt and updatedAt fields generated,
  2. object associations with destroy/nullify dependencies,
  3. interfaces (sort of type inheritance in GraphQL),
  4. cursors (for infinite scrolling or batch fetching),
  5. custom lifecycle hooks,
  6. validations,
  7. object counts.

Supports custom table names, as well as table prefix and suffixes (ie. for different environments/tenants).

Getting Started

Installation

$ npm install --save pyrope

Simple example

import { PyropeModel } from 'pyrope';
import {
  GraphQLObjectType,
  GraphQLString,
  GraphQLNonNull } from 'graphql';

const UserType = new GraphQLObjectType({
  name: 'User',
  description: 'A user in the system.',
  fields: () => ({
    uuid: {
      type: new GraphQLNonNull(GraphQLString),
      description: 'A unique string to identify a user.',
    },
    username: {
      type: new GraphQLNonNull(GraphQLString),
      description: 'The username',
    },
    hashedPassword: {
      type: GraphQLString,
      description: 'The hashed password to authenticate the user.',
    },
    createdAt: {
      type: GraphQLString,
    },
    updatedAt: {
      type: GraphQLString,
    }
  })
});

const User = new PyropeModel(UserType);
const beforeCreate = ( fields ) => new Promise((resolve, reject) => {
  encryptPassword(fields.password) // some encryption function
    .then(hashedPassword => {
      fields.hashedPassword = hashedPassword;
      delete(fields.password);
      
      resolve(fields)
    })
    .catch(err => reject(err));
});

const userFields = {
  username: 'John',
  password: 'secret',
};

User.create(userFields, {beforeCreate})
  .then(record => console.log(record))
  .catch(err => console.error(err));

// record saved to database 'users'
record = {
  uuid: 'ee1bf4f2-8b80-479e-868c-355dc2708532',
  username: 'John',
  hashedPassword: '$2a$10$30ITCecgzolVrlm...',
  createdAt: 1471991655503,
  updatedAt: 1471991655503,
}

Documentation

Check the ES6Docs here, the API and the tests.

More to come...

Gotchas

  • Table names are generated by Inflector.tableize(modelName) from Inflected package.
  • The default index key for each record is uuid
  • The association table name is generated by concatenating both table names with an underscore, in alphabetical order. ie, contacts_orgnaizations.

Roadmap

v1.0.0 Milestones

  • Query optimizations
  • Stress tests and look for data inconsistencies (ie. failed requests)
  • Optimize algorithms for associations
  • ORM with Prototype functions, ie. const john = new User(UserType); john.age(30); console.log(john.age());
  • Refactor and abstract PyropeRecord, PyropeModel and PyropeActions.
  • Implement FlowType

See issues.

MIT Licence

Copyright (c) 2016 Sergio del Rio

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.