feat(InputTypeComposer): add makeFieldNonNull and `makeFieldNullabl…

…e` methods This methods have such names due similar naming with TypeComposer. Old methods `makeRequired` and `makeOptional` made as aliases and will continue to work.
graphql-compose · Apr 27, 2018 · a08152f · a08152f
1 parent 8867567
commit a08152f
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 5 deletions.
diff --git a/src/InputTypeComposer.d.ts b/src/InputTypeComposer.d.ts
@@ -83,6 +83,9 @@ export class InputTypeComposer {
 
     public reorderFields(names: string[]): this;
 
+    public isFieldNonNull(fieldName: string): boolean ;
+
+    // alias for isFieldNonNull
     public isRequired(fieldName: string): boolean;
 
     public getFieldConfig(fieldName: string): GraphQLInputFieldConfig;
@@ -91,8 +94,14 @@ export class InputTypeComposer {
 
     public getFieldTC(fieldName: string): InputTypeComposer;
 
+    public makeFieldNonNull(fieldNameOrArray: string | string[]): this;
+
+    // alias for makeFieldNonNull
     public makeRequired(fieldNameOrArray: string | string[]): this;
 
+    public makeFieldNullable(fieldNameOrArray: string | string[]): this;
+
+    // alias for makeFieldNullable
     public makeOptional(fieldNameOrArray: string | string[]): this;
 
     public clone(newTypeName: string): InputTypeComposer;

diff --git a/src/InputTypeComposer.js b/src/InputTypeComposer.js
@@ -246,10 +246,15 @@ export class InputTypeComposer {
     return this;
   }
 
-  isRequired(fieldName: string): boolean {
+  isFieldNonNull(fieldName: string): boolean {
     return this.getFieldType(fieldName) instanceof GraphQLNonNull;
   }
 
+  // alias for isFieldNonNull
+  isRequired(fieldName: string): boolean {
+    return this.isFieldNonNull(fieldName);
+  }
+
   getFieldConfig(fieldName: string): GraphQLInputFieldConfig {
     const fc = this.getField(fieldName);
     if (!fc) {
@@ -279,7 +284,7 @@ export class InputTypeComposer {
     return this.constructor.schemaComposer.InputTypeComposer.createTemp(fieldType);
   }
 
-  makeRequired(fieldNameOrArray: string | Array<string>): InputTypeComposer {
+  makeFieldNonNull(fieldNameOrArray: string | Array<string>): InputTypeComposer {
     const fieldNames = Array.isArray(fieldNameOrArray) ? fieldNameOrArray : [fieldNameOrArray];
     fieldNames.forEach(fieldName => {
       if (this.hasField(fieldName)) {
@@ -292,7 +297,12 @@ export class InputTypeComposer {
     return this;
   }
 
-  makeOptional(fieldNameOrArray: string | Array<string>): InputTypeComposer {
+  // alias for makeFieldNonNull
+  makeRequired(fieldNameOrArray: string | Array<string>): InputTypeComposer {
+    return this.makeFieldNonNull(fieldNameOrArray);
+  }
+
+  makeFieldNullable(fieldNameOrArray: string | Array<string>): InputTypeComposer {
     const fieldNames = Array.isArray(fieldNameOrArray) ? fieldNameOrArray : [fieldNameOrArray];
     fieldNames.forEach(fieldName => {
       if (this.hasField(fieldName)) {
@@ -305,6 +315,10 @@ export class InputTypeComposer {
     return this;
   }
 
+  makeOptional(fieldNameOrArray: string | Array<string>): InputTypeComposer {
+    return this.makeFieldNullable(fieldNameOrArray);
+  }
+
   clone(newTypeName: string): InputTypeComposer {
     if (!newTypeName) {
       throw new Error('You should provide new type name for clone() method');

diff --git a/src/__tests__/InputTypeComposer-test.js b/src/__tests__/InputTypeComposer-test.js
@@ -193,16 +193,40 @@ describe('InputTypeComposer', () => {
     });
 
     it('isRequired()', () => {
+      itc.setField('input1', 'String');
       expect(itc.isRequired('input1')).toBe(false);
+      itc.setField('input1', 'String!');
+      expect(itc.isRequired('input1')).toBe(true);
     });
 
-    it('makeRequired()', () => {
-      itc.makeRequired('input1');
+    it('isFieldNonNull()', () => {
+      itc.setField('input1', 'String');
+      expect(itc.isFieldNonNull('input1')).toBe(false);
+      itc.setField('input1', 'String!');
+      expect(itc.isFieldNonNull('input1')).toBe(true);
+    });
+
+    it('makeFieldNonNull()', () => {
+      itc.makeFieldNonNull('input1');
       expect(itc.getFieldType('input1')).toBeInstanceOf(GraphQLNonNull);
       expect((itc.getFieldType('input1'): any).ofType).toBe(GraphQLString);
+      expect(itc.isFieldNonNull('input1')).toBe(true);
       expect(itc.isRequired('input1')).toBe(true);
     });
 
+    it('makeRequired()', () => {
+      itc.setField('input1', 'String');
+      itc.makeRequired('input1');
+      expect(itc.isFieldNonNull('input1')).toBe(true);
+    });
+
+    it('makeFieldNullable()', () => {
+      itc.makeFieldNonNull('input1');
+      expect(itc.isFieldNonNull('input1')).toBe(true);
+      itc.makeFieldNullable('input1');
+      expect(itc.isFieldNonNull('input1')).toBe(false);
+    });
+
     it('makeOptional()', () => {
       itc.makeRequired('input1');
       expect(itc.isRequired('input1')).toBe(true);