graphql/codegen/docs/migration/operations-and-client-preset-from-5-0

[giscus[bot]]

graphql/codegen/docs/migration/operations-and-client-preset-from-5-0

https://the-guild.dev/graphql/codegen/docs/migration/operations-and-client-preset-from-5-0

[Watertight-skaat]

I personally would prefer an option to have the client-present still generate all types instead of "just the used ones"

[eddeee888]

Could you help me understand your use case for all schema types please?
Would you be open to sharing your codegen config? It'd help me a lot

[ohanslik-vendavo]

I am trying to do the same but I have no idea hot to setup both the client preset and the typescript plugin to work together. They will both generate enums, for example.
To be honest, when reading migration guide, I would prefer if there was an actual example how to do the previous functionality instead of "use this plugin". While the usage is probably obvious to the developing team, it isn't obvious to anyone else.

[eddeee888]

Short answer is client-preset does not work with typescript plugin anymore.

Could you please create a discussion with your current setup issues and tag @eddeee888: https://github.com/dotansimha/graphql-code-generator/discussions/new?category=general

I'm happy to review and answer questions in more details

[MasonD]

I had to do the following. client-preset doesn't expose the option, but the plugins it uses behind-the-scenes can import types from the typescript plugin if you basically write a middleware to apply extra config after the preset does its thing.

import { preset as clientPreset } from '@graphql-codegen/client-preset';

{
  generates: {
    'client/gql/': {
      schema: 'schema',
      documents: [ 'documents' ],
      preset: {
        buildGeneratesSection: async (options) => {
          const ret = await clientPreset.buildGeneratesSection(options);
          if (options.config.importSchemaTypesFrom) {
            ret[0].config.importSchemaTypesFrom =
              options.config.importSchemaTypesFrom;
            ret[0].plugins.push({ 
              // This is hacky and needs to be changed alongside importSchemaTypesFrom, but you can just import directly from the types file if you leave it out.
              ['add']: { content: "export * from './types';" },
            });
          }
          return ret;
        },
        prepareDocuments: clientPreset.prepareDocuments,
      },
      presetConfig: {
        // extra config
      },
      config: {
        useTypeImports: true,
        importSchemaTypesFrom: 'client/gql/types.ts',
      },
    },
    'client/gql/types.ts': {
      schema: 'schema',
      plugins: ['typescript'],
      config: {
        generateOperationTypes: true,
      },
    },
  }
}

[ohanslik-vendavo]

@MasonD Thanks a lot. I was pretty sure that types could be imported but couldn't make it work. Seeing your solution, I now understand why.

[RobertOstermann]

Is there a way to keep the nullable result types as optional in the client preset?

6. Document field types are generated to correctly match runtime expectations

[eddeee888]

Hello @RobertOstermann , there's no such option for Client Preset, as we want the managed experience to have correct types.
Could you please share your use case/why you'd need it?

[RobertOstermann]

Having it as an option would be nice so I don't have to go through my entire codebase and change any usages of those types to work without them being optional. Not a big issue though as it should be easy enough for me to handle manually.