@nmarks/graphql-codegen-per-operation-file-preset 1.0.0

package/typings/index.d.ts

@@ -0,0 +1,131 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+export type PerOperationFileConfig = {
+    /**
+     * @description Required, should point to the base schema types file.
+     * The key of the output is used a the base path for this file.
+     *
+     * If you wish to use an NPM package or a local workspace package, make sure to prefix the package name with `~`.
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        preset: 'per-operation-file',
+     *        plugins: ['typescript-operations'],
+     *        presetConfig: {
+     *          baseTypesPath: 'types.ts'
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    baseTypesPath: string;
+    /**
+     * @description Optional, sets the extension for the generated files.
+     * @default .ts
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        preset: 'per-operation-file',
+     *        plugins: ['typescript-operations'],
+     *        presetConfig: {
+     *          baseTypesPath: 'types.ts',
+     *          extension: '.generated.ts',
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    extension?: string;
+    /**
+     * @description Optional, override the `cwd` of the execution.
+     * @default process.cwd()
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        preset: 'per-operation-file',
+     *        plugins: ['typescript-operations'],
+     *        presetConfig: {
+     *          baseTypesPath: 'types.ts',
+     *          cwd: '/some/path'
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    cwd?: string;
+    /**
+     * @description Optional, defines a folder where the generated files will be created.
+     * @default '__generated__'
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        preset: 'per-operation-file',
+     *        plugins: ['typescript-operations'],
+     *        presetConfig: {
+     *          baseTypesPath: 'types.ts',
+     *          folder: '__generated__'
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    folder?: string;
+    /**
+     * @description Optional, override the name of the import namespace used to import from the `baseTypesPath` file.
+     * @default Types
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file.ts': {
+     *        preset: 'per-operation-file',
+     *        plugins: ['typescript-operations'],
+     *        presetConfig: {
+     *          baseTypesPath: 'types.ts',
+     *          importTypesNamespace: 'SchemaTypes'
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    importTypesNamespace?: string;
+};
+export declare const preset: Types.OutputPreset<PerOperationFileConfig>;
+export default preset;

package/typings/resolve-document-imports.d.cts

@@ -0,0 +1,48 @@
+import { FragmentDefinitionNode, GraphQLSchema } from 'graphql';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { FragmentImport, ImportDeclaration, ImportSource, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import { Source } from '@graphql-tools/utils';
+export type FragmentRegistry = {
+    [fragmentName: string]: {
+        location: string;
+        importNames: string[];
+        onType: string;
+        node: FragmentDefinitionNode;
+    };
+};
+export type DocumentImportResolverOptions = {
+    baseDir: string;
+    /**
+     * Schema base types source
+     */
+    schemaTypesSource: string | ImportSource;
+    /**
+     * Should `import type` be used
+     */
+    typesImport: boolean;
+    /**
+     * Folder for generated files
+     */
+    folder: string;
+    /**
+     * Extension for generated files
+     */
+    extension: string;
+};
+interface ResolveDocumentImportResult {
+    filename: string;
+    documents: [Source];
+    importStatements: string[];
+    fragmentImports: ImportDeclaration<FragmentImport>[];
+    externalFragments: LoadedFragment<{
+        level: number;
+    }>[];
+}
+/**
+ * Transform the preset's provided documents into single-file generator sources, while resolving fragment and user-defined imports
+ *
+ * Resolves user provided imports and fragment imports using the `DocumentImportResolverOptions`.
+ * Does not define specific plugins, but rather returns a string[] of `importStatements` for the calling plugin to make use of
+ */
+export declare function resolveDocumentImports<T>(presetOptions: Types.PresetFnArgs<T>, schemaObject: GraphQLSchema, importResolverOptions: DocumentImportResolverOptions, dedupeFragments?: boolean): Array<ResolveDocumentImportResult>;
+export {};

package/typings/resolve-document-imports.d.ts

@@ -0,0 +1,48 @@
+import { FragmentDefinitionNode, GraphQLSchema } from 'graphql';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { FragmentImport, ImportDeclaration, ImportSource, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import { Source } from '@graphql-tools/utils';
+export type FragmentRegistry = {
+    [fragmentName: string]: {
+        location: string;
+        importNames: string[];
+        onType: string;
+        node: FragmentDefinitionNode;
+    };
+};
+export type DocumentImportResolverOptions = {
+    baseDir: string;
+    /**
+     * Schema base types source
+     */
+    schemaTypesSource: string | ImportSource;
+    /**
+     * Should `import type` be used
+     */
+    typesImport: boolean;
+    /**
+     * Folder for generated files
+     */
+    folder: string;
+    /**
+     * Extension for generated files
+     */
+    extension: string;
+};
+interface ResolveDocumentImportResult {
+    filename: string;
+    documents: [Source];
+    importStatements: string[];
+    fragmentImports: ImportDeclaration<FragmentImport>[];
+    externalFragments: LoadedFragment<{
+        level: number;
+    }>[];
+}
+/**
+ * Transform the preset's provided documents into single-file generator sources, while resolving fragment and user-defined imports
+ *
+ * Resolves user provided imports and fragment imports using the `DocumentImportResolverOptions`.
+ * Does not define specific plugins, but rather returns a string[] of `importStatements` for the calling plugin to make use of
+ */
+export declare function resolveDocumentImports<T>(presetOptions: Types.PresetFnArgs<T>, schemaObject: GraphQLSchema, importResolverOptions: DocumentImportResolverOptions, dedupeFragments?: boolean): Array<ResolveDocumentImportResult>;
+export {};

package/typings/utils.d.cts

@@ -0,0 +1,23 @@
+import { DocumentNode, FragmentDefinitionNode, GraphQLSchema } from 'graphql';
+import { FragmentRegistry } from './fragment-resolver.cjs';
+/**
+ * Generate output file path for a specific operation/fragment
+ */
+export declare function generateOperationFilePath(sourceLocation: string, operationName: string, folder: string, extension: string): string;
+/**
+ * Analyzes fragment usage in a GraphQL document.
+ * Returns information about which fragments are used and which specific types they're used with.
+ */
+export declare function analyzeFragmentUsage(documentNode: DocumentNode, fragmentRegistry: FragmentRegistry, schema: GraphQLSchema): {
+    fragmentsInUse: {
+        [fragmentName: string]: number;
+    };
+    usedFragmentTypes: {
+        [fragmentName: string]: string[];
+    };
+};
+export declare function extractExternalFragmentsInUse(documentNode: DocumentNode | FragmentDefinitionNode, fragmentNameToFile: FragmentRegistry, localFragment: Set<string>, result?: {
+    [fragmentName: string]: number;
+}, level?: number): {
+    [fragmentName: string]: number;
+};

package/typings/utils.d.ts

@@ -0,0 +1,23 @@
+import { DocumentNode, FragmentDefinitionNode, GraphQLSchema } from 'graphql';
+import { FragmentRegistry } from './fragment-resolver.js';
+/**
+ * Generate output file path for a specific operation/fragment
+ */
+export declare function generateOperationFilePath(sourceLocation: string, operationName: string, folder: string, extension: string): string;
+/**
+ * Analyzes fragment usage in a GraphQL document.
+ * Returns information about which fragments are used and which specific types they're used with.
+ */
+export declare function analyzeFragmentUsage(documentNode: DocumentNode, fragmentRegistry: FragmentRegistry, schema: GraphQLSchema): {
+    fragmentsInUse: {
+        [fragmentName: string]: number;
+    };
+    usedFragmentTypes: {
+        [fragmentName: string]: string[];
+    };
+};
+export declare function extractExternalFragmentsInUse(documentNode: DocumentNode | FragmentDefinitionNode, fragmentNameToFile: FragmentRegistry, localFragment: Set<string>, result?: {
+    [fragmentName: string]: number;
+}, level?: number): {
+    [fragmentName: string]: number;
+};