feat: add support for required properties

* feat: add support for required properties

* Add model with required fields

* Fix lint errors

Closes #144

Author: israelglar

flow-typed/npm/mongoose_v4.x.x.js

@@ -184,6 +184,7 @@ type Mongoose$SchemaField<Schema> = {
   options?: ?{
     description: ?string
   },
+  isRequired?: boolean,
   enumValues?: ?(string[]),
   schema?: Schema,
   _index?: ?{ [optionName: string]: mixed }

src/__mocks__/userModel.js

@@ -111,3 +111,15 @@ UserSchema.virtual('nameVirtual').get(function() {
 const UserModel = mongoose.model('User', UserSchema);
 
 export { UserSchema, UserModel };
+
+const UserRequiredSchema: SchemaType<any> = new Schema({
+  name: {
+    type: String,
+    description: 'Person name',
+    required: true,
+  },
+});
+
+const UserRequiredModel = mongoose.model('UserRequired', UserRequiredSchema);
+
+export { UserRequiredSchema, UserRequiredModel };

src/__tests__/fieldConverter-test.js

@@ -2,7 +2,7 @@
 /* eslint-disable no-unused-expressions, no-template-curly-in-string */
 
 import { EnumTypeComposer, schemaComposer } from 'graphql-compose';
-import { UserModel } from '../__mocks__/userModel';
+import { UserModel, UserRequiredModel } from '../__mocks__/userModel';
 import {
   deriveComplexType,
   getFieldsFromModel,
@@ -14,6 +14,7 @@ import {
   enumToGraphQL,
   documentArrayToGraphQL,
   referenceToGraphQL,
+  convertModelToGraphQL,
 } from '../fieldsConverter';
 import GraphQLMongoID from '../types/mongoid';
 
@@ -108,6 +109,13 @@ describe('fieldConverter', () => {
     });
   });
 
+  describe('convertFieldToGraphQL()', () => {
+    it('should set required field', () => {
+      const tc = convertModelToGraphQL(UserRequiredModel, 'UserRequired', schemaComposer);
+      expect(tc.isFieldNonNull('name')).toBeTruthy();
+    });
+  });
+
   describe('convertFieldToGraphQL()', () => {
     it('should convert any mongoose field to graphQL type', () => {
       const mongooseField = {

src/fieldsConverter.js

@@ -127,6 +127,7 @@ export function convertModelToGraphQL(
     return schemaComposer.getTC(model.schema);
   }
 
+  const requiredFields = [];
   const typeComposer = schemaComposer.getOrCreateTC(typeName);
   // $FlowFixMe await landing [email protected] or above
   schemaComposer.set(model.schema, typeComposer);
@@ -137,6 +138,11 @@ export function convertModelToGraphQL(
 
   Object.keys(mongooseFields).forEach(fieldName => {
     const mongooseField: MongooseFieldT = mongooseFields[fieldName];
+
+    if (mongooseField.isRequired) {
+      requiredFields.push(fieldName);
+    }
+
     graphqlFields[fieldName] = {
       type: convertFieldToGraphQL(mongooseField, typeName, schemaComposer),
       description: _getFieldDescription(mongooseField),
@@ -158,6 +164,7 @@ export function convertModelToGraphQL(
   });
 
   typeComposer.addFields(graphqlFields);
+  requiredFields.map(f => typeComposer.makeFieldNonNull(f));
   return typeComposer;
 }
 

src/utils/getIndexesFromModel.js

@@ -20,9 +20,9 @@ function isSpecificIndex(idx) {
 }
 
 /*
-* Get mongoose model, and return array of fields with indexes.
-*  MongooseModel  ->  [ { _id: 1 }, { name: 1, surname: -1 } ]
-*/
+ * Get mongoose model, and return array of fields with indexes.
+ *  MongooseModel  ->  [ { _id: 1 }, { name: 1, surname: -1 } ]
+ */
 export function getIndexesFromModel(
   mongooseModel: MongooseModel,
   opts: getIndexesFromModelOpts = {}