stepzen 0.10.0 → 0.11.0-beta.2

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g stepzen
 $ stepzen COMMAND
 running command...
 $ stepzen (-v|--version|version)
-stepzen/0.10.0 darwin-x64 node-v14.18.3
+stepzen/0.11.0-beta.2 darwin-x64 node-v14.19.1
 $ stepzen --help [COMMAND]
 USAGE
   $ stepzen COMMAND
@@ -91,18 +91,31 @@ USAGE
   $ stepzen import SCHEMAS
 
 OPTIONS
-  -h, --help               show CLI help
-  --dir=dir                working directory
+  -h, --help
+      show CLI help
 
-  --name=name              subfolder inside the workspace folder to save the imported schema files, defaults to the
-                           imported schema name
+  --dir=dir
+      working directory
 
-  --prefix=prefix          [curl] prefix to add every type in the generated schema.
+  --name=name
+      subfolder inside the workspace folder to save the imported schema files, defaults to the imported schema name
 
-  --query-name=query-name  [curl] property name to add to the Query type as a way to access the imported cURL endpoint.
+  --path-params=path-params
+      [curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the
+      variable segments with $paramName placeholders.
 
-  --query-type=query-type  [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.
+      Example:
+      stepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'
+
+  --prefix=prefix
+      [curl] prefix to add every type in the generated schema.
+
+  --query-name=query-name
+      [curl] property name to add to the Query type as a way to access the imported cURL endpoint.
+
+  --query-type=query-type
+      [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.
 ```
 
 ## `stepzen list TYPE`

package/lib/commands/import.js

@@ -12,9 +12,11 @@ const generate_1 = require("../generate");
 const utils_1 = require("../shared/utils");
 const helpers_1 = require("../generate/helpers");
 const curl2sdl_1 = require("../generate/curl2sdl");
+const curl_parser_1 = require("../shared/curl-parser");
 const workspace_1 = require("../shared/workspace");
 const init_1 = require("./init");
 const constants_1 = require("../shared/constants");
+const path_params_parser_1 = require("../shared/path-params-parser");
 class Import extends command_1.Command {
     async run() {
         const { args, argv, flags } = this.parse(Import);
@@ -40,25 +42,45 @@ class Import extends command_1.Command {
             if (schemas.length > 1) {
                 throw new errors_1.CLIError('Please run cURL import separately from importing other schemas');
             }
-            if (argv.length < 2) {
-                throw new errors_1.CLIError('Please append the full cURL command, e.g. ' +
-                    chalk.bold(`${this.config.name} import curl https://test.stepzen.net/version`));
-            }
             this.log(chalk.yellow(`NOTE: ${chalk.bold('stepzen import curl')} is a ${chalk.bold('new')} feature.`));
             this.log(chalk.yellow('If you have any issues, please check if they have been addressed ' +
                 'in the latest version, or reach out to StepZen on Discord: ' +
-                'https://discord.gg/9k2VdPn2FR'));
-            // LATER: introduce a generic graphqlize() API taking in schema as the first arg
-            argv.shift(); // remove 'curl' and pass everything else further
-            cli_ux_1.cli.action.start('Starting');
-            const resultOrError = await curl2sdl_1.curl2sdl({
-                argv,
+                constants_1.STEPZEN_DISCORD_URL));
+            let curl2sdlOptions;
+            const fixedOptions = {
                 name: flags.name,
                 source: workspace.schema,
+            };
+            const editableOptions = {
                 queryName: flags['query-name'],
                 rootType: flags['query-type'],
                 typePrefix: flags.prefix,
-            });
+                pathParams: flags['path-params'],
+            };
+            if (argv.length === 1) {
+                // no parameters given: start an interactive prompt
+                console.log();
+                console.log('This command introspects the response of a REST endpoint and generates' +
+                    ' a GraphQL schema allowing you to access this endpoint through your ' +
+                    'StepZen API. curl syntax is supported so that you copy and paste a ' +
+                    'curl command instead of the URL.');
+                console.log();
+                curl2sdlOptions = Object.assign(Object.assign({}, fixedOptions), (await curl2sdl_1.askCurlQuestions(editableOptions)));
+            }
+            else {
+                // run non-interative
+                const argsOrError = curl_parser_1.parseCurlArgv(argv);
+                if ('error' in argsOrError) {
+                    throw new errors_1.CLIError(argsOrError.error);
+                }
+                const parsedPathParamsOrError = path_params_parser_1.parsePathParamsPattern(argsOrError.url, flags['path-params']);
+                if ('error' in parsedPathParamsOrError) {
+                    throw new errors_1.CLIError(parsedPathParamsOrError.error);
+                }
+                curl2sdlOptions = Object.assign(Object.assign(Object.assign({}, fixedOptions), editableOptions), { pathParams: parsedPathParamsOrError, curlArgs: argsOrError });
+            }
+            cli_ux_1.cli.action.start('Starting');
+            const resultOrError = await curl2sdl_1.curl2sdl(curl2sdlOptions);
             cli_ux_1.cli.action.stop();
             if ('error' in resultOrError) {
                 this.log('A problem occured while processing your import. ' +
@@ -70,7 +92,7 @@ class Import extends command_1.Command {
         }
         else {
             ;
-            ['prefix', 'query-type', 'query-name'].forEach(flag => {
+            ['prefix', 'query-type', 'query-name', 'path-params'].forEach(flag => {
                 if (flag in flags) {
                     this.log(chalk.gray(`The ${chalk.bold(`--${flag}`)} flag only applies when importing ${chalk.bold('curl')}. It will be ignored now.`));
                 }
@@ -118,6 +140,16 @@ Import.flags = {
         description: '[curl] name for the type returned by the cURL endpoint in the ' +
             `generated schema. The name specified by ${chalk.bold('--query-type')} is not prefixed by ${chalk.bold('--prefix')} if both flags are present.`,
     }),
+    'path-params': command_1.flags.string({
+        description: `[curl] specifies path parameters in the URL path.` +
+            ` Can be formed by taking the original path and replacing the` +
+            ` variable segments with ${chalk.bold('$paramName')} placeholders.` +
+            `\n` +
+            `\nExample:` +
+            `\nstepzen import curl https://example.com/users/jane/posts/12` +
+            ` --path-params` +
+            ` '/users/${chalk.bold('$userId')}/posts/${chalk.bold('$postId')}'`,
+    }),
 };
 Import.args = [
     {

package/lib/generate/curl2sdl.d.ts

@@ -1,16 +1,24 @@
+import { CurlArguments } from '../shared/curl-parser';
+import { PathParam } from '../shared/path-params-parser';
 export declare type Curl2SdlOptions = {
-    argv: readonly string[];
+    curlArgs: CurlArguments;
     name: string;
     source: string;
     queryName?: string;
     rootType?: string;
     typePrefix?: string;
+    pathParams: readonly PathParam[];
 };
-export declare type HeaderInput = {
-    name: string;
-    value: string;
+export declare type EditableCurl2SdlOptions = Pick<Curl2SdlOptions, 'curlArgs' | 'queryName' | 'rootType' | 'typePrefix' | 'pathParams'>;
+export declare type CurlAnswers = {
+    url: string;
+    queryName: string;
+    rootType: string;
+    typePrefix: string;
+    pathParams: string;
 };
-export declare const curl2sdl: ({ argv, name, source, queryName, rootType, typePrefix, }: Curl2SdlOptions) => Promise<{
+export declare const askCurlQuestions: (defaultAnswers?: Partial<CurlAnswers>) => Promise<EditableCurl2SdlOptions>;
+export declare const curl2sdl: ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, }: Curl2SdlOptions) => Promise<{
     error: string;
 } | {
     outPath: string;

package/lib/generate/curl2sdl.js

@@ -1,24 +1,80 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.curl2sdl = void 0;
+exports.curl2sdl = exports.askCurlQuestions = void 0;
 const errors_1 = require("@oclif/errors");
+const chalk = require("chalk");
 const fs = require("fs-extra");
+const inquirer = require("inquirer");
+const lodash_1 = require("lodash");
 const os = require("os");
 const path = require("path");
+const string_argv_1 = require("string-argv");
 const node_fetch_1 = require("node-fetch");
 const debug = require("debug");
 const prettier = require("prettier");
 const transpiler_1 = require("@stepzen/transpiler");
 const curl_parser_1 = require("../shared/curl-parser");
+const path_params_parser_1 = require("../shared/path-params-parser");
 const constants_1 = require("../shared/constants");
 const errors_2 = require("../shared/errors");
-exports.curl2sdl = async ({ argv, name, source, queryName, rootType, typePrefix, }) => {
-    let json;
-    const curlArgs = curl_parser_1.parseCurlArgv(argv);
+exports.askCurlQuestions = async (defaultAnswers = {}) => {
+    let questions = [
+        {
+            name: 'url',
+            message: 'Endpoint URL or a full curl command',
+        },
+        {
+            name: 'pathParams',
+            message: 'Parameters for endpoint URL path',
+        },
+        {
+            name: 'queryName',
+            message: 'Query name to use when generating schema (leave blank to use defaults)',
+        },
+        {
+            name: 'rootType',
+            message: 'Query type name to use when generating schema (leave blank to use defaults)',
+        },
+        {
+            name: 'typePrefix',
+            message: 'Prefix to add to all generated type name (leave blank to use defaults)',
+        },
+    ];
+    questions = questions.map(question => (Object.assign(Object.assign({}, question), { default: lodash_1.get(defaultAnswers, question.name) })));
+    const answers = await inquirer.prompt(questions);
+    const curlArgs = curl_parser_1.parseCurlArgv(string_argv_1.default(answers.url));
     if ('error' in curlArgs) {
-        throw new errors_1.CLIError(curlArgs.error);
+        console.log();
+        console.log(chalk.red('A problem occurred while parsing the curl command:\n', curlArgs.error), '\nPlease enter a URL or a supported curl command.');
+        console.log();
+        return exports.askCurlQuestions(answers);
+    }
+    const parsedPathParamsOrError = path_params_parser_1.parsePathParamsPattern(curlArgs.url, answers.pathParams);
+    if ('error' in parsedPathParamsOrError) {
+        console.log();
+        console.log(chalk.red('A problem occurred while parsing path parameters pattern:\n', parsedPathParamsOrError.error));
+        console.log();
+        console.log(`Please enter a path parameter specification that` +
+            ` can be formed by taking the original path and replacing the variable` +
+            ` segments with ${chalk.bold('$paramName')} placeholders.`);
+        console.log();
+        console.log('Example:\n' +
+            `\tendpoint URL: https://example.com/users/jane/posts/12\n ` +
+            `\tpath parameters: /users/${chalk.bold('$userId')}/posts/${chalk.bold('$postId')}`);
+        console.log();
+        return exports.askCurlQuestions(answers);
     }
+    return {
+        curlArgs,
+        queryName: answers.queryName,
+        rootType: answers.rootType,
+        typePrefix: answers.typePrefix,
+        pathParams: parsedPathParamsOrError,
+    };
+};
+exports.curl2sdl = async ({ curlArgs, name, source, queryName, rootType, typePrefix, pathParams, }) => {
+    let json;
     try {
         const url = `${constants_1.STEPZEN_JSON2SDL_SERVER_URL}/api/graphql`;
         const query = `query (
@@ -27,6 +83,9 @@ exports.curl2sdl = async ({ argv, name, source, queryName, rootType, typePrefix,
       $rootType: String
       $typePrefix: String
       $headers: [HeaderInput!]
+      $data: String
+      $method: HTTPMethod
+      $pathParams: [PathParam!]
     ) {
       getSDLFromCurl(
         command: $command
@@ -34,6 +93,9 @@ exports.curl2sdl = async ({ argv, name, source, queryName, rootType, typePrefix,
         rootType: $rootType
         typePrefix: $typePrefix
         headers: $headers
+        data: $data
+        method: $method
+        pathParams: $pathParams
       ) {
         sdl
         config
@@ -45,6 +107,9 @@ exports.curl2sdl = async ({ argv, name, source, queryName, rootType, typePrefix,
             rootType: rootType || null,
             typePrefix: typePrefix || null,
             headers: curlArgs.headers.length > 0 ? curlArgs.headers : null,
+            data: curlArgs.data || null,
+            method: curlArgs.method,
+            pathParams: pathParams.length > 0 ? pathParams : null,
         };
         debug('stepzen:curl2sdl')(url);
         debug('stepzen:curl2sdl')(query);

package/lib/hooks/prerun/check-upgrade.d.ts

@@ -1,3 +1,9 @@
 import { Hook } from '@oclif/config';
+export declare const compareMajorVersions: (v1: string, v2: string) => number | string;
+export declare const shouldCheckVersion: (version: string) => boolean;
+export declare const checkUpgrade: (version: string) => Promise<{
+    message?: string;
+    isBlocking: boolean;
+}>;
 declare const hook: Hook<'prerun'>;
 export default hook;

package/lib/hooks/prerun/check-upgrade.js

@@ -1,19 +1,56 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkUpgrade = exports.shouldCheckVersion = exports.compareMajorVersions = void 0;
 const chalk = require("chalk");
 const compareVersions = require("compare-versions");
-const shell = require("shelljs");
+const fs = require("fs-extra");
+const debug_1 = require("debug");
+const node_fetch_1 = require("node-fetch");
+const constants_1 = require("../../shared/constants");
+const errors_1 = require("../../shared/errors");
 const { version } = require('../../../package.json');
-const hook = async function () {
-    if (!shell.which('npm')) {
-        return null;
+const majorRegexp = /\d+\./;
+const timeoutBeta = 1000 * 60 * 60 * 24; // one day
+const timeoutStable = 7 * timeoutBeta; // one week
+exports.compareMajorVersions = (v1, v2) => {
+    const v1Major = v1.match(majorRegexp);
+    const v2Major = v2.match(majorRegexp);
+    if (!v1Major || !v2Major) {
+        return ('Cannot get the major from the version string ' +
+            `'${v1Major ? v2 : v1}'. Does it follow semver?`);
+    }
+    return parseInt(v1Major[0], 10) - parseInt(v2Major[0], 10);
+};
+exports.shouldCheckVersion = (version) => {
+    if (!fs.existsSync(constants_1.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP)) {
+        // always check for a new version if the file does not exist
+        return true;
+    }
+    const { mtime } = fs.statSync(constants_1.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP);
+    const threshold = version.includes('beta') ? timeoutBeta : timeoutStable;
+    return new Date().getTime() - mtime.getTime() > threshold;
+};
+exports.checkUpgrade = async (version) => {
+    if (!exports.shouldCheckVersion(version)) {
+        return { message: undefined, isBlocking: false };
+    }
+    let versions;
+    try {
+        const pkgmeta = await node_fetch_1.default('https://registry.npmjs.org/stepzen').then(r => r.json());
+        versions = pkgmeta['dist-tags'];
+    }
+    catch (error) {
+        // cannot connect to npm -> proceed
+        debug_1.default('stepzen:check-upgrade')('failed to get the stepzen version info from npm', error);
+        return { message: undefined, isBlocking: false };
     }
-    const npm = shell.exec('npm view stepzen dist-tags --json', { silent: true });
-    const versions = JSON.parse(npm);
     let beta = false;
     let latest = versions.latest;
-    let warning = '';
+    const result = {
+        message: undefined,
+        isBlocking: false,
+    };
     if (version.includes('beta')) {
         beta = true;
         latest = versions.beta;
@@ -22,23 +59,45 @@ const hook = async function () {
     if (upgradeable === -1) {
         const diff = `${chalk.grey(version)} => ${latest}`;
         if (beta) {
-            warning = `${chalk.yellow('An upgrade to the beta channel is available:')}
+            result.message = `${chalk.yellow('An upgrade to the beta channel is available:')}
 ${diff}
 ${chalk.green('npm install -g stepzen@beta')}
       `;
         }
         else {
-            warning = `${chalk.yellow('An upgrade to StepZen CLI is available:')}
+            result.message = `${chalk.yellow('An upgrade to StepZen CLI is available:')}
 ${diff}
 ${chalk.green('npm install -g stepzen')}
       `;
         }
+        const versionCmpLatest = exports.compareMajorVersions(version, latest);
+        if (typeof versionCmpLatest === 'string') {
+            debug_1.default('stepzen:check-upgrade')(versionCmpLatest);
+            result.message = errors_1.UPGRADE_CHECK_ERROR;
+            result.isBlocking = true;
+        }
+        else {
+            result.isBlocking = versionCmpLatest < 0;
+        }
+    }
+    try {
+        // update the modification time on the file
+        fs.writeFileSync(constants_1.STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP, '');
+    }
+    catch (_a) {
+        // ignore
     }
-    if (warning) {
+    return result;
+};
+const hook = async function () {
+    const { message, isBlocking } = await exports.checkUpgrade(version);
+    if (message) {
         this.log('');
-        this.log(warning.trim());
+        this.log(message.trim());
         this.log('');
-        this.exit();
+        if (isBlocking) {
+            this.exit(1);
+        }
     }
 };
 exports.default = hook;

package/lib/shared/constants.d.ts

@@ -1,4 +1,5 @@
 export declare const STEPZEN_CONFIG_DIRECTORY: string;
+export declare const STEPZEN_LAST_UPDATE_CHECK_TIMESTAMP: string;
 export declare const STEPZEN_CONFIG_FILE: string;
 export declare const STEPZEN_DOMAIN: string;
 export declare const STEPZEN_SERVER_URL: string;
@@ -10,3 +11,4 @@ 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 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_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_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_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");
@@ -12,6 +12,7 @@ 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;
 // 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');
 exports.STEPZEN_CONFIG_FILE = ENV_VAR_STEPZEN_CONFIG_FILE || 'stepzen-config.yaml';
 // The zenctl domain. Override with the env var `STEPZEN_DOMAIN`
 exports.STEPZEN_DOMAIN = ENV_VAR_STEPZEN_DOMAIN || 'stepzen.io';
@@ -31,3 +32,4 @@ exports.ADMIN_UPLOAD_URL = '/cli/admin/upload';
 exports.ADMIN_VERIFY_URL = '/cli/admin/verify';
 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.d.ts

@@ -15,10 +15,12 @@ export declare const parseCurlHeaderString: (header: string) => {
 };
 export interface CurlArguments {
     url: string;
+    method: 'Get' | 'Post';
     headers: Array<{
         name: string;
         value: string;
     }>;
+    data?: string;
 }
 export interface ParseError {
     error: string;

package/lib/shared/curl-parser.js

@@ -2,11 +2,13 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseCurlArgv = exports.parseCurlHeaderString = void 0;
+const constants_1 = require("./constants");
 // Based on the existing curl flags at https://curl.se/docs/manpage.html
 const curlFlagRegex = /^(-[a-zA-Z0-9.:#])|(--[a-zA-Z0-9.-]+)$/;
 // Based on the definition of a `token` at
 // https://datatracker.ietf.org/doc/html/rfc2616#page-17
 const httpHeaderRegex = /^(?<name>[a-zA-Z0-9!#$%&'*+,-.^_`|~]+)\s*:(?<value>.*)$/;
+const httpURLRegex = /^https?:\/\//i;
 /**
  * Parse a header string according to https://curl.se/docs/manpage.html#-H
  * and https://datatracker.ietf.org/doc/html/rfc2616#section-4.2
@@ -43,7 +45,58 @@ exports.parseCurlHeaderString = (header) => {
     };
 };
 const isAFlagArg = (arg) => curlFlagRegex.test(arg);
-const isAHeaderFlag = (flag) => ['-H', '--header'].includes(flag);
+const isAURL = (arg) => httpURLRegex.test(arg);
+const parseHeaderFlag = (argv, i, partialCurlArgs) => {
+    if (i + 1 >= argv.length) {
+        return {
+            error: `The '${argv[i]}' curl flag requires a value`,
+        };
+    }
+    const headerOrError = exports.parseCurlHeaderString(argv[i + 1]);
+    if (headerOrError && 'error' in headerOrError) {
+        return headerOrError; // error
+    }
+    const headers = partialCurlArgs.headers || [];
+    // A `null` from parseCurlHeaderString() means a header should NOT be
+    // sent. This is not supported by zenserv / the introspection service
+    // so the CLI simply omits such headers
+    if (headerOrError) {
+        headers.push(headerOrError); // header
+    }
+    return {
+        result: Object.assign(Object.assign({}, partialCurlArgs), { headers }),
+        skip: 1,
+    };
+};
+const parseDataFlag = (argv, i, partialCurlArgs) => {
+    if (i + 1 >= argv.length) {
+        return {
+            error: `The '${argv[i]}' curl flag requires a value`,
+        };
+    }
+    if (argv[i] !== '--data-raw' && argv[i + 1].charAt(0) === '@') {
+        return {
+            error: `Reading request data from local files in not currently supported ` +
+                `by StepZen CLI (${argv[i]} ${argv[i + 1]}). If this is a blocker ` +
+                `for you, please let us know on Discord (${constants_1.STEPZEN_DISCORD_URL})`,
+        };
+    }
+    const data = (partialCurlArgs.data ? partialCurlArgs.data + '&' : '') + argv[i + 1];
+    return {
+        result: Object.assign(Object.assign({}, partialCurlArgs), { data }),
+        skip: 1,
+    };
+};
+const flags = [
+    {
+        matches: ['-H', '--header'],
+        parse: parseHeaderFlag,
+    },
+    {
+        matches: ['-d', '--data', '--data-ascii', '--data-raw', '--data-binary'],
+        parse: parseDataFlag,
+    },
+];
 /**
  * Parse a curl command line arguments array to a JSON structure consumable by
  * the StepZen introspection service backend.
@@ -60,39 +113,33 @@ const isAHeaderFlag = (flag) => ['-H', '--header'].includes(flag);
  * @returns {*} a structured object with the curl arguments
  */
 exports.parseCurlArgv = (argv) => {
-    const result = {
-        url: '',
-        headers: [],
-    };
+    var _a;
+    if (((_a = argv[0]) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'curl') {
+        argv = argv.slice(1);
+    }
+    let result = {};
     for (let i = 0; i < argv.length; i++) {
         if (isAFlagArg(argv[i])) {
-            if (isAHeaderFlag(argv[i])) {
-                if (i + 1 === argv.length) {
-                    return {
-                        error: `The '${argv[i]}' curl flag requires a value`,
-                    };
+            const knownFlag = flags.find(flag => flag.matches.includes(argv[i]));
+            if (knownFlag) {
+                const resultOrError = knownFlag.parse(argv, i, result);
+                if ('error' in resultOrError) {
+                    return resultOrError; // error
                 }
-                const headerOrError = exports.parseCurlHeaderString(argv[i + 1]);
-                if (headerOrError && 'error' in headerOrError) {
-                    return headerOrError; // error
-                }
-                // A `null` from parseCurlHeaderString() means a header should NOT be
-                // sent. This is not supported by zenserv / the introspection service
-                // so the CLI simply omits such headers
-                if (headerOrError) {
-                    result.headers.push(headerOrError); // header
-                }
-                i += 1; // skip over the flag value
+                result = resultOrError.result; // result
+                i += resultOrError.skip || 0;
             }
             else {
                 return {
-                    error: `The '${argv[i]}' curl flag is not currently supported by StepZen CLI`,
+                    error: `The '${argv[i]}' curl flag is not currently supported by StepZen CLI.` +
+                        ` If this is a blocker for you, please let us know on Discord (${constants_1.STEPZEN_DISCORD_URL})`,
                 };
             }
         }
         else if (result.url) {
             return {
-                error: `Multiple URLs are not currently supported by StepZen CLI (${argv[i]})`,
+                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 {
@@ -104,5 +151,23 @@ exports.parseCurlArgv = (argv) => {
             error: 'curl: a URL is required',
         };
     }
+    if (!isAURL(result.url)) {
+        return {
+            error: `Unsupported URL schema in '${result.url}'.` +
+                ` StepZen CLI currently supports 'https' and 'http'.` +
+                ` If this is a blocker for you, please let us know on Discord (${constants_1.STEPZEN_DISCORD_URL})`,
+        };
+    }
+    result.headers = result.headers || [];
+    result.method = result.method || result.data ? 'Post' : 'Get';
+    // Add the default content-type header if the request has any data
+    // in it, and no content-type header is explicitly provided.
+    if (result.headers.findIndex(header => header.name.toLowerCase() === 'content-type') === -1 &&
+        result.data) {
+        result.headers.push({
+            name: 'content-type',
+            value: 'application/x-www-form-urlencoded',
+        });
+    }
     return result;
 };

package/lib/shared/errors.d.ts

@@ -2,3 +2,4 @@ export declare const formatTemporaryErrorMessage: (errors: ReadonlyArray<{
     message?: string;
 }>) => string;
 export declare const PERMANENT_STEPZEN_ERROR: string;
+export declare const UPGRADE_CHECK_ERROR: string;

package/lib/shared/errors.js

@@ -1,12 +1,17 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERMANENT_STEPZEN_ERROR = exports.formatTemporaryErrorMessage = void 0;
+exports.UPGRADE_CHECK_ERROR = exports.PERMANENT_STEPZEN_ERROR = exports.formatTemporaryErrorMessage = void 0;
+const constants_1 = require("./constants");
 exports.formatTemporaryErrorMessage = (errors) => `A problem occurred while processing your import${errors.length > 0 && errors[0].message ? `: "${errors[0].message}"` : ''}. Please try again.` +
     ` If the issue persists, make sure you are on the latest version of StepZen ` +
     `CLI. And if the issue still persists contact support via the StepZen discord ` +
-    `channel (https://discord.gg/9k2VdPn2FR).`;
+    `channel (${constants_1.STEPZEN_DISCORD_URL}).`;
 exports.PERMANENT_STEPZEN_ERROR = 'An unexpected problem occurred while processing your import.' +
     ` If the issue persists, make sure you are on the latest version of StepZen ` +
     `CLI. And if the issue still persists contact support via the StepZen discord ` +
-    `channel (https://discord.gg/9k2VdPn2FR).`;
+    `channel (${constants_1.STEPZEN_DISCORD_URL}).`;
+exports.UPGRADE_CHECK_ERROR = 'An unexpected problem occurred while checking for new CLI versions.' +
+    ` If the issue persists, make sure you are on the latest version of StepZen ` +
+    `CLI. And if the issue still persists contact support via the StepZen discord ` +
+    `channel (${constants_1.STEPZEN_DISCORD_URL}).`;

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

@@ -0,0 +1,7 @@
+import { ParseError } from './curl-parser';
+export declare type PathParam = {
+    index: number;
+    name: string;
+};
+export declare const formatPatternDiffWithPath: (patternSegments: readonly string[], pathSegments: readonly string[]) => string | null;
+export declare const parsePathParamsPattern: (url: string, pathParamsPattern?: string | undefined) => PathParam[] | ParseError;

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

@@ -0,0 +1,73 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePathParamsPattern = exports.formatPatternDiffWithPath = void 0;
+const chalk = require("chalk");
+const pathParamRegex = /^\$[_A-Za-z]\w*$/;
+exports.formatPatternDiffWithPath = (patternSegments, pathSegments) => {
+    let hasErrors = false;
+    const diff = [];
+    for (let i = 0; i < patternSegments.length; i++) {
+        const patternSegment = patternSegments[i];
+        if (i >= pathSegments.length) {
+            diff.push(chalk.red(`< ${patternSegment} >`));
+            hasErrors = true;
+        }
+        else if (patternSegment.charAt(0) === '$') {
+            diff.push(patternSegment);
+        }
+        else {
+            const pathSegment = pathSegments[i];
+            if (pathSegment === patternSegment) {
+                diff.push(pathSegment);
+            }
+            else {
+                diff.push(chalk.red(`< ${patternSegment} >`));
+                hasErrors = true;
+            }
+        }
+    }
+    for (let i = patternSegments.length; i < pathSegments.length; i++) {
+        diff.push(chalk.magenta(`< ${pathSegments[i]} >`));
+        hasErrors = true;
+    }
+    return hasErrors ? diff.join('/') : null;
+};
+exports.parsePathParamsPattern = (url, pathParamsPattern) => {
+    if (!pathParamsPattern) {
+        return [];
+    }
+    if (pathParamsPattern.charAt(0) === '/') {
+        pathParamsPattern = pathParamsPattern.slice(1);
+    }
+    let pathname = new URL(url).pathname;
+    if (pathname.charAt(0) === '/') {
+        pathname = pathname.slice(1);
+    }
+    const pathSegments = pathname.split('/');
+    const patternSegments = pathParamsPattern.split('/');
+    const maybeDiff = exports.formatPatternDiffWithPath(patternSegments, pathSegments);
+    if (maybeDiff) {
+        return {
+            error: `Path parameters do not align with the URL path: /${maybeDiff}`,
+        };
+    }
+    const invalidParameterSegments = patternSegments.filter(segment => segment.charAt(0) === '$' && !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).`,
+        };
+    }
+    return patternSegments
+        .map((segment, index) => ({
+        index,
+        name: segment,
+    }))
+        .filter(({ name }) => name.charAt(0) === '$')
+        .map(({ index, name }) => ({
+        index,
+        name: name.slice(1),
+    }));
+};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.10.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 schemas from stepzen","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."}},"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.11.0-beta.2","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 schemas from stepzen","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.10.0",
+  "version": "0.11.0-beta.2",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "contributors": [
@@ -119,6 +119,8 @@
     "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: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",
     "version": "oclif-dev readme && git add README.md",
     "prepare": "husky install"
   },