@graphql-codegen/cli 2.7.0 → 2.7.1-alpha-223b75f49.0

package/esm/init/plugins.js

@@ -0,0 +1,160 @@
+import { italic } from './helpers.js';
+import { Tags } from './types.js';
+export const plugins = [
+    {
+        name: `TypeScript ${italic('(required by other typescript plugins)')}`,
+        package: '@graphql-codegen/typescript',
+        value: 'typescript',
+        pathInRepo: 'typescript/typescript',
+        available: hasTag(Tags.typescript),
+        shouldBeSelected: tags => oneOf(tags, Tags.angular, Tags.stencil) || allOf(tags, Tags.typescript, Tags.react) || noneOf(tags, Tags.flow),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Operations ${italic('(operations and fragments)')}`,
+        package: '@graphql-codegen/typescript-operations',
+        value: 'typescript-operations',
+        pathInRepo: 'typescript/operations',
+        available: tags => allOf(tags, Tags.browser, Tags.typescript),
+        shouldBeSelected: tags => oneOf(tags, Tags.angular, Tags.stencil) || allOf(tags, Tags.typescript, Tags.react),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Resolvers ${italic('(strongly typed resolve functions)')}`,
+        package: '@graphql-codegen/typescript-resolvers',
+        value: 'typescript-resolvers',
+        pathInRepo: 'typescript/resolvers',
+        available: tags => allOf(tags, Tags.node, Tags.typescript),
+        shouldBeSelected: tags => noneOf(tags, Tags.flow),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Flow ${italic('(required by other flow plugins)')}`,
+        package: '@graphql-codegen/flow',
+        value: 'flow',
+        pathInRepo: 'flow/flow',
+        available: hasTag(Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `Flow Operations ${italic('(operations and fragments)')}`,
+        package: '@graphql-codegen/flow-operations',
+        value: 'flow-operations',
+        pathInRepo: 'flow/operations',
+        available: tags => allOf(tags, Tags.browser, Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `Flow Resolvers ${italic('(strongly typed resolve functions)')}`,
+        package: '@graphql-codegen/flow-resolvers',
+        value: 'flow-resolvers',
+        pathInRepo: 'flow/resolvers',
+        available: tags => allOf(tags, Tags.node, Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `TypeScript Apollo Angular ${italic('(typed GQL services)')}`,
+        package: '@graphql-codegen/typescript-apollo-angular',
+        value: 'typescript-apollo-angular',
+        pathInRepo: 'typescript/apollo-angular',
+        available: hasTag(Tags.angular),
+        shouldBeSelected: () => true,
+        defaultExtension: '.js',
+    },
+    {
+        name: `TypeScript Vue Apollo Composition API ${italic('(typed functions)')}`,
+        package: '@graphql-codegen/typescript-vue-apollo',
+        value: 'typescript-vue-apollo',
+        pathInRepo: 'typescript/vue-apollo',
+        available: tags => allOf(tags, Tags.vue, Tags.typescript),
+        shouldBeSelected: () => true,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Vue Apollo Smart Operations ${italic('(typed functions)')}`,
+        package: '@graphql-codegen/typescript-vue-apollo-smart-ops',
+        value: 'typescript-vue-apollo-smart-ops',
+        pathInRepo: 'typescript/vue-apollo-smart-ops',
+        available: tags => allOf(tags, Tags.vue, Tags.typescript),
+        shouldBeSelected: () => true,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript React Apollo ${italic('(typed components and HOCs)')}`,
+        package: '@graphql-codegen/typescript-react-apollo',
+        value: 'typescript-react-apollo',
+        pathInRepo: 'typescript/react-apollo',
+        available: tags => allOf(tags, Tags.react, Tags.typescript),
+        shouldBeSelected: () => true,
+        defaultExtension: '.tsx',
+    },
+    {
+        name: `TypeScript Stencil Apollo ${italic('(typed components)')}`,
+        package: '@graphql-codegen/typescript-stencil-apollo',
+        value: 'typescript-stencil-apollo',
+        pathInRepo: 'typescript/stencil-apollo',
+        available: hasTag(Tags.stencil),
+        shouldBeSelected: () => true,
+        defaultExtension: '.tsx',
+    },
+    {
+        name: `TypeScript MongoDB ${italic('(typed MongoDB objects)')}`,
+        package: '@graphql-codegen/typescript-mongodb',
+        value: 'typescript-mongodb',
+        pathInRepo: 'typescript/mongodb',
+        available: tags => allOf(tags, Tags.node, Tags.typescript),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript GraphQL files modules ${italic('(declarations for .graphql files)')}`,
+        package: '@graphql-codegen/typescript-graphql-files-modules',
+        value: 'typescript-graphql-files-modules',
+        pathInRepo: 'typescript/graphql-files-modules',
+        available: tags => allOf(tags, Tags.browser, Tags.typescript),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript GraphQL document nodes ${italic('(embedded GraphQL document)')}`,
+        package: '@graphql-codegen/typescript-document-nodes',
+        value: 'typescript-document-nodes',
+        pathInRepo: 'typescript/document-nodes',
+        available: tags => allOf(tags, Tags.typescript),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Introspection Fragment Matcher ${italic('(for Apollo Client)')}`,
+        package: '@graphql-codegen/fragment-matcher',
+        value: 'fragment-matcher',
+        pathInRepo: 'other/fragment-matcher',
+        available: hasTag(Tags.browser),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Urql Introspection ${italic('(for Urql Client)')}`,
+        package: '@graphql-codegen/urql-introspection',
+        value: 'urql-introspection',
+        pathInRepo: 'other/urql-introspection',
+        available: hasTag(Tags.browser),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+];
+function hasTag(tag) {
+    return (tags) => tags.includes(tag);
+}
+function oneOf(list, ...items) {
+    return list.some(i => items.includes(i));
+}
+function noneOf(list, ...items) {
+    return !list.some(i => items.includes(i));
+}
+function allOf(list, ...items) {
+    return items.every(i => list.includes(i));
+}

package/esm/init/questions.js

@@ -0,0 +1,140 @@
+import { grey } from './helpers.js';
+import { Tags } from './types.js';
+import { plugins } from './plugins.js';
+export function getQuestions(possibleTargets) {
+    return [
+        {
+            type: 'checkbox',
+            name: 'targets',
+            message: `What type of application are you building?`,
+            choices: getApplicationTypeChoices(possibleTargets),
+            validate: ((targets) => targets.length > 0),
+        },
+        {
+            type: 'input',
+            name: 'schema',
+            message: 'Where is your schema?:',
+            suffix: grey(' (path or url)'),
+            default: 'http://localhost:4000',
+            validate: (str) => str.length > 0,
+        },
+        {
+            type: 'input',
+            name: 'documents',
+            message: 'Where are your operations and fragments?:',
+            when: answers => {
+                // flatten targets
+                // I can't find an API in Inquirer that would do that
+                answers.targets = normalizeTargets(answers.targets);
+                return answers.targets.includes(Tags.browser);
+            },
+            default: 'src/**/*.graphql',
+            validate: (str) => str.length > 0,
+        },
+        {
+            type: 'checkbox',
+            name: 'plugins',
+            message: 'Pick plugins:',
+            choices: getPluginChoices,
+            validate: ((plugins) => plugins.length > 0),
+        },
+        {
+            type: 'input',
+            name: 'output',
+            message: 'Where to write the output:',
+            default: getOutputDefaultValue,
+            validate: (str) => str.length > 0,
+        },
+        {
+            type: 'confirm',
+            name: 'introspection',
+            message: 'Do you want to generate an introspection file?',
+        },
+        {
+            type: 'input',
+            name: 'config',
+            message: 'How to name the config file?',
+            default: 'codegen.yml',
+            validate: (str) => {
+                const isNotEmpty = str.length > 0;
+                const hasCorrectExtension = ['json', 'yml', 'yaml'].some(ext => str.toLocaleLowerCase().endsWith(`.${ext}`));
+                return isNotEmpty && hasCorrectExtension;
+            },
+        },
+        {
+            type: 'input',
+            name: 'script',
+            message: 'What script in package.json should run the codegen?',
+            validate: (str) => str.length > 0,
+        },
+    ];
+}
+export function getApplicationTypeChoices(possibleTargets) {
+    function withFlowOrTypescript(tags) {
+        if (possibleTargets.TypeScript) {
+            tags.push(Tags.typescript);
+        }
+        else if (possibleTargets.Flow) {
+            tags.push(Tags.flow);
+        }
+        else {
+            tags.push(Tags.flow, Tags.typescript);
+        }
+        return tags;
+    }
+    return [
+        {
+            name: 'Backend - API or server',
+            key: 'backend',
+            value: withFlowOrTypescript([Tags.node]),
+            checked: possibleTargets.Node,
+        },
+        {
+            name: 'Application built with Angular',
+            key: 'angular',
+            value: [Tags.angular, Tags.browser, Tags.typescript],
+            checked: possibleTargets.Angular,
+        },
+        {
+            name: 'Application built with React',
+            key: 'react',
+            value: withFlowOrTypescript([Tags.react, Tags.browser]),
+            checked: possibleTargets.React,
+        },
+        {
+            name: 'Application built with Stencil',
+            key: 'stencil',
+            value: [Tags.stencil, Tags.browser, Tags.typescript],
+            checked: possibleTargets.Stencil,
+        },
+        {
+            name: 'Application built with other framework or vanilla JS',
+            key: 'client',
+            value: [Tags.browser, Tags.typescript, Tags.flow],
+            checked: possibleTargets.Browser && !possibleTargets.Angular && !possibleTargets.React && !possibleTargets.Stencil,
+        },
+    ];
+}
+export function getPluginChoices(answers) {
+    return plugins
+        .filter(p => p.available(answers.targets))
+        .map(p => {
+        return {
+            name: p.name,
+            value: p,
+            checked: p.shouldBeSelected(answers.targets),
+        };
+    });
+}
+function normalizeTargets(targets) {
+    return [].concat(...targets);
+}
+export function getOutputDefaultValue(answers) {
+    if (answers.plugins.some(plugin => plugin.defaultExtension === '.tsx')) {
+        return 'src/generated/graphql.tsx';
+    }
+    if (answers.plugins.some(plugin => plugin.defaultExtension === '.ts')) {
+        return 'src/generated/graphql.ts';
+    }
+    return 'src/generated/graphql.js';
+}

package/esm/init/targets.js

@@ -0,0 +1,40 @@
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { Tags } from './types.js';
+export async function guessTargets() {
+    const pkg = JSON.parse(readFileSync(resolve(process.cwd(), 'package.json'), {
+        encoding: 'utf-8',
+    }));
+    const dependencies = Object.keys({
+        ...pkg.dependencies,
+        ...pkg.devDependencies,
+    });
+    return {
+        [Tags.angular]: isAngular(dependencies),
+        [Tags.react]: isReact(dependencies),
+        [Tags.stencil]: isStencil(dependencies),
+        [Tags.vue]: isVue(dependencies),
+        [Tags.browser]: false,
+        [Tags.node]: false,
+        [Tags.typescript]: isTypescript(dependencies),
+        [Tags.flow]: isFlow(dependencies),
+    };
+}
+function isAngular(dependencies) {
+    return dependencies.includes('@angular/core');
+}
+function isReact(dependencies) {
+    return dependencies.includes('react');
+}
+function isStencil(dependencies) {
+    return dependencies.includes('@stencil/core');
+}
+function isVue(dependencies) {
+    return dependencies.includes('vue') || dependencies.includes('nuxt');
+}
+function isTypescript(dependencies) {
+    return dependencies.includes('typescript');
+}
+function isFlow(dependencies) {
+    return dependencies.includes('flow');
+}

package/esm/init/types.js

@@ -0,0 +1,11 @@
+export var Tags;
+(function (Tags) {
+    Tags["browser"] = "Browser";
+    Tags["node"] = "Node";
+    Tags["typescript"] = "TypeScript";
+    Tags["flow"] = "Flow";
+    Tags["angular"] = "Angular";
+    Tags["stencil"] = "Stencil";
+    Tags["react"] = "React";
+    Tags["vue"] = "Vue";
+})(Tags || (Tags = {}));

package/esm/load.js

@@ -0,0 +1,88 @@
+import { loadSchema as loadSchemaToolkit, loadDocuments as loadDocumentsToolkit, } from '@graphql-tools/load';
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+import { CodeFileLoader } from '@graphql-tools/code-file-loader';
+import { GitLoader } from '@graphql-tools/git-loader';
+import { GithubLoader } from '@graphql-tools/github-loader';
+import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
+import { JsonFileLoader } from '@graphql-tools/json-file-loader';
+import { UrlLoader } from '@graphql-tools/url-loader';
+import { ApolloEngineLoader } from '@graphql-tools/apollo-engine-loader';
+import { PrismaLoader } from '@graphql-tools/prisma-loader';
+import { join, extname } from 'path';
+export const defaultSchemaLoadOptions = {
+    assumeValidSDL: true,
+    sort: true,
+    convertExtensions: true,
+    includeSources: true,
+};
+export const defaultDocumentsLoadOptions = {
+    sort: true,
+    skipGraphQLImport: true,
+};
+export async function loadSchema(schemaPointers, config) {
+    try {
+        const loaders = [
+            new CodeFileLoader(),
+            new GitLoader(),
+            new GithubLoader(),
+            new GraphQLFileLoader(),
+            new JsonFileLoader(),
+            new UrlLoader(),
+            new ApolloEngineLoader(),
+            new PrismaLoader(),
+        ];
+        const schema = await loadSchemaToolkit(schemaPointers, {
+            ...defaultSchemaLoadOptions,
+            loaders,
+            ...config,
+            ...config.config,
+        });
+        return schema;
+    }
+    catch (e) {
+        throw new DetailedError('Failed to load schema', `
+        Failed to load schema from ${Object.keys(schemaPointers).join(',')}:
+
+        ${e.message || e}
+        ${e.stack || ''}
+    
+        GraphQL Code Generator supports:
+          - ES Modules and CommonJS exports (export as default or named export "schema")
+          - Introspection JSON File
+          - URL of GraphQL endpoint
+          - Multiple files with type definitions (glob expression)
+          - String in config file
+    
+        Try to use one of above options and run codegen again.
+    
+      `);
+    }
+}
+export async function loadDocuments(documentPointers, config) {
+    const loaders = [
+        new CodeFileLoader({
+            pluckConfig: {
+                skipIndent: true,
+            },
+        }),
+        new GitLoader(),
+        new GithubLoader(),
+        new GraphQLFileLoader(),
+    ];
+    const ignore = [];
+    for (const generatePath of Object.keys(config.generates)) {
+        if (extname(generatePath) === '') {
+            // we omit paths that don't resolve to a specific file
+            continue;
+        }
+        ignore.push(join(process.cwd(), generatePath));
+    }
+    const loadedFromToolkit = await loadDocumentsToolkit(documentPointers, {
+        ...defaultDocumentsLoadOptions,
+        ignore,
+        loaders,
+        ...config,
+        ...config.config,
+    });
+    return loadedFromToolkit;
+}

package/esm/plugins.js

@@ -0,0 +1,41 @@
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+import { resolve } from 'path';
+export async function getPluginByName(name, pluginLoader) {
+    const possibleNames = [
+        `@graphql-codegen/${name}`,
+        `@graphql-codegen/${name}-template`,
+        `@graphql-codegen/${name}-plugin`,
+        `graphql-codegen-${name}`,
+        `graphql-codegen-${name}-template`,
+        `graphql-codegen-${name}-plugin`,
+        `codegen-${name}`,
+        `codegen-${name}-template`,
+        name,
+    ];
+    const possibleModules = possibleNames.concat(resolve(process.cwd(), name));
+    for (const moduleName of possibleModules) {
+        try {
+            return await pluginLoader(moduleName);
+        }
+        catch (err) {
+            if (err.code !== 'MODULE_NOT_FOUND') {
+                throw new DetailedError(`Unable to load template plugin matching ${name}`, `
+              Unable to load template plugin matching '${name}'.
+              Reason:
+                ${err.message}
+            `);
+            }
+        }
+    }
+    const possibleNamesMsg = possibleNames
+        .map(name => `
+        - ${name}
+    `.trimRight())
+        .join('');
+    throw new DetailedError(`Unable to find template plugin matching ${name}`, `
+        Unable to find template plugin matching '${name}'
+        Install one of the following packages:
+
+        ${possibleNamesMsg}
+      `);
+}

package/esm/presets.js

@@ -0,0 +1,46 @@
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+import { resolve } from 'path';
+export async function getPresetByName(name, loader) {
+    const possibleNames = [
+        `@graphql-codegen/${name}`,
+        `@graphql-codegen/${name}-preset`,
+        name,
+        resolve(process.cwd(), name),
+    ];
+    for (const moduleName of possibleNames) {
+        try {
+            const loaded = await loader(moduleName);
+            if (loaded && loaded.preset) {
+                return loaded.preset;
+            }
+            if (loaded && loaded.default) {
+                return loaded.default;
+            }
+            return loaded;
+        }
+        catch (err) {
+            if (
+            /** CJS Error code */
+            err.code !== 'MODULE_NOT_FOUND' &&
+                /** ESM Error code */
+                err.code !== 'ERR_MODULE_NOT_FOUND') {
+                throw new DetailedError(`Unable to load preset matching ${name}`, `
+              Unable to load preset matching '${name}'.
+              Reason:
+                ${err.message}
+            `);
+            }
+        }
+    }
+    const possibleNamesMsg = possibleNames
+        .map(name => `
+        - ${name}
+    `.trimRight())
+        .join('');
+    throw new DetailedError(`Unable to find preset matching ${name}`, `
+        Unable to find preset matching '${name}'
+        Install one of the following packages:
+
+        ${possibleNamesMsg}
+      `);
+}

package/esm/utils/cli-error.js

@@ -0,0 +1,20 @@
+export function isListrError(err) {
+    return err.name === 'ListrError' && Array.isArray(err.errors) && err.errors.length > 0;
+}
+export function cliError(err, exitOnError = true) {
+    let msg;
+    if (err instanceof Error) {
+        msg = err.message || err.toString();
+    }
+    else if (typeof err === 'string') {
+        msg = err;
+    }
+    else {
+        msg = JSON.stringify(err);
+    }
+    // eslint-disable-next-line no-console
+    console.error(msg);
+    if (exitOnError) {
+        process.exit(1);
+    }
+}

package/esm/utils/debugging.js

@@ -0,0 +1,21 @@
+import { getLogger } from './logger.js';
+let queue = [];
+export function debugLog(message, ...meta) {
+    if (!process.env.GQL_CODEGEN_NODEBUG && process.env.DEBUG !== undefined) {
+        queue.push({
+            message,
+            meta,
+        });
+    }
+}
+export function printLogs() {
+    if (!process.env.GQL_CODEGEN_NODEBUG && process.env.DEBUG !== undefined) {
+        queue.forEach(log => {
+            getLogger().info(log.message, ...log.meta);
+        });
+        resetLogs();
+    }
+}
+export function resetLogs() {
+    queue = [];
+}

package/esm/utils/file-system.js

@@ -0,0 +1,19 @@
+import { unlink as fsUnlink, promises } from 'fs';
+const { writeFile: fsWriteFile, readFile: fsReadFile, stat: fsStat } = promises;
+export function writeFile(filepath, content) {
+    return fsWriteFile(filepath, content);
+}
+export function readFile(filepath) {
+    return fsReadFile(filepath, 'utf-8');
+}
+export async function fileExists(filePath) {
+    try {
+        return (await fsStat(filePath)).isFile();
+    }
+    catch (err) {
+        return false;
+    }
+}
+export function unlinkFile(filePath, cb) {
+    fsUnlink(filePath, cb);
+}

package/esm/utils/logger.js

@@ -0,0 +1,18 @@
+import { dummyLogger } from 'ts-log';
+let logger;
+export function getLogger() {
+    return logger || dummyLogger;
+}
+useWinstonLogger();
+export function setLogger(newLogger) {
+    logger = newLogger;
+}
+export function setSilentLogger() {
+    logger = dummyLogger;
+}
+export function useWinstonLogger() {
+    if (logger && logger.levels) {
+        return;
+    }
+    logger = console;
+}