Merge pull request #609 from Code-Hex/issue-474

Add support for InterfaceTypeDefinition (resolved conflict)

Author: Code-Hex

Diff for: codegen.yml

@@ -13,6 +13,7 @@ generates:
           schema: yup
           importFrom: ../types
           withObjectType: true
+          withInterfaceType: true
           directives:
             required:
               msg: required
@@ -49,6 +50,7 @@ generates:
           schema: zod
           importFrom: ../types
           withObjectType: true
+          withInterfaceType: true
           directives:
             # Write directives like
             #
@@ -72,6 +74,7 @@ generates:
           schema: myzod
           importFrom: ../types
           withObjectType: true
+          withInterfaceType: true
           directives:
             constraint:
               minLength: min

Diff for: example/myzod/schemas.ts

@@ -1,5 +1,5 @@
 import * as myzod from 'myzod'
-import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, PageInput, PageType, User } from '../types'
+import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, Namer, PageInput, PageType, User } from '../types'
 
 export const definedNonNullAnySchema = myzod.object({});
 
@@ -92,6 +92,12 @@ export function MyTypeFooArgsSchema(): myzod.Type<MyTypeFooArgs> {
   })
 }
 
+export function NamerSchema(): myzod.Type<Namer> {
+  return myzod.object({
+    name: myzod.string().optional().nullable()
+  })
+}
+
 export function PageInputSchema(): myzod.Type<PageInput> {
   return myzod.object({
     attributes: myzod.array(myzod.lazy(() => AttributeInputSchema())).optional().nullable(),

Diff for: example/test.graphql

@@ -15,7 +15,7 @@ type Guest {
 
 union UserKind = Admin | Guest
 
-type User {
+type User implements Namer {
   id: ID
   name: String
   email: String
@@ -25,6 +25,10 @@ type User {
   updatedAt: Date
 }
 
+interface Namer {
+  name: String
+}
+
 input PageInput {
   id: ID!
   title: String!

Diff for: example/types.ts

@@ -91,6 +91,10 @@ export type MyTypeFooArgs = {
   d: Scalars['Float']['input'];
 };
 
+export type Namer = {
+  name?: Maybe<Scalars['String']['output']>;
+};
+
 export type PageInput = {
   attributes?: InputMaybe<Array<AttributeInput>>;
   date?: InputMaybe<Scalars['Date']['input']>;
@@ -112,7 +116,7 @@ export enum PageType {
   Service = 'SERVICE'
 }
 
-export type User = {
+export type User = Namer & {
   __typename?: 'User';
   createdAt?: Maybe<Scalars['Date']['output']>;
   email?: Maybe<Scalars['String']['output']>;

Diff for: example/yup/schemas.ts

@@ -1,5 +1,5 @@
 import * as yup from 'yup'
-import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, PageInput, PageType, User, UserKind } from '../types'
+import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, Namer, PageInput, PageType, User, UserKind } from '../types'
 
 export const ButtonComponentTypeSchema = yup.string<ButtonComponentType>().oneOf(Object.values(ButtonComponentType)).defined();
 
@@ -96,6 +96,12 @@ export function MyTypeFooArgsSchema(): yup.ObjectSchema<MyTypeFooArgs> {
   })
 }
 
+export function NamerSchema(): yup.ObjectSchema<Namer> {
+  return yup.object({
+    name: yup.string().defined().nullable().optional()
+  })
+}
+
 export function PageInputSchema(): yup.ObjectSchema<PageInput> {
   return yup.object({
     attributes: yup.array(yup.lazy(() => AttributeInputSchema().nonNullable())).defined().nullable().optional(),

Diff for: example/zod/schemas.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, PageInput, PageType, User } from '../types'
+import { Admin, AttributeInput, ButtonComponentType, ComponentInput, DropDownComponentInput, EventArgumentInput, EventInput, EventOptionType, Guest, HttpInput, HttpMethod, LayoutInput, MyType, MyTypeFooArgs, Namer, PageInput, PageType, User } from '../types'
 
 type Properties<T> = Required<{
   [K in keyof T]: z.ZodType<T[K], any, T[K]>;
@@ -100,6 +100,12 @@ export function MyTypeFooArgsSchema(): z.ZodObject<Properties<MyTypeFooArgs>> {
   })
 }
 
+export function NamerSchema(): z.ZodObject<Properties<Namer>> {
+  return z.object({
+    name: z.string().nullish()
+  })
+}
+
 export function PageInputSchema(): z.ZodObject<Properties<PageInput>> {
   return z.object({
     attributes: z.array(z.lazy(() => AttributeInputSchema())).nullish(),

Diff for: src/config.ts

@@ -194,6 +194,24 @@ export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
    * ```
    */
   withObjectType?: boolean
+  /**
+   * @description Generates validation schema with GraphQL type interfaces.
+   *
+   * @exampleMarkdown
+   * ```yml
+   * generates:
+   *   path/to/types.ts:
+   *     plugins:
+   *       - typescript
+   *   path/to/schemas.ts:
+   *     plugins:
+   *       - graphql-codegen-validation-schema
+   *     config:
+   *       schema: yup
+   *       withInterfaceType: true
+   * ```
+   */
+  withInterfaceType?: boolean
   /**
    * @description Specify validation schema export type.
    * @default function

Diff for: src/graphql.ts

@@ -4,6 +4,7 @@ import type {
   DefinitionNode,
   DocumentNode,
   GraphQLSchema,
+  InterfaceTypeDefinitionNode,
   ListTypeNode,
   NameNode,
   NamedTypeNode,
@@ -23,6 +24,7 @@ export const isNamedType = (typ?: TypeNode): typ is NamedTypeNode => typ?.kind =
 export const isInput = (kind: string) => kind.includes('Input');
 
 type ObjectTypeDefinitionFn = (node: ObjectTypeDefinitionNode) => any;
+type InterfaceTypeDefinitionFn = (node: InterfaceTypeDefinitionNode) => any;
 
 export function ObjectTypeDefinitionBuilder(useObjectTypes: boolean | undefined, callback: ObjectTypeDefinitionFn): ObjectTypeDefinitionFn | undefined {
   if (!useObjectTypes)
@@ -35,6 +37,14 @@ export function ObjectTypeDefinitionBuilder(useObjectTypes: boolean | undefined,
   };
 }
 
+export function InterfaceTypeDefinitionBuilder(useInterfaceTypes: boolean | undefined, callback: InterfaceTypeDefinitionFn): InterfaceTypeDefinitionFn | undefined {
+  if (!useInterfaceTypes)
+    return undefined;
+  return (node) => {
+    return callback(node);
+  };
+}
+
 export function topologicalSortAST(schema: GraphQLSchema, ast: DocumentNode): DocumentNode {
   const dependencyGraph = new Graph();
   const targetKinds = [

Diff for: src/myzod/index.ts

@@ -5,6 +5,7 @@ import type {
   GraphQLSchema,
   InputObjectTypeDefinitionNode,
   InputValueDefinitionNode,
+  InterfaceTypeDefinitionNode,
   NameNode,
   ObjectTypeDefinitionNode,
   TypeNode,
@@ -18,7 +19,14 @@ import type { ValidationSchemaPluginConfig } from '../config';
 import { buildApi, formatDirectiveConfig } from '../directive';
 import { BaseSchemaVisitor } from '../schema_visitor';
 import type { Visitor } from '../visitor';
-import { ObjectTypeDefinitionBuilder, isInput, isListType, isNamedType, isNonNullType } from './../graphql';
+import {
+  InterfaceTypeDefinitionBuilder,
+  ObjectTypeDefinitionBuilder,
+  isInput,
+  isListType,
+  isNamedType,
+  isNonNullType,
+} from './../graphql';
 
 const anySchema = `definedNonNullAnySchema`;
 
@@ -53,6 +61,44 @@ export class MyZodSchemaVisitor extends BaseSchemaVisitor {
     };
   }
 
+  get InterfaceTypeDefinition() {
+    return {
+      leave: InterfaceTypeDefinitionBuilder(this.config.withInterfaceType, (node: InterfaceTypeDefinitionNode) => {
+        const visitor = this.createVisitor('output');
+        const name = visitor.convertName(node.name.value);
+        this.importTypes.push(name);
+
+        // Building schema for field arguments.
+        const argumentBlocks = this.buildTypeDefinitionArguments(node, visitor);
+        const appendArguments = argumentBlocks ? `\n${argumentBlocks}` : '';
+
+        // Building schema for fields.
+        const shape = node.fields?.map(field => generateFieldMyZodSchema(this.config, visitor, field, 2)).join(',\n');
+
+        switch (this.config.validationSchemaExportType) {
+          case 'const':
+            return (
+              new DeclarationBlock({})
+                .export()
+                .asKind('const')
+                .withName(`${name}Schema: myzod.Type<${name}>`)
+                .withContent([`myzod.object({`, shape, '})'].join('\n')).string + appendArguments
+            );
+
+          case 'function':
+          default:
+            return (
+              new DeclarationBlock({})
+                .export()
+                .asKind('function')
+                .withName(`${name}Schema(): myzod.Type<${name}>`)
+                .withBlock([indent(`return myzod.object({`), shape, indent('})')].join('\n')).string + appendArguments
+            );
+        }
+      }),
+    };
+  }
+
   get ObjectTypeDefinition() {
     return {
       leave: ObjectTypeDefinitionBuilder(this.config.withObjectType, (node: ObjectTypeDefinitionNode) => {
@@ -61,7 +107,7 @@ export class MyZodSchemaVisitor extends BaseSchemaVisitor {
         this.importTypes.push(name);
 
         // Building schema for field arguments.
-        const argumentBlocks = this.buildObjectTypeDefinitionArguments(node, visitor);
+        const argumentBlocks = this.buildTypeDefinitionArguments(node, visitor);
         const appendArguments = argumentBlocks ? `\n${argumentBlocks}` : '';
 
         // Building schema for fields.
@@ -266,6 +312,7 @@ function generateNameNodeMyZodSchema(config: ValidationSchemaPluginConfig, visit
   const converter = visitor.getNameNodeConverter(node);
 
   switch (converter?.targetKind) {
+    case 'InterfaceTypeDefinition':
     case 'InputObjectTypeDefinition':
     case 'ObjectTypeDefinition':
     case 'UnionTypeDefinition':
@@ -279,7 +326,12 @@ function generateNameNodeMyZodSchema(config: ValidationSchemaPluginConfig, visit
       }
     case 'EnumTypeDefinition':
       return `${converter.convertName()}Schema`;
+    case 'ScalarTypeDefinition':
+      return myzod4Scalar(config, visitor, node.value);
     default:
+      if (converter?.targetKind)
+        console.warn('Unknown target kind', converter.targetKind);
+
       return myzod4Scalar(config, visitor, node.value);
   }
 }

Diff for: src/schema_visitor.ts

@@ -1,4 +1,10 @@
-import type { FieldDefinitionNode, GraphQLSchema, InputValueDefinitionNode, ObjectTypeDefinitionNode } from 'graphql';
+import type {
+  FieldDefinitionNode,
+  GraphQLSchema,
+  InputValueDefinitionNode,
+  InterfaceTypeDefinitionNode,
+  ObjectTypeDefinitionNode,
+} from 'graphql';
 
 import type { ValidationSchemaPluginConfig } from './config';
 import type { SchemaVisitor } from './types';
@@ -39,7 +45,10 @@ export abstract class BaseSchemaVisitor implements SchemaVisitor {
     name: string
   ): string;
 
-  protected buildObjectTypeDefinitionArguments(node: ObjectTypeDefinitionNode, visitor: Visitor) {
+  protected buildTypeDefinitionArguments(
+    node: ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode,
+    visitor: Visitor,
+  ) {
     return visitor.buildArgumentsSchemaBlock(node, (typeName, field) => {
       this.importTypes.push(typeName);
       return this.buildInputFields(field.arguments ?? [], visitor, typeName);

Diff for: src/visitor.ts

@@ -1,6 +1,14 @@
 import { TsVisitor } from '@graphql-codegen/typescript';
-import type { FieldDefinitionNode, GraphQLSchema, NameNode, ObjectTypeDefinitionNode } from 'graphql';
-import { specifiedScalarTypes } from 'graphql';
+import type {
+  FieldDefinitionNode,
+  GraphQLSchema,
+  InterfaceTypeDefinitionNode,
+  NameNode,
+  ObjectTypeDefinitionNode,
+} from 'graphql';
+import {
+  specifiedScalarTypes,
+} from 'graphql';
 
 import type { ValidationSchemaPluginConfig } from './config';
 
@@ -37,7 +45,11 @@ export class Visitor extends TsVisitor {
     if (this.scalarDirection === 'both')
       return null;
 
-    return this.scalars[scalarName][this.scalarDirection];
+    const scalar = this.scalars[scalarName];
+    if (!scalar)
+      throw new Error(`Unknown scalar ${scalarName}`);
+
+    return scalar[this.scalarDirection];
   }
 
   public shouldEmitAsNotAllowEmptyString(name: string): boolean {
@@ -53,7 +65,7 @@ export class Visitor extends TsVisitor {
   }
 
   public buildArgumentsSchemaBlock(
-    node: ObjectTypeDefinitionNode,
+    node: ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode,
     callback: (typeName: string, field: FieldDefinitionNode) => string,
   ) {
     const fieldsWithArguments = node.fields?.filter(field => field.arguments && field.arguments.length > 0) ?? [];