stepzen 0.16.0-beta.5 → 0.17.0-beta.1

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.16.0-beta.5 darwin-x64 node-v14.19.1
+stepzen/0.17.0-beta.1 darwin-x64 node-v14.19.1
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -123,7 +123,11 @@ OPTIONS
       --header-param 'Authorization: apikey $apikey'
 
   --name=name
-      subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name
+      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

package/lib/commands/import.d.ts

@@ -1,5 +1,6 @@
 import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
+import { Workspace } from '../shared/types';
 export default class Import extends ZenCommand {
     static description: string;
     static curlFlags: {
@@ -56,6 +57,7 @@ export default class Import extends ZenCommand {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         name: flags.IOptionFlag<string | undefined>;
+        overwrite: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     static args: {
@@ -64,9 +66,10 @@ export default class Import extends ZenCommand {
     }[];
     static strict: boolean;
     run(): Promise<void>;
-    warnAboutIgnoredFlags: (schema: string, usedFlags: {
+    ensureOnConflictBehavior(workspace: Workspace, schema: string, flags: ReturnType<Import['parseWorkaround']>['flags']): Promise<"overwrite" | "append">;
+    warnAboutIgnoredFlags(schema: string, usedFlags: {
         [key: string]: any;
-    }) => void;
+    }): void;
     parseWorkaround(): import("@oclif/parser").Output<{
         'db-schema': string | undefined;
         'db-host': string | undefined;
@@ -82,6 +85,7 @@ export default class Import extends ZenCommand {
         help: void;
         silent: boolean;
         name: string | undefined;
+        overwrite: boolean;
         'non-interactive': boolean;
     }, {
         [name: string]: any;

package/lib/commands/import.js

@@ -3,6 +3,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk = require("chalk");
 const fs = require("fs-extra");
+const path = require("path");
+const inquirer = require("inquirer");
 const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
 const transpiler_1 = require("@stepzen/transpiler");
@@ -12,49 +14,19 @@ const utils_1 = require("../shared/utils");
 const helpers_1 = require("../generate/helpers");
 const curl2sdl_1 = require("../generate/curl2sdl");
 const curl_parser_1 = require("../shared/curl-parser");
-const workspace_1 = require("../shared/workspace");
 const zen_command_1 = require("../shared/zen-command");
-const init_1 = require("./init");
 const constants_1 = require("../shared/constants");
 const path_params_parser_1 = require("../shared/path-params-parser");
 const header_params_parser_1 = require("../shared/header-params-parser");
 class Import extends zen_command_1.default {
-    constructor() {
-        super(...arguments);
-        // notify the user about any ignored flags
-        this.warnAboutIgnoredFlags = (schema, usedFlags) => {
-            Import.flagsForSchemas.forEach(({ flags, schemas }) => {
-                if (!schemas.includes(schema)) {
-                    Object.keys(flags).forEach(flag => {
-                        if (Object.prototype.hasOwnProperty.call(usedFlags, flag)) {
-                            this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${schemas
-                                .map(schema => chalk.bold(schema))
-                                .join(', ')}. It will be ignored now.`));
-                        }
-                    });
-                }
-            });
-        };
-    }
     async run() {
         const { args, argv, flags } = this.parseWorkaround();
         // Get a list of schemas you're asking for
         const schema = helpers_1.getSchema(args.schema);
-        // Get the working directory and workspace
-        let workspace;
-        const directory = utils_1.getDirectory(flags.dir);
-        const maybeWorkspace = workspace_1.getWorkspace(directory);
-        if (maybeWorkspace) {
-            workspace = maybeWorkspace;
-        }
-        else {
-            try {
-                workspace = await init_1.default.run([directory]);
-            }
-            catch (error) {
-                throw new errors_1.CLIError(`Could not create a StepZen workspace in the ${flags.dir ? directory : 'current'} directory.\n` + error.message);
-            }
-        }
+        // Get or create a StepZen workspace (possibly interactive)
+        const workspace = await this.ensureStepZenWorkspace({ directory: flags.dir });
+        // Define a sane onConflict behaviour (possibly interactive)
+        const onConflict = await this.ensureOnConflictBehavior(workspace, schema, flags);
         this.warnAboutIgnoredFlags(schema, flags);
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function
@@ -71,6 +43,7 @@ class Import extends zen_command_1.default {
             const fixedOptions = {
                 name: flags.name,
                 source: workspace.schema,
+                onConflict,
             };
             const editableOptions = {
                 queryName: flags['query-name'],
@@ -132,7 +105,13 @@ class Import extends zen_command_1.default {
                 preAnswered = 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('schema', flags['db-schema']));
             }
             // Let's go!
-            result = await generate_1.default(schema, flags.name, workspace.schema, preAnswered);
+            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(),
@@ -144,6 +123,61 @@ class Import extends zen_command_1.default {
         // Nice message
         this.log(chalk.green(`Successfully imported schema ${chalk.bold(schema)} from StepZen`));
     }
+    async ensureOnConflictBehavior(workspace, schema, flags) {
+        const name = flags.name || schema;
+        const hasConflict = fs.existsSync(path.join(workspace.schema, name));
+        if (!hasConflict) {
+            return 'append';
+        }
+        // No `--name` is given (i.e. naming is automatic)
+        // Using the default name is going to lead to a conflict, and it should
+        // be resolved by inventing a new unique name for the new schema.
+        if (!flags.name) {
+            return 'append';
+        }
+        // `--name` is given and (i.e. naming is namaged by the user)
+        // There is a naming conflict.
+        // The user has explicitly asked to overwrite the existing schema.
+        if (flags.overwrite) {
+            return 'overwrite';
+        }
+        // `--name` is given and (i.e. naming is namaged by the user)
+        // There is a naming conflict.
+        // The user has NOT given an explicit permission to overwrite the existing
+        // schema.
+        // In an interactive mode the CLI asks them for a confirmation.
+        // In a non-interactive mode the CLI throws an error.
+        if (flags['non-interactive']) {
+            throw new errors_1.CLIError(`A schema named ${chalk.bold(flags.name)} already exists in this workspace. Add an ${chalk.bold('--overwrite')} flag to overwrite it.`);
+        }
+        this.log(`A schema named ${chalk.bold(flags.name)} already exists in this workspace. Would you like to overwrite it?`);
+        const answers = await inquirer.prompt([
+            {
+                name: 'overwrite',
+                type: 'confirm',
+                default: false,
+                message: `Overwrite ${flags.name}?`,
+            },
+        ]);
+        if (answers.overwrite) {
+            return 'overwrite';
+        }
+        this.exit();
+    }
+    // notify the user about any ignored flags
+    warnAboutIgnoredFlags(schema, usedFlags) {
+        Import.flagsForSchemas.forEach(({ flags, schemas }) => {
+            if (!schemas.includes(schema)) {
+                Object.keys(flags).forEach(flag => {
+                    if (Object.prototype.hasOwnProperty.call(usedFlags, flag)) {
+                        this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${schemas
+                            .map(schema => chalk.bold(schema))
+                            .join(', ')}. It will be ignored now.`));
+                    }
+                });
+            }
+        });
+    }
     // Correct the value for the 'header-param' flag to work around the oclif's
     // parser issue with multi-value flags: https://github.com/oclif/oclif/issues/261
     parseWorkaround() {
@@ -242,8 +276,12 @@ Import.flagsForSchemas = [
     { flags: Import.postgresqlFlags, schemas: ['postgresql'] },
 ];
 Import.flags = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ description: 'working directory' }), help: command_1.flags.help({ char: 'h' }), silent: command_1.flags.boolean({ hidden: true }), name: command_1.flags.string({
-        description: 'subfolder inside the workspace folder to save the imported' +
-            ' schema files, defaults to the imported schema name',
+        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);
 Import.args = [
     {

package/lib/commands/init.d.ts

@@ -1,8 +1,5 @@
 import { flags } from '@oclif/command';
 import ZenCommand from '../shared/zen-command';
-export declare const validateWorkspaceName: (directory: string, name: string) => boolean;
-export declare const generateWorkspaceName: (directory: string) => string;
-export declare const guessSchemaRoot: (directory: string) => string;
 export default class Init extends ZenCommand {
     static description: string;
     static hidden: boolean;

package/lib/commands/init.js

@@ -1,120 +1,17 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guessSchemaRoot = exports.generateWorkspaceName = exports.validateWorkspaceName = void 0;
 const command_1 = require("@oclif/command");
-const errors_1 = require("@oclif/errors");
-const fs = require("fs");
-const glob = require("glob");
-const inquirer = require("inquirer");
-const os = require("os");
-const path = require("path");
-const utils_1 = require("../shared/utils");
-const moniker_1 = require("../shared/moniker");
 const workspace_1 = require("../shared/workspace");
 const zen_command_1 = require("../shared/zen-command");
-exports.validateWorkspaceName = (directory, name) => {
-    return !fs.existsSync(path.join(directory, name));
-};
-exports.generateWorkspaceName = (directory) => {
-    let name = 'hello-stepzen';
-    while (!exports.validateWorkspaceName(directory, name)) {
-        name = `hello-${moniker_1.getRandomDescriptor()}-stepzen`;
-    }
-    return name;
-};
-exports.guessSchemaRoot = (directory) => {
-    const existing = [
-        ...glob.sync('*/**/config.yaml', {
-            cwd: directory,
-            ignore: '**/node_modules/**',
-        }),
-        ...glob.sync('*/**/index.graphql', {
-            cwd: directory,
-            ignore: '**/node_modules/**',
-        }),
-    ];
-    return existing.length > 0 ? path.dirname(existing[0]) : '';
-};
 class Init extends zen_command_1.default {
     async run() {
         const { args, flags } = this.parse(Init);
-        // Get the correct directory
-        let directory = utils_1.getDirectory(args.directory);
-        // Make sure it is not already a workspace
-        if (workspace_1.getWorkspace(directory)) {
-            throw new errors_1.CLIError(`This directory is already a StepZen workspace: ${directory}.` +
-                ' Please select a different directory.');
-        }
-        const isHomeDir = directory === os.homedir();
-        // Prevent init from running in the home directory if the directory was
-        // explicitly provided as an aargument to `stepzen init`.
-        // StepZen CLI sometimes would enumerate all files in the workspace folder
-        // doing so in the home directory is likely to fail.
-        if (args.directory && isHomeDir) {
-            throw new errors_1.CLIError('Using the home directory as a StepZen workspace is not supported.' +
-                ' Please select a different directory.');
-        }
-        // Make a suggestion for the workspace name (if running in the HOME
-        // directory)
-        const name = isHomeDir
-            ? exports.generateWorkspaceName(directory)
-            : path.basename(directory);
-        // See if we think there's a StepZen schema already
-        const root = isHomeDir ? '' : exports.guessSchemaRoot(directory);
-        // If you've passed an endpoint, validate it, and throw an error
-        // straight away if needed
-        if (flags.endpoint) {
-            const error = utils_1.validateEndpoint(flags.endpoint);
-            if (typeof error === 'string') {
-                throw new errors_1.CLIError(error);
-            }
-        }
-        // Make a suggestion for the endpoint
-        const endpoint = flags.endpoint || `api/${moniker_1.default()}`;
-        // What questions will we ask?
-        const questions = [
-            {
-                default: name,
-                message: 'What would you like to call your workspace?',
-                name: 'name',
-                validate: (name) => exports.validateWorkspaceName(directory, name),
-                when: isHomeDir && !flags.yes,
-            },
-            {
-                default: endpoint,
-                message: 'What would you like your endpoint to be called?',
-                name: 'endpoint',
-                validate: utils_1.validateEndpoint,
-                when: !flags.endpoint && !flags.yes,
-            },
-            {
-                message: `We have detected a schema in this directory. Set the schema root to "${root}"?`,
-                name: 'use-root',
-                type: 'confirm',
-                when: Boolean(root) && !flags.yes,
-            },
-        ];
-        // Get the answers
-        const answers = Object.assign({ name,
-            endpoint, 'use-root': true }, (await inquirer.prompt(questions)));
-        // Append the suggested workspace name to the directory (if running
-        // in the HOME directory)
-        if (isHomeDir) {
-            // eslint-disable-next-line require-atomic-updates
-            directory = path.join(directory, answers.name);
-            fs.mkdirSync(directory);
-        }
-        // Create the workspace
-        const workspace = { endpoint: answers.endpoint };
-        if (root && answers['use-root'])
-            workspace.root = root;
-        // Write the file
-        const file = path.join(directory, 'stepzen.config.json');
-        fs.writeFileSync(file, JSON.stringify(workspace, null, '  '));
-        // Fetch the newly created workspace
-        const created = workspace_1.getWorkspace(directory);
-        // Done!
+        const created = await workspace_1.initWorkspace({
+            directory: args.directory,
+            endpoint: flags.endpoint,
+            yes: flags.yes,
+        });
         this.log(`Created a StepZen workspace in ${created.directory}`);
         return created;
     }

package/lib/commands/start.d.ts

@@ -9,7 +9,6 @@ export default class Start extends ZenCommand {
         'no-console': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'no-dashboard': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'no-init': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'no-server': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'no-validate': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         'no-watcher': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         port: import("@oclif/parser/lib/flags").IOptionFlag<number>;

package/lib/commands/start.js

@@ -7,10 +7,7 @@ const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
 const throttle_debounce_1 = require("throttle-debounce");
 const detect = require("detect-port");
-const utils_1 = require("../shared/utils");
 const start_1 = require("../start");
-const workspace_1 = require("../shared/workspace");
-const init_1 = require("./init");
 const constants_1 = require("../shared/constants");
 const zen_command_1 = require("../shared/zen-command");
 const dashboard = require('@stepzen/dashboard');
@@ -19,28 +16,13 @@ class Start extends zen_command_1.default {
     async run() {
         const { flags } = this.parse(Start);
         const { configuration } = await this.ensureStepZenAccount();
-        // Get the working directory and workspace
-        let workspace;
-        const directory = utils_1.getDirectory(flags.dir);
-        const maybeWorkspace = workspace_1.getWorkspace(directory);
-        if (maybeWorkspace) {
-            workspace = maybeWorkspace;
-        }
-        else {
-            const initArgs = [directory];
-            if (flags.endpoint) {
-                initArgs.push('--endpoint', flags.endpoint);
-            }
-            try {
-                workspace = await init_1.default.run(initArgs);
-            }
-            catch (error) {
-                throw new errors_1.CLIError(`Could not create a StepZen workspace in the ${flags.dir ? directory : 'current'} directory.\n` + error.message);
-            }
-        }
-        // If you have overridden the endpoint, set it
+        // Get or create a StepZen workspace (possibly interactive)
+        const workspace = await this.ensureStepZenWorkspace({
+            directory: flags.dir,
+            endpoint: flags.endpoint,
+        });
+        // If the user has overridden the endpoint, apply the override
         if (flags.endpoint) {
-            // eslint-disable-next-line require-atomic-updates
             workspace.endpoint = flags.endpoint;
         }
         // Check the port is available
@@ -50,25 +32,25 @@ class Start extends zen_command_1.default {
         }
         // This is the file watcher
         if (!flags['no-watcher']) {
+            const redeploy = throttle_debounce_1.debounce(500, (path) => {
+                start_1.changed({ workspace, file: path });
+                start_1.deploy({ workspace, flags });
+            });
             chokidar
-                .watch(workspace.schema, {
-                ignored: '**/*.js',
+                .watch(['**/*.graphql', 'config.yaml'], {
+                cwd: workspace.schema,
+                ignored: 'node_modules/**',
+                ignoreInitial: true,
             })
-                .on('change', throttle_debounce_1.debounce(500, async (path) => {
-                utils_1.clearConsole();
-                await start_1.deploy(path, workspace, flags);
-                await start_1.console(workspace);
-            }));
+                .on('change', redeploy)
+                .on('add', redeploy)
+                .on('unlink', redeploy);
         }
         // Start!
-        utils_1.clearConsole();
         core_1.CliUx.ux.action.start('Starting...');
         // Unless explicitly disabled, auto-init
         if (!flags['no-init']) {
-            await start_1.deploy(null, workspace, flags);
-        }
-        if (!flags['no-console']) {
-            start_1.console(workspace);
+            await start_1.deploy({ workspace, flags });
         }
         // Create the dashboard
         if (!flags['no-dashboard']) {
@@ -92,9 +74,22 @@ class Start extends zen_command_1.default {
         }
         // Done
         core_1.CliUx.ux.action.stop();
+        if (!flags['no-console']) {
+            if (!flags['no-init']) {
+                start_1.success({
+                    workspace,
+                    account: configuration.account,
+                    port: flags.port,
+                });
+                this.log();
+            }
+            if (!flags['no-watcher']) {
+                start_1.watching(workspace);
+            }
+        }
     }
 }
 exports.default = Start;
 Start.description = 'upload and deploy your schema';
-Start.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ description: 'working directory' }), endpoint: command_1.flags.string({ description: 'Override workspace endpoint' }), help: command_1.flags.help({ char: 'h' }), 'no-console': command_1.flags.boolean({ hidden: true }), 'no-dashboard': command_1.flags.boolean({ hidden: true }), 'no-init': command_1.flags.boolean({ hidden: true }), 'no-server': command_1.flags.boolean({ hidden: true }), 'no-validate': command_1.flags.boolean({ hidden: true }), 'no-watcher': command_1.flags.boolean({ hidden: true }), port: command_1.flags.integer({ default: 5001, env: 'PORT' }) });
+Start.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { dir: command_1.flags.string({ description: 'working directory' }), endpoint: command_1.flags.string({ description: 'Override workspace endpoint' }), help: command_1.flags.help({ char: 'h' }), 'no-console': command_1.flags.boolean({ hidden: true }), 'no-dashboard': command_1.flags.boolean({ hidden: true }), 'no-init': command_1.flags.boolean({ hidden: true }), 'no-validate': command_1.flags.boolean({ hidden: true }), 'no-watcher': command_1.flags.boolean({ hidden: true }), port: command_1.flags.integer({ default: 5001, env: 'PORT' }) });
 Start.args = [];

package/lib/generate/curl2sdl.d.ts

@@ -28,6 +28,7 @@ export declare type Curl2SdlOptions = {
     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 = {
@@ -65,7 +66,7 @@ export declare const compileParameterList: (headers: HeaderInput[], pathParams:
  */
 export declare const makeDuplicateParamsMessage: (headers: HeaderInput[], pathParams: PathParam[], url: string) => string | null;
 export declare const askCurlQuestions: (defaultAnswers?: Partial<CurlAnswers>) => Promise<EditableCurl2SdlOptions>;
-export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, }: Curl2SdlOptions) => Promise<{
+export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, onConflict, }: Curl2SdlOptions) => Promise<{
     error: string;
 } | {
     outPath: string;

package/lib/generate/curl2sdl.js

@@ -151,7 +151,7 @@ exports.askCurlQuestions = async (defaultAnswers = {}) => {
         pathParams: parsedPathParamsOrError,
     };
 };
-exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, headers, }) => {
+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`;
@@ -252,6 +252,7 @@ exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePre
         output: null,
         silent: true,
         mergeTypes: false,
+        onConflict,
     });
     return { outPath: result };
 };

package/lib/generate/helpers.d.ts

@@ -11,4 +11,3 @@ 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 const mergeFiles: (name: string, source: string, files: string, answers: any) => Promise<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.mergeFiles = exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchema = exports.getConfiguration = exports.createGeneratorFiles = void 0;
+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,7 +12,6 @@ const lodash_1 = require("lodash");
 const os = require("os");
 const path = require("path");
 const shell = require("shelljs");
-const transpiler = require("@stepzen/transpiler");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
 const { version } = require('../../package.json');
@@ -93,7 +92,7 @@ exports.getSchema = (arg) => {
     const schema = arg.trim();
     // Now supports importing only one schema at a time:
     // https://github.com/steprz/stepzen-cli/issues/628
-    if (schema.includes(',')) {
+    if (schema.includes(',') || schema.includes(' ')) {
         throw new errors_1.CLIError("Importing multiple schemas is no longer supported; please specify only one (e.g. 'stepzen import mysql')");
     }
     // support `postgres` as an alias to `postgresql`
@@ -160,14 +159,3 @@ exports.askTemplateQuestions = async (id, settings, state) => {
     const answers = await inquirer.prompt(questions);
     return Object.assign(Object.assign({}, state), answers);
 };
-exports.mergeFiles = async (name, source, files, answers) => {
-    const output = await transpiler.merge(source, {
-        name: name,
-        source: files,
-    }, {
-        answers,
-        silent: true,
-        output: null,
-    });
-    return output;
-};

package/lib/generate/index.d.ts

@@ -1,4 +1,11 @@
-declare const _default: (schema: string, name: string | undefined, source: string, preAnswered?: {
-    [question: string]: string;
-}) => Promise<string>;
+export declare type GenerateOptions = {
+    schema: string;
+    name?: string;
+    onConflict: 'overwrite' | 'append';
+    source: string;
+    preAnswered?: {
+        [question: string]: string;
+    };
+};
+declare const _default: ({ schema, name, onConflict, source, preAnswered, }: GenerateOptions) => Promise<string>;
 export default _default;

package/lib/generate/index.js

@@ -6,8 +6,9 @@ const core_1 = require("@oclif/core");
 const fs = require("fs-extra");
 const lodash = require("lodash");
 const path = require("path");
+const transpiler = require("@stepzen/transpiler");
 const helpers_1 = require("./helpers");
-exports.default = async (schema, name, source, preAnswered = {}) => {
+exports.default = async ({ schema, name, onConflict, source, preAnswered = {}, }) => {
     var _a, _b;
     // Store the generator
     let generator;
@@ -82,7 +83,15 @@ exports.default = async (schema, name, source, preAnswered = {}) => {
         // if (generator.type === 'template')
         files = path.join(templates, schema);
     }
-    const output = await helpers_1.mergeFiles(name || schema, source, files, answers);
+    const output = await transpiler.merge(source, {
+        name: name || schema,
+        source: files,
+    }, {
+        answers,
+        silent: true,
+        output: null,
+        onConflict,
+    });
     core_1.CliUx.ux.action.stop();
     // Housekeeping
     cleanUp();

package/lib/shared/utils.d.ts

@@ -1,5 +1,19 @@
-export declare const clearConsole: () => void;
 export declare const getDirectory: (d?: string | undefined) => string;
+/**
+ * Replace the path prefix with `~` if it is inside the user's home directory.
+ *
+ * @param {*} absPath an absolute file or directory path
+ * @returns {*} the same path that possibly looks more friendly to users
+ */
+export declare const homeRelative: (absPath: string) => string;
+/**
+ * Replace the path prefix with `~` if it is inside the user's home directory.
+ *
+ * @param {*} absPath an absolute file or directory path
+ * @param {*} workspace an absolute file or the workspace root
+ * @returns {*} the same path that possibly looks more friendly to users
+ */
+export declare const workspaceRelative: (absPath: string, workspace: string) => string;
 export declare const getStepZenExtensions: () => Promise<string>;
 export declare const validateEndpoint: (endpoint: string) => any;
 export declare const maskStepZenKey: (key: string) => string;

package/lib/shared/utils.js

@@ -1,7 +1,7 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.maskStepZenKey = exports.validateEndpoint = exports.getStepZenExtensions = exports.getDirectory = exports.clearConsole = void 0;
+exports.maskStepZenKey = exports.validateEndpoint = exports.getStepZenExtensions = exports.workspaceRelative = exports.homeRelative = exports.getDirectory = void 0;
 const errors_1 = require("@oclif/errors");
 const debug = require("debug");
 const node_fetch_1 = require("node-fetch");
@@ -10,12 +10,6 @@ const os = require("os");
 const path = require("path");
 const prettier = require("prettier");
 const constants_1 = require("./constants");
-exports.clearConsole = () => {
-    process.stdout.write(
-    // Taken from create-react-app
-    // eslint-disable-next-line unicorn/no-hex-escape
-    process.platform === 'win32' ? '\x1B[2J\x1B[0f' : '\x1B[2J\x1B[3J\x1B[H');
-};
 exports.getDirectory = (d = process.cwd()) => {
     let directory = d;
     // If it starts with `~`, expand this
@@ -31,6 +25,33 @@ exports.getDirectory = (d = process.cwd()) => {
     }
     return directory;
 };
+/**
+ * Replace the path prefix with `~` if it is inside the user's home directory.
+ *
+ * @param {*} absPath an absolute file or directory path
+ * @returns {*} the same path that possibly looks more friendly to users
+ */
+exports.homeRelative = (absPath) => {
+    let pretty = absPath;
+    if (absPath.startsWith(os.homedir())) {
+        pretty = '~' + absPath.substring(os.homedir().length);
+    }
+    return pretty;
+};
+/**
+ * Replace the path prefix with `~` if it is inside the user's home directory.
+ *
+ * @param {*} absPath an absolute file or directory path
+ * @param {*} workspace an absolute file or the workspace root
+ * @returns {*} the same path that possibly looks more friendly to users
+ */
+exports.workspaceRelative = (absPath, workspace) => {
+    let pretty = absPath;
+    if (absPath.startsWith(workspace)) {
+        pretty = '.' + absPath.substring(workspace.length);
+    }
+    return pretty;
+};
 exports.getStepZenExtensions = async () => {
     const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
     const url = `https://www.${domain}/directives.graphql`;

package/lib/shared/workspace.d.ts

@@ -1,2 +1,10 @@
 import { Workspace } from './types';
+export declare const validateWorkspaceName: (directory: string, name: string) => boolean;
+export declare const generateWorkspaceName: (directory: string) => string;
+export declare const guessSchemaRoot: (directory: string) => string;
 export declare const getWorkspace: (directory: string) => Workspace | null;
+export declare const initWorkspace: (args: {
+    directory?: string;
+    endpoint?: string;
+    yes?: boolean;
+}) => Promise<Workspace>;

package/lib/shared/workspace.js

@@ -1,12 +1,38 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkspace = void 0;
+exports.initWorkspace = exports.getWorkspace = exports.guessSchemaRoot = exports.generateWorkspaceName = exports.validateWorkspaceName = void 0;
 const errors_1 = require("@oclif/errors");
 const fs = require("fs");
+const glob = require("glob");
+const inquirer = require("inquirer");
 const os = require("os");
 const path = require("path");
+const moniker_1 = require("../shared/moniker");
 const utils_1 = require("./utils");
+exports.validateWorkspaceName = (directory, name) => {
+    return !fs.existsSync(path.join(directory, name));
+};
+exports.generateWorkspaceName = (directory) => {
+    let name = 'hello-stepzen';
+    while (!exports.validateWorkspaceName(directory, name)) {
+        name = `hello-${moniker_1.getRandomDescriptor()}-stepzen`;
+    }
+    return name;
+};
+exports.guessSchemaRoot = (directory) => {
+    const existing = [
+        ...glob.sync('*/**/config.yaml', {
+            cwd: directory,
+            ignore: '**/node_modules/**',
+        }),
+        ...glob.sync('*/**/index.graphql', {
+            cwd: directory,
+            ignore: '**/node_modules/**',
+        }),
+    ];
+    return existing.length > 0 ? path.dirname(existing[0]) : '';
+};
 exports.getWorkspace = (directory) => {
     let workspaceRoot;
     const parts = path
@@ -54,3 +80,81 @@ exports.getWorkspace = (directory) => {
         schema: schema,
     };
 };
+exports.initWorkspace = async (args) => {
+    // Get the correct directory
+    let directory = utils_1.getDirectory(args.directory);
+    // Make sure it is not already a workspace
+    if (exports.getWorkspace(directory)) {
+        throw new errors_1.CLIError(`This directory is already a StepZen workspace: ${directory}.` +
+            ' Please select a different directory.');
+    }
+    const isHomeDir = directory === os.homedir();
+    // Prevent init from running in the home directory if the directory was
+    // explicitly provided as an aargument to `stepzen init`.
+    // StepZen CLI sometimes would enumerate all files in the workspace folder
+    // doing so in the home directory is likely to fail.
+    if (args.directory && isHomeDir) {
+        throw new errors_1.CLIError('Using the home directory as a StepZen workspace is not supported.' +
+            ' Please select a different directory.');
+    }
+    // Make a suggestion for the workspace name (if running in the HOME
+    // directory)
+    const name = isHomeDir
+        ? exports.generateWorkspaceName(directory)
+        : path.basename(directory);
+    // See if we think there's a StepZen schema already
+    const root = isHomeDir ? '' : exports.guessSchemaRoot(directory);
+    // If you've passed an endpoint, validate it, and throw an error
+    // straight away if needed
+    if (args.endpoint) {
+        const error = utils_1.validateEndpoint(args.endpoint);
+        if (typeof error === 'string') {
+            throw new errors_1.CLIError(error);
+        }
+    }
+    // Make a suggestion for the endpoint
+    const endpoint = args.endpoint || `api/${moniker_1.default()}`;
+    // What questions will we ask?
+    const questions = [
+        {
+            default: name,
+            message: 'What would you like to call your workspace?',
+            name: 'name',
+            validate: (name) => exports.validateWorkspaceName(directory, name),
+            when: isHomeDir && !args.yes,
+        },
+        {
+            default: endpoint,
+            message: 'What would you like your endpoint to be called?',
+            name: 'endpoint',
+            validate: utils_1.validateEndpoint,
+            when: !args.endpoint && !args.yes,
+        },
+        {
+            message: `We have detected a schema in this directory. Set the schema root to "${root}"?`,
+            name: 'use-root',
+            type: 'confirm',
+            when: Boolean(root) && !args.yes,
+        },
+    ];
+    // Get the answers
+    const answers = Object.assign({ name,
+        endpoint, 'use-root': true }, (await inquirer.prompt(questions)));
+    // Append the suggested workspace name to the directory (if running
+    // in the HOME directory)
+    if (isHomeDir) {
+        // eslint-disable-next-line require-atomic-updates
+        directory = path.join(directory, answers.name);
+        fs.mkdirSync(directory);
+    }
+    // Create the workspace
+    const workspace = { endpoint: answers.endpoint };
+    if (root && answers['use-root'])
+        workspace.root = root;
+    // Write the file
+    const file = path.join(directory, 'stepzen.config.json');
+    fs.writeFileSync(file, JSON.stringify(workspace, null, '  '));
+    // Fetch the newly created workspace
+    const created = exports.getWorkspace(directory);
+    return created;
+};

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

@@ -1,5 +1,5 @@
 import { Command } from '@oclif/command';
-import { MachineConfiguration, StepZenCredentials } from './types';
+import { MachineConfiguration, StepZenCredentials, Workspace } from './types';
 export declare abstract class ZenCommand extends Command {
     static flags: {
         'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
@@ -7,6 +7,10 @@ export declare abstract class ZenCommand extends Command {
     ensureStepZenAccount(): Promise<{
         configuration: import("./types").LoggedInMachineConfiguration;
     }>;
+    ensureStepZenWorkspace(options?: {
+        directory?: string;
+        endpoint?: string;
+    }): Promise<Workspace>;
     promptUserToLogIn(uuid: string): Promise<{
         configuration: MachineConfiguration & StepZenCredentials;
     }>;

package/lib/shared/zen-command.js

@@ -3,10 +3,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZenCommand = void 0;
 const command_1 = require("@oclif/command");
+const errors_1 = require("@oclif/errors");
 const inquirer = require("inquirer");
 const chalk = require("chalk");
+const process = require("process");
 const configuration_1 = require("./configuration");
 const stepzen_sdk_1 = require("./stepzen-sdk");
+const utils_1 = require("./utils");
+const workspace_1 = require("./workspace");
 class ZenCommand extends command_1.Command {
     async ensureStepZenAccount() {
         const configuration = await configuration_1.readConfiguration();
@@ -17,6 +21,29 @@ class ZenCommand extends command_1.Command {
         }
         return this.promptUserToLogIn(configuration.uuid);
     }
+    async ensureStepZenWorkspace(options = {}) {
+        let workspace;
+        const directory = utils_1.getDirectory(options.directory);
+        const maybeWorkspace = workspace_1.getWorkspace(directory);
+        if (maybeWorkspace) {
+            workspace = maybeWorkspace;
+        }
+        else {
+            try {
+                workspace = await workspace_1.initWorkspace({ directory, endpoint: options.endpoint });
+            }
+            catch (error) {
+                throw new errors_1.CLIError(`Could not create a StepZen workspace in the ${options.directory ? directory : 'current'} directory.\n` + error.message);
+            }
+        }
+        // Emphasize that the workspace is not the _current_ directory.
+        if (workspace.directory !== process.cwd()) {
+            this.log();
+            this.log(` ⤴️  Using the StepZen workspace in ${chalk.blue(utils_1.homeRelative(workspace.directory))}`);
+            this.log();
+        }
+        return workspace;
+    }
     async promptUserToLogIn(uuid) {
         this.log(chalk.bold(chalk.cyan('Welcome to the StepZen CLI!')));
         this.log('');

package/lib/start/console.d.ts

@@ -1,2 +1,11 @@
-declare const _default: (workspace: any) => Promise<void>;
-export default _default;
+import { Workspace } from '../shared/types';
+export declare const watching: (workspace: Workspace) => void;
+export declare const changed: ({ file, workspace, }: {
+    file: string;
+    workspace: Workspace;
+}) => void;
+export declare const success: ({ workspace, account, port, }: {
+    workspace: Workspace;
+    account: string;
+    port: number;
+}) => void;

package/lib/start/console.js

@@ -1,16 +1,33 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.success = exports.changed = exports.watching = void 0;
 const chalk = require("chalk");
-const fs = require("fs");
-const os = require("os");
-const path = require("path");
-exports.default = async (workspace) => {
-    const cwd = workspace.schema.replace(os.homedir(), '~');
-    const config = path.join(cwd, 'config.yaml');
+const utils_1 = require("../shared/utils");
+const constants_1 = require("../shared/constants");
+exports.watching = (workspace) => {
+    console.log(`Watching ${chalk.blue(utils_1.homeRelative(workspace.schema))} for changes...`);
+};
+exports.changed = ({ file, workspace, }) => {
+    console.log(`File changed: ${chalk.blue(utils_1.workspaceRelative(file, workspace.directory))}`);
+};
+exports.success = ({ workspace, account, port, }) => {
+    const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
+    const url = `https://${account}.${domain}/${workspace.endpoint}/__graphql`;
     console.log();
-    if (fs.existsSync(config)) {
-        console.log(`Watching ${chalk.blue(config)} for configuration changes...`);
+    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}`));
+    }
+    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)" \\`);
+        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(`Watching ${chalk.blue(cwd)} for GraphQL changes...`);
 };

package/lib/start/deploy.d.ts

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

package/lib/start/deploy.js

@@ -8,18 +8,12 @@ const fs = require("fs-extra");
 const path = require("path");
 const prettyMilliseconds = require("pretty-ms");
 const deploy_1 = require("../commands/deploy");
-const configuration_1 = require("../shared/configuration");
-const constants_1 = require("../shared/constants");
 const upload_1 = require("../commands/upload");
 const validate_1 = require("../commands/validate");
 const dotenv = require('dotenv');
-exports.default = async (file, workspace, flags) => {
+exports.default = async ({ workspace, flags, }) => {
     var e_1, _a;
     dotenv.config({ path: path.join(workspace.directory, '.env') });
-    if (file) {
-        console.log(`File changed: ${chalk.blue(file)}`);
-    }
-    const configuration = (await configuration_1.readConfiguration());
     if (!flags['no-validate']) {
         try {
             await validate_1.default.run([workspace.schema]);
@@ -101,22 +95,4 @@ exports.default = async (file, workspace, flags) => {
     const deployEnd = new Date().getTime();
     const deployTime = deployEnd - deployStart;
     core_1.CliUx.ux.action.stop(`${chalk.grey('done in')} ${prettyMilliseconds(deployTime)} 🚀`);
-    const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
-    const endpoint = `https://${configuration.account}.${domain}/${workspace.endpoint}/__graphql`;
-    console.log();
-    console.log(chalk.grey(`Your API url is`, chalk.green(` ${endpoint}`)));
-    console.log();
-    if (process.platform === 'win32') {
-        console.log(chalk.grey(`You can explore your hosted API with GraphiQL at `), chalk.green(` http://localhost:${flags.port}/${workspace.endpoint}`));
-    }
-    else {
-        console.log(chalk.grey(`You can test your hosted API with cURL:`));
-        console.log();
-        console.log(`curl ${endpoint} \\`);
-        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:${flags.port}/${workspace.endpoint}`));
-    }
 };

package/lib/start/index.d.ts

@@ -1,3 +1,2 @@
-import console from './console';
-import deploy from './deploy';
-export { console, deploy };
+export { default as deploy } from './deploy';
+export { changed, success, watching } from './console';

package/lib/start/index.js

@@ -1,8 +1,9 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deploy = exports.console = void 0;
-const console_1 = require("./console");
-exports.console = console_1.default;
-const deploy_1 = require("./deploy");
-exports.deploy = deploy_1.default;
+var deploy_1 = require("./deploy");
+Object.defineProperty(exports, "deploy", { enumerable: true, get: function () { return deploy_1.default; } });
+var console_1 = require("./console");
+Object.defineProperty(exports, "changed", { enumerable: true, get: function () { return console_1.changed; } });
+Object.defineProperty(exports, "success", { enumerable: true, get: function () { return console_1.success; } });
+Object.defineProperty(exports, "watching", { enumerable: true, get: function () { return console_1.watching; } });

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.16.0-beta.5","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"import a schema for an external data source or a API endpoint to your GraphQL API","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] prefix to add every type in the generated schema."},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"},"header-param":{"name":"header-param","type":"option","description":"[curl] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'"},"db-host":{"name":"db-host","type":"option","description":"[mysql, postgresql] database host"},"db-user":{"name":"db-user","type":"option","description":"[mysql, postgresql] database user name"},"db-password":{"name":"db-password","type":"option","description":"[mysql, postgresql] database password"},"db-database":{"name":"db-database","type":"option","description":"[mysql, postgresql] name of database to import"},"db-schema":{"name":"db-schema","type":"option","description":"[postgresql] database schema"}},"args":[{"name":"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-server":{"name":"no-server","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"transpile a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"upload to StepZen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"validate a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"display your credentials with StepZen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}
+{"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":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stepzen",
   "description": "The StepZen CLI",
-  "version": "0.16.0-beta.5",
+  "version": "0.17.0-beta.1",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -32,8 +32,8 @@
     "@oclif/errors": "1.3.5",
     "@oclif/plugin-help": "^5.1.12",
     "@stepzen/dashboard": "0.2.0",
-    "@stepzen/sdk": "0.11.2",
-    "@stepzen/transpiler": "0.0.39",
+    "@stepzen/sdk": "0.11.3",
+    "@stepzen/transpiler": "0.2.0",
     "chalk": "^4.1.1",
     "chokidar": "^3.5.2",
     "compare-versions": "^3.6.0",