API usage - not getting baseTypesPath to work

[JoviDeCroock]

Hey all,

I've been using the project for GraphQLSP, in the linked PR I have been trying to use the typescript plugin to generate a set of global type and then on the second run have the typescript-operations and typed-document-node import from this global file... However I have tried a lot of permutations of the baseTypesPath setting but it hasn't really worked out. Initially creating this as a Q&A because I'm not sure whether this is a bug or intended behavior. For clarity I am using the node API here.

[eddeee888]

Hi @JoviDeCroock 👋

Looking through the linked PR, I think this line is the right place.

What would a typical value of baseTypesPath would be in this case?
Have you tried running this through a normal Codegen config setup to see if it works? 🙂

[eddeee888]

ahhh right, I see. baseTypesPath is mentioned in this near-operation-file preset so I think it works in that preset.

So it may not work in normal typescript-operations or typed-document-node plugins. I also cannot find baseTypesPath in these plugin docs

Let me look into near-operation-file preset source code to see how it's used.

[eddeee888]

Yea I think baseTypesPath ends up somewhere here in the preset

I think we can't run codegen on presets.

However, it seems like it just adds a line. I wonder if it would work if we use the @graphql-codegen/add plugin to add a line at the top of the generated files in your use case?

import * as addPlugin from '@graphql-codegen/add'; // 1. Import `add` plugin
// other code
const config = {
    documents: [
      {
        location: 'operation.graphql',
        document: parse(doc),
      },
    ],
    config: { /* Your other config */ },
    filename: outputFile,
    schema: parse(printSchema(schema)),
    plugins: [
      { 'typescript-operations': {} }, 
      { 'typed-document-node': {} }
      { add: { content: 'import * as Types from "..." ' } } // 2. Work out a reasonable import path here
    ],
    pluginMap: {
      'typescript-operations': typescriptOperationsPlugin,
      'typed-document-node': typedDocumentNodePlugin,
      add: addPlugin, // 3. Wire up `addPlugin`
    },
  }

[JoviDeCroock]

but then we'd also have to prefix all imports from typescript-operations/typed-document-node with types. right? That's some prefix option?

[eddeee888]

Ah great question! I think you can update your config to this:

const config = {
    documents: [...],
    config: { 
      namespacedImportName: 'Types', // This adds `Types.` to your types
    },
    filename: outputFile,
    schema: parse(printSchema(schema)),
    plugins: [...],
    pluginMap: {...},
  }
}

near-operation-file preset does that here