@knocklabs/cli 0.1.21 → 0.1.23

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

@@ -7,26 +7,26 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    buildEmailLayoutDirBundle: function() {
+    get buildEmailLayoutDirBundle () {
         return _processorisomorphic.buildEmailLayoutDirBundle;
     },
-    buildGuideDirBundle: function() {
+    get buildGuideDirBundle () {
         return _processorisomorphic1.buildGuideDirBundle;
     },
-    buildMessageTypeDirBundle: function() {
+    get buildMessageTypeDirBundle () {
         return _processorisomorphic2.buildMessageTypeDirBundle;
     },
-    buildPartialDirBundle: function() {
+    get buildPartialDirBundle () {
         return _processorisomorphic3.buildPartialDirBundle;
     },
-    buildTranslationDirBundle: function() {
+    get buildTranslationDirBundle () {
         return _processorisomorphic4.buildTranslationDirBundle;
     },
-    buildWorkflowDirBundle: function() {
+    get buildWorkflowDirBundle () {
         return _processorisomorphic5.buildWorkflowDirBundle;
     }
 });

package/dist/lib/marshal/message-type/helpers.js

@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    ensureValidCommandTarget: function() {
+    get ensureValidCommandTarget () {
         return ensureValidCommandTarget;
     },
-    isMessageTypeDir: function() {
+    get isMessageTypeDir () {
         return isMessageTypeDir;
     },
-    lsMessageTypeJson: function() {
+    get lsMessageTypeJson () {
         return lsMessageTypeJson;
     },
-    messageTypeJsonPath: function() {
+    get messageTypeJsonPath () {
         return messageTypeJsonPath;
     }
 });

package/dist/lib/marshal/message-type/processor.isomorphic.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    MESSAGE_TYPE_JSON: function() {
+    get MESSAGE_TYPE_JSON () {
         return MESSAGE_TYPE_JSON;
     },
-    buildMessageTypeDirBundle: function() {
+    get buildMessageTypeDirBundle () {
         return buildMessageTypeDirBundle;
     }
 });

package/dist/lib/marshal/message-type/reader.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    readAllForCommandTarget: function() {
+    get readAllForCommandTarget () {
         return readAllForCommandTarget;
     },
-    readMessageTypeDir: function() {
+    get readMessageTypeDir () {
         return readMessageTypeDir;
     }
 });
@@ -100,7 +100,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 };
 const readMessageTypeDir = async (messageTypeDirCtx, opts = {})=>{
     const { abspath } = messageTypeDirCtx;
-    const { withExtractedFiles = false, withReadonlyField = false } = opts;
+    const { withExtractedFiles = false } = opts;
     const dirExists = await _fsextra.pathExists(abspath);
     if (!dirExists) throw new Error(`${abspath} does not exist`);
     const messageTypeJsonPath = await (0, _helpers1.lsMessageTypeJson)(abspath);
@@ -108,7 +108,7 @@ const readMessageTypeDir = async (messageTypeDirCtx, opts = {})=>{
     const result = await (0, _json.readJson)(messageTypeJsonPath);
     if (!result[0]) return result;
     let [messageTypeJson] = result;
-    messageTypeJson = withReadonlyField ? messageTypeJson : (0, _objectisomorphic.omitDeep)(messageTypeJson, [
+    messageTypeJson = (0, _objectisomorphic.omitDeep)(messageTypeJson, [
         "__readonly"
     ]);
     return withExtractedFiles ? joinExtractedFiles(messageTypeDirCtx, messageTypeJson) : [

package/dist/lib/marshal/message-type/writer.js

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    pruneMessageTypesIndexDir: function() {
+    get pruneMessageTypesIndexDir () {
         return pruneMessageTypesIndexDir;
     },
-    writeMessageTypeDirFromData: function() {
+    get writeMessageTypeDirFromData () {
         return writeMessageTypeDirFromData;
     },
-    writeMessageTypesIndexDir: function() {
+    get writeMessageTypesIndexDir () {
         return writeMessageTypesIndexDir;
     }
 });

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

@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    ensureValidCommandTarget: function() {
+    get ensureValidCommandTarget () {
         return ensureValidCommandTarget;
     },
-    isPartialDir: function() {
+    get isPartialDir () {
         return isPartialDir;
     },
-    lsPartialJson: function() {
+    get lsPartialJson () {
         return lsPartialJson;
     },
-    partialJsonPath: function() {
+    get partialJsonPath () {
         return partialJsonPath;
     }
 });

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

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    PARTIAL_JSON: function() {
+    get PARTIAL_JSON () {
         return PARTIAL_JSON;
     },
-    buildPartialDirBundle: function() {
+    get buildPartialDirBundle () {
         return buildPartialDirBundle;
     }
 });

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

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    readAllForCommandTarget: function() {
+    get readAllForCommandTarget () {
         return readAllForCommandTarget;
     },
-    readPartialDir: function() {
+    get readPartialDir () {
         return readPartialDir;
     }
 });
@@ -100,7 +100,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 };
 const readPartialDir = async (partialDirCtx, opts = {})=>{
     const { abspath } = partialDirCtx;
-    const { withExtractedFiles = false, withReadonlyField = false } = opts;
+    const { withExtractedFiles = false } = opts;
     const dirExists = await _fsextra.pathExists(abspath);
     if (!dirExists) throw new Error(`${abspath} does not exist`);
     const partialJsonPath = await (0, _helpers1.lsPartialJson)(abspath);
@@ -108,7 +108,7 @@ const readPartialDir = async (partialDirCtx, opts = {})=>{
     const result = await (0, _json.readJson)(partialJsonPath);
     if (!result[0]) return result;
     let [partialJson] = result;
-    partialJson = withReadonlyField ? partialJson : (0, _objectisomorphic.omitDeep)(partialJson, [
+    partialJson = (0, _objectisomorphic.omitDeep)(partialJson, [
         "__readonly"
     ]);
     return withExtractedFiles ? joinExtractedFiles(partialDirCtx, partialJson) : [

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

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    prunePartialsIndexDir: function() {
+    get prunePartialsIndexDir () {
         return prunePartialsIndexDir;
     },
-    writePartialDirFromData: function() {
+    get writePartialDirFromData () {
         return writePartialDirFromData;
     },
-    writePartialsIndexDir: function() {
+    get writePartialsIndexDir () {
         return writePartialsIndexDir;
     }
 });

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

@@ -14,14 +14,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    FILEPATH_MARKED_RE: function() {
+    get FILEPATH_MARKED_RE () {
         return FILEPATH_MARKED_RE;
     },
-    FILEPATH_MARKER: function() {
+    get FILEPATH_MARKER () {
         return FILEPATH_MARKER;
     }
 });

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

@@ -8,15 +8,22 @@ Object.defineProperty(exports, "prepareResourceJson", {
         return prepareResourceJson;
     }
 });
+const _lodash = require("lodash");
 const _objectisomorphic = require("../../helpers/object.isomorphic");
+// sha and updated_at fields change too frequently, so we exclude them from resource JSON files
+const REMOVED_READONLY_FIELDS = [
+    "sha",
+    "updated_at"
+];
 const prepareResourceJson = (resource)=>{
     var _resource___annotation;
-    // Move read only field under the dedicated field "__readonly".
     const readonlyFields = ((_resource___annotation = resource.__annotation) === null || _resource___annotation === void 0 ? void 0 : _resource___annotation.readonly_fields) || [];
     const [readonly, remainder] = (0, _objectisomorphic.split)(resource, readonlyFields);
+    const filteredReadonlyFields = (0, _lodash.omit)(readonly, REMOVED_READONLY_FIELDS);
+    // Move remaining read only fields under the dedicated field "__readonly".
     const resourceJson = {
         ...remainder,
-        __readonly: readonly
+        __readonly: filteredReadonlyFields
     };
     // Strip out all schema annotations, so not to expose them to end users.
     return (0, _objectisomorphic.omitDeep)(resourceJson, [

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

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    checkIfValidExtractedFilePathFormat: function() {
+    get checkIfValidExtractedFilePathFormat () {
         return checkIfValidExtractedFilePathFormat;
     },
-    readExtractedFileSync: function() {
+    get readExtractedFileSync () {
         return readExtractedFileSync;
     },
-    validateExtractedFilePath: function() {
+    get validateExtractedFilePath () {
         return validateExtractedFilePath;
     }
 });

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

@@ -5,35 +5,35 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    SYSTEM_NAMESPACE: function() {
+    get SYSTEM_NAMESPACE () {
         return SYSTEM_NAMESPACE;
     },
-    buildTranslationFileCtx: function() {
+    get buildTranslationFileCtx () {
         return buildTranslationFileCtx;
     },
-    ensureValidCommandTarget: function() {
+    get ensureValidCommandTarget () {
         return ensureValidCommandTarget;
     },
-    formatLanguage: function() {
+    get formatLanguage () {
         return formatLanguage;
     },
-    isTranslationDir: function() {
+    get isTranslationDir () {
         return isTranslationDir;
     },
-    isValidLocale: function() {
+    get isValidLocale () {
         return isValidLocale;
     },
-    lsTranslationDir: function() {
+    get lsTranslationDir () {
         return lsTranslationDir;
     },
-    parseTranslationRef: function() {
+    get parseTranslationRef () {
         return parseTranslationRef;
     },
-    translationRefDescription: function() {
+    get translationRefDescription () {
         return translationRefDescription;
     }
 });

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

@@ -5,23 +5,23 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    DEFAULT_TRANSLATION_FORMAT: function() {
+    get DEFAULT_TRANSLATION_FORMAT () {
         return DEFAULT_TRANSLATION_FORMAT;
     },
-    SUPPORTED_TRANSLATION_FORMATS: function() {
+    get SUPPORTED_TRANSLATION_FORMATS () {
         return SUPPORTED_TRANSLATION_FORMATS;
     },
-    buildTranslationDirBundle: function() {
+    get buildTranslationDirBundle () {
         return buildTranslationDirBundle;
     },
-    formatFileName: function() {
+    get formatFileName () {
         return formatFileName;
     },
-    formatRef: function() {
+    get formatRef () {
         return formatRef;
     }
 });

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

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    writeTranslationFile: function() {
+    get writeTranslationFile () {
         return writeTranslationFile;
     },
-    writeTranslationFiles: function() {
+    get writeTranslationFiles () {
         return writeTranslationFiles;
     }
 });

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

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    generateWorkflowDir: function() {
+    get generateWorkflowDir () {
         return generateWorkflowDir;
     },
-    parseStepsInput: function() {
+    get parseStepsInput () {
         return parseStepsInput;
     },
-    scaffoldWorkflowDirBundle: function() {
+    get scaffoldWorkflowDirBundle () {
         return scaffoldWorkflowDirBundle;
     }
 });

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

@@ -5,35 +5,38 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    countSteps: function() {
+    get countSteps () {
         return countSteps;
     },
-    ensureValidCommandTarget: function() {
+    get ensureValidCommandTarget () {
         return ensureValidCommandTarget;
     },
-    formatCategories: function() {
+    get formatCategories () {
         return formatCategories;
     },
-    formatStatus: function() {
+    get formatStatus () {
         return formatStatus;
     },
-    formatStepSummary: function() {
+    get formatStepSummary () {
         return formatStepSummary;
     },
-    isWorkflowDir: function() {
+    get generateWorkflowTypes () {
+        return generateWorkflowTypes;
+    },
+    get isWorkflowDir () {
         return isWorkflowDir;
     },
-    lsWorkflowJson: function() {
+    get lsWorkflowJson () {
         return lsWorkflowJson;
     },
-    validateWorkflowKey: function() {
+    get validateWorkflowKey () {
         return validateWorkflowKey;
     },
-    workflowJsonPath: function() {
+    get workflowJsonPath () {
         return workflowJsonPath;
     }
 });
@@ -41,7 +44,9 @@ const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _lodash = require("lodash");
+const _quicktypecore = require("quicktype-core");
 const _string = require("../../helpers/string");
+const _typegen = require("../../helpers/typegen");
 const _processorisomorphic = require("./processor.isomorphic");
 const _types = require("./types");
 function _getRequireWildcardCache(nodeInterop) {
@@ -263,3 +268,41 @@ const doCountSteps = (steps)=>{
     return count;
 };
 const countSteps = (workflow)=>doCountSteps(workflow.steps);
+async function generateWorkflowTypes(workflows, targetLanguage) {
+    const validWorkflows = workflows.filter((workflow)=>workflow.trigger_data_json_schema);
+    if (validWorkflows.length === 0) {
+        return {
+            result: undefined,
+            workflows: []
+        };
+    }
+    const schemaInput = new _quicktypecore.JSONSchemaInput(new _quicktypecore.FetchingJSONSchemaStore());
+    for (const workflow of validWorkflows){
+        const pascalCaseWorkflowKey = workflow.key.split(/[_-]/).map((part)=>part.charAt(0).toUpperCase() + part.slice(1)).join("");
+        const schema = (0, _typegen.transformSchema)({
+            ...workflow.trigger_data_json_schema,
+            title: `${pascalCaseWorkflowKey}Data`
+        });
+        schemaInput.addSource({
+            name: `${pascalCaseWorkflowKey}Data`,
+            schema: JSON.stringify(schema)
+        });
+    }
+    const inputData = new _quicktypecore.InputData();
+    inputData.addInput(schemaInput);
+    const result = await (0, _quicktypecore.quicktype)({
+        inputData,
+        lang: targetLanguage,
+        allPropertiesOptional: false,
+        alphabetizeProperties: true,
+        rendererOptions: {
+            "just-types": true,
+            "no-extra-properties": true,
+            "no-optional-null": true
+        }
+    });
+    return {
+        result,
+        workflows: validWorkflows
+    };
+}

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

@@ -12,20 +12,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    VISUAL_BLOCKS_JSON: function() {
+    get VISUAL_BLOCKS_JSON () {
         return VISUAL_BLOCKS_JSON;
     },
-    WORKFLOW_JSON: function() {
+    get WORKFLOW_JSON () {
         return WORKFLOW_JSON;
     },
-    buildWorkflowDirBundle: function() {
+    get buildWorkflowDirBundle () {
         return buildWorkflowDirBundle;
     },
-    formatExtractedFilePath: function() {
+    get formatExtractedFilePath () {
         return formatExtractedFilePath;
     }
 });

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

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    readAllForCommandTarget: function() {
+    get readAllForCommandTarget () {
         return readAllForCommandTarget;
     },
-    readWorkflowDir: function() {
+    get readWorkflowDir () {
         return readWorkflowDir;
     }
 });
@@ -143,7 +143,7 @@ const joinExtractedFiles = async (workflowDirCtx, workflowJson)=>{
 };
 const readWorkflowDir = async (workflowDirCtx, opts = {})=>{
     const { abspath } = workflowDirCtx;
-    const { withExtractedFiles = false, withReadonlyField = false } = opts;
+    const { withExtractedFiles = false } = opts;
     const dirExists = await _fsextra.pathExists(abspath);
     if (!dirExists) throw new Error(`${abspath} does not exist`);
     const workflowJsonPath = await (0, _helpers1.lsWorkflowJson)(abspath);
@@ -151,7 +151,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, _objectisomorphic.omitDeep)(workflowJson, [
+    workflowJson = (0, _objectisomorphic.omitDeep)(workflowJson, [
         "__readonly"
     ]);
     return withExtractedFiles ? joinExtractedFiles(workflowDirCtx, workflowJson) : [

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

@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    pruneWorkflowsIndexDir: function() {
+    get pruneWorkflowsIndexDir () {
         return pruneWorkflowsIndexDir;
     },
-    writeWorkflowDirFromBundle: function() {
+    get writeWorkflowDirFromBundle () {
         return writeWorkflowDirFromBundle;
     },
-    writeWorkflowDirFromData: function() {
+    get writeWorkflowDirFromData () {
         return writeWorkflowDirFromData;
     },
-    writeWorkflowsIndexDir: function() {
+    get writeWorkflowsIndexDir () {
         return writeWorkflowsIndexDir;
     }
 });

package/dist/lib/resources.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get ALL_RESOURCE_TYPES () {
+        return ALL_RESOURCE_TYPES;
+    },
+    get RESOURCE_SUBDIRS () {
+        return RESOURCE_SUBDIRS;
+    }
+});
+const ALL_RESOURCE_TYPES = [
+    // Partials first, as email layouts and workflows may reference them
+    "partial",
+    // Email layouts next, as workflows with email channel steps may reference them
+    "email_layout",
+    "workflow",
+    "translation"
+];
+const RESOURCE_SUBDIRS = {
+    email_layout: "layouts",
+    partial: "partials",
+    translation: "translations",
+    workflow: "workflows"
+};