@knocklabs/cli 1.0.0 → 1.0.3

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/push.js

@@ -162,7 +162,8 @@ _define_property(GuidePush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(GuidePush, "args", {
     guideKey: _core.Args.string({

package/dist/commands/layout/push.js

@@ -168,7 +168,8 @@ _define_property(EmailLayoutPush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(EmailLayoutPush, "args", {
     emailLayoutKey: _core.Args.string({

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

@@ -165,7 +165,8 @@ _define_property(MessageTypePush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(MessageTypePush, "args", {
     messageTypeKey: _core.Args.string({

package/dist/commands/partial/push.js

@@ -165,7 +165,8 @@ _define_property(PartialPush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(PartialPush, "args", {
     partialKey: _core.Args.string({

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

package/dist/commands/push.js

@@ -16,12 +16,13 @@ const _const = require("../lib/helpers/const");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/flag"));
 const _projectconfig = require("../lib/helpers/project-config");
 const _resources = require("../lib/resources");
-const _push = /*#__PURE__*/ _interop_require_default(require("./guide/push"));
-const _push1 = /*#__PURE__*/ _interop_require_default(require("./layout/push"));
-const _push2 = /*#__PURE__*/ _interop_require_default(require("./message-type/push"));
-const _push3 = /*#__PURE__*/ _interop_require_default(require("./partial/push"));
-const _push4 = /*#__PURE__*/ _interop_require_default(require("./translation/push"));
-const _push5 = /*#__PURE__*/ _interop_require_default(require("./workflow/push"));
+const _push = /*#__PURE__*/ _interop_require_default(require("./audience/push"));
+const _push1 = /*#__PURE__*/ _interop_require_default(require("./guide/push"));
+const _push2 = /*#__PURE__*/ _interop_require_default(require("./layout/push"));
+const _push3 = /*#__PURE__*/ _interop_require_default(require("./message-type/push"));
+const _push4 = /*#__PURE__*/ _interop_require_default(require("./partial/push"));
+const _push5 = /*#__PURE__*/ _interop_require_default(require("./translation/push"));
+const _push6 = /*#__PURE__*/ _interop_require_default(require("./workflow/push"));
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -111,6 +112,9 @@ class Push extends _basecommand.default {
             ...flags["commit-message"] ? [
                 "--commit-message",
                 flags["commit-message"]
+            ] : [],
+            ...flags.force ? [
+                "--force"
             ] : []
         ];
         // Note: Because we're pushing the different resource types sequentially,
@@ -146,7 +150,8 @@ _define_property(Push, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 const runResourcePushCommand = async (resourceType, targetDirCtx, args)=>{
     const subdirPath = _nodepath.resolve(targetDirCtx.abspath, _resources.RESOURCE_SUBDIRS[resourceType]);
@@ -155,38 +160,44 @@ const runResourcePushCommand = async (resourceType, targetDirCtx, args)=>{
         return;
     }
     switch(resourceType){
+        case "audience":
+            return _push.default.run([
+                ...args,
+                "--audiences-dir",
+                subdirPath
+            ]);
         case "email_layout":
-            return _push1.default.run([
+            return _push2.default.run([
                 ...args,
                 "--layouts-dir",
                 subdirPath
             ]);
         case "partial":
-            return _push3.default.run([
+            return _push4.default.run([
                 ...args,
                 "--partials-dir",
                 subdirPath
             ]);
         case "translation":
-            return _push4.default.run([
+            return _push5.default.run([
                 ...args,
                 "--translations-dir",
                 subdirPath
             ]);
         case "workflow":
-            return _push5.default.run([
+            return _push6.default.run([
                 ...args,
                 "--workflows-dir",
                 subdirPath
             ]);
         case "message_type":
-            return _push2.default.run([
+            return _push3.default.run([
                 ...args,
                 "--message-types-dir",
                 subdirPath
             ]);
         case "guide":
-            return _push.default.run([
+            return _push1.default.run([
                 ...args,
                 "--guides-dir",
                 subdirPath

package/dist/commands/translation/push.js

@@ -153,7 +153,8 @@ _define_property(TranslationPush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(TranslationPush, "args", {
     translationRef: _core.Args.string({

package/dist/commands/workflow/push.js

@@ -162,7 +162,8 @@ _define_property(WorkflowPush, "flags", {
         dependsOn: [
             "commit"
         ]
-    })
+    }),
+    force: _flag.force
 });
 _define_property(WorkflowPush, "args", {
     workflowKey: _core.Args.string({

package/dist/lib/api-v1.js

@@ -73,7 +73,8 @@ class ApiV1 {
             branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
-            commit_message: flags["commit-message"]
+            commit_message: flags["commit-message"],
+            force: flags.force
         });
         const data = {
             workflow
@@ -187,7 +188,8 @@ class ApiV1 {
             branch: flags.branch,
             commit: flags.commit,
             commit_message: flags["commit-message"],
-            namespace: translation.namespace
+            namespace: translation.namespace,
+            force: flags.force
         });
         return this.put(`/translations/${translation.locale_code}`, {
             translation
@@ -238,7 +240,8 @@ class ApiV1 {
             branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
-            commit_message: flags["commit-message"]
+            commit_message: flags["commit-message"],
+            force: flags.force
         });
         const data = {
             email_layout: layout
@@ -289,7 +292,8 @@ class ApiV1 {
             branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
-            commit_message: flags["commit-message"]
+            commit_message: flags["commit-message"],
+            force: flags.force
         });
         const data = {
             partial
@@ -347,7 +351,8 @@ class ApiV1 {
             branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
-            commit_message: flags["commit-message"]
+            commit_message: flags["commit-message"],
+            force: flags.force
         });
         const data = {
             message_type: messageType
@@ -411,7 +416,8 @@ class ApiV1 {
             branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
-            commit_message: flags["commit-message"]
+            commit_message: flags["commit-message"],
+            force: flags.force
         });
         const data = {
             guide

package/dist/lib/helpers/flag.js

@@ -21,6 +21,9 @@ _export(exports, {
     get filePath () {
         return filePath;
     },
+    get force () {
+        return force;
+    },
     get jsonStr () {
         return jsonStr;
     },
@@ -152,3 +155,6 @@ const branch = slug({
     // Using lodash's once avoids unnecessarily reading the branch file multiple times.
     default: (0, _lodash.once)(_branch.readSlugFromBranchFile)
 });
+const force = _core.Flags.boolean({
+    summary: "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. " + "If you're using this on a non-development environment, you should also ensure you `commit` the changes."
+});

package/dist/lib/helpers/git.js

@@ -2,9 +2,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "isFileIgnoredByGit", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get getCurrentGitBranch () {
+        return getCurrentGitBranch;
+    },
+    get isFileIgnoredByGit () {
         return isFileIgnoredByGit;
     }
 });
@@ -23,3 +31,14 @@ const isFileIgnoredByGit = async (currDir, filePath)=>{
         return false;
     }
 };
+const getCurrentGitBranch = ()=>{
+    try {
+        const branch = (0, _nodechild_process.execSync)("git rev-parse --abbrev-ref HEAD", {
+            stdio: "pipe",
+            encoding: "utf-8"
+        }).trim();
+        return branch;
+    } catch  {
+        return undefined;
+    }
+};

package/dist/lib/helpers/project-config.js

@@ -130,6 +130,7 @@ const findAndReadProjectConfig = async ()=>{
     return readProjectConfig(configPath);
 };
 const ResourceDirectoriesByType = {
+    audience: "audiences",
     workflow: "workflows",
     guide: "guides",
     partial: "partials",

package/dist/lib/marshal/audience/generator.js

@@ -0,0 +1,38 @@
+"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 generateAudienceDir () {
+        return generateAudienceDir;
+    },
+    get scaffoldAudienceDirBundle () {
+        return scaffoldAudienceDirBundle;
+    }
+});
+const _processorisomorphic = require("./processor.isomorphic");
+const _writer = require("./writer");
+/*
+ * Scaffolds a new audience directory bundle with default content.
+ */ const scaffoldAudienceDirBundle = (attrs)=>{
+    const audienceJson = {
+        name: attrs.name,
+        type: attrs.type
+    };
+    if (attrs.description) {
+        audienceJson.description = attrs.description;
+    }
+    return {
+        [_processorisomorphic.AUDIENCE_JSON]: audienceJson
+    };
+};
+const generateAudienceDir = async (audienceDirCtx, attrs)=>{
+    const bundle = scaffoldAudienceDirBundle(attrs);
+    return (0, _writer.writeAudienceDirFromBundle)(audienceDirCtx, bundle);
+};