Codegen forces resolution of relationships even if they aren't requested in the query about graphql-code-generator

[eddeee888]

Hi @asharnadeem ,

To achieve what you need, mappers can be used.

Using base plugins

Here's what you can do if you use @graphql-codegen/typescript-resolvers

1. Create a type that you want to return into a Book type in the schema e.g.

// src/mappers.ts

export type BookMapper = {
  id: string;
  name: string;
}

2. Then, wire it up in codegen config:

// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
  schema: '**/schema.graphql'
  generates: {
    'src/types.generated.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        mappers: {
          Book: './mappers#BookMapper'
        }
      }
    }
  }
}

export default config;

3. Run codegen and you can now return BookMapper in Query.book

Using Server Preset

Using base plugin can get repetitive and it also doesn't provide runtime safety. We recommend using Server Preset to get a more managed experience so you can focus more on developing features instead of worrying about types.

To set up server preset, here's what you do:

1. Update codegen config

// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';
import { defineConfig } from '@eddeee888/gcg-typescript-resolver-files';

const config: CodegenConfig = {
  schema: '**/schema.graphql'
  generates: {
    'src/schema': defineConfig(),
}

export default config;

2. Make sure you schema is in the right module e.g.

# src/schema/schema.graphql
type Query {
  book(id: ID!): Book!
}
# ... other types

3. Add mappers into schema:

// src/schema/schema.mappers.ts
export type BookMapper = {
  id: string;
  name: string;
}

4. Run codegen and mappers you can use BookMapper resolver.

Here's the full guide to integrate Server Preset into GraphQL Yoga or Apollo Server

[eddeee888]

Hi @asharnadeem , I'll close this issue as it's an expected behaviour. If you have issues using mappers or Server Preset, please create other issues and ping me.