@knocklabs/cli 1.0.0-rc.1 → 1.0.2

package/dist/commands/branch/create.js

@@ -8,9 +8,13 @@ Object.defineProperty(exports, "default", {
         return BranchCreate;
     }
 });
+const _enquirer = require("enquirer");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
 const _arg = require("../../lib/helpers/arg");
+const _const = require("../../lib/helpers/const");
+const _git = require("../../lib/helpers/git");
 const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -32,12 +36,45 @@ function _interop_require_default(obj) {
 class BranchCreate extends _basecommand.default {
     async run() {
         const { args, flags } = this.props;
-        const resp = await this.request(args.slug);
+        // If slug is provided, use it directly
+        let slug = args.slug;
+        // Otherwise, prompt for it with Git branch as default
+        if (!slug) {
+            slug = await this.promptForBranchSlug();
+        }
+        if (!slug) {
+            return this.error("Invalid slug provided");
+        }
+        const resp = await this.request(slug);
         if (flags.json) return resp;
         this.render(resp);
     }
+    async promptForBranchSlug() {
+        const gitBranch = (0, _git.getCurrentGitBranch)();
+        const initial = gitBranch ? (0, _string.slugify)(gitBranch) : undefined;
+        try {
+            const response = await (0, _enquirer.prompt)({
+                type: "input",
+                name: "slug",
+                message: "Branch slug",
+                initial,
+                validate: (value)=>{
+                    const slugified = (0, _string.slugify)(value);
+                    if (!slugified) {
+                        return "Invalid slug provided";
+                    }
+                    return true;
+                }
+            });
+            return (0, _string.slugify)(response.slug);
+        } catch  {
+            return undefined;
+        }
+    }
     async request(slug) {
-        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.post(`/v1/branches/${slug}`));
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.branches.create(slug, {
+                environment: _const.KnockEnv.Development
+            }));
     }
     async render(data) {
         this.log(`‣ Successfully created branch \`${data.slug}\``);
@@ -48,7 +85,7 @@ _define_property(BranchCreate, "summary", "Creates a new branch off of the devel
 _define_property(BranchCreate, "enableJsonFlag", true);
 _define_property(BranchCreate, "args", {
     slug: _arg.CustomArgs.slug({
-        required: true,
+        required: false,
         description: "The slug for the new branch"
     })
 });

package/dist/commands/branch/list.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
 const _date = require("../../lib/helpers/date");
 const _page = require("../../lib/helpers/page");
 const _request = require("../../lib/helpers/request");
@@ -43,28 +44,32 @@ class BranchList extends _basecommand.default {
             ...this.props.flags,
             ...pageParams
         });
-        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.get("/v1/branches", {
-                query: queryParams
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.branches.list({
+                environment: _const.KnockEnv.Development,
+                ...queryParams
             }));
     }
     async render(data) {
         const { entries } = data;
         this.log(`‣ Showing ${entries.length} branches off of the development environment\n`);
-        _core.ux.table(entries, {
+        const formattedBranches = entries.map((entry)=>({
+                slug: entry.slug,
+                created_at: (0, _date.formatDate)(entry.created_at),
+                updated_at: (0, _date.formatDate)(entry.updated_at),
+                last_commit_at: entry.last_commit_at ? (0, _date.formatDate)(entry.last_commit_at) : "Never"
+            }));
+        _core.ux.table(formattedBranches, {
             slug: {
                 header: "Slug"
             },
             created_at: {
-                header: "Created at",
-                get: (entry)=>(0, _date.formatDate)(entry.created_at)
+                header: "Created at"
             },
             updated_at: {
-                header: "Updated at",
-                get: (entry)=>(0, _date.formatDate)(entry.updated_at)
+                header: "Updated at"
             },
             last_commit_at: {
-                header: "Last commit at",
-                get: (entry)=>entry.last_commit_at ? (0, _date.formatDate)(entry.last_commit_at) : "Never"
+                header: "Last commit at"
             }
         });
         return this.prompt(data);

package/dist/commands/branch/switch.js

@@ -15,6 +15,7 @@ const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
 const _arg = require("../../lib/helpers/arg");
 const _branch = require("../../lib/helpers/branch");
+const _const = require("../../lib/helpers/const");
 const _error = require("../../lib/helpers/error");
 const _git = require("../../lib/helpers/git");
 const _request = require("../../lib/helpers/request");
@@ -132,12 +133,16 @@ class BranchSwitch extends _basecommand.default {
         }
     }
     async fetchBranch(slug) {
-        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.get(`/v1/branches/${slug}`), {
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.branches.retrieve(slug, {
+                environment: _const.KnockEnv.Development
+            }), {
             action: "‣ Fetching branch"
         });
     }
     async createBranch(slug) {
-        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.post(`/v1/branches/${slug}`), {
+        return (0, _request.withSpinnerV2)(()=>this.apiV1.mgmtClient.branches.create(slug, {
+                environment: _const.KnockEnv.Development
+            }), {
             action: "‣ Creating branch"
         });
     }

package/dist/commands/guide/open.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return GuideOpen;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _browser = require("../../lib/helpers/browser");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _urls = require("../../lib/urls");
+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 GuideOpen extends _basecommand.default {
+    async run() {
+        const whoamiResp = await this.apiV1.whoami();
+        if (!(0, _request.isSuccessResp)(whoamiResp)) {
+            const message = (0, _request.formatErrorRespMessage)(whoamiResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        const { account_slug } = whoamiResp.data;
+        const { guideKey } = this.props.args;
+        const { environment, branch } = this.props.flags;
+        const envOrBranch = branch !== null && branch !== void 0 ? branch : environment;
+        const url = (0, _urls.viewGuideUrl)(this.sessionContext.dashboardOrigin, account_slug, envOrBranch, guideKey);
+        this.log(`‣ Opening guide \`${guideKey}\` in the Knock dashboard...`);
+        this.log(`  ${url}`);
+        await _browser.browser.openUrl(url);
+    }
+}
+_define_property(GuideOpen, "summary", "Open a guide in the Knock dashboard.");
+_define_property(GuideOpen, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    branch: _flag.branch
+});
+_define_property(GuideOpen, "args", {
+    guideKey: _core.Args.string({
+        required: true
+    })
+});

package/dist/commands/layout/open.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return LayoutOpen;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _browser = require("../../lib/helpers/browser");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _urls = require("../../lib/urls");
+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 LayoutOpen extends _basecommand.default {
+    async run() {
+        const whoamiResp = await this.apiV1.whoami();
+        if (!(0, _request.isSuccessResp)(whoamiResp)) {
+            const message = (0, _request.formatErrorRespMessage)(whoamiResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        const { account_slug } = whoamiResp.data;
+        const { layoutKey } = this.props.args;
+        const { environment, branch } = this.props.flags;
+        const envOrBranch = branch !== null && branch !== void 0 ? branch : environment;
+        const url = (0, _urls.viewLayoutUrl)(this.sessionContext.dashboardOrigin, account_slug, envOrBranch, layoutKey);
+        this.log(`‣ Opening layout \`${layoutKey}\` in the Knock dashboard...`);
+        this.log(`  ${url}`);
+        await _browser.browser.openUrl(url);
+    }
+}
+_define_property(LayoutOpen, "summary", "Open a layout in the Knock dashboard.");
+_define_property(LayoutOpen, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    branch: _flag.branch
+});
+_define_property(LayoutOpen, "args", {
+    layoutKey: _core.Args.string({
+        required: true
+    })
+});

package/dist/commands/message-type/open.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return MessageTypeOpen;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _browser = require("../../lib/helpers/browser");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _urls = require("../../lib/urls");
+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 MessageTypeOpen extends _basecommand.default {
+    async run() {
+        const whoamiResp = await this.apiV1.whoami();
+        if (!(0, _request.isSuccessResp)(whoamiResp)) {
+            const message = (0, _request.formatErrorRespMessage)(whoamiResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        const { account_slug } = whoamiResp.data;
+        const { messageTypeKey } = this.props.args;
+        const { environment, branch } = this.props.flags;
+        const envOrBranch = branch !== null && branch !== void 0 ? branch : environment;
+        const url = (0, _urls.viewMessageTypeUrl)(this.sessionContext.dashboardOrigin, account_slug, envOrBranch, messageTypeKey);
+        this.log(`‣ Opening message type \`${messageTypeKey}\` in the Knock dashboard...`);
+        this.log(`  ${url}`);
+        await _browser.browser.openUrl(url);
+    }
+}
+_define_property(MessageTypeOpen, "summary", "Open a message type in the Knock dashboard.");
+_define_property(MessageTypeOpen, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    branch: _flag.branch
+});
+_define_property(MessageTypeOpen, "args", {
+    messageTypeKey: _core.Args.string({
+        required: true
+    })
+});

package/dist/commands/partial/open.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return PartialOpen;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _browser = require("../../lib/helpers/browser");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _urls = require("../../lib/urls");
+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 PartialOpen extends _basecommand.default {
+    async run() {
+        const whoamiResp = await this.apiV1.whoami();
+        if (!(0, _request.isSuccessResp)(whoamiResp)) {
+            const message = (0, _request.formatErrorRespMessage)(whoamiResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        const { account_slug } = whoamiResp.data;
+        const { partialKey } = this.props.args;
+        const { environment, branch } = this.props.flags;
+        const envOrBranch = branch !== null && branch !== void 0 ? branch : environment;
+        const url = (0, _urls.viewPartialUrl)(this.sessionContext.dashboardOrigin, account_slug, envOrBranch, partialKey);
+        this.log(`‣ Opening partial \`${partialKey}\` in the Knock dashboard...`);
+        this.log(`  ${url}`);
+        await _browser.browser.openUrl(url);
+    }
+}
+_define_property(PartialOpen, "summary", "Open a partial in the Knock dashboard.");
+_define_property(PartialOpen, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    branch: _flag.branch
+});
+_define_property(PartialOpen, "args", {
+    partialKey: _core.Args.string({
+        required: true
+    })
+});

package/dist/commands/pull.js

@@ -15,12 +15,13 @@ const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/fl
 const _projectconfig = require("../lib/helpers/project-config");
 const _ux = require("../lib/helpers/ux");
 const _resources = require("../lib/resources");
-const _pull = /*#__PURE__*/ _interop_require_default(require("./guide/pull"));
-const _pull1 = /*#__PURE__*/ _interop_require_default(require("./layout/pull"));
-const _pull2 = /*#__PURE__*/ _interop_require_default(require("./message-type/pull"));
-const _pull3 = /*#__PURE__*/ _interop_require_default(require("./partial/pull"));
-const _pull4 = /*#__PURE__*/ _interop_require_default(require("./translation/pull"));
-const _pull5 = /*#__PURE__*/ _interop_require_default(require("./workflow/pull"));
+const _pull = /*#__PURE__*/ _interop_require_default(require("./audience/pull"));
+const _pull1 = /*#__PURE__*/ _interop_require_default(require("./guide/pull"));
+const _pull2 = /*#__PURE__*/ _interop_require_default(require("./layout/pull"));
+const _pull3 = /*#__PURE__*/ _interop_require_default(require("./message-type/pull"));
+const _pull4 = /*#__PURE__*/ _interop_require_default(require("./partial/pull"));
+const _pull5 = /*#__PURE__*/ _interop_require_default(require("./translation/pull"));
+const _pull6 = /*#__PURE__*/ _interop_require_default(require("./workflow/pull"));
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -140,39 +141,45 @@ _define_property(Pull, "flags", {
 const runResourcePullCommand = async (resourceType, targetDirCtx, args)=>{
     const subdirPath = _nodepath.resolve(targetDirCtx.abspath, _resources.RESOURCE_SUBDIRS[resourceType]);
     switch(resourceType){
+        case "audience":
+            return _pull.default.run([
+                ...args,
+                "--audiences-dir",
+                subdirPath
+            ]);
         case "email_layout":
-            return _pull1.default.run([
+            return _pull2.default.run([
                 ...args,
                 "--layouts-dir",
                 subdirPath
             ]);
         case "partial":
-            return _pull3.default.run([
+            return _pull4.default.run([
                 ...args,
                 "--partials-dir",
                 subdirPath
             ]);
         // TODO(KNO-9451): Include translation in the knock pull
         case "translation":
-            return _pull4.default.run([
+            return _pull5.default.run([
                 ...args,
                 "--translations-dir",
                 subdirPath
             ]);
         case "workflow":
-            return _pull5.default.run([
+            return _pull6.default.run([
                 ...args,
                 "--workflows-dir",
                 subdirPath
             ]);
         case "message_type":
-            return _pull2.default.run([
+            return _pull3.default.run([
                 ...args,
                 "--message-types-dir",
                 subdirPath
             ]);
         case "guide":
-            return _pull.default.run([
+            return _pull1.default.run([
                 ...args,
                 "--guides-dir",
                 subdirPath