@knocklabs/cli 0.1.19 → 0.1.21

package/oclif.manifest.json

@@ -1568,6 +1568,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"
+      ]
+    },
     "workflow:activate": {
       "aliases": [],
       "args": {
@@ -1639,6 +2029,61 @@
         "activate.js"
       ]
     },
+    "workflow:generate-types": {
+      "aliases": [],
+      "args": {},
+      "description": "Generate types for all workflows in the development environment and write them to a file.",
+      "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": "Select the environment to generate types for.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-file": {
+          "name": "output-file",
+          "required": true,
+          "summary": "The output file to write the generated types to. We currently support .ts, .rb, .go, .py files only. Your file extension will determine the target language for the generated types.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "workflow:generate-types",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "workflow",
+        "generate-types.js"
+      ]
+    },
     "workflow:get": {
       "aliases": [],
       "args": {
@@ -2167,5 +2612,5 @@
       ]
     }
   },
-  "version": "0.1.19"
+  "version": "0.1.21"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -19,25 +19,26 @@
   "dependencies": {
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
-    "@prantlf/jsonlint": "^14.0.3",
-    "axios": "^1.7.3",
+    "@prantlf/jsonlint": "^14.1.0",
+    "axios": "^1.9.0",
     "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.1",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
-    "yup": "^1.4.0"
+    "quicktype-core": "^23.0.171",
+    "yup": "^1.6.1"
   },
   "devDependencies": {
     "@oclif/test": "^3",
-    "@swc/cli": "^0.4.0",
-    "@swc/core": "^1.5.7",
-    "@swc/helpers": "^0.5.12",
+    "@swc/cli": "^0.7.5",
+    "@swc/core": "^1.11.24",
+    "@swc/helpers": "^0.5.17",
     "@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.46",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -46,15 +47,15 @@
     "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",
+    "shx": "^0.4.0",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "tslib": "^2.6.3",
-    "typescript": "^5.5.4"
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
   },
   "oclif": {
     "bin": "knock",