@knocklabs/cli 0.1.4 → 0.1.6

package/dist/commands/layout/push.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>EmailLayoutPush
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/helpers/flag"));
+const _object = require("../../lib/helpers/object");
+const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
+const _emailLayout = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/email-layout"));
+const _validate = /*#__PURE__*/ _interopRequireDefault(require("./validate"));
+function _interopRequireDefault(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 _interopRequireWildcard(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 = {};
+    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 EmailLayoutPush extends _baseCommand.default {
+    async run() {
+        const { flags  } = this.props;
+        // 1. First read all layout directories found for the given command.
+        const target = await _emailLayout.ensureValidCommandTarget(this.props, this.runContext);
+        const [layouts, readErrors] = await _emailLayout.readAllForCommandTarget(target, {
+            withExtractedFiles: true
+        });
+        if (readErrors.length > 0) {
+            this.error((0, _error.formatErrors)(readErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        if (layouts.length === 0) {
+            this.error(`No layout directories found in ${target.context.abspath}`);
+        }
+        // 2. Then validate them all ahead of pushing them.
+        _ux.spinner.start(`‣ Validating`);
+        const apiErrors = await _validate.default.validateAll(this.apiV1, this.props, layouts);
+        if (apiErrors.length > 0) {
+            this.error((0, _error.formatErrors)(apiErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        _ux.spinner.stop();
+        // 3. Finally push up each layout, abort on the first error.
+        _ux.spinner.start(`‣ Pushing`);
+        for (const layout of layouts){
+            const props = (0, _object.merge)(this.props, {
+                flags: {
+                    annotate: true
+                }
+            });
+            // eslint-disable-next-line no-await-in-loop
+            const resp = await this.apiV1.upsertEmailLayout(props, {
+                ...layout.content,
+                key: layout.key
+            });
+            if ((0, _request.isSuccessResp)(resp)) {
+                // Update the layout directory with the successfully pushed layout
+                // payload from the server.
+                // eslint-disable-next-line no-await-in-loop
+                await _emailLayout.writeEmailLayoutDirFromData(layout, resp.data.email_layout);
+                continue;
+            }
+            const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _emailLayout.emailLayoutJsonPath(layout), "ApiError");
+            this.error((0, _error.formatError)(error));
+        }
+        _ux.spinner.stop();
+        // 4. Display a success message.
+        const layoutKeys = layouts.map((l)=>l.key);
+        const actioned = flags.commit ? "pushed and committed" : "pushed";
+        this.log(`‣ Successfully ${actioned} ${layouts.length} layout(s):\n` + (0, _string.indentString)(layoutKeys.join("\n"), 4));
+    }
+}
+EmailLayoutPush.summary = "Push one or more email layouts from a local file system to Knock.";
+EmailLayoutPush.flags = {
+    environment: _core.Flags.string({
+        summary: "Pushing an email layout is only allowed in the development environment",
+        default: _const.KnockEnv.Development,
+        options: [
+            _const.KnockEnv.Development
+        ]
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to push all layouts from the target directory."
+    }),
+    "layouts-dir": _flag.dirPath({
+        summary: "The target directory path to find all layouts to push.",
+        dependsOn: [
+            "all"
+        ],
+        aliases: [
+            "email-layouts-dir"
+        ]
+    }),
+    commit: _core.Flags.boolean({
+        summary: "Push and commit the layout(s) at the same time"
+    }),
+    "commit-message": _core.Flags.string({
+        summary: "Use the given value as the commit message",
+        char: "m",
+        dependsOn: [
+            "commit"
+        ]
+    })
+};
+EmailLayoutPush.args = {
+    emailLayoutKey: _core.Args.string({
+        required: false
+    })
+};

package/dist/commands/layout/validate.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>EmailLayoutValidate
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
+const _emailLayout = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/email-layout"));
+function _interopRequireDefault(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 _interopRequireWildcard(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 = {};
+    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 EmailLayoutValidate extends _baseCommand.default {
+    async run() {
+        // 1. Read all layout directories found for the given command.
+        const target = await _emailLayout.ensureValidCommandTarget(this.props, this.runContext);
+        const [layouts, readErrors] = await _emailLayout.readAllForCommandTarget(target, {
+            withExtractedFiles: true
+        });
+        if (readErrors.length > 0) {
+            this.error((0, _error.formatErrors)(readErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        if (layouts.length === 0) {
+            this.error(`No layout directories found in ${target.context.abspath}`);
+        }
+        // 2. Validate each layout data
+        _ux.spinner.start(`‣ Validating`);
+        const apiErrors = await EmailLayoutValidate.validateAll(this.apiV1, this.props, layouts);
+        if (apiErrors.length > 0) {
+            this.error((0, _error.formatErrors)(apiErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        _ux.spinner.stop();
+        // 3. Display a success message.
+        const layoutsKey = layouts.map((l)=>l.key);
+        this.log(`‣ Successfully validated ${layouts.length} layout(s):\n` + (0, _string.indentString)(layoutsKey.join("\n"), 4));
+    }
+    static async validateAll(api, props, layouts) {
+        const errorPromises = layouts.map(async (layout)=>{
+            const resp = await api.validateEmailLayout(props, {
+                ...layout.content,
+                key: layout.key
+            });
+            if ((0, _request.isSuccessResp)(resp)) return;
+            const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _emailLayout.emailLayoutJsonPath(layout), "ApiError");
+            return error;
+        });
+        const errors = (await Promise.all(errorPromises)).filter((e)=>Boolean(e));
+        return errors;
+    }
+}
+EmailLayoutValidate.summary = "Validate one or more layouts from a local file system.";
+EmailLayoutValidate.flags = {
+    environment: _core.Flags.string({
+        summary: "Validating a layout is only done in the development environment",
+        default: _const.KnockEnv.Development,
+        options: [
+            _const.KnockEnv.Development
+        ]
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to validate all layouts from the target directory."
+    }),
+    "layouts-dir": _flag.dirPath({
+        summary: "The target directory path to find all layouts to validate.",
+        dependsOn: [
+            "all"
+        ],
+        aliases: [
+            "email-layouts-dir"
+        ]
+    })
+};
+EmailLayoutValidate.args = {
+    emailLayoutKey: _core.Args.string({
+        required: false
+    })
+};

package/dist/commands/workflow/get.js

@@ -9,7 +9,10 @@ Object.defineProperty(exports, "default", {
 const _core = require("@oclif/core");
 const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
 const _date = require("../../lib/helpers/date");
+const _error = require("../../lib/helpers/error");
 const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
 const _conditions = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/conditions"));
 const _workflow = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/workflow"));
 function _interopRequireDefault(obj) {
@@ -58,12 +61,30 @@ function _interopRequireWildcard(obj, nodeInterop) {
 }
 class WorkflowGet extends _baseCommand.default {
     async run() {
-        const resp = await (0, _request.withSpinner)(()=>this.apiV1.getWorkflow(this.props));
+        _ux.spinner.start("‣ Loading");
+        const { workflow , whoami  } = await this.loadWorkflow();
+        _ux.spinner.stop();
         const { flags  } = this.props;
-        if (flags.json) return resp.data;
-        this.render(resp.data);
+        if (flags.json) return workflow;
+        this.render(workflow, whoami);
     }
-    render(workflow) {
+    async loadWorkflow() {
+        const workflowResp = await this.apiV1.getWorkflow(this.props);
+        if (!(0, _request.isSuccessResp)(workflowResp)) {
+            const message = (0, _request.formatErrorRespMessage)(workflowResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        const whoamiResp = await this.apiV1.whoami();
+        if (!(0, _request.isSuccessResp)(whoamiResp)) {
+            const message = (0, _request.formatErrorRespMessage)(whoamiResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        return {
+            workflow: workflowResp.data,
+            whoami: whoamiResp.data
+        };
+    }
+    render(workflow, whoami) {
         const { workflowKey  } = this.props.args;
         const { environment: env , "hide-uncommitted-changes": commitedOnly  } = this.props.flags;
         const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
@@ -130,11 +151,13 @@ class WorkflowGet extends _baseCommand.default {
             },
             ref: {
                 header: "Ref",
-                minWidth: 18
+                minWidth: 18,
+                get: (step)=>step.ref
             },
             type: {
                 header: "Type",
-                minWidth: 12
+                minWidth: 12,
+                get: (step)=>step.type
             },
             summary: {
                 header: "Summary",
@@ -142,9 +165,18 @@ class WorkflowGet extends _baseCommand.default {
             },
             conditions: {
                 header: "Conditions",
-                get: (step)=>step.conditions ? _conditions.formatConditions(step.conditions) : "-"
+                get: (step)=>{
+                    if (step.type === _workflow.StepType.Branch) return "-";
+                    if (!step.conditions) return "-";
+                    return _conditions.formatConditions(step.conditions);
+                }
             }
         });
+        const hasTopLevelBranchStep = workflow.steps.some((step)=>step.type === _workflow.StepType.Branch);
+        const dashboardLinkMessage = hasTopLevelBranchStep ? `\n‣ This workflow has branches with nested steps, view the full workflow tree in the Knock Dashboard:` : `\n‣ View the full workflow in the Knock Dashboard:`;
+        const viewWorkflowUrl = `https://dashboard.knock.app/${whoami.account_slug}/${env.toLowerCase()}/workflows/${workflow.key}`;
+        this.log(dashboardLinkMessage);
+        this.log((0, _string.indentString)(viewWorkflowUrl, 2));
     }
 }
 WorkflowGet.summary = "Display a single workflow from an environment.";

package/dist/commands/workflow/list.js

@@ -98,7 +98,10 @@ class WorkflowList extends _baseCommand.default {
             },
             steps: {
                 header: "Steps",
-                get: (entry)=>entry.steps.length > 0 ? entry.steps.length : "-"
+                get: (entry)=>{
+                    const result = _workflow.countSteps(entry);
+                    return result > 0 ? result : "-";
+                }
             },
             updated_at: {
                 header: "Updated at",

package/dist/lib/api-v1.js

@@ -159,6 +159,53 @@ class ApiV1 {
             params
         });
     }
+    // By resources: Email layouts
+    async listEmailLayouts({ flags  }) {
+        const params = (0, _object.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            hide_uncommitted_changes: flags["hide-uncommitted-changes"],
+            ...(0, _page.toPageParams)(flags)
+        });
+        return this.get("/email_layouts", {
+            params
+        });
+    }
+    async getEmailLayout({ args , flags  }) {
+        const params = (0, _object.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            hide_uncommitted_changes: flags["hide-uncommitted-changes"]
+        });
+        return this.get(`/email_layouts/${args.emailLayoutKey}`, {
+            params
+        });
+    }
+    async upsertEmailLayout({ flags  }, layout) {
+        const params = (0, _object.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            commit: flags.commit,
+            commit_message: flags["commit-message"]
+        });
+        const data = {
+            email_layout: layout
+        };
+        return this.put(`/email_layouts/${layout.key}`, data, {
+            params
+        });
+    }
+    async validateEmailLayout({ flags  }, layout) {
+        const params = (0, _object.prune)({
+            environment: flags.environment
+        });
+        const data = {
+            email_layout: layout
+        };
+        return this.put(`/email_layouts/${layout.key}/validate`, data, {
+            params
+        });
+    }
     // By methods:
     async get(subpath, config) {
         return this.client.get(`/${API_VERSION}` + subpath, config);

package/dist/lib/marshal/email-layout/helpers.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    LAYOUT_JSON: ()=>LAYOUT_JSON,
+    emailLayoutJsonPath: ()=>emailLayoutJsonPath,
+    isEmailLayoutDir: ()=>isEmailLayoutDir,
+    lsEmailLayoutJson: ()=>lsEmailLayoutJson,
+    ensureValidCommandTarget: ()=>ensureValidCommandTarget
+});
+const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
+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 _interopRequireWildcard(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 = {};
+    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 LAYOUT_JSON = "layout.json";
+const emailLayoutJsonPath = (layoutDirCtx)=>_nodePath.resolve(layoutDirCtx.abspath, LAYOUT_JSON);
+const isEmailLayoutDir = async (dirPath)=>Boolean(await lsEmailLayoutJson(dirPath));
+const lsEmailLayoutJson = async (dirPath)=>{
+    const emailLayoutJsonPath = _nodePath.resolve(dirPath, LAYOUT_JSON);
+    const exists = await _fsExtra.pathExists(emailLayoutJsonPath);
+    return exists ? emailLayoutJsonPath : undefined;
+};
+const ensureValidCommandTarget = async (props, runContext)=>{
+    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 !== "email_layout") {
+        return _core.ux.error(`Cannot run ${commandId} inside a ${resourceDirCtx.type} directory`);
+    }
+    // Cannot accept both email layout key arg and --all flag.
+    if (flags.all && args.emailLayoutKey) {
+        return _core.ux.error(`emailLayoutKey arg \`${args.emailLayoutKey}\` cannot also be provided when using --all`);
+    }
+    // --all flag is given, which means no layout key arg.
+    if (flags.all) {
+        // If --all flag used inside a layout directory, then require a layouts dir path.
+        if (resourceDirCtx && !flags["layouts-dir"]) {
+            return _core.ux.error("Missing required flag layouts-dir");
+        }
+        // Targeting all layout dirs in the layouts index dir.
+        // TODO: Default to the knock project config first if present before cwd.
+        const defaultToCwd = {
+            abspath: runCwd,
+            exists: true
+        };
+        const indexDirCtx = flags["layouts-dir"] || defaultToCwd;
+        return {
+            type: "emailLayoutsIndexDir",
+            context: indexDirCtx
+        };
+    }
+    // Email layout key arg is given, which means no --all flag.
+    if (args.emailLayoutKey) {
+        if (resourceDirCtx && resourceDirCtx.key !== args.emailLayoutKey) {
+            return _core.ux.error(`Cannot run ${commandId} \`${args.emailLayoutKey}\` inside another layout directory:\n${resourceDirCtx.key}`);
+        }
+        const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodePath.resolve(runCwd, args.emailLayoutKey);
+        const layoutDirCtx = {
+            type: "email_layout",
+            key: args.emailLayoutKey,
+            abspath: targetDirPath,
+            exists: await isEmailLayoutDir(targetDirPath)
+        };
+        return {
+            type: "emailLayoutDir",
+            context: layoutDirCtx
+        };
+    }
+    // From this point on, we have neither an email layout key arg nor --all flag.
+    // If running inside a layout directory, then use that.
+    if (resourceDirCtx) {
+        return {
+            type: "emailLayoutDir",
+            context: resourceDirCtx
+        };
+    }
+    return _core.ux.error("Missing 1 required arg:emailLayoutKey");
+};

package/dist/lib/marshal/email-layout/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_exportStar(require("./helpers"), exports);
+_exportStar(require("./reader"), exports);
+_exportStar(require("./types"), exports);
+_exportStar(require("./writer"), exports);
+function _exportStar(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;
+}