added: attributeFields map and globalId options, closes #41

Author: mickhansen

README.md

@@ -148,6 +148,8 @@ attributeFields(Model, {
   // ... options
   exclude: [], // array of model attributes to ignore - default: []
   only: [], // only generate definitions for these model attributes - default: null
+  globalId: true, // return an relay global id field - default: false
+  map: {} // rename fields - default: {}
 });
 
 /*

src/attributeFields.js

@@ -1,5 +1,6 @@
 import * as typeMapper from './typeMapper';
 import { GraphQLNonNull, GraphQLEnumType } from 'graphql';
+import { globalIdField } from 'graphql-relay';
 
 module.exports = function (Model, options) {
   options = options || {};
@@ -11,11 +12,15 @@ module.exports = function (Model, options) {
     var attribute = Model.rawAttributes[key]
       , type = attribute.type;
 
+    if (options.map && options.map[key]) {
+      key = options.map[key];
+    }
+
     memo[key] = {
       type: typeMapper.toGraphQL(type, Model.sequelize.constructor)
     };
 
-    if ( memo[key].type instanceof GraphQLEnumType ) {
+    if (memo[key].type instanceof GraphQLEnumType ) {
       memo[key].type.name = `${Model.name}${key}EnumType`;
     }
 
@@ -26,5 +31,9 @@ module.exports = function (Model, options) {
     return memo;
   }, {});
 
+  if (options.globalId) {
+    result.id = globalIdField(Model.name);
+  }
+
   return result;
 };

test/attributeFields.test.js

@@ -17,6 +17,10 @@ import {
   GraphQLList
 } from 'graphql';
 
+import {
+  toGlobalId
+} from 'graphql-relay';
+
 describe('attributeFields', function () {
   var Model;
   var modelName = Math.random().toString();
@@ -99,6 +103,29 @@ describe('attributeFields', function () {
     expect(Object.keys(fields)).to.deep.equal(['id', 'email', 'list']);
   });
 
+  it('should be possible to rename fields with map', function () {
+    var fields = attributeFields(Model, {
+      map: {
+        id: '_id'
+      }
+    });
+
+    expect(Object.keys(fields)).to.contain('_id');
+    expect(Object.keys(fields)).not.to.contain('id');
+  });
+
+  it('should be possible to automatically set a relay globalId', function () {
+    var fields = attributeFields(Model, {
+      globalId: true
+    });
+
+    expect(fields.id.resolve).to.be.ok;
+    expect(fields.id.type.ofType.name).to.equal('ID');
+    expect(fields.id.resolve({
+      id: 23
+    })).to.equal(toGlobalId(Model.name, 23));
+  });
+
   it('should automatically name enum types', function () {
     var fields = attributeFields(Model);