@knocklabs/cli 0.1.4 → 0.1.6

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

@@ -10,9 +10,7 @@ function _export(target, all) {
 }
 _export(exports, {
     readWorkflowDir: ()=>readWorkflowDir,
-    readAllForCommandTarget: ()=>readAllForCommandTarget,
-    checkIfValidExtractedFilePathFormat: ()=>checkIfValidExtractedFilePathFormat,
-    readExtractedFileSync: ()=>readExtractedFileSync
+    readAllForCommandTarget: ()=>readAllForCommandTarget
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _core = require("@oclif/core");
@@ -20,9 +18,9 @@ const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _error = require("../../helpers/error");
 const _json = require("../../helpers/json");
-const _liquid = require("../../helpers/liquid");
 const _object = require("../../helpers/object");
-const _helpers = require("./helpers");
+const _helpers = require("../shared/helpers");
+const _helpers1 = require("./helpers");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -65,102 +63,6 @@ function _interopRequireWildcard(obj, nodeInterop) {
 // For now we support up to two levels of content extraction in workflow.json.
 // (e.g. workflow.json, then visual_blocks.json)
 const MAX_EXTRACTION_LEVEL = 2;
-// The following files are exepected to have valid json content, and should be
-// decoded and joined into the main workflow.json.
-const DECODABLE_JSON_FILES = new Set([
-    _helpers.VISUAL_BLOCKS_JSON
-]);
-/*
- * Validate the file path format of an extracted field. The file path must be:
- *
- * 1) Expressed as a relative path.
- *
- *    For exmaple:
- *      subject@: "email_1/subject.html"              // GOOD
- *      subject@: "./email_1/subject.html"            // GOOD
- *      subject@: "/workflow-x/email_1/subject.html"  // BAD
- *
- * 2) The resolved path must be contained inside the workflow directory
- *
- *    For exmaple (workflow-y is a different workflow dir in this example):
- *      subject@: "./email_1/subject.html"              // GOOD
- *      subject@: "../workflow-y/email_1/subject.html"  // BAD
- *
- * Note: does not validate the presence of the file nor the uniqueness of the
- * file path.
- */ const checkIfValidExtractedFilePathFormat = (relpath, sourceFileAbspath)=>{
-    if (typeof relpath !== "string") return false;
-    if (_nodePath.isAbsolute(relpath)) return false;
-    const extractedFileAbspath = _nodePath.resolve(sourceFileAbspath, relpath);
-    const pathDiff = _nodePath.relative(sourceFileAbspath, extractedFileAbspath);
-    return !pathDiff.startsWith("..");
-};
-/*
- * Validate the extracted file path based on its format and uniqueness (but not
- * the presence).
- *
- * Note, the uniqueness check is based on reading from and writing to
- * uniqueFilePaths, which is MUTATED in place.
- */ const validateExtractedFilePath = (val, workflowDirCtx, uniqueFilePaths, objPathToFieldStr)=>{
-    const workflowJsonPath = _nodePath.resolve(workflowDirCtx.abspath, _helpers.WORKFLOW_JSON);
-    // Validate the file path format, and that it is unique per workflow.
-    if (!checkIfValidExtractedFilePathFormat(val, workflowJsonPath) || typeof val !== "string" || val in uniqueFilePaths) {
-        const error = new _error.JsonDataError("must be a relative path string to a unique file within the directory", objPathToFieldStr);
-        return error;
-    }
-    // Keep track of all the valid extracted file paths that have been seen, so
-    // we can validate each file path's uniqueness as we traverse.
-    uniqueFilePaths[val] = true;
-    return undefined;
-};
-const readExtractedFileSync = (relpath, workflowDirCtx, objPathToFieldStr = "")=>{
-    // Check if the file actually exists at the given file path.
-    const abspath = _nodePath.resolve(workflowDirCtx.abspath, relpath);
-    const exists = _fsExtra.pathExistsSync(abspath);
-    if (!exists) {
-        const error = new _error.JsonDataError("must be a relative path string to a file that exists", objPathToFieldStr);
-        return [
-            undefined,
-            error
-        ];
-    }
-    // Read the file and check for valid liquid syntax given it is supported
-    // across all message templates and file extensions.
-    const contentStr = _fsExtra.readFileSync(abspath, "utf8");
-    const liquidParseError = (0, _liquid.validateLiquidSyntax)(contentStr);
-    if (liquidParseError) {
-        const error = new _error.JsonDataError(`points to a file that contains invalid liquid syntax (${relpath})\n\n` + (0, _error.formatErrors)([
-            liquidParseError
-        ], {
-            indentBy: 2
-        }), objPathToFieldStr);
-        return [
-            undefined,
-            error
-        ];
-    }
-    // If the file is expected to contain decodable json, then parse the contentStr
-    // as such.
-    const fileName = _nodePath.basename(abspath.toLowerCase());
-    const decodable = DECODABLE_JSON_FILES.has(fileName);
-    const [content, jsonParseErrors] = decodable ? (0, _json.parseJson)(contentStr) : [
-        contentStr,
-        []
-    ];
-    if (jsonParseErrors.length > 0) {
-        const error = new _error.JsonDataError(`points to a file with invalid content (${relpath})\n\n` + (0, _error.formatErrors)(jsonParseErrors, {
-            indentBy: 2
-        }), objPathToFieldStr);
-        return [
-            undefined,
-            error
-        ];
-    }
-    return [
-        content,
-        undefined
-    ];
-};
 const joinExtractedFiles = async (workflowDirCtx, workflowJson)=>{
     // Tracks any errors encountered during traversal. Mutated in place.
     const errors = [];
@@ -192,7 +94,7 @@ const joinExtractedFiles = async (workflowDirCtx, workflowJson)=>{
             const lastFound = (0, _object.getLastFound)(prevJoinedFilePaths, parts);
             const prevJoinedFilePath = typeof lastFound === "string" ? lastFound : undefined;
             const rebasedFilePath = prevJoinedFilePath ? _nodePath.join(_nodePath.dirname(prevJoinedFilePath), value) : value;
-            const invalidFilePathError = validateExtractedFilePath(rebasedFilePath, workflowDirCtx, uniqueFilePaths, objPathToFieldStr);
+            const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(rebasedFilePath, _nodePath.resolve(workflowDirCtx.abspath, _helpers1.WORKFLOW_JSON), uniqueFilePaths, objPathToFieldStr);
             if (invalidFilePathError) {
                 errors.push(invalidFilePathError);
                 // Wipe the invalid file path in the node so the final workflow json
@@ -206,7 +108,7 @@ const joinExtractedFiles = async (workflowDirCtx, workflowJson)=>{
             }
             // By this point we have a valid extracted file path, so attempt to read
             // the file at the file path.
-            const [content, readExtractedFileError] = readExtractedFileSync(rebasedFilePath, workflowDirCtx, objPathToFieldStr);
+            const [content, readExtractedFileError] = (0, _helpers.readExtractedFileSync)(rebasedFilePath, workflowDirCtx, objPathToFieldStr);
             if (readExtractedFileError) {
                 errors.push(readExtractedFileError);
                 // Replace the extracted file path with the rebased one, and set the
@@ -236,7 +138,7 @@ const readWorkflowDir = async (workflowDirCtx, opts = {})=>{
     const { withExtractedFiles =false , withReadonlyField =false  } = opts;
     const dirExists = await _fsExtra.pathExists(abspath);
     if (!dirExists) throw new Error(`${abspath} does not exist`);
-    const workflowJsonPath = await (0, _helpers.lsWorkflowJson)(abspath);
+    const workflowJsonPath = await (0, _helpers1.lsWorkflowJson)(abspath);
     if (!workflowJsonPath) throw new Error(`${abspath} is not a workflow directory`);
     const result = await (0, _json.readJson)(workflowJsonPath);
     if (!result[0]) return result;
@@ -259,7 +161,7 @@ const readWorkflowDir = async (workflowDirCtx, opts = {})=>{
         // eslint-disable-next-line no-await-in-loop
         const [workflow, readErrors] = await readWorkflowDir(workflowDirCtx, opts);
         if (readErrors.length > 0) {
-            const workflowJsonPath = _nodePath.resolve(workflowDirCtx.abspath, _helpers.WORKFLOW_JSON);
+            const workflowJsonPath = _nodePath.resolve(workflowDirCtx.abspath, _helpers1.WORKFLOW_JSON);
             const e = new _error.SourceError((0, _error.formatErrors)(readErrors), workflowJsonPath);
             errors.push(e);
             continue;
@@ -298,7 +200,7 @@ const readAllForCommandTarget = async (target, opts = {})=>{
                         type: "workflow",
                         key: dirent.name,
                         abspath,
-                        exists: await (0, _helpers.isWorkflowDir)(abspath)
+                        exists: await (0, _helpers1.isWorkflowDir)(abspath)
                     };
                     return workflowDirCtx;
                 });

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

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

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.