@knocklabs/cli 0.1.8 → 0.1.10

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.8 linux-x64 node-v18.18.2
+@knocklabs/cli/0.1.10 linux-x64 node-v18.19.0
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -77,7 +77,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/commit/index.ts)_
+_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/index.ts)_
 
 ## `knock commit get ID`
 
@@ -94,7 +94,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/commit/get.ts)_
+_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/get.ts)_
 
 ## `knock commit list`
 
@@ -118,7 +118,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/commit/list.ts)_
+_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/list.ts)_
 
 ## `knock commit promote`
 
@@ -135,7 +135,7 @@ FLAGS
   --to=<value>             The destination environment to promote all changes from the preceding environment.
 ```
 
-_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/commit/promote.ts)_
+_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/promote.ts)_
 
 ## `knock help [COMMANDS]`
 
@@ -175,7 +175,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/layout/get.ts)_
+_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/get.ts)_
 
 ## `knock layout list`
 
@@ -198,7 +198,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/layout/list.ts)_
+_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/list.ts)_
 
 ## `knock layout pull [EMAILLAYOUTKEY]`
 
@@ -218,7 +218,7 @@ FLAGS
   --service-token=<value>     (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/layout/pull.ts)_
+_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/pull.ts)_
 
 ## `knock layout push [EMAILLAYOUTKEY]`
 
@@ -240,7 +240,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/layout/push.ts)_
+_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/push.ts)_
 
 ## `knock layout validate [EMAILLAYOUTKEY]`
 
@@ -259,7 +259,7 @@ FLAGS
   --service-token=<value>  (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/layout/validate.ts)_
+_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/validate.ts)_
 
 ## `knock plugins`
 
@@ -531,7 +531,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/translation/get.ts)_
+_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/get.ts)_
 
 ## `knock translation list`
 
@@ -554,7 +554,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/translation/list.ts)_
+_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/list.ts)_
 
 ## `knock translation pull [TRANSLATIONREF]`
 
@@ -579,7 +579,7 @@ FLAGS
   --translations-dir=<value>  The target directory path to pull all translations into.
 ```
 
-_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/translation/pull.ts)_
+_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/pull.ts)_
 
 ## `knock translation push [TRANSLATIONREF]`
 
@@ -606,7 +606,7 @@ FLAGS
   --translations-dir=<value>    The target directory path to find all translations to push.
 ```
 
-_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/translation/push.ts)_
+_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/push.ts)_
 
 ## `knock translation validate [TRANSLATIONREF]`
 
@@ -631,7 +631,7 @@ FLAGS
   --translations-dir=<value>  The target directory path to find all translations to validate.
 ```
 
-_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/translation/validate.ts)_
+_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/validate.ts)_
 
 ## `knock whoami`
 
@@ -648,7 +648,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -675,7 +675,7 @@ DESCRIPTION
   with `false` in order to deactivate it.
 ```
 
-_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/activate.ts)_
+_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/activate.ts)_
 
 ## `knock workflow get WORKFLOWKEY`
 
@@ -695,7 +695,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/get.ts)_
+_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/get.ts)_
 
 ## `knock workflow list`
 
@@ -718,7 +718,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/list.ts)_
+_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/list.ts)_
 
 ## `knock workflow pull [WORKFLOWKEY]`
 
@@ -738,7 +738,7 @@ FLAGS
   --workflows-dir=<value>     The target directory path to pull all workflows into.
 ```
 
-_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/pull.ts)_
+_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/pull.ts)_
 
 ## `knock workflow push [WORKFLOWKEY]`
 
@@ -759,7 +759,7 @@ FLAGS
   --workflows-dir=<value>       The target directory path to find all workflows to push.
 ```
 
-_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/push.ts)_
+_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/push.ts)_
 
 ## `knock workflow run WORKFLOWKEY`
 
@@ -780,7 +780,7 @@ FLAGS
   --tenant=<value>         A tenant id for the workflow run.
 ```
 
-_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/run.ts)_
+_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/run.ts)_
 
 ## `knock workflow validate [WORKFLOWKEY]`
 
