stepzen 0.15.0-beta.1 → 0.16.0-beta.0

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.15.0-beta.1 darwin-x64 node-v14.19.1
+stepzen/0.16.0-beta.0 darwin-x64 node-v14.19.1
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -94,9 +94,34 @@ OPTIONS
   -h, --help
       show CLI help
 
+  --db-database=db-database
+      [mysql, postgresql] name of database to import
+
+  --db-host=db-host
+      [mysql, postgresql] database host
+
+  --db-password=db-password
+      [mysql, postgresql] database password
+
+  --db-schema=db-schema
+      [postgresql] database schema
+
+  --db-user=db-user
+      [mysql, postgresql] database user name
+
   --dir=dir
       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
+      parameter.
+
+      Example:
+      stepzen import curl https://example.com/api/customers \
+      -H "Authorization: apikey SecretAPIKeyValue" \
+      --header-param 'Authorization: apikey $apikey'
+
   --name=name
       subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name
 

package/lib/commands/deploy.d.ts

@@ -8,7 +8,6 @@ export default class Deploy extends ZenCommand {
         schema: flags.IOptionFlag<string>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/import.d.ts

@@ -2,17 +2,38 @@ import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
 export default class Import extends ZenCommand {
     static description: string;
+    static curlFlags: {
+        prefix: flags.IOptionFlag<string | undefined>;
+        '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>;
+        'db-user': flags.IOptionFlag<string | undefined>;
+        'db-password': flags.IOptionFlag<string | undefined>;
+        'db-database': flags.IOptionFlag<string | undefined>;
+    };
+    static postgresqlFlags: {
+        'db-schema': flags.IOptionFlag<string | undefined>;
+    };
     static flags: {
-        dir: flags.IOptionFlag<string | undefined>;
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        name: flags.IOptionFlag<string | undefined>;
+        'db-schema': flags.IOptionFlag<string | undefined>;
+        'db-host': flags.IOptionFlag<string | undefined>;
+        'db-user': flags.IOptionFlag<string | undefined>;
+        'db-password': flags.IOptionFlag<string | undefined>;
+        'db-database': flags.IOptionFlag<string | undefined>;
         prefix: flags.IOptionFlag<string | undefined>;
         'query-name': flags.IOptionFlag<string | undefined>;
         'query-type': flags.IOptionFlag<string | undefined>;
         'path-params': flags.IOptionFlag<string | undefined>;
+        '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>;
+        name: flags.IOptionFlag<string | undefined>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         name: string;
@@ -20,4 +41,5 @@ export default class Import extends ZenCommand {
     }[];
     static strict: boolean;
     run(): Promise<void>;
+    warnAboutIgnoredFlags: (schemas: string[], maybeIgnored: string[], relevantSchemas: string[]) => void;
 }

package/lib/commands/import.js

@@ -17,7 +17,24 @@ const zen_command_1 = require("../shared/zen-command");
 const init_1 = require("./init");
 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");
 class Import extends zen_command_1.default {
+    constructor() {
+        super(...arguments);
+        // notify the user about any ignored flags
+        this.warnAboutIgnoredFlags = (schemas, maybeIgnored, relevantSchemas) => {
+            if (!schemas.some(schema => relevantSchemas.includes(schema))) {
+                maybeIgnored.forEach(flag => {
+                    // eslint-disable-next-line no-prototype-builtins
+                    if (command_1.flags.hasOwnProperty(flag)) {
+                        this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${relevantSchemas
+                            .map(schema => chalk.bold(schema))
+                            .join(', ')}. It will be ignored now.`));
+                    }
+                });
+            }
+        };
+    }
     async run() {
         const { args, argv, flags } = this.parse(Import);
         // Get a list of schemas you're asking for
@@ -41,6 +58,14 @@ class Import extends zen_command_1.default {
                 throw new errors_1.CLIError(`Could not create a StepZen workspace in the ${flags.dir ? directory : 'current'} directory.\n` + error.message);
             }
         }
+        this.warnAboutIgnoredFlags(schemas, Object.keys(Import.curlFlags), ['curl']);
+        this.warnAboutIgnoredFlags(schemas, Object.keys(Import.sqlFlags), [
+            'mysql',
+            'postgresql',
+        ]);
+        this.warnAboutIgnoredFlags(schemas, Object.keys(Import.postgresqlFlags), [
+            'postgresql',
+        ]);
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function
         //  - v2 with the graphqlize service
@@ -74,7 +99,8 @@ class Import extends zen_command_1.default {
                     'StepZen API. curl syntax is supported so that you copy and paste a ' +
                     'curl command instead of the URL.');
                 console.log();
-                curl2sdlOptions = Object.assign(Object.assign({}, fixedOptions), (await curl2sdl_1.askCurlQuestions(editableOptions)));
+                const curlAnswers = await curl2sdl_1.askCurlQuestions(editableOptions);
+                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), curlAnswers), { headers: curlAnswers.curlArgs.headers });
             }
             else {
                 // run non-interative
@@ -86,7 +112,15 @@ class Import extends zen_command_1.default {
                 if ('error' in parsedPathParamsOrError) {
                     throw new errors_1.CLIError(parsedPathParamsOrError.error);
                 }
-                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, curlArgs: argsOrError });
+                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);
+                if (maybeDuplicateParamsMessage) {
+                    throw new errors_1.CLIError(maybeDuplicateParamsMessage);
+                }
+                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, headers: headersOrError, curlArgs: argsOrError });
             }
             core_1.CliUx.ux.action.start('Starting');
             const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
@@ -100,14 +134,24 @@ class Import extends zen_command_1.default {
             result = resultOrError.outPath;
         }
         else {
-            ;
-            ['prefix', 'query-type', 'query-name', 'path-params'].forEach(flag => {
-                if (flag in flags) {
-                    this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${chalk.bold('curl')}. It will be ignored now.`));
-                }
-            });
+            // Map flag names to the properties defined for sql engines in:
+            // https://github.com/steprz/generator-engines/blob/main/generator/src/shared/sql.ts
+            // If/when the number of property-to-answer mappings increase, create a dictionary
+            // { schema: { flag: field } } and build the below map based on this (a
+            // dictionary also enables a generic solution to the warning about ignored flags).
+            const preAnsweredForDBs = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (flags['db-host'] === undefined ? {} : { host: flags['db-host'] })), (flags['db-user'] === undefined ? {} : { user: flags['db-user'] })), (flags['db-password'] === undefined
+                ? {}
+                : { password: flags['db-password'] })), (flags['db-database'] === undefined
+                ? {}
+                : { database: flags['db-database'] })), (flags['db-schema'] === undefined
+                ? {}
+                : { schema: flags['db-schema'] }));
+            const preAnswered = {
+                mysql: preAnsweredForDBs,
+                postgresql: preAnsweredForDBs,
+            };
             // Let's go!
