@knocklabs/cli 0.1.0 → 0.1.4

package/dist/commands/translation/push.js

@@ -104,6 +104,7 @@ class TranslationPush extends _baseCommand.default {
         this.log(`‣ Successfully ${actioned} ${translations.length} translation(s):\n` + (0, _string.indentString)(handledRefs.join("\n"), 4));
     }
 }
+TranslationPush.summary = "Push one or more translations from a local file system to Knock.";
 TranslationPush.flags = {
     environment: _core.Flags.string({
         summary: "Pushing a translation is only allowed in the development environment",
@@ -112,8 +113,11 @@ TranslationPush.flags = {
             _const.KnockEnv.Development
         ]
     }),
-    all: _core.Flags.boolean(),
+    all: _core.Flags.boolean({
+        summary: "Whether to push all translations from the target directory."
+    }),
     "translations-dir": _flag.dirPath({
+        summary: "The target directory path to find all translations to push.",
         dependsOn: [
             "all"
         ]
@@ -129,9 +133,9 @@ TranslationPush.flags = {
         ]
     })
 };
-TranslationPush.args = [
-    {
-        name: "translationRef",
+TranslationPush.args = {
+    translationRef: _core.Args.string({
+        description: _translation.translationRefDescription,
         required: false
-    }
-];
+    })
+};

package/dist/commands/translation/validate.js

@@ -99,24 +99,28 @@ class TranslationValidate extends _baseCommand.default {
         return errors;
     }
 }
+TranslationValidate.summary = "Validate one or more translations from a local file system.";
 TranslationValidate.flags = {
     environment: _core.Flags.string({
-        summary: "Validating a workflow is only done in the development environment",
+        summary: "Validating a translation is only done in the development environment",
         default: _const.KnockEnv.Development,
         options: [
             _const.KnockEnv.Development
         ]
     }),
-    all: _core.Flags.boolean(),
+    all: _core.Flags.boolean({
+        summary: "Whether to validate all translations from the target directory."
+    }),
     "translations-dir": _flag.dirPath({
+        summary: "The target directory path to find all translations to validate.",
         dependsOn: [
             "all"
         ]
     })
 };
-TranslationValidate.args = [
-    {
-        name: "translationRef",
+TranslationValidate.args = {
+    translationRef: _core.Args.string({
+        description: _translation.translationRefDescription,
         required: false
-    }
-];
+    })
+};

package/dist/commands/whoami.js

@@ -17,6 +17,8 @@ function _interopRequireDefault(obj) {
 class Whoami extends _baseCommand.default {
     async run() {
         const resp = await (0, _request.withSpinner)(()=>this.apiV1.whoami());
+        const { flags  } = this.props;
+        if (flags.json) return resp.data;
         this.log(`‣ Successfully verified the provided service token:`);
         const info = [
             `Account name: ${resp.data.account_name}`,
@@ -25,4 +27,5 @@ class Whoami extends _baseCommand.default {
         this.log((0, _string.indentString)(info.join("\n"), 4));
     }
 }
+Whoami.summary = "Verify the provided service token.";
 Whoami.enableJsonFlag = true;

package/dist/commands/workflow/activate.js

@@ -35,20 +35,31 @@ class WorkflowActivate extends _baseCommand.default {
         this.log(`‣ Successfully ${actioned} \`${args.workflowKey}\` workflow in \`${flags.environment}\` environment`);
     }
 }
+WorkflowActivate.summary = "Activate or deactivate a workflow in a given environment.";
+WorkflowActivate.description = `
+This immediately enables or disables a workflow in a given environment without
+needing to go through environment promotion.
+
+By default, this command activates a given workflow. Pass in the --status flag
+with \`false\` in order to deactivate it.
+`.trim();
 WorkflowActivate.flags = {
     // Do not default to any env for this command, since this action runs
     // directly in each environment outside the commit and promote flow.
     environment: _core.Flags.string({
-        required: true
+        required: true,
+        summary: "The environment to use."
     }),
     status: (0, _flag.booleanStr)({
-        default: true
+        default: true,
+        summary: "The workflow active status to set."
     }),
-    force: _core.Flags.boolean()
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
 };
-WorkflowActivate.args = [
-    {
-        name: "workflowKey",
+WorkflowActivate.args = {
+    workflowKey: _core.Args.string({
         required: true
-    }
-];
+    })
+};

package/dist/commands/workflow/get.js

@@ -102,7 +102,7 @@ class WorkflowGet extends _baseCommand.default {
                 value: (0, _date.formatDateTime)(workflow.updated_at)
             }
         ];
-        _core.CliUx.ux.table(rows, {
+        _core.ux.table(rows, {
             key: {
                 header: "Workflow",
                 minWidth: 24
@@ -113,8 +113,9 @@ class WorkflowGet extends _baseCommand.default {
             }
         });
         this.log("");
+        // Leading space is there intentionally to align the left padding.
         if (workflow.steps.length === 0) {
-            return _core.CliUx.ux.log(" This workflow has no steps to display.");
+            return _core.ux.log(" This workflow has no steps to display.");
         }
         /*
      * Workflow steps table
@@ -122,7 +123,7 @@ class WorkflowGet extends _baseCommand.default {
                 ...step,
                 index
             }));
-        _core.CliUx.ux.table(steps, {
+        _core.ux.table(steps, {
             index: {
                 header: "Steps",
                 get: (step)=>step.index + 1
@@ -146,16 +147,19 @@ class WorkflowGet extends _baseCommand.default {
         });
     }
 }
+WorkflowGet.summary = "Display a single workflow from an environment.";
 WorkflowGet.flags = {
     environment: _core.Flags.string({
-        default: "development"
+        default: "development",
+        summary: "The environment to use."
     }),
-    "hide-uncommitted-changes": _core.Flags.boolean()
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    })
 };
-WorkflowGet.args = [
-    {
-        name: "workflowKey",
+WorkflowGet.args = {
+    workflowKey: _core.Args.string({
         required: true
-    }
-];
+    })
+};
 WorkflowGet.enableJsonFlag = true;

package/dist/commands/workflow/list.js

@@ -79,7 +79,7 @@ class WorkflowList extends _baseCommand.default {
         this.log(`‣ Showing ${entries.length} workflows in \`${env}\` environment ${qualifier}\n`);
         /*
      * Workflows list table
-     */ _core.CliUx.ux.table(entries, {
+     */ _core.ux.table(entries, {
             key: {
                 header: "Key"
             },
@@ -118,11 +118,15 @@ class WorkflowList extends _baseCommand.default {
         }
     }
 }
+WorkflowList.summary = "Display all workflows for an environment.";
 WorkflowList.flags = {
     environment: _core.Flags.string({
-        default: "development"
+        default: "development",
+        summary: "The environment to use."
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
     }),
-    "hide-uncommitted-changes": _core.Flags.boolean(),
     ..._page.pageFlags
 };
 WorkflowList.enableJsonFlag = true;

package/dist/commands/workflow/new.js

@@ -125,11 +125,10 @@ WorkflowNew.flags = {
     }),
     force: _core.Flags.boolean()
 };
-WorkflowNew.args = [
-    {
-        name: "workflowKey",
+WorkflowNew.args = {
+    workflowKey: _core.Args.string({
         required: true
-    }
-];
+    })
+};
 // TODO(KNO-3072): Unhide after we move the generator logic to the backend.
 WorkflowNew.hidden = true;

package/dist/commands/workflow/pull.js

@@ -171,22 +171,30 @@ class WorkflowPull extends _baseCommand.default {
         }, workflows) : workflows;
     }
 }
+WorkflowPull.summary = "Pull one or more workflows from an environment into a local file system.";
 WorkflowPull.flags = {
     environment: _core.Flags.string({
-        default: "development"
+        default: "development",
+        summary: "The environment to use."
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to pull all workflows from the specified environment."
     }),
-    all: _core.Flags.boolean(),
     "workflows-dir": _flag.dirPath({
+        summary: "The target directory path to pull all workflows into.",
         dependsOn: [
             "all"
         ]
     }),
-    "hide-uncommitted-changes": _core.Flags.boolean(),
-    force: _core.Flags.boolean()
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    }),
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
 };
-WorkflowPull.args = [
-    {
-        name: "workflowKey",
+WorkflowPull.args = {
+    workflowKey: _core.Args.string({
         required: false
-    }
-];
+    })
+};

package/dist/commands/workflow/push.js

@@ -116,6 +116,7 @@ class WorkflowPush extends _baseCommand.default {
         this.log(`‣ Successfully ${actioned} ${workflows.length} workflow(s):\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
     }
 }
+WorkflowPush.summary = "Push one or more workflows from a local file system to Knock.";
 WorkflowPush.flags = {
     environment: _core.Flags.string({
         summary: "Pushing a workflow is only allowed in the development environment",
@@ -124,8 +125,11 @@ WorkflowPush.flags = {
             _const.KnockEnv.Development
         ]
     }),
-    all: _core.Flags.boolean(),
+    all: _core.Flags.boolean({
+        summary: "Whether to push all workflows from the target directory."
+    }),
     "workflows-dir": _flag.dirPath({
+        summary: "The target directory path to find all workflows to push.",
         dependsOn: [
             "all"
         ]
@@ -141,9 +145,8 @@ WorkflowPush.flags = {
         ]
     })
 };
-WorkflowPush.args = [
-    {
-        name: "workflowKey",
+WorkflowPush.args = {
+    workflowKey: _core.Args.string({
         required: false
-    }
-];
+    })
+};

package/dist/commands/workflow/run.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>WorkflowRun
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _flag = require("../../lib/helpers/flag");
+const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class WorkflowRun extends _baseCommand.default {
+    async run() {
+        const { args , flags  } = this.props;
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.runWorkflow(this.props), {
+            action: "‣ Running"
+        });
+        this.log(`‣ Successfully ran \`${args.workflowKey}\` workflow in \`${flags.environment}\` environment`);
+        this.log((0, _string.indentString)(`Workflow run id: ${resp.data.workflow_run_id}`, 4));
+    }
+}
+WorkflowRun.summary = "Test run a workflow using the latest version from Knock.";
+WorkflowRun.flags = {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment in which to run the workflow"
+    }),
+    recipients: (0, _flag.maybeJsonStrAsList)({
+        required: true,
+        aliases: [
+            "recipient"
+        ],
+        summary: "One or more recipient user ids separated by comma, or a JSON string containing one or more recipient object references for this workflow run."
+    }),
+    actor: (0, _flag.maybeJsonStr)({
+        summary: "An actor id, or a JSON string of an actor object reference for the workflow run."
+    }),
+    tenant: _core.Flags.string({
+        summary: "A tenant id for the workflow run."
+    }),
+    data: (0, _flag.jsonStr)({
+        summary: "A JSON string of the data for this workflow"
+    })
+};
+WorkflowRun.args = {
+    workflowKey: _core.Args.string({
+        required: true
+    })
+};

package/dist/commands/workflow/validate.js

@@ -103,6 +103,7 @@ class WorkflowValidate extends _baseCommand.default {
         return errors;
     }
 }
+WorkflowValidate.summary = "Validate one or more workflows from a local file system.";
 WorkflowValidate.flags = {
     environment: _core.Flags.string({
         summary: "Validating a workflow is only done in the development environment",
@@ -111,16 +112,18 @@ WorkflowValidate.flags = {
             _const.KnockEnv.Development
         ]
     }),
-    all: _core.Flags.boolean(),
+    all: _core.Flags.boolean({
+        summary: "Whether to validate all workflows from the target directory."
+    }),
     "workflows-dir": _flag.dirPath({
+        summary: "The target directory path to find all workflows to validate.",
         dependsOn: [
             "all"
         ]
     })
 };
-WorkflowValidate.args = [
-    {
-        name: "workflowKey",
+WorkflowValidate.args = {
+    workflowKey: _core.Args.string({
         required: false
-    }
-];
+    })
+};

package/dist/lib/api-v1.js

@@ -79,6 +79,20 @@ class ApiV1 {
             params
         });
     }
+    async runWorkflow({ args , flags  }) {
+        const params = (0, _object.prune)({
+            environment: flags.environment
+        });
+        const data = (0, _object.prune)({
+            recipients: flags.recipients,
+            tenant: flags.tenant,
+            data: flags.data,
+            actor: flags.actor
+        });
+        return this.put(`/workflows/${args.workflowKey}/run`, data, {
+            params
+        });
+    }
     // By resources: Commits
     async commitAllChanges({ flags  }) {
         const params = (0, _object.prune)({

package/dist/lib/base-command.js

@@ -60,21 +60,25 @@ class BaseCommand extends _core.Command {
         // 1. Load user's config from the config dir, as available.
         await _userConfig.default.load(this.config.configDir);
         // 2. Parse flags and args, must come after the user config load.
-        this.props = await this.parse(this.constructor);
+        const { args , flags  } = await this.parse(this.ctor);
+        this.props = {
+            args: args,
+            flags: flags
+        };
         // 3. Instantiate a knock api client.
         this.apiV1 = new _apiV1.default(this.props.flags, this.config);
         // 4. Load the run context of the invoked command.
         this.runContext = await _runContext.load(this.id);
     }
 }
-// Global flags are inherited by any command that extends BaseCommand.
-BaseCommand.globalFlags = {
+// Base flags are inherited by any command that extends BaseCommand.
+BaseCommand.baseFlags = {
     // Evaluated in the following precedence:
     // - service token flag passed into the command
     // - if not provided, fall back to env variable
     // - if not available, fall back to user config
     "service-token": _core.Flags.string({
-        summary: "The service token to authenticate with",
+        summary: "The service token to authenticate with.",
         required: true,
         multiple: false,
         env: "KNOCK_SERVICE_TOKEN",

package/dist/lib/helpers/flag.js

@@ -10,11 +10,15 @@ function _export(target, all) {
 }
 _export(exports, {
     booleanStr: ()=>booleanStr,
-    dirPath: ()=>dirPath
+    dirPath: ()=>dirPath,
+    jsonStr: ()=>jsonStr,
+    maybeJsonStr: ()=>maybeJsonStr,
+    maybeJsonStrAsList: ()=>maybeJsonStrAsList
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
+const _json = require("./json");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -74,3 +78,28 @@ const dirPath = _core.Flags.custom({
         };
     }
 });
+const jsonStr = _core.Flags.custom({
+    parse: async (input)=>{
+        try {
+            const data = JSON.parse(input);
+            return data;
+        } catch  {
+            throw new Error(`${input} is not a valid JSON string.`);
+        }
+    }
+});
+const maybeJsonStr = _core.Flags.custom({
+    parse: async (input)=>{
+        return (0, _json.tryJsonParse)(input);
+    }
+});
+const maybeJsonStrAsList = _core.Flags.custom({
+    parse: async (input)=>{
+        const data = (0, _json.tryJsonParse)(input);
+        if (typeof data === "string") return data.split(",");
+        if (Array.isArray(data)) return data;
+        return [
+            data
+        ];
+    }
+});

package/dist/lib/helpers/json.js

@@ -11,6 +11,7 @@ function _export(target, all) {
 _export(exports, {
     DOUBLE_SPACES: ()=>DOUBLE_SPACES,
     parseJson: ()=>parseJson,
+    tryJsonParse: ()=>tryJsonParse,
     readJson: ()=>readJson
 });
 const _jsonlint = /*#__PURE__*/ _interopRequireWildcard(require("@prantlf/jsonlint"));
@@ -71,6 +72,14 @@ const parseJson = (json)=>{
         errors
     ];
 };
+const tryJsonParse = (maybeJson)=>{
+    try {
+        const data = JSON.parse(maybeJson);
+        return data;
+    } catch  {
+        return maybeJson;
+    }
+};
 const readJson = async (filePath)=>{
     const json = await _fsExtra.readFile(filePath, "utf8");
     return parseJson(json);

package/dist/lib/helpers/page.js

@@ -28,9 +28,14 @@ function _interopRequireDefault(obj) {
 }
 const MAX_PAGINATION_LIMIT = 100;
 const pageFlags = {
-    after: _core.Flags.string(),
-    before: _core.Flags.string(),
+    after: _core.Flags.string({
+        summary: "The cursor after which to fetch the next page."
+    }),
+    before: _core.Flags.string({
+        summary: "The cursor before which to fetch the previous page."
+    }),
     limit: _core.Flags.integer({
+        summary: "The total number of entries to fetch per page.",
         max: MAX_PAGINATION_LIMIT
     })
 };

package/dist/lib/helpers/request.js

@@ -38,7 +38,7 @@ const withSpinner = async (requestFn, opts = {})=>{
     // Error out before the action stop so the spinner can update accordingly.
     if (ensureSuccess && !isSuccessResp(resp)) {
         const message = formatErrorRespMessage(resp);
-        _core.CliUx.ux.error(new _error.ApiError(message));
+        _core.ux.error(new _error.ApiError(message));
     }
     _ux.spinner.stop();
     return resp;

package/dist/lib/helpers/ux.js

@@ -34,9 +34,9 @@ const promptToConfirm = async (message)=>{
 };
 const spinner = {
     start (action) {
-        if (!_const.isTestEnv) _core.CliUx.ux.action.start(action);
+        if (!_const.isTestEnv) _core.ux.action.start(action);
     },
     stop () {
-        _core.CliUx.ux.action.stop();
+        _core.ux.action.stop();
     }
 };

package/dist/lib/marshal/translation/helpers.js

@@ -9,6 +9,7 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    translationRefDescription: ()=>translationRefDescription,
     formatLanguage: ()=>formatLanguage,
     formatRef: ()=>formatRef,
     isValidLocale: ()=>isValidLocale,
@@ -67,6 +68,11 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
+const translationRefDescription = `
+Translation ref is a identifier string that refers to a unique translation.
+If a translation has no namespace, it is the same as the locale, e.g. \`en\`.
+If namespaced, it is formatted as namespace.locale, e.g. \`admin.en\`.
+`.trim();
 const formatLanguage = (translation)=>{
     const lang = _localeCodes.default.getByTag(translation.locale_code);
     return lang.location ? `${lang.name}, ${lang.location}` : lang.name;
@@ -113,11 +119,11 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     const { commandId , resourceDir: resourceDirCtx , cwd: runCwd  } = runContext;
     // Error, trying to run the command not in a translation directory.
     if (resourceDirCtx && resourceDirCtx.type !== "translation") {
-        return _core.CliUx.ux.error(`Cannot run ${commandId} inside a ${resourceDirCtx.type} directory`);
+        return _core.ux.error(`Cannot run ${commandId} inside a ${resourceDirCtx.type} directory`);
     }
     // Error, got neither the translationRef arg nor the --all flag.
     if (!args.translationRef && !flags.all) {
-        _core.CliUx.ux.error("At least one of translation ref arg or --all flag must be given");
+        _core.ux.error("At least one of translation ref arg or --all flag must be given");
     }
     // No translationRef arg, which means --all flag is used.
     if (!args.translationRef) {
@@ -143,12 +149,12 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     // From this point on, we have translationRef so parse and validate the format.
     const parsedRef = parseTranslationRef(args.translationRef);
     if (!parsedRef) {
-        return _core.CliUx.ux.error(`Invalid translation ref \`${args.translationRef}\`, use valid <locale> or <namespace>.<locale> for namespaced translations`);
+        return _core.ux.error(`Invalid translation ref \`${args.translationRef}\`, use valid <locale> or <namespace>.<locale> for namespaced translations`);
     }
     const { localeCode , namespace  } = parsedRef;
     // If we are in the translation dir, make sure the locale matches.
     if (resourceDirCtx && resourceDirCtx.key !== localeCode) {
-        return _core.CliUx.ux.error(`Cannot run ${commandId} with \`${args.translationRef}\` inside a ${resourceDirCtx.key} directory`);
+        return _core.ux.error(`Cannot run ${commandId} with \`${args.translationRef}\` inside a ${resourceDirCtx.key} directory`);
     }
     const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodePath.resolve(runCwd, localeCode);
     // Got translationRef arg but no --all flag, which means target only a single
@@ -163,7 +169,7 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     // From this point on, we have both translationRef and --all flag used
     // together, so make sure we are targeting a non-namespaced top-level locale.
     if (namespace) {
-        return _core.CliUx.ux.error(`Cannot use --all with a namespaced translation \`${args.translationRef}\``);
+        return _core.ux.error(`Cannot use --all with a namespaced translation \`${args.translationRef}\``);
     }
     const translationDirCtx = {
         type: "translation",

package/dist/lib/marshal/translation/reader.js

@@ -92,7 +92,7 @@ const readAllForCommandTarget = async (target)=>{
     const { type: targetType , context: targetCtx  } = target;
     if (!targetCtx.exists) {
         const subject = targetType === "translationFile" ? "a translation file at" : "translation files in";
-        return _core.CliUx.ux.error(`Cannot locate ${subject} \`${targetCtx.abspath}\``);
+        return _core.ux.error(`Cannot locate ${subject} \`${targetCtx.abspath}\``);
     }
     switch(targetType){
         case "translationFile":

package/dist/lib/marshal/workflow/generator.js

@@ -80,6 +80,7 @@ const scaffoldBatchStep = (refSuffix)=>{
         type: _types.StepType.Batch,
         settings: {
             batch_order: "asc",
+            batch_window_type: "sliding",
             batch_window: {
                 unit: "seconds",
                 value: 30