@knocklabs/cli 0.1.3 → 0.1.5

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

@@ -23,8 +23,10 @@ const _lodash = require("lodash");
 const _const = require("../../helpers/const");
 const _json = require("../../helpers/json");
 const _object = require("../../helpers/object");
-const _helpers = require("./helpers");
+const _helpers = require("../shared/helpers");
+const _helpers1 = require("./helpers");
 const _reader = require("./reader");
+const _types = require("./types");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -121,6 +123,9 @@ const formatExtractedFilePath = (objPathParts, fileExt, opts = {})=>{
     ];
     return _nodePath.join(...paths).toLowerCase();
 };
+const NON_RECURSIVELY_TRAVERSABLE_FIELDS_FOR_EXTRACTION = new Set([
+    "branches"
+]);
 const compileExtractionSettings = (node, objPathParts = [])=>{
     const map = new Map();
     const compileRecursively = (item, parts)=>{
@@ -138,10 +143,14 @@ const compileExtractionSettings = (node, objPathParts = [])=>{
                         key
                     ], extractableFields[key]);
                 }
-                compileRecursively(val, [
-                    ...parts,
-                    key
-                ]);
+                // Recursively exam current field for any additionally extractable data
+                // within, except for disallowed fields
+                if (!NON_RECURSIVELY_TRAVERSABLE_FIELDS_FOR_EXTRACTION.has(key)) {
+                    compileRecursively(val, [
+                        ...parts,
+                        key
+                    ]);
+                }
             }
             return;
         }
@@ -167,35 +176,23 @@ const compileExtractionSettings = (node, objPathParts = [])=>{
         return 0;
     }));
 };
-/*
- * For a given workflow payload (and its local workflow reference), this function
- * builds a "workflow directory bundle", which is an obj made up of all the
- * relative file paths (within the workflow directory) and its file content to
- * write the workflow directory.
- *
- * Every workflow will always have a workflow.json file, so every bundle includes
- * it and its content at minimum. To the extent the workflow includes any
- * extractable fields, those fields content get extracted out and added to the
- * bundle.
- *
- * Important things to keep in mind re: content extraction:
- * 1. There can be multiple places in workflow json where content extraction
- *    happens.
- * 2. There can be multiple levels of content extraction happening, currently
- *    at a maximum of 2 levels.
- *
- * The way this function works and handles the content extraction is by:
- * 1. Traversing the given step node, and compiling all annotated extraction
- *    settings by the object path in the node *ordered from leaf to root*.
- * 2. Iterate over compiled extraction settings from leaf to root, and start
- *    extracting out the field as needed. In case the node that needs to be
- *    extracted out contains extracted file paths, then those file paths get
- *    rebased to relative to the referenced file.
- */ const buildWorkflowDirBundle = (remoteWorkflow, localWorkflow = {})=>{
-    const bundle = {};
-    const mutWorkflow = (0, _lodash.cloneDeep)(remoteWorkflow);
-    const localWorkflowStepsByRef = (0, _lodash.keyBy)(localWorkflow.steps || [], "ref");
-    for (const step of mutWorkflow.steps){
+const keyLocalWorkflowStepsByRef = (steps, result = {})=>{
+    if (!Array.isArray(steps)) return result;
+    for (const step of steps){
+        if (!(0, _lodash.isPlainObject)(step)) continue;
+        if (!step.ref) continue;
+        result[step.ref] = step;
+        if (step.type === _types.StepType.Branch && Array.isArray(step.branches)) {
+            for (const branch of step.branches){
+                if (!(0, _lodash.isPlainObject)(branch)) continue;
+                result = keyLocalWorkflowStepsByRef(branch.steps, result);
+            }
+        }
+    }
+    return result;
+};
+const recursivelyBuildWorkflowDirBundle = (bundle, steps, localWorkflowStepsByRef)=>{
+    for (const step of steps){
         // A compiled map of extraction settings of every field in the step where
         // we support content extraction, organized by each field's object path.
         const compiledExtractionSettings = compileExtractionSettings(step);
@@ -217,7 +214,7 @@ const compileExtractionSettings = (node, objPathParts = [])=>{
             // First figure out the relative file path (within the workflow directory)
             // for the extracted file. If already extracted in the local workflow,
             // then use that; otherwise format a new file path.
-            const relpath = extractedFilePath || formatExtractedFilePath(objPathParts, fileExt, {
+            const relpath = typeof extractedFilePath === "string" ? extractedFilePath : formatExtractedFilePath(objPathParts, fileExt, {
                 unnestDirsBy: 1,
                 nestIntoDirs: [
                     step.ref
@@ -242,6 +239,7 @@ const compileExtractionSettings = (node, objPathParts = [])=>{
             // bundle for writing to the file system later. Then replace the field
             // content with the extracted file path and mark the field as extracted
             // with @ suffix.
+            //
             // TODO: Consider guarding against an edge case, and check if the relpath
             // already exists in the bundle, and if so make the relpath unique.
             (0, _lodash.set)(bundle, [
@@ -250,10 +248,48 @@ const compileExtractionSettings = (node, objPathParts = [])=>{
             (0, _lodash.set)(step, `${objPathStr}${_helpers.FILEPATH_MARKER}`, relpath);
             (0, _lodash.unset)(step, objPathParts);
         }
+        // Lastly, recurse thru any branches that exist in the workflow tree
+        if (step.type === _types.StepType.Branch) {
+            for (const branch of step.branches){
+                recursivelyBuildWorkflowDirBundle(bundle, branch.steps, localWorkflowStepsByRef);
+            }
+        }
     }
-    // Finally, prepare the workflow data to be written into a workflow json file.
+};
+/*
+ * For a given workflow payload (and its local workflow reference), this function
+ * builds a "workflow directory bundle", which is an obj made up of all the
+ * relative file paths (within the workflow directory) and its file content to
+ * write the workflow directory.
+ *
+ * Every workflow will always have a workflow.json file, so every bundle includes
+ * it and its content at minimum. To the extent the workflow includes any
+ * extractable fields, those fields content get extracted out and added to the
+ * bundle.
+ *
+ * Important things to keep in mind re: content extraction:
+ * 1. There can be multiple places in workflow json where content extraction
+ *    happens.
+ * 2. There can be multiple levels of content extraction happening, currently
+ *    at a maximum of 2 levels.
+ *
+ * The way this function works and handles the content extraction is by:
+ * 1. Traversing the given step node, and compiling all annotated extraction
+ *    settings by the object path in the node *ordered from leaf to root*.
+ * 2. Iterate over compiled extraction settings from leaf to root, and start
+ *    extracting out the field as needed. In case the node that needs to be
+ *    extracted out contains extracted file paths, then those file paths get
+ *    rebased to relative to the referenced file.
+ */ const buildWorkflowDirBundle = (remoteWorkflow, localWorkflow = {})=>{
+    const bundle = {};
+    const mutWorkflow = (0, _lodash.cloneDeep)(remoteWorkflow);
+    const localWorkflowStepsByRef = keyLocalWorkflowStepsByRef(localWorkflow.steps);
+    // Recursively traverse the workflow step tree, mutating it and the bundle
+    // along the way
+    recursivelyBuildWorkflowDirBundle(bundle, mutWorkflow.steps, localWorkflowStepsByRef);
+    // Then, prepare the workflow data to be written into a workflow json file.
     return (0, _lodash.set)(bundle, [
-        _helpers.WORKFLOW_JSON
+        _helpers1.WORKFLOW_JSON
     ], toWorkflowJson(mutWorkflow));
 };
 const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow)=>{
@@ -274,7 +310,7 @@ const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
         }
         const promises = Object.entries(workflowDirBundle).map(([relpath, fileContent])=>{
             const filePath = _nodePath.resolve(workflowDirCtx.abspath, relpath);
-            return relpath === _helpers.WORKFLOW_JSON ? _fsExtra.outputJson(filePath, fileContent, {
+            return relpath === _helpers1.WORKFLOW_JSON ? _fsExtra.outputJson(filePath, fileContent, {
                 spaces: _json.DOUBLE_SPACES
             }) : _fsExtra.outputFile(filePath, fileContent);
         });
@@ -310,7 +346,7 @@ const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
     const promises = dirents.map(async (dirent)=>{
         const direntName = dirent.name.toLowerCase();
         const direntPath = _nodePath.resolve(indexDirCtx.abspath, direntName);
-        if (await (0, _helpers.isWorkflowDir)(direntPath) && workflowsByKey[direntName]) {
+        if (await (0, _helpers1.isWorkflowDir)(direntPath) && workflowsByKey[direntName]) {
             return;
         }
         await _fsExtra.remove(direntPath);
@@ -333,7 +369,7 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
                 type: "workflow",
                 key: workflow.key,
                 abspath: workflowDirPath,
-                exists: indexDirCtx.exists ? await (0, _helpers.isWorkflowDir)(workflowDirPath) : false
+                exists: indexDirCtx.exists ? await (0, _helpers1.isWorkflowDir)(workflowDirPath) : false
             };
             return writeWorkflowDirFromData(workflowDirCtx, workflow);
         });

package/dist/lib/run-context/loader.js

@@ -11,6 +11,7 @@ Object.defineProperty(exports, "load", {
     get: ()=>load
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
+const _emailLayout = /*#__PURE__*/ _interopRequireWildcard(require("../marshal/email-layout"));
 const _translation = /*#__PURE__*/ _interopRequireWildcard(require("../marshal/translation"));
 const _workflow = /*#__PURE__*/ _interopRequireWildcard(require("../marshal/workflow"));
 function _getRequireWildcardCache(nodeInterop) {
@@ -63,6 +64,16 @@ const evaluateRecursively = async (ctx, currDir)=>{
             exists: true
         };
     }
+    // Check if we are inside a layout directory, and if so update the context.
+    const isEmailLayoutDir = await _emailLayout.isEmailLayoutDir(currDir);
+    if (!ctx.resourceDir && isEmailLayoutDir) {
+        ctx.resourceDir = {
+            type: "email_layout",
+            key: _nodePath.basename(currDir),
+            abspath: currDir,
+            exists: true
+        };
+    }
     // NOTE: Must keep this check as last in the order of directory-type checks
     // since the `isTranslationDir` only checks that the directory name is a
     // valid locale name.

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.3",
+  "version": "0.1.5",
   "commands": {
     "knock": {
       "id": "knock",
@@ -174,6 +174,338 @@
       },
       "args": {}
     },
+    "layout:get": {
+      "id": "layout:get",
+      "summary": "Display a single email layout from an environment.",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [
+        "email-layout:get",
+        "email_layout:get"
+      ],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with.",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "summary": "The environment to use.",
+          "multiple": false,
+          "default": "development"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "type": "boolean",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": true
+        }
+      }
+    },
+    "layout:list": {
+      "id": "layout:list",
+      "summary": "Display all email layouts for an environment.",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [
+        "email-layout:list",
+        "email_layout:list"
+      ],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with.",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "summary": "The environment to use.",
+          "multiple": false,
+          "default": "development"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "type": "boolean",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false
+        },
+        "after": {
+          "name": "after",
+          "type": "option",
+          "summary": "The cursor after which to fetch the next page.",
+          "multiple": false
+        },
+        "before": {
+          "name": "before",
+          "type": "option",
+          "summary": "The cursor before which to fetch the previous page.",
+          "multiple": false
+        },
+        "limit": {
+          "name": "limit",
+          "type": "option",
+          "summary": "The total number of entries to fetch per page.",
+          "multiple": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "layout:pull": {
+      "id": "layout:pull",
+      "summary": "Pull one or more email layouts from an environment into a local file system.",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [
+        "email-layout:pull",
+        "email_layout:pull"
+      ],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with.",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "summary": "The environment to use.",
+          "multiple": false,
+          "default": "development"
+        },
+        "all": {
+          "name": "all",
+          "type": "boolean",
+          "summary": "Whether to pull all email layouts from the specified environment.",
+          "allowNo": false
+        },
+        "layouts-dir": {
+          "name": "layouts-dir",
+          "type": "option",
+          "summary": "The target directory path to pull all email layouts into.",
+          "multiple": false,
+          "dependsOn": [
+            "all"
+          ],
+          "aliases": [
+            "email-layouts-dir"
+          ]
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "type": "boolean",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "summary": "Remove the confirmation prompt.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      }
+    },
+    "layout:push": {
+      "id": "layout:push",
+      "summary": "Push one or more email layouts from a local file system to Knock.",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [
+        "email-layout:push",
+        "email_layout:push"
+      ],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with.",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "summary": "Pushing an email layout is only allowed in the development environment",
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "default": "development"
+        },
+        "all": {
+          "name": "all",
+          "type": "boolean",
+          "summary": "Whether to push all layouts from the target directory.",
+          "allowNo": false
+        },
+        "layouts-dir": {
+          "name": "layouts-dir",
+          "type": "option",
+          "summary": "The target directory path to find all layouts to push.",
+          "multiple": false,
+          "dependsOn": [
+            "all"
+          ],
+          "aliases": [
+            "email-layouts-dir"
+          ]
+        },
+        "commit": {
+          "name": "commit",
+          "type": "boolean",
+          "summary": "Push and commit the layout(s) at the same time",
+          "allowNo": false
+        },
+        "commit-message": {
+          "name": "commit-message",
+          "type": "option",
+          "char": "m",
+          "summary": "Use the given value as the commit message",
+          "multiple": false,
+          "dependsOn": [
+            "commit"
+          ]
+        }
+      },
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      }
+    },
+    "layout:validate": {
+      "id": "layout:validate",
+      "summary": "Validate one or more layouts from a local file system.",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [
+        "email-layout:validate",
+        "email_layout:validate"
+      ],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with.",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "summary": "Validating a layout is only done in the development environment",
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "default": "development"
+        },
+        "all": {
+          "name": "all",
+          "type": "boolean",
+          "summary": "Whether to validate all layouts from the target directory.",
+          "allowNo": false
+        },
+        "layouts-dir": {
+          "name": "layouts-dir",
+          "type": "option",
+          "summary": "The target directory path to find all layouts to validate.",
+          "multiple": false,
+          "dependsOn": [
+            "all"
+          ],
+          "aliases": [
+            "email-layouts-dir"
+          ]
+        }
+      },
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      }
+    },
     "translation:get": {
       "id": "translation:get",
       "summary": "Display a single translation from an environment.",
@@ -840,7 +1172,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 +1203,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.5",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -23,27 +23,27 @@
     "@prantlf/jsonlint": "^14.0.3",
     "axios": "^1.4.0",
     "date-fns": "^2.30.0",
-    "enquirer": "^2.3.6",
+    "enquirer": "^2.4.1",
     "fs-extra": "^11.1.1",
-    "liquidjs": "^10.7.1",
+    "liquidjs": "^10.8.4",
     "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",
     "eslint-config-oclif-typescript": "^1.0.3",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "mocha": "^10",
@@ -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.6.0",
+    "typescript": "^5.1.6"
   },
   "oclif": {
     "bin": "knock",
@@ -75,6 +75,9 @@
       },
       "translation": {
         "description": "Manage translation files."
+      },
+      "layout": {
+        "description": "Manage email layouts."
       }
     }
   },