@graphql-codegen/cli 2.11.4-alpha-8815d56b3.0 → 2.11.4

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "2.11.4-alpha-8815d56b3.0",
+  "version": "2.11.4",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/core": "2.6.0",
-    "@graphql-codegen/plugin-helpers": "^2.6.1",
+    "@graphql-codegen/core": "2.6.1",
+    "@graphql-codegen/plugin-helpers": "^2.6.2",
     "@graphql-tools/apollo-engine-loader": "^7.3.6",
     "@graphql-tools/code-file-loader": "^7.3.1",
     "@graphql-tools/git-loader": "^7.2.1",
@@ -19,7 +19,7 @@
     "@graphql-tools/utils": "^8.9.0",
     "@whatwg-node/fetch": "^0.2.3",
     "ansi-escapes": "^4.3.1",
-    "chalk": "^4",
+    "chalk": "^4.1.0",
     "chokidar": "^3.5.2",
     "cosmiconfig": "^7.0.0",
     "debounce": "^1.2.0",
@@ -72,7 +72,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {

package/typings/bin.d.cts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/typings/cli.d.cts

@@ -0,0 +1,2 @@
+export declare function runCli(cmd: string): Promise<number>;
+export declare function ensureGraphQlPackage(): Promise<void>;

package/typings/codegen.d.cts

@@ -0,0 +1,3 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { CodegenContext } from './config.cjs';
+export declare function executeCodegen(input: CodegenContext | Types.Config): Promise<Types.FileOutput[]>;

package/typings/config.d.cts

@@ -0,0 +1,138 @@
+import { Types, Profiler } from '@graphql-codegen/plugin-helpers';
+import { GraphQLConfig } from 'graphql-config';
+import { GraphQLSchema } from 'graphql';
+export declare type YamlCliFlags = {
+    config: string;
+    watch: boolean | string | string[];
+    require: string[];
+    overwrite: boolean;
+    project: string;
+    silent: boolean;
+    errorsOnly: boolean;
+    profile: boolean;
+    check?: boolean;
+    verbose?: boolean;
+    debug?: boolean;
+    ignoreNoDocuments?: boolean;
+    emitLegacyCommonJSImports?: boolean;
+};
+export declare function generateSearchPlaces(moduleName: string): string[];
+export interface LoadCodegenConfigOptions {
+    /**
+     * The path to the config file or directory contains the config file.
+     * @default process.cwd()
+     */
+    configFilePath?: string;
+    /**
+     * The name of the config file
+     * @default codegen
+     */
+    moduleName?: string;
+    /**
+     * Additional search paths for the config file you want to check
+     */
+    searchPlaces?: string[];
+    /**
+     * @default codegen
+     */
+    packageProp?: string;
+    /**
+     * Overrides or extends the loaders for specific file extensions
+     */
+    loaders?: Record<string, (filepath: string, content: string) => Promise<Types.Config> | Types.Config>;
+}
+export interface LoadCodegenConfigResult {
+    filepath: string;
+    config: Types.Config;
+    isEmpty?: boolean;
+}
+export declare function loadCodegenConfig({ configFilePath, moduleName, searchPlaces: additionalSearchPlaces, packageProp, loaders: customLoaders, }: LoadCodegenConfigOptions): Promise<LoadCodegenConfigResult>;
+export declare function loadContext(configFilePath?: string): Promise<CodegenContext> | never;
+export declare function buildOptions(): {
+    c: {
+        alias: string;
+        type: "string";
+        describe: string;
+    };
+    w: {
+        alias: string;
+        describe: string;
+        coerce: (watch: any) => string | boolean | any[];
+    };
+    r: {
+        alias: string;
+        describe: string;
+        type: "array";
+        default: any[];
+    };
+    o: {
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    s: {
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    e: {
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    profile: {
+        describe: string;
+        type: "boolean";
+    };
+    p: {
+        alias: string;
+        describe: string;
+        type: "string";
+    };
+    v: {
+        alias: string;
+        describe: string;
+        type: "boolean";
+        default: boolean;
+    };
+    d: {
+        alias: string;
+        describe: string;
+        type: "boolean";
+        default: boolean;
+    };
+};
+export declare function parseArgv(argv?: string[]): YamlCliFlags;
+export declare function createContext(cliFlags?: YamlCliFlags): Promise<CodegenContext>;
+export declare function updateContextWithCliFlags(context: CodegenContext, cliFlags: YamlCliFlags): void;
+export declare class CodegenContext {
+    private _config;
+    private _graphqlConfig?;
+    private config;
+    private _project?;
+    private _checkMode;
+    private _pluginContext;
+    cwd: string;
+    filepath: string;
+    profiler: Profiler;
+    profilerOutput?: string;
+    checkModeStaleFiles: any[];
+    constructor({ config, graphqlConfig, filepath, }: {
+        config?: Types.Config;
+        graphqlConfig?: GraphQLConfig;
+        filepath?: string;
+    });
+    useProject(name?: string): void;
+    getConfig<T>(extraConfig?: T): T & Types.Config;
+    updateConfig(config: Partial<Types.Config>): void;
+    enableCheckMode(): void;
+    get checkMode(): boolean;
+    useProfiler(): void;
+    getPluginContext(): {
+        [key: string]: any;
+    };
+    loadSchema(pointer: Types.Schema): Promise<GraphQLSchema>;
+    loadDocuments(pointer: Types.OperationDocument[]): Promise<Types.DocumentFile[]>;
+}
+export declare function ensureContext(input: CodegenContext | Types.Config): CodegenContext;
+export declare function shouldEmitLegacyCommonJSImports(config: Types.Config, outputPath: string): boolean;

package/typings/generate-and-save.d.cts

@@ -0,0 +1,5 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { CodegenContext } from './config.cjs';
+export declare function generate(input: CodegenContext | (Types.Config & {
+    cwd?: string;
+}), saveToFile?: boolean): Promise<Types.FileOutput[] | any>;

package/typings/graphql-config.d.cts

@@ -0,0 +1,3 @@
+import { GraphQLExtensionDeclaration, GraphQLConfig } from 'graphql-config';
+export declare const CodegenExtension: GraphQLExtensionDeclaration;
+export declare function findAndLoadGraphQLConfig(filepath?: string): Promise<GraphQLConfig | void>;

package/typings/hooks.d.cts

@@ -0,0 +1,11 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+export declare const lifecycleHooks: (_hooks?: Partial<Types.LifecycleHooksDefinition>) => {
+    afterStart: () => Promise<void>;
+    onWatchTriggered: (event: string, path: string) => Promise<void>;
+    onError: (error: string) => Promise<void>;
+    afterOneFileWrite: (path: string) => Promise<void>;
+    afterAllFileWrite: (paths: string[]) => Promise<void>;
+    beforeOneFileWrite: (path: string) => Promise<void>;
+    beforeAllFileWrite: (paths: string[]) => Promise<void>;
+    beforeDone: () => Promise<void>;
+};

package/typings/index.d.cts

@@ -0,0 +1,7 @@
+export { executeCodegen } from './codegen.cjs';
+export { generate } from './generate-and-save.cjs';
+export * from './config.cjs';
+export * from './init/index.cjs';
+export * from './utils/cli-error.cjs';
+export * from './cli.cjs';
+export * from './graphql-config.cjs';

package/typings/init/helpers.d.cts

@@ -0,0 +1,10 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { Answers } from './types.cjs';
+export declare function writeConfig(answers: Answers, config: Types.Config): Promise<{
+    relativePath: string;
+    fullPath: string;
+}>;
+export declare function writePackage(answers: Answers, configLocation: string): Promise<void>;
+export declare function bold(str: string): string;
+export declare function grey(str: string): string;
+export declare function italic(str: string): string;

package/typings/init/index.d.cts

@@ -0,0 +1 @@
+export declare function init(): Promise<void>;

package/typings/init/plugins.d.cts

@@ -0,0 +1,2 @@
+import { PluginOption } from './types.cjs';
+export declare const plugins: Array<PluginOption>;

package/typings/init/questions.d.cts

@@ -0,0 +1,11 @@
+import inquirer from 'inquirer';
+import { Tags, Answers } from './types.cjs';
+export declare function getQuestions(possibleTargets: Record<Tags, boolean>): inquirer.QuestionCollection;
+export declare function getApplicationTypeChoices(possibleTargets: Record<Tags, boolean>): {
+    name: string;
+    key: string;
+    value: Tags[];
+    checked: boolean;
+}[];
+export declare function getPluginChoices(answers: Answers): inquirer.DistinctChoice<inquirer.AllChoiceMap<inquirer.Answers>, inquirer.AllChoiceMap<inquirer.AllChoiceMap<inquirer.Answers>>>[];
+export declare function getOutputDefaultValue(answers: Answers): "src/generated/graphql.tsx" | "src/generated/graphql.ts" | "src/generated/graphql.cjs";

package/typings/init/targets.d.cts

@@ -0,0 +1,2 @@
+import { Tags } from './types.cjs';
+export declare function guessTargets(): Promise<Record<Tags, boolean>>;

package/typings/init/types.d.cts

@@ -0,0 +1,29 @@
+export interface PluginOption {
+    name: string;
+    package: string;
+    value: string;
+    pathInRepo: string;
+    available(tags: Tags[]): boolean;
+    shouldBeSelected(tags: Tags[]): boolean;
+    defaultExtension: string;
+}
+export interface Answers {
+    targets: Tags[];
+    config: string;
+    plugins: PluginOption[];
+    schema: string;
+    documents?: string;
+    output: string;
+    script: string;
+    introspection: boolean;
+}
+export declare enum Tags {
+    browser = "Browser",
+    node = "Node",
+    typescript = "TypeScript",
+    flow = "Flow",
+    angular = "Angular",
+    stencil = "Stencil",
+    react = "React",
+    vue = "Vue"
+}

package/typings/load.d.cts

@@ -0,0 +1,15 @@
+import { UnnormalizedTypeDefPointer } from '@graphql-tools/load';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { GraphQLSchema } from 'graphql';
+export declare const defaultSchemaLoadOptions: {
+    assumeValidSDL: boolean;
+    sort: boolean;
+    convertExtensions: boolean;
+    includeSources: boolean;
+};
+export declare const defaultDocumentsLoadOptions: {
+    sort: boolean;
+    skipGraphQLImport: boolean;
+};
+export declare function loadSchema(schemaPointers: UnnormalizedTypeDefPointer, config: Types.Config): Promise<GraphQLSchema>;
+export declare function loadDocuments(documentPointers: UnnormalizedTypeDefPointer | UnnormalizedTypeDefPointer[], config: Types.Config): Promise<Types.DocumentFile[]>;

package/typings/plugins.d.cts

@@ -0,0 +1,2 @@
+import { Types, CodegenPlugin } from '@graphql-codegen/plugin-helpers';
+export declare function getPluginByName(name: string, pluginLoader: Types.PackageLoaderFn<CodegenPlugin>): Promise<CodegenPlugin>;

package/typings/presets.d.cts

@@ -0,0 +1,5 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+export declare function getPresetByName(name: string, loader: Types.PackageLoaderFn<{
+    preset?: Types.OutputPreset;
+    default?: Types.OutputPreset;
+}>): Promise<Types.OutputPreset>;

package/typings/utils/cli-error.d.cts

@@ -0,0 +1,11 @@
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+declare type CompositeError = Error | DetailedError;
+declare type ListrError = Error & {
+    errors: CompositeError[];
+};
+export declare function isListrError(err: Error & {
+    name?: unknown;
+    errors?: unknown;
+}): err is ListrError;
+export declare function cliError(err: any, exitOnError?: boolean): void;
+export {};

package/typings/utils/debugging.d.cts

@@ -0,0 +1,3 @@
+export declare function debugLog(message: string, ...meta: any[]): void;
+export declare function printLogs(): void;
+export declare function resetLogs(): void;

package/typings/utils/file-system.d.cts

@@ -0,0 +1,4 @@
+export declare function writeFile(filepath: string, content: string): Promise<void>;
+export declare function readFile(filepath: string): Promise<string>;
+export declare function fileExists(filePath: string): Promise<boolean>;
+export declare function unlinkFile(filePath: string, cb?: (err?: Error) => any): void;

package/typings/utils/get-latest-version.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Fetches the version directly from the registry instead of depending on
+ * an ESM only module as latest-version does.
+ * @param packageName
+ */
+export declare function getLatestVersion(packageName: string): Promise<string>;

package/typings/utils/logger.d.cts

@@ -0,0 +1,5 @@
+import { Logger } from 'ts-log';
+export declare function getLogger(): Logger;
+export declare function setLogger(newLogger: Logger): void;
+export declare function setSilentLogger(): void;
+export declare function useWinstonLogger(): void;

package/typings/utils/watcher.d.cts

@@ -0,0 +1,3 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { CodegenContext } from '../config.cjs';
+export declare const createWatcher: (initalContext: CodegenContext, onNext: (result: Types.FileOutput[]) => Promise<Types.FileOutput[]>) => Promise<void>;