@knocklabs/cli 1.0.0 → 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/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, {
@@ -155,38 +156,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/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);
+};

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

@@ -0,0 +1,142 @@
+"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 audienceJsonPath () {
+        return audienceJsonPath;
+    },
+    get ensureValidCommandTarget () {
+        return ensureValidCommandTarget;
+    },
+    get isAudienceDir () {
+        return isAudienceDir;
+    },
+    get lsAudienceJson () {
+        return lsAudienceJson;
+    },
+    get validateAudienceKey () {
+        return validateAudienceKey;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _projectconfig = require("../../helpers/project-config");
+const _string = require("../../helpers/string");
+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 audienceJsonPath = (audienceDirCtx)=>_nodepath.resolve(audienceDirCtx.abspath, _processorisomorphic.AUDIENCE_JSON);
+const lsAudienceJson = async (dirPath)=>{
+    const audienceJsonPath = _nodepath.resolve(dirPath, _processorisomorphic.AUDIENCE_JSON);
+    const exists = await _fsextra.pathExists(audienceJsonPath);
+    return exists ? audienceJsonPath : undefined;
+};
+const isAudienceDir = async (dirPath)=>Boolean(await lsAudienceJson(dirPath));
+const validateAudienceKey = (input)=>{
+    if (!(0, _string.checkSlugifiedFormat)(input, {
+        onlyLowerCase: true
+    })) {
+        return "must include only lowercase alphanumeric, dash, or underscore characters";
+    }
+    return undefined;
+};
+const ensureValidCommandTarget = async (props, runContext, projectConfig)=>{
+    const { args, flags } = props;
+    const { commandId, resourceDir: resourceDirCtx, cwd: runCwd } = runContext;
+    // If the target resource is a different type than the current resource dir
+    // type, error out.
+    if (resourceDirCtx && resourceDirCtx.type !== "audience") {
+        return _core.ux.error(`Cannot run ${commandId} inside a ${resourceDirCtx.type} directory`);
+    }
+    // Cannot accept both audience key arg and --all flag.
+    if (flags.all && args.audienceKey) {
+        return _core.ux.error(`audienceKey arg \`${args.audienceKey}\` cannot also be provided when using --all`);
+    }
+    // Default to knock project config first if present, otherwise cwd.
+    const audiencesIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(projectConfig, "audience", runCwd);
+    // --all flag is given, which means no audience key arg.
+    if (flags.all) {
+        // If --all flag used inside an audience directory, then require an audiences
+        // dir path.
+        if (resourceDirCtx && !flags["audiences-dir"]) {
+            return _core.ux.error("Missing required flag audiences-dir");
+        }
+        return {
+            type: "audiencesIndexDir",
+            context: flags["audiences-dir"] || audiencesIndexDirCtx
+        };
+    }
+    // Audience key arg is given, which means no --all flag.
+    if (args.audienceKey) {
+        if (resourceDirCtx && resourceDirCtx.key !== args.audienceKey) {
+            return _core.ux.error(`Cannot run ${commandId} \`${args.audienceKey}\` inside another audience directory:\n${resourceDirCtx.key}`);
+        }
+        const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(audiencesIndexDirCtx.abspath, args.audienceKey);
+        const audienceDirCtx = {
+            type: "audience",
+            key: args.audienceKey,
+            abspath: targetDirPath,
+            exists: await isAudienceDir(targetDirPath)
+        };
+        return {
+            type: "audienceDir",
+            context: audienceDirCtx
+        };
+    }
+    // From this point on, we have neither an audience key arg nor --all flag.
+    // If running inside an audience directory, then use that audience directory.
+    if (resourceDirCtx) {
+        return {
+            type: "audienceDir",
+            context: resourceDirCtx
+        };
+    }
+    return _core.ux.error("Missing 1 required arg:\naudienceKey");
+};

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./generator"), exports);
+_export_star(require("./helpers"), exports);
+_export_star(require("./processor.isomorphic"), exports);
+_export_star(require("./reader"), exports);
+_export_star(require("./types"), exports);
+_export_star(require("./writer"), 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/audience/processor.isomorphic.js

@@ -0,0 +1,25 @@
+"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 AUDIENCE_JSON () {
+        return AUDIENCE_JSON;
+    },
+    get buildAudienceDirBundle () {
+        return buildAudienceDirBundle;
+    }
+});
+const _helpersisomorphic = require("../shared/helpers.isomorphic");
+const AUDIENCE_JSON = "audience.json";
+const buildAudienceDirBundle = (remoteAudience, _localAudience, $schema)=>{
+    return {
+        [AUDIENCE_JSON]: (0, _helpersisomorphic.prepareResourceJson)(remoteAudience, $schema)
+    };
+};