@knocklabs/cli 0.2.0 → 0.2.1

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.2.0 linux-x64 node-v18.20.8
+@knocklabs/cli/0.2.1 linux-x64 node-v18.20.8
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -80,7 +80,7 @@ FLAGS
       --service-token=<value>   The service token to authenticate with.
 ```
 
-_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/index.ts)_
+_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/index.ts)_
 
 ## `knock commit get ID`
 
@@ -97,7 +97,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/get.ts)_
+_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/get.ts)_
 
 ## `knock commit list`
 
@@ -127,7 +127,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/list.ts)_
+_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/list.ts)_
 
 ## `knock commit promote`
 
@@ -144,7 +144,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.2.0/src/commands/commit/promote.ts)_
+_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/promote.ts)_
 
 ## `knock guide activate GUIDEKEY`
 
@@ -174,7 +174,7 @@ DESCRIPTION
   or deactivated at a later time using the --from and --until flags.
 ```
 
-_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/guide/activate.ts)_
+_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/guide/activate.ts)_
 
 ## `knock guide generate-types`
 
@@ -195,7 +195,7 @@ DESCRIPTION
   Generate types for all guides in an environment and write them to a file.
 ```
 
-_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/guide/generate-types.ts)_
+_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/guide/generate-types.ts)_
 
 ## `knock help [COMMAND]`
 
@@ -235,7 +235,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/get.ts)_
+_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/get.ts)_
 
 ## `knock layout list`
 
@@ -258,7 +258,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/list.ts)_
+_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/list.ts)_
 
 ## `knock layout pull [EMAILLAYOUTKEY]`
 
@@ -278,7 +278,7 @@ FLAGS
   --service-token=<value>     The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/pull.ts)_
+_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/pull.ts)_
 
 ## `knock layout push [EMAILLAYOUTKEY]`
 
@@ -300,7 +300,7 @@ FLAGS
       --service-token=<value>   The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/push.ts)_
+_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/push.ts)_
 
 ## `knock layout validate [EMAILLAYOUTKEY]`
 
@@ -319,7 +319,7 @@ FLAGS
   --service-token=<value>  The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/validate.ts)_
+_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/validate.ts)_
 
 ## `knock login`
 
@@ -331,7 +331,7 @@ FLAGS
   --service-token=<value>  The service token to authenticate with.
 ```
 
-_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/login.ts)_
 
 ## `knock logout`
 
@@ -343,7 +343,7 @@ FLAGS
   --service-token=<value>  The service token to authenticate with.
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/logout.ts)_
 
 ## `knock partial get PARTIALKEY`
 
@@ -363,7 +363,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/get.ts)_
+_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/get.ts)_
 
 ## `knock partial list`
 
@@ -386,7 +386,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/list.ts)_
+_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/list.ts)_
 
 ## `knock partial pull [PARTIALKEY]`
 
@@ -406,7 +406,7 @@ FLAGS
   --service-token=<value>     The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/pull.ts)_
+_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/pull.ts)_
 
 ## `knock partial push [PARTIALKEY]`
 
@@ -427,7 +427,7 @@ FLAGS
       --service-token=<value>   The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/push.ts)_
+_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/push.ts)_
 
 ## `knock partial validate [PARTIALKEY]`
 
@@ -446,7 +446,7 @@ FLAGS
   --service-token=<value>  The service token to authenticate with.
 ```
 
-_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/validate.ts)_
+_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/validate.ts)_
 
 ## `knock pull`
 
@@ -465,7 +465,7 @@ FLAGS
   --service-token=<value>     The service token to authenticate with.
 ```
 
-_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/pull.ts)_
+_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/pull.ts)_
 
 ## `knock push`
 
@@ -485,7 +485,7 @@ FLAGS
       --service-token=<value>   The service token to authenticate with.
 ```
 
-_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/push.ts)_
+_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/push.ts)_
 
 ## `knock translation get TRANSLATIONREF`
 
@@ -512,7 +512,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/get.ts)_
+_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/get.ts)_
 
 ## `knock translation list`
 
@@ -535,7 +535,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/list.ts)_
+_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/list.ts)_
 
 ## `knock translation pull [TRANSLATIONREF]`
 
@@ -562,7 +562,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.2.0/src/commands/translation/pull.ts)_
+_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/pull.ts)_
 
 ## `knock translation push [TRANSLATIONREF]`
 
@@ -589,7 +589,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.2.0/src/commands/translation/push.ts)_
+_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/push.ts)_
 
 ## `knock translation validate [TRANSLATIONREF]`
 
@@ -614,7 +614,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.2.0/src/commands/translation/validate.ts)_
+_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/validate.ts)_
 
 ## `knock whoami`
 
@@ -631,7 +631,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -658,7 +658,7 @@ DESCRIPTION
   with `false` in order to deactivate it.
 ```
 
-_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/activate.ts)_
+_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/activate.ts)_
 
 ## `knock workflow generate-types`
 
@@ -679,7 +679,7 @@ DESCRIPTION
   Generate types for all workflows in an environment and write them to a file.
 ```
 
-_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/generate-types.ts)_
+_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/generate-types.ts)_
 
 ## `knock workflow get WORKFLOWKEY`
 
@@ -699,7 +699,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/get.ts)_
+_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/get.ts)_
 
 ## `knock workflow list`
 
@@ -722,7 +722,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/list.ts)_
+_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/list.ts)_
 
 ## `knock workflow pull [WORKFLOWKEY]`
 
@@ -742,7 +742,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.2.0/src/commands/workflow/pull.ts)_
+_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/pull.ts)_
 
 ## `knock workflow push [WORKFLOWKEY]`
 
@@ -763,7 +763,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.2.0/src/commands/workflow/push.ts)_
+_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/push.ts)_
 
 ## `knock workflow run WORKFLOWKEY`
 
@@ -784,7 +784,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.2.0/src/commands/workflow/run.ts)_
+_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/run.ts)_
 
 ## `knock workflow validate [WORKFLOWKEY]`
 
@@ -803,5 +803,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.2.0/src/commands/workflow/validate.ts)_
+_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/validate.ts)_
 <!-- commandsstop -->

package/dist/commands/branch/create.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return BranchCreate;
+    }
+});
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _arg = require("../../lib/helpers/arg");
+const _request = require("../../lib/helpers/request");
+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
+    };
+}
+class BranchCreate extends _basecommand.default {
+    async run() {
+        const { args, flags } = this.props;
+        const resp = await this.request(args.slug);
+        if (flags.json) return resp;
+        this.render(resp);
+    }
+    async request(slug) {
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.post(`/v1/branches/${slug}`));
+    }
+    async render(data) {
+        this.log(`‣ Successfully created branch \`${data.slug}\``);
+        this.log(`  Created at: ${data.created_at}`);
+    }
+}
+// Hide until branches are released in GA
+_define_property(BranchCreate, "hidden", true);
+_define_property(BranchCreate, "summary", "Creates a new branch off of the development environment.");
+_define_property(BranchCreate, "enableJsonFlag", true);
+_define_property(BranchCreate, "args", {
+    slug: _arg.CustomArgs.slugArg({
+        required: true,
+        description: "The slug for the new branch"
+    })
+});

package/dist/commands/branch/delete.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return BranchDelete;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _arg = require("../../lib/helpers/arg");
+const _request = require("../../lib/helpers/request");
+const _ux = require("../../lib/helpers/ux");
+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
+    };
+}
+class BranchDelete extends _basecommand.default {
+    async run() {
+        const { args, flags } = this.props;
+        // Confirm before deleting the branch, unless forced
+        const prompt = `Delete branch \`${args.slug}\`?`;
+        const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+        if (!input) return;
+        await (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.delete(`/v1/branches/${args.slug}`), {
+            action: "‣ Deleting branch"
+        });
+        this.log(`‣ Successfully deleted branch \`${args.slug}\``);
+    }
+}
+// Hide until branches are released in GA
+_define_property(BranchDelete, "hidden", true);
+_define_property(BranchDelete, "summary", "Deletes an existing branch with the given slug.");
+_define_property(BranchDelete, "args", {
+    slug: _arg.CustomArgs.slugArg({
+        required: true,
+        description: "The slug of the branch to delete"
+    })
+});
+_define_property(BranchDelete, "flags", {
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
+});

