stepzen 0.17.0 → 0.18.0-beta.0

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.17.0 darwin-x64 node-v14.19.3
+stepzen/0.18.0-beta.0 darwin-x64 node-v14.19.3
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -91,6 +91,13 @@ USAGE
   $ stepzen import SCHEMA
 
 OPTIONS
+  -H, --header=header
+      [curl, graphql] specifies a request header to pass
+
+      Example:
+      stepzen import curl https://example.com/api/customers \
+      -H "Authorization: apikey SecretAPIKeyValue"
+
   -h, --help
       show CLI help
 
@@ -113,8 +120,8 @@ OPTIONS
       working directory
 
   --header-param=header-param
-      [curl] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the
-      variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a
+      [curl, graphql] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing
+      the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a
       parameter.
 
       Example:

package/lib/commands/import.d.ts

@@ -1,16 +1,18 @@
 import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
+import { HeaderInput } from '../shared/header';
 import { Workspace } from '../shared/types';
 export default class Import extends ZenCommand {
     static description: string;
     static commonIntrospectionFlags: {
         prefix: flags.IOptionFlag<string | undefined>;
+        header: flags.IOptionFlag<string[]>;
+        'header-param': flags.IOptionFlag<string[]>;
     };
     static curlFlags: {
         'query-name': flags.IOptionFlag<string | undefined>;
         'query-type': flags.IOptionFlag<string | undefined>;
         'path-params': flags.IOptionFlag<string | undefined>;
-        'header-param': flags.IOptionFlag<string[]>;
     };
     static sqlFlags: {
         'db-host': flags.IOptionFlag<string | undefined>;
@@ -24,6 +26,8 @@ export default class Import extends ZenCommand {
     static flagsForSchemas: ({
         flags: {
             prefix: flags.IOptionFlag<string | undefined>;
+            header: flags.IOptionFlag<string[]>;
+            'header-param': flags.IOptionFlag<string[]>;
         };
         schemas: string[];
     } | {
@@ -31,7 +35,6 @@ export default class Import extends ZenCommand {
             'query-name': flags.IOptionFlag<string | undefined>;
             'query-type': flags.IOptionFlag<string | undefined>;
             'path-params': flags.IOptionFlag<string | undefined>;
-            'header-param': flags.IOptionFlag<string[]>;
         };
         schemas: string[];
     } | {
@@ -57,8 +60,9 @@ export default class Import extends ZenCommand {
         'query-name': flags.IOptionFlag<string | undefined>;
         'query-type': flags.IOptionFlag<string | undefined>;
         'path-params': flags.IOptionFlag<string | undefined>;
-        'header-param': flags.IOptionFlag<string[]>;
         prefix: flags.IOptionFlag<string | undefined>;
+        header: flags.IOptionFlag<string[]>;
+        'header-param': flags.IOptionFlag<string[]>;
         dir: flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
@@ -85,8 +89,9 @@ export default class Import extends ZenCommand {
         'query-name': string | undefined;
         'query-type': string | undefined;
         'path-params': string | undefined;
-        'header-param': string[];
         prefix: string | undefined;
+        header: string[];
+        'header-param': string[];
         dir: string | undefined;
         help: void;
         silent: boolean;
@@ -96,4 +101,5 @@ export default class Import extends ZenCommand {
     }, {
         [name: string]: any;
     }>;
+    parseHeaderFlags(headerFlagValues?: string[], headerParamFlagValues?: string[]): HeaderInput[];
 }

package/lib/commands/import.js

@@ -19,6 +19,7 @@ const graphql2sdl_1 = require("../generate/graphql2sdl");
 const constants_1 = require("../shared/constants");
 const path_params_parser_1 = require("../shared/path-params-parser");
 const header_params_parser_1 = require("../shared/header-params-parser");
+const header_1 = require("../shared/header");
 class Import extends zen_command_1.default {
     async run() {
         const { args, argv, flags } = this.parseWorkaround();
@@ -29,6 +30,7 @@ class Import extends zen_command_1.default {
         // Define a sane onConflict behaviour (possibly interactive)
         const onConflict = await this.ensureOnConflictBehavior(workspace, schema, flags);
         this.warnAboutIgnoredFlags(schema, flags);
+        const headers = this.parseHeaderFlags(flags.header, flags['header-param']);
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function
         //  - v2 with the graphqlize service
@@ -61,7 +63,9 @@ class Import extends zen_command_1.default {
                     'curl command instead of the URL.');
                 console.log();
                 const curlAnswers = await curl2sdl_1.askCurlQuestions(editableOptions);
-                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), curlAnswers), { headers: curlAnswers.curlArgs.headers });
+                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), curlAnswers), { 
+                    // include boths headers passed via flags and headers entered interactively
+                    headers: headers.concat(curlAnswers.curlArgs.headers) });
             }
             else {
                 // run non-interative
@@ -73,15 +77,11 @@ class Import extends zen_command_1.default {
                 if ('error' in parsedPathParamsOrError) {
                     throw new errors_1.CLIError(parsedPathParamsOrError.error);
                 }
-                const headersOrError = header_params_parser_1.makeHeaders(argsOrError.headers, flags['header-param']);
-                if ('error' in headersOrError) {
-                    throw new errors_1.CLIError(headersOrError.error);
-                }
-                const maybeDuplicateParamsMessage = curl2sdl_1.makeDuplicateParamsMessage(headersOrError, parsedPathParamsOrError, argsOrError.url);
+                const maybeDuplicateParamsMessage = curl2sdl_1.makeDuplicateParamsMessage(headers, parsedPathParamsOrError, argsOrError.url);
                 if (maybeDuplicateParamsMessage) {
                     throw new errors_1.CLIError(maybeDuplicateParamsMessage);
                 }
-                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, headers: headersOrError, curlArgs: argsOrError });
+                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, headers: headers, curlArgs: argsOrError });
             }
             core_1.CliUx.ux.action.start('Starting');
             const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
