@knocklabs/cli 1.1.1 → 1.2.2

package/dist/commands/source/get.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return SourceGet;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
+const _date = require("../../lib/helpers/date");
+const _error = require("../../lib/helpers/error");
+const _request = require("../../lib/helpers/request");
+const _ux = require("../../lib/helpers/ux");
+const _helpers = require("../../lib/marshal/source/helpers");
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class SourceGet extends _basecommand.default {
+    async run() {
+        _ux.spinner.start("‣ Loading");
+        const { source } = await this.loadSource();
+        _ux.spinner.stop();
+        const { flags } = this.props;
+        if (flags.json) return source;
+        this.render(source);
+    }
+    async loadSource() {
+        const sourceResp = await this.apiV1.getSource(this.props);
+        if (!(0, _request.isSuccessResp)(sourceResp)) {
+            const message = (0, _request.formatErrorRespMessage)(sourceResp);
+            _core.ux.error(new _error.ApiError(message));
+        }
+        return {
+            source: sourceResp.data
+        };
+    }
+    render(source) {
+        var _source_environment_settings;
+        const { sourceKey } = this.props.args;
+        const { environment } = this.props.flags;
+        const scope = environment ? ` in ${(0, _command.formatCommandScope)({
+            environment
+        })}` : "";
+        this.log(`‣ Showing source \`${sourceKey}\`${scope}\n`);
+        /*
+     * Source table
+     */ const rows = [
+            {
+                key: "Name",
+                value: source.name
+            },
+            {
+                key: "Key",
+                value: source.key
+            },
+            {
+                key: "Description",
+                value: source.description || "-"
+            },
+            {
+                key: "Custom image URL",
+                value: source.custom_image_url || "-"
+            },
+            {
+                key: "Created at",
+                value: (0, _date.formatDateTime)(source.created_at)
+            },
+            {
+                key: "Updated at",
+                value: (0, _date.formatDateTime)(source.updated_at)
+            }
+        ];
+        _core.ux.table(rows, {
+            key: {
+                header: "Source",
+                minWidth: 24
+            },
+            value: {
+                header: "",
+                minWidth: 24
+            }
+        });
+        this.log("");
+        /*
+     * Per-environment settings
+     */ const envSettings = (_source_environment_settings = source.environment_settings) !== null && _source_environment_settings !== void 0 ? _source_environment_settings : {};
+        for (const slug of Object.keys(envSettings)){
+            this.renderEnvironmentSettings(slug, envSettings[slug]);
+        }
+    }
+    renderEnvironmentSettings(slug, envSettings) {
+        const { settings, mappings } = envSettings;
+        /*
+     * A curated subset of the open-ended `settings` object, in display order;
+     * the full object is always available via `--json`.
+     */ const settingsRows = [
+            {
+                key: "Endpoint",
+                value: (0, _helpers.formatSettingValue)(settings.endpoint)
+            },
+            {
+                key: "Event type path",
+                value: (0, _helpers.formatSettingValue)(settings.event_type_path)
+            },
+            {
+                key: "Timestamp path",
+                value: (0, _helpers.formatSettingValue)(settings.timestamp_path)
+            },
+            {
+                key: "Idempotency key path",
+                value: (0, _helpers.formatSettingValue)(settings.idempotency_key_path)
+            },
+            {
+                key: "Enforce verification",
+                value: (0, _helpers.formatSettingValue)(settings.enforce_verification)
+            },
+            {
+                key: "Preprocess script",
+                value: (0, _helpers.formatPreprocessScript)(settings)
+            }
+        ];
+        _core.ux.table(settingsRows, {
+            key: {
+                header: `Settings (${slug})`,
+                minWidth: 24
+            },
+            value: {
+                header: "",
+                minWidth: 24
+            }
+        });
+        this.log("");
+        if (mappings.length > 0) {
+            _core.ux.table(mappings, {
+                event_type: {
+                    header: "Event type"
+                },
+                action_type: {
+                    header: "Action type"
+                },
+                status: {
+                    header: "Status",
+                    get: (mapping)=>(0, _helpers.formatMappingStatus)(mapping)
+                }
+            });
+            this.log("");
+        }
+    }
+}
+_define_property(SourceGet, "summary", "Display a single source from an environment.");
+_define_property(SourceGet, "flags", {
+    environment: _core.Flags.string({
+        summary: "The environment to use."
+    })
+});
+_define_property(SourceGet, "args", {
+    sourceKey: _core.Args.string({
+        required: true
+    })
+});
+_define_property(SourceGet, "enableJsonFlag", true);

