@graphql-codegen/near-operation-file-preset/typings/index.d.ts

GraphQL Code Generator preset for generating operation code near the operation file

import { Types } from '@graphql-codegen/plugin-helpers';
import { FragmentDefinitionNode } from 'graphql';
import { resolveDocumentImports, DocumentImportResolverOptions } from './resolve-document-imports.js';
import { FragmentImport, ImportSource } from '@graphql-codegen/visitor-plugin-common';
export { resolveDocumentImports, DocumentImportResolverOptions };
export declare type FragmentImportFromFn = (source: ImportSource<FragmentImport>, sourceFilePath: string) => ImportSource<FragmentImport>;
export declare type NearOperationFileConfig = {
    /**
     * @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
     * ```yaml {5}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *     plugins:
     *       - typescript-operations
     * ```
     */
    baseTypesPath: string;
    /**
     * @description Overrides all external fragments import types by using a specific file path or a package name.
     *
     * If you wish to use an NPM package or a local workspace package, make sure to prefix the package name with `~`.
     *
     * @exampleMarkdown
     * ```yaml {6}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *       importAllFragmentsFrom: '~types'
     *     plugins:
     *       - typescript-operations
     * ```
     */
    importAllFragmentsFrom?: string | FragmentImportFromFn;
    /**
     * @description Optional, sets the extension for the generated files. Use this to override the extension if you are using plugins that requires a different type of extensions (such as `typescript-react-apollo`)
     * @default .generated.ts
     *
     * @exampleMarkdown
     * ```yaml {6}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *       extension: .generated.tsx
     *     plugins:
     *       - typescript-operations
     *       - typescript-react-apollo
     * ```
     */
    extension?: string;
    /**
     * @description Optional, override the `cwd` of the execution. We are using `cwd` to figure out the imports between files. Use this if your execution path is not your project root directory.
     * @default process.cwd()
     *
     * @exampleMarkdown
     * ```yaml {6}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *       cwd: /some/path
     *     plugins:
     *       - typescript-operations
     * ```
     */
    cwd?: string;
    /**
     * @description Optional, defines a folder, (Relative to the source files) where the generated files will be created.
     * @default ''
     *
     * @exampleMarkdown
     * ```yaml {6}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *       folder: __generated__
     *     plugins:
     *       - typescript-operations
     * ```
     */
    folder?: string;
    /**
     * @description Optional, override the name of the import namespace used to import from the `baseTypesPath` file.
     * @default Types
     *
     * @exampleMarkdown
     * ```yaml {6}
     * generates:
     *   src/:
     *     preset: near-operation-file
     *     presetConfig:
     *       baseTypesPath: types.ts
     *       importTypesNamespace: SchemaTypes
     *     plugins:
     *       - typescript-operations
     * ```
     */
    importTypesNamespace?: string;
};
export declare type FragmentNameToFile = {
    [fragmentName: string]: {
        location: string;
        importsNames: string[];
        onType: string;
        node: FragmentDefinitionNode;
    };
};
export declare const preset: Types.OutputPreset<NearOperationFileConfig>;
export default preset;