stepzen 0.18.0-beta.1 → 0.19.0-beta.0

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.18.0-beta.1 darwin-x64 node-v14.19.3
+stepzen/0.19.0-beta.0 darwin-x64 node-v14.19.3
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -179,10 +179,17 @@ USAGE
   $ stepzen login
 
 OPTIONS
-  -h, --help  show CLI help
+  -a, --account=account    StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI
+                           prompts the users to enter one.
+
+  -h, --help               show CLI help
+
+  -k, --adminkey=adminkey  Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users
+                           to enter one.
 
-  --public    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.
+  --public                 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.
 ```
 
 ## `stepzen logout`

package/lib/commands/import.d.ts

@@ -1,4 +1,5 @@
 import { flags } from '@oclif/command';
+import type { CommonImportOptions } from '../generate';
 import ZenCommand from '../shared/zen-command';
 import { HeaderInput } from '../shared/header';
 import { Workspace } from '../shared/types';
@@ -79,6 +80,10 @@ export default class Import extends ZenCommand {
     }[];
     static strict: boolean;
     run(): Promise<void>;
+    importCurl(argv: string[], flags: any, fixedOptions: CommonImportOptions): Promise<string>;
+    importGraphQL(argv: string[], flags: any, fixedOptions: CommonImportOptions): Promise<string>;
+    importSql(schema: string, argv: string[], flags: any, fixedOptions: CommonImportOptions): Promise<string>;
+    importFromGeneratorEngines(schema: string, argv: string[], flags: any, fixedOptions: CommonImportOptions): Promise<string>;
     ensureOnConflictBehavior(workspace: Workspace, schema: string, flags: ReturnType<Import['parseWorkaround']>['flags']): Promise<"overwrite" | "append">;
     warnAboutIgnoredFlags(schema: string, usedFlags: {
         [key: string]: any;
@@ -106,4 +111,7 @@ export default class Import extends ZenCommand {
         [name: string]: any;
     }>;
     parseHeaderFlags(headerFlagValues?: string[], headerParamFlagValues?: string[]): HeaderInput[];
+    getSqlOptionsFromFlags(flags: any): {
+        [x: string]: any;
+    };
 }

package/lib/commands/import.js

@@ -16,6 +16,7 @@ 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 sql2sdl_1 = require("../generate/sql2sdl");
 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");
@@ -30,123 +31,28 @@ class Import extends zen_command_1.default {
         // Define a sane onConflict behaviour (possibly interactive)
         const onConflict = await this.ensureOnConflictBehavior(workspace, schema, flags);
         this.warnAboutIgnoredFlags(schema, flags);
-        const headers = this.parseHeaderFlags(flags.header, flags['header-param']);
+        // Common options for all import schemas
+        const fixedOptions = {
+            name: flags.name,
+            source: workspace.schema,
+            onConflict,
+        };
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function
         //  - v2 with the graphqlize service
         let result;
         if (schema === 'curl') {
-            // LATER: offload the check to the graphqlize service or fetch
-            // the list of supported data sources and compare agains it.
-            this.log(chalk.yellow(`NOTE: ${chalk.bold('stepzen import curl')} is a ${chalk.bold('new')} feature.`));
-            this.log(chalk.yellow('If you have any issues, please check if they have been addressed ' +
-                'in the latest version, or reach out to StepZen on Discord: ' +
-                constants_1.STEPZEN_DISCORD_URL));
-            let curl2sdlOptions;
-            const fixedOptions = {
-                name: flags.name,
-                source: workspace.schema,
-                onConflict,
-            };
-            const editableOptions = {
-                queryName: flags['query-name'],
-                rootType: flags['query-type'],
-                typePrefix: flags.prefix,
-                pathParams: flags['path-params'],
-            };
-            if (argv.length === 1) {
-                // no parameters given: start an interactive prompt
-                console.log();
-                console.log('This command introspects the response of a REST endpoint and generates' +
-                    ' a GraphQL schema allowing you to access this endpoint through your ' +
-                    'StepZen API. curl syntax is supported so that you copy and paste a ' +
-                    'curl command instead of the URL.');
-                console.log();
-                const curlAnswers = await curl2sdl_1.askCurlQuestions(editableOptions);
-                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), curlAnswers), { 
-                    // include boths headers passed via flags and headers entered interactively
-                    headers: headers.concat(curlAnswers.curlArgs.headers) });
-            }
-            else {
-                // run non-interative
-                const argsOrError = curl_parser_1.parseCurlArgv(argv);
-                if ('error' in argsOrError) {
-                    throw new errors_1.CLIError(argsOrError.error);
-                }
-                const parsedPathParamsOrError = path_params_parser_1.parsePathParamsPattern(argsOrError.url, flags['path-params']);
-                if ('error' in parsedPathParamsOrError) {
-                    throw new errors_1.CLIError(parsedPathParamsOrError.error);
-                }
-                const maybeDuplicateParamsMessage = curl2sdl_1.makeDuplicateParamsMessage(headers, parsedPathParamsOrError, argsOrError.url);
-                if (maybeDuplicateParamsMessage) {
-                    throw new errors_1.CLIError(maybeDuplicateParamsMessage);
-                }
-                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, headers: headers, curlArgs: argsOrError });
-            }
-            core_1.CliUx.ux.action.start('Starting');
-            const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
-            core_1.CliUx.ux.action.stop();
-            if ('error' in resultOrError) {
-                this.log('A problem occured while processing your import. ' +
-                    'Please check that the given cURL command is valid.');
-                this.log(resultOrError.error);
-                this.exit();
-            }
-            result = resultOrError.outPath;
+            result = await this.importCurl(argv, flags, fixedOptions);
         }
         else if (schema === 'graphql') {
-            const editableOptions = {
-                typePrefix: flags.prefix,
-                headers: headers,
-            };
-            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;
+            result = await this.importGraphQL(argv, flags, fixedOptions);
+        }
+        else if (process.env.STEPZEN_BYPASS_GENERATOR_ENGINES) {
+            result = await this.importSql(schema, argv, flags, fixedOptions);
         }
         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
-            // 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).
-            let preAnswered = {};
-            if (schema === 'mysql' || schema === 'postgresql') {
-                const asKeyValue = (key, flag) => flag === undefined ? {} : { [key]: flag };
-                preAnswered = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, asKeyValue('host', flags['db-host'])), asKeyValue('user', flags['db-user'])), asKeyValue('password', flags['db-password'])), asKeyValue('database', flags['db-database'])), asKeyValue('linkTypes', flags['db-link-types'] ? 'Yes' : 'No')), asKeyValue('schema', flags['db-schema']));
-            }
-            // Let's go!
-            result = await generate_1.default({
-                schema,
-                name: flags.name,
-                onConflict,
-                source: workspace.schema,
-                preAnswered,
-            });
-            // Validate
-            await transpiler_1.validate(result, {
-                extensions: await utils_1.getStepZenExtensions(),
-            });
+            // Delegate the schema to generator-engines function
+            result = await this.importFromGeneratorEngines(schema, argv, flags, fixedOptions);
         }
         // Housekeeping
         fs.copySync(result, workspace.schema);
@@ -154,6 +60,134 @@ class Import extends zen_command_1.default {
         // Nice message
         this.log(chalk.green(`Successfully imported schema ${chalk.bold(schema)} from StepZen`));
     }
+    async importCurl(argv, flags, fixedOptions) {
+        const headers = this.parseHeaderFlags(flags.header, flags['header-param']);
+        // LATER: offload the check to the graphqlize service or fetch
+        // the list of supported data sources and compare agains it.
+        this.log(chalk.yellow(`NOTE: ${chalk.bold('stepzen import curl')} is a ${chalk.bold('new')} feature.`));
+        this.log(chalk.yellow('If you have any issues, please check if they have been addressed ' +
+            'in the latest version, or reach out to StepZen on Discord: ' +
+            constants_1.STEPZEN_DISCORD_URL));
+        let curl2sdlOptions;
+        const editableOptions = {
+            queryName: flags['query-name'],
+            rootType: flags['query-type'],
+            typePrefix: flags.prefix,
+            pathParams: flags['path-params'],
+        };
+        if (argv.length === 1) {
+            // no parameters given: start an interactive prompt
+            console.log();
+            console.log('This command introspects the response of a REST endpoint and generates' +
+                ' a GraphQL schema allowing you to access this endpoint through your ' +
+                'StepZen API. curl syntax is supported so that you copy and paste a ' +
+                'curl command instead of the URL.');
+            console.log();
+            const curlAnswers = await curl2sdl_1.askCurlQuestions(editableOptions);
+            curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), curlAnswers), { 
+                // include boths headers passed via flags and headers entered interactively
+                headers: headers.concat(curlAnswers.curlArgs.headers) });
+        }
+        else {
+            // run non-interative
+            const argsOrError = curl_parser_1.parseCurlArgv(argv);
+            if ('error' in argsOrError) {
+                throw new errors_1.CLIError(argsOrError.error);
+            }
+            const parsedPathParamsOrError = path_params_parser_1.parsePathParamsPattern(argsOrError.url, flags['path-params']);
+            if ('error' in parsedPathParamsOrError) {
+                throw new errors_1.CLIError(parsedPathParamsOrError.error);
+            }
+            const maybeDuplicateParamsMessage = curl2sdl_1.makeDuplicateParamsMessage(headers, parsedPathParamsOrError, argsOrError.url);
+            if (maybeDuplicateParamsMessage) {
+                throw new errors_1.CLIError(maybeDuplicateParamsMessage);
+            }
+            curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, headers: headers, curlArgs: argsOrError });
+        }
+        core_1.CliUx.ux.action.start('Starting');
+        const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
+        core_1.CliUx.ux.action.stop();
+        if ('error' in resultOrError) {
+            this.log('A problem occured while processing your import. ' +
+                'Please check that the given cURL command is valid.');
+            this.log(resultOrError.error);
+            this.exit();
+        }
+        return resultOrError.outPath;
+    }
+    async importGraphQL(argv, flags, fixedOptions) {
+        const headers = this.parseHeaderFlags(flags.header, flags['header-param']);
+        const editableOptions = {
+            typePrefix: flags.prefix,
+            headers: headers,
+        };
+        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 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();
+        }
+        return resultOrError.outPath;
+    }
+    async importSql(schema, argv, flags, fixedOptions) {
+        if (!(schema === 'mysql' || schema === 'postgresql')) {
+            throw new errors_1.CLIError(`Schema "${schema}" not supported when the STEPZEN_BYPASS_GENERATOR_ENGINES feature flag is enabled; ` +
+                `if this is a legacy import schema, please run the command without the feature flag`);
+        }
+        const editableOptions = this.getSqlOptionsFromFlags(flags);
+        let answers;
+        if (editableOptions.host !== undefined &&
+            editableOptions.database !== undefined &&
+            editableOptions.user !== undefined &&
+            editableOptions.password !== undefined) {
+            // non-interactive
+            answers = editableOptions;
+        }
+        else {
+            // interactive
+            answers = await sql2sdl_1.askSqlQuestions(schema, editableOptions);
+        }
+        const options = Object.assign(Object.assign({}, fixedOptions), answers);
+        core_1.CliUx.ux.action.start('Starting');
+        const resultOrError = await sql2sdl_1.sql2sdl(schema, options);
+        core_1.CliUx.ux.action.stop();
+        if ('error' in resultOrError) {
+            this.log('A problem occured while processing your import. ' +
+                'Please check that the given database details are valid.');
+            this.log(resultOrError.error);
+            this.exit();
+        }
+        return resultOrError.outPath;
+    }
+    async importFromGeneratorEngines(schema, argv, flags, fixedOptions) {
+        const preAnswered = {};
+        if (schema === 'mysql' || schema === 'postgresql') {
+            const sqlPreAnswered = this.getSqlOptionsFromFlags(flags);
+            if (Object.prototype.hasOwnProperty.call(sqlPreAnswered, 'linkTypes')) {
+                sqlPreAnswered.linkTypes = sqlPreAnswered.linkTypes ? 'Yes' : 'No';
+            }
+        }
+        // Let's go!
+        const result = await generate_1.default(Object.assign(Object.assign({}, fixedOptions), { schema,
+            preAnswered }));
+        // Validate
+        await transpiler_1.validate(result, {
+            extensions: await utils_1.getStepZenExtensions(),
+        });
+        return result;
+    }
     async ensureOnConflictBehavior(workspace, schema, flags) {
         const featureFlag = process.env.STEPZEN_DETECT_NAME_CONFLICTS;
         if (featureFlag === undefined || featureFlag.toLowerCase() === 'false') {
@@ -276,6 +310,10 @@ class Import extends zen_command_1.default {
         }
         return headersOrError;
     }
+    getSqlOptionsFromFlags(flags) {
+        const asKeyValue = (key, flag) => flag === undefined ? {} : { [key]: flag };
+        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, asKeyValue('host', flags['db-host'])), asKeyValue('user', flags['db-user'])), asKeyValue('password', flags['db-password'])), asKeyValue('database', flags['db-database'])), asKeyValue('linkTypes', flags['db-link-types'])), asKeyValue('schema', flags['db-schema']));
+    }
 }
 exports.default = Import;
 Import.description = 'import a schema for an external data source or a API endpoint to your GraphQL API';

package/lib/commands/login.js

@@ -57,12 +57,14 @@ exports.default = Login;
 Login.description = 'log in to StepZen';
 Login.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { account: command_1.flags.string({
         char: 'a',
+        description: 'StepZen account name (copy from https://stepzen.com/account).' +
+            ' If not provided, the CLI prompts the users to enter one.',
         exclusive: ['config', 'public'],
-        hidden: true,
     }), adminkey: command_1.flags.string({
         char: 'k',
+        description: 'Admin key (copy from https://stepzen.com/account)' +
+            ' If not provided, the CLI prompts the users to enter one.',
         exclusive: ['config', 'public'],
-        hidden: true,
     }), public: command_1.flags.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' +

package/lib/generate/curl2sdl.d.ts

@@ -1,16 +1,14 @@
 import { CurlArguments } from '../shared/curl-parser';
 import { PathParam } from '../shared/path-params-parser';
 import { HeaderInput } from '../shared/header';
-export declare type Curl2SdlOptions = {
+import type { CommonImportOptions } from '.';
+export declare type Curl2SdlOptions = CommonImportOptions & {
     curlArgs: CurlArguments;
-    name?: string;
-    source: string;
     queryName?: string;
     rootType?: string;
     typePrefix?: string;
     pathParams: readonly PathParam[];
     headers: readonly HeaderInput[];
-    onConflict: 'overwrite' | 'append';
 };
 export declare type EditableCurl2SdlOptions = Pick<Curl2SdlOptions, 'curlArgs' | 'queryName' | 'rootType' | 'typePrefix' | 'pathParams'>;
 export declare type CurlAnswers = {

package/lib/generate/curl2sdl.js

@@ -9,6 +9,7 @@ const string_argv_1 = require("string-argv");
 const curl_parser_1 = require("../shared/curl-parser");
 const path_params_parser_1 = require("../shared/path-params-parser");
 const helpers_1 = require("./helpers");
+const constants_1 = require("../shared/constants");
 /**
  * Collect together all query parameters from HTTP headers and from the
  * pathname, and return them as a uniform list.
@@ -88,7 +89,7 @@ exports.makeDuplicateParamsMessage = (headers, pathParams, url) => {
     return null;
 };
 exports.askCurlQuestions = async (defaultAnswers = {}) => {
-    let questions = [
+    const questions = [
         {
             name: 'url',
             message: 'Endpoint URL or a full curl command',
@@ -110,8 +111,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
             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) })));
-    const answers = await inquirer.prompt(questions);
+    const answers = await inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
     const curlArgs = curl_parser_1.parseCurlArgv(string_argv_1.default(answers.url));
     if ('error' in curlArgs) {
         console.log();
@@ -143,7 +143,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
     };
 };
 exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }) => {
-    const response = await helpers_1.queryIntrospectionService({
+    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
         operation: 'getSDLFromCurl',
         variables: {
             command: {

package/lib/generate/graphql2sdl.d.ts

@@ -1,12 +1,10 @@
 import { HeaderInput } from '../shared/header';
-export declare type GraphQL2SdlOptions = {
-    name?: string;
-    source: string;
+import type { CommonImportOptions } from '.';
+export declare type GraphQL2SdlOptions = CommonImportOptions & {
     endpoint: string;
     typePrefix?: string;
     includeRootOperations?: boolean;
     headers: readonly HeaderInput[];
-    onConflict: 'overwrite' | 'append';
 };
 export declare type EditableGraphQL2SdlOptions = Pick<GraphQL2SdlOptions, 'endpoint' | 'typePrefix' | 'includeRootOperations' | 'headers'>;
 export declare type GraphQLAnswers = {

package/lib/generate/graphql2sdl.js

@@ -3,11 +3,11 @@
 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");
+const constants_1 = require("../shared/constants");
 exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
-    let questions = [
+    const questions = [
         {
             name: 'endpoint',
             message: 'What is the GraphQL endpoint URL?',
@@ -30,11 +30,10 @@ exports.askGraphQLQuestions = async (defaultAnswers = {}) => {
             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);
+    return inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
 };
 exports.graphql2sdl = async ({ name, source, endpoint, typePrefix, includeRootOperations, headers, onConflict, }) => {
-    const response = await helpers_1.queryIntrospectionService({
+    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_JSON2SDL_SERVER_URL, {
         operation: 'getSDLFromGraphQL',
         variables: {
             endpoint: {

package/lib/generate/helpers.d.ts

@@ -1,3 +1,4 @@
+import * as inquirer from 'inquirer';
 import type { Answers, DistinctQuestion } from 'inquirer';
 export declare const createGeneratorFiles: (id: string, details: any) => Promise<string>;
 export declare type GeneratorConfiguration = {
@@ -25,7 +26,8 @@ export declare type IntrospectionServiceResponse = {
     config?: string;
     error?: string;
 };
-export declare const queryIntrospectionService: (query: IntrospectionServiceQuery) => Promise<IntrospectionServiceResponse>;
+export declare const queryIntrospectionService: (serverUrl: string, query: IntrospectionServiceQuery) => Promise<IntrospectionServiceResponse>;
 export declare const writeSdlAndConfig: (name: string, source: string, onConflict: 'overwrite' | 'append', { config, sdl }: IntrospectionServiceResponse) => Promise<{
     outPath: string;
 }>;
+export declare const overrideDefaults: <Options>(questions: inquirer.DistinctQuestion<Options>[], defaultAnswers: Partial<Options>) => inquirer.DistinctQuestion<Options>[];

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.writeSdlAndConfig = exports.queryIntrospectionService = exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
+exports.overrideDefaults = 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");
@@ -161,11 +161,10 @@ exports.askTemplateQuestions = async (id, settings, state) => {
     const answers = await inquirer.prompt(questions);
     return Object.assign(Object.assign({}, state), answers);
 };
-exports.queryIntrospectionService = async (query) => {
+exports.queryIntrospectionService = async (serverUrl, query) => {
     let json;
     try {
-        const url = `${constants_1.STEPZEN_JSON2SDL_SERVER_URL}/api/graphql`;
-        debug('stepzen:introspection')(url);
+        debug('stepzen:introspection')(serverUrl);
         const queryString = `query (
       ${Object.entries(query.variables).map(([id, { type }]) => `$${id}: ${type}`)} 
       ) { 
@@ -181,7 +180,7 @@ exports.queryIntrospectionService = async (query) => {
             variables: lodash_1.mapValues(query.variables, ({ value }) => value),
         });
         debug('stepzen:introspection')(payload);