package/dist/commands/source/list.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return SourceList;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
+const _date = require("../../lib/helpers/date");
+const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class SourceList extends _basecommand.default {
+    async run() {
+        const resp = await this.request();
+        const { flags } = this.props;
+        if (flags.json) return resp.data;
+        this.render(resp.data);
+    }
+    async request(pageParams = {}) {
+        const props = (0, _objectisomorphic.merge)(this.props, {
+            flags: {
+                ...pageParams
+            }
+        });
+        return (0, _request.withSpinner)(()=>this.apiV1.listSources(props));
+    }
+    async render(data) {
+        const { entries } = data;
+        const { environment } = this.props.flags;
+        const scope = environment ? ` in ${(0, _command.formatCommandScope)({
+            environment
+        })}` : "";
+        this.log(`‣ Showing ${entries.length} sources${scope}\n`);
+        /*
+     * Sources list table
+     */ _core.ux.table(entries, {
+            key: {
+                header: "Key"
+            },
+            name: {
+                header: "Name"
+            },
+            description: {
+                header: "Description",
+                get: (entry)=>entry.description || "-"
+            },
+            updated_at: {
+                header: "Updated at",
+                get: (entry)=>(0, _date.formatDate)(entry.updated_at)
+            }
+        });
+        return this.prompt(data);
+    }
+    async prompt(data) {
+        const { page_info } = data;
+        const pageAction = await (0, _page.maybePromptPageAction)(page_info);
+        const pageParams = pageAction && (0, _page.paramsForPageAction)(pageAction, page_info);
+        if (pageParams) {
+            this.log("\n");
+            const resp = await this.request(pageParams);
+            return this.render(resp.data);
+        }
+    }
+}
+_define_property(SourceList, "summary", "Display all sources for an environment.");
+_define_property(SourceList, "flags", {
+    environment: _core.Flags.string({
+        summary: "The environment to use."
+    }),
+    ..._page.pageFlags
+});
+_define_property(SourceList, "enableJsonFlag", true);

package/dist/commands/translation/push.js

@@ -154,6 +154,7 @@ _define_property(TranslationPush, "flags", {
             "commit"
         ]
     }),
+    "allow-empty": _flag.allowEmptyOnPush,
     force: _flag.force
 });
 _define_property(TranslationPush, "args", {

package/dist/commands/whoami.js

@@ -40,10 +40,16 @@ class Whoami extends _basecommand.default {
             `Service token name: ${resp.service_token_name}`
         ] : [
             `Account name: ${resp.account_name}`,
-            `User ID: ${resp.user_id}`
+            `User ID: ${resp.user_id}`,
+            ...resp.user_name ? [
+                `User name: ${resp.user_name}`
+            ] : [],
+            ...resp.user_email ? [
+                `User email: ${resp.user_email}`
+            ] : []
         ];
         this.log((0, _string.indentString)(info.join("\n"), 4));
     }
 }
-_define_property(Whoami, "summary", "Verify the provided service token.");
+_define_property(Whoami, "summary", "Verify authentication and show the current account and user.");
 _define_property(Whoami, "enableJsonFlag", true);

package/dist/commands/workflow/get.js

@@ -135,6 +135,12 @@ class WorkflowGet extends _basecommand.default {
                     emptyDisplay: "-"
                 })
             },
+            {
+                key: "Tags",
+                value: _workflow.formatTags(workflow, {
+                    emptyDisplay: "-"
+                })
+            },
             {
                 key: "Created at",
                 value: (0, _date.formatDateTime)(workflow.created_at)

package/dist/commands/workflow/list.js

@@ -116,6 +116,12 @@ class WorkflowList extends _basecommand.default {
                         truncateAfter: 3
                     })
             },
+            tags: {
+                header: "Tags",
+                get: (entry)=>_workflow.formatTags(entry, {
+                        truncateAfter: 3
+                    })
+            },
             steps: {
                 header: "Steps",
                 get: (entry)=>{

package/dist/commands/workflow/push.js

@@ -163,6 +163,7 @@ _define_property(WorkflowPush, "flags", {
             "commit"
         ]
     }),
+    "allow-empty": _flag.allowEmptyOnPush,
     force: _flag.force
 });
 _define_property(WorkflowPush, "args", {

package/dist/commands/workflow/run.js

@@ -106,6 +106,12 @@ _define_property(WorkflowRun, "flags", {
     }),
     data: (0, _flag.jsonStr)({
         summary: "A JSON string of the data for this workflow"
+    }),
+    "sandbox-mode": _core.Flags.boolean({
+        summary: "When enabled, channels in this workflow generate messages but don't send them to the downstream provider."
+    }),
+    "skip-delay": _core.Flags.boolean({
+        summary: "When enabled, delay steps in this workflow will be skipped"
     })
 });
 _define_property(WorkflowRun, "args", {

package/dist/help.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return KnockHelp;
+    }
+});
+const _core = require("@oclif/core");
+const BRAND_COLOR = "#FF573A";
+const WORDMARK = `
+██╗  ██╗███╗   ██╗ ██████╗  ██████╗██╗  ██╗
+██║ ██╔╝████╗  ██║██╔═══██╗██╔════╝██║ ██╔╝
+█████╔╝ ██╔██╗ ██║██║   ██║██║     █████╔╝ 
+██╔═██╗ ██║╚██╗██║██║   ██║██║     ██╔═██╗ 
+██║  ██╗██║ ╚████║╚██████╔╝╚██████╗██║  ██╗
+╚═╝  ╚═╝╚═╝  ╚═══╝ ╚═════╝  ╚═════╝╚═╝  ╚═╝
+`.trim();
+const GET_STARTED = [
+    [
+        "knock login",
+        "Log in with a Knock user account"
+    ],
+    [
+        "knock init",
+        "Initialize a new Knock project (knock.json)"
+    ]
+];
+const COMMON = [
+    [
+        "knock workflow pull",
+        "Pull workflows into a local file system"
+    ],
+    [
+        "knock workflow push",
+        "Push workflows from a local file system to Knock"
+    ],
+    [
+        "knock push",
+        "Push all resources from a local file system to Knock"
+    ],
+    [
+        "knock commit promote",
+        "Promote commits to the subsequent environment"
+    ],
+    [
+        "knock <command> --help",
+        "Get help for a command"
+    ]
+];
+function brand(text) {
+    return _core.ux.colorize(BRAND_COLOR, text);
+}
+class KnockHelp extends _core.Help {
+    async showRootHelp() {
+        this.log("");
+        this.log(brand(WORDMARK));
+        this.log("");
+        this.log(`» Knock CLI\n`);
+        this.logSection("Get started:", GET_STARTED);
+        this.logSection("Common commands:", COMMON);
+    }
+    logSection(title, entries) {
+        const pad = Math.max(...entries.map(([c])=>c.length));
+        this.log(title);
+        this.log("");
+        for (const [cmd, summary] of entries){
+            this.log(`  ${brand(cmd.padEnd(pad))}  ${summary}`);
+        }
+        this.log("");
+    }
+}

package/dist/lib/api-v1.js

@@ -74,6 +74,7 @@ class ApiV1 {
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             force: flags.force
         });
         const data = {
@@ -110,11 +111,18 @@ class ApiV1 {
             environment: flags.environment,
             branch: flags.branch
         });
+        const settings = (0, _objectisomorphic.prune)({
+            sandbox_mode: flags["sandbox-mode"],
+            skip_delay: flags["skip-delay"]
+        });
         const data = (0, _objectisomorphic.prune)({
             recipients: flags.recipients,
             tenant: flags.tenant,
             data: flags.data,
-            actor: flags.actor
+            actor: flags.actor,
+            ...Object.keys(settings).length > 0 ? {
+                settings
+            } : {}
         });
         return this.put(`/workflows/${args.workflowKey}/run`, data, {
             params
@@ -139,6 +147,7 @@ class ApiV1 {
             environment: flags.environment,
             branch: flags.branch,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             resource_type: flags["resource-type"],
             resource_id: flags["resource-id"]
         });
@@ -190,6 +199,7 @@ class ApiV1 {
             branch: flags.branch,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             namespace: translation.namespace,
             force: flags.force
         });
@@ -243,6 +253,7 @@ class ApiV1 {
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             force: flags.force
         });
         const data = {
@@ -295,6 +306,7 @@ class ApiV1 {
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             force: flags.force
         });
         const data = {
@@ -354,6 +366,7 @@ class ApiV1 {
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             force: flags.force
         });
         const data = {
@@ -400,6 +413,25 @@ class ApiV1 {
             params
         });
     }
+    async listSources({ flags }) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            ...(0, _page.toPageParams)(flags)
+        });
+        return this.get("/sources", {
+            params
+        });
+    }
+    async getSource({ args, flags }) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate
+        });
+        return this.get(`/sources/${args.sourceKey}`, {
+            params
+        });
+    }
     async validateGuide({ flags }, guide) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
@@ -419,6 +451,7 @@ class ApiV1 {
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"],
+            allow_empty: flags["allow-empty"],
             force: flags.force
         });
         const data = {
@@ -440,6 +473,41 @@ class ApiV1 {
             params
         });
     }
+    // By resources: Schemas
+    async listSchemas({ flags }, filters = {}) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            branch: flags.branch,
+            item_type: filters.itemType,
+            after: filters.after
+        });
+        return this.get("/schemas", {
+            params
+        });
+    }
+    async getSchema({ flags }, itemType, collection) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            branch: flags.branch,
+            item_id: collection
+        });
+        return this.get(`/schemas/${itemType}`, {
+            params
+        });
+    }
+    async upsertSchema({ flags }, itemType, schema, collection) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            branch: flags.branch,
+            item_id: collection
+        });
+        const data = {
+            schema
+        };
+        return this.put(`/schemas/${itemType}`, data, {
+            params
+        });
+    }
     async listAllChannels() {
         const channels = [];
         for await (const channel of this.mgmtClient.channels.list()){
@@ -454,6 +522,15 @@ class ApiV1 {
         }
         return environments;
     }
+    // By resources: Branches
+    async rebaseBranch(branchSlug, environment) {
+        const params = {
+            environment
+        };
+        return this.put(`/branches/${branchSlug}/rebase`, {}, {
+            params
+        });
+    }
     // By methods:
     async get(subpath, config) {
         return this.client.get(`/${API_VERSION}` + subpath, config);

package/dist/lib/auth.js

@@ -38,6 +38,7 @@ function _interop_require_default(obj) {
     };
 }
 const DEFAULT_TIMEOUT = 5000;
+const LOGIN_TIMEOUT = 5 * 60 * 1000;
 function createChallenge() {
     // PKCE code verifier and challenge
     const codeVerifier = _nodecrypto.default.randomBytes(32).toString("base64url");
@@ -167,8 +168,8 @@ async function waitForAccessToken(dashboardUrl, authUrl) {
     });
     const { codeVerifier, codeChallenge, state } = createChallenge();
     const timeout = setTimeout(()=>{
-        cleanupAndReject(`authentication timed out after ${DEFAULT_TIMEOUT / 1000} seconds`);
-    }, 60000);
+        cleanupAndReject(`authentication timed out after ${LOGIN_TIMEOUT / 1000} seconds`);
+    }, LOGIN_TIMEOUT);
     function cleanupAndReject(message) {
         cleanup();
         reject(new Error(`Could not authenticate: ${message}`));

package/dist/lib/helpers/flag.js

@@ -9,6 +9,12 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    get allowEmpty () {
+        return allowEmpty;
+    },
+    get allowEmptyOnPush () {
+        return allowEmptyOnPush;
+    },
     get booleanStr () {
         return booleanStr;
     },
@@ -158,3 +164,12 @@ const branch = slug({
 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."
 });
+const allowEmpty = _core.Flags.boolean({
+    summary: "Create an empty commit for an already-published resource (analogous to git commit --allow-empty). " + "Requires --resource-type and --resource-id."
+});
+const allowEmptyOnPush = _core.Flags.boolean({
+    summary: "Create an empty commit for an already-published resource (analogous to git commit --allow-empty).",
+    dependsOn: [
+        "commit"
+    ]
+});

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

@@ -21,6 +21,9 @@ _export(exports, {
     get formatStep () {
         return formatStep;
     },
+    get formatTags () {
+        return formatTags;
+    },
     get generateIndexTypeTS () {
         return generateIndexTypeTS;
     },
@@ -101,6 +104,14 @@ const formatActivationRules = (rules)=>{
     if (!rules || !Array.isArray(rules)) return "-";
     return rules.map(({ directive, pathname })=>`${directive} ${pathname}`).join(", ");
 };
+const formatTags = (guide, opts = {})=>{
+    const { tags } = guide;
+    const { truncateAfter: limit, emptyDisplay = "" } = opts;
+    if (!tags) return emptyDisplay;
+    const count = tags.length;
+    if (!limit || limit >= count) return tags.join(", ");
+    return (0, _lodash.take)(tags, limit).join(", ") + ` (+ ${count - limit} more)`;
+};
 const guideJsonPath = (guideDirCtx)=>_nodepath.resolve(guideDirCtx.abspath, _processorisomorphic.GUIDE_JSON);
 const lsGuideJson = async (dirPath)=>{
     const guideJsonPath = _nodepath.resolve(dirPath, _processorisomorphic.GUIDE_JSON);