@@ -97,6 +97,7 @@ class Import extends zen_command_1.default {
         else if (schema === 'graphql') {
             const editableOptions = {
                 typePrefix: flags.prefix,
+                headers: headers,
             };
             let answers;
             if (argv.length === 1) {
@@ -217,37 +218,64 @@ class Import extends zen_command_1.default {
     parseWorkaround() {
         const argv = this.argv;
         const parsed = this.parse(Import, argv);
-        if (!parsed.flags['header-param']) {
-            return parsed;
-        }
-        // Every ['--header-param', value] pair in the argv array should match
-        // only one value in the 'header-param' flag's value list.
-        const matchedIndices = new Set();
-        // For each value in the 'header-param' flag's value list, find the original
-        // ['--header-param', value] pair in the argv array.
-        for (let i = 0; i < parsed.flags['header-param'].length; i++) {
-            const value = parsed.flags['header-param'][i];
-            const flagIdx = argv.findIndex((arg, idx) => {
-                const spaceDelimMatch = arg === '--header-param' &&
-                    idx < argv.length &&
-                    argv[idx + 1] === value;
-                const eqlDelimMatch = arg === `--header-param=${value}`;
-                return (spaceDelimMatch || eqlDelimMatch) && !matchedIndices.has(idx);
-            });
-            // If not found, that means the given value was associated with the
-            // `--header-param` flag incorrectly. In that case, it's moved from
-            // `flags` to `argv` in the parsed output.
-            if (flagIdx === -1) {
-                parsed.flags['header-param'].splice(i, 1);
-                i -= 1; // compensate for the .splice() call above
-                parsed.argv.push(value);
-            }
-            else {
-                matchedIndices.add(flagIdx);
+        const fixFlag = (flag) => {
+            if (parsed.flags[flag]) {
+                // Every ['--flag', value] pair in the argv array should match
+                // only one value in the flag's value list.
+                const matchedIndices = new Set();
+                // For each value in the flag's value list, find the original
+                // ['--flag', value] pair in the argv array.
+                for (let i = 0; i < parsed.flags[flag].length; i++) {
+                    const value = parsed.flags[flag][i];
+                    const flagIdx = argv.findIndex((arg, idx) => {
+                        const spaceDelimMatch = (arg === `--${flag}` ||
+                            (Import.flags[flag].char &&
+                                arg === `-${Import.flags[flag].char}`)) &&
+                            idx < argv.length &&
+                            argv[idx + 1] === value;
+                        const eqlDelimMatch = arg === `--${flag}=${value}`;
+                        return ((spaceDelimMatch || eqlDelimMatch) && !matchedIndices.has(idx));
+                    });
+                    // If not found, that means the given value was associated with the
+                    // `flag` incorrectly. In that case, it's moved from `flags` to `argv` in
+                    // the parsed output.
+                    if (flagIdx === -1) {
+                        parsed.flags[flag].splice(i, 1);
+                        i -= 1; // compensate for the .splice() call above
+                        parsed.argv.push(value);
+                    }
+                    else {
+                        matchedIndices.add(flagIdx);
+                    }
+                }
             }
-        }
+        };
+        fixFlag('header');
+        fixFlag('header-param');
         return parsed;
     }
+    parseHeaderFlags(headerFlagValues, headerParamFlagValues) {
+        const headers = [];
+        if (headerFlagValues) {
+            headerFlagValues.forEach(value => {
+                const headerOrError = header_1.parseHeader(value);
+                if (headerOrError && 'error' in headerOrError) {
+                    throw new errors_1.CLIError(headerOrError.error);
+                }
+                // A `null` from parseCurlHeaderString() means a header should NOT be
+                // sent. This is not supported by zenserv / the introspection service
+                // so the CLI simply omits such headers
+                if (headerOrError) {
+                    headers.push(headerOrError); // header
+                }
+            });
+        }
+        const headersOrError = header_params_parser_1.makeHeaders(headers, headerParamFlagValues);
+        if ('error' in headersOrError) {
+            throw new errors_1.CLIError(headersOrError.error);
+        }
+        return headersOrError;
+    }
 }
 exports.default = Import;
 Import.description = 'import a schema for an external data source or a API endpoint to your GraphQL API';
@@ -255,6 +283,26 @@ Import.commonIntrospectionFlags = {
     prefix: command_1.flags.string({
         description: '[curl, graphql] prefix to add every type in the generated schema.',
     }),
+    header: command_1.flags.string({
+        char: 'H',
+        description: `[curl, graphql] specifies a request header to pass` +
+            `\n` +
+            `\nExample:` +
+            `\nstepzen import curl https://example.com/api/customers \\` +
+            `\n\t-H ${chalk.bold('"Authorization: apikey SecretAPIKeyValue"')}`,
+        multiple: true,
+    }),
+    'header-param': command_1.flags.string({
+        description: `[curl, graphql] specifies a parameter in a header value.` +
+            ` Can be formed by taking a ${chalk.bold('-H, --header')} flag and replacing the` +
+            ` variable part of the header value with a ${chalk.bold('$paramName')} placeholder. Repeat this flag once for each header with a parameter.` +
+            `\n` +
+            `\nExample:` +
+            `\nstepzen import curl https://example.com/api/customers \\` +
+            `\n\t-H "Authorization: apikey SecretAPIKeyValue" \\` +
+            `\n\t--header-param 'Authorization: apikey ${chalk.bold('$apikey')}'`,
+        multiple: true,
+    }),
 };
 Import.curlFlags = {
     'query-name': command_1.flags.string({
@@ -275,17 +323,6 @@ Import.curlFlags = {
             ` --path-params` +
             ` '/users/${chalk.bold('$userId')}/posts/${chalk.bold('$postId')}'`,
     }),
-    'header-param': command_1.flags.string({
-        description: `[curl] specifies a parameter in a header value.` +
-            ` Can be formed by taking a ${chalk.bold('-H, --header')} flag and replacing the` +
-            ` variable part of the header value with a ${chalk.bold('$paramName')} placeholder. Repeat this flag once for each header with a parameter.` +
-            `\n` +
-            `\nExample:` +
-            `\nstepzen import curl https://example.com/api/customers \\` +
-            `\n\t-H "Authorization: apikey SecretAPIKeyValue" \\` +
-            `\n\t--header-param 'Authorization: apikey ${chalk.bold('$apikey')}'`,
-        multiple: true,
-    }),
 };
 Import.sqlFlags = {
     'db-host': command_1.flags.string({

package/lib/commands/whoami.js

@@ -12,7 +12,11 @@ class WhoAmI extends zen_command_1.default {
         const configuration = await configuration_1.readConfiguration();
         if (!('account' in configuration)) {
             this.log('You are not logged in.');
-            this.exit();
+            return;
+        }
+        if (configuration.account.startsWith('public')) {
+            this.log(`Account: ${chalk.bold(configuration.account)}`);
+            return;
         }
         const details = {
             account: `${configuration.account}  `,

package/lib/generate/graphql2sdl.d.ts

@@ -5,10 +5,10 @@ export declare type GraphQL2SdlOptions = {
     endpoint: string;
     typePrefix?: string;
     includeRootOperations?: boolean;
-    header?: string;
+    headers: readonly HeaderInput[];
     onConflict: 'overwrite' | 'append';
 };
-export declare type EditableGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'header'>;
+export declare type EditableGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'headers'>;
 export declare type GraphQLAnswers = {
     endpoint: string;
     typePrefix: string;
@@ -16,7 +16,7 @@ export declare type GraphQLAnswers = {
     headers: readonly HeaderInput[];
 };
 export declare const askGraphQLQuestions: (defaultAnswers?: Partial<GraphQLAnswers>) => Promise<EditableGraphQL2SdlOptions>;
-export declare const graphql2sdl: ({ name, source, endpoint, typePrefix, includeRootOperations, header, onConflict, }: GraphQL2SdlOptions) => Promise<{
+export declare const graphql2sdl: ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }: GraphQL2SdlOptions) => Promise<{
     error: string;
 } | {
     outPath: string;

package/lib/generate/graphql2sdl.js

@@ -33,7 +33,7 @@ exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
     questions = questions.map(question => (Object.assign(Object.assign({}, question), { default: lodash_1.get(defaultAnswers, question.name) })));
     return inquirer.prompt(questions);
 };
-exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, header, onConflict, }) => {
+exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }) => {
     const response = await helpers_1.queryIntrospectionService({
         operation: 'getSDLFromGraphQL',
         variables: {
@@ -51,7 +51,7 @@ exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOp
             },
             headers: {
                 type: '[HeaderInput!]',
-                value: header ? [header_1.parseHeaderNameValue(header)] : null,
+                value: headers && headers.length > 0 ? headers : null,
             },
         },
     });

package/lib/generate/index.js

@@ -9,7 +9,7 @@ const path = require("path");
 const transpiler = require("@stepzen/transpiler");
 const helpers_1 = require("./helpers");
 exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }) => {
-    var _a, _b;
+    var _a, _b, _c;
     // Store the generator
     let generator;
     // Initial answers from flags, keyed as <schema>_config
@@ -28,6 +28,9 @@ exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }
             answers: undefined,
         };
     }
+    if ((_b = configure === null || configure === void 0 ? void 0 : configure.errors) === null || _b === void 0 ? void 0 : _b.error) {
+        throw new errors_1.CLIError(configure.errors.error);
+    }
     // For housekeeping
     const tempFiles = [];
     const cleanUp = async () => {
@@ -47,7 +50,7 @@ exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }
             const config = fs.readFileSync(file, 'utf8');
             const json = JSON.parse(config);
             generator = {
-                questions: ((_b = json === null || json === void 0 ? void 0 : json.config) === null || _b === void 0 ? void 0 : _b.questions) || [],
+                questions: ((_c = json === null || json === void 0 ? void 0 : json.config) === null || _c === void 0 ? void 0 : _c.questions) || [],
                 type: 'template',
                 answers: undefined,
             };

package/lib/shared/curl-parser.d.ts

@@ -1,26 +1,11 @@
-export interface CurlHeader {
-    name: string;
-    value: string;
-}
+import { Header } from './header';
+import { ParseError } from './types';
 export interface CurlArguments {
     url: string;
     method: 'Get' | 'Post';
-    headers: CurlHeader[];
+    headers: Header[];
     data?: string;
 }
-export interface ParseError {
-    error: string;
-}
-/**
- * Parse a header string according to https://curl.se/docs/manpage.html#-H
- * and https://datatracker.ietf.org/doc/html/rfc2616#section-4.2
- *
- * @param {*} header a curl header string, e.g. `"api-key: asfdasdfad"`
- * @returns {*} a name/value record or
- *    `null` for the `Header:` notation that means "remove this header" in
- *    the cURL spec or a error object if cannot parse the string.
- */
-export declare const parseCurlHeaderString: (header: string) => CurlHeader | null | ParseError;
 /**
  * Parse a curl command line arguments array to a JSON structure consumable by
  * the StepZen introspection service backend.

package/lib/shared/curl-parser.js

@@ -1,54 +1,16 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCurlArgv = exports.parseCurlHeaderString = void 0;
+exports.parseCurlArgv = void 0;
 const constants_1 = require("./constants");
+const header_1 = require("./header");
 // Based on the existing curl flags at https://curl.se/docs/manpage.html
 const curlFlagRegex = /^(-[a-zA-Z0-9.:#])|(--[a-zA-Z0-9.-]+)$/;
-// Based on the definition of a `token` at
-// https://datatracker.ietf.org/doc/html/rfc2616#page-17
-const httpHeaderRegex = /^(?<name>[a-zA-Z0-9!#$%&'*+,-.^_`|~]+)\s*:(?<value>.*)$/;
 const httpURLRegex = /^https?:\/\//i;
-/**
- * Parse a header string according to https://curl.se/docs/manpage.html#-H
- * and https://datatracker.ietf.org/doc/html/rfc2616#section-4.2
- *
- * @param {*} header a curl header string, e.g. `"api-key: asfdasdfad"`
- * @returns {*} a name/value record or
- *    `null` for the `Header:` notation that means "remove this header" in
- *    the cURL spec or a error object if cannot parse the string.
- */
-exports.parseCurlHeaderString = (header) => {
-    const trimmed = header.trim();
-    // Check if it's a `Header:` case
-    if (trimmed.indexOf(':') === trimmed.length - 1) {
-        // the user intent was to _remove_ this header
-        return null;
-    }
-    // Check if it's a `Header;` case
-    if (trimmed.indexOf(':') === -1 &&
-        trimmed.indexOf(';') === trimmed.length - 1) {
-        return {
-            name: trimmed.substring(0, trimmed.length - 1).trim(),
-            value: '',
-        };
-    }
-    const match = trimmed.match(httpHeaderRegex);
-    if (!match || !match.groups || !match.groups.name || !match.groups.value) {
-        return {
-            error: `Unexpected header syntax in "${header}". ` +
-                `Expected "[name]: [value]", "[name];" or "[name]:"`,
-        };
-    }
-    return {
-        name: match.groups.name,
-        value: match.groups.value.trim(),
-    };
-};
 const isAFlagArg = (arg) => curlFlagRegex.test(arg);
 const isAURL = (arg) => httpURLRegex.test(arg);
 const parseHeaderFlag = (value, partialCurlArgs) => {
-    const headerOrError = exports.parseCurlHeaderString(value);
+    const headerOrError = header_1.parseHeader(value);
     if (headerOrError && 'error' in headerOrError) {
         return headerOrError; // error
     }

package/lib/shared/header-params-parser.d.ts

@@ -1,7 +1,7 @@
-import { HeaderInput } from './header';
-import { ParseError, CurlHeader } from './curl-parser';
-export declare const parseHeaderParam: (headers: readonly CurlHeader[], headerParam: string) => {
+import { Header, HeaderInput } from './header';
+import { ParseError } from './types';
+export declare const parseHeaderParam: (headers: readonly Header[], headerParam: string) => {
     header: HeaderInput;
-    remainingHeaders: CurlHeader[];
+    remainingHeaders: Header[];
 } | ParseError;
-export declare const makeHeaders: (curlHeaders: readonly CurlHeader[], headerParams?: readonly string[]) => ParseError | HeaderInput[];
+export declare const makeHeaders: (curlHeaders: readonly Header[], headerParams?: readonly string[]) => ParseError | HeaderInput[];

package/lib/shared/header-params-parser.js

@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeHeaders = exports.parseHeaderParam = void 0;
 const chalk = require("chalk");
 const debug = require("debug");
-const curl_parser_1 = require("./curl-parser");
+const header_1 = require("./header");
 const headerParamRegex = /^(?<prefix>([^$]|\$\$)*)(?<param>\$[_A-Za-z]\w*);?(?<suffix>.*)$/;
 exports.parseHeaderParam = (headers, headerParam) => {
-    const headerOrError = curl_parser_1.parseCurlHeaderString(headerParam);
+    const headerOrError = header_1.parseHeader(headerParam);
     if (!headerOrError || 'error' in headerOrError) {
         if (headerOrError) {
             debug('stepzen:curl2sdl')(`Failed to parse a header param ${headerParam}.` +

package/lib/shared/header.d.ts

@@ -1,7 +1,9 @@
-export declare type NameValueHeaderInput = {
+import { ParseError } from './types';
+export interface Header {
     name: string;
     value: string;
-};
+}
+export declare type NameValueHeaderInput = Header;
 export declare type NamePartsHeaderInput = {
     name: string;
     parts: HeaderInputValuePart[];
@@ -18,4 +20,13 @@ export declare type HeaderInputVariableValuePart = {
 };
 export declare type HeaderInputValuePart = HeaderInputConstantValuePart | HeaderInputVariableValuePart;
 export declare const HEADER_REGEX: RegExp;
-export declare const parseHeaderNameValue: (input: string) => NameValueHeaderInput | null;
+/**
+ * Parse a header string according to https://curl.se/docs/manpage.html#-H
+ * and https://datatracker.ietf.org/doc/html/rfc2616#section-4.2
+ *
+ * @param {*} header a curl header string, e.g. `"api-key: asfdasdfad"`
+ * @returns {*} a name/value record or
+ *    `null` for the `Header:` notation that means "remove this header" in
+ *    the cURL spec or a error object if cannot parse the string.
+ */
+export declare const parseHeader: (header: string) => Header | null | ParseError;

package/lib/shared/header.js

@@ -1,13 +1,43 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseHeaderNameValue = exports.HEADER_REGEX = void 0;
-exports.HEADER_REGEX = /([\w-]+): (.*)/;
-exports.parseHeaderNameValue = (input) => {
-    const match = input.match(exports.HEADER_REGEX);
-    if (match) {
-        const [name, value] = match.splice(1, 2);
-        return { name, value };
+exports.parseHeader = exports.HEADER_REGEX = void 0;
+// Based on the definition of a `token` at
+// https://datatracker.ietf.org/doc/html/rfc2616#page-17
+exports.HEADER_REGEX = /^(?<name>[a-zA-Z0-9!#$%&'*+,-.^_`|~]+)\s*:(?<value>.*)$/;
+/**
+ * Parse a header string according to https://curl.se/docs/manpage.html#-H
+ * and https://datatracker.ietf.org/doc/html/rfc2616#section-4.2
+ *
+ * @param {*} header a curl header string, e.g. `"api-key: asfdasdfad"`
+ * @returns {*} a name/value record or
+ *    `null` for the `Header:` notation that means "remove this header" in
+ *    the cURL spec or a error object if cannot parse the string.
+ */
+exports.parseHeader = (header) => {
+    const trimmed = header.trim();
+    // Check if it's a `Header:` case
+    if (trimmed.indexOf(':') === trimmed.length - 1) {
+        // the user intent was to _remove_ this header
+        return null;
     }
-    return null;
+    // Check if it's a `Header;` case
+    if (trimmed.indexOf(':') === -1 &&
+        trimmed.indexOf(';') === trimmed.length - 1) {
+        return {
+            name: trimmed.substring(0, trimmed.length - 1).trim(),
+            value: '',
+        };
+    }
+    const match = trimmed.match(exports.HEADER_REGEX);
+    if (!match || !match.groups || !match.groups.name || !match.groups.value) {
+        return {
+            error: `Unexpected header syntax in "${header}". ` +
+                `Expected "[name]: [value]", "[name];" or "[name]:"`,
+        };
+    }
+    return {
+        name: match.groups.name,
+        value: match.groups.value.trim(),
+    };
 };

package/lib/shared/path-params-parser.d.ts

@@ -1,4 +1,4 @@
-import { ParseError } from './curl-parser';
+import { ParseError } from './types';
 export declare type PathParam = {
     index: number;
     name: string;

package/lib/shared/types.d.ts

@@ -36,3 +36,9 @@ export interface ZenCtlResponse {
     results?: Array<string>;
     success: boolean;
 }
+/**
+ * Represents an error during parsing of a string.
+ */
+export interface ParseError {
+    error: string;
+}

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.17.0","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"import a schema for an external data source or a API endpoint to your GraphQL API","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema."},"overwrite":{"name":"overwrite","type":"boolean","description":"Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] prefix to add every type in the generated schema."},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by \u001b[1m--query-type\u001b[22m is not prefixed by \u001b[1m--prefix\u001b[22m if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with \u001b[1m$paramName\u001b[22m placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/\u001b[1m$userId\u001b[22m/posts/\u001b[1m$postId\u001b[22m'"},"header-param":{"name":"header-param","type":"option","description":"[curl] specifies a parameter in a header value. Can be formed by taking a \u001b[1m-H, --header\u001b[22m flag and replacing the variable part of the header value with a \u001b[1m$paramName\u001b[22m placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey \u001b[1m$apikey\u001b[22m'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] name of database to import"},"db-schema":{"name":"db-schema","type":"option","description":"[postgresql] database schema"}},"args":[{"name":"schema","required":true}]},"init":{"id":"init","description":"stepzen init","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"StepZen lint","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"list":{"id":"list","description":"list your items","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationsets","schemas"]}]},"login":{"id":"login","description":"log in to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"account":{"name":"account","type":"option","char":"a","hidden":true},"adminkey":{"name":"adminkey","type":"option","char":"k","hidden":true},"public":{"name":"public","type":"boolean","description":"Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not suitable for handling private data as all endpoints created with a public account will be public.","allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"log out of StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"upload and deploy your schema","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"transpile a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"upload to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"validate a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"display your credentials with StepZen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}
+{"version":"0.18.0-beta.0","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"import a schema for an external data source or a API endpoint to your GraphQL API","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema."},"overwrite":{"name":"overwrite","type":"boolean","description":"Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] prefix to add every type in the generated schema."},"header":{"name":"header","type":"option","char":"H","description":"[curl, graphql] specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\""},"header-param":{"name":"header-param","type":"option","description":"[curl, graphql] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] name of database to import"},"db-schema":{"name":"db-schema","type":"option","description":"[postgresql] database schema"}},"args":[{"name":"schema","required":true}]},"init":{"id":"init","description":"stepzen init","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"StepZen lint","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"list":{"id":"list","description":"list your items","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationsets","schemas"]}]},"login":{"id":"login","description":"log in to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"account":{"name":"account","type":"option","char":"a","hidden":true},"adminkey":{"name":"adminkey","type":"option","char":"k","hidden":true},"public":{"name":"public","type":"boolean","description":"Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not suitable for handling private data as all endpoints created with a public account will be public.","allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"log out of StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"upload and deploy your schema","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"transpile a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"upload to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"validate a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"display your credentials with StepZen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stepzen",
   "description": "The StepZen CLI",
-  "version": "0.17.0",
+  "version": "0.18.0-beta.0",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [