dotansimha/graphql-code-generator release-1680576611161

April 04, 2023

on GitHub

@graphql-codegen/cli@3.3.0

Minor Changes

• #9151 b7dacb21f Thanks @'./user/schema.mappers#UserMapper',! - Add watchPattern config option for generates sections.

  By default, watch mode automatically watches all GraphQL schema and document files. This means when a change is detected, Codegen CLI is run.

  A user may want to run Codegen CLI when non-schema and non-document files are changed. Each generates section now has a watchPattern option to allow more file patterns to be added to the list of patterns to watch.

  In the example below, mappers are exported from schema.mappers.ts files. We want to re-run Codegen if the content of *.mappers.ts files change because they change the generated types file. To solve this, we can add mapper file patterns to watch using the glob pattern used for schema and document files.

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          mappers: {
  
            Book: './book/schema.mappers#BookMapper',
          },
        }
        watchPattern: 'src/schema/**/*.mappers.ts', // Watches mapper files in `watch` mode. Use an array for multiple patterns e.g. `['src/*.pattern1.ts','src/*.pattern2.ts']`
      },
    },
  };

  Then, run Codegen CLI in watch mode:

  yarn graphql-codegen --watch

  Now, updating *.mappers.ts files re-runs Codegen! 🎉

  Note: watchPattern is only used in watch mode i.e. running CLI with --watch flag.

Patch Changes

• Updated dependencies [b7dacb21f, f104619ac]:
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/visitor-plugin-common@3.1.0

Minor Changes

• #9146 9f4d9c5a4 Thanks @eddeee888! - [typescript-resolvers] Add resolversNonOptionalTypename config option.

  This is extending on ResolversUnionTypes implemented in #9069

  resolversNonOptionalTypename adds non-optional __typename to union members of ResolversUnionTypes, without affecting the union members' base intefaces.

  A common use case for non-optional __typename of union members is using it as the common field to work out the final schema type. This makes implementing the union's __resolveType very simple as we can use __typename to decide which union member the resolved object is. Without this, we have to check the existence of field/s on the incoming object which could be verbose.

  For example, consider this schema:

  type Query {
    book(id: ID!): BookPayload!
  }
  
  type Book {
    id: ID!
    isbn: String!
  }
  
  type BookResult {
    node: Book
  }
  
  type PayloadError {
    message: String!
  }
  
  union BookPayload = BookResult | PayloadError

  With optional __typename: We need to check existence of certain fields to resolve type in the union resolver:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. No `__typename` in resolver results...
      return {
        node: book,
      };
    } catch (e) {
      return {
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => {
      // 2. ... means more checks in `__resolveType`
      if ('message' in parent) {
        return 'PayloadError';
      }
      return 'BookResult';
    },
  };

  With non-optional __typename: Resolvers declare the type. This which gives us better TypeScript support in resolvers and simplify __resolveType implementation:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. `__typename` is declared in resolver results...
      return {
        __typename: 'BookResult', // 1a. this also types `node` for us 🎉
        node: book,
      };
    } catch (e) {
      return {
        __typename: 'PayloadError',
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => parent.__typename, // 2. ... means a very simple check in `__resolveType`
  };

  Using resolversNonOptionalTypename: add it into typescript-resolvers plugin config:

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          resolversNonOptionalTypename: true, // Or `resolversNonOptionalTypename: { unionMember: true }`
        },
      },
    },
  };

Patch Changes

