@knocklabs/cli 0.1.7 → 0.1.8

package/dist/lib/marshal/email-layout/writer.js

@@ -20,9 +20,9 @@ const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _const = require("../../helpers/const");
 const _json = require("../../helpers/json");
-const _object = require("../../helpers/object");
-const _helpers = require("../shared/helpers");
-const _helpers1 = require("./helpers");
+const _objectIsomorphic = require("../../helpers/object.isomorphic");
+const _constIsomorphic = require("../shared/const.isomorphic");
+const _helpers = require("./helpers");
 const _reader = require("./reader");
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
@@ -96,13 +96,13 @@ function _interopRequireWildcard(obj, nodeInterop) {
     var _emailLayout___annotation;
     // Move read only field under the dedicated field "__readonly".
     const readonlyFields = ((_emailLayout___annotation = emailLayout.__annotation) === null || _emailLayout___annotation === void 0 ? void 0 : _emailLayout___annotation.readonly_fields) || [];
-    const [readonly, remainder] = (0, _object.split)(emailLayout, readonlyFields);
+    const [readonly, remainder] = (0, _objectIsomorphic.split)(emailLayout, readonlyFields);
     const emailLayoutjson = {
         ...remainder,
         __readonly: readonly
     };
     // Strip out all schema annotations, so not to expose them to end users.
-    return (0, _object.omitDeep)(emailLayoutjson, [
+    return (0, _objectIsomorphic.omitDeep)(emailLayoutjson, [
         "__annotation"
     ]);
 };
@@ -122,7 +122,7 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         }
         const promises = Object.entries(bundle).map(([relpath, fileContent])=>{
             const filePath = _nodePath.default.resolve(emailLayoutDirCtx.abspath, relpath);
-            return relpath === _helpers1.LAYOUT_JSON ? _fsExtra.outputJson(filePath, fileContent, {
+            return relpath === _helpers.LAYOUT_JSON ? _fsExtra.outputJson(filePath, fileContent, {
                 spaces: _json.DOUBLE_SPACES
             }) : _fsExtra.outputFile(filePath, fileContent);
         });
@@ -158,8 +158,8 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         if (!(0, _lodash.has)(mutRemoteEmailLayout, objPathParts)) continue;
         // If the field at this path is extracted in the local layout, then
         // always extract; otherwise extract based on the field settings default.
-        const objPathStr = _object.ObjPath.stringify(objPathParts);
-        const extractedFilePath = (0, _lodash.get)(localEmailLayout, `${objPathStr}${_helpers.FILEPATH_MARKER}`);
+        const objPathStr = _objectIsomorphic.ObjPath.stringify(objPathParts);
+        const extractedFilePath = (0, _lodash.get)(localEmailLayout, `${objPathStr}${_constIsomorphic.FILEPATH_MARKER}`);
         const { default: extractByDefault , file_ext: fileExt  } = extractionSettings;
         if (!extractedFilePath && !extractByDefault) continue;
         // By this point, we have a field where we need to extract its content.
@@ -175,13 +175,13 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         (0, _lodash.set)(bundle, [
             relpath
         ], data);
-        (0, _lodash.set)(mutRemoteEmailLayout, `${objPathStr}${_helpers.FILEPATH_MARKER}`, relpath);
+        (0, _lodash.set)(mutRemoteEmailLayout, `${objPathStr}${_constIsomorphic.FILEPATH_MARKER}`, relpath);
         (0, _lodash.unset)(mutRemoteEmailLayout, objPathStr);
     }
     // At this point the bundle contains all extractable files, so we finally add the layout
     // JSON realtive path + the file content.
     return (0, _lodash.set)(bundle, [
-        _helpers1.LAYOUT_JSON
+        _helpers.LAYOUT_JSON
     ], toEmailLayoutJson(mutRemoteEmailLayout));
 };
 const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
@@ -197,7 +197,7 @@ const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
                 type: "email_layout",
                 key: remoteEmailLayout.key,
                 abspath: emailLayoutDirPath,
-                exists: indexDirCtx.exists ? await (0, _helpers1.isEmailLayoutDir)(emailLayoutDirPath) : false
+                exists: indexDirCtx.exists ? await (0, _helpers.isEmailLayoutDir)(emailLayoutDirPath) : false
             };
             return writeEmailLayoutDirFromData(emailLayoutDirCtx, remoteEmailLayout);
         });
@@ -231,7 +231,7 @@ const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
     const promises = dirents.map(async (dirent)=>{
         const direntName = dirent.name.toLowerCase();
         const direntPath = _nodePath.default.resolve(indexDirCtx.abspath, direntName);
-        if (await (0, _helpers1.isEmailLayoutDir)(direntPath) && emailLayoutsByKey[direntName]) {
+        if (await (0, _helpers.isEmailLayoutDir)(direntPath) && emailLayoutsByKey[direntName]) {
             return;
         }
         await _fsExtra.remove(direntPath);

package/dist/lib/marshal/shared/const.isomorphic.js

@@ -0,0 +1,25 @@
+/*
+ * IMPORTANT:
+ *
+ * This file is suffixed with `.isomorphic` because the code in this file is
+ * meant to run not just in a nodejs environment but also in a browser. For this
+ * reason there are some restrictions for which nodejs imports are allowed in
+ * this module. See `.eslintrc.json` for more details.
+ */ // Mark any template fields we are extracting out with this suffix as a rule,
+// so we can reliably interpret the field value.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    FILEPATH_MARKER: ()=>FILEPATH_MARKER,
+    FILEPATH_MARKED_RE: ()=>FILEPATH_MARKED_RE
+});
+const FILEPATH_MARKER = "@";
+const FILEPATH_MARKED_RE = new RegExp(`${FILEPATH_MARKER}$`);

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

@@ -9,8 +9,6 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    FILEPATH_MARKER: ()=>FILEPATH_MARKER,
-    FILEPATH_MARKED_RE: ()=>FILEPATH_MARKED_RE,
     readExtractedFileSync: ()=>readExtractedFileSync,
     validateExtractedFilePath: ()=>validateExtractedFilePath,
     checkIfValidExtractedFilePathFormat: ()=>checkIfValidExtractedFilePathFormat
@@ -60,8 +58,6 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const FILEPATH_MARKER = "@";
-const FILEPATH_MARKED_RE = new RegExp(`${FILEPATH_MARKER}$`);
 // The following files are exepected to have valid json content, and should be
 // decoded and joined into the main JSON file.
 const DECODABLE_JSON_FILES = new Set([

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

@@ -15,8 +15,8 @@ _export(exports, {
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _lodash = require("lodash");
-const _helpers = require("../shared/helpers");
-const _helpers1 = require("./helpers");
+const _constIsomorphic = require("../shared/const.isomorphic");
+const _processorIsomorphic = require("./processor.isomorphic");
 const _types = require("./types");
 const _writer = require("./writer");
 function _getRequireWildcardCache(nodeInterop) {
@@ -119,7 +119,7 @@ const scaffoldEmailChannelStep = (refSuffix)=>{
                 layout_key: "default"
             },
             subject: "You've got mail!",
-            ["html_body" + _helpers.FILEPATH_MARKER]: templateFilePath
+            ["html_body" + _constIsomorphic.FILEPATH_MARKER]: templateFilePath
         }
     };
     const bundleFragment = {
@@ -139,7 +139,7 @@ const scaffoldInAppFeedChannelStep = (refSuffix)=>{
         channel_key: "<IN-APP-FEED CHANNEL KEY>",
         template: {
             action_url: "{{ vars.app_url }}",
-            ["markdown_body" + _helpers.FILEPATH_MARKER]: templateFilePath
+            ["markdown_body" + _constIsomorphic.FILEPATH_MARKER]: templateFilePath
         }
     };
     const bundleFragment = {
@@ -158,7 +158,7 @@ const scaffoldSmsChannelStep = (refSuffix)=>{
         type: _types.StepType.Channel,
         channel_key: "<SMS CHANNEL KEY>",
         template: {
-            ["text_body" + _helpers.FILEPATH_MARKER]: templateFilePath
+            ["text_body" + _constIsomorphic.FILEPATH_MARKER]: templateFilePath
         }
     };
     const bundleFragment = {
@@ -180,7 +180,7 @@ const scaffoldPushChannelStep = (refSuffix)=>{
             settings: {
                 delivery_type: "content"
             },
-            ["text_body" + _helpers.FILEPATH_MARKER]: templateFilePath
+            ["text_body" + _constIsomorphic.FILEPATH_MARKER]: templateFilePath
         }
     };
     const bundleFragment = {
@@ -199,7 +199,7 @@ const scaffoldChatChannelStep = (refSuffix)=>{
         type: _types.StepType.Channel,
         channel_key: "<CHAT CHANNEL KEY>",
         template: {
-            ["markdown_body" + _helpers.FILEPATH_MARKER]: templateFilePath
+            ["markdown_body" + _constIsomorphic.FILEPATH_MARKER]: templateFilePath
         }
     };
     const bundleFragment = {
@@ -264,7 +264,7 @@ const scaffoldWorkflowDirBundle = (attrs)=>{
         steps: scaffoldedSteps
     };
     return (0, _lodash.assign)({
-        [_helpers1.WORKFLOW_JSON]: workflowJson
+        [_processorIsomorphic.WORKFLOW_JSON]: workflowJson
     }, ...bundleFragments);
 };
 const generateWorkflowDir = async (workflowDirCtx, attrs)=>{

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

@@ -9,8 +9,6 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    WORKFLOW_JSON: ()=>WORKFLOW_JSON,
-    VISUAL_BLOCKS_JSON: ()=>VISUAL_BLOCKS_JSON,
     workflowJsonPath: ()=>workflowJsonPath,
     validateWorkflowKey: ()=>validateWorkflowKey,
     lsWorkflowJson: ()=>lsWorkflowJson,
@@ -26,6 +24,7 @@ const _core = require("@oclif/core");
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _string = require("../../helpers/string");
+const _processorIsomorphic = require("./processor.isomorphic");
 const _types = require("./types");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
@@ -66,9 +65,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const WORKFLOW_JSON = "workflow.json";
-const VISUAL_BLOCKS_JSON = "visual_blocks.json";
-const workflowJsonPath = (workflowDirCtx)=>_nodePath.resolve(workflowDirCtx.abspath, WORKFLOW_JSON);
+const workflowJsonPath = (workflowDirCtx)=>_nodePath.resolve(workflowDirCtx.abspath, _processorIsomorphic.WORKFLOW_JSON);
 const validateWorkflowKey = (input)=>{
     if (!(0, _string.checkSlugifiedFormat)(input, {
         onlyLowerCase: true
@@ -78,7 +75,7 @@ const validateWorkflowKey = (input)=>{
     return undefined;
 };
 const lsWorkflowJson = async (dirPath)=>{
-    const workflowJsonPath = _nodePath.resolve(dirPath, WORKFLOW_JSON);
+    const workflowJsonPath = _nodePath.resolve(dirPath, _processorIsomorphic.WORKFLOW_JSON);
     const exists = await _fsExtra.pathExists(workflowJsonPath);
     return exists ? workflowJsonPath : undefined;
 };

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 _exportStar(require("./generator"), exports);
 _exportStar(require("./helpers"), exports);
+_exportStar(require("./processor.isomorphic"), exports);
 _exportStar(require("./reader"), exports);
 _exportStar(require("./types"), exports);
 _exportStar(require("./writer"), exports);

package/dist/lib/marshal/workflow/processor.isomorphic.js

@@ -0,0 +1,272 @@
+/*
+ * IMPORTANT:
+ *
+ * This file is suffixed with `.isomorphic` because the code in this file is
+ * meant to run not just in a nodejs environment but also in a browser. For this
+ * reason there are some restrictions for which nodejs imports are allowed in
+ * this module. See `.eslintrc.json` for more details.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    WORKFLOW_JSON: ()=>WORKFLOW_JSON,
+    VISUAL_BLOCKS_JSON: ()=>VISUAL_BLOCKS_JSON,
+    buildWorkflowDirBundle: ()=>buildWorkflowDirBundle,
+    formatExtractedFilePath: ()=>formatExtractedFilePath,
+    toWorkflowJson: ()=>toWorkflowJson
+});
+const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
+const _lodash = require("lodash");
+const _objectIsomorphic = require("../../helpers/object.isomorphic");
+const _constIsomorphic = require("../shared/const.isomorphic");
+const _types = require("./types");
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const WORKFLOW_JSON = "workflow.json";
+const VISUAL_BLOCKS_JSON = "visual_blocks.json";
+/*
+ * Sanitize the workflow content into a format that's appropriate for reading
+ * and writing, by stripping out any annotation fields and handling readonly
+ * fields.
+ */ const toWorkflowJson = (workflow)=>{
+    var _workflow___annotation;
+    // Move read only fields of a workflow under the dedicated field "__readonly".
+    const readonlyFields = ((_workflow___annotation = workflow.__annotation) === null || _workflow___annotation === void 0 ? void 0 : _workflow___annotation.readonly_fields) || [];
+    const [readonly, remainder] = (0, _objectIsomorphic.split)(workflow, readonlyFields);
+    const worklfowJson = {
+        ...remainder,
+        __readonly: readonly
+    };
+    // Strip out all schema annotations, so not to expose them to end users.
+    return (0, _objectIsomorphic.omitDeep)(worklfowJson, [
+        "__annotation"
+    ]);
+};
+const formatExtractedFilePath = (objPathParts, fileExt, opts = {})=>{
+    const { unnestDirsBy =0 , nestIntoDirs =[]  } = opts;
+    // 1. Unnest the obj path parts by the given depths, if the option is given.
+    const maxUnnestableDepth = Math.min(Math.max(objPathParts.length - 1, 0), unnestDirsBy);
+    const unnestedObjPathParts = objPathParts.slice(maxUnnestableDepth, objPathParts.length);
+    // 2. Build the file path parts based on the object path parts.
+    const filePathParts = [];
+    let arrayIndexNums = [];
+    for (const part of unnestedObjPathParts){
+        if (typeof part === "string" && arrayIndexNums.length > 0) {
+            filePathParts.push([
+                ...arrayIndexNums,
+                part
+            ].join("."));
+            arrayIndexNums = [];
+            continue;
+        }
+        if (typeof part === "string") {
+            filePathParts.push(part);
+            continue;
+        }
+        if (typeof part === "number") {
+            arrayIndexNums.push(part + 1);
+            continue;
+        }
+    }
+    if (arrayIndexNums.length > 0) {
+        filePathParts.push(arrayIndexNums.join("."));
+    }
+    // 3. Format the final file path out based on the file path parts. Nest it
+    // under the directories if the option is given.
+    const fileName = filePathParts.pop();
+    const paths = [
+        ...nestIntoDirs,
+        ...filePathParts,
+        `${fileName}.${fileExt}`
+    ];
+    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)=>{
+        if ((0, _lodash.isPlainObject)(item)) {
+            const extractableFields = (0, _lodash.get)(item, [
+                "__annotation",
+                "extractable_fields"
+            ], {});
+            for (const [key, val] of Object.entries(item)){
+                // If the field we are on is extractable, then add its extraction
+                // settings to the map with the current object path.
+                if (key in extractableFields) {
+                    map.set([
+                        ...parts,
+                        key
+                    ], extractableFields[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;
+        }
+        if (Array.isArray(item)) {
+            item.map((val, idx)=>compileRecursively(val, [
+                    ...parts,
+                    idx
+                ]));
+        }
+    };
+    // Walk the node tree and compile all extractable fields by object path.
+    compileRecursively(node, objPathParts);
+    // Sort the compiled entries in desc order by the object path length, so the
+    // deepest nested fields come first and the top most fields come last because
+    // this is the order we should be extracting and replacing field contents.
+    return new Map([
+        ...map
+    ].sort((a, b)=>{
+        const aLength = a[0].length;
+        const bLength = b[0].length;
+        if (aLength < bLength) return 1;
+        if (aLength > bLength) return -1;
+        return 0;
+    }));
+};
+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);
+        // Iterate through each extractable field, determine whether we need to
+        // extract the field content in the remote workflow, and if so, perform the
+        // extraction. Note, this compiled map is ordered by the deepest nested to
+        // the top most fields, so that more than one extraction is possible.
+        for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
+            // If this step doesn't have this object path, then it's not relevant so
+            // nothing more to do here.
+            if (!(0, _lodash.has)(step, objPathParts)) continue;
+            // If the field at this path is extracted in the local workflow, then
+            // always extract; otherwise extract based on the field settings default.
+            const objPathStr = _objectIsomorphic.ObjPath.stringify(objPathParts);
+            const extractedFilePath = (0, _lodash.get)(localWorkflowStepsByRef, `${step.ref}.${objPathStr}${_constIsomorphic.FILEPATH_MARKER}`);
+            const { default: extractByDefault , file_ext: fileExt  } = extractionSettings;
+            if (!extractedFilePath && !extractByDefault) continue;
+            // By this point, we have a field where we need to extract its content.
+            // 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 = typeof extractedFilePath === "string" ? extractedFilePath : formatExtractedFilePath(objPathParts, fileExt, {
+                unnestDirsBy: 1,
+                nestIntoDirs: [
+                    step.ref
+                ]
+            });
+            // In case we are about to extract a field that has children rather than
+            // string content (e.g. visual blocks), prepare the data to strip out any
+            // annotations.
+            let data = (0, _objectIsomorphic.omitDeep)((0, _lodash.get)(step, objPathParts), [
+                "__annotation"
+            ]);
+            // Also, if the extractable data contains extracted file paths in itself
+            // then rebase those file paths to be relative to its referenced file.
+            data = (0, _objectIsomorphic.mapValuesDeep)(data, (value, key)=>{
+                if (!_constIsomorphic.FILEPATH_MARKED_RE.test(key)) return value;
+                const rebaseRootDir = _nodePath.dirname(relpath);
+                const rebasedFilePath = _nodePath.relative(rebaseRootDir, value);
+                return rebasedFilePath;
+            });
+            const content = typeof data === "string" ? data : JSON.stringify(data, null, 2);
+            // Perform the extraction by adding the content and its file path to the
+            // 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, [
+                relpath
+            ], content);
+            (0, _lodash.set)(step, `${objPathStr}${_constIsomorphic.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);
+            }
+        }
+    }
+};
+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, [
+        WORKFLOW_JSON
+    ], toWorkflowJson(mutWorkflow));
+};

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

@@ -18,9 +18,11 @@ const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _error = require("../../helpers/error");
 const _json = require("../../helpers/json");
-const _object = require("../../helpers/object");
+const _objectIsomorphic = require("../../helpers/object.isomorphic");
+const _constIsomorphic = require("../shared/const.isomorphic");
 const _helpers = require("../shared/helpers");
 const _helpers1 = require("./helpers");
+const _processorIsomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -80,21 +82,21 @@ const joinExtractedFiles = async (workflowDirCtx, workflowJson)=>{
     }).entries()){
         const currJoinedFilePaths = {};
         const prevJoinedFilePaths = joinedFilePathsPerLevel[idx - 1] || {};
-        (0, _object.mapValuesDeep)(workflowJson, (value, key, parts)=>{
+        (0, _objectIsomorphic.mapValuesDeep)(workflowJson, (value, key, parts)=>{
             // If not marked with the @ suffix, there's nothing to do.
-            if (!_helpers.FILEPATH_MARKED_RE.test(key)) return;
-            const objPathToFieldStr = _object.ObjPath.stringify(parts);
-            const inlinObjPathStr = objPathToFieldStr.replace(_helpers.FILEPATH_MARKED_RE, "");
+            if (!_constIsomorphic.FILEPATH_MARKED_RE.test(key)) return;
+            const objPathToFieldStr = _objectIsomorphic.ObjPath.stringify(parts);
+            const inlinObjPathStr = objPathToFieldStr.replace(_constIsomorphic.FILEPATH_MARKED_RE, "");
             // If there is inlined content present already, then nothing more to do.
             if ((0, _lodash.hasIn)(workflowJson, inlinObjPathStr)) return;
             // Check if the extracted path found at the current field path belongs to
             // a node whose parent or grandparent has been previously joined earlier
             // in the tree. If so, rebase the extracted path to be a relative path to
             // the workflow json.
-            const lastFound = (0, _object.getLastFound)(prevJoinedFilePaths, parts);
+            const lastFound = (0, _objectIsomorphic.getLastFound)(prevJoinedFilePaths, parts);
             const prevJoinedFilePath = typeof lastFound === "string" ? lastFound : undefined;
             const rebasedFilePath = prevJoinedFilePath ? _nodePath.join(_nodePath.dirname(prevJoinedFilePath), value) : value;
-            const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(rebasedFilePath, _nodePath.resolve(workflowDirCtx.abspath, _helpers1.WORKFLOW_JSON), uniqueFilePaths, objPathToFieldStr);
+            const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(rebasedFilePath, _nodePath.resolve(workflowDirCtx.abspath, _processorIsomorphic.WORKFLOW_JSON), uniqueFilePaths, objPathToFieldStr);
             if (invalidFilePathError) {
                 errors.push(invalidFilePathError);
                 // Wipe the invalid file path in the node so the final workflow json
@@ -143,7 +145,7 @@ const readWorkflowDir = async (workflowDirCtx, opts = {})=>{
     const result = await (0, _json.readJson)(workflowJsonPath);
     if (!result[0]) return result;
     let [workflowJson] = result;
-    workflowJson = withReadonlyField ? workflowJson : (0, _object.omitDeep)(workflowJson, [
+    workflowJson = withReadonlyField ? workflowJson : (0, _objectIsomorphic.omitDeep)(workflowJson, [
         "__readonly"
     ]);
     return withExtractedFiles ? joinExtractedFiles(workflowDirCtx, workflowJson) : [
@@ -161,7 +163,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, _helpers1.WORKFLOW_JSON);
+            const workflowJsonPath = _nodePath.resolve(workflowDirCtx.abspath, _processorIsomorphic.WORKFLOW_JSON);
             const e = new _error.SourceError((0, _error.formatErrors)(readErrors), workflowJsonPath);
             errors.push(e);
             continue;