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

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.15.0-beta.2 darwin-x64 node-v14.19.1
+stepzen/0.16.0-beta.1 darwin-x64 node-v14.19.1
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -84,7 +84,7 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.1
 
 ## `stepzen import SCHEMAS`
 
-Import a schema for an external data source or a API endpoint to your GraphQL API.
+import a schema for an external data source or a API endpoint to your GraphQL API
 
 ```
 USAGE
@@ -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
 
@@ -135,7 +160,7 @@ OPTIONS
 
 ## `stepzen login`
 
-Log in to StepZen
+log in to StepZen
 
 ```
 USAGE
@@ -150,7 +175,7 @@ OPTIONS
 
 ## `stepzen logout`
 
-log out of stepzen
+log out of StepZen
 
 ```
 USAGE
@@ -177,7 +202,7 @@ OPTIONS
 
 ## `stepzen upload TYPE DESTINATION`
 
-upload to stepzen
+upload to StepZen
 
 ```
 USAGE

package/lib/commands/import.d.ts

@@ -2,15 +2,60 @@ 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 flagsForSchemas: ({
+        flags: {
+            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[]>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
+            'db-host': flags.IOptionFlag<string | undefined>;
+            'db-user': flags.IOptionFlag<string | undefined>;
+            'db-password': flags.IOptionFlag<string | undefined>;
+            'db-database': flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
+            'db-schema': flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    })[];
     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>;
     };
     static args: {
@@ -19,4 +64,26 @@ export default class Import extends ZenCommand {
     }[];
     static strict: boolean;
     run(): Promise<void>;
+    warnAboutIgnoredFlags: (usedSchemas: readonly string[], usedFlags: {
+        [key: string]: any;
+    }) => void;
+    parseWorkaround(): import("@oclif/parser").Output<{
+        'db-schema': string | undefined;
+        'db-host': string | undefined;
+        'db-user': string | undefined;
+        'db-password': string | undefined;
+        'db-database': string | undefined;
+        prefix: string | undefined;
+        'query-name': string | undefined;
+        'query-type': string | undefined;
+        'path-params': string | undefined;
+        'header-param': string[];
+        dir: string | undefined;
+        help: void;
+        silent: boolean;
+        name: string | undefined;
+        'non-interactive': boolean;
+    }, {
+        [name: string]: any;
+    }>;
 }

package/lib/commands/import.js