package/dist/commands/branch/list.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return BranchList;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _date = require("../../lib/helpers/date");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+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
+    };
+}
+class BranchList extends _basecommand.default {
+    async run() {
+        const resp = await this.request();
+        const { flags } = this.props;
+        if (flags.json) return resp;
+        this.render(resp);
+    }
+    async request(pageParams = {}) {
+        const queryParams = (0, _page.toPageParams)({
+            ...this.props.flags,
+            ...pageParams
+        });
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.get("/v1/branches", {
+                query: queryParams
+            }));
+    }
+    async render(data) {
+        const { entries } = data;
+        this.log(`‣ Showing ${entries.length} branches off of the development environment\n`);
+        _core.ux.table(entries, {
+            slug: {
+                header: "Slug"
+            },
+            created_at: {
+                header: "Created at",
+                get: (entry)=>(0, _date.formatDate)(entry.created_at)
+            },
+            updated_at: {
+                header: "Updated at",
+                get: (entry)=>(0, _date.formatDate)(entry.updated_at)
+            },
+            last_commit_at: {
+                header: "Last commit at",
+                get: (entry)=>entry.last_commit_at ? (0, _date.formatDate)(entry.last_commit_at) : "Never"
+            }
+        });
+        return this.prompt(data);
+    }
+    async prompt(data) {
+        const { page_info } = data;
+        const pageAction = await (0, _page.maybePromptPageAction)(page_info);
+        const pageParams = pageAction && (0, _page.paramsForPageAction)(pageAction, page_info);
+        if (pageParams) {
+            this.log("\n");
+            const resp = await this.request(pageParams);
+            return this.render(resp);
+        }
+    }
+}
+// Hide until branches are released in GA
+_define_property(BranchList, "hidden", true);
+_define_property(BranchList, "summary", "Display all existing branches off of the development environment.");
+_define_property(BranchList, "flags", {
+    ..._page.pageFlags
+});
+_define_property(BranchList, "enableJsonFlag", true);

package/dist/commands/whoami.js

@@ -31,17 +31,16 @@ function _interop_require_default(obj) {
 }
 class Whoami extends _basecommand.default {
     async run() {
-        const resp = await (0, _request.withSpinner)(()=>this.apiV1.whoami());
+        const resp = await (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.auth.verify());
         const { flags } = this.props;
-        if (flags.json) return resp.data;
+        if (flags.json) return resp;
         this.log(`‣ Successfully authenticated:`);
-        let info = [];
-        info = resp.data.service_token_name ? [
-            `Account name: ${resp.data.account_name}`,
-            `Service token name: ${resp.data.service_token_name}`
+        const info = resp.service_token_name ? [
+            `Account name: ${resp.account_name}`,
+            `Service token name: ${resp.service_token_name}`
         ] : [
-            `Account name: ${resp.data.account_name}`,
-            `User ID: ${resp.data.user_id}`
+            `Account name: ${resp.account_name}`,
+            `User ID: ${resp.user_id}`
         ];
         this.log((0, _string.indentString)(info.join("\n"), 4));
     }

package/dist/lib/api-v1.js

@@ -8,6 +8,7 @@ Object.defineProperty(exports, "default", {
         return ApiV1;
     }
 });
+const _mgmt = /*#__PURE__*/ _interop_require_default(require("@knocklabs/mgmt"));
 const _axios = /*#__PURE__*/ _interop_require_default(require("axios"));
 const _objectisomorphic = require("./helpers/object.isomorphic");
 const _page = require("./helpers/page");
@@ -30,6 +31,11 @@ function _interop_require_default(obj) {
     };
 }
 const API_VERSION = "v1";
+/**
+ * KnockMgmt client requires a service token, but we set the Authorization
+ * request header directly, so use a placeholder when service token is not
+ * provided.
+ */ const PLACEHOLDER_SERVICE_TOKEN = "placeholder-service-token";
 class ApiV1 {
     getToken(sessionContext) {
         return sessionContext.session ? sessionContext.session.accessToken : sessionContext.token;
@@ -406,21 +412,29 @@ class ApiV1 {
     constructor(sessionContext, config){
         var _sessionContext_session;
         _define_property(this, "client", void 0);
+        _define_property(this, "mgmtClient", void 0);
         const baseURL = sessionContext.apiOrigin;
         const token = this.getToken(sessionContext);
         var _sessionContext_session_clientId;
+        const headers = {
+            // Used to authenticate the request to the API.
+            Authorization: `Bearer ${token}`,
+            // Used in conjunction with the JWT access token, to allow the OAuth server to
+            // verify the client ID of the OAuth client that issued the access token.
+            "x-knock-client-id": (_sessionContext_session_clientId = (_sessionContext_session = sessionContext.session) === null || _sessionContext_session === void 0 ? void 0 : _sessionContext_session.clientId) !== null && _sessionContext_session_clientId !== void 0 ? _sessionContext_session_clientId : undefined,
+            "User-Agent": `${config.userAgent}`
+        };
         this.client = _axios.default.create({
             baseURL,
-            headers: {
-                // Used to authenticate the request to the API.
-                Authorization: `Bearer ${token}`,
-                // Used in conjunction with the JWT access token, to allow the OAuth server to
-                // verify the client ID of the OAuth client that issued the access token.
-                "x-knock-client-id": (_sessionContext_session_clientId = (_sessionContext_session = sessionContext.session) === null || _sessionContext_session === void 0 ? void 0 : _sessionContext_session.clientId) !== null && _sessionContext_session_clientId !== void 0 ? _sessionContext_session_clientId : undefined,
-                "User-Agent": `${config.userAgent}`
-            },
+            headers,
             // Don't reject the promise based on a response status code.
             validateStatus: null
         });
+        // This should eventually replace the Axios client
+        this.mgmtClient = new _mgmt.default({
+            serviceToken: sessionContext.token || PLACEHOLDER_SERVICE_TOKEN,
+            baseURL,
+            defaultHeaders: headers
+        });
     }
 }

package/dist/lib/helpers/arg.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "CustomArgs", {
+    enumerable: true,
+    get: function() {
+        return CustomArgs;
+    }
+});
+const _core = require("@oclif/core");
+const slugArg = _core.Args.custom({
+    parse: async (str)=>{
+        const slug = str.toLowerCase().trim().replace(/\s+/g, "-");
+        if (!slug) {
+            throw new Error("Invalid slug provided");
+        }
+        return slug;
+    }
+});
+const CustomArgs = {
+    slugArg
+};

package/dist/lib/helpers/request.js

@@ -12,16 +12,28 @@ _export(exports, {
     get formatErrorRespMessage () {
         return formatErrorRespMessage;
     },
+    get formatMgmtError () {
+        return formatMgmtError;
+    },
     get isSuccessResp () {
         return isSuccessResp;
     },
     get withSpinner () {
         return withSpinner;
+    },
+    get withSpinnerV2 () {
+        return withSpinnerV2;
     }
 });
+const _mgmt = /*#__PURE__*/ _interop_require_default(require("@knocklabs/mgmt"));
 const _core = require("@oclif/core");
 const _error = require("./error");
 const _ux = require("./ux");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
 const isSuccessResp = (resp)=>resp.status >= 200 && resp.status < 300;
 const formatErrorRespMessage = ({ status, data })=>{
     if (status === 500) {
@@ -36,16 +48,50 @@ const formatErrorRespMessage = ({ status, data })=>{
     }
     return message;
 };
+const formatMgmtError = (apiError)=>{
+    if (apiError.status === 500) {
+        return "An internal server error occurred";
+    }
+    var _apiError_error_message;
+    // Prefer the error message from the error object over
+    // the error message formatted by the Stainless SDK
+    const description = `${(_apiError_error_message = apiError.error.message) !== null && _apiError_error_message !== void 0 ? _apiError_error_message : apiError.message} (status: ${apiError.status})`;
+    var _apiError_error_errors;
+    const inputErrors = (_apiError_error_errors = apiError.error.errors) !== null && _apiError_error_errors !== void 0 ? _apiError_error_errors : [];
+    if (Array.isArray(inputErrors) && inputErrors.length > 0) {
+        const errs = inputErrors.map((e)=>new _error.JsonDataError(e.message, e.field));
+        return errs.length === 0 ? description : description + "\n\n" + (0, _error.formatErrors)(errs, {
+            indentBy: 2
+        });
+    }
+    return description;
+};
 const withSpinner = async (requestFn, opts = {})=>{
-    const { action = "‣ Loading", ensureSuccess = true } = opts;
+    const { action = "‣ Loading" } = opts;
     // Suppress printing the spinner in tests, oclif doesn't for some reasons.
     _ux.spinner.start(action);
     const resp = await requestFn();
     // Error out before the action stop so the spinner can update accordingly.
-    if (ensureSuccess && !isSuccessResp(resp)) {
+    if (!isSuccessResp(resp)) {
         const message = formatErrorRespMessage(resp);
         _core.ux.error(new _error.ApiError(message));
     }
     _ux.spinner.stop();
     return resp;
 };
+const withSpinnerV2 = async (requestFn, opts = {})=>{
+    const { action = "‣ Loading" } = opts;
+    // Suppress printing the spinner in tests, oclif doesn't for some reasons.
+    _ux.spinner.start(action);
+    try {
+        const resp = await requestFn();
+        _ux.spinner.stop();
+        return resp;
+    } catch (error) {
+        if (error instanceof _mgmt.default.APIError) {
+            const message = formatMgmtError(error);
+            return _core.ux.error(new _error.ApiError(message));
+        }
+        throw error;
+    }
+};

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

@@ -23,16 +23,20 @@ _export(exports, {
     get buildPartialDirBundle () {
         return _processorisomorphic3.buildPartialDirBundle;
     },
+    get buildReusableStepDirBundle () {
+        return _processorisomorphic4.buildReusableStepDirBundle;
+    },
     get buildTranslationDirBundle () {
-        return _processorisomorphic4.buildTranslationDirBundle;
+        return _processorisomorphic5.buildTranslationDirBundle;
     },
     get buildWorkflowDirBundle () {
-        return _processorisomorphic5.buildWorkflowDirBundle;
+        return _processorisomorphic6.buildWorkflowDirBundle;
     }
 });
 const _processorisomorphic = require("./email-layout/processor.isomorphic");
 const _processorisomorphic1 = require("./guide/processor.isomorphic");
 const _processorisomorphic2 = require("./message-type/processor.isomorphic");
 const _processorisomorphic3 = require("./partial/processor.isomorphic");
-const _processorisomorphic4 = require("./translation/processor.isomorphic");
-const _processorisomorphic5 = require("./workflow/processor.isomorphic");
+const _processorisomorphic4 = require("./reusable-step/processor.isomorphic");
+const _processorisomorphic5 = require("./translation/processor.isomorphic");
+const _processorisomorphic6 = require("./workflow/processor.isomorphic");

package/dist/lib/marshal/reusable-step/helpers.js

@@ -0,0 +1,72 @@
+"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 isReusableStepDir () {
+        return isReusableStepDir;
+    },
+    get lsReusableStepJson () {
+        return lsReusableStepJson;
+    },
+    get reusableStepJsonPath () {
+        return reusableStepJsonPath;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _processorisomorphic = require("./processor.isomorphic");
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _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;
+}
+const reusableStepJsonPath = (reusableStepDirCtx)=>_nodepath.resolve(reusableStepDirCtx.abspath, _processorisomorphic.REUSABLE_STEP_JSON);
+const isReusableStepDir = async (dirPath)=>Boolean(await lsReusableStepJson(dirPath));
+const lsReusableStepJson = async (dirPath)=>{
+    const reusableStepJsonPath = _nodepath.resolve(dirPath, _processorisomorphic.REUSABLE_STEP_JSON);
+    const exists = await _fsextra.pathExists(reusableStepJsonPath);
+    return exists ? reusableStepJsonPath : undefined;
+};

package/dist/lib/marshal/reusable-step/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./processor.isomorphic"), exports);
+_export_star(require("./types"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/dist/lib/marshal/reusable-step/processor.isomorphic.js

@@ -0,0 +1,86 @@
+/*
+ * IMPORTANT:
+ *
+ * This file is suffixed with `.isomorphic` because the code in this file is
+ * meant to run not just in a nodejs environment but also in a browser. For this
+ * reason there are some restrictions for which nodejs imports are allowed in
+ * this module. See `.eslintrc.json` for more details.
+ */ "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 REUSABLE_STEP_JSON () {
+        return REUSABLE_STEP_JSON;
+    },
+    get buildReusableStepDirBundle () {
+        return buildReusableStepDirBundle;
+    }
+});
+const _lodash = require("lodash");
+const _objectisomorphic = require("../../helpers/object.isomorphic");
+const _constisomorphic = require("../shared/const.isomorphic");
+const _helpersisomorphic = require("../shared/helpers.isomorphic");
+const REUSABLE_STEP_JSON = "reusable_step.json";
+const compileExtractionSettings = (reusableStep)=>{
+    const extractableFields = (0, _lodash.get)(reusableStep, [
+        "__annotation",
+        "extractable_fields"
+    ], {});
+    const map = new Map();
+    for (const key of Object.keys(reusableStep)){
+        // If the field we are on is extractable, then add its extraction
+        // settings to the map with the current object path.
+        if (key in extractableFields) {
+            map.set([
+                key
+            ], extractableFields[key]);
+        }
+    }
+    return map;
+};
+const buildReusableStepDirBundle = (remoteReusableStep, localReusableStep = {})=>{
+    const bundle = {};
+    const mutRemoteReusableStep = (0, _lodash.cloneDeep)(remoteReusableStep);
+    // A map of extraction settings of every field in the reusable step
+    const compiledExtractionSettings = compileExtractionSettings(mutRemoteReusableStep);
+    // Iterate through each extractable field, determine whether we need to
+    // extract the field content, and if so, perform the extraction.
+    for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
+        // If this reusable step doesn't have this field path, then we don't extract.
+        if (!(0, _lodash.has)(mutRemoteReusableStep, objPathParts)) continue;
+        // If the field at this path is extracted in the local reusable step, then
+        // always extract; otherwise extract based on the field settings default.
+        const objPathStr = _objectisomorphic.ObjPath.stringify(objPathParts);
+        const extractedFilePath = (0, _lodash.get)(localReusableStep, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`);
+        const { default: extractByDefault, file_ext: fileExt } = extractionSettings;
+        if (!extractedFilePath && !extractByDefault) continue;
+        // By this point, we have a field where we need to extract its content.
+        const data = (0, _lodash.get)(mutRemoteReusableStep, objPathParts);
+        const fileName = objPathParts.pop();
+        // If we have an extracted file path from the local reusable step, we use that.
+        // In the other case we use the default path.
+        const relpath = typeof extractedFilePath === "string" ? extractedFilePath : `${fileName}.${fileExt}`;
+        // Perform the extraction by adding the content and its file path to the
+        // bundle for writing to the file system later. Then replace the field
+        // content with the extracted file path and mark the field as extracted
+        // with @ suffix.
+        const content = typeof data === "string" ? data : JSON.stringify(data, null, 2);
+        (0, _lodash.set)(bundle, [
+            relpath
+        ], content);
+        (0, _lodash.set)(mutRemoteReusableStep, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`, relpath);
+        (0, _lodash.unset)(mutRemoteReusableStep, objPathStr);
+    }
+    // At this point the bundle contains all extractable files, so we finally add
+    // the reusable step JSON relative path + the file content.
+    return (0, _lodash.set)(bundle, [
+        REUSABLE_STEP_JSON
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteReusableStep));
+};

package/dist/lib/marshal/reusable-step/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/oclif.manifest.json

@@ -335,6 +335,179 @@
         "whoami.js"
       ]
     },
+    "branch:create": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "The slug for the new branch",
+          "name": "slug",
+          "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": false,
+          "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"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "branch:create",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Creates a new branch off of the development environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "branch",
+        "create.js"
+      ]
+    },
+    "branch:delete": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "The slug of the branch to delete",
+          "name": "slug",
+          "required": true
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": false,
+          "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"
+        },
+        "force": {
+          "name": "force",
+          "summary": "Remove the confirmation prompt.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "branch:delete",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Deletes an existing branch with the given slug.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "branch",
+        "delete.js"
+      ]
+    },
+    "branch: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": false,
+          "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"
+        },
+        "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": "branch:list",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display all existing branches off of the development environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "branch",
+        "list.js"
+      ]
+    },
     "commit:get": {
       "aliases": [],
       "args": {
@@ -3387,5 +3560,5 @@
       ]
     }
   },
-  "version": "0.2.0"
+  "version": "0.2.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -17,6 +17,7 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
+    "@knocklabs/mgmt": "^0.5.0",
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
     "@prantlf/jsonlint": "^14.1.0",
@@ -91,8 +92,9 @@
     "type.check": "tsc",
     "postpack": "shx rm -f oclif.manifest.json",
     "prepack": "yarn build && oclif manifest && oclif readme",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "test": "mocha \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md",
+    "check": "yarn run lint && yarn run format.check && yarn run type.check"
   },
   "engines": {
     "node": ">=18.17.0"