stepzen 0.17.0-beta.1 → 0.17.0

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.17.0-beta.1 darwin-x64 node-v14.19.1
+stepzen/0.17.0 darwin-x64 node-v14.19.3
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -126,9 +126,6 @@ OPTIONS
       Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
       schema.
 
-  --overwrite
-      Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.
-
   --path-params=path-params
       [curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the
       variable segments with $paramName placeholders.
@@ -137,7 +134,7 @@ OPTIONS
       stepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'
 
   --prefix=prefix
-      [curl] prefix to add every type in the generated schema.
+      [curl, graphql] prefix to add every type in the generated schema.
 
   --query-name=query-name
       [curl] property name to add to the Query type as a way to access the imported cURL endpoint.

package/lib/commands/import.d.ts

@@ -3,8 +3,10 @@ import ZenCommand from '../shared/zen-command';
 import { Workspace } from '../shared/types';
 export default class Import extends ZenCommand {
     static description: string;
-    static curlFlags: {
+    static commonIntrospectionFlags: {
         prefix: flags.IOptionFlag<string | undefined>;
+    };
+    static curlFlags: {
         'query-name': flags.IOptionFlag<string | undefined>;
         'query-type': flags.IOptionFlag<string | undefined>;
         'path-params': flags.IOptionFlag<string | undefined>;
@@ -22,6 +24,10 @@ export default class Import extends ZenCommand {
     static flagsForSchemas: ({
         flags: {
             prefix: flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
             'query-name': flags.IOptionFlag<string | undefined>;
             'query-type': flags.IOptionFlag<string | undefined>;
             'path-params': flags.IOptionFlag<string | undefined>;
@@ -48,11 +54,11 @@ export default class Import extends ZenCommand {
         '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[]>;
+        prefix: flags.IOptionFlag<string | undefined>;
         dir: flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
@@ -76,11 +82,11 @@ export default class Import extends ZenCommand {
         '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[];
+        prefix: string | undefined;
         dir: string | undefined;
         help: void;
         silent: boolean;

package/lib/commands/import.js

@@ -15,6 +15,7 @@ const helpers_1 = require("../generate/helpers");
 const curl2sdl_1 = require("../generate/curl2sdl");
 const curl_parser_1 = require("../shared/curl-parser");
 const zen_command_1 = require("../shared/zen-command");
+const graphql2sdl_1 = require("../generate/graphql2sdl");
 const constants_1 = require("../shared/constants");
 const path_params_parser_1 = require("../shared/path-params-parser");
 const header_params_parser_1 = require("../shared/header-params-parser");
@@ -93,6 +94,35 @@ class Import extends zen_command_1.default {
             }
             result = resultOrError.outPath;
         }
+        else if (schema === 'graphql') {
+            const editableOptions = {
+                typePrefix: flags.prefix,
+            };
+            let answers;
+            if (argv.length === 1) {
+                // interactive
+                answers = await graphql2sdl_1.askGraphQLQuestions(editableOptions);
+            }
+            else {
+                // non-interactive
+                answers = Object.assign(Object.assign({}, editableOptions), { endpoint: argv[1] });
+            }
+            const fixedOptions = {
+                name: flags.name,
+                source: workspace.schema,
+                onConflict,
+            };
+            const options = Object.assign(Object.assign({}, fixedOptions), answers);
+            core_1.CliUx.ux.action.start('Starting');
+            const resultOrError = await graphql2sdl_1.graphql2sdl(options);
+            core_1.CliUx.ux.action.stop();
+            if ('error' in resultOrError) {
+                this.log('A problem occured while processing your import.');
+                this.log(resultOrError.error);
+                this.exit();
+            }
+            result = resultOrError.outPath;
+        }
         else {
             // Map flag names to the properties defined for sql engines in:
             // https://github.com/steprz/generator-engines/blob/main/generator/src/shared/sql.ts
@@ -124,6 +154,10 @@ class Import extends zen_command_1.default {
         this.log(chalk.green(`Successfully imported schema ${chalk.bold(schema)} from StepZen`));
     }
     async ensureOnConflictBehavior(workspace, schema, flags) {
+        const featureFlag = process.env.STEPZEN_DETECT_NAME_CONFLICTS;
+        if (featureFlag === undefined || featureFlag.toLowerCase() === 'false') {
+            return 'append';
+        }
         const name = flags.name || schema;
         const hasConflict = fs.existsSync(path.join(workspace.schema, name));
         if (!hasConflict) {
@@ -217,10 +251,12 @@ 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.curlFlags = {
+Import.commonIntrospectionFlags = {
     prefix: command_1.flags.string({
-        description: '[curl] prefix to add every type in the generated schema.',
+        description: '[curl, graphql] prefix to add every type in the generated schema.',
     }),
+};
+Import.curlFlags = {
     '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.',
@@ -271,18 +307,20 @@ Import.postgresqlFlags = {
     }),
 };
 Import.flagsForSchemas = [
+    { flags: Import.commonIntrospectionFlags, schemas: ['curl', 'graphql'] },
     { 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({
+Import.flags = Object.assign(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 to. Defaults to the name of the imported schema.',
     }), overwrite: command_1.flags.boolean({
         description: 'Overwrite any existing schema with the same name. Cannot be used' +
             ' without also providing a --name flag.',
         dependsOn: ['name'],
-    }) }), Import.curlFlags), Import.sqlFlags), Import.postgresqlFlags);
+        hidden: true,
+    }) }), Import.commonIntrospectionFlags), Import.curlFlags), Import.sqlFlags), Import.postgresqlFlags);
 Import.args = [
     {
         name: 'schema',

package/lib/commands/lint.js

@@ -2,9 +2,9 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = require("@oclif/command");
+const transpiler_1 = require("@stepzen/transpiler");
 const utils_1 = require("../shared/utils");
 const zen_command_1 = require("../shared/zen-command");
-const { lint } = require('@stepzen/transpiler');
 class Init extends zen_command_1.default {
     async run() {
         const { flags } = this.parse(Init);
@@ -18,7 +18,7 @@ class Init extends zen_command_1.default {
             this.log(formatted);
         };
         // Lint
-        await lint(directory);
+        await transpiler_1.lint(directory);
     }
 }
 exports.default = Init;

package/lib/commands/start.js

@@ -2,6 +2,7 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 const chokidar = require("chokidar");
+const debug = require("debug");
 const core_1 = require("@oclif/core");
 const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
@@ -33,6 +34,7 @@ class Start extends zen_command_1.default {
         // This is the file watcher
         if (!flags['no-watcher']) {
             const redeploy = throttle_debounce_1.debounce(500, (path) => {
+                debug('stepzen:start')(`chokidar decected change to ${path}`);
                 start_1.changed({ workspace, file: path });
                 start_1.deploy({ workspace, flags });
             });
@@ -45,15 +47,18 @@ class Start extends zen_command_1.default {
                 .on('change', redeploy)
                 .on('add', redeploy)
                 .on('unlink', redeploy);
+            debug('stepzen:start')(`chokidar started watching ${workspace.schema}`);
         }
         // Start!
         core_1.CliUx.ux.action.start('Starting...');
+        let didDeploy = false;
         // Unless explicitly disabled, auto-init
         if (!flags['no-init']) {
-            await start_1.deploy({ workspace, flags });
+            didDeploy = await start_1.deploy({ workspace, flags });
         }
         // Create the dashboard
         if (!flags['no-dashboard']) {
+            debug('stepzen:start')(`starting the dashboard server on ${flags.port}`);
             const ui = await dashboard({
                 account: configuration.account,
                 adminkey: configuration.adminkey,
@@ -71,11 +76,12 @@ class Start extends zen_command_1.default {
                 workspace,
             });
             await ui.start();
+            debug('stepzen:start')(`dashboard server on ${flags.port} started`);
         }
         // Done
         core_1.CliUx.ux.action.stop();
         if (!flags['no-console']) {
-            if (!flags['no-init']) {
+            if (didDeploy) {
                 start_1.success({
                     workspace,
                     account: configuration.account,

package/lib/commands/transpile.d.ts

@@ -17,5 +17,5 @@ export default class Transpile extends ZenCommand {
         name: string;
         required: boolean;
     }[];
-    run(): Promise<any>;
+    run(): Promise<string | false | undefined>;
 }

package/lib/commands/transpile.js

@@ -6,26 +6,26 @@ const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
 const fs = require("fs-extra");
 const path = require("path");
+const transpiler_1 = require("@stepzen/transpiler");
 const utils_1 = require("../shared/utils");
 const zen_command_1 = require("../shared/zen-command");
-const { configure, stitch, validate } = require('@stepzen/transpiler');
 class Transpile extends zen_command_1.default {
     async run() {
         const { args, flags } = this.parse(Transpile);
         const folder = utils_1.getDirectory(args.folder);
         // CONFIG
         if (flags['output-configuration']) {
-            const config = await configure(folder, flags.silent);
+            const config = await transpiler_1.configure(folder, flags.silent);
             if (flags['hide-output']) {
                 return config;
             }
-            this.log(config);
+            this.log(`${config}`);
             return;
         }
         // SCHEMA
         try {
-            const schema = stitch(folder);
-            validate(schema, {
+            const schema = transpiler_1.stitch(folder);
+            transpiler_1.validate(schema, {
                 extensions: await utils_1.getStepZenExtensions(),
             });
             const file = path.join(schema, 'index.graphql');

package/lib/commands/validate.js

@@ -4,16 +4,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const chalk = require("chalk");
 const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
+const transpiler_1 = require("@stepzen/transpiler");
 const utils_1 = require("../shared/utils");
 const zen_command_1 = require("../shared/zen-command");
-const { stitch, validate } = require('@stepzen/transpiler');
 class Validate extends zen_command_1.default {
     async run() {
         const { args } = this.parse(Validate);
         const folder = utils_1.getDirectory(args.folder);
         try {
-            const schema = stitch(folder);
-            validate(schema, {
+            const schema = transpiler_1.stitch(folder);
+            transpiler_1.validate(schema, {
                 extensions: await utils_1.getStepZenExtensions(),
             });
         }

package/lib/generate/curl2sdl.d.ts

@@ -1,24 +1,6 @@
 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;
+import { HeaderInput } from '../shared/header';
 export declare type Curl2SdlOptions = {
     curlArgs: CurlArguments;
     name?: string;

package/lib/generate/curl2sdl.js

@@ -2,22 +2,13 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
 const inquirer = require("inquirer");
 const lodash_1 = require("lodash");
-const os = require("os");
-const path = require("path");
 const string_argv_1 = require("string-argv");
-const node_fetch_1 = require("node-fetch");
-const debug = require("debug");
-const prettier = require("prettier");
-const transpiler_1 = require("@stepzen/transpiler");
 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");
+const helpers_1 = require("./helpers");
 /**
  * Collect together all query parameters from HTTP headers and from the
  * pathname, and return them as a uniform list.
@@ -116,7 +107,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
         },
         {
             name: 'typePrefix',
-            message: 'Prefix to add to all generated type name (leave blank to use defaults)',
+            message: 'Prefix to add to all generated type names (leave blank to use defaults)',
         },
     ];
     questions = questions.map(question => (Object.assign(Object.assign({}, question), { default: lodash_1.get(defaultAnswers, question.name) })));
@@ -152,107 +143,45 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
     };
 };
 exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }) => {
-    let json;
-    try {
-        const url = `${constants_1.STEPZEN_JSON2SDL_SERVER_URL}/api/graphql`;
-        const query = `query (
-      $command: String!
-      $queryName: String
-      $rootType: String
-      $typePrefix: String
-      $headers: [HeaderInput!]
-      $data: String
-      $method: HTTPMethod
-      $pathParams: [PathParamInput!]
-    ) {
-      getSDLFromCurl(
-        command: $command
-        queryName: $queryName
-        rootType: $rootType
-        typePrefix: $typePrefix
-        headers: $headers
-        data: $data
-        method: $method
-        pathParams: $pathParams
-      ) {
-        sdl
-        config
-      }
-    }`;
-        const variables = {
-            command: curlArgs.url,
-            queryName: queryName || null,
-            rootType: rootType || null,
-            typePrefix: typePrefix || null,
-            headers: headers.length > 0 ? headers : null,
-            data: curlArgs.data || null,
-            method: curlArgs.method,
-            pathParams: pathParams.length > 0 ? pathParams : null,
-        };
-        debug('stepzen:curl2sdl')(url);
-        debug('stepzen:curl2sdl')(query);
-        debug('stepzen:curl2sdl')(variables);
-        const payload = JSON.stringify({
-            query,
-            variables,
-        });
-        debug('stepzen:curl2sdl')(payload);
-        const response = await node_fetch_1.default(url, {
-            method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify({
-                query,
-                variables,
-            }),
-        });
-        const text = await response.text();
-        debug('stepzen:curl2sdl')(text);
-        json = JSON.parse(text);
-    }
-    catch (error) {
-        debug('stepzen:curl2sdl')(error);
-        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
-    }
-    if (!json.data && !json.errors) {
-        debug('stepzen:curl2sdl')('expected the response from the JSON introspection service ' +
-            'to contain either `data` or `errors`');
-        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
-    }
-    if (json.errors) {
-        return { error: json.errors.map((error) => error.message).join('\n') };
-    }
-    const { getSDLFromCurl } = json.data;
-    if (!getSDLFromCurl) {
-        debug('stepzen:curl2sdl')('expected the response from the JSON introspection service ' +
-            'to contain a `getSDLFromCurl` object');
-        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
-    }
-    const { config, sdl } = getSDLFromCurl;
-    if (!config && !sdl) {
-        debug('stepzen:curl2sdl')('expected the response from the JSON introspection service ' +
-            'to contain at least one of `getSDLFromCurl.config` or ' +
-            '`getSDLFromCurl.sdl` properties');
-        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
-    }
-    // write out the generated config and schema files
-    const tmp = path.join(os.tmpdir(), `stepzen-curl2sdl-${Date.now()}`);
-    fs.ensureDirSync(tmp);
-    // fs.ensureDirSync(path.join(tmp, subfolder))
-    if (config) {
-        fs.writeFileSync(path.join(tmp, 'config.yaml'), prettier.format(config, { parser: 'yaml' }));
-    }
-    if (sdl) {
-        fs.writeFileSync(path.join(tmp, 'index.graphql'), prettier.format(sdl, { parser: 'graphql' }));
-    }
-    const result = await transpiler_1.merge(source, {
-        name: name || 'curl',
-        source: tmp,
-    }, {
-        answers: {},
-        output: null,
-        silent: true,
-        mergeTypes: false,
-        onConflict,
+    const response = await helpers_1.queryIntrospectionService({
+        operation: 'getSDLFromCurl',
+        variables: {
+            command: {
+                type: 'String!',
+                value: curlArgs.url,
+            },
+            queryName: {
+                type: 'String',
+                value: queryName || null,
+            },
+            rootType: {
+                type: 'String',
+                value: rootType || null,
+            },
+            typePrefix: {
+                type: 'String',
+                value: typePrefix || null,
+            },
+            headers: {
+                type: '[HeaderInput!]',
+                value: headers && headers.length > 0 ? headers : null,
+            },
+            data: {
+                type: 'String',
+                value: curlArgs.data || null,
+            },
+            method: {
+                type: 'HTTPMethod!',
+                value: curlArgs.method,
+            },
+            pathParams: {
+                type: '[PathParamInput!]',
+                value: pathParams.length > 0 ? pathParams : null,
+            },
+        },
     });
-    return { outPath: result };
+    if (response.error) {
+        return { error: response.error };
+    }
+    return helpers_1.writeSdlAndConfig(name || 'curl', source, onConflict, response);
 };

package/lib/generate/graphql2sdl.d.ts

@@ -0,0 +1,23 @@
+import { HeaderInput } from '../shared/header';
+export declare type GraphQL2SdlOptions = {
+    name?: string;
+    source: string;
+    endpoint: string;
+    typePrefix?: string;
+    includeRootOperations?: boolean;
+    header?: string;
+    onConflict: 'overwrite' | 'append';
+};
+export declare type EditableGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'header'>;
+export declare type GraphQLAnswers = {
+    endpoint: string;
+    typePrefix: string;
+    includeRootOperations: boolean;
+    headers: readonly HeaderInput[];
+};
+export declare const askGraphQLQuestions: (defaultAnswers?: Partial<GraphQLAnswers>) => Promise<EditableGraphQL2SdlOptions>;
+export declare const graphql2sdl: ({ name, source, endpoint, typePrefix, includeRootOperations, header, onConflict, }: GraphQL2SdlOptions) => Promise<{
+    error: string;
+} | {
+    outPath: string;
+}>;

package/lib/generate/graphql2sdl.js

@@ -0,0 +1,62 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.graphql2sdl = exports.askGraphQLQuestions = void 0;
+const inquirer = require("inquirer");
+const lodash_1 = require("lodash");
+const header_1 = require("../shared/header");
+const helpers_1 = require("./helpers");
+exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
+    let questions = [
+        {
+            name: 'endpoint',
+            message: 'What is the GraphQL endpoint URL?',
+            validate: input => input.trim() !== '',
+        },
+        {
+            name: 'typePrefix',
+            message: 'Prefix to add to all generated type names (leave blank for none)',
+        },
+        {
+            name: 'includeRootOperations',
+            type: 'confirm',
+            message: 'Should type prefix be added to query and mutation fields as well?',
+            when: answers => Boolean(answers.typePrefix),
+        },
+        {
+            name: 'header',
+            type: 'input',
+            message: 'Add an HTTP header, e.g. Header-Name: header value (leave blank for none)',
+            validate: input => input === '' || header_1.HEADER_REGEX.test(input.trim()) || 'invalid header',
+        },
+    ];
+    questions = questions.map(question => (Object.assign(Object.assign({}, question), { default: lodash_1.get(defaultAnswers, question.name) })));
+    return inquirer.prompt(questions);
+};
+exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, header, onConflict, }) => {
+    const response = await helpers_1.queryIntrospectionService({
+        operation: 'getSDLFromGraphQL',
+        variables: {
+            endpoint: {
+                type: 'String!',
+                value: endpoint,
+            },
+            typePrefix: {
+                type: 'String',
+                value: typePrefix || null,
+            },
+            includeRootOperations: {
+                type: 'Boolean',
+                value: includeRootOperations || null,
+            },
+            headers: {
+                type: '[HeaderInput!]',
+                value: header ? [header_1.parseHeaderNameValue(header)] : null,
+            },
+        },
+    });
+    if (response.error) {
+        return { error: response.error };
+    }
+    return helpers_1.writeSdlAndConfig(name || 'graphql', source, onConflict, response);
+};

package/lib/generate/helpers.d.ts

@@ -11,3 +11,21 @@ export declare const getSchema: (arg: string) => string;
 export declare const getTemplates: () => Promise<string>;
 export declare const askGeneratorQuestions: (id: string, settings: any, state: any) => Promise<any>;
 export declare const askTemplateQuestions: (id: string, settings: any, state: any) => Promise<any>;
+export declare type IntrospectionServiceQuery = {
+    operation: string;
+    variables: {
+        [id: string]: {
+            type: string;
+            value: any | null;
+        };
+    };
+};
+export declare type IntrospectionServiceResponse = {
+    sdl?: string;
+    config?: string;
+    error?: string;
+};
+export declare const queryIntrospectionService: (query: IntrospectionServiceQuery) => Promise<IntrospectionServiceResponse>;
+export declare const writeSdlAndConfig: (name: string, source: string, onConflict: 'overwrite' | 'append', { config, sdl }: IntrospectionServiceResponse) => Promise<{
+    outPath: string;
+}>;

package/lib/generate/helpers.js

@@ -1,7 +1,7 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
+exports.writeSdlAndConfig = exports.queryIntrospectionService = exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
 const errors_1 = require("@oclif/errors");
 const chalk = require("chalk");
 const debug = require("debug");
@@ -12,6 +12,8 @@ const lodash_1 = require("lodash");
 const os = require("os");
 const path = require("path");
 const shell = require("shelljs");
+const transpiler = require("@stepzen/transpiler");
+const prettier = require("prettier");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
 const { version } = require('../../package.json');
@@ -159,3 +161,86 @@ exports.askTemplateQuestions = async (id, settings, state) => {
     const answers = await inquirer.prompt(questions);
     return Object.assign(Object.assign({}, state), answers);
 };
+exports.queryIntrospectionService = async (query) => {
+    let json;
+    try {
+        const url = `${constants_1.STEPZEN_JSON2SDL_SERVER_URL}/api/graphql`;
+        debug('stepzen:introspection')(url);
+        const queryString = `query (
+      ${Object.entries(query.variables).map(([id, { type }]) => `$${id}: ${type}`)} 
+      ) { 
+        ${query.operation}(${Object.keys(query.variables).map(id => `${id}: $${id}`)}) {
+          sdl
+          config
+        } 
+    }`;
+        debug('stepzen:introspection')(queryString);
+        debug('stepzen:introspection')(query.variables);
+        const payload = JSON.stringify({
+            query: queryString,
+            variables: lodash_1.mapValues(query.variables, ({ value }) => value),
+        });
+        debug('stepzen:introspection')(payload);
+        const response = await node_fetch_1.default(url, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: payload,
+        });
+        const text = await response.text();
+        debug('stepzen:introspection')(text);
+        json = JSON.parse(text);
+    }
+    catch (error) {
+        debug('stepzen:introspection')(error);
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+    if (!json.data && !json.errors) {
+        debug('stepzen:introspection')('expected the response from the JSON introspection service ' +
+            'to contain either `data` or `errors`');
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+    if (json.errors) {
+        const compileError = (error) => {
+            var _a;
+            return error.message +
+                (((_a = error.extensions) === null || _a === void 0 ? void 0 : _a.details) ? `: ${error.extensions.details}` : '');
+        };
+        return { error: json.errors.map(compileError).join('\n') };
+    }
+    if (!json.data[query.operation]) {
+        debug('stepzen:graphql2sdl')('expected the response from the JSON introspection service ' +
+            `to contain a \`${query.operation}\` object`);
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+    const { config, sdl } = json.data[query.operation];
+    if (!config && !sdl) {
+        debug('stepzen:curl2sdl')('expected the response from the JSON introspection service ' +
+            `to contain at least one of \`${query.operation}.config\` or ` +
+            `\`${query.operation}.sdl\` properties`);
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+    return { config, sdl };
+};
+exports.writeSdlAndConfig = async (name, source, onConflict, { config, sdl }) => {
+    // write out the generated config and schema files
+    const tmp = path.join(os.tmpdir(), `stepzen-introspection-${Date.now()}`);
+    fs.ensureDirSync(tmp);
+    // fs.ensureDirSync(path.join(tmp, subfolder))
+    if (config) {
+        fs.writeFileSync(path.join(tmp, 'config.yaml'), prettier.format(config, { parser: 'yaml' }));
+    }
+    if (sdl) {
+        fs.writeFileSync(path.join(tmp, 'index.graphql'), prettier.format(sdl, { parser: 'graphql' }));
+    }
+    const result = await transpiler.merge(source, {
+        name: name,
+        source: tmp,
+    }, {
+        answers: {},
+        output: null,
+        silent: true,
+        mergeTypes: false,
+        onConflict,
+    });
+    return { outPath: result };
+};

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

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

package/lib/shared/header.d.ts

@@ -0,0 +1,21 @@
+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 const HEADER_REGEX: RegExp;
+export declare const parseHeaderNameValue: (input: string) => NameValueHeaderInput | null;

package/lib/shared/header.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseHeaderNameValue = exports.HEADER_REGEX = void 0;
+exports.HEADER_REGEX = /([\w-]+): (.*)/;
+exports.parseHeaderNameValue = (input) => {
+    const match = input.match(exports.HEADER_REGEX);
+    if (match) {
+        const [name, value] = match.splice(1, 2);
+        return { name, value };
+    }
+    return null;
+};

package/lib/start/console.js

@@ -15,19 +15,34 @@ exports.success = ({ workspace, account, port, }) => {
     const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
     const url = `https://${account}.${domain}/${workspace.endpoint}/__graphql`;
     console.log();
-    console.log(chalk.grey(`Your API url is`, chalk.green(` ${url}`)));
-    console.log();
     if (process.platform === 'win32') {
-        console.log(chalk.grey(`You can explore your hosted API with GraphiQL at `), chalk.green(` http://localhost:${port}/${workspace.endpoint}`));
+        console.log(chalk.grey(`In PowerShell you can test your hosted API with Invoke-WebRequest:`));
+        console.log();
+        console.log(`Invoke-WebRequest \``);
+        console.log(`   -Uri ${url} \``);
+        console.log(`   -Method "POST" \``);
+        console.log(`   -Headers @{`);
+        console.log(`     "Content-Type" = "application/json"`);
+        if (!account.startsWith('public')) {
+            console.log(`     "Authorization" = "APIKey $(stepzen whoami --apikey)"`);
+        }
+        console.log(`   } \``);
+        console.log(`   -Body (@{`);
+        console.log(`     "query" = '${chalk.bgYellow.black('your graphql query')}'`);
+        console.log(`   } | ConvertTo-Json)`);
     }
     else {
         console.log(chalk.grey(`You can test your hosted API with cURL:`));
         console.log();
         console.log(`curl ${url} \\`);
-        console.log(`   --header "Authorization: Apikey $(stepzen whoami --apikey)" \\`);
+        if (!account.startsWith('public')) {
+            console.log(`   --header "Authorization: Apikey $(stepzen whoami --apikey)" \\`);
+        }
         console.log(`   --header "Content-Type: application/json" \\`);
-        console.log(`   --data '{"query": "your graphql query"}'`);
-        console.log();
-        console.log(chalk.grey(`or explore it with GraphiQL at`), chalk.green(` http://localhost:${port}/${workspace.endpoint}`));
+        console.log(`   --data '{"query": "${chalk.bgYellow.black('your graphql query')}"}'`);
     }
+    console.log();
+    console.log(chalk.grey(`or explore it with GraphiQL at http://localhost:${port}/${workspace.endpoint}`));
+    console.log();
+    console.log(chalk.grey(`Your API url is ${chalk.green(url)}`));
 };

package/lib/start/deploy.d.ts

@@ -2,5 +2,5 @@ import { Workspace } from '../shared/types';
 declare const _default: ({ workspace, flags, }: {
     workspace: Workspace;
     flags: Record<string, any>;
-}) => Promise<void>;
+}) => Promise<boolean>;
 export default _default;

package/lib/start/deploy.js

@@ -3,27 +3,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 const chalk = require("chalk");
+const debug = require("debug");
 const core_1 = require("@oclif/core");
+const dotenv = require("dotenv");
 const fs = require("fs-extra");
 const path = require("path");
 const prettyMilliseconds = require("pretty-ms");
 const deploy_1 = require("../commands/deploy");
 const upload_1 = require("../commands/upload");
 const validate_1 = require("../commands/validate");
-const dotenv = require('dotenv');
 exports.default = async ({ workspace, flags, }) => {
     var e_1, _a;
     dotenv.config({ path: path.join(workspace.directory, '.env') });
     if (!flags['no-validate']) {
+        const validateCmd = `stepzen validate ${workspace.schema}`;
         try {
+            debug('stepzen:start')(`starting $(${validateCmd})`);
             await validate_1.default.run([workspace.schema]);
+            debug('stepzen:start')(`$(${validateCmd}) completed successfully`);
         }
         catch (error) {
+            debug('stepzen:start')(`$(${validateCmd}) failed with`, error);
             console.log();
             console.log(chalk.red('Your local schema has the following GraphQL errors:'));
             console.log();
             console.log(error.message);
-            return;
+            return false;
         }
     }
     core_1.CliUx.ux.action.start(`Deploying ${chalk.yellow(workspace.endpoint)} to StepZen`);
@@ -69,12 +74,17 @@ exports.default = async ({ workspace, flags, }) => {
     try {
         for (var uploadCmds_1 = tslib_1.__asyncValues(uploadCmds), uploadCmds_1_1; uploadCmds_1_1 = await uploadCmds_1.next(), !uploadCmds_1_1.done;) {
             const cmd = uploadCmds_1_1.value;
+            const commandCmd = `stepzen upload '${cmd.join("' '")}'`;
             try {
+                debug('stepzen:start')(`starting $(${commandCmd})`);
                 await upload_1.default.run(cmd);
+                debug('stepzen:start')(`$(${commandCmd}) completed successfully`);
             }
             catch (error) {
+                debug('stepzen:start')(`$(${commandCmd}) failed with`, error);
+                core_1.CliUx.ux.action.stop(chalk.red('fail'));
                 logError(error);
-                return;
+                return false;
             }
         }
     }
@@ -85,14 +95,20 @@ exports.default = async ({ workspace, flags, }) => {
         }
         finally { if (e_1) throw e_1.error; }
     }
+    const deployCmd = `stepzen deploy '${deployArgs.join("' '")}'`;
     try {
+        debug('stepzen:start')(`starting $(${deployCmd})`);
         await deploy_1.default.run(deployArgs);
+        debug('stepzen:start')(`$(${deployCmd}) completed successfully`);
     }
     catch (error) {
+        debug('stepzen:start')(`$(${deployCmd}) failed with`, error);
+        core_1.CliUx.ux.action.stop(chalk.red('fail'));
         logError(error);
-        return;
+        return false;
     }
     const deployEnd = new Date().getTime();
     const deployTime = deployEnd - deployStart;
     core_1.CliUx.ux.action.stop(`${chalk.grey('done in')} ${prettyMilliseconds(deployTime)} 🚀`);
+    return true;
 };

package/oclif.manifest.json

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

package/package.json

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