-            result = await generate_1.default(schemas, flags.name, workspace.schema);
+            result = await generate_1.default(schemas, flags.name, workspace.schema, preAnswered);
             // Validate
             await transpiler_1.validate(result, {
                 extensions: await utils_1.getStepZenExtensions(),
@@ -123,18 +167,19 @@ class Import extends zen_command_1.default {
 }
 exports.default = Import;
 Import.description = 'Import a schema for an external data source or a API endpoint to your GraphQL API.';
-Import.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ description: 'working directory' }), help: command_1.flags.help({ char: 'h' }), silent: command_1.flags.boolean({ hidden: true }), name: command_1.flags.string({
-        description: 'subfolder inside the workspace folder to save the imported' +
-            ' schema files, defaults to the imported schema name',
-    }), prefix: command_1.flags.string({
+Import.curlFlags = {
+    prefix: command_1.flags.string({
         description: '[curl] prefix to add every type in the generated schema.',
-    }), 'query-name': command_1.flags.string({
+    }),
+    'query-name': command_1.flags.string({
         description: '[curl] property name to add to the Query type as a way to' +
             ' access the imported cURL endpoint.',
-    }), 'query-type': command_1.flags.string({
+    }),
+    'query-type': command_1.flags.string({
         description: '[curl] name for the type returned by the cURL endpoint in the ' +
             `generated schema. The name specified by ${chalk.bold('--query-type')} is not prefixed by ${chalk.bold('--prefix')} if both flags are present.`,
-    }), 'path-params': command_1.flags.string({
+    }),
+    'path-params': command_1.flags.string({
         description: `[curl] specifies path parameters in the URL path.` +
             ` Can be formed by taking the original path and replacing the` +
             ` variable segments with ${chalk.bold('$paramName')} placeholders.` +
@@ -143,7 +188,42 @@ Import.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { d
             `\nstepzen import curl https://example.com/users/jane/posts/12` +
             ` --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({
+        description: '[mysql, postgresql] database host',
+    }),
+    'db-user': command_1.flags.string({
+        description: '[mysql, postgresql] database user name',
+    }),
+    'db-password': command_1.flags.string({
+        description: '[mysql, postgresql] database password',
+    }),
+    'db-database': command_1.flags.string({
+        description: '[mysql, postgresql] name of database to import',
+    }),
+};
+Import.postgresqlFlags = {
+    'db-schema': command_1.flags.string({
+        description: '[postgresql] database schema',
+    }),
+};
+Import.flags = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ description: 'working directory' }), help: command_1.flags.help({ char: 'h' }), silent: command_1.flags.boolean({ hidden: true }), name: command_1.flags.string({
+        description: 'subfolder inside the workspace folder to save the imported' +
+            ' schema files, defaults to the imported schema name',
+    }) }), Import.curlFlags), Import.sqlFlags), Import.postgresqlFlags);
 Import.args = [
     {
         name: 'schemas',

package/lib/commands/init.d.ts

@@ -11,7 +11,6 @@ export default class Init extends ZenCommand {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         yes: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         hidden: boolean;

package/lib/commands/lint.d.ts

@@ -7,7 +7,6 @@ export default class Init extends ZenCommand {
         dir: flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     run(): Promise<void>;
 }

package/lib/commands/list.d.ts

@@ -1,11 +1,9 @@
-import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
 export default class List extends ZenCommand {
     static description: string;
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/login.d.ts

@@ -9,7 +9,6 @@ export default class Login extends ZenCommand {
         config: flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     run(): Promise<void>;
 }

package/lib/commands/logout.d.ts

@@ -1,11 +1,9 @@
-import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
 export default class Logout extends ZenCommand {
     static description: string;
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     run(): Promise<void>;
 }

package/lib/commands/start.d.ts

@@ -14,7 +14,6 @@ export default class Start extends ZenCommand {
         'no-watcher': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         port: import("@oclif/parser/lib/flags").IOptionFlag<number>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: never[];
     run(): Promise<void>;

package/lib/commands/transpile.d.ts

@@ -12,7 +12,6 @@ export default class Transpile extends ZenCommand {
         'output-configuration': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/upload.d.ts

@@ -8,7 +8,6 @@ export default class Upload extends ZenCommand {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: ({
         name: string;

package/lib/commands/validate.d.ts

@@ -1,4 +1,3 @@
-import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
 export default class Validate extends ZenCommand {
     static description: string;
@@ -6,7 +5,6 @@ export default class Validate extends ZenCommand {
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/whoami.d.ts

@@ -1,4 +1,3 @@
-import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
 export default class WhoAmI extends ZenCommand {
     static description: string;
@@ -9,7 +8,6 @@ export default class WhoAmI extends ZenCommand {
         apikey: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         adminkey: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     static args: never[];
     run(): Promise<void>;

package/lib/generate/curl2sdl.d.ts

@@ -1,5 +1,24 @@
 import { CurlArguments } from '../shared/curl-parser';
 import { PathParam } from '../shared/path-params-parser';
+export declare type NameValueHeaderInput = {
+    name: string;
+    value: string;
+};
+export declare type NamePartsHeaderInput = {
+    name: string;
+    parts: HeaderInputValuePart[];
+};
+export declare type HeaderInput = NameValueHeaderInput | NamePartsHeaderInput;
+export declare type HeaderInputConstantValuePart = {
+    kind: 'Constant';
+    value: string;
+};
+export declare type HeaderInputVariableValuePart = {
+    kind: 'Variable';
+    value: string;
+    name: string;
+};
+export declare type HeaderInputValuePart = HeaderInputConstantValuePart | HeaderInputVariableValuePart;
 export declare type Curl2SdlOptions = {
     curlArgs: CurlArguments;
     name?: string;
@@ -8,6 +27,7 @@ export declare type Curl2SdlOptions = {
     rootType?: string;
     typePrefix?: string;
     pathParams: readonly PathParam[];
+    headers: readonly HeaderInput[];
 };
 export declare type EditableCurl2SdlOptions = Pick<Curl2SdlOptions, 'curlArgs' | 'queryName' | 'rootType' | 'typePrefix' | 'pathParams'>;
 export declare type CurlAnswers = {
@@ -17,8 +37,35 @@ export declare type CurlAnswers = {
     typePrefix: string;
     pathParams: string;
 };
+export declare type CurlQueryParameter = {
+    name: string;
+    value: string;
+    context: string;
+};
+/**
+ * Collect together all query parameters from HTTP headers and from the
+ * pathname, and return them as a uniform list.
+ *
+ * @param {*} headers list of curl headers, possibly with parameters
+ * @param {*} pathParams list of path parameters
+ * @param {*} pathname full pathname of the REST endpoint
+ * @returns {*} combined list of query parameters in a uniform format
+ */
+export declare const compileParameterList: (headers: HeaderInput[], pathParams: PathParam[], pathname: string) => CurlQueryParameter[];
+/**
+ * Check the header and path parameters for duplicates, and construct a
+ * user-friendly error message describing identified problems (if any).
+ * If no problems are found, return `null`.
+ *
+ * @param {*} headers list of curl headers, possibly with parameters
+ * @param {*} pathParams list of path parameters
+ * @param {*} url full URL of the REST endpoint
+ * @returns {*} a message describing duplicate query parameters, or null if
+ *              there are no duplicates
+ */
+export declare const makeDuplicateParamsMessage: (headers: HeaderInput[], pathParams: PathParam[], url: string) => string | null;
 export declare const askCurlQuestions: (defaultAnswers?: Partial<CurlAnswers>) => Promise<EditableCurl2SdlOptions>;
-export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, }: Curl2SdlOptions) => Promise<{
+export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, }: Curl2SdlOptions) => Promise<{
     error: string;
 } | {
     outPath: string;

package/lib/generate/curl2sdl.js

@@ -1,7 +1,7 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.curl2sdl = exports.askCurlQuestions = void 0;
+exports.curl2sdl = exports.askCurlQuestions = exports.makeDuplicateParamsMessage = exports.compileParameterList = void 0;
 const errors_1 = require("@oclif/errors");
 const chalk = require("chalk");
 const fs = require("fs-extra");
@@ -18,6 +18,84 @@ const curl_parser_1 = require("../shared/curl-parser");
 const path_params_parser_1 = require("../shared/path-params-parser");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
+/**
+ * Collect together all query parameters from HTTP headers and from the
+ * pathname, and return them as a uniform list.
+ *
+ * @param {*} headers list of curl headers, possibly with parameters
+ * @param {*} pathParams list of path parameters
+ * @param {*} pathname full pathname of the REST endpoint
+ * @returns {*} combined list of query parameters in a uniform format
+ */
+exports.compileParameterList = (headers, pathParams, pathname) => {
+    // Drop empty segments, including empty string before the leading slash
+    const pathSegments = pathname.split('/').filter(Boolean);
+    // For each header, make a list of the parameters it contains.
+    // `flatMap()` concatenates each header's param lists into a single list.
+    return lodash_1.flatMap(headers, header => {
+        // skip headers that don't contain parameters
+        if (!('parts' in header)) {
+            return [];
+        }
+        // Reconstruct the full header string (for the context).
+        const fullHeader = `${header.name}: ${header.parts
+            .map(part => part.value)
+            .join('')}`;
+        // Filter out the 'Variable' parts of the header value, and convert them
+        // to the `CurlyQueryParameter` structure.
+        return header.parts
+            .map(part => part.kind === 'Variable'
+            ? {
+                name: part.name,
+                value: part.value,
+                context: `'${header.name}' header ${chalk.dim(`(${fullHeader})`)}`,
+            }
+            : null)
+            .filter(Boolean); // remove nulls
+    }).concat(
+    // Append the path parameters to the list, converting them to
+    // the `CurlyQueryParameter` structure as well.
+    pathParams.map(param => ({
+        name: param.name,
+        value: pathSegments[param.index],
+        context: `pathname ${chalk.dim(`(${pathname})`)}`,
+    })));
+};
+/**
+ * Check the header and path parameters for duplicates, and construct a
+ * user-friendly error message describing identified problems (if any).
+ * If no problems are found, return `null`.
+ *
+ * @param {*} headers list of curl headers, possibly with parameters
+ * @param {*} pathParams list of path parameters
+ * @param {*} url full URL of the REST endpoint
+ * @returns {*} a message describing duplicate query parameters, or null if
+ *              there are no duplicates
+ */
+exports.makeDuplicateParamsMessage = (headers, pathParams, url) => {
+    // Create a uniform list of query parameters from the headers and path
+    const parameters = exports.compileParameterList(headers, pathParams, new URL(url).pathname);
+    const errors = Object.entries(lodash_1.groupBy(parameters, 'name'))
+        // Create groups for each unique parameter name,
+        // and then sub-groups for each unique [name, value] tuple.
+        .map(([name, group]) => ({
+        name,
+        values: Object.entries(lodash_1.groupBy(group, 'value')),
+    }))
+        // ignore the [name, value] tuples that occur only once
+        .filter(({ values }) => values.length > 1)
+        // for the rest, create a message describing the duplicates
+        .map(({ name, values }) => `The parameter ${chalk.bold(`$${name}`)} is used for ${values.length} different values:` +
+        `\n${values
+            .map(([value, params], i) => `\t${i + 1}: '${value}' in the ${params[0].context}`)
+            .join('\n')}`);
+    if (errors.length > 0) {
+        return ('Could not use the same name for different parameters.\n' +
+            errors.join('\n') +
+            '\nPlease give a different parameter name for each variable value.');
+    }
+    return null;
+};
 exports.askCurlQuestions = async (defaultAnswers = {}) => {
     let questions = [
         {
@@ -73,7 +151,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
         pathParams: parsedPathParamsOrError,
     };
 };
-exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, }) => {
+exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, }) => {
     let json;
     try {
         const url = `${constants_1.STEPZEN_JSON2SDL_SERVER_URL}/api/graphql`;
@@ -106,7 +184,7 @@ exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePre
             queryName: queryName || null,
             rootType: rootType || null,
             typePrefix: typePrefix || null,
-            headers: curlArgs.headers.length > 0 ? curlArgs.headers : null,
+            headers: headers.length > 0 ? headers : null,
             data: curlArgs.data || null,
             method: curlArgs.method,
             pathParams: pathParams.length > 0 ? pathParams : null,

package/lib/generate/helpers.js

@@ -121,15 +121,13 @@ exports.askGeneratorQuestions = async (id, settings, state) => {
     var _a, _b;
     let status = -1;
     do {
-        if (settings.questions.length === 0) {
-            // would cause a hot loop, so it's an error
-            throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
-        }
-        const questions = settings.questions.map((question) => (Object.assign(Object.assign({ type: 'password' }, question), { 
-            // set the previous iteration's answer as the default value, except for password fields
-            default: question.type && question.type !== 'password'
-                ? lodash_1.get(state, question.name)
-                : undefined })));
+        const questions = settings.questions.map((question) => {
+            return Object.assign(Object.assign({ type: 'password' }, question), { 
+                // set the previous iteration's answer as the default value, except for password fields
+                default: question.type && question.type !== 'password'
+                    ? lodash_1.get(state, question.name)
+                    : undefined });
+        });
         // eslint-disable-next-line no-await-in-loop
         const answers = await inquirer.prompt(questions);
         state = lodash_1.merge(state, answers);
@@ -142,7 +140,12 @@ exports.askGeneratorQuestions = async (id, settings, state) => {
         if (result.status === -1 && result.questions.length === 0) {
             console.log();
             console.log(chalk.red(`A problem occurred when running ${id} import${((_a = result.errors) === null || _a === void 0 ? void 0 : _a.error) ? `: "${(_b = result.errors) === null || _b === void 0 ? void 0 : _b.error}"` : '.'}`));
-            console.log('Please try again');
+            console.log('Please try again and check command-line parameters');
+            if (questions.length === 0) {
+                // all questions are pre-answered, so there is no chance to save the
+                // situation interactively => don't loop
+                throw new errors_1.CLIError('Unable to import');
+            }
         }
         else {
             settings = {

package/lib/generate/index.d.ts

@@ -1,2 +1,6 @@
-declare const _default: (schemas: any, name: string | undefined, source: string) => Promise<string>;
+declare const _default: (schemas: any, name: string | undefined, source: string, preAnswered?: {
+    [schema: string]: {
+        [question: string]: string;
+    };
+}) => Promise<string>;
 export default _default;

package/lib/generate/index.js

@@ -10,7 +10,7 @@ const os = require("os");
 const path = require("path");
 const transpiler_1 = require("@stepzen/transpiler");
 const helpers_1 = require("./helpers");
-exports.default = async (schemas, name, source) => {
+exports.default = async (schemas, name, source, preAnswered = {}) => {
     var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
     var _e;
     // Store the generators
@@ -18,15 +18,19 @@ exports.default = async (schemas, name, source) => {
     for (const schema of schemas) {
         generators[schema] = null;
     }
-    // Store the answers
-    let answers = {};
+    // Initial answers from flags. Assumption: <schema> -> <schema>_config
+    const initialAnswers = {};
+    Object.keys(generators).forEach(id => {
+        initialAnswers[`${id}_config`] = preAnswered[id] || {};
+    });
+    let answers = initialAnswers;
     // Start downloading
     core_1.CliUx.ux.action.start('Downloading from StepZen...');
     try {
         // Get all generators from...Generators
         for (var _f = tslib_1.__asyncValues(Object.keys(generators)), _g; _g = await _f.next(), !_g.done;) {
             const id = _g.value;
-            const configure = await helpers_1.getConfiguration(id, {});
+            const configure = await helpers_1.getConfiguration(id, answers);
             if (configure) {
                 generators[id] = {
                     questions: configure.questions,

package/lib/hooks/prerun/check-upgrade.js

@@ -6,10 +6,10 @@ const chalk = require("chalk");
 const compareVersions = require("compare-versions");
 const fs = require("fs-extra");
 const debug_1 = require("debug");
+const parser_1 = require("@oclif/parser");
 const node_fetch_1 = require("node-fetch");
 const constants_1 = require("../../shared/constants");
 const errors_1 = require("../../shared/errors");
-const { version } = require('../../../package.json');
 const majorRegexp = /\d+\./;
 const timeoutBeta = 1000 * 60 * 60 * 24; // one day
 const timeoutStable = 7 * timeoutBeta; // one week
@@ -89,15 +89,24 @@ ${chalk.green('npm install -g stepzen')}
     }
     return result;
 };
-const hook = async function () {
-    const { message, isBlocking } = await exports.checkUpgrade(version);
-    if (message) {
+const hook = async function (options) {
+    const { message, isBlocking } = await exports.checkUpgrade(this.config.version);
+    // parse the command line to get `flags['non-interactive']`
+    const TheCommand = options.Command;
+    const { flags } = parser_1.parse(options.argv, Object.assign({ context: this }, TheCommand));
+    // In a non-interactive shell only print the upgrade nudge if the upgrade
+    // is blocking.
+    // For non-blocking upgrades we don't want to print the upgrade nudge when
+    // the CLI is executed as a part of a non-interactive shell script. This
+    // additional output might by unexpected by the rest of script and could
+    // break the pipeline.
+    if (message && (isBlocking || !flags['non-interactive'])) {
         this.log('');
         this.log(message.trim());
         this.log('');
-        if (isBlocking) {
-            this.exit(1);
-        }
+    }
+    if (isBlocking) {
+        this.exit(1);
     }
 };
 exports.default = hook;

package/lib/shared/configuration.js

@@ -6,7 +6,7 @@ exports.removeCredentialsFromConfigFile = exports.writeCredentialsToConfigFile =
 const errors_1 = require("@oclif/errors");
 const debug = require("debug");
 const fs = require("fs");
-const crypto = require("crypto");
+const uuid_1 = require("uuid");
 const path = require("path");
 const yaml = require("yaml");
 const stepzen_sdk_1 = require("./stepzen-sdk");
@@ -35,7 +35,7 @@ exports.ensureValidConfiguration = async (maybeConfiguration) => {
     }
     // ensure configuration has a UUID
     if (!configuration.uuid) {
-        configuration.uuid = crypto.randomUUID();
+        configuration.uuid = uuid_1.v4();
         debug('stepzen:configuration')(`Generated a new machine UUID: ${configuration.uuid}`);
         modified = true;
     }

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

@@ -1,30 +1,26 @@
-/**
- * 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) => {
+export interface CurlHeader {
     name: string;
     value: string;
-} | null | {
-    error: string;
-};
+}
 export interface CurlArguments {
     url: string;
     method: 'Get' | 'Post';
-    headers: Array<{
-        name: string;
-        value: string;
-    }>;
+    headers: CurlHeader[];
     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

@@ -26,7 +26,8 @@ exports.parseCurlHeaderString = (header) => {
         return null;
     }
     // Check if it's a `Header;` case
-    if (trimmed.indexOf(';') === trimmed.length - 1) {
+    if (trimmed.indexOf(':') === -1 &&
+        trimmed.indexOf(';') === trimmed.length - 1) {
         return {
             name: trimmed.substring(0, trimmed.length - 1).trim(),
             value: '',

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

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

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

@@ -0,0 +1,108 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+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 headerParamRegex = /^(?<prefix>([^$]|\$\$)*)(?<param>\$[_A-Za-z]\w*);?(?<suffix>.*)$/;
+exports.parseHeaderParam = (headers, headerParam) => {
+    const headerOrError = curl_parser_1.parseCurlHeaderString(headerParam);
+    if (!headerOrError || 'error' in headerOrError) {
+        if (headerOrError) {
+            debug('stepzen:curl2sdl')(`Failed to parse a header param ${headerParam}.` +
+                ` Error: ${headerOrError.error}`);
+        }
+        return {
+            error: `Could not find a header name in` +
+                ` ${chalk.bold(`--header-param '${headerParam}'`)}.`,
+        };
+    }
+    const { name, value } = headerOrError;
+    const paramValueMatches = value.match(headerParamRegex);
+    if (!paramValueMatches || !paramValueMatches.groups) {
+        return {
+            error: `Could not find a $-prefixed parameter name in` +
+                ` ${chalk.bold(`--header-param '${headerParam}'`)}.` +
+                ` Did you use single quotes to prevent shell variable expansion?`,
+        };
+    }
+    const prefix = paramValueMatches.groups.prefix.replace(/\$\$/g, '$');
+    const paramName = paramValueMatches.groups.param.substring(1);
+    const suffix = paramValueMatches.groups.suffix.replace(/\$\$/g, '$');
+    if (suffix.match(headerParamRegex)) {
+        return {
+            error: `StepZen CLI currently supports at max 1 parameter per header` +
+                ` ${chalk.bold(`--header-param '${headerParam}'`)} has several.`,
+        };
+    }
+    const candidates = headers.filter(h => h.name.toLowerCase() === name.toLowerCase());
+    if (candidates.length === 0) {
+        return {
+            error: `Could not find a matching '-H, --header' curl flag for` +
+                ` ${chalk.bold(`--header-param '${headerParam}'`)}.` +
+                ` No header matches the name ${name}.`,
+        };
+    }
+    const matches = candidates.filter(({ value }) => value.startsWith(prefix) &&
+        value.substring(prefix.length).endsWith(suffix));
+    if (matches.length === 0) {
+        return {
+            error: `Could not find a matching '-H, --header' curl flag for` +
+                ` ${chalk.bold(`--header-param '${headerParam}'`)}.` +
+                (candidates.length > 1
+                    ? ` None of the ${name} headers matches the '${value}' pattern.`
+                    : ` The ${name} header does not match the '${value}' pattern.`),
+        };
+    }
+    if (matches.length > 1) {
+        debug('stepzen:curl2sdl')(`Ambiguous --header-param '${headerParam}'. Matched headers:` +
+            `\n${matches
+                .map(header => `\t-H '${header.name}: ${header.value}'`)
+                .join('\n')}` +
+            `\nUsing the first match.`);
+    }
+    const asConstantHeaderValuePart = (value) => ({
+        kind: 'Constant',
+        value,
+    });
+    const asVariableHeaderValuePart = (value, name) => ({
+        kind: 'Variable',
+        value,
+        name,
+    });
+    return {
+        header: {
+            name: matches[0].name,
+            parts: [
+                ...(prefix
+                    ? [asConstantHeaderValuePart(prefix)]
+                    : [
+                    /* spreading an empty array is a no-op */
+                    ]),
+                asVariableHeaderValuePart(matches[0].value.substring(prefix.length, matches[0].value.length - suffix.length), paramName),
+                ...(suffix
+                    ? [asConstantHeaderValuePart(suffix)]
+                    : [
+                    /* spreading an empty array is a no-op */
+                    ]),
+            ],
+        },
+        // assume each --header is referenced by at most one --header-param
+        remainingHeaders: headers.filter(h => h !== matches[0]),
+    };
+};
+exports.makeHeaders = (curlHeaders, headerParams = []) => {
+    const headers = [];
+    let remainingCurlHeaders = curlHeaders;
+    for (const headerParam of headerParams) {
+        const resultOrError = exports.parseHeaderParam(remainingCurlHeaders, headerParam);
+        if ('error' in resultOrError) {
+            return resultOrError;
+        }
+        headers.push(resultOrError.header);
+        remainingCurlHeaders = resultOrError.remainingHeaders;
+    }
+    headers.push(...remainingCurlHeaders);
+    return headers;
+};

package/lib/shared/zen-command.d.ts

@@ -1,9 +1,8 @@
-import { Command, flags } from '@oclif/command';
+import { Command } from '@oclif/command';
 import { MachineConfiguration, StepZenCredentials } from './types';
 export declare abstract class ZenCommand extends Command {
     static flags: {
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'enable-login-prompt': flags.IOptionFlag<boolean | undefined>;
     };
     ensureStepZenAccount(): Promise<{
         configuration: import("./types").LoggedInMachineConfiguration;

package/lib/shared/zen-command.js

@@ -3,7 +3,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZenCommand = void 0;
 const command_1 = require("@oclif/command");
-const errors_1 = require("@oclif/errors");
 const inquirer = require("inquirer");
 const chalk = require("chalk");
 const configuration_1 = require("./configuration");
@@ -16,19 +15,15 @@ class ZenCommand extends command_1.Command {
                 configuration,
             };
         }
-        const TheCommand = this.constructor;
-        const { flags } = this.parse(TheCommand);
-        if (flags['enable-login-prompt']) {
-            return this.promptUserToLogIn(configuration.uuid);
-        }
-        throw new errors_1.CLIError('Could not find StepZen account credentials.' +
-            ' Please run `stepzen login` first.');
+        return this.promptUserToLogIn(configuration.uuid);
     }
     async promptUserToLogIn(uuid) {
-        this.log(chalk.bold(chalk.cyan('Welcome to StepZen CLI!')));
+        this.log(chalk.bold(chalk.cyan('Welcome to the StepZen CLI!')));
         this.log('');
-        this.log(`Please log in with your StepZen account to make your GraphQL API private.` +
-            ` All APIs created without logging in will be public.`);
+        this.log(`You are about to deploy your GraphQL API to the cloud on a public` +
+            ` endpoint. Log in or create a StepZen account to get a` +
+            ` production-ready GraphQL API deployed on a secure and private` +
+            ` endpoint.`);
         this.log('');
         const answers = await inquirer.prompt([
             {
@@ -82,19 +77,12 @@ ZenCommand.flags = {
     'non-interactive': command_1.flags.boolean({
         description: 'disable all interactive prompts',
         hidden: true,
-    }),
-    // The flag type has to be `option` (not `boolean`) for `env` to take effect
-    'enable-login-prompt': command_1.flags.option({
-        description: 'An (internal) feature flag to enable the "prompt user to log in"' +
-            ' feature for the users who run the CLI without being logged in. It' +
-            ' is intentially hidden and not documented because in the future' +
-            ' this feature will be enabled for all users and the flag will be' +
-            ' removed.',
-        hidden: true,
-        options: ['true', 'false'],
-        parse: value => Boolean(value),
-        default: false,
-        env: 'STEPZEN_ENABLE_LOGIN_PROMPT',
+        default: () => {
+            if (process.env.STEPZEN_INTERACTIVE !== undefined) {
+                return process.env.STEPZEN_INTERACTIVE.toLowerCase() === 'false';
+            }
+            return !process.stdin.isTTY || !process.stdout.isTTY;
+        },
     }),
 };
 exports.default = ZenCommand;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.15.0-beta.1","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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] 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 --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'"}},"args":[{"name":"schemas","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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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-server":{"name":"no-server","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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":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.16.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, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] 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 --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'"},"header-param":{"name":"header-param","type":"option","description":"[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 parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"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":"schemas","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-server":{"name":"no-server","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":"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.15.0-beta.1",
+  "version": "0.16.0-beta.0",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -13,7 +13,7 @@
   },
   "main": "lib/index.js",
   "engines": {
-    "node": ">=14.17.0",
+    "node": ">=14.0",
     "npm": ">=6.14"
   },
   "files": [
@@ -28,7 +28,7 @@
   "dependencies": {
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.18.3",
-    "@oclif/core": "1.6.3",
+    "@oclif/core": "1.7.0",
     "@oclif/errors": "1.3.5",
     "@oclif/plugin-help": "^5.1.12",
     "@stepzen/dashboard": "0.1.37",
@@ -38,7 +38,7 @@
     "chokidar": "^3.5.2",
     "compare-versions": "^3.6.0",
     "date-fns": "^2.26.0",
-    "debug": "^4.3.0",
+    "debug": "^4.3.4",
     "detect-port": "^1.3.0",
     "dotenv": "^8.6.0",
     "fs-extra": "^9.1.0",
@@ -46,10 +46,11 @@
     "inquirer": "^7.3.3",
     "lodash": "^4.17.21",
     "node-fetch": "^2.6.6",
-    "prettier": "^2.4.1",
+    "prettier": "^2.6.2",
     "pretty-ms": "^7.0.1",
     "shelljs": "^0.8.5",
     "throttle-debounce": "^3.0.1",
+    "uuid": "^8.3.2",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
@@ -69,14 +70,16 @@
     "@types/minimist": "^1.2.1",
     "@types/mocha": "^5.2.7",
     "@types/mock-fs": "^4.13.0",
-    "@types/node": "^14.18.13",
+    "@types/node": "^14.0.27",
     "@types/node-fetch": "^2.5.7",
     "@types/prettier": "^2.1.6",
     "@types/rimraf": "^3.0.0",
+    "@types/semver": "^7.3.9",
     "@types/shelljs": "^0.8.8",
     "@types/sinon-chai": "3.2.8",
     "@types/throttle-debounce": "^2.1.0",
     "@types/unzipper": "^0.10.4",
+    "@types/uuid": "^8.3.4",
     "chai": "^4.2.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -93,8 +96,10 @@
     "nock": "^13.0.4",
     "nodemon": "^2.0.7",
     "nyc": "^14.1.1",
+    "semver": "^7.3.7",
     "sinon": "13.0.1",
     "sinon-chai": "3.7.0",
+    "strip-ansi": "^6.0.1",
     "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   },
@@ -118,9 +123,9 @@
     "postpack": "rm -f oclif.manifest.json",
     "posttest": "eslint . --ignore-path .prettierignore",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "test": "tsc -b && cross-env STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "tsc -b && cross-env STEPZEN_INTERACTIVE=true STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
     "test:single:example": "npm run test:single -- test/src/shared/curl-parser.test.ts",
-    "test:single": "tsc -b && cross-env STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost mocha --forbid-only test/_global.test.ts",
+    "test:single": "tsc -b && cross-env STEPZEN_INTERACTIVE=true STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost mocha --forbid-only test/_global.test.ts",
     "version": "oclif-dev readme && git add README.md",
     "prepare": "husky install"
   },