@knocklabs/cli 0.1.20 → 0.1.22

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.20 linux-x64 node-v18.20.7
+@knocklabs/cli/0.1.22 linux-x64 node-v18.20.8
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -42,6 +42,8 @@ USAGE
 * [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
 * [`knock partial push [PARTIALKEY]`](#knock-partial-push-partialkey)
 * [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
+* [`knock pull`](#knock-pull)
+* [`knock push`](#knock-push)
 * [`knock translation get TRANSLATIONREF`](#knock-translation-get-translationref)
 * [`knock translation list`](#knock-translation-list)
 * [`knock translation pull [TRANSLATIONREF]`](#knock-translation-pull-translationref)
@@ -49,6 +51,7 @@ USAGE
 * [`knock translation validate [TRANSLATIONREF]`](#knock-translation-validate-translationref)
 * [`knock whoami`](#knock-whoami)
 * [`knock workflow activate WORKFLOWKEY`](#knock-workflow-activate-workflowkey)
+* [`knock workflow generate-types`](#knock-workflow-generate-types)
 * [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
 * [`knock workflow list`](#knock-workflow-list)
 * [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
@@ -73,7 +76,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.20/src/commands/commit/index.ts)_
+_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/commit/index.ts)_
 
 ## `knock commit get ID`
 
@@ -90,7 +93,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/commit/get.ts)_
+_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/commit/get.ts)_
 
 ## `knock commit list`
 
@@ -114,7 +117,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/commit/list.ts)_
+_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/commit/list.ts)_
 
 ## `knock commit promote`
 
@@ -131,7 +134,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.20/src/commands/commit/promote.ts)_
+_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/commit/promote.ts)_
 
 ## `knock help [COMMAND]`
 
@@ -151,7 +154,7 @@ DESCRIPTION
   Display help for knock.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.20/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.28/src/commands/help.ts)_
 
 ## `knock layout get EMAILLAYOUTKEY`
 
@@ -171,7 +174,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/layout/get.ts)_
+_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/layout/get.ts)_
 
 ## `knock layout list`
 
@@ -194,7 +197,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/layout/list.ts)_
+_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/layout/list.ts)_
 
 ## `knock layout pull [EMAILLAYOUTKEY]`
 
@@ -214,7 +217,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.20/src/commands/layout/pull.ts)_
+_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/layout/pull.ts)_
 
 ## `knock layout push [EMAILLAYOUTKEY]`
 
@@ -236,7 +239,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.20/src/commands/layout/push.ts)_
+_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/layout/push.ts)_
 
 ## `knock layout validate [EMAILLAYOUTKEY]`
 
@@ -255,7 +258,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.20/src/commands/layout/validate.ts)_
+_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/layout/validate.ts)_
 
 ## `knock partial get PARTIALKEY`
 
@@ -275,7 +278,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/partial/get.ts)_
+_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/partial/get.ts)_
 
 ## `knock partial list`
 
@@ -298,7 +301,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/partial/list.ts)_
+_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/partial/list.ts)_
 
 ## `knock partial pull [PARTIALKEY]`
 
@@ -318,7 +321,7 @@ FLAGS
   --service-token=<value>     (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/partial/pull.ts)_
+_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/partial/pull.ts)_
 
 ## `knock partial push [PARTIALKEY]`
 
@@ -339,7 +342,7 @@ FLAGS
       --service-token=<value>   (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/partial/push.ts)_
+_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/partial/push.ts)_
 
 ## `knock partial validate [PARTIALKEY]`
 
@@ -358,7 +361,46 @@ FLAGS
   --service-token=<value>  (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/partial/validate.ts)_
+_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/partial/validate.ts)_
+
+## `knock pull`
+
+Pull all resources from an environment into a local file system.
+
+```
+USAGE
+  $ knock pull --service-token <value> --knock-dir <value> [--environment <value>]
+    [--hide-uncommitted-changes] [--force]
+
+FLAGS
+  --environment=<value>       [default: development] The environment to use.
+  --force                     Remove the confirmation prompt.
+  --hide-uncommitted-changes  Hide any uncommitted changes.
+  --knock-dir=<value>         (required) The target directory path to pull all resources into.
+  --service-token=<value>     (required) The service token to authenticate with.
+```
+
+_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/pull.ts)_
+
+## `knock push`
+
+Push all resources from a local file system to Knock.
+
+```
+USAGE
+  $ knock push --service-token <value> --knock-dir <value> [--environment development] [-m <value>
+    --commit]
+
+FLAGS
+  -m, --commit-message=<value>  Use the given value as the commit message
+      --commit                  Push and commit the resource(s) at the same time
+      --environment=<option>    [default: development] Pushing resources is only allowed in the development environment
+                                <options: development>
+      --knock-dir=<value>       (required) The target directory path to find all resources to push.
+      --service-token=<value>   (required) The service token to authenticate with.
+```
+
+_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/push.ts)_
 
 ## `knock translation get TRANSLATIONREF`
 
@@ -385,7 +427,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/translation/get.ts)_
+_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/translation/get.ts)_
 
 ## `knock translation list`
 
@@ -408,7 +450,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/translation/list.ts)_
+_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/translation/list.ts)_
 
 ## `knock translation pull [TRANSLATIONREF]`
 
@@ -435,7 +477,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.20/src/commands/translation/pull.ts)_
+_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/translation/pull.ts)_
 
 ## `knock translation push [TRANSLATIONREF]`
 
@@ -462,7 +504,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.20/src/commands/translation/push.ts)_
+_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/translation/push.ts)_
 
 ## `knock translation validate [TRANSLATIONREF]`
 
@@ -487,7 +529,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.20/src/commands/translation/validate.ts)_
+_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/translation/validate.ts)_
 
 ## `knock whoami`
 
@@ -504,7 +546,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -531,7 +573,28 @@ DESCRIPTION
   with `false` in order to deactivate it.
 ```
 
-_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/workflow/activate.ts)_
+_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/activate.ts)_
+
+## `knock workflow generate-types`
+
+Generate types for all workflows in the development environment and write them to a file.
+
+```
+USAGE
+  $ knock workflow generate-types --service-token <value> --output-file <value> [--environment <value>]
+
+FLAGS
+  --environment=<value>    [default: development] Select the environment to generate types for.
+  --output-file=<value>    (required) 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.
+  --service-token=<value>  (required) The service token to authenticate with.
+
+DESCRIPTION
+  Generate types for all workflows in the development environment and write them to a file.
+```
+
+_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/generate-types.ts)_
 
 ## `knock workflow get WORKFLOWKEY`
 
@@ -551,7 +614,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/workflow/get.ts)_
+_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/get.ts)_
 
 ## `knock workflow list`
 
@@ -574,7 +637,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.20/src/commands/workflow/list.ts)_
+_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/list.ts)_
 
 ## `knock workflow pull [WORKFLOWKEY]`
 
@@ -594,7 +657,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.20/src/commands/workflow/pull.ts)_
+_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/pull.ts)_
 
 ## `knock workflow push [WORKFLOWKEY]`
 
@@ -615,7 +678,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.20/src/commands/workflow/push.ts)_
+_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/push.ts)_
 
 ## `knock workflow run WORKFLOWKEY`
 
@@ -636,7 +699,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.20/src/commands/workflow/run.ts)_
+_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/run.ts)_
 
 ## `knock workflow validate [WORKFLOWKEY]`
 
@@ -655,5 +718,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.20/src/commands/workflow/validate.ts)_
+_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.22/src/commands/workflow/validate.ts)_
 <!-- commandsstop -->

package/dist/commands/pull.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return Pull;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../lib/base-command"));
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/flag"));
+const _ux = require("../lib/helpers/ux");
+const _resources = require("../lib/resources");
+const _pull = /*#__PURE__*/ _interop_require_default(require("./layout/pull"));
+const _pull1 = /*#__PURE__*/ _interop_require_default(require("./partial/pull"));
+const _pull2 = /*#__PURE__*/ _interop_require_default(require("./translation/pull"));
+const _pull3 = /*#__PURE__*/ _interop_require_default(require("./workflow/pull"));
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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 _interop_require_wildcard(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 = {
+        __proto__: null
+    };
+    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;
+}
+class Pull extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        const targetDirCtx = flags["knock-dir"];
+        const prompt = targetDirCtx.exists ? `Pull latest resources into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new resources directory at ${targetDirCtx.abspath}?`;
+        const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+        if (!input) return;
+        const args = [
+            "--all",
+            "--environment",
+            flags.environment,
+            ...flags["hide-uncommitted-changes"] ? [
+                "--hide-uncommitted-changes"
+            ] : [],
+            ...flags["service-token"] ? [
+                "--service-token",
+                flags["service-token"]
+            ] : [],
+            // Always use the force flag to skip prompts
+            "--force"
+        ];
+        for (const resourceType of _resources.ALL_RESOURCE_TYPES){
+            // eslint-disable-next-line no-await-in-loop
+            await runResourcePullCommand(resourceType, targetDirCtx, args);
+        }
+    }
+}
+_define_property(Pull, "summary", "Pull all resources from an environment into a local file system.");
+_define_property(Pull, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    "knock-dir": _flag.dirPath({
+        summary: "The target directory path to pull all resources into.",
+        required: true
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    }),
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
+});
+const runResourcePullCommand = async (resourceType, targetDirCtx, args)=>{
+    const subdirPath = _nodepath.resolve(targetDirCtx.abspath, _resources.RESOURCE_SUBDIRS[resourceType]);
+    switch(resourceType){
+        case "email_layout":
+            return _pull.default.run([
+                ...args,
+                "--layouts-dir",
+                subdirPath
+            ]);
+        case "partial":
+            return _pull1.default.run([
+                ...args,
+                "--partials-dir",
+                subdirPath
+            ]);
+        case "translation":
+            return _pull2.default.run([
+                ...args,
+                "--translations-dir",
+                subdirPath
+            ]);
+        case "workflow":
+            return _pull3.default.run([
+                ...args,
+                "--workflows-dir",
+                subdirPath
+            ]);
+        default:
+            {
+                const invalidResourceType = resourceType;
+                throw new Error(`Unknown resource type: ${invalidResourceType}`);
+            }
+    }
+};

package/dist/commands/push.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return Push;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../lib/base-command"));
+const _const = require("../lib/helpers/const");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/flag"));
+const _resources = require("../lib/resources");
+const _push = /*#__PURE__*/ _interop_require_default(require("./layout/push"));
+const _push1 = /*#__PURE__*/ _interop_require_default(require("./partial/push"));
+const _push2 = /*#__PURE__*/ _interop_require_default(require("./translation/push"));
+const _push3 = /*#__PURE__*/ _interop_require_default(require("./workflow/push"));
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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 _interop_require_wildcard(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 = {
+        __proto__: null
+    };
+    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;
+}
+class Push extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        const targetDirCtx = flags["knock-dir"];
+        if (!targetDirCtx.exists) {
+            this.error(`Directory ${targetDirCtx.abspath} does not exist`);
+        }
+        const args = [
+            "--all",
+            "--environment",
+            flags.environment,
+            ...flags["service-token"] ? [
+                "--service-token",
+                flags["service-token"]
+            ] : [],
+            ...flags.commit ? [
+                "--commit"
+            ] : [],
+            ...flags["commit-message"] ? [
+                "--commit-message",
+                flags["commit-message"]
+            ] : []
+        ];
+        // Note: Because we're pushing the different resource types sequentially,
+        // if one of the push commands fails, we may end up in a partially pushed
+        // state, with only some of the resources upserted. This is the best we can
+        // do until we have a bulk push mAPI endpoint.
+        for (const resourceType of _resources.ALL_RESOURCE_TYPES){
+            // eslint-disable-next-line no-await-in-loop
+            await runResourcePushCommand(resourceType, targetDirCtx, args);
+        }
+    }
+}
+_define_property(Push, "summary", "Push all resources from a local file system to Knock.");
+_define_property(Push, "flags", {
+    environment: _core.Flags.string({
+        summary: "Pushing resources is only allowed in the development environment",
+        default: _const.KnockEnv.Development,
+        options: [
+            _const.KnockEnv.Development
+        ]
+    }),
+    "knock-dir": _flag.dirPath({
+        summary: "The target directory path to find all resources to push.",
+        required: true
+    }),
+    commit: _core.Flags.boolean({
+        summary: "Push and commit the resource(s) at the same time"
+    }),
+    "commit-message": _core.Flags.string({
+        summary: "Use the given value as the commit message",
+        char: "m",
+        dependsOn: [
+            "commit"
+        ]
+    })
+});
+const runResourcePushCommand = async (resourceType, targetDirCtx, args)=>{
+    const subdirPath = _nodepath.resolve(targetDirCtx.abspath, _resources.RESOURCE_SUBDIRS[resourceType]);
+    const hasResources = await _fsextra.pathExists(subdirPath);
+    if (!hasResources) {
+        return;
+    }
+    switch(resourceType){
+        case "email_layout":
+            return _push.default.run([
+                ...args,
+                "--layouts-dir",
+                subdirPath
+            ]);
+        case "partial":
+            return _push1.default.run([
+                ...args,
+                "--partials-dir",
+                subdirPath
+            ]);
+        case "translation":
+            return _push2.default.run([
+                ...args,
+                "--translations-dir",
+                subdirPath
+            ]);
+        case "workflow":
+            return _push3.default.run([
+                ...args,
+                "--workflows-dir",
+                subdirPath
+            ]);
+        default:
+            {
+                const invalidResourceType = resourceType;
+                throw new Error(`Unknown resource type: ${invalidResourceType}`);
+            }
+    }
+};

package/dist/commands/workflow/generate-types.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return WorkflowGenerateTypes;
+    }
+});
+const _core = require("@oclif/core");
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+const _ux = require("../../lib/helpers/ux");
+const _typegenerator = require("../../lib/type-generator");
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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 _interop_require_wildcard(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 = {
+        __proto__: null
+    };
+    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;
+}
+class WorkflowGenerateTypes extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        const fileExtension = flags["output-file"].abspath.split(".").pop();
+        const targetLanguage = (0, _typegenerator.getLanguageFromExtension)(fileExtension);
+        if (!targetLanguage) {
+            this.error(new _error.ApiError(`Unsupported file extension: ${fileExtension}. We currently support .ts, .rb, .go, .py files only.`));
+        }
+        _ux.spinner.start(`‣ Loading workflows`);
+        // 1. List all workflows in the development environment.
+        const workflows = await this.listAllWorkflows();
+        _ux.spinner.stop();
+        // 2. Generate types for all workflows.
+        _ux.spinner.start(`‣ Generating types`);
+        const { result, workflows: workflowsWithValidTypes } = await (0, _typegenerator.generateWorkflowTypes)(workflows, targetLanguage);
+        _ux.spinner.stop();
+        if (!result) {
+            this.log(`‣ No workflows with valid trigger data JSON schema found, skipping type generation`);
+            return;
+        }
+        // 3. Write the generated types to the output file.
+        await _fsextra.writeFile(flags["output-file"].abspath, result.lines.join("\n"));
+        this.log(`‣ Successfully generated types for ${workflowsWithValidTypes.length} workflow(s) and wrote them to ${flags["output-file"].abspath}`);
+    }
+    async listAllWorkflows(pageParams = {}, workflowsFetchedSoFar = []) {
+        const props = (0, _objectisomorphic.merge)(this.props, {
+            flags: {
+                ...pageParams,
+                annotate: true,
+                limit: _page.MAX_PAGINATION_LIMIT
+            }
+        });
+        const resp = await this.apiV1.listWorkflows(props);
+        if (!(0, _request.isSuccessResp)(resp)) {
+            const message = (0, _request.formatErrorRespMessage)(resp);
+            this.error(new _error.ApiError(message));
+        }
+        const { entries, page_info: pageInfo } = resp.data;
+        const workflows = [
+            ...workflowsFetchedSoFar,
+            ...entries
+        ];
+        return pageInfo.after ? this.listAllWorkflows({
+            after: pageInfo.after
+        }, workflows) : workflows;
+    }
+}
+_define_property(WorkflowGenerateTypes, "description", "Generate types for all workflows in the development environment and write them to a file.");
+_define_property(WorkflowGenerateTypes, "flags", {
+    environment: _core.Flags.string({
+        summary: "Select the environment to generate types for.",
+        default: _const.KnockEnv.Development
+    }),
+    "output-file": _flag.filePath({
+        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.",
+        required: true
+    })
+});

package/dist/lib/helpers/flag.js

@@ -15,6 +15,9 @@ _export(exports, {
     dirPath: function() {
         return dirPath;
     },
+    filePath: function() {
+        return filePath;
+    },
     jsonStr: function() {
         return jsonStr;
     },
@@ -77,6 +80,19 @@ const booleanStr = _core.Flags.custom({
     ],
     parse: async (input)=>input === "true"
 });
+const filePath = _core.Flags.custom({
+    parse: async (input)=>{
+        const abspath = _nodepath.isAbsolute(input) ? input : _nodepath.resolve(process.cwd(), input);
+        const exists = await _fsextra.pathExists(abspath);
+        if (exists && !(await _fsextra.lstat(abspath)).isFile()) {
+            throw new Error(`${input} exists but is not a file`);
+        }
+        return {
+            abspath,
+            exists
+        };
+    }
+});
 const dirPath = _core.Flags.custom({
     parse: async (input)=>{
         const abspath = _nodepath.isAbsolute(input) ? input : _nodepath.resolve(process.cwd(), input);

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: all[name]
+    });
+}
+_export(exports, {
+    ALL_RESOURCE_TYPES: function() {
+        return ALL_RESOURCE_TYPES;
+    },
+    RESOURCE_SUBDIRS: function() {
+        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"
+};

package/dist/lib/type-generator.js

@@ -0,0 +1,100 @@
+"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, {
+    generateWorkflowTypes: function() {
+        return generateWorkflowTypes;
+    },
+    getLanguageFromExtension: function() {
+        return getLanguageFromExtension;
+    }
+});
+const _quicktypecore = require("quicktype-core");
+function getLanguageFromExtension(extension) {
+    switch(extension){
+        case "ts":
+            return "typescript";
+        case "py":
+            return "python";
+        case "go":
+            return "go";
+        case "rb":
+            return "ruby";
+        default:
+            return undefined;
+    }
+}
+/**
+ * Transforms the schema to add additionalProperties to all objects.
+ *
+ * TODO: handle refs, union types, and more.
+ *
+ * @param schema The schema to transform
+ * @returns The transformed schema
+ */ function transformSchema(schema) {
+    if (schema.type === "object" && !schema.additionalProperties) {
+        schema.additionalProperties = false;
+    }
+    var _schema_properties;
+    for (const key of Object.keys((_schema_properties = schema.properties) !== null && _schema_properties !== void 0 ? _schema_properties : {})){
+        const property = schema.properties[key];
+        if (property.type === "object") {
+            const transformedProperty = transformSchema(property);
+            schema.properties[key] = transformedProperty;
+        }
+    }
+    return schema;
+}
+/**
+ * Given a set of workflows, will go through and generated types for each workflow.
+ *
+ * If the workflow has no trigger data JSON schema, will return empty lines.
+ *
+ * @param workflows List of workflows to generate types for
+ * @param targetLanguage Target programming language for type generation
+ * @returns Generated type definitions for the workflows
+ */ 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 = 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/oclif.manifest.json

@@ -76,6 +76,146 @@
         "ping.js"
       ]
     },
+    "pull": {
+      "aliases": [],
+      "args": {},
+      "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"
+        },
+        "knock-dir": {
+          "name": "knock-dir",
+          "required": true,
+          "summary": "The target directory path to pull all resources 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,
+      "hiddenAliases": [],
+      "id": "pull",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Pull all resources from an environment into a local file system.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "pull.js"
+      ]
+    },
+    "push": {
+      "aliases": [],
+      "args": {},
+      "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 resources is only allowed in the development environment",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "type": "option"
+        },
+        "knock-dir": {
+          "name": "knock-dir",
+          "required": true,
+          "summary": "The target directory path to find all resources to push.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "commit": {
+          "name": "commit",
+          "summary": "Push and commit the resource(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,
+      "hiddenAliases": [],
+      "id": "push",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Push all resources from a local file system to Knock.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "push.js"
+      ]
+    },
     "whoami": {
       "aliases": [],
       "args": {},
@@ -2029,6 +2169,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": {
@@ -2557,5 +2752,5 @@
       ]
     }
   },
-  "version": "0.1.20"
+  "version": "0.1.22"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.20",
+  "version": "0.1.22",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -20,24 +20,25 @@
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
     "@prantlf/jsonlint": "^14.1.0",
-    "axios": "^1.7.9",
+    "axios": "^1.9.0",
     "date-fns": "^2.30.0",
     "enquirer": "^2.4.1",
     "fs-extra": "^11.3.0",
-    "liquidjs": "^10.21.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.10.6",
-    "@swc/helpers": "^0.5.15",
+    "@swc/cli": "^0.7.7",
+    "@swc/core": "^1.11.24",
+    "@swc/helpers": "^0.5.17",
     "@types/chai": "^4",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.24",
+    "@types/node": "^20.19.0",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -49,12 +50,12 @@
     "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.8.1",
-    "typescript": "^5.5.4"
+    "typescript": "^5.8.3"
   },
   "oclif": {
     "bin": "knock",