stepzen 0.11.0 → 0.13.0-beta.0

package/README.md

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

package/lib/commands/import.js

@@ -27,10 +27,19 @@ class Import extends command_1.Command {
                 'In order to use the --name flag please import each schema separately.');
         }
         // Get the working directory and workspace
+        let workspace;
         const directory = utils_1.getDirectory(flags.dir);
-        let workspace = workspace_1.getWorkspace(directory);
-        if (!workspace) {
-            workspace = await init_1.default.run([directory]);
+        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);
+            }
         }
         // Select an import execution flow:
         //  - v1 with `stepzen/engines` and cloud function

package/lib/commands/init.d.ts

@@ -1,4 +1,7 @@
 import { Command, flags } from '@oclif/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 Command {
     static description: string;
     static hidden: boolean;
@@ -7,5 +10,5 @@ export default class Init extends Command {
         hidden: boolean;
         name: string;
     }[];
-    run(): Promise<any>;
+    run(): Promise<import("../shared/types").Workspace>;
 }

package/lib/commands/init.js

@@ -1,53 +1,85 @@
 "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");
+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 command_1.Command {
     async run() {
         const { args, flags } = this.parse(Init);
         // Get the correct directory
-        const directory = utils_1.getDirectory(args.directory);
+        let directory = utils_1.getDirectory(args.directory);
         // Make sure it is not already a workspace
-        const w = workspace_1.getWorkspace(directory);
-        if (w)
-            throw new errors_1.CLIError('This is already a workspace, cannot init');
-        // If you've passed an endpoint, validate it, and throw an error straight away if needed
+        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')
+            if (typeof error === 'string') {
                 throw new errors_1.CLIError(error);
+            }
         }
         // Make a suggestion for the endpoint
         const endpoint = flags.endpoint || `api/${moniker_1.default()}`;
-        // See if we think there's a StepZen schema already
-        let root;
-        const existing = [
-            ...glob.sync('*/**/config.yaml', {
-                cwd: directory,
-                ignore: '**/node_modules/**',
-            }),
-            ...glob.sync('*/**/index.graphql', {
-                cwd: directory,
-                ignore: '**/node_modules/**',
-            }),
-        ];
-        if (existing.length > 0) {
-            root = existing[0]
-                .replace('config.yaml', '')
-                .replace('index.graphql', '')
-                .replace(/\/*$/, '');
-        }
-        const hasRoot = existing.length > 0;
         // 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?',
@@ -59,14 +91,22 @@ class Init extends command_1.Command {
                 message: `We have detected a schema in this directory. Set the schema root to "${root}"?`,
                 name: 'use-root',
                 type: 'confirm',
-                when: hasRoot && !flags.yes,
+                when: Boolean(root) && !flags.yes,
             },
         ];
         // Get the answers
-        const answers = Object.assign({ endpoint, 'use-root': true }, (await inquirer.prompt(questions)));
+        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 (hasRoot && answers['use-root'])
+        if (root && answers['use-root'])
             workspace.root = root;
         // Write the file
         const file = path.join(directory, 'stepzen.config.json');
@@ -74,7 +114,7 @@ class Init extends command_1.Command {
         // Fetch the newly created workspace
         const created = workspace_1.getWorkspace(directory);
         // Done!
-        this.log(`Created ${path.join(created.directory, 'stepzen.config.json')}`);
+        this.log(`Created a StepZen workspace in ${created.directory}`);
         return created;
     }
 }

package/lib/commands/start.js

@@ -25,14 +25,23 @@ class Start extends command_1.Command {
             throw new errors_1.CLIError('You are probably not logged in.');
         }
         // Get the working directory and workspace
+        let workspace;
         const directory = utils_1.getDirectory(flags.dir);
-        let workspace = workspace_1.getWorkspace(directory);
-        if (!workspace) {
+        const maybeWorkspace = workspace_1.getWorkspace(directory);
+        if (maybeWorkspace) {
+            workspace = maybeWorkspace;
+        }
+        else {
             const initArgs = [directory];
-            if (flags.endpoint)
+            if (flags.endpoint) {
                 initArgs.push('--endpoint', flags.endpoint);
-            // eslint-disable-next-line require-atomic-updates
-            workspace = await init_1.default.run(initArgs);
+            }
+            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
         if (flags.endpoint) {

package/lib/generate/helpers.d.ts

@@ -1,4 +1,6 @@
 import type { Answers, DistinctQuestion } from 'inquirer';
+export declare const createGeneratorFilesDirectly: (id: string, details: any) => Promise<string>;
+export declare const createGeneratorFilesViaStepZen: (id: string, details: any) => Promise<string>;
 export declare const createGeneratorFiles: (id: string, details: any) => Promise<string>;
 export declare type GeneratorConfiguration = {
     questions: DistinctQuestion<Answers>[];
@@ -6,6 +8,8 @@ export declare type GeneratorConfiguration = {
     errors: Record<string, any>;
     status: number;
 };
+export declare const getConfigurationDirectly: (id: string, details?: any) => Promise<GeneratorConfiguration | null>;
+export declare const getConfigurationViaStepZen: (id: string, details?: any) => Promise<GeneratorConfiguration | null>;
 export declare const getConfiguration: (id: string, details?: any) => Promise<GeneratorConfiguration | null>;
 export declare const getSchemaList: (arg: string) => string[];
 export declare const getTemplates: () => 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.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchemaList = exports.getConfiguration = exports.createGeneratorFiles = void 0;
+exports.askTemplateQuestions = exports.askGeneratorQuestions = exports.getTemplates = exports.getSchemaList = exports.getConfiguration = exports.getConfigurationViaStepZen = exports.getConfigurationDirectly = exports.createGeneratorFiles = exports.createGeneratorFilesViaStepZen = exports.createGeneratorFilesDirectly = void 0;
 const errors_1 = require("@oclif/errors");
 const chalk = require("chalk");
 const debug = require("debug");
@@ -16,10 +16,40 @@ const configuration_1 = require("../shared/configuration");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
 const { version } = require('../../package.json');
-exports.createGeneratorFiles = async (id, details) => {
+exports.createGeneratorFilesDirectly = async (id, details) => {
+    const url = `${constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL}/create`;
+    debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
+    try {
+        const response = await node_fetch_1.default(url, {
+            body: JSON.stringify({
+                id,
+                details: JSON.stringify(details.answers),
+            }),
+            headers: {
+                'Content-Type': 'application/json',
+                'User-Agent': `stepzen-cli/${version}`,
+            },
+            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);
+        }
+        return tmp;
+    }
+    catch (error) {
+        debug('stepzen:generate')(error);
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+};
+exports.createGeneratorFilesViaStepZen = async (id, details) => {
     const config = configuration_1.readConfiguration();
     const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
     const url = `https://${config.account}.${domain}/${constants_1.STEPZEN_GENERATOR_ENGINES_ENDPOINT}/__graphql`;
+    debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
     const response = await node_fetch_1.default(url, {
         body: JSON.stringify({
             query: `
@@ -51,10 +81,45 @@ exports.createGeneratorFiles = async (id, details) => {
     }
     return tmp;
 };
-exports.getConfiguration = async (id, details = {}) => {
+exports.createGeneratorFiles = async (id, details) => {
+    const fn = constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL
+        ? exports.createGeneratorFilesDirectly
+        : exports.createGeneratorFilesViaStepZen;
+    return fn(id, details);
+};
+exports.getConfigurationDirectly = async (id, details = {}) => {
+    const url = `${constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL}/configure`;
+    debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
+    try {
+        const response = await node_fetch_1.default(url, {
+            body: JSON.stringify({
+                id,
+                details: JSON.stringify(details),
+            }),
+            headers: {
+                'Content-Type': 'application/json',
+                'User-Agent': `stepzen-cli/${version}`,
+            },
+            method: 'POST',
+        });
+        const { answers, errors, questions, status } = await response.json();
+        return {
+            answers: JSON.parse(answers),
+            errors: JSON.parse(errors),
+            questions: JSON.parse(questions),
+            status: JSON.parse(status),
+        };
+    }
+    catch (error) {
+        debug('stepzen:generate')(error);
+        throw new errors_1.CLIError(errors_2.PERMANENT_STEPZEN_ERROR);
+    }
+};
+exports.getConfigurationViaStepZen = async (id, details = {}) => {
     const config = configuration_1.readConfiguration();
     const domain = constants_1.STEPZEN_DOMAIN.replace('.io', '.net');
     const url = `https://${config.account}.${domain}/${constants_1.STEPZEN_GENERATOR_ENGINES_ENDPOINT}/__graphql`;
+    debug('stepzen:generate')(`calling the generator engine ${id} via ${url}`);
     const response = await node_fetch_1.default(url, {
         body: JSON.stringify({
             query: `
@@ -100,6 +165,12 @@ exports.getConfiguration = async (id, details = {}) => {
     }
     return data.configure;
 };
+exports.getConfiguration = async (id, details = {}) => {
+    const fn = constants_1.STEPZEN_DIRECT_GENERATOR_ENGINES_URL
+        ? exports.getConfigurationDirectly
+        : exports.getConfigurationViaStepZen;
+    return fn(id, details);
+};
 exports.getSchemaList = (arg) => {
     const schemas = arg.split(',').map((schema) => schema.trim());
     // Make sure they're unique, otherwise, complain

package/lib/shared/constants.d.ts

@@ -5,6 +5,7 @@ export declare const STEPZEN_DOMAIN: string;
 export declare const STEPZEN_SERVER_URL: string;
 export declare const STEPZEN_GENERATOR_ENGINES_SCHEMA: string;
 export declare const STEPZEN_GENERATOR_ENGINES_ENDPOINT = "stepzen-generator/engines";
+export declare const STEPZEN_DIRECT_GENERATOR_ENGINES_URL: string | undefined;
 export declare const STEPZEN_API_TEMPLATES_REPOSITORY = "https://github.com/steprz/stepzen-schemas";
 export declare const ADMIN_DEPLOY_URL = "/cli/admin/deploy";
 export declare const ADMIN_LIST_URL = "/cli/admin/list";

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_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_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;
 // This file contains constants and all magic strings
 const dotenv = require("dotenv");
 const os = require("os");
@@ -9,7 +9,7 @@ const path = require("path");
 // This allows you to set environment variables in a `.env` file.
 // This file needs to be in your working directory.
 dotenv.config();
-const { STEPZEN_CONFIG_FILE: ENV_VAR_STEPZEN_CONFIG_FILE, STEPZEN_DOMAIN: ENV_VAR_STEPZEN_DOMAIN, STEPZEN_GENERATOR_ENGINES_SCHEMA: ENV_VAR_STEPZEN_GENERATOR_ENGINES_SCHEMA, STEPZEN_SERVER_URL: ENV_VAR_STEPZEN_SERVER_URL, STEPZEN_JSON2SDL_SERVER_URL: ENV_VAR_STEPZEN_JSON2SDL_SERVER_URL, } = process.env;
+const { STEPZEN_CONFIG_FILE: ENV_VAR_STEPZEN_CONFIG_FILE, STEPZEN_DOMAIN: ENV_VAR_STEPZEN_DOMAIN, STEPZEN_GENERATOR_ENGINES_SCHEMA: ENV_VAR_STEPZEN_GENERATOR_ENGINES_SCHEMA, STEPZEN_SERVER_URL: ENV_VAR_STEPZEN_SERVER_URL, STEPZEN_JSON2SDL_SERVER_URL: ENV_VAR_STEPZEN_JSON2SDL_SERVER_URL, STEPZEN_DIRECT_GENERATOR_ENGINES_URL: ENV_VAR_STEPZEN_DIRECT_GENERATOR_ENGINES_URL, } = process.env;
 // Where your authentication details are stored locally
 exports.STEPZEN_CONFIG_DIRECTORY = path.join(os.homedir(), '.stepzen');
 exports.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP = path.join(exports.STEPZEN_CONFIG_DIRECTORY, 'last_update_check.timestamp');
@@ -23,6 +23,8 @@ exports.STEPZEN_SERVER_URL = ENV_VAR_STEPZEN_SERVER_URL || 'https://{account}.st
 exports.STEPZEN_GENERATOR_ENGINES_SCHEMA = ENV_VAR_STEPZEN_GENERATOR_ENGINES_SCHEMA || 'stepzen/engines';
 // Generator Engines schema: target API endpoint
 exports.STEPZEN_GENERATOR_ENGINES_ENDPOINT = 'stepzen-generator/engines';
+// If defined, call the generator engines cloud function directly, skipping zenctl
+exports.STEPZEN_DIRECT_GENERATOR_ENGINES_URL = ENV_VAR_STEPZEN_DIRECT_GENERATOR_ENGINES_URL;
 // API Templates repository
 exports.STEPZEN_API_TEMPLATES_REPOSITORY = 'https://github.com/steprz/stepzen-schemas';
 // Paths to the endpoints used (only for tests)

package/lib/shared/moniker.d.ts

@@ -1,2 +1,4 @@
+export declare const getRandomAnimal: () => string;
+export declare const getRandomDescriptor: () => string;
 declare const _default: () => string;
 export default _default;

package/lib/shared/moniker.js

@@ -1,6 +1,7 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRandomDescriptor = exports.getRandomAnimal = void 0;
 const lodash_1 = require("lodash");
 const animals = [
     'aardvark',
@@ -637,8 +638,6 @@ const descriptors = [
     'zinc',
     'zooming',
 ];
-exports.default = () => {
-    const animal = animals[lodash_1.random(0, animals.length - 1)];
-    const descriptor = descriptors[lodash_1.random(0, descriptors.length - 1)];
-    return `${descriptor}-${animal}`;
-};
+exports.getRandomAnimal = () => animals[lodash_1.random(0, animals.length - 1)];
+exports.getRandomDescriptor = () => descriptors[lodash_1.random(0, descriptors.length - 1)];
+exports.default = () => `${exports.getRandomDescriptor()}-${exports.getRandomAnimal()}`;

package/lib/shared/types.d.ts

@@ -3,11 +3,20 @@ export interface MachineConfiguration {
     adminkey: string;
     apikey?: string;
 }
+/**
+ * On-disk representation of a workspace config file, `stepzen.config.json`
+ */
 export interface WorkspaceConfiguration {
-    directory?: string;
     endpoint: string;
     root?: string;
-    schema?: string;
+}
+/**
+ * In-memory representation of a workspace config
+ */
+export interface Workspace {
+    endpoint: string;
+    directory: string;
+    schema: string;
 }
 export interface ZenCtlResponse {
     errors?: Array<string>;

package/lib/shared/utils.js

@@ -68,11 +68,12 @@ exports.ensureApiKey = async () => {
 exports.getDirectory = (d = process.cwd()) => {
     let directory = d;
     // If it starts with `~`, expand this
-    if (directory.startsWith('~'))
+    if (directory.startsWith('~')) {
         directory = directory.replace('~', os.homedir());
-    // If it does not now start with `/`, then get the absolute path
-    if (directory.startsWith('/') === false)
-        directory = path.resolve(directory);
+    }
+    // If it does not now start with `/`, then get the absolute path.
+    // Also, remove any `..` and `.` segments.
+    directory = path.resolve(directory);
     // If the path does not exist, throw an error
     if (!fs.existsSync(directory)) {
         throw new errors_1.CLIError(`Cannot find ${directory}`);

package/lib/shared/workspace.d.ts

@@ -1 +1,2 @@
-export declare const getWorkspace: (directory: string) => any;
+import { Workspace } from './types';
+export declare const getWorkspace: (directory: string) => Workspace | null;

package/lib/shared/workspace.js

@@ -4,50 +4,53 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWorkspace = void 0;
 const errors_1 = require("@oclif/errors");
 const fs = require("fs");
+const os = require("os");
 const path = require("path");
 const utils_1 = require("./utils");
 exports.getWorkspace = (directory) => {
-    let workspace = {
-        directory: '',
-        endpoint: '',
-        root: '',
-        schema: '',
-    };
-    // Loop through this and all parent directories to find the root
-    let parts = directory.split('/');
-    do {
-        const d = `${parts.join('/')}`.replace(/\/*$/, '');
+    let workspaceRoot;
+    const parts = path
+        // Remove trailing slashes and any `..` and `.` segments
+        .resolve(directory)
+        // split into segments
+        .split(path.sep);
+    // Loop through this and all parent directories up to $HOME to find the root
+    for (; parts.length > 0; parts.pop()) {
+        const d = parts.join(path.sep);
         const f = path.join(d, 'stepzen.config.json');
         if (fs.existsSync(f)) {
-            workspace.directory = d;
-            parts = [];
-        }
-        parts.pop();
-    } while (parts.length > 0);
-    // If it's found a workspace, then parse the configuration file
-    if (workspace.directory) {
-        const filepath = path.join(workspace.directory, 'stepzen.config.json');
-        const file = fs.readFileSync(filepath, 'utf8');
-        try {
-            const config = JSON.parse(file);
-            workspace = Object.assign(Object.assign({}, workspace), config);
+            workspaceRoot = d;
+            break;
         }
-        catch (_a) {
-            throw new errors_1.CLIError(`Cannot parse configuration from ${filepath}`);
+        if (d === os.homedir()) {
+            break;
         }
     }
-    // Add the 'schema' property, which is the directory + the 'root'
-    workspace.schema = path.join(workspace.directory, workspace.root);
+    if (!workspaceRoot) {
+        return null;
+    }
+    const filepath = path.join(workspaceRoot, 'stepzen.config.json');
+    const file = fs.readFileSync(filepath, 'utf8');
+    let config;
+    try {
+        config = JSON.parse(file);
+    }
+    catch (_a) {
+        throw new errors_1.CLIError(`Cannot parse configuration from ${filepath}`);
+    }
     // Validate the workspace
-    if (workspace.directory) {
-        const error = utils_1.validateEndpoint(workspace.endpoint);
-        if (typeof error === 'string')
-            throw new errors_1.CLIError(error);
-        const schemaExists = fs.existsSync(workspace.schema);
-        if (!schemaExists)
-            throw new errors_1.CLIError(`Cannot find workspace schema folder ${workspace.schema}`);
-        return workspace;
+    const error = utils_1.validateEndpoint(config.endpoint);
+    if (typeof error === 'string') {
+        throw new errors_1.CLIError(error);
+    }
+    // Add the 'schema' property, which is the directory + the 'root'
+    const schema = path.join(workspaceRoot, config.root || '');
+    if (!fs.existsSync(schema)) {
+        throw new errors_1.CLIError(`Cannot find workspace schema folder ${schema}`);
     }
-    // This is not a workspace folder
-    return false;
+    return {
+        directory: workspaceRoot,
+        endpoint: config.endpoint,
+        schema: schema,
+    };
 };

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.11.0","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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.13.0-beta.0","commands":{"deploy":{"id":"deploy","description":"deploy to stepzen","pluginName":"stepzen","pluginType":"core","aliases":[],"flags":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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.11.0",
+  "version": "0.13.0-beta.0",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -79,6 +79,7 @@
     "@types/unzipper": "^0.10.4",
     "chai": "^4.2.0",
     "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
     "eslint": "7.11.0",
     "eslint-config-oclif": "3.1.0",
     "eslint-config-oclif-typescript": "0.1.0",
@@ -118,9 +119,9 @@
     "postpack": "rm -f oclif.manifest.json",
     "posttest": "eslint . --ignore-path .prettierignore",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "test": "tsc -b && STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "tsc -b && cross-env STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
     "test:single:example": "npm run test:single -- test/src/shared/curl-parser.test.ts",
-    "test:single": "tsc -b && STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost mocha --forbid-only test/_global.test.ts",
+    "test:single": "tsc -b && cross-env STEPZEN_DOMAIN=steprz.io STEPZEN_SERVER_URL=http://localhost mocha --forbid-only test/_global.test.ts",
     "version": "oclif-dev readme && git add README.md",
     "prepare": "husky install"
   },