@@ -799,5 +799,5 @@ FLAGS
   --workflows-dir=<value>  The target directory path to find all workflows to validate.
 ```
 
-_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.8/src/commands/workflow/validate.ts)_
+_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/validate.ts)_
 <!-- commandsstop -->

package/dist/commands/translation/list.js

@@ -82,7 +82,7 @@ class TranslationList extends _baseCommand.default {
      */ _core.ux.table(entries, {
             ref: {
                 header: "Ref",
-                get: (entry)=>_translation.formatRef(entry)
+                get: (entry)=>_translation.formatRef(entry.locale_code, entry.namespace)
             },
             language_name: {
                 header: "Language",

package/dist/isomorphic.js

@@ -0,0 +1,50 @@
+/*
+ * IMPORTANT: You must only expose exports from isomorphic modules.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "marshal", {
+    enumerable: true,
+    get: ()=>_indexIsomorphic
+});
+const _indexIsomorphic = /*#__PURE__*/ _interopRequireWildcard(require("./lib/marshal/index.isomorphic"));
+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;
+}

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

@@ -9,7 +9,6 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    LAYOUT_JSON: ()=>LAYOUT_JSON,
     emailLayoutJsonPath: ()=>emailLayoutJsonPath,
     isEmailLayoutDir: ()=>isEmailLayoutDir,
     lsEmailLayoutJson: ()=>lsEmailLayoutJson,
@@ -18,6 +17,7 @@ _export(exports, {
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
+const _processorIsomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -57,11 +57,10 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const LAYOUT_JSON = "layout.json";
-const emailLayoutJsonPath = (layoutDirCtx)=>_nodePath.resolve(layoutDirCtx.abspath, LAYOUT_JSON);
+const emailLayoutJsonPath = (layoutDirCtx)=>_nodePath.resolve(layoutDirCtx.abspath, _processorIsomorphic.LAYOUT_JSON);
 const isEmailLayoutDir = async (dirPath)=>Boolean(await lsEmailLayoutJson(dirPath));
 const lsEmailLayoutJson = async (dirPath)=>{
-    const emailLayoutJsonPath = _nodePath.resolve(dirPath, LAYOUT_JSON);
+    const emailLayoutJsonPath = _nodePath.resolve(dirPath, _processorIsomorphic.LAYOUT_JSON);
     const exists = await _fsExtra.pathExists(emailLayoutJsonPath);
     return exists ? emailLayoutJsonPath : undefined;
 };

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _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/email-layout/processor.isomorphic.js

@@ -0,0 +1,93 @@
+"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, {
+    LAYOUT_JSON: ()=>LAYOUT_JSON,
+    buildEmailLayoutDirBundle: ()=>buildEmailLayoutDirBundle,
+    toEmailLayoutJson: ()=>toEmailLayoutJson
+});
+const _lodash = require("lodash");
+const _objectIsomorphic = require("../../helpers/object.isomorphic");
+const _constIsomorphic = require("../shared/const.isomorphic");
+const LAYOUT_JSON = "layout.json";
+/*
+ * Sanitize the email layout content into a format that's appropriate for reading
+ * and writing, by stripping out any annotation fields and handling readonly
+ * fields.
+ */ const toEmailLayoutJson = (emailLayout)=>{
+    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, _objectIsomorphic.split)(emailLayout, readonlyFields);
+    const emailLayoutjson = {
+        ...remainder,
+        __readonly: readonly
+    };
+    // Strip out all schema annotations, so not to expose them to end users.
+    return (0, _objectIsomorphic.omitDeep)(emailLayoutjson, [
+        "__annotation"
+    ]);
+};
+const compileExtractionSettings = (emailLayout)=>{
+    const extractableFields = (0, _lodash.get)(emailLayout, [
+        "__annotation",
+        "extractable_fields"
+    ], {});
+    const map = new Map();
+    for (const [key] of Object.entries(emailLayout)){
+        // 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([
+                key
+            ], extractableFields[key]);
+        }
+    }
+    return map;
+};
+const buildEmailLayoutDirBundle = (remoteEmailLayout, localEmailLayout = {})=>{
+    const bundle = {};
+    const mutRemoteEmailLayout = (0, _lodash.cloneDeep)(remoteEmailLayout);
+    // A map of extraction settings of every field in the email layout
+    const compiledExtractionSettings = compileExtractionSettings(mutRemoteEmailLayout);
+    // Iterate through each extractable field, determine whether we need to
+    // extract the field content, and if so, perform the
+    // extraction.
+    for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
+        // If this layout doesn't have this field path, then we don't extract.
+        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 = _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.
+        const data = (0, _lodash.get)(mutRemoteEmailLayout, objPathParts);
+        const fileName = objPathParts.pop();
+        // If we have an extracted file path from the local layout, we use that.
+        // In the other case we use the default path.
+        const relpath = typeof extractedFilePath === "string" ? extractedFilePath : `${fileName}.${fileExt}`;
+        // 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.
+        (0, _lodash.set)(bundle, [
+            relpath
+        ], data);
+        (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, [
+        LAYOUT_JSON
+    ], toEmailLayoutJson(mutRemoteEmailLayout));
+};

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

@@ -22,6 +22,7 @@ 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 _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -111,7 +112,7 @@ const readAllForCommandTarget = async (target, opts = {})=>{
         // eslint-disable-next-line no-await-in-loop
         const [layout, readErrors] = await readEmailLayoutDir(layoutDirCtx, opts);
         if (readErrors.length > 0) {
-            const layoutJsonPath = _nodePath.default.resolve(layoutDirCtx.abspath, _helpers1.LAYOUT_JSON);
+            const layoutJsonPath = _nodePath.default.resolve(layoutDirCtx.abspath, _processorIsomorphic.LAYOUT_JSON);
             const e = new _error.SourceError((0, _error.formatErrors)(readErrors), layoutJsonPath);
             errors.push(e);
             continue;
@@ -162,7 +163,7 @@ const readEmailLayoutDir = async (layoutDirCtx, opts = {})=>{
         // If there is inlined content present already, then nothing more to do.
         if ((0, _lodash.hasIn)(layoutJson, inlinObjPathStr)) return;
         // Check if the extracted path found at the current field path is valid
-        const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(relpath, _nodePath.default.resolve(layoutDirCtx.abspath, _helpers1.LAYOUT_JSON), uniqueFilePaths, objPathToFieldStr);
+        const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(relpath, _nodePath.default.resolve(layoutDirCtx.abspath, _processorIsomorphic.LAYOUT_JSON), uniqueFilePaths, objPathToFieldStr);
         if (invalidFilePathError) {
             errors.push(invalidFilePathError);
             // Wipe the invalid file path in the node so the final layout json

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

@@ -11,18 +11,15 @@ function _export(target, all) {
 _export(exports, {
     writeEmailLayoutDirFromData: ()=>writeEmailLayoutDirFromData,
     writeEmailLayoutIndexDir: ()=>writeEmailLayoutIndexDir,
-    buildEmailLayoutDirBundle: ()=>buildEmailLayoutDirBundle,
-    pruneLayoutsIndexDir: ()=>pruneLayoutsIndexDir,
-    toEmailLayoutJson: ()=>toEmailLayoutJson
+    pruneLayoutsIndexDir: ()=>pruneLayoutsIndexDir
 });
 const _nodePath = /*#__PURE__*/ _interopRequireDefault(require("node:path"));
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _const = require("../../helpers/const");
 const _json = require("../../helpers/json");
-const _objectIsomorphic = require("../../helpers/object.isomorphic");
-const _constIsomorphic = require("../shared/const.isomorphic");
 const _helpers = require("./helpers");
+const _processorIsomorphic = require("./processor.isomorphic");
 const _reader = require("./reader");
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
@@ -68,51 +65,13 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-/* Traverse a given email layout data and compile extraction settings of every extractable
- * field into a sorted map.
- *
- * NOTE: Currently we do NOT support content extraction at nested levels for email layouts.
- */ const compileExtractionSettings = (emailLayout)=>{
-    const extractableFields = (0, _lodash.get)(emailLayout, [
-        "__annotation",
-        "extractable_fields"
-    ], {});
-    const map = new Map();
-    for (const [key] of Object.entries(emailLayout)){
-        // 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([
-                key
-            ], extractableFields[key]);
-        }
-    }
-    return map;
-};
-/* Sanitize the email layout content into a format that's appropriate for reading
- * and writing, by stripping out any annotation fields and handling readonly
- * fields.
- */ const toEmailLayoutJson = (emailLayout)=>{
-    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, _objectIsomorphic.split)(emailLayout, readonlyFields);
-    const emailLayoutjson = {
-        ...remainder,
-        __readonly: readonly
-    };
-    // Strip out all schema annotations, so not to expose them to end users.
-    return (0, _objectIsomorphic.omitDeep)(emailLayoutjson, [
-        "__annotation"
-    ]);
-};
 const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)=>{
     // If the layout directory exists on the file system (i.e. previously
     // pulled before), then read the layout file to use as a reference.
     const [localEmailLayout] = emailLayoutDirCtx.exists ? await (0, _reader.readEmailLayoutDir)(emailLayoutDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = buildEmailLayoutDirBundle(remoteEmailLayout, localEmailLayout);
+    const bundle = (0, _processorIsomorphic.buildEmailLayoutDirBundle)(remoteEmailLayout, localEmailLayout);
     const backupDirPath = _nodePath.default.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // We store a backup in case there's an error.
@@ -122,7 +81,7 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         }
         const promises = Object.entries(bundle).map(([relpath, fileContent])=>{
             const filePath = _nodePath.default.resolve(emailLayoutDirCtx.abspath, relpath);
-            return relpath === _helpers.LAYOUT_JSON ? _fsExtra.outputJson(filePath, fileContent, {
+            return relpath === _processorIsomorphic.LAYOUT_JSON ? _fsExtra.outputJson(filePath, fileContent, {
                 spaces: _json.DOUBLE_SPACES
             }) : _fsExtra.outputFile(filePath, fileContent);
         });
@@ -142,48 +101,6 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         await _fsExtra.remove(backupDirPath);
     }
 };
-/* For a given email layout payload, this function builds a "email layout directoy bundle".
- * This is an object which contains all the relative paths and its file content.
- * It includes the extractable fields, which are extracted out and added to the bundle as separate files.
- */ const buildEmailLayoutDirBundle = (remoteEmailLayout, localEmailLayout = {})=>{
-    const bundle = {};
-    const mutRemoteEmailLayout = (0, _lodash.cloneDeep)(remoteEmailLayout);
-    // A map of extraction settings of every field in the email layout
-    const compiledExtractionSettings = compileExtractionSettings(mutRemoteEmailLayout);
-    // Iterate through each extractable field, determine whether we need to
-    // extract the field content, and if so, perform the
-    // extraction.
-    for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
-        // If this layout doesn't have this field path, then we don't extract.
-        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 = _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.
-        const data = (0, _lodash.get)(mutRemoteEmailLayout, objPathParts);
-        const fileName = objPathParts.pop();
-        // If we have an extracted file path from the local layout, we use that. In the other
-        // case we use the default path.
-        const relpath = typeof extractedFilePath === "string" ? extractedFilePath : `${fileName}.${fileExt}`;
-        // 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.
-        (0, _lodash.set)(bundle, [
-            relpath
-        ], data);
-        (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, [
-        _helpers.LAYOUT_JSON
-    ], toEmailLayoutJson(mutRemoteEmailLayout));
-};
 const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
     const backupDirPath = _nodePath.default.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {

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

@@ -0,0 +1,20 @@
+/*
+ * IMPORTANT: You must only expose exports from isomorphic modules.
+ */ "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, {
+    buildEmailLayoutDirBundle: ()=>_processorIsomorphic.buildEmailLayoutDirBundle,
+    buildTranslationDirBundle: ()=>_processorIsomorphic1.buildTranslationDirBundle,
+    buildWorkflowDirBundle: ()=>_processorIsomorphic2.buildWorkflowDirBundle
+});
+const _processorIsomorphic = require("./email-layout/processor.isomorphic");
+const _processorIsomorphic1 = require("./translation/processor.isomorphic");
+const _processorIsomorphic2 = require("./workflow/processor.isomorphic");

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

@@ -11,7 +11,6 @@ function _export(target, all) {
 _export(exports, {
     translationRefDescription: ()=>translationRefDescription,
     formatLanguage: ()=>formatLanguage,
-    formatRef: ()=>formatRef,
     isValidLocale: ()=>isValidLocale,
     isTranslationDir: ()=>isTranslationDir,
     buildTranslationFileCtx: ()=>buildTranslationFileCtx,
@@ -24,6 +23,7 @@ const _core = require("@oclif/core");
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _localeCodes = /*#__PURE__*/ _interopRequireDefault(require("locale-codes"));
 const _fs = require("../../helpers/fs");
+const _processorIsomorphic = require("./processor.isomorphic");
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -77,15 +77,15 @@ const formatLanguage = (translation)=>{
     const lang = _localeCodes.default.getByTag(translation.locale_code);
     return lang.location ? `${lang.name}, ${lang.location}` : lang.name;
 };
-const formatRef = ({ locale_code , namespace  })=>namespace ? `${namespace}.${locale_code}` : locale_code;
 const isValidLocale = (localeCode)=>Boolean(_localeCodes.default.getByTag(localeCode));
 const isTranslationDir = (dirPath)=>{
     const locale = _nodePath.basename(dirPath);
     return isValidLocale(locale);
 };
 const buildTranslationFileCtx = async (dirPath, localeCode, namespace)=>{
-    const ref = namespace ? `${namespace}.${localeCode}` : localeCode;
-    const abspath = _nodePath.resolve(dirPath, `${ref}.json`);
+    const ref = (0, _processorIsomorphic.formatRef)(localeCode, namespace);
+    const filename = (0, _processorIsomorphic.formatFileName)(ref);
+    const abspath = _nodePath.resolve(dirPath, filename);
     const exists = await _fsExtra.pathExists(abspath);
     return {
         ref,

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _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/translation/processor.isomorphic.js

@@ -0,0 +1,33 @@
+"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, {
+    formatRef: ()=>formatRef,
+    formatFileName: ()=>formatFileName,
+    buildTranslationDirBundle: ()=>buildTranslationDirBundle
+});
+const formatRef = (localeCode, namespace)=>namespace ? `${namespace}.${localeCode}` : localeCode;
+const formatFileName = (input)=>{
+    const ref = typeof input === "string" ? input : formatRef(input.locale_code, input.namespace);
+    return `${ref}.json`;
+};
+const buildTranslationDirBundle = (input)=>{
+    if (Array.isArray(input)) {
+        const translations = input;
+        return Object.fromEntries(translations.map((translation)=>[
+                formatFileName(translation),
+                JSON.parse(translation.content)
+            ]));
+    }
+    const translation = input;
+    return {
+        [formatFileName(translation)]: JSON.parse(translation.content)
+    };
+};

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.8",
+  "version": "0.1.10",
   "commands": {
     "knock": {
       "id": "knock",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -25,19 +25,19 @@
     "date-fns": "^2.30.0",
     "enquirer": "^2.4.1",
     "fs-extra": "^11.1.1",
-    "liquidjs": "^10.9.3",
+    "liquidjs": "^10.9.4",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
-    "yup": "^1.3.2"
+    "yup": "^1.3.3"
   },
   "devDependencies": {
     "@oclif/test": "^2.5.6",
-    "@swc/cli": "^0.1.62",
+    "@swc/cli": "^0.1.63",
     "@swc/core": "^1.3.37",
     "@swc/helpers": "^0.4.14",
     "@types/chai": "^4",
-    "@types/fs-extra": "^11.0.3",
-    "@types/mocha": "^10.0.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mocha": "^10.0.6",
     "@types/node": "^20.9.0",
     "chai": "^4",
     "eslint": "^7.32.0",
@@ -47,7 +47,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "mocha": "^10",
-    "nock": "^13.3.8",
+    "nock": "^13.4.0",
     "oclif": "^3",
     "prettier": "2.8.8",
     "shx": "^0.3.4",