Merge pull request #107 from mernxl/mongoose-discriminantors

Mongoose discriminantors, composeWithMongooseDiscriminators

Author: nodkz

.babelrc

@@ -6,6 +6,7 @@
   "env": {
     "cjs": {
       "plugins": [
+        "transform-class-properties",
         ["transform-runtime", { "polyfill": false }]
       ],
       "presets": [
@@ -17,6 +18,7 @@
       ]
     },
     "mjs": {
+      "plugins": ["transform-class-properties"],
       "presets": [
         [
           "env",
@@ -31,9 +33,11 @@
       ]
     },
     "es": {
+      "plugins": ["transform-class-properties"],
     },
     "node8": {
       "plugins": [
+        "transform-class-properties",
         ["transform-runtime", { "polyfill": false }]
       ],
       "presets": [
@@ -47,6 +51,9 @@
       ]
     },
     "test": {
+      "plugins": [
+        "transform-class-properties",
+      ],
       "presets": [
         ["env", {
           "targets": {

.travis.yml

@@ -10,9 +10,6 @@ notifications:
 node_js:
   - "9"
   - "8"
-before_install: yarn global add greenkeeper-lockfile@1
-before_script: greenkeeper-lockfile-update
-after_script: greenkeeper-lockfile-upload
 script:
   - yarn run test
   - yarn run build

README.md

@@ -92,9 +92,9 @@ const User = mongoose.model('User', UserSchema);
 const customizationOptions = {}; // left it empty for simplicity, described below
 const UserTC = composeWithMongoose(User, customizationOptions);
 
-// STEP 3: CREATE CRAZY GraphQL SCHEMA WITH ALL CRUD USER OPERATIONS
+// STEP 3: Add needed CRUD User operations to the GraphQL Schema
 // via graphql-compose it will be much much easier, with less typing
-schemaComposer.rootQuery().addFields({
+schemaComposer.Query.addFields({
   userById: UserTC.getResolver('findById'),
   userByIds: UserTC.getResolver('findByIds'),
   userOne: UserTC.getResolver('findOne'),
@@ -104,7 +104,7 @@ schemaComposer.rootQuery().addFields({
   userPagination: UserTC.getResolver('pagination'),
 });
 
-schemaComposer.rootMutation().addFields({
+schemaComposer.Mutation.addFields({
   userCreate: UserTC.getResolver('createOne'),
   userUpdateById: UserTC.getResolver('updateById'),
   userUpdateOne: UserTC.getResolver('updateOne'),
@@ -122,6 +122,126 @@ You think that is to much code?
 I don't think so, because by default internally was created about 55 graphql types (for input, sorting, filtering). So you will need much much more lines of code to implement all these CRUD operations by hands.
 
 
+### Working with Mongoose Collection Level Discriminators
+Variable Namings
+* `...DTC` - Suffix for a `DiscriminatorTypeComposer` instance, which is also an instance of `TypeComposer`. All fields and Relations manipulations on this instance affects all registered discriminators and the Discriminator Interface.
+
+```js
+  import mongoose from 'mongoose';
+  import { schemaComposer } from 'graphql-compose';
+  import { composeWithMongooseDiscriminators } from 'graphql-compose-mongoose';
+
+  // pick a discriminatorKey
+  const DKey = 'type';
+
+  const enumCharacterType = {
+    PERSON: 'Person',
+    DROID: 'Droid',
+  };
+
+  // DEFINE BASE SCHEMA
+  const CharacterSchema = new mongoose.Schema({
+    // _id: field...
+    type: {
+      type: String,
+      require: true,
+      enum: (Object.keys(enumCharacterType): Array<string>),
+      description: 'Character type Droid or Person',
+    },
+
+    name: String,
+    height: Number,
+    mass: Number,
+    films: [String],
+  });
+
+  // DEFINE DISCRIMINATOR SCHEMAS
+  const DroidSchema = new mongoose.Schema({
+    makeDate: String,
+    primaryFunction: [String],
+  });
+
+  const PersonSchema = new mongoose.Schema({
+    gender: String,
+    hairColor: String,
+    starships: [String],
+  });
+
+  // set discriminator Key
+  CharacterSchema.set('discriminatorKey', DKey);
+
+  // create base Model
+  const CharacterModel = mongoose.model('Character', CharacterSchema);
+
+  // create mongoose discriminator models
+  const DroidModel = CharacterModel.discriminator(enumCharacterType.DROID, DroidSchema);
+  const PersonModel = CharacterModel.discriminator(enumCharacterType.PERSON, PersonSchema);
+
+  // create DiscriminatorTypeComposer
+  const baseOptions = { // regular TypeConverterOptions, passed to composeWithMongoose
+    fields: {
+      remove: ['friends'],
+    }
+  }
+  const CharacterDTC = composeWithMongooseDiscriminators(CharacterModel, baseOptions);
+
+  // create Discriminator Types
+  const droidTypeConverterOptions = {  // this options will be merged with baseOptions -> customisationsOptions
+    fields: {
+      remove: ['makeDate'],
+    }
+  };
+  const DroidTC = CharacterDTC.discriminator(DroidModel, droidTypeConverterOptions);
+  const PersonTC = CharacterDTC.discriminator(PersonModel);  // baseOptions -> customisationsOptions applied
+
+  // You may now use CharacterDTC to add fields to all Discriminators
+  // Use DroidTC, `PersonTC as any other TypeComposer.
+  schemaComposer.Mutation.addFields({
+    droidCreate: DroidTC.getResolver('createOne'),
+    personCreate: PersonTC.getResolver('createOne'),
+  });
+
+  const schema = schemaComposer.buildSchema();
+
+  describe('createOne', () => {
+    it('should create child document without specifying DKey', async () => {
+      const res = await graphql.graphql(
+        schema,
+        `mutation CreateCharacters {
+          droidCreate(record: {name: "Queue XL", modelNumber: 360 }) {
+            record {
+              __typename
+              type
+              name
+              modelNumber
+            }
+          }
+
+          personCreate(record: {name: "mernxl", dob: 57275272}) {
+            record {
+              __typename
+              type
+              name
+              dob
+            }
+          }
+        }`
+      );
+
+      expect(res).toEqual({
+        data: {
+          droidCreate: {
+            record: { __typename: 'Droid', type: 'Droid', name: 'Queue XL', modelNumber: 360 },
+          },
+          personCreate: {
+            record: { __typename: 'Person', type: 'Person', name: 'mernxl', dob: 57275272 },
+          },
+        },
+      });
+    });
+  });
+```
+
 ## FAQ
 
 ### Can I get generated vanilla GraphQL types?
@@ -273,7 +393,7 @@ The typical implementation may be like this:
 // extend resolve params with hook
 rp.beforeRecordMutate = async function(doc, rp) {
   doc.userTouchedAt = new Date();
-  
+
   const canMakeUpdate  = await performAsyncTask( ...provide data from doc... )
   if (!canMakeUpdate) {
     throw new Error('Forbidden!');
@@ -304,7 +424,7 @@ function adminAccess(resolvers) {
 
       // extend resolve params with hook
       rp.beforeRecordMutate = async function(doc, rp) { ... }
-      
+
       return next(rp)
     })
   })
@@ -465,4 +585,3 @@ This plugin adds `pagination` resolver.
 
 ## License
 [MIT](https://github.com/graphql-compose/graphql-compose-mongoose/blob/master/LICENSE.md)
-

flow-typed/npm/babel-cli_vx.x.x.js

@@ -1,5 +1,5 @@
-// flow-typed signature: adfc416d3944bc9e0c30c54aa3ad632b
-// flow-typed version: <<STUB>>/babel-cli_v^6.26.0/flow_v0.54.1
+// flow-typed signature: 40ac71f9403783e7957989cfd3c8695f
+// flow-typed version: <<STUB>>/babel-cli_v^6.26.0/flow_v0.76.0
 
 /**
  * This is an autogenerated libdef stub for: