@graphql-codegen/typescript-oclif 2.2.14 → 2.2.15-alpha-5d16266dd.0

package/cjs/index.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLRequestVisitor = exports.validate = exports.plugin = void 0;
+const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
+const graphql_1 = require("graphql");
+const visitor_js_1 = require("./visitor.js");
+Object.defineProperty(exports, "GraphQLRequestVisitor", { enumerable: true, get: function () { return visitor_js_1.GraphQLRequestVisitor; } });
+const path_1 = require("path");
+const plugin = (schema, documents, config, info) => {
+    const allAst = (0, graphql_1.concatAST)(documents.reduce((prev, v) => {
+        return [...prev, v.document];
+    }, []));
+    const allFragments = [
+        ...allAst.definitions.filter(d => d.kind === graphql_1.Kind.FRAGMENT_DEFINITION).map(fragmentDef => ({
+            node: fragmentDef,
+            name: fragmentDef.name.value,
+            onType: fragmentDef.typeCondition.name.value,
+            isExternal: false,
+        })),
+        ...(config.externalFragments || []),
+    ];
+    const visitor = new visitor_js_1.GraphQLRequestVisitor(schema, allFragments, config, info);
+    (0, plugin_helpers_1.oldVisit)(allAst, { leave: visitor });
+    return {
+        prepend: visitor.getImports(),
+        content: visitor.cliContent,
+    };
+};
+exports.plugin = plugin;
+const validate = async (schema, documents, config, outputFile) => {
+    if ((0, path_1.extname)(outputFile) !== '.ts') {
+        throw new Error(`Plugin "typescript-oclif" requires output file extensions to be ".ts"!`);
+    }
+};
+exports.validate = validate;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/utils.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.omitOclifDirectives = exports.getFlagConfigForVariableDefinition = void 0;
+const getFlagConfigForVariableDefinition = (definition) => {
+    const { list, required, innerType } = getInnerType(definition.type);
+    const oclifType = mapVariableTypeToOclifType(innerType);
+    const parser = getParserForType(innerType);
+    return `${definition.variable.name.value}: flags.${oclifType}({
+  multiple: ${list},
+  required: ${required},${parser ? `\n  parse: ${parser}` : ''}
+})`;
+};
+exports.getFlagConfigForVariableDefinition = getFlagConfigForVariableDefinition;
+// Supply a custom parser for oclif flag configuration
+const getParserForType = (type) => {
+    if (type.name.value === 'Float') {
+        return 'input => Number(input)';
+    }
+};
+const mapVariableTypeToOclifType = (type) => {
+    if (type.name.value === 'Boolean') {
+        return 'boolean';
+    }
+    if (['Float', 'Int'].includes(type.name.value)) {
+        // A quirk of oclif is that "integer" allows for any `number`-typed response, and then
+        //   we supply our own parsing function to make sure it's a float and not an integer
+        return 'integer';
+    }
+    return 'string';
+};
+// Retrieve the inner type if nested within List and/or NonNull
+const getInnerType = (type) => {
+    const result = {
+        list: false,
+        required: false,
+    };
+    let _type = type;
+    while (_type.kind !== 'NamedType') {
+        if (_type.kind === 'ListType') {
+            result.list = true;
+        }
+        else if (_type.kind === 'NonNullType') {
+            result.required = true;
+        }
+        _type = _type.type;
+    }
+    result.innerType = _type;
+    return result;
+};
+// remove all @oclif directives from the document for transmission to the server
+const omitOclifDirectives = (node) => {
+    const directives = node.directives.filter(directive => directive.name.value !== 'oclif');
+    return Object.assign({}, node, { directives });
+};
+exports.omitOclifDirectives = omitOclifDirectives;

package/cjs/visitor.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLRequestVisitor = void 0;
+const tslib_1 = require("tslib");
+const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
+const auto_bind_1 = tslib_1.__importDefault(require("auto-bind"));
+const graphql_1 = require("graphql");
+const utils_js_1 = require("./utils.js");
+class GraphQLRequestVisitor extends visitor_plugin_common_1.ClientSideBaseVisitor {
+    constructor(schema, fragments, rawConfig, info) {
+        super(schema, fragments, rawConfig, {});
+        this._operationsToInclude = [];
+        this._info = info;
+        const { handlerPath = '../../handler' } = rawConfig;
+        // FIXME: This is taken in part from
+        //  presets/near-operation-file/src/index.ts:139. How do I build a path relative to the outputFile in the same way?
+        //  A plugin doesn't appear to have access to the same "options.baseOutputDir" that the preset does.
+        // const absClientPath = resolve(info.outputFile, join(options.baseOutputDir, options.presetConfig.baseTypesPath));
+        (0, auto_bind_1.default)(this);
+        this._additionalImports.push(`import { Command, flags } from '@oclif/command'`);
+        this._additionalImports.push(`import handler from '${handlerPath}'`);
+    }
+    buildOperation(node, documentVariableName, operationType, operationResultType, operationVariablesTypes) {
+        this._operationsToInclude.push({
+            node,
+            documentVariableName,
+            operationType,
+            operationResultType,
+            operationVariablesTypes,
+        });
+        return null;
+    }
+    // Clean client-side content (ie directives) out of the GraphQL document prior to sending to the server
+    get definition() {
+        const operation = this._operationsToInclude[0];
+        const clientOperation = (0, graphql_1.print)((0, utils_js_1.omitOclifDirectives)(operation.node));
+        return `const ${operation.documentVariableName} = \`\n${clientOperation}\``;
+    }
+    // Generate the code required for this CLI operation
+    get cliContent() {
+        if (this._operationsToInclude.length !== 1) {
+            throw new Error(`Each graphql document should have exactly one operation; found ${this._operationsToInclude.length} while generating ${this._info.outputFile}.`);
+        }
+        const operation = this._operationsToInclude[0];
+        // Find the @oclif directive in the client document, if it's there
+        const directive = operation.node.directives.find(directive => directive.name.value === 'oclif');
+        // Remap the directive's fields ie @oclif(description: "a name") to a more usable format
+        const directiveValues = {};
+        if (directive) {
+            directiveValues.examples = [];
+            directive.arguments.forEach(arg => {
+                const value = 'value' in arg.value ? arg.value.value.toString() : null;
+                const { value: name } = arg.name;
+                if (name === 'description') {
+                    directiveValues.description = value;
+                }
+                else if (name === 'example') {
+                    directiveValues.examples.push(value);
+                }
+                else {
+                    throw new Error(`Invalid field supplied to @oclif directive: ${name}`);
+                }
+            });
+        }
+        const { description, examples } = directiveValues;
+        const flags = operation.node.variableDefinitions.map(utils_js_1.getFlagConfigForVariableDefinition);
+        return `
+${this.definition}
+
+export default class ${operation.node.name.value} extends Command {
+  ${description ? `\nstatic description = "${description}";\n` : ''}
+  ${examples ? `\nstatic examples: string[] = ${JSON.stringify(examples)};\n` : ''}
+  static flags = {
+    help: flags.help({ char: 'h' }),
+${(0, visitor_plugin_common_1.indentMultiline)(flags.join(',\n'), 2)}
+  };
+
+  async run() {
+    const { flags } = this.parse(${operation.node.name.value});
+    await handler({ command: this, query: ${operation.documentVariableName}, variables: flags });
+  }
+}
+`;
+    }
+}
+exports.GraphQLRequestVisitor = GraphQLRequestVisitor;

package/esm/index.js

@@ -0,0 +1,30 @@
+import { oldVisit } from '@graphql-codegen/plugin-helpers';
+import { concatAST, Kind } from 'graphql';
+import { GraphQLRequestVisitor } from './visitor.js';
+import { extname } from 'path';
+export const plugin = (schema, documents, config, info) => {
+    const allAst = concatAST(documents.reduce((prev, v) => {
+        return [...prev, v.document];
+    }, []));
+    const allFragments = [
+        ...allAst.definitions.filter(d => d.kind === Kind.FRAGMENT_DEFINITION).map(fragmentDef => ({
+            node: fragmentDef,
+            name: fragmentDef.name.value,
+            onType: fragmentDef.typeCondition.name.value,
+            isExternal: false,
+        })),
+        ...(config.externalFragments || []),
+    ];
+    const visitor = new GraphQLRequestVisitor(schema, allFragments, config, info);
+    oldVisit(allAst, { leave: visitor });
+    return {
+        prepend: visitor.getImports(),
+        content: visitor.cliContent,
+    };
+};
+export const validate = async (schema, documents, config, outputFile) => {
+    if (extname(outputFile) !== '.ts') {
+        throw new Error(`Plugin "typescript-oclif" requires output file extensions to be ".ts"!`);
+    }
+};
+export { GraphQLRequestVisitor };

package/esm/utils.js

@@ -0,0 +1,50 @@
+export const getFlagConfigForVariableDefinition = (definition) => {
+    const { list, required, innerType } = getInnerType(definition.type);
+    const oclifType = mapVariableTypeToOclifType(innerType);
+    const parser = getParserForType(innerType);
+    return `${definition.variable.name.value}: flags.${oclifType}({
+  multiple: ${list},
+  required: ${required},${parser ? `\n  parse: ${parser}` : ''}
+})`;
+};
+// Supply a custom parser for oclif flag configuration
+const getParserForType = (type) => {
+    if (type.name.value === 'Float') {
+        return 'input => Number(input)';
+    }
+};
+const mapVariableTypeToOclifType = (type) => {
+    if (type.name.value === 'Boolean') {
+        return 'boolean';
+    }
+    if (['Float', 'Int'].includes(type.name.value)) {
+        // A quirk of oclif is that "integer" allows for any `number`-typed response, and then
+        //   we supply our own parsing function to make sure it's a float and not an integer
+        return 'integer';
+    }
+    return 'string';
+};
+// Retrieve the inner type if nested within List and/or NonNull
+const getInnerType = (type) => {
+    const result = {
+        list: false,
+        required: false,
+    };
+    let _type = type;
+    while (_type.kind !== 'NamedType') {
+        if (_type.kind === 'ListType') {
+            result.list = true;
+        }
+        else if (_type.kind === 'NonNullType') {
+            result.required = true;
+        }
+        _type = _type.type;
+    }
+    result.innerType = _type;
+    return result;
+};
+// remove all @oclif directives from the document for transmission to the server
+export const omitOclifDirectives = (node) => {
+    const directives = node.directives.filter(directive => directive.name.value !== 'oclif');
+    return Object.assign({}, node, { directives });
+};

package/{index.mjs → esm/visitor.js}

@@ -1,61 +1,8 @@
-import { oldVisit } from '@graphql-codegen/plugin-helpers';
-import { print, concatAST, Kind } from 'graphql';
-import { ClientSideBaseVisitor, indentMultiline } from '@graphql-codegen/visitor-plugin-common';
+import { ClientSideBaseVisitor, indentMultiline, } from '@graphql-codegen/visitor-plugin-common';
 import autoBind from 'auto-bind';
-import { extname } from 'path';
-
-const getFlagConfigForVariableDefinition = (definition) => {
-    const { list, required, innerType } = getInnerType(definition.type);
-    const oclifType = mapVariableTypeToOclifType(innerType);
-    const parser = getParserForType(innerType);
-    return `${definition.variable.name.value}: flags.${oclifType}({
-  multiple: ${list},
-  required: ${required},${parser ? `\n  parse: ${parser}` : ''}
-})`;
-};
-// Supply a custom parser for oclif flag configuration
-const getParserForType = (type) => {
-    if (type.name.value === 'Float') {
-        return 'input => Number(input)';
-    }
-};
-const mapVariableTypeToOclifType = (type) => {
-    if (type.name.value === 'Boolean') {
-        return 'boolean';
-    }
-    if (['Float', 'Int'].includes(type.name.value)) {
-        // A quirk of oclif is that "integer" allows for any `number`-typed response, and then
-        //   we supply our own parsing function to make sure it's a float and not an integer
-        return 'integer';
-    }
-    return 'string';
-};
-// Retrieve the inner type if nested within List and/or NonNull
-const getInnerType = (type) => {
-    const result = {
-        list: false,
-        required: false,
-    };
-    let _type = type;
-    while (_type.kind !== 'NamedType') {
-        if (_type.kind === 'ListType') {
-            result.list = true;
-        }
-        else if (_type.kind === 'NonNullType') {
-            result.required = true;
-        }
-        _type = _type.type;
-    }
-    result.innerType = _type;
-    return result;
-};
-// remove all @oclif directives from the document for transmission to the server
-const omitOclifDirectives = (node) => {
-    const directives = node.directives.filter(directive => directive.name.value !== 'oclif');
-    return Object.assign({}, node, { directives });
-};
-
-class GraphQLRequestVisitor extends ClientSideBaseVisitor {
+import { print } from 'graphql';
+import { getFlagConfigForVariableDefinition, omitOclifDirectives } from './utils.js';
+export class GraphQLRequestVisitor extends ClientSideBaseVisitor {
     constructor(schema, fragments, rawConfig, info) {
         super(schema, fragments, rawConfig, {});
         this._operationsToInclude = [];
@@ -132,31 +79,3 @@ ${indentMultiline(flags.join(',\n'), 2)}
 `;
     }
 }
-
-const plugin = (schema, documents, config, info) => {
-    const allAst = concatAST(documents.reduce((prev, v) => {
-        return [...prev, v.document];
-    }, []));
-    const allFragments = [
-        ...allAst.definitions.filter(d => d.kind === Kind.FRAGMENT_DEFINITION).map(fragmentDef => ({
-            node: fragmentDef,
-            name: fragmentDef.name.value,
-            onType: fragmentDef.typeCondition.name.value,
-            isExternal: false,
-        })),
-        ...(config.externalFragments || []),
-    ];
-    const visitor = new GraphQLRequestVisitor(schema, allFragments, config, info);
-    oldVisit(allAst, { leave: visitor });
-    return {
-        prepend: visitor.getImports(),
-        content: visitor.cliContent,
-    };
-};
-const validate = async (schema, documents, config, outputFile) => {
-    if (extname(outputFile) !== '.ts') {
-        throw new Error(`Plugin "typescript-oclif" requires output file extensions to be ".ts"!`);
-    }
-};
-
-export { GraphQLRequestVisitor, plugin, validate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/typescript-oclif",
-  "version": "2.2.14",
+  "version": "2.2.15-alpha-5d16266dd.0",
   "description": "GraphQL Code Generator plugin for generating a CLI tool with oclif",
   "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",
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@graphql-codegen/plugin-helpers": "^2.4.0",
-    "@graphql-codegen/visitor-plugin-common": "2.10.0",
+    "@graphql-codegen/visitor-plugin-common": "2.11.0-alpha-5d16266dd.0",
     "auto-bind": "~4.0.0",
     "tslib": "~2.4.0"
   },
@@ -19,21 +19,28 @@
   },
   "author": "Kalan Snyder <hello@kalan.io>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
-    "./package.json": "./package.json",
     ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
-    "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
-    }
+    "./package.json": "./package.json"
   }
-}
+}

package/{index.d.ts → typings/index.d.ts}

@@ -1,6 +1,6 @@
 import { PluginValidateFn, PluginFunction } from '@graphql-codegen/plugin-helpers';
 import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
-import { GraphQLRequestVisitor } from './visitor';
+import { GraphQLRequestVisitor } from './visitor.js';
 export interface Config extends RawClientSideBasePluginConfig {
     handlerPath?: string;
 }

package/{visitor.d.ts → typings/visitor.d.ts}

@@ -1,6 +1,6 @@
 import { ClientSideBaseVisitor, ClientSideBasePluginConfig, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
 import { GraphQLSchema, OperationDefinitionNode } from 'graphql';
-import { Config, Info } from '.';
+import { Config, Info } from './index.js';
 export declare class GraphQLRequestVisitor extends ClientSideBaseVisitor<Config, ClientSideBasePluginConfig> {
     private _operationsToInclude;
     private _info;

package/index.js

@@ -1,170 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-const pluginHelpers = require('@graphql-codegen/plugin-helpers');
-const graphql = require('graphql');
-const visitorPluginCommon = require('@graphql-codegen/visitor-plugin-common');
-const autoBind = _interopDefault(require('auto-bind'));
-const path = require('path');
-
-const getFlagConfigForVariableDefinition = (definition) => {
-    const { list, required, innerType } = getInnerType(definition.type);
-    const oclifType = mapVariableTypeToOclifType(innerType);
-    const parser = getParserForType(innerType);
-    return `${definition.variable.name.value}: flags.${oclifType}({
-  multiple: ${list},
-  required: ${required},${parser ? `\n  parse: ${parser}` : ''}
-})`;
-};
-// Supply a custom parser for oclif flag configuration
-const getParserForType = (type) => {
-    if (type.name.value === 'Float') {
-        return 'input => Number(input)';
-    }
-};
-const mapVariableTypeToOclifType = (type) => {
-    if (type.name.value === 'Boolean') {
-        return 'boolean';
-    }
-    if (['Float', 'Int'].includes(type.name.value)) {
-        // A quirk of oclif is that "integer" allows for any `number`-typed response, and then
-        //   we supply our own parsing function to make sure it's a float and not an integer
-        return 'integer';
-    }
-    return 'string';
-};
-// Retrieve the inner type if nested within List and/or NonNull
-const getInnerType = (type) => {
-    const result = {
-        list: false,
-        required: false,
-    };
-    let _type = type;
-    while (_type.kind !== 'NamedType') {
-        if (_type.kind === 'ListType') {
-            result.list = true;
-        }
-        else if (_type.kind === 'NonNullType') {
-            result.required = true;
-        }
-        _type = _type.type;
-    }
-    result.innerType = _type;
-    return result;
-};
-// remove all @oclif directives from the document for transmission to the server
-const omitOclifDirectives = (node) => {
-    const directives = node.directives.filter(directive => directive.name.value !== 'oclif');
-    return Object.assign({}, node, { directives });
-};
-
-class GraphQLRequestVisitor extends visitorPluginCommon.ClientSideBaseVisitor {
-    constructor(schema, fragments, rawConfig, info) {
-        super(schema, fragments, rawConfig, {});
-        this._operationsToInclude = [];
-        this._info = info;
-        const { handlerPath = '../../handler' } = rawConfig;
-        // FIXME: This is taken in part from
-        //  presets/near-operation-file/src/index.ts:139. How do I build a path relative to the outputFile in the same way?
-        //  A plugin doesn't appear to have access to the same "options.baseOutputDir" that the preset does.
-        // const absClientPath = resolve(info.outputFile, join(options.baseOutputDir, options.presetConfig.baseTypesPath));
-        autoBind(this);
-        this._additionalImports.push(`import { Command, flags } from '@oclif/command'`);
-        this._additionalImports.push(`import handler from '${handlerPath}'`);
-    }
-    buildOperation(node, documentVariableName, operationType, operationResultType, operationVariablesTypes) {
-        this._operationsToInclude.push({
-            node,
-            documentVariableName,
-            operationType,
-            operationResultType,
-            operationVariablesTypes,
-        });
-        return null;
-    }
-    // Clean client-side content (ie directives) out of the GraphQL document prior to sending to the server
-    get definition() {
-        const operation = this._operationsToInclude[0];
-        const clientOperation = graphql.print(omitOclifDirectives(operation.node));
-        return `const ${operation.documentVariableName} = \`\n${clientOperation}\``;
-    }
-    // Generate the code required for this CLI operation
-    get cliContent() {
-        if (this._operationsToInclude.length !== 1) {
-            throw new Error(`Each graphql document should have exactly one operation; found ${this._operationsToInclude.length} while generating ${this._info.outputFile}.`);
-        }
-        const operation = this._operationsToInclude[0];
-        // Find the @oclif directive in the client document, if it's there
-        const directive = operation.node.directives.find(directive => directive.name.value === 'oclif');
-        // Remap the directive's fields ie @oclif(description: "a name") to a more usable format
-        const directiveValues = {};
-        if (directive) {
-            directiveValues.examples = [];
-            directive.arguments.forEach(arg => {
-                const value = 'value' in arg.value ? arg.value.value.toString() : null;
-                const { value: name } = arg.name;
-                if (name === 'description') {
-                    directiveValues.description = value;
-                }
-                else if (name === 'example') {
-                    directiveValues.examples.push(value);
-                }
-                else {
-                    throw new Error(`Invalid field supplied to @oclif directive: ${name}`);
-                }
-            });
-        }
-        const { description, examples } = directiveValues;
-        const flags = operation.node.variableDefinitions.map(getFlagConfigForVariableDefinition);
-        return `
-${this.definition}
-
-export default class ${operation.node.name.value} extends Command {
-  ${description ? `\nstatic description = "${description}";\n` : ''}
-  ${examples ? `\nstatic examples: string[] = ${JSON.stringify(examples)};\n` : ''}
-  static flags = {
-    help: flags.help({ char: 'h' }),
-${visitorPluginCommon.indentMultiline(flags.join(',\n'), 2)}
-  };
-
-  async run() {
-    const { flags } = this.parse(${operation.node.name.value});
-    await handler({ command: this, query: ${operation.documentVariableName}, variables: flags });
-  }
-}
-`;
-    }
-}
-
-const plugin = (schema, documents, config, info) => {
-    const allAst = graphql.concatAST(documents.reduce((prev, v) => {
-        return [...prev, v.document];
-    }, []));
-    const allFragments = [
-        ...allAst.definitions.filter(d => d.kind === graphql.Kind.FRAGMENT_DEFINITION).map(fragmentDef => ({
-            node: fragmentDef,
-            name: fragmentDef.name.value,
-            onType: fragmentDef.typeCondition.name.value,
-            isExternal: false,
-        })),
-        ...(config.externalFragments || []),
-    ];
-    const visitor = new GraphQLRequestVisitor(schema, allFragments, config, info);
-    pluginHelpers.oldVisit(allAst, { leave: visitor });
-    return {
-        prepend: visitor.getImports(),
-        content: visitor.cliContent,
-    };
-};
-const validate = async (schema, documents, config, outputFile) => {
-    if (path.extname(outputFile) !== '.ts') {
-        throw new Error(`Plugin "typescript-oclif" requires output file extensions to be ".ts"!`);
-    }
-};
-
-exports.GraphQLRequestVisitor = GraphQLRequestVisitor;
-exports.plugin = plugin;
-exports.validate = validate;