-        const response = await node_fetch_1.default(url, {
+        const response = await node_fetch_1.default(serverUrl, {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
             body: payload,
@@ -245,3 +244,9 @@ exports.writeSdlAndConfig = async (name, source, onConflict, { config, sdl }) =>
     });
     return { outPath: result };
 };
+exports.overrideDefaults = (questions, defaultAnswers) => {
+    return questions.map(question => {
+        const def = lodash_1.get(defaultAnswers, question.name);
+        return def === undefined ? question : Object.assign(Object.assign({}, question), { default: def });
+    });
+};

package/lib/generate/index.d.ts

@@ -1,8 +1,10 @@
-export declare type GenerateOptions = {
-    schema: string;
+export declare type CommonImportOptions = {
     name?: string;
-    onConflict: 'overwrite' | 'append';
     source: string;
+    onConflict: 'overwrite' | 'append';
+};
+export declare type GenerateOptions = CommonImportOptions & {
+    schema: string;
     preAnswered?: {
         [question: string]: string;
     };

package/lib/generate/sql2sdl.d.ts

@@ -0,0 +1,22 @@
+import type { CommonImportOptions } from '.';
+export declare type DBType = 'mysql' | 'postgresql';
+export declare type SQLOptions = CommonImportOptions & {
+    host: string;
+    database: string;
+    user: string;
+    password: string;
+    linkTypes?: boolean;
+    schema?: string;
+};
+export declare type EditableSQLOptions = Pick<SQLOptions, 'host' | 'database' | 'user' | 'password' | 'linkTypes' | 'schema'>;
+export declare const parseHost: (host?: string | undefined) => {
+    host?: string | undefined;
+    port?: string | undefined;
+    isValid: boolean;
+};
+export declare const askSqlQuestions: (dbType: DBType, defaultAnswers?: Partial<SQLOptions>) => Promise<EditableSQLOptions>;
+export declare const sql2sdl: (dbType: DBType, { name, source, host, database, user, password, linkTypes, schema, onConflict, }: SQLOptions) => Promise<{
+    error: string;
+} | {
+    outPath: string;
+}>;

package/lib/generate/sql2sdl.js

@@ -0,0 +1,128 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sql2sdl = exports.askSqlQuestions = exports.parseHost = void 0;
+const chalk = require("chalk");
+const inquirer = require("inquirer");
+const helpers_1 = require("./helpers");
+const constants_1 = require("../shared/constants");
+exports.parseHost = (host) => {
+    if (!host) {
+        return { host: undefined, port: undefined, isValid: false };
+    }
+    let url;
+    // Try parsing as a DNS name or an IPv4 address (possibly with a port)
+    // e.g. "example.com:5432" or "[fedc:ba98:7654:3210:fedc:ba98:7654:3210]:5432"
+    try {
+        url = new URL(`http://${host}`);
+    }
+    catch (_a) {
+        // Try parsing as an IPv6 address (without a port)
+        // e.g. fedc:ba98:7654:3210:fedc:ba98:7654:3210
+        try {
+            url = new URL(`http://[${host}]`);
+        }
+        catch (_b) {
+            // ignore
+        }
+    }
+    if (!url) {
+        return { host, port: undefined, isValid: false };
+    }
+    return {
+        host: url.hostname,
+        port: url.port || undefined,
+        isValid: true,
+    };
+};
+exports.askSqlQuestions = async (dbType, defaultAnswers = {}) => {
+    let questions = [
+        {
+            name: 'host',
+            message: 'What is your host?',
+            validate: input => exports.parseHost(input).isValid || `Could not parse "${input}" as a hostname.`,
+        },
+        {
+            name: 'database',
+            message: 'What is your database name?',
+            validate: input => input.trim() !== '' || 'Database name must not be empty',
+        },
+        {
+            name: 'user',
+            message: 'What is the username?',
+            validate: input => input.trim() !== '' || 'Username must not be empty',
+        },
+        {
+            name: 'password',
+            message: 'What is the password?',
+            type: 'password',
+        },
+        {
+            name: 'linkTypes',
+            message: 'Automatically link types with @materializer whenever there is database support' +
+                `\n  ${chalk.dim('(https://stepzen.com/docs/features/linking-types)')}`,
+            type: 'confirm',
+            default: false,
+        },
+    ];
+    if (dbType === 'postgresql') {
+        questions = questions.concat([
+            {
+                name: 'schema',
+                message: 'What is your database schema (leave blank to use defaults)?',
+            },
+        ]);
+    }
+    return inquirer.prompt(helpers_1.overrideDefaults(questions, defaultAnswers));
+};
+exports.sql2sdl = async (dbType, { name, source, host, database, user, password, linkTypes, schema, onConflict, }) => {
+    const effectiveName = name || dbType;
+    const hostDetails = exports.parseHost(host);
+    const response = await helpers_1.queryIntrospectionService(constants_1.STEPZEN_DBINTROSPECTION_SERVER_URL, {
+        operation: 'generateSDL',
+        variables: {
+            driver: {
+                type: 'DBDriver!',
+                value: dbType === 'mysql' ? 'MYSQL' : 'POSTGRESQL',
+            },
+            host: {
+                type: 'String!',
+                value: hostDetails.host,
+            },
+            port: {
+                type: 'Int',
+                value: hostDetails.port === undefined
+                    ? null
+                    : parseInt(hostDetails.port, 10),
+            },
+            database: {
+                type: 'String!',
+                value: database,
+            },
+            user: {
+                type: 'String!',
+                value: user,
+            },
+            password: {
+                type: 'String!',
+                value: password,
+            },
+            onlyTypes: {
+                type: 'Boolean',
+                value: !linkTypes,
+            },
+            schema: {
+                type: 'String',
+                value: schema,
+            },
+            configName: {
+                type: 'String!',
+                value: `${effectiveName}_config`,
+            },
+        },
+    });
+    if (response.error) {
+        return { error: response.error };
+    }
+    return helpers_1.writeSdlAndConfig(effectiveName, source, onConflict, response);
+};

package/lib/shared/constants.d.ts

@@ -10,4 +10,5 @@ export declare const ADMIN_LIST_URL = "/cli/admin/list";
 export declare const ADMIN_UPLOAD_URL = "/cli/admin/upload";
 export declare const ADMIN_ACCOUNT_URL = "/cli/admin/account";
 export declare const STEPZEN_JSON2SDL_SERVER_URL: string;
+export declare const STEPZEN_DBINTROSPECTION_SERVER_URL: string;
 export declare const STEPZEN_DISCORD_URL = "https://discord.gg/9k2VdPn2FR";

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_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_DBINTROSPECTION_SERVER_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_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_DBINTROSPECTION_SERVER_URL: ENV_VAR_DBINTROSPECTION_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');
@@ -29,5 +29,7 @@ exports.ADMIN_LIST_URL = '/cli/admin/list';
 exports.ADMIN_UPLOAD_URL = '/cli/admin/upload';
 exports.ADMIN_ACCOUNT_URL = '/cli/admin/account';
 exports.STEPZEN_JSON2SDL_SERVER_URL = ENV_VAR_STEPZEN_JSON2SDL_SERVER_URL ||
-    'https://jsonintrospection-ng-prod-xynkgeaaaa-uc.a.run.app';
+    'https://jsonintrospection-ng-prod-xynkgeaaaa-uc.a.run.app/api/graphql';
+exports.STEPZEN_DBINTROSPECTION_SERVER_URL = ENV_VAR_DBINTROSPECTION_SERVER_URL ||
+    'https://dbintrospection-prod-xynkgeaaaa-uc.a.run.app/graphql';
 exports.STEPZEN_DISCORD_URL = 'https://discord.gg/9k2VdPn2FR';

package/lib/start/deploy.js

@@ -35,7 +35,7 @@ exports.default = async ({ workspace, flags, }) => {
     const deployArgs = [workspace.endpoint, '--silent'];
     const uploadCmds = [];
     const configPath = path.join(workspace.schema, 'config.yaml');
-    if (fs.existsSync(configPath)) {
+    if (fs.existsSync(configPath) && fs.statSync(configPath).size > 0) {
         deployArgs.push('--configurationsets', `${workspace.endpoint},stepzen/default`);
         uploadCmds.push([
             'configurationset',
@@ -61,7 +61,7 @@ exports.default = async ({ workspace, flags, }) => {
     const logError = (error) => {
         try {
             const zenctlError = JSON.parse(error.message);
-            const msg = zenctlError[0].message;
+            const msg = zenctlError[0].message || zenctlError[0] || zenctlError;
             console.log('');
             console.log(chalk.red(msg));
         }

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.18.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.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] prefix to add every type in the generated schema."},"header":{"name":"header","type":"option","char":"H","description":"[curl, graphql] specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\""},"header-param":{"name":"header-param","type":"option","description":"[curl, graphql] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] name of database to import"},"db-link-types":{"name":"db-link-types","type":"boolean","description":"[mysql, postgresql] Automatically link types with @materializer whenever there is database support (https://stepzen.com/docs/features/linking-types)","allowNo":false},"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.19.0-beta.0","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"import a schema for an external data source or a API endpoint to your GraphQL API","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema."},"overwrite":{"name":"overwrite","type":"boolean","description":"Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.","hidden":true,"allowNo":false},"prefix":{"name":"prefix","type":"option","description":"[curl, graphql] prefix to add every type in the generated schema."},"header":{"name":"header","type":"option","char":"H","description":"[curl, graphql] specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\""},"header-param":{"name":"header-param","type":"option","description":"[curl, graphql] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] name of database to import"},"db-link-types":{"name":"db-link-types","type":"boolean","description":"[mysql, postgresql] Automatically link types with @materializer whenever there is database support (https://stepzen.com/docs/features/linking-types)","allowNo":false},"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","description":"StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI prompts the users to enter one."},"adminkey":{"name":"adminkey","type":"option","char":"k","description":"Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users to enter one."},"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.18.0-beta.1",
+  "version": "0.19.0-beta.0",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [