fixed some code for #132 (withObjectType)

Author: Code-Hex

src/config.ts

@@ -194,7 +194,8 @@ export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
    */
   directives?: DirectiveConfig;
   /**
-   * @description Converts the regular graphql type into a zod validation function.
+   * @description Generates validation schema with graphql type objects.
+   * but excludes "Query", "Mutation", "Subscription" objects.
    *
    * @exampleMarkdown
    * ```yml
@@ -207,8 +208,8 @@ export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
    *       - graphql-codegen-validation-schema
    *     config:
    *       schema: yup
-   *       useObjectTypes: true
+   *       withObjectType: true
    * ```
    */
-  useObjectTypes?: boolean;
+  withObjectType?: boolean;
 }

src/graphql.ts

@@ -1,7 +1,22 @@
-import { ListTypeNode, NonNullTypeNode, NamedTypeNode, TypeNode } from 'graphql';
+import { ListTypeNode, NonNullTypeNode, NamedTypeNode, TypeNode, ObjectTypeDefinitionNode } from 'graphql';
 
 export const isListType = (typ?: TypeNode): typ is ListTypeNode => typ?.kind === 'ListType';
 export const isNonNullType = (typ?: TypeNode): typ is NonNullTypeNode => typ?.kind === 'NonNullType';
 export const isNamedType = (typ?: TypeNode): typ is NamedTypeNode => typ?.kind === 'NamedType';
 
 export const isInput = (kind: string) => kind.includes('Input');
+
+type ObjectTypeDefinitionFn = (node: ObjectTypeDefinitionNode) => any;
+
+export const ObjectTypeDefinitionBuilder = (
+  useObjectTypes: boolean | undefined,
+  callback: ObjectTypeDefinitionFn
+): ObjectTypeDefinitionFn | undefined => {
+  if (!useObjectTypes) return undefined;
+  return node => {
+    if (/^Query|Mutation|Subscription$/.test(node.name.value)) {
+      return;
+    }
+    return callback(node);
+  };
+};

src/myzod/index.ts