@@ -17,9 +17,27 @@ 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 = (usedSchemas, usedFlags) => {
+            Import.flagsForSchemas.forEach(({ flags, schemas }) => {
+                if (!usedSchemas.some(usedSchema => schemas.includes(usedSchema))) {
+                    Object.keys(flags).forEach(flag => {
+                        if (Object.prototype.hasOwnProperty.call(usedFlags, flag)) {
+                            this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${schemas
+                                .map(schema => chalk.bold(schema))
+                                .join(', ')}. It will be ignored now.`));
+                        }
+                    });
+                }
+            });
+        };
+    }
     async run() {
-        const { args, argv, flags } = this.parse(Import);
+        const { args, argv, flags } = this.parseWorkaround();
         // Get a list of schemas you're asking for
         const schemas = helpers_1.getSchemaList(args.schemas);
         if (schemas.length > 1 && flags.name) {
@@ -41,6 +59,7 @@ 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, flags);
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function
         //  - v2 with the graphqlize service
@@ -74,7 +93,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 +106,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 +128,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(),
@@ -120,21 +158,58 @@ class Import extends zen_command_1.default {
         this;
         this.log(chalk.green(`Successfully imported ${schemas.length} schemas from StepZen`));
     }
+    // Correct the value for the 'header-param' flag to work around the oclif's
+    // parser issue with multi-value flags: https://github.com/oclif/oclif/issues/261
+    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);
+            }
+        }
+        return parsed;
+    }
 }
 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.description = 'import a schema for an external data source or a API endpoint to your GraphQL API';
+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 +218,47 @@ 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.flagsForSchemas = [
+    { flags: Import.curlFlags, schemas: ['curl'] },
+    { flags: Import.sqlFlags, schemas: ['mysql', 'postgresql'] },
+    { flags: Import.postgresqlFlags, schemas: ['postgresql'] },
+];
+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/lint.js

@@ -22,6 +22,6 @@ class Init extends zen_command_1.default {
     }
 }
 exports.default = Init;
-Init.description = 'stepzen lint';
+Init.description = 'StepZen lint';
 Init.hidden = true;
 Init.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ hidden: true }), help: command_1.flags.help({ char: 'h' }) });

package/lib/commands/login.js

@@ -54,7 +54,7 @@ class Login extends zen_command_1.default {
     }
 }
 exports.default = Login;
-Login.description = 'Log in to StepZen';
+Login.description = 'log in to StepZen';
 Login.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { account: command_1.flags.string({
         char: 'a',
         exclusive: ['config', 'public'],

package/lib/commands/logout.js

@@ -14,5 +14,5 @@ class Logout extends zen_command_1.default {
     }
 }
 exports.default = Logout;
-Logout.description = 'log out of stepzen';
+Logout.description = 'log out of StepZen';
 Logout.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { help: command_1.flags.help({ char: 'h' }) });

package/lib/commands/start.js

@@ -11,7 +11,6 @@ const utils_1 = require("../shared/utils");
 const start_1 = require("../start");
 const workspace_1 = require("../shared/workspace");
 const init_1 = require("./init");
-const dashboard_interface_1 = require("../generate/dashboard-interface");
 const constants_1 = require("../shared/constants");
 const zen_command_1 = require("../shared/zen-command");
 const dashboard = require('@stepzen/dashboard');
@@ -81,7 +80,6 @@ class Start extends zen_command_1.default {
                     version,
                 },
                 domain: constants_1.STEPZEN_DOMAIN,
-                generators: dashboard_interface_1.createDashboardInterface(workspace),
                 predicates: {
                     available: true,
                     enabled: false,

package/lib/commands/upload.js

@@ -50,7 +50,7 @@ class Upload extends zen_command_1.default {
     }
 }
 exports.default = Upload;
-Upload.description = 'upload to stepzen';
+Upload.description = 'upload to StepZen';
 // The uploaded resource is either a directory or a file. In case it is the former,
 // it will be packaged into a zip archive and transferred.
 Upload.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({

package/lib/commands/whoami.js

@@ -51,7 +51,7 @@ class WhoAmI extends zen_command_1.default {
     }
 }
 exports.default = WhoAmI;
-WhoAmI.description = 'stepzen whoami';
+WhoAmI.description = 'display your credentials with StepZen whoami';
 WhoAmI.hidden = true;
 WhoAmI.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { help: command_1.flags.help({ char: 'h' }), showkeys: command_1.flags.boolean({
         default: false,

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,16 +18,20 @@ 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, {});
-            if (configure) {
+            const configure = await helpers_1.getConfiguration(id, answers);
+            if (configure === null || configure === void 0 ? void 0 : configure.questions.length) {
                 generators[id] = {
                     questions: configure.questions,
                     type: 'generator',

package/lib/shared/constants.d.ts

@@ -3,8 +3,6 @@ export declare const STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP: string;
 export declare const STEPZEN_CONFIG_FILE: string;
 export declare const STEPZEN_DOMAIN: string;
 export declare const STEPZEN_SERVER_URL: string;
-export declare const STEPZEN_GENERATOR_ENGINES_SCHEMA: string;
-export declare const STEPZEN_GENERATOR_ENGINES_ENDPOINT = "stepzen-generator/engines";
 export declare const STEPZEN_DIRECT_GENERATOR_ENGINES_URL: string;
 export declare const STEPZEN_API_TEMPLATES_REPOSITORY = "https://github.com/steprz/stepzen-schemas";
 export declare const ADMIN_DEPLOY_URL = "/cli/admin/deploy";

package/lib/shared/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STEPZEN_DISCORD_URL = exports.STEPZEN_JSON2SDL_SERVER_URL = exports.ADMIN_ACCOUNT_URL = exports.ADMIN_UPLOAD_URL = exports.ADMIN_LIST_URL = exports.ADMIN_DEPLOY_URL = exports.STEPZEN_API_TEMPLATES_REPOSITORY = exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = exports.STEPZEN_GENERATOR_ENGINES_ENDPOINT = exports.STEPZEN_GENERATOR_ENGINES_SCHEMA = exports.STEPZEN_SERVER_URL = exports.STEPZEN_DOMAIN = exports.STEPZEN_CONFIG_FILE = exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = exports.STEPZEN_CONFIG_DIRECTORY = void 0;
+exports.STEPZEN_DISCORD_URL = exports.STEPZEN_JSON2SDL_SERVER_URL = exports.ADMIN_ACCOUNT_URL = exports.ADMIN_UPLOAD_URL = exports.ADMIN_LIST_URL = exports.ADMIN_DEPLOY_URL = exports.STEPZEN_API_TEMPLATES_REPOSITORY = exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = exports.STEPZEN_SERVER_URL = exports.STEPZEN_DOMAIN = exports.STEPZEN_CONFIG_FILE = exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = exports.STEPZEN_CONFIG_DIRECTORY = void 0;
 // This file contains constants and all magic strings
 const dotenv = require("dotenv");
 const os = require("os");
@@ -9,7 +9,7 @@ const path = require("path");
 // This allows you to set environment variables in a `.env` file.
 // This file needs to be in your working directory.
 dotenv.config();
-const { STEPZEN_CONFIG_FILE: ENV_VAR_STEPZEN_CONFIG_FILE, STEPZEN_DOMAIN: ENV_VAR_STEPZEN_DOMAIN, STEPZEN_GENERATOR_ENGINES_SCHEMA: ENV_VAR_STEPZEN_GENERATOR_ENGINES_SCHEMA, STEPZEN_SERVER_URL: ENV_VAR_STEPZEN_SERVER_URL, STEPZEN_JSON2SDL_SERVER_URL: ENV_VAR_STEPZEN_JSON2SDL_SERVER_URL, STEPZEN_DIRECT_GENERATOR_ENGINES_URL: ENV_VAR_STEPZEN_DIRECT_GENERATOR_ENGINES_URL, } = process.env;
+const { STEPZEN_CONFIG_FILE: ENV_VAR_STEPZEN_CONFIG_FILE, STEPZEN_DOMAIN: ENV_VAR_STEPZEN_DOMAIN, STEPZEN_SERVER_URL: ENV_VAR_STEPZEN_SERVER_URL, STEPZEN_JSON2SDL_SERVER_URL: ENV_VAR_STEPZEN_JSON2SDL_SERVER_URL, STEPZEN_DIRECT_GENERATOR_ENGINES_URL: ENV_VAR_STEPZEN_DIRECT_GENERATOR_ENGINES_URL, } = process.env;
 // Where your authentication details are stored locally
 exports.STEPZEN_CONFIG_DIRECTORY = path.join(os.homedir(), '.stepzen');
 exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = path.join(exports.STEPZEN_CONFIG_DIRECTORY, 'last_update_check.timestamp');
@@ -18,11 +18,6 @@ exports.STEPZEN_CONFIG_FILE = ENV_VAR_STEPZEN_CONFIG_FILE || 'stepzen-config.yam
 exports.STEPZEN_DOMAIN = ENV_VAR_STEPZEN_DOMAIN || 'stepzen.io';
 // The zenctl URL. Override with the env var `STEPZEN_SERVER_URL`
 exports.STEPZEN_SERVER_URL = ENV_VAR_STEPZEN_SERVER_URL || 'https://{account}.stepzen.io';
-// Generator Engines schema: folder/name
-// Use 'stepzen/engines-dev' to test the dev instance of https://github.com/steprz/generator-engines
-exports.STEPZEN_GENERATOR_ENGINES_SCHEMA = ENV_VAR_STEPZEN_GENERATOR_ENGINES_SCHEMA || 'stepzen/engines';
-// Generator Engines schema: target API endpoint
-exports.STEPZEN_GENERATOR_ENGINES_ENDPOINT = 'stepzen-generator/engines';
 // If defined, call the generator engines cloud function directly, skipping zenctl
 exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = ENV_VAR_STEPZEN_DIRECT_GENERATOR_ENGINES_URL ||
     'https://us-central1-stepzen-functions.cloudfunctions.net/generator-engine';

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/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.15.0-beta.2","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'"}},"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":[]}}}
+{"version":"0.16.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},"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":"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.15.0-beta.2",
+  "version": "0.16.0-beta.1",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -31,7 +31,7 @@
     "@oclif/core": "1.7.0",
     "@oclif/errors": "1.3.5",
     "@oclif/plugin-help": "^5.1.12",
-    "@stepzen/dashboard": "0.1.37",
+    "@stepzen/dashboard": "0.2.0",
     "@stepzen/sdk": "0.11.0",
     "@stepzen/transpiler": "0.0.38",
     "chalk": "^4.1.1",
@@ -99,6 +99,7 @@
     "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"
   },

package/lib/generate/dashboard-interface.d.ts

@@ -1,7 +0,0 @@
-export declare const createDashboardInterface: (workspace: any) => {
-    endpoint: string;
-    onStart: () => Promise<void>;
-    onImport: (id: string, files: any) => Promise<{
-        success: boolean;
-    }>;
-};

package/lib/generate/dashboard-interface.js

@@ -1,42 +0,0 @@
-"use strict";
-// Copyright (c) 2020,2021,2022, StepZen, Inc.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDashboardInterface = void 0;
-const fs = require("fs-extra");
-const os = require("os");
-const path = require("path");
-const deploy_1 = require("../commands/deploy");
-const constants_1 = require("../shared/constants");
-const { merge } = require('@stepzen/transpiler');
-exports.createDashboardInterface = (workspace) => ({
-    endpoint: constants_1.STEPZEN_GENERATOR_ENGINES_ENDPOINT,
-    onStart: async () => {
-        await deploy_1.default.run([
-            constants_1.STEPZEN_GENERATOR_ENGINES_ENDPOINT,
-            '--schema',
-            constants_1.STEPZEN_GENERATOR_ENGINES_SCHEMA,
-            '--silent',
-        ]);
-    },
-    onImport: async (id, files) => {
-        const tmp = path.join(os.tmpdir(), `stepzen-generated-schema-${Date.now()}`);
-        fs.ensureDirSync(tmp);
-        for (const file of files) {
-            const cleaned = file.name.replace(os.tmpdir(), '');
-            const dir = path.join(tmp, cleaned);
-            fs.writeFileSync(dir, file.content);
-        }
-        const built = await merge(workspace.schema, {
-            name: id,
-            source: tmp,
-        }, {
-            silent: true,
-        });
-        fs.copySync(built, workspace.schema);
-        fs.removeSync(built);
-        fs.removeSync(tmp);
-        return {
-            success: true,
-        };
-    },
-});