@knocklabs/cli 0.1.19 → 0.1.20

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

@@ -76,7 +76,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 /*
  * For the given list of partial directory contexts, read each partial dir and
  * return partial directory data.
- */ const readPartialsDirs = async (partialDirCtxs, opts = {})=>{
+ */ const readPartialDirs = async (partialDirCtxs, opts = {})=>{
     const partials = [];
     const errors = [];
     for (const partialDirCtx of partialDirCtxs){
@@ -170,7 +170,7 @@ const readAllForCommandTarget = async (target, opts = {})=>{
     switch(targetType){
         case "partialDir":
             {
-                return readPartialsDirs([
+                return readPartialDirs([
                     targetCtx
                 ], opts);
             }
@@ -190,7 +190,7 @@ const readAllForCommandTarget = async (target, opts = {})=>{
                     return partialDirCtx;
                 });
                 const partialDirCtxs = (await Promise.all(promises)).filter((partialDirCtx)=>partialDirCtx.exists);
-                return readPartialsDirs(partialDirCtxs, opts);
+                return readPartialDirs(partialDirCtxs, opts);
             }
         default:
             throw new Error(`Invalid partial command target: ${target}`);

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

@@ -8,10 +8,10 @@ Object.defineProperty(exports, "PartialType", {
         return PartialType;
     }
 });
-var PartialType;
-(function(PartialType) {
+var PartialType = /*#__PURE__*/ function(PartialType) {
     PartialType["Html"] = "html";
     PartialType["Json"] = "json";
     PartialType["Markdown"] = "markdown";
     PartialType["Text"] = "text";
-})(PartialType || (PartialType = {}));
+    return PartialType;
+}({});

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

@@ -8,12 +8,12 @@ Object.defineProperty(exports, "StepType", {
         return StepType;
     }
 });
-var StepType;
-(function(StepType) {
+var StepType = /*#__PURE__*/ function(StepType) {
     StepType["Channel"] = "channel";
     StepType["Batch"] = "batch";
     StepType["Delay"] = "delay";
     StepType["HttpFetch"] = "http_fetch";
     StepType["Branch"] = "branch";
     StepType["Throttle"] = "throttle";
-})(StepType || (StepType = {}));
+    return StepType;
+}({});

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

@@ -14,6 +14,8 @@ Object.defineProperty(exports, "load", {
 });
 const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
 const _emaillayout = /*#__PURE__*/ _interop_require_wildcard(require("../marshal/email-layout"));
+const _messagetype = /*#__PURE__*/ _interop_require_wildcard(require("../marshal/message-type"));
+const _partial = /*#__PURE__*/ _interop_require_wildcard(require("../marshal/partial"));
 const _translation = /*#__PURE__*/ _interop_require_wildcard(require("../marshal/translation"));
 const _workflow = /*#__PURE__*/ _interop_require_wildcard(require("../marshal/workflow"));
 function _getRequireWildcardCache(nodeInterop) {
@@ -57,38 +59,40 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
+const buildResourceDirContext = (type, currDir)=>{
+    return {
+        type,
+        key: _nodepath.basename(currDir),
+        abspath: currDir,
+        exists: true
+    };
+};
 const evaluateRecursively = async (ctx, currDir)=>{
-    // Check if we are inside a workflow directory, and if so update the context.
-    const isWorkflowDir = await _workflow.isWorkflowDir(currDir);
-    if (!ctx.resourceDir && isWorkflowDir) {
-        ctx.resourceDir = {
-            type: "workflow",
-            key: _nodepath.basename(currDir),
-            abspath: 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.
-    const isTranslationDir = _translation.isTranslationDir(currDir);
-    if (!ctx.resourceDir && isTranslationDir) {
-        ctx.resourceDir = {
-            type: "translation",
-            key: _nodepath.basename(currDir),
-            abspath: currDir,
-            exists: true
-        };
+    // Check if we are inside a resource directory and if so update the context.
+    if (!ctx.resourceDir) {
+        const isWorkflowDir = await _workflow.isWorkflowDir(currDir);
+        if (isWorkflowDir) {
+            ctx.resourceDir = buildResourceDirContext("workflow", currDir);
+        }
+        const isEmailLayoutDir = await _emaillayout.isEmailLayoutDir(currDir);
+        if (isEmailLayoutDir) {
+            ctx.resourceDir = buildResourceDirContext("email_layout", currDir);
+        }
+        const isPartialDir = await _partial.isPartialDir(currDir);
+        if (isPartialDir) {
+            ctx.resourceDir = buildResourceDirContext("partial", currDir);
+        }
+        const isMessageTypeDir = await _messagetype.isMessageTypeDir(currDir);
+        if (isMessageTypeDir) {
+            ctx.resourceDir = buildResourceDirContext("message_type", currDir);
+        }
+        // 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.
+        const isTranslationDir = _translation.isTranslationDir(currDir);
+        if (isTranslationDir) {
+            ctx.resourceDir = buildResourceDirContext("translation", currDir);
+        }
     }
     // If we've identified the resource context, no need to go further.
     // TODO: In the future, consider supporting a knock project config file which

package/oclif.manifest.json

@@ -770,6 +770,396 @@
         "validate.js"
       ]
     },
+    "message-type:get": {
+      "aliases": [],
+      "args": {
+        "messageTypeKey": {
+          "name": "messageTypeKey",
+          "required": true
+        }
+      },
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "message-type:get",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display a single in-app message type from an environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "message-type",
+        "get.js"
+      ]
+    },
+    "message-type:list": {
+      "aliases": [],
+      "args": {},
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "after": {
+          "name": "after",
+          "summary": "The cursor after which to fetch the next page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "before": {
+          "name": "before",
+          "summary": "The cursor before which to fetch the previous page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "limit": {
+          "name": "limit",
+          "summary": "The total number of entries to fetch per page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "message-type:list",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display all in-app message types for an environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "message-type",
+        "list.js"
+      ]
+    },
+    "message-type:pull": {
+      "aliases": [],
+      "args": {
+        "messageTypeKey": {
+          "name": "messageTypeKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to pull all in-app message types from the specified environment.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "message-types-dir": {
+          "dependsOn": [
+            "all"
+          ],
+          "name": "message-types-dir",
+          "summary": "The target directory path to pull all in-app message types into.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "name": "force",
+          "summary": "Remove the confirmation prompt.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "message-type:pull",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Pull one or more in-app message types from an environment into a local file system.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "message-type",
+        "pull.js"
+      ]
+    },
+    "message-type:push": {
+      "aliases": [],
+      "args": {
+        "messageTypeKey": {
+          "name": "messageTypeKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "Pushing a message type is only allowed in the development environment",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to push all message types from the target directory.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "message-types-dir": {
+          "dependsOn": [
+            "all"
+          ],
+          "name": "message-types-dir",
+          "summary": "The target directory path to find all message types to push.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "commit": {
+          "name": "commit",
+          "summary": "Push and commit the message type(s) at the same time",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "commit-message": {
+          "char": "m",
+          "dependsOn": [
+            "commit"
+          ],
+          "name": "commit-message",
+          "summary": "Use the given value as the commit message",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "message-type:push",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Push one or more message types from a local file system to Knock.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "message-type",
+        "push.js"
+      ]
+    },
+    "message-type:validate": {
+      "aliases": [],
+      "args": {
+        "messageTypeKey": {
+          "name": "messageTypeKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "Validating a message type is only done in the development environment",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to validate all message types from the target directory.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "message-types-dir": {
+          "dependsOn": [
+            "all"
+          ],
+          "name": "message-types-dir",
+          "summary": "The target directory path to find all message types to validate.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "message-type:validate",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Validate one or more message types from a local file system.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "message-type",
+        "validate.js"
+      ]
+    },
     "partial:get": {
       "aliases": [],
       "args": {
@@ -2167,5 +2557,5 @@
       ]
     }
   },
-  "version": "0.1.19"
+  "version": "0.1.20"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.19",
+  "version": "0.1.20",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -19,12 +19,12 @@
   "dependencies": {
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
-    "@prantlf/jsonlint": "^14.0.3",
-    "axios": "^1.7.3",
+    "@prantlf/jsonlint": "^14.1.0",
+    "axios": "^1.7.9",
     "date-fns": "^2.30.0",
     "enquirer": "^2.4.1",
-    "fs-extra": "^11.2.0",
-    "liquidjs": "^10.16.1",
+    "fs-extra": "^11.3.0",
+    "liquidjs": "^10.21.0",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
     "yup": "^1.4.0"
@@ -32,12 +32,12 @@
   "devDependencies": {
     "@oclif/test": "^3",
     "@swc/cli": "^0.4.0",
-    "@swc/core": "^1.5.7",
-    "@swc/helpers": "^0.5.12",
+    "@swc/core": "^1.10.6",
+    "@swc/helpers": "^0.5.15",
     "@types/chai": "^4",
     "@types/fs-extra": "^11.0.4",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.14.14",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.17.24",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -46,14 +46,14 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "mocha": "^10",
-    "nock": "^13.5.4",
+    "nock": "^13.5.6",
     "oclif": "^4",
     "prettier": "2.8.8",
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "tslib": "^2.6.3",
+    "tslib": "^2.8.1",
     "typescript": "^5.5.4"
   },
   "oclif": {