@@ -1,4 +1,4 @@
-import { isInput, isNonNullType, isListType, isNamedType } from './../graphql';
+import { isInput, isNonNullType, isListType, isNamedType, ObjectTypeDefinitionBuilder } from './../graphql';
 import { ValidationSchemaPluginConfig } from '../config';
 import {
   InputValueDefinitionNode,
@@ -49,8 +49,7 @@ export const MyZodSchemaVisitor = (schema: GraphQLSchema, config: ValidationSche
         .withName(`${name}Schema(): myzod.Type<${name}>`)
         .withBlock([indent(`return myzod.object({`), shape, indent('})')].join('\n')).string;
     },
-    ObjectTypeDefinition: (node: ObjectTypeDefinitionNode) => {
-      if (!config.useObjectTypes) return;
+    ObjectTypeDefinition: ObjectTypeDefinitionBuilder(config.withObjectType, (node: ObjectTypeDefinitionNode) => {
       const name = tsVisitor.convertName(node.name.value);
       importTypes.push(name);
 
@@ -69,7 +68,7 @@ export const MyZodSchemaVisitor = (schema: GraphQLSchema, config: ValidationSche
             indent('})'),
           ].join('\n')
         ).string;
-    },
+    }),
     EnumTypeDefinition: (node: EnumTypeDefinitionNode) => {
       const enumname = tsVisitor.convertName(node.name.value);
       importTypes.push(enumname);

src/yup/index.ts

@@ -1,4 +1,4 @@
-import { isInput, isNonNullType, isListType, isNamedType } from './../graphql';
+import { isInput, isNonNullType, isListType, isNamedType, ObjectTypeDefinitionBuilder } from './../graphql';
 import { ValidationSchemaPluginConfig } from '../config';
 import {
   InputValueDefinitionNode,
@@ -41,8 +41,7 @@ export const YupSchemaVisitor = (schema: GraphQLSchema, config: ValidationSchema
         .withName(`${name}Schema(): yup.SchemaOf<${name}>`)
         .withBlock([indent(`return yup.object({`), shape, indent('})')].join('\n')).string;
     },
-    ObjectTypeDefinition: (node: ObjectTypeDefinitionNode) => {
-      if (!config.useObjectTypes) return;
+    ObjectTypeDefinition: ObjectTypeDefinitionBuilder(config.withObjectType, (node: ObjectTypeDefinitionNode) => {
       const name = tsVisitor.convertName(node.name.value);
       importTypes.push(name);
 
@@ -59,7 +58,7 @@ export const YupSchemaVisitor = (schema: GraphQLSchema, config: ValidationSchema
             indent('})'),
           ].join('\n')
         ).string;
-    },
+    }),
     EnumTypeDefinition: (node: EnumTypeDefinitionNode) => {
       const enumname = tsVisitor.convertName(node.name.value);
       importTypes.push(enumname);

src/zod/index.ts

@@ -1,4 +1,4 @@
-import { isInput, isNonNullType, isListType, isNamedType } from './../graphql';
+import { isInput, isNonNullType, isListType, isNamedType, ObjectTypeDefinitionBuilder } from './../graphql';
 import { ValidationSchemaPluginConfig } from '../config';
 import {
   InputValueDefinitionNode,
@@ -63,8 +63,7 @@ export const ZodSchemaVisitor = (schema: GraphQLSchema, config: ValidationSchema
         .withName(`${name}Schema(): z.ZodObject<Properties<${name}>>`)
         .withBlock([indent(`return z.object({`), shape, indent('})')].join('\n')).string;
     },
-    ObjectTypeDefinition: (node: ObjectTypeDefinitionNode) => {
-      if (!config.useObjectTypes) return;
+    ObjectTypeDefinition: ObjectTypeDefinitionBuilder(config.withObjectType, (node: ObjectTypeDefinitionNode) => {
       const name = tsVisitor.convertName(node.name.value);
       importTypes.push(name);
 
@@ -81,7 +80,7 @@ export const ZodSchemaVisitor = (schema: GraphQLSchema, config: ValidationSchema
             indent('})'),
           ].join('\n')
         ).string;
-    },
+    }),
     EnumTypeDefinition: (node: EnumTypeDefinitionNode) => {
       const enumname = tsVisitor.convertName(node.name.value);
       importTypes.push(enumname);

tests/myzod.spec.ts

@@ -411,7 +411,7 @@ describe('myzod', () => {
     });
   });
 
-  describe('GraphQl Type Support', () => {
+  describe('with withObjectType', () => {
     const schema = buildSchema(/* GraphQL */ `
       input ScalarsInput {
         date: Date!
@@ -431,9 +431,21 @@ describe('myzod', () => {
         isMember: Boolean
         createdAt: Date!
       }
+
+      type Mutation {
+        _empty: String
+      }
+
+      type Query {
+        _empty: String
+      }
+
+      type Subscription {
+        _empty: String
+      }
     `);
 
-    it('not generate if useObjectTypes false', async () => {
+    it('not generate if withObjectType false', async () => {
       const result = await plugin(
         schema,
         [],
@@ -451,7 +463,7 @@ describe('myzod', () => {
         [],
         {
           schema: 'myzod',
-          useObjectTypes: true,
+          withObjectType: true,
           scalarSchemas: {
             Date: 'myzod.date()',
             Email: 'myzod.string().email()',
@@ -464,7 +476,7 @@ describe('myzod', () => {
         'export const definedNonNullAnySchema = myzod.object({});',
         'export function ScalarsInputSchema(): myzod.Type<ScalarsInput> {',
         'date: myzod.date(),',
-        'email: myzod.string().email().optional().nullable()',
+        'email: myzod.string().email().optional().nullable(),',
         // User Create Input
         'export function UserCreateInputSchema(): myzod.Type<UserCreateInput> {',
         'name: myzod.string(),',
@@ -482,6 +494,10 @@ describe('myzod', () => {
       for (const wantContain of wantContains) {
         expect(result.content).toContain(wantContain);
       }
+
+      for (const wantNotContain of ['Query', 'Mutation', 'Subscription']) {
+        expect(result.content).not.toContain(wantNotContain);
+      }
     });
   });
 });

tests/yup.spec.ts

@@ -313,7 +313,7 @@ describe('yup', () => {
     expect(result.prepend).toContain("import { SayI } from './types'");
     expect(result.content).toContain('export function SayISchema(): yup.SchemaOf<SayI> {');
   });
-  describe('GraphQl Type Support', () => {
+  describe('with withObjectType', () => {
     const schema = buildSchema(/* GraphQL */ `
       input ScalarsInput {
         date: Date!
@@ -333,9 +333,21 @@ describe('yup', () => {
         isMember: Boolean
         createdAt: Date!
       }
+
+      type Mutation {
+        _empty: String
+      }
+
+      type Query {
+        _empty: String
+      }
+
+      type Subscription {
+        _empty: String
+      }
     `);
 
-    it('not generate if useObjectTypes false', async () => {
+    it('not generate if withObjectType false', async () => {
       const result = await plugin(
         schema,
         [],
@@ -347,13 +359,13 @@ describe('yup', () => {
       expect(result.content).not.toContain('export function UserSchema(): yup.SchemaOf<User> {');
     });
 
-    it('generate both input & type if useObjectTypes true', async () => {
+    it('generate both input & type if withObjectType true', async () => {
       const result = await plugin(
         schema,
         [],
         {
           schema: 'yup',
-          useObjectTypes: true,
+          withObjectType: true,
           scalarSchemas: {
             Date: 'yup.date()',
             Email: 'yup.string().email()',
@@ -365,25 +377,29 @@ describe('yup', () => {
         // ScalarsInput
         'export function ScalarsInputSchema(): yup.SchemaOf<ScalarsInput> {',
         'return yup.object({',
-        'date: yup.date().defined()',
+        'date: yup.date().defined(),',
         'email: yup.string().email()',
         // User Create Input
         'export function UserCreateInputSchema(): yup.SchemaOf<UserCreateInput> {',
-        'name: yup.string().defined()',
+        'name: yup.string().defined(),',
         'email: yup.string().email().defined()',
         // User
         'export function UserSchema(): yup.SchemaOf<User> {',
-        "__typename: yup.mixed().oneOf(['User', undefined])",
-        'id: yup.string().defined()',
-        'name: yup.string()',
-        'age: yup.number()',
-        'isMember: yup.boolean()',
-        'email: yup.string().email()',
+        "__typename: yup.mixed().oneOf(['User', undefined]),",
+        'id: yup.string().defined(),',
+        'name: yup.string(),',
+        'age: yup.number(),',
+        'isMember: yup.boolean(),',
+        'email: yup.string().email(),',
         'createdAt: yup.date().defined()',
       ];
       for (const wantContain of wantContains) {
         expect(result.content).toContain(wantContain);
       }
+
+      for (const wantNotContain of ['Query', 'Mutation', 'Subscription']) {
+        expect(result.content).not.toContain(wantNotContain);
+      }
     });
   });
 });

tests/zod.spec.ts

@@ -476,7 +476,7 @@ describe('zod', () => {
       }
     });
   });
-  describe('GraphQl Type Support', () => {
+  describe('with withObjectType', () => {
     const schema = buildSchema(/* GraphQL */ `
       input ScalarsInput {
         date: Date!
@@ -496,9 +496,21 @@ describe('zod', () => {
         isMember: Boolean
         createdAt: Date!
       }
+
+      type Mutation {
+        _empty: String
+      }
+
+      type Query {
+        _empty: String
+      }
+
+      type Subscription {
+        _empty: String
+      }
     `);
 
-    it('not generate if useObjectTypes false', async () => {
+    it('not generate if withObjectType false', async () => {
       const result = await plugin(
         schema,
         [],
@@ -516,7 +528,7 @@ describe('zod', () => {
         [],
         {
           schema: 'zod',
-          useObjectTypes: true,
+          withObjectType: true,
           scalarSchemas: {
             Date: 'z.date()',
             Email: 'z.string().email()',
@@ -528,25 +540,29 @@ describe('zod', () => {
         // ScalarsInput
         'export function ScalarsInputSchema(): z.ZodObject<Properties<ScalarsInput>> {',
         'return z.object({',
-        'date: z.date()',
+        'date: z.date(),',
         'email: z.string().email().nullish()',
         // User Create Input
         'export function UserCreateInputSchema(): z.ZodObject<Properties<UserCreateInput>> {',
-        'name: z.string()',
+        'name: z.string(),',
         'email: z.string().email()',
         // User
         'export function UserSchema(): z.ZodObject<Properties<User>> {',
         "__typename: z.literal('User').optional()",
-        'id: z.string()',
+        'id: z.string(),',
         'name: z.string().nullish(),',
-        'age: z.number().nullish()',
-        'isMember: z.boolean().nullish()',
-        'email: z.string().email().nullish()',
+        'age: z.number().nullish(),',
+        'isMember: z.boolean().nullish(),',
+        'email: z.string().email().nullish(),',
         'createdAt: z.date()',
       ];
       for (const wantContain of wantContains) {
         expect(result.content).toContain(wantContain);
       }
+
+      for (const wantNotContain of ['Query', 'Mutation', 'Subscription']) {
+        expect(result.content).not.toContain(wantNotContain);
+      }
     });
   });
 });