• #9206 e56790104 Thanks @eddeee888! - Fix ResolversUnionTypes being used in ResolversParentTypes

  Previously, objects with mappable fields are converted to Omit format that references its own type group or ResolversTypes or ResolversParentTypes e.g.

  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolversTypes['BookResult'] | ResolversTypes['StandardError'];
    // Note: `result` on the next line references `ResolversTypes["Book"]`
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversParentTypes['BookResult'] | ResolversParentTypes['StandardError'];
    // Note: `result` on the next line references `ResolversParentTypes["Book"]`
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  In #9069, we extracted resolver union types to its own group:

  export type ResolversUnionTypes = {
    // Note: `result` on the next line references `ResolversTypes["Book"]` which is only correct for the `ResolversTypes` case
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }) | StandardError;
  };
  
  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolverTypeWrapper<ResolversUnionTypes['BookPayload']>;
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversUnionTypes['BookPayload'];
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  This change creates an extra ResolversUnionParentTypes that is referenced by ResolversParentTypes to ensure backwards compatibility:

  export type ResolversUnionTypes = {
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> }) | StandardError;
  };
  
  // ... and the reference is changed in ResolversParentTypes:
  export type ResolversParentTypes = {
    // ... other fields
    BookPayload: ResolversUnionParentTypes['BookPayload'];
  };

• #9194 acb647e4e Thanks @dstaley! - Don't emit import statements for unused fragments

• Updated dependencies [b7dacb21f, f104619ac]:

  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/typescript-document-nodes@3.0.3

Patch Changes

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/gql-tag-operations@3.0.0

Major Changes

• #9137 2256c8b5d Thanks @beerose! - Add TypedDocumentNode string alternative that doesn't require GraphQL AST on the client. This change requires @graphql-typed-document-node/core in version 3.2.0 or higher.

Patch Changes

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/typescript-operations@3.0.3

Patch Changes

• Updated dependencies [e56790104, b7dacb21f, f104619ac, 92d86b009, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0
  • @graphql-codegen/typescript@3.0.3

@graphql-codegen/typescript-resolvers@3.2.0

Minor Changes

• #9146 9f4d9c5a4 Thanks @eddeee888! - [typescript-resolvers] Add resolversNonOptionalTypename config option.

  This is extending on ResolversUnionTypes implemented in #9069

  resolversNonOptionalTypename adds non-optional __typename to union members of ResolversUnionTypes, without affecting the union members' base intefaces.

  A common use case for non-optional __typename of union members is using it as the common field to work out the final schema type. This makes implementing the union's __resolveType very simple as we can use __typename to decide which union member the resolved object is. Without this, we have to check the existence of field/s on the incoming object which could be verbose.

  For example, consider this schema:

  type Query {
    book(id: ID!): BookPayload!
  }
  
  type Book {
    id: ID!
    isbn: String!
  }
  
  type BookResult {
    node: Book
  }
  
  type PayloadError {
    message: String!
  }
  
  union BookPayload = BookResult | PayloadError

  With optional __typename: We need to check existence of certain fields to resolve type in the union resolver:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. No `__typename` in resolver results...
      return {
        node: book,
      };
    } catch (e) {
      return {
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => {
      // 2. ... means more checks in `__resolveType`
      if ('message' in parent) {
        return 'PayloadError';
      }
      return 'BookResult';
    },
  };

  With non-optional __typename: Resolvers declare the type. This which gives us better TypeScript support in resolvers and simplify __resolveType implementation:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. `__typename` is declared in resolver results...
      return {
        __typename: 'BookResult', // 1a. this also types `node` for us 🎉
        node: book,
      };
    } catch (e) {
      return {
        __typename: 'PayloadError',
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => parent.__typename, // 2. ... means a very simple check in `__resolveType`
  };

  Using resolversNonOptionalTypename: add it into typescript-resolvers plugin config:

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          resolversNonOptionalTypename: true, // Or `resolversNonOptionalTypename: { unionMember: true }`
        },
      },
    },
  };

Patch Changes

• #9206 e56790104 Thanks @eddeee888! - Fix ResolversUnionTypes being used in ResolversParentTypes

  Previously, objects with mappable fields are converted to Omit format that references its own type group or ResolversTypes or ResolversParentTypes e.g.

  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolversTypes['BookResult'] | ResolversTypes['StandardError'];
    // Note: `result` on the next line references `ResolversTypes["Book"]`
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversParentTypes['BookResult'] | ResolversParentTypes['StandardError'];
    // Note: `result` on the next line references `ResolversParentTypes["Book"]`
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  In #9069, we extracted resolver union types to its own group:

  export type ResolversUnionTypes = {
    // Note: `result` on the next line references `ResolversTypes["Book"]` which is only correct for the `ResolversTypes` case
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }) | StandardError;
  };
  
  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolverTypeWrapper<ResolversUnionTypes['BookPayload']>;
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversUnionTypes['BookPayload'];
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  This change creates an extra ResolversUnionParentTypes that is referenced by ResolversParentTypes to ensure backwards compatibility:

  export type ResolversUnionTypes = {
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> }) | StandardError;
  };
  
  // ... and the reference is changed in ResolversParentTypes:
  export type ResolversParentTypes = {
    // ... other fields
    BookPayload: ResolversUnionParentTypes['BookPayload'];
  };

• f104619ac Thanks @saihaj! - Resolve issue with nesting fields in @provides directive being prevented

• Updated dependencies [e56790104, b7dacb21f, f104619ac, 92d86b009, acb647e4e, 9f4d9c5a4]:

  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0
  • @graphql-codegen/typescript@3.0.3

@graphql-codegen/typed-document-node@4.0.0

Major Changes

• #9137 2256c8b5d Thanks @beerose! - Add TypedDocumentNode string alternative that doesn't require GraphQL AST on the client. This change requires @graphql-typed-document-node/core in version 3.2.0 or higher.

Patch Changes

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/typescript@3.0.3

Patch Changes

• #9150 92d86b009 Thanks @rliljest! - Properly escape enum identifiers when enumsAsConst is used

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:

  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/client-preset@3.0.0

Major Changes

• #9137 2256c8b5d Thanks @beerose! - Add TypedDocumentNode string alternative that doesn't require GraphQL AST on the client. This change requires @graphql-typed-document-node/core in version 3.2.0 or higher.

Patch Changes

• #9137 2256c8b5d Thanks @beerose! - dependencies updates:
  • Updated dependency @graphql-typed-document-node/core@3.2.0 ↗︎ (from 3.1.2, in dependencies)
• Updated dependencies [e56790104, b7dacb21f, f104619ac, 92d86b009, 2256c8b5d, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0
  • @graphql-codegen/typescript@3.0.3
  • @graphql-codegen/typed-document-node@4.0.0
  • @graphql-codegen/gql-tag-operations@3.0.0
  • @graphql-codegen/typescript-operations@3.0.3

@graphql-codegen/graphql-modules-preset@3.1.2

Patch Changes

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:
  • @graphql-codegen/visitor-plugin-common@3.1.0
  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/testing@2.0.2

Patch Changes

• #9228 a5ec5af36 Thanks @eddeee888! - Add complex test cases for resolvers tests

• Updated dependencies [b7dacb21f, f104619ac]:

  • @graphql-codegen/plugin-helpers@4.2.0

@graphql-codegen/plugin-helpers@4.2.0

Minor Changes

• #9151 b7dacb21f Thanks @'./user/schema.mappers#UserMapper',! - Add watchPattern config option for generates sections.

  By default, watch mode automatically watches all GraphQL schema and document files. This means when a change is detected, Codegen CLI is run.

  A user may want to run Codegen CLI when non-schema and non-document files are changed. Each generates section now has a watchPattern option to allow more file patterns to be added to the list of patterns to watch.

  In the example below, mappers are exported from schema.mappers.ts files. We want to re-run Codegen if the content of *.mappers.ts files change because they change the generated types file. To solve this, we can add mapper file patterns to watch using the glob pattern used for schema and document files.

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          mappers: {
  
            Book: './book/schema.mappers#BookMapper',
          },
        }
        watchPattern: 'src/schema/**/*.mappers.ts', // Watches mapper files in `watch` mode. Use an array for multiple patterns e.g. `['src/*.pattern1.ts','src/*.pattern2.ts']`
      },
    },
  };

  Then, run Codegen CLI in watch mode:

  yarn graphql-codegen --watch

  Now, updating *.mappers.ts files re-runs Codegen! 🎉

  Note: watchPattern is only used in watch mode i.e. running CLI with --watch flag.

Patch Changes

• f104619ac Thanks @saihaj! - Resolve issue with nesting fields in @provides directive being prevented