stepzen 0.13.0-beta.3 → 0.14.0

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.13.0-beta.3 darwin-x64 node-v14.19.1
+stepzen/0.14.0 darwin-x64 node-v14.19.1
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND

package/lib/commands/import.js

@@ -6,7 +6,7 @@ const fs = require("fs-extra");
 const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
 const transpiler_1 = require("@stepzen/transpiler");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const generate_1 = require("../generate");
 const utils_1 = require("../shared/utils");
 const helpers_1 = require("../generate/helpers");
@@ -88,9 +88,9 @@ class Import extends zen_command_1.default {
                 }
                 curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, curlArgs: argsOrError });
             }
-            cli_ux_1.cli.action.start('Starting');
+            core_1.CliUx.ux.action.start('Starting');
             const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
-            cli_ux_1.cli.action.stop();
+            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.');

package/lib/commands/login.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // Stepzen login checks that credentials presented are good and
 // subsequently changes the identity of the logged in account.
 const command_1 = require("@oclif/command");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const configuration_1 = require("../shared/configuration");
 const stepzen_sdk_1 = require("../shared/stepzen-sdk");
 const zen_command_1 = require("../shared/zen-command");
@@ -16,7 +16,7 @@ class Login extends zen_command_1.default {
         let adminkey;
         // If the --config flag is provided, try and log in using the details in the file
         if (flags.config) {
-            const config = configuration_1.importConfiguration(flags.config);
+            const config = await configuration_1.importConfiguration(flags.config);
             account = config.account;
             adminkey = config.adminkey;
         }
@@ -26,21 +26,22 @@ class Login extends zen_command_1.default {
                 account = flags.account;
             }
             else {
-                account = await cli_ux_1.default.prompt('What is your account name?');
+                account = await core_1.CliUx.ux.prompt('What is your account name?');
             }
             // Check if the --adminkey flag is provided, and if not prompt the user for an admin key.
-            if (flags.adminkey) {
-                adminkey = flags.adminkey;
-            }
-            else {
-                adminkey = await cli_ux_1.default.prompt('What is your admin key?', {
+            if (flags.adminkey === undefined) {
+                adminkey = await core_1.CliUx.ux.prompt('What is your admin key?', {
+                    required: false,
                     type: 'hide',
                 });
             }
+            else {
+                adminkey = flags.adminkey;
+            }
         }
         const configuration = await stepzen_sdk_1.default.login(adminkey, account);
         // Change the default account.
-        configuration_1.writeConfigurationToLoginFile(configuration);
+        configuration_1.writeCredentialsToConfigFile(configuration);
         this.log('You have successfully logged in.');
     }
 }

package/lib/commands/logout.js

@@ -9,7 +9,7 @@ const zen_command_1 = require("../shared/zen-command");
 class Logout extends zen_command_1.default {
     async run() {
         // Remove the configuration from the login file.
-        configuration_1.removeConfigurationFromLoginFile();
+        configuration_1.removeCredentialsFromConfigFile();
         this.log('You have been logged out.');
     }
 }

package/lib/commands/start.js

@@ -2,7 +2,7 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 const chokidar = require("chokidar");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const command_1 = require("@oclif/command");
 const errors_1 = require("@oclif/errors");
 const throttle_debounce_1 = require("throttle-debounce");
@@ -56,7 +56,6 @@ class Start extends zen_command_1.default {
                 ignored: '**/*.js',
             })
                 .on('change', throttle_debounce_1.debounce(500, async (path) => {
-                await utils_1.checkAuth();
                 utils_1.clearConsole();
                 await start_1.deploy(path, workspace, flags);
                 await start_1.console(workspace);
@@ -64,7 +63,7 @@ class Start extends zen_command_1.default {
         }
         // Start!
         utils_1.clearConsole();
-        cli_ux_1.default.action.start('Starting...');
+        core_1.CliUx.ux.action.start('Starting...');
         // Unless explicitly disabled, auto-init
         if (!flags['no-init']) {
             await start_1.deploy(null, workspace, flags);
@@ -94,7 +93,7 @@ class Start extends zen_command_1.default {
             await ui.start();
         }
         // Done
-        cli_ux_1.default.action.stop();
+        core_1.CliUx.ux.action.stop();
     }
 }
 exports.default = Start;

package/lib/commands/whoami.js

@@ -9,8 +9,8 @@ const zen_command_1 = require("../shared/zen-command");
 class WhoAmI extends zen_command_1.default {
     async run() {
         const { flags } = this.parse(WhoAmI);
-        const configuration = configuration_1.readConfiguration();
-        if (!configuration) {
+        const configuration = await configuration_1.readConfiguration();
+        if (!('account' in configuration)) {
             this.log('You are not logged in.');
             this.exit();
         }

package/lib/generate/helpers.js

@@ -18,6 +18,7 @@ const { version } = require('../../package.json');
 exports.createGeneratorFiles = async (id, details) => {
     const url = `${constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL}/create`;
     debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
+    const engineErrorMessageWrap = (msg) => `An error has occurred when creating the schema: ${msg}. Please check your parameters and try again.`;
     try {
         const response = await node_fetch_1.default(url, {
             body: JSON.stringify({
@@ -30,18 +31,33 @@ exports.createGeneratorFiles = async (id, details) => {
             },
             method: 'POST',
         });
-        const files = await response.json();
-        const tmp = path.join(os.tmpdir(), `stepzen-generated-schema-${Date.now()}`);
-        fs.ensureDirSync(tmp);
-        for (const file of files) {
-            const dir = path.join(tmp, file.name);
-            fs.writeFileSync(dir, file.content);
+        const responseJson = await response.json();
+        if (responseJson.errors) {
+            // assuming a response of type { status: Int, errors: String }
+            throw new errors_1.CLIError(engineErrorMessageWrap(responseJson.errors));
+        }
+        else {
+            // where errors is an error message if name === null.
+            const files = responseJson;
+            const tmp = path.join(os.tmpdir(), `stepzen-generated-schema-${Date.now()}`);
+            fs.ensureDirSync(tmp);
+            for (const file of files) {
+                if (file.errors) {
+                    throw new errors_1.CLIError(engineErrorMessageWrap(file.errors));
+                }
+                else {
+                    const dir = path.join(tmp, file.name);
+                    fs.writeFileSync(dir, file.content);
+                }
+            }
+            return tmp;
         }
-        return tmp;
     }
     catch (error) {
         debug('stepzen:generate')(error);
-        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+        throw error instanceof errors_1.CLIError
+            ? error
+            : new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
     }
 };
 exports.getConfiguration = async (id, details = {}) => {

package/lib/generate/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const errors_1 = require("@oclif/errors");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const fs = require("fs-extra");
 const lodash = require("lodash");
 const os = require("os");
@@ -21,7 +21,7 @@ exports.default = async (schemas, name, source) => {
     // Store the answers
     let answers = {};
     // Start downloading
-    cli_ux_1.default.action.start('Downloading from StepZen...');
+    core_1.CliUx.ux.action.start('Downloading from StepZen...');
     try {
         // Get all generators from...Generators
         for (var _f = tslib_1.__asyncValues(Object.keys(generators)), _g; _g = await _f.next(), !_g.done;) {
@@ -68,7 +68,7 @@ exports.default = async (schemas, name, source) => {
         finally { if (e_2) throw e_2.error; }
     }
     // Finished downloading
-    cli_ux_1.default.action.stop();
+    core_1.CliUx.ux.action.stop();
     console.log();
     // If you've tried to import non-existent templates, complain and exit
     const notFound = Object.entries(generators)
@@ -109,7 +109,7 @@ exports.default = async (schemas, name, source) => {
     fs.ensureDirSync(output);
     fs.copySync(source, output);
     console.log();
-    cli_ux_1.default.action.start('Generating schemas...');
+    core_1.CliUx.ux.action.start('Generating schemas...');
     try {
         for (var _m = tslib_1.__asyncValues(Object.entries(generators)), _o; _o = await _m.next(), !_o.done;) {
             const [id, generator] = _o.value;
@@ -149,7 +149,7 @@ exports.default = async (schemas, name, source) => {
         finally { if (e_4) throw e_4.error; }
     }
     // Housekeeping
-    cli_ux_1.default.action.stop();
+    core_1.CliUx.ux.action.stop();
     fs.removeSync(templates);
     return output;
 };

package/lib/hooks/prerun/ensure-config-file.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const debug = require("debug");
+const configuration_1 = require("../../shared/configuration");
+const constants_1 = require("../../shared/constants");
+const hook = async function () {
+    // If the configuration is set through an env variable,
+    // skip all the config file checks.
+    if (process.env.STEPZEN_CONFIG_CONTENT) {
+        return;
+    }
+    const configFilePath = path.join(constants_1.STEPZEN_CONFIG_DIRECTORY, constants_1.STEPZEN_CONFIG_FILE);
+    let rawConfiguration;
+    try {
+        rawConfiguration = await configuration_1.importConfiguration(configFilePath);
+    }
+    catch (_a) {
+        rawConfiguration = null;
+    }
+    const { configuration, modified } = await configuration_1.ensureValidConfiguration(rawConfiguration);
+    if (modified) {
+        configuration_1.writeConfiguration(configuration);
+        debug('stepzen:configuration')(`Automatically updated the ${configFilePath} config file.`);
+    }
+};
+exports.default = hook;

package/lib/shared/actions.js

@@ -6,7 +6,7 @@ const configuration_1 = require("./configuration");
 const constants_1 = require("./constants");
 const stepzen_sdk_1 = require("./stepzen-sdk");
 exports.deploy = async (destination, configurationsets, schema) => {
-    const config = configuration_1.readConfiguration();
+    const config = (await configuration_1.readConfiguration());
     const server = constants_1.STEPZEN_SERVER_URL.replace('{account}', config.account);
     const client = await stepzen_sdk_1.default.client({
         account: config.account,
@@ -21,7 +21,7 @@ exports.deploy = async (destination, configurationsets, schema) => {
     return client.deploy(destination, payload);
 };
 exports.list = async (type) => {
-    const config = configuration_1.readConfiguration();
+    const config = (await configuration_1.readConfiguration());
     const server = constants_1.STEPZEN_SERVER_URL.replace('{account}', config.account);
     const client = await stepzen_sdk_1.default.client({
         account: config.account,
@@ -32,7 +32,7 @@ exports.list = async (type) => {
     return client.list[type]();
 };
 exports.upload = async (type, destination, source) => {
-    const config = configuration_1.readConfiguration();
+    const config = (await configuration_1.readConfiguration());
     const server = constants_1.STEPZEN_SERVER_URL.replace('{account}', config.account);
     const client = await stepzen_sdk_1.default.client({
         account: config.account,

package/lib/shared/configuration.d.ts

@@ -1,5 +1,24 @@
-import { MachineConfiguration } from './types';
-export declare const readConfiguration: () => MachineConfiguration | null;
-export declare const importConfiguration: (filepath: string) => MachineConfiguration;
-export declare const removeConfigurationFromLoginFile: () => boolean;
-export declare const writeConfigurationToLoginFile: (configuration: MachineConfiguration) => MachineConfiguration;
+import { LoggedInMachineConfiguration, LoggedOutMachineConfiguration, MachineConfiguration, StepZenCredentials } from './types';
+/**
+ * Ensure that the `stepzen-config.yaml` file exists and has valid content.
+ * Cover 3 cases:
+ *  - file does not exist (this is the first time the CLI is run)
+ *      -> initialize the config file and add a UUID into it
+ *  - file exists but does not include a UUID (it was created by an earlier
+ *    version of the CLI)
+ *       -> add a UUID into the existing config file
+ *  - file exists, has stepzen credentials, but does not include an API key
+ *    (it was created by an earlier version of the CLI)
+ *       -> either fetch the API key from StepZen or remove logged in credentials
+ *
+ * @param {*} maybeConfiguration raw contents of the configuration file
+ */
+export declare const ensureValidConfiguration: (maybeConfiguration: Record<string, any> | null) => Promise<{
+    configuration: MachineConfiguration;
+    modified: boolean;
+}>;
+export declare const importConfiguration: (filepath: string) => Promise<Record<string, any>>;
+export declare const readConfiguration: () => Promise<MachineConfiguration>;
+export declare const writeConfiguration: (configuration: MachineConfiguration) => Promise<MachineConfiguration>;
+export declare const writeCredentialsToConfigFile: (credentials: StepZenCredentials) => Promise<LoggedInMachineConfiguration>;
+export declare const removeCredentialsFromConfigFile: () => Promise<LoggedOutMachineConfiguration>;

package/lib/shared/configuration.js

@@ -1,61 +1,106 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeConfigurationToLoginFile = exports.removeConfigurationFromLoginFile = exports.importConfiguration = exports.readConfiguration = void 0;
+exports.removeCredentialsFromConfigFile = exports.writeCredentialsToConfigFile = exports.writeConfiguration = exports.readConfiguration = exports.importConfiguration = exports.ensureValidConfiguration = void 0;
 // This file contains methods for managing configuration
 const errors_1 = require("@oclif/errors");
 const debug = require("debug");
 const fs = require("fs");
+const crypto = require("crypto");
 const path = require("path");
 const yaml = require("yaml");
+const stepzen_sdk_1 = require("./stepzen-sdk");
 const constants_1 = require("./constants");
-exports.readConfiguration = () => {
-    try {
-        let configuration;
-        // If the configuration comes from an env var, use it
-        if (process.env.STEPZEN_CONFIG_CONTENT) {
-            configuration = process.env.STEPZEN_CONFIG_CONTENT;
+const configFilePath = path.join(constants_1.STEPZEN_CONFIG_DIRECTORY, constants_1.STEPZEN_CONFIG_FILE);
+/**
+ * Ensure that the `stepzen-config.yaml` file exists and has valid content.
+ * Cover 3 cases:
+ *  - file does not exist (this is the first time the CLI is run)
+ *      -> initialize the config file and add a UUID into it
+ *  - file exists but does not include a UUID (it was created by an earlier
+ *    version of the CLI)
+ *       -> add a UUID into the existing config file
+ *  - file exists, has stepzen credentials, but does not include an API key
+ *    (it was created by an earlier version of the CLI)
+ *       -> either fetch the API key from StepZen or remove logged in credentials
+ *
+ * @param {*} maybeConfiguration raw contents of the configuration file
+ */
+exports.ensureValidConfiguration = async (maybeConfiguration) => {
+    let modified = false;
+    const configuration = Object.assign({}, maybeConfiguration);
+    // ensure configuration exists
+    if (!maybeConfiguration) {
+        modified = true;
+    }
+    // ensure configuration has a UUID
+    if (!configuration.uuid) {
+        configuration.uuid = crypto.randomUUID();
+        debug('stepzen:configuration')(`Generated a new machine UUID: ${configuration.uuid}`);
+        modified = true;
+    }
+    // ensure a logged-in configuration includes an API key
+    if (configuration.account && !configuration.apikey) {
+        try {
+            debug('stepzen:configuration')(`Fetching an API key for account ${configuration.account}`);
+            const credentials = await stepzen_sdk_1.default.login(configuration.adminkey, configuration.account);
+            configuration.apikey = credentials.apikey;
         }
-        else {
-            // Read the stored configuration, if it exists.
-            const file = path.join(constants_1.STEPZEN_CONFIG_DIRECTORY, constants_1.STEPZEN_CONFIG_FILE);
-            configuration = fs.readFileSync(file, 'utf8');
+        catch (error) {
+            if (error instanceof Error &&
+                error.message.includes('Your credentials are invalid')) {
+                debug('stepzen:configuration')(`Removing the stored account credentials because logging in failed. ${error}`);
+                delete configuration.account;
+                delete configuration.adminkey;
+                delete configuration.apikey;
+            }
+            else {
+                // ignore other errors
+            }
         }
-        // Parse the yaml into an Object.
-        const parsed = yaml.parse(configuration);
-        debug('stepzen:configuration')(parsed);
-        return parsed;
-    }
-    catch (_a) {
-        return null;
+        modified = true;
     }
+    return {
+        configuration: configuration,
+        modified,
+    };
 };
-exports.importConfiguration = (filepath) => {
+exports.importConfiguration = async (filepath) => {
     if (!fs.existsSync(filepath)) {
         throw new errors_1.CLIError('Configuration file does not exist');
     }
-    const configuration = fs.readFileSync(filepath, 'utf8');
+    const content = fs.readFileSync(filepath, 'utf8');
     try {
-        const parsed = yaml.parse(configuration);
-        debug('stepzen:configuration')(parsed);
-        return parsed;
+        return yaml.parse(content);
     }
     catch (_a) {
         throw new errors_1.CLIError('Configuration file is not valid yaml');
     }
 };
-exports.removeConfigurationFromLoginFile = () => {
-    try {
-        // Remove the configuration file
-        const file = path.join(constants_1.STEPZEN_CONFIG_DIRECTORY, constants_1.STEPZEN_CONFIG_FILE);
-        fs.unlinkSync(file);
-        return true;
+exports.readConfiguration = async () => {
+    let maybeConfiguration = null;
+    // If the configuration comes from an env var, use it
+    if (process.env.STEPZEN_CONFIG_CONTENT) {
+        try {
+            maybeConfiguration = yaml.parse(process.env.STEPZEN_CONFIG_CONTENT);
+        }
+        catch (error) {
+            debug('stepzen:configuration')(`Could not parse the STEPZEN_CONFIG_CONTENT env var as YAML: ${error}`);
+        }
     }
-    catch (_a) {
-        return false;
+    else {
+        try {
+            maybeConfiguration = await exports.importConfiguration(configFilePath);
+        }
+        catch (error) {
+            debug('stepzen:configuration')(`Could not read the config file at ${configFilePath}: ${error}`);
+        }
     }
+    const { configuration } = await exports.ensureValidConfiguration(maybeConfiguration);
+    debug('stepzen:configuration')(configuration);
+    return configuration;
 };
-exports.writeConfigurationToLoginFile = (configuration) => {
+exports.writeConfiguration = async (configuration) => {
     // Generate YAML from the configuration
     const content = yaml.stringify(configuration);
     // Check that the configuration directory exists. If not, create it.
@@ -63,7 +108,20 @@ exports.writeConfigurationToLoginFile = (configuration) => {
         fs.mkdirSync(constants_1.STEPZEN_CONFIG_DIRECTORY);
     }
     // Write the configuration file. Overwrites if it already exists.
-    const file = path.join(constants_1.STEPZEN_CONFIG_DIRECTORY, constants_1.STEPZEN_CONFIG_FILE);
-    fs.writeFileSync(file, content, { mode: '600' });
+    fs.writeFileSync(configFilePath, content, { mode: '600' });
+    return exports.readConfiguration();
+};
+exports.writeCredentialsToConfigFile = async (credentials) => {
+    const oldConfig = await exports.readConfiguration();
+    const newConfig = Object.assign(Object.assign({}, oldConfig), credentials);
+    const writtenConfig = await exports.writeConfiguration(newConfig);
+    return Object.assign(Object.assign({}, newConfig), writtenConfig);
+};
+exports.removeCredentialsFromConfigFile = async () => {
+    const configuration = await exports.readConfiguration();
+    delete configuration.account;
+    delete configuration.apikey;
+    delete configuration.adminkey;
+    await exports.writeConfiguration(configuration);
     return configuration;
 };

package/lib/shared/constants.d.ts

@@ -10,6 +10,6 @@ export declare const STEPZEN_API_TEMPLATES_REPOSITORY = "https://github.com/step
 export declare const ADMIN_DEPLOY_URL = "/cli/admin/deploy";
 export declare const ADMIN_LIST_URL = "/cli/admin/list";
 export declare const ADMIN_UPLOAD_URL = "/cli/admin/upload";
-export declare const ADMIN_VERIFY_URL = "/cli/admin/verify";
+export declare const ADMIN_ACCOUNT_URL = "/cli/admin/account";
 export declare const STEPZEN_JSON2SDL_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_VERIFY_URL = exports.ADMIN_UPLOAD_URL = exports.ADMIN_LIST_URL = exports.ADMIN_DEPLOY_URL = exports.STEPZEN_API_TEMPLATES_REPOSITORY = exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = exports.STEPZEN_GENERATOR_ENGINES_ENDPOINT = exports.STEPZEN_GENERATOR_ENGINES_SCHEMA = exports.STEPZEN_SERVER_URL = exports.STEPZEN_DOMAIN = exports.STEPZEN_CONFIG_FILE = exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = exports.STEPZEN_CONFIG_DIRECTORY = void 0;
+exports.STEPZEN_DISCORD_URL = exports.STEPZEN_JSON2SDL_SERVER_URL = exports.ADMIN_ACCOUNT_URL = exports.ADMIN_UPLOAD_URL = exports.ADMIN_LIST_URL = exports.ADMIN_DEPLOY_URL = exports.STEPZEN_API_TEMPLATES_REPOSITORY = exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = exports.STEPZEN_GENERATOR_ENGINES_ENDPOINT = exports.STEPZEN_GENERATOR_ENGINES_SCHEMA = exports.STEPZEN_SERVER_URL = exports.STEPZEN_DOMAIN = exports.STEPZEN_CONFIG_FILE = exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = exports.STEPZEN_CONFIG_DIRECTORY = void 0;
 // This file contains constants and all magic strings
 const dotenv = require("dotenv");
 const os = require("os");
@@ -32,7 +32,7 @@ exports.STEPZEN_API_TEMPLATES_REPOSITORY = 'https://github.com/steprz/stepzen-sc
 exports.ADMIN_DEPLOY_URL = '/cli/admin/deploy';
 exports.ADMIN_LIST_URL = '/cli/admin/list';
 exports.ADMIN_UPLOAD_URL = '/cli/admin/upload';
-exports.ADMIN_VERIFY_URL = '/cli/admin/verify';
+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';
 exports.STEPZEN_DISCORD_URL = 'https://discord.gg/9k2VdPn2FR';

package/lib/shared/curl-parser.js

@@ -87,6 +87,17 @@ const parseMethodFlag = (value, partialCurlArgs) => {
         result: Object.assign(Object.assign({}, partialCurlArgs), { method }),
     };
 };
+const parseURLFlag = (value, partialCurlArgs) => {
+    if (partialCurlArgs.url) {
+        return {
+            error: `Multiple URLs are not currently supported by StepZen CLI (${value}).` +
+                ` If this is a blocker for you, please let us know on Discord (${constants_1.STEPZEN_DISCORD_URL})`,
+        };
+    }
+    return {
+        result: Object.assign(Object.assign({}, partialCurlArgs), { url: value }),
+    };
+};
 const flags = [
     {
         matches: ['-H', '--header'],
@@ -100,6 +111,10 @@ const flags = [
         matches: ['-X', '--request'],
         parse: parseMethodFlag,
     },
+    {
+        matches: ['--url'],
+        parse: parseURLFlag,
+    },
 ];
 const tryMatchCurlFlag = (matches, argv, i) => {
     for (const match of matches) {
@@ -155,7 +170,7 @@ exports.parseCurlArgv = (argv) => {
                     continue;
                 }
                 if ('error' in matcherResult) {
-                    // flag matched but it requies a value which is missing
+                    // flag matched but it requires a value which is missing
                     return matcherResult;
                 }
                 const parserResult = flag.parse(matcherResult.value, result, matcherResult.match);
@@ -174,14 +189,13 @@ exports.parseCurlArgv = (argv) => {
                 };
             }
         }
-        else if (result.url) {
-            return {
-                error: `Multiple URLs are not currently supported by StepZen CLI (${argv[i]}).` +
-                    ` If this is a blocker for you, please let us know on Discord (${constants_1.STEPZEN_DISCORD_URL})`,
-            };
-        }
         else {
-            result.url = argv[i];
+            // The only curl argument that's not a flag is the URL
+            const resultOrError = parseURLFlag(argv[i], result, '');
+            if ('error' in resultOrError) {
+                return resultOrError;
+            }
+            result = resultOrError.result;
         }
     }
     if (!result.url) {

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

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parsePathParamsPattern = exports.formatPatternDiffWithPath = void 0;
 const chalk = require("chalk");
 const pathParamRegex = /^\$[_A-Za-z]\w*$/;
+// in a literal segment, $ should be escaped as $$
+const pathSegmentRegex = /^([^$]|\$\$)+$/;
 exports.formatPatternDiffWithPath = (patternSegments, pathSegments) => {
     let hasErrors = false;
     const diff = [];
@@ -13,12 +15,9 @@ exports.formatPatternDiffWithPath = (patternSegments, pathSegments) => {
             diff.push(chalk.red(`< ${patternSegment} >`));
             hasErrors = true;
         }
-        else if (patternSegment.charAt(0) === '$') {
-            diff.push(patternSegment);
-        }
-        else {
+        else if (pathSegmentRegex.test(patternSegment)) {
             const pathSegment = pathSegments[i];
-            if (pathSegment === patternSegment) {
+            if (pathSegment === patternSegment.replace(/\$\$/g, '$')) {
                 diff.push(pathSegment);
             }
             else {
@@ -26,6 +25,13 @@ exports.formatPatternDiffWithPath = (patternSegments, pathSegments) => {
                 hasErrors = true;
             }
         }
+        else {
+            // If the path segment contains some unescaped (single) $ chars,
+            // interpret it as a pattern for now. An error will be reported
+            // later (in parsePathParamsPattern) if it doesn't match
+            // pathParamRegex (starts with $)
+            diff.push(patternSegment);
+        }
     }
     for (let i = patternSegments.length; i < pathSegments.length; i++) {
         diff.push(chalk.magenta(`< ${pathSegments[i]} >`));
@@ -52,22 +58,24 @@ exports.parsePathParamsPattern = (url, pathParamsPattern) => {
             error: `Path parameters do not align with the URL path: /${maybeDiff}`,
         };
     }
-    const invalidParameterSegments = patternSegments.filter(segment => segment.charAt(0) === '$' && !pathParamRegex.test(segment));
+    const invalidParameterSegments = patternSegments.filter(segment => !pathSegmentRegex.test(segment) && !pathParamRegex.test(segment));
     if (invalidParameterSegments.length > 0) {
         return {
             error: `The path parameter name '${invalidParameterSegments[0]}' is not` +
                 ` allowed. Path parameter names should be valid GraphQL identifiers` +
-                ` prefixed with $ (dollar sign).`,
+                ` prefixed with $ (dollar sign). $ in literal path segments must be` +
+                ` escaped as $$.`,
         };
     }
-    return patternSegments
+    const retval = patternSegments
         .map((segment, index) => ({
         index,
         name: segment,
     }))
-        .filter(({ name }) => name.charAt(0) === '$')
+        .filter(({ name }) => pathParamRegex.test(name))
         .map(({ index, name }) => ({
         index,
         name: name.slice(1),
     }));
+    return retval;
 };

package/lib/shared/stepzen-sdk.d.ts

@@ -1,14 +1,14 @@
+import { StepZenCredentials } from './types';
 declare const stepzen: {
-    login: (adminkey: string, account?: string) => Promise<{
-        account: string;
-        adminkey: string;
-    }>;
-    createAnonymousAccount: () => {
-        account: string;
-        adminkey: string;
-    };
+    login: (adminkey: string, account?: string) => Promise<StepZenCredentials>;
+    createAnonymousAccount: (uuid: string) => Promise<StepZenCredentials>;
     verify: (account: string, adminkey: string) => Promise<boolean>;
-    client: (options: Pick<import("@stepzen/sdk").StepZenAccount, "account" | "adminkey"> & Partial<import("@stepzen/sdk").StepZenAccount>) => Promise<{
+    client: (options: import("@stepzen/sdk/lib/client").AnonymousClientOptions | import("@stepzen/sdk/lib/client").UserCredentialsClientOptions) => Promise<{
+        readonly credentials: {
+            account: string;
+            adminkey: string;
+            apikey: string;
+        };
         account: () => Promise<{
             account: string;
             apikey: string;
@@ -19,14 +19,14 @@ declare const stepzen: {
         deploy: (destination: string, properties: {
             configurationsets?: string[] | undefined;
             schema: string;
-        }) => Promise<import("@stepzen/sdk").ZenCtlResponse>;
+        }) => Promise<import("@stepzen/sdk/lib/client").ZenCtlResponse>;
         list: {
-            configurationsets: () => Promise<import("@stepzen/sdk").ZenCtlResponse>;
-            schemas: () => Promise<import("@stepzen/sdk").ZenCtlResponse>;
+            configurationsets: () => Promise<import("@stepzen/sdk/lib/client").ZenCtlResponse>;
+            schemas: () => Promise<import("@stepzen/sdk/lib/client").ZenCtlResponse>;
         };
         upload: {
-            configurationset: (destination: string, file: string) => Promise<import("@stepzen/sdk").ZenCtlResponse>;
-            schema: (destination: string, directory: string) => Promise<import("@stepzen/sdk").ZenCtlResponse>;
+            configurationset: (destination: string, file: string) => Promise<import("@stepzen/sdk/lib/client").ZenCtlResponse>;
+            schema: (destination: string, directory: string) => Promise<import("@stepzen/sdk/lib/client").ZenCtlResponse>;
         };
     }>;
 };

package/lib/shared/stepzen-sdk.js

@@ -3,26 +3,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const errors_1 = require("@oclif/errors");
 const sdk_1 = require("@stepzen/sdk");
+const constants_1 = require("./constants");
 const { version } = require('../../package.json');
 const stepzen = Object.assign(Object.assign({}, sdk_1.init({ appName: `stepzen-cli/${version}` })), { login: async (adminkey, account = adminkey.split(':')[0]) => {
-        // Check whether the account and admin key exist and are correct by calling
-        // the stepzen admin api.
-        const isValidConfiguration = await stepzen.verify(account, adminkey);
-        if (!isValidConfiguration) {
+        try {
+            const client = await stepzen.client({
+                account,
+                adminkey,
+                domain: constants_1.STEPZEN_DOMAIN,
+                server: constants_1.STEPZEN_SERVER_URL,
+            });
+            return client.credentials;
+        }
+        catch (error) {
             // Exit, with error
-            throw new errors_1.CLIError('We are unable to verify your account details. Could you please check them?');
+            throw new errors_1.CLIError('We are unable to verify your account details. Could you please check them?' +
+                ` (${error})`);
+        }
+    }, createAnonymousAccount: async (uuid) => {
+        try {
+            const client = await stepzen.client({
+                publicAccountToken: uuid,
+                domain: constants_1.STEPZEN_DOMAIN,
+                server: constants_1.STEPZEN_SERVER_URL,
+            });
+            return client.credentials;
+        }
+        catch (error) {
+            throw new errors_1.CLIError(`Could not create a public account (${error})`);
         }
-        return {
-            account,
-            adminkey,
-        };
-    }, createAnonymousAccount: () => {
-        const anonAdminKey = process.env.STEPZEN_ANONYMOUS_ADMINKEY ||
-            // LATER: call the actual API (pending https://github.com/steprz/zen/issues/5545)
-            'test::steprz.io+666::test';
-        return {
-            account: anonAdminKey.split(':')[0],
-            adminkey: anonAdminKey,
-        };
     } });
 exports.default = stepzen;

package/lib/shared/types.d.ts

@@ -1,8 +1,20 @@
-export interface MachineConfiguration {
+export interface StepZenCredentials {
     account: string;
     adminkey: string;
-    apikey?: string;
+    apikey: string;
 }
+export interface LoggedOutMachineConfiguration {
+    uuid: string;
+}
+export declare type LoggedInMachineConfiguration = LoggedOutMachineConfiguration & StepZenCredentials;
+/**
+ * In-memory representation of the `~/.stepzen/stepzen-config.yaml`
+ * configuration file.
+ *
+ * If the user is not logged in, it has only a UUID of the CLI installation.
+ * If the user is logged in, it has also has the StepZen account credentials.
+ */
+export declare type MachineConfiguration = LoggedInMachineConfiguration | LoggedOutMachineConfiguration;
 /**
  * On-disk representation of a workspace config file, `stepzen.config.json`
  */

package/lib/shared/utils.d.ts

@@ -1,6 +1,4 @@
-export declare const checkAuth: () => Promise<void>;
 export declare const clearConsole: () => void;
-export declare const ensureApiKey: () => Promise<void>;
 export declare const getDirectory: (d?: string | undefined) => string;
 export declare const getStepZenExtensions: () => Promise<string>;
 export declare const validateEndpoint: (endpoint: string) => any;

package/lib/shared/utils.js

@@ -1,9 +1,8 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.maskStepZenKey = exports.validateEndpoint = exports.getStepZenExtensions = exports.getDirectory = exports.ensureApiKey = exports.clearConsole = exports.checkAuth = void 0;
+exports.maskStepZenKey = exports.validateEndpoint = exports.getStepZenExtensions = exports.getDirectory = exports.clearConsole = void 0;
 const errors_1 = require("@oclif/errors");
-const chalk = require("chalk");
 const debug = require("debug");
 const node_fetch_1 = require("node-fetch");
 const fs = require("fs");
@@ -11,60 +10,12 @@ const os = require("os");
 const path = require("path");
 const prettier = require("prettier");
 const constants_1 = require("./constants");
-const configuration_1 = require("./configuration");
-const stepzen_sdk_1 = require("./stepzen-sdk");
-exports.checkAuth = async () => {
-    var _a;
-    const configuration = configuration_1.readConfiguration();
-    // If there is no configuration, you're not logged in
-    if (!configuration) {
-        return;
-    }
-    const details = configuration;
-    // If the account is called 'test', return. It's a test.
-    if (details.account === 'test') {
-        return;
-    }
-    const isValidAccount = await stepzen_sdk_1.default.verify(details.account, details.adminkey);
-    if (!isValidAccount) {
-        if ((_a = details.account) === null || _a === void 0 ? void 0 : _a.endsWith('Playground')) {
-            console.log(chalk.yellow(`
-╔════════════════════════════════════════╗
-║  Your playground account has expired!  ║
-║       Sign up for a full account:      ║
-║            www.stepzen.com             ║
-╚════════════════════════════════════════╝
-      `));
-        }
-        else {
-            console.log('Could not complete the request. Please check your authentication details are correct.');
-        }
-        // eslint-disable-next-line no-process-exit,unicorn/no-process-exit
-        process.exit(1);
-    }
-};
 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.ensureApiKey = async () => {
-    const configuration = configuration_1.readConfiguration();
-    const details = configuration;
-    if (details && !details.apikey) {
-        debug('stepzen:account')(`Fetching API key for account ${details.account}`);
-        try {
-            const client = await stepzen_sdk_1.default.client(details);
-            const response = await client.account();
-            if ('apikey' in response) {
-                details.apikey = response.apikey;
-                await configuration_1.writeConfigurationToLoginFile(details);
-            }
-        }
-        catch (_a) { }
-    }
-};
 exports.getDirectory = (d = process.cwd()) => {
     let directory = d;
     // If it starts with `~`, expand this

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

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

package/lib/shared/zen-command.js

@@ -10,8 +10,8 @@ const configuration_1 = require("./configuration");
 const stepzen_sdk_1 = require("./stepzen-sdk");
 class ZenCommand extends command_1.Command {
     async ensureStepZenAccount() {
-        const configuration = configuration_1.readConfiguration();
-        if (configuration && configuration.account) {
+        const configuration = await configuration_1.readConfiguration();
+        if ('account' in configuration) {
             return {
                 configuration,
             };
@@ -19,12 +19,12 @@ class ZenCommand extends command_1.Command {
         const TheCommand = this.constructor;
         const { flags } = this.parse(TheCommand);
         if (flags['enable-login-prompt']) {
-            return this.promptUserToLogIn();
+            return this.promptUserToLogIn(configuration.uuid);
         }
         throw new errors_1.CLIError('Could not find StepZen account credentials.' +
             ' Please run `stepzen login` first.');
     }
-    async promptUserToLogIn() {
+    async promptUserToLogIn(uuid) {
         this.log(chalk.bold(chalk.cyan('Welcome to StepZen CLI!')));
         this.log('');
         this.log(`Please log in with your StepZen account to make your GraphQL API private.` +
@@ -60,14 +60,14 @@ class ZenCommand extends command_1.Command {
                     suffix: chalk.blue(` (available at ${chalk.bold('https://stepzen.com/account')})`),
                 },
             ]);
-            configuration = await stepzen_sdk_1.default.login(answers.adminkey);
-            configuration_1.writeConfigurationToLoginFile(configuration);
+            const credentials = await stepzen_sdk_1.default.login(answers.adminkey);
+            configuration = await configuration_1.writeCredentialsToConfigFile(credentials);
             this.log('You have successfully logged in.');
             this.log('');
         }
         else {
-            configuration = await stepzen_sdk_1.default.createAnonymousAccount();
-            configuration_1.writeConfigurationToLoginFile(configuration);
+            const credentials = await stepzen_sdk_1.default.createAnonymousAccount(uuid);
+            configuration = await configuration_1.writeCredentialsToConfigFile(credentials);
             this.log(`We've created a temporary public account for you.\nAll endpoints` +
                 ` deployed to this account will be automatically deleted after 24` +
                 ` hours. You can log in with your regular StepZen account at any` +

package/lib/start/deploy.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 const chalk = require("chalk");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const fs = require("fs-extra");
 const path = require("path");
 const prettyMilliseconds = require("pretty-ms");
@@ -19,7 +19,7 @@ exports.default = async (file, workspace, flags) => {
     if (file) {
         console.log(`File changed: ${chalk.blue(file)}`);
     }
-    const configuration = configuration_1.readConfiguration();
+    const configuration = (await configuration_1.readConfiguration());
     if (!flags['no-validate']) {
         try {
             await validate_1.default.run([workspace.schema]);
@@ -32,7 +32,7 @@ exports.default = async (file, workspace, flags) => {
             return;
         }
     }
-    cli_ux_1.default.action.start(`Deploying ${chalk.yellow(workspace.endpoint)} to StepZen`);
+    core_1.CliUx.ux.action.start(`Deploying ${chalk.yellow(workspace.endpoint)} to StepZen`);
     const deployArgs = [workspace.endpoint, '--silent'];
     const uploadCmds = [];
     const configPath = path.join(workspace.schema, 'config.yaml');
@@ -100,7 +100,7 @@ exports.default = async (file, workspace, flags) => {
     }
     const deployEnd = new Date().getTime();
     const deployTime = deployEnd - deployStart;
-    cli_ux_1.default.action.stop(`${chalk.grey('done in')} ${prettyMilliseconds(deployTime)} 🚀`);
+    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();

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.13.0-beta.3","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"Import a schema for an external data source or a API endpoint to your GraphQL API.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] prefix to add every type in the generated schema."},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"}},"args":[{"name":"schemas","required":true}]},"init":{"id":"init","description":"stepzen init","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"stepzen lint","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"list":{"id":"list","description":"list your items","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationsets","schemas"]}]},"login":{"id":"login","description":"log in to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"account":{"name":"account","type":"option","char":"a","hidden":true},"adminkey":{"name":"adminkey","type":"option","char":"k","hidden":true},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"log out of stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"upload and deploy your schema","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-server":{"name":"no-server","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"transpile a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"upload to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"validate a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"stepzen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}
+{"version":"0.14.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},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"configurationsets":{"name":"configurationsets","type":"option","description":"Configurationsets to use","default":""},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"schema":{"name":"schema","type":"option","description":"Schema to use","required":true},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"destination","description":"destination","required":true}]},"import":{"id":"import","description":"Import a schema for an external data source or a API endpoint to your GraphQL API.","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"working directory"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","hidden":true,"allowNo":false},"name":{"name":"name","type":"option","description":"subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name"},"prefix":{"name":"prefix","type":"option","description":"[curl] prefix to add every type in the generated schema."},"query-name":{"name":"query-name","type":"option","description":"[curl] property name to add to the Query type as a way to access the imported cURL endpoint."},"query-type":{"name":"query-type","type":"option","description":"[curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present."},"path-params":{"name":"path-params","type":"option","description":"[curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'"}},"args":[{"name":"schemas","required":true}]},"init":{"id":"init","description":"stepzen init","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"endpoint":{"name":"endpoint","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"yes":{"name":"yes","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"directory","hidden":true}]},"lint":{"id":"lint","description":"stepzen lint","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"list":{"id":"list","description":"list your items","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationsets","schemas"]}]},"login":{"id":"login","description":"log in to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"account":{"name":"account","type":"option","char":"a","hidden":true},"adminkey":{"name":"adminkey","type":"option","char":"k","hidden":true},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"log out of stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"upload and deploy your schema","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"working directory"},"endpoint":{"name":"endpoint","type":"option","description":"Override workspace endpoint"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"no-console":{"name":"no-console","type":"boolean","hidden":true,"allowNo":false},"no-dashboard":{"name":"no-dashboard","type":"boolean","hidden":true,"allowNo":false},"no-init":{"name":"no-init","type":"boolean","hidden":true,"allowNo":false},"no-server":{"name":"no-server","type":"boolean","hidden":true,"allowNo":false},"no-validate":{"name":"no-validate","type":"boolean","hidden":true,"allowNo":false},"no-watcher":{"name":"no-watcher","type":"boolean","hidden":true,"allowNo":false},"port":{"name":"port","type":"option","default":5001}},"args":[]},"transpile":{"id":"transpile","description":"transpile a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"config":{"name":"config","type":"option","hidden":true},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"hide-output":{"name":"hide-output","type":"boolean","hidden":true,"allowNo":false},"inspect":{"name":"inspect","type":"boolean","char":"i","hidden":true,"allowNo":false},"inspect-after":{"name":"inspect-after","type":"boolean","hidden":true,"allowNo":false},"output-configuration":{"name":"output-configuration","type":"boolean","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"folder","required":true}]},"upload":{"id":"upload","description":"upload to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"dir":{"name":"dir","type":"option","description":"A directory to upload"},"file":{"name":"file","type":"option","description":"A file to upload"},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"silent":{"name":"silent","type":"boolean","allowNo":false}},"args":[{"name":"type","description":"type","required":true,"options":["configurationset","schema"]},{"name":"destination","description":"destination","required":true}]},"validate":{"id":"validate","description":"validate a graphql schema","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"folder","required":true}]},"whoami":{"id":"whoami","description":"stepzen whoami","pluginName":"stepzen","pluginType":"core","hidden":true,"aliases":[],"flags":{"non-interactive":{"name":"non-interactive","type":"boolean","description":"disable all interactive prompts","hidden":true,"allowNo":false},"enable-login-prompt":{"name":"enable-login-prompt","type":"option","description":"An (internal) feature flag to enable the \"prompt user to log in\" feature for the users who run the CLI without being logged in. It is intentially hidden and not documented because in the future this feature will be enabled for all users and the flag will be removed.","hidden":true,"options":["true","false"],"default":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"showkeys":{"name":"showkeys","type":"boolean","allowNo":false},"apikey":{"name":"apikey","type":"boolean","allowNo":false},"adminkey":{"name":"adminkey","type":"boolean","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stepzen",
   "description": "The StepZen CLI",
-  "version": "0.13.0-beta.3",
+  "version": "0.14.0",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -13,7 +13,7 @@
   },
   "main": "lib/index.js",
   "engines": {
-    "node": ">=14.0.1",
+    "node": ">=14.17.0",
     "npm": ">=6.14"
   },
   "files": [
@@ -28,14 +28,14 @@
   "dependencies": {
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.18.3",
+    "@oclif/core": "1.6.3",
     "@oclif/errors": "1.3.5",
     "@oclif/plugin-help": "^5.1.12",
     "@stepzen/dashboard": "0.1.37",
-    "@stepzen/sdk": "0.9.46",
+    "@stepzen/sdk": "0.11.0",
     "@stepzen/transpiler": "0.0.38",
     "chalk": "^4.1.1",
     "chokidar": "^3.5.2",
-    "cli-ux": "^6.0.9",
     "compare-versions": "^3.6.0",
     "date-fns": "^2.26.0",
     "debug": "^4.3.0",
@@ -69,7 +69,7 @@
     "@types/minimist": "^1.2.1",
     "@types/mocha": "^5.2.7",
     "@types/mock-fs": "^4.13.0",
-    "@types/node": "^12.20.7",
+    "@types/node": "^14.18.13",
     "@types/node-fetch": "^2.5.7",
     "@types/prettier": "^2.1.6",
     "@types/rimraf": "^3.0.0",
@@ -107,7 +107,7 @@
     "hooks": {
       "prerun": [
         "./lib/hooks/prerun/check-upgrade",
-        "./lib/hooks/prerun/ensure-api-key",
+        "./lib/hooks/prerun/ensure-config-file",
         "./lib/hooks/prerun/ensure-permissions"
       ]
     }

package/lib/hooks/prerun/ensure-api-key.js

@@ -1,8 +0,0 @@
-"use strict";
-// Copyright (c) 2020,2021,2022, StepZen, Inc.
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../shared/utils");
-const hook = async function () {
-    await utils_1.ensureApiKey();
-};
-exports.default = hook;