@graphql-codegen/typescript-operations
Version:
GraphQL Code Generator plugin for generating TypeScript types for GraphQL queries, mutations, subscriptions and fragments
60 lines (59 loc) • 2.72 kB
JavaScript
import { oldVisit } from '@graphql-codegen/plugin-helpers';
import { transformSchemaAST } from '@graphql-codegen/schema-ast';
import { optimizeOperations } from '@graphql-codegen/visitor-plugin-common';
import { concatAST } from 'graphql';
import { TypeScriptDocumentsVisitor } from './visitor.js';
export const plugin = async (inputSchema, rawDocuments, config, { outputFile }) => {
const schema = config.nullability?.errorHandlingClient ? await semanticToStrict(inputSchema) : inputSchema;
const documents = config.flattenGeneratedTypes
? optimizeOperations(schema, rawDocuments, {
includeFragments: config.flattenGeneratedTypesIncludeFragments,
})
: rawDocuments;
const allAst = concatAST(documents.map(v => v.document));
const visitor = new TypeScriptDocumentsVisitor(schema, config, allAst, outputFile);
const operationsResult = oldVisit(allAst, { leave: visitor });
const operationsDefinitions = operationsResult.definitions;
if (config.addOperationExport) {
for (const d of allAst.definitions) {
if ('name' in d) {
operationsDefinitions.push(`export declare const ${d.name.value}: import("graphql").DocumentNode;`);
}
}
}
const schemaTypes = oldVisit(transformSchemaAST(schema, config).ast, { leave: visitor });
// IMPORTANT: when a visitor leaves a node with no transformation logic,
// It will leave the node as an object.
// Here, we filter in nodes that have been turned into strings, i.e. they have been transformed
// This way, we do not have to explicitly declare a method for every node type to convert them to null
const schemaTypesDefinitions = schemaTypes.definitions.filter(def => typeof def === 'string');
let content = [...schemaTypesDefinitions, ...operationsDefinitions].join('\n');
if (config.globalNamespace) {
content = `
declare global {
${content}
}`;
}
return {
prepend: [
...visitor.getImports(),
...visitor.getExternalSchemaTypeImports(),
...visitor.getEnumsImports(),
...visitor.getScalarsImports(),
...visitor.getGlobalDeclarations(visitor.config.noExport),
visitor.getExactUtilityType(),
visitor.getIncrementalUtilityType(),
],
content,
};
};
export { TypeScriptDocumentsVisitor };
const semanticToStrict = async (schema) => {
try {
const sock = await import('graphql-sock');
return sock.semanticToStrict(schema);
}
catch {
throw new Error("To use the `nullability.errorHandlingClient` option, you must install the 'graphql-sock' package.");
}
};