@knocklabs/cli 0.1.3 → 0.1.4

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.3 linux-x64 node-v18.16.0
+@knocklabs/cli/0.1.4 linux-x64 node-v18.16.1
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -70,7 +70,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with.
 ```
 
-_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.3/dist/commands/commit/index.ts)_
+_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.4/dist/commands/commit/index.ts)_
 
 ## `knock commit promote`
 
@@ -104,7 +104,7 @@ DESCRIPTION
   Display help for knock.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.11/src/commands/help.ts)_
 
 ## `knock plugins`
 
@@ -112,11 +112,14 @@ List installed plugins.
 
 ```
 USAGE
-  $ knock plugins [--core]
+  $ knock plugins [--json] [--core]
 
 FLAGS
   --core  Show core plugins.
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   List installed plugins.
 
@@ -124,7 +127,7 @@ EXAMPLES
   $ knock plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.0.1/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/index.ts)_
 
 ## `knock plugins:install PLUGIN...`
 
@@ -469,7 +472,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.3/dist/commands/whoami.ts)_
+_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.4/dist/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -574,7 +577,7 @@ FLAGS
 
 ## `knock workflow run WORKFLOWKEY`
 
-Test run a workflow using the latest version from Knock, or a local workflow directory.
+Test run a workflow using the latest version from Knock.
 
 ```
 USAGE
@@ -582,10 +585,11 @@ USAGE
     <value>] [--tenant <value>] [--data <value>]
 
 FLAGS
-  --actor=<value>          An actor id for the workflow run.
+  --actor=<value>          An actor id, or a JSON string of an actor object reference for the workflow run.
   --data=<value>           A JSON string of the data for this workflow
   --environment=<value>    [default: development] The environment in which to run the workflow
-  --recipients=<value>...  (required) One or more recipient ids for this workflow run, separated by comma.
+  --recipients=<value>     (required) One or more recipient user ids separated by comma, or a JSON string containing one
+                           or more recipient object references for this workflow run.
   --service-token=<value>  (required) The service token to authenticate with.
   --tenant=<value>         A tenant id for the workflow run.
 ```

package/dist/commands/workflow/run.js

@@ -23,26 +23,24 @@ class WorkflowRun extends _baseCommand.default {
             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);
+        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, or a local workflow directory.";
+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: _core.Flags.string({
+    recipients: (0, _flag.maybeJsonStrAsList)({
         required: true,
         aliases: [
             "recipient"
         ],
-        summary: "One or more recipient ids for this workflow run, separated by comma.",
-        multiple: true,
-        delimiter: ","
+        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: _core.Flags.string({
-        summary: "An actor id for the 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."

package/dist/lib/api-v1.js

@@ -81,13 +81,15 @@ class ApiV1 {
     }
     async runWorkflow({ args , flags  }) {
         const params = (0, _object.prune)({
-            environment: flags.environment,
+            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`, {}, {
+        return this.put(`/workflows/${args.workflowKey}/run`, data, {
             params
         });
     }

package/dist/lib/helpers/flag.js

@@ -11,11 +11,14 @@ function _export(target, all) {
 _export(exports, {
     booleanStr: ()=>booleanStr,
     dirPath: ()=>dirPath,
-    jsonStr: ()=>jsonStr
+    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();
@@ -85,3 +88,18 @@ const jsonStr = _core.Flags.custom({
         }
     }
 });
+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/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

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

@@ -106,14 +106,26 @@ const formatCategories = (workflow, opts = {})=>{
 };
 const batchStepSummaryLines = (step)=>{
     if (step.type !== _types.StepType.Batch) return [];
-    const { batch_key , batch_window: duration , batch_until_field_path: field_path , batch_order  } = step.settings;
+    const { batch_key , batch_window_type , batch_window: duration , batch_window_extension_limit , batch_until_field_path: field_path , batch_order  } = step.settings;
     return [
         batch_key && `Batch key: ${batch_key}`,
         duration && `Batch window: ${duration.value} ${duration.unit}`,
         field_path && `Batch window: "${field_path}"`,
+        `Batch window type: ${batch_window_type}`,
+        batch_window_extension_limit && `Batch window extension limit: ${batch_window_extension_limit.value} ${batch_window_extension_limit.unit}`,
         `Batch order: ${batch_order}`
     ];
 };
+const throttleStepSummaryLines = (step)=>{
+    if (step.type !== _types.StepType.Throttle) return [];
+    const { throttle_key , throttle_window: duration , throttle_window_field_path: field_path , throttle_limit  } = step.settings;
+    return [
+        throttle_key && `Throttle key: ${throttle_key}`,
+        duration && `Throttle window: ${duration.value} ${duration.unit}`,
+        field_path && `Throttle window: "${field_path}"`,
+        `Throttle limit: ${throttle_limit}`
+    ];
+};
 const delayStepSummaryLines = (step)=>{
     if (step.type !== _types.StepType.Delay) return [];
     const { delay_for: duration , delay_until_field_path: field_path  } = step.settings;
@@ -145,6 +157,7 @@ const formatStepSummary = (step)=>{
         ...batchStepSummaryLines(step),
         ...delayStepSummaryLines(step),
         ...httpFetchStepSummaryLines(step),
+        ...throttleStepSummaryLines(step),
         // Extra line between step rows to make it easier on the eye.
         " "
     ].filter((x)=>x);

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

@@ -12,4 +12,5 @@ var StepType;
     StepType["Batch"] = "batch";
     StepType["Delay"] = "delay";
     StepType["HttpFetch"] = "http_fetch";
+    StepType["Throttle"] = "throttle";
 })(StepType || (StepType = {}));

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.3",
+  "version": "0.1.4",
   "commands": {
     "knock": {
       "id": "knock",
@@ -840,7 +840,7 @@
     },
     "workflow:run": {
       "id": "workflow:run",
-      "summary": "Test run a workflow using the latest version from Knock, or a local workflow directory.",
+      "summary": "Test run a workflow using the latest version from Knock.",
       "strict": true,
       "pluginName": "@knocklabs/cli",
       "pluginAlias": "@knocklabs/cli",
@@ -871,18 +871,17 @@
         "recipients": {
           "name": "recipients",
           "type": "option",
-          "summary": "One or more recipient ids for this workflow run, separated by comma.",
+          "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.",
           "required": true,
-          "multiple": true,
+          "multiple": false,
           "aliases": [
             "recipient"
-          ],
-          "delimiter": ","
+          ]
         },
         "actor": {
           "name": "actor",
           "type": "option",
-          "summary": "An actor id for the workflow run.",
+          "summary": "An actor id, or a JSON string of an actor object reference for the workflow run.",
           "multiple": false
         },
         "tenant": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -25,20 +25,20 @@
     "date-fns": "^2.30.0",
     "enquirer": "^2.3.6",
     "fs-extra": "^11.1.1",
-    "liquidjs": "^10.7.1",
+    "liquidjs": "^10.8.3",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
-    "yup": "^1.1.1"
+    "yup": "^1.2.0"
   },
   "devDependencies": {
-    "@oclif/test": "^2.3.21",
+    "@oclif/test": "^2.3.23",
     "@swc/cli": "^0.1.62",
     "@swc/core": "^1.3.37",
     "@swc/helpers": "^0.4.14",
     "@types/chai": "^4",
     "@types/fs-extra": "^11.0.1",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.2.5",
+    "@types/node": "^20.4.1",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -51,11 +51,11 @@
     "oclif": "^3",
     "prettier": "2.8.8",
     "shx": "^0.3.4",
-    "sinon": "^15.1.0",
+    "sinon": "^15.2.0",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "tslib": "^2.5.2",
-    "typescript": "^5.0.4"
+    "tslib": "^2.5.3",
+    "typescript": "^5.1.3"
   },
   "oclif": {
     "bin": "knock",