@knocklabs/cli 0.1.22 → 0.2.0

package/dist/commands/guide/pull.js

@@ -0,0 +1,209 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return GuidePull;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+const _ux = require("../../lib/helpers/ux");
+const _guide = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/guide"));
+const _runcontext = require("../../lib/run-context");
+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 GuidePull extends _basecommand.default {
+    async run() {
+        const { args, flags } = this.props;
+        if (flags.all && args.guideKey) {
+            return this.error(`guideKey arg \`${args.guideKey}\` cannot also be provided when using --all`);
+        }
+        return flags.all ? this.pullAllGuides() : this.pullOneGuide();
+    }
+    async pullOneGuide() {
+        const { flags } = this.props;
+        const dirContext = await this.getGuideDirContext();
+        if (dirContext.exists) {
+            this.log(`‣ Found \`${dirContext.key}\` at ${dirContext.abspath}`);
+        } else {
+            const prompt = `Create a new guide directory \`${dirContext.key}\` at ${dirContext.abspath}?`;
+            const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+            if (!input) return;
+        }
+        const resp = await (0, _request.withSpinner)(()=>{
+            const props = (0, _objectisomorphic.merge)(this.props, {
+                args: {
+                    guideKey: dirContext.key
+                },
+                flags: {
+                    annotate: true
+                }
+            });
+            return this.apiV1.getGuide(props);
+        });
+        await _guide.writeGuideDirFromData(dirContext, resp.data);
+        const action = dirContext.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath}`);
+    }
+    async pullAllGuides() {
+        const { flags } = this.props;
+        const defaultToCwd = {
+            abspath: this.runContext.cwd,
+            exists: true
+        };
+        const targetDirCtx = flags["guides-dir"] || defaultToCwd;
+        const prompt = targetDirCtx.exists ? `Pull latest guides into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new guides directory at ${targetDirCtx.abspath}?`;
+        const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+        if (!input) return;
+        _ux.spinner.start(`‣ Loading`);
+        const guides = await this.listAllGuides();
+        await _guide.writeGuidesIndexDir(targetDirCtx, guides);
+        _ux.spinner.stop();
+        const action = targetDirCtx.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${action} the guides directory at ${targetDirCtx.abspath}`);
+    }
+    async listAllGuides(pageParams = {}, guidesFetchedSoFar = []) {
+        const props = (0, _objectisomorphic.merge)(this.props, {
+            flags: {
+                ...pageParams,
+                annotate: true,
+                limit: _page.MAX_PAGINATION_LIMIT
+            }
+        });
+        const resp = await this.apiV1.listGuides(props);
+        if (!(0, _request.isSuccessResp)(resp)) {
+            const message = (0, _request.formatErrorRespMessage)(resp);
+            this.error(new _error.ApiError(message));
+        }
+        const { entries, page_info: pageInfo } = resp.data;
+        const guides = [
+            ...guidesFetchedSoFar,
+            ...entries
+        ];
+        return pageInfo.after ? this.listAllGuides({
+            after: pageInfo.after
+        }, guides) : guides;
+    }
+    async getGuideDirContext() {
+        const { guideKey } = this.props.args;
+        const { resourceDir, cwd: runCwd } = this.runContext;
+        // Inside an existing resource dir, use it if valid for the target guide.
+        if (resourceDir) {
+            const target = {
+                commandId: _basecommand.default.id,
+                type: "guide",
+                key: guideKey
+            };
+            return (0, _runcontext.ensureResourceDirForTarget)(resourceDir, target);
+        }
+        // Not inside any existing guide directory, which means either create a
+        // new guide directory in the cwd, or update it if there is one already.
+        if (guideKey) {
+            const dirPath = _nodepath.resolve(runCwd, guideKey);
+            const exists = await _guide.isGuideDir(dirPath);
+            return {
+                type: "guide",
+                key: guideKey,
+                abspath: dirPath,
+                exists
+            };
+        }
+        // Not in any guide directory, nor a guide key arg was given so error.
+        return this.error("Missing 1 required arg:\nguideKey");
+    }
+}
+// Hide until guides are released in GA.
+_define_property(GuidePull, "hidden", true);
+_define_property(GuidePull, "summary", "Pull one or more guides from an environment into a local file system.");
+_define_property(GuidePull, "flags", {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to pull all guides from the specified environment."
+    }),
+    "guides-dir": _flag.dirPath({
+        summary: "The target directory path to pull all guides into.",
+        dependsOn: [
+            "all"
+        ]
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    }),
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
+});
+_define_property(GuidePull, "args", {
+    guideKey: _core.Args.string({
+        required: false
+    })
+});

package/dist/commands/guide/push.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return GuidePush;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
+const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
+const _guide = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/guide"));
+const _validate = /*#__PURE__*/ _interop_require_default(require("./validate"));
+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 GuidePush extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        // 1. First read all guide directories found for the given command.
+        const target = await _guide.ensureValidCommandTarget(this.props, this.runContext);
+        const [guides, readErrors] = await _guide.readAllForCommandTarget(target, {
+            withExtractedFiles: true
+        });
+        if (readErrors.length > 0) {
+            this.error((0, _error.formatErrors)(readErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        if (guides.length === 0) {
+            this.error(`No guide 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, guides);
+        if (apiErrors.length > 0) {
+            this.error((0, _error.formatErrors)(apiErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        _ux.spinner.stop();
+        // 3. Finally push up each guide, abort on the first error.
+        _ux.spinner.start(`‣ Pushing`);
+        for (const guide of guides){
+            const props = (0, _objectisomorphic.merge)(this.props, {
+                flags: {
+                    annotate: true
+                }
+            });
+            // eslint-disable-next-line no-await-in-loop
+            const resp = await this.apiV1.upsertGuide(props, {
+                ...guide.content,
+                key: guide.key
+            });
+            if ((0, _request.isSuccessResp)(resp)) {
+                // Update the guide directory with the successfully pushed guide
+                // payload from the server.
+                // eslint-disable-next-line no-await-in-loop
+                await _guide.writeGuideDirFromData(guide, resp.data.guide);
+                continue;
+            }
+            const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _guide.guideJsonPath(guide), "ApiError");
+            this.error((0, _error.formatError)(error));
+        }
+        _ux.spinner.stop();
+        // 4. Display a success message.
+        const guideKeys = guides.map((g)=>g.key);
+        const actioned = flags.commit ? "pushed and committed" : "pushed";
+        this.log(`‣ Successfully ${actioned} ${guides.length} guide(s):\n` + (0, _string.indentString)(guideKeys.join("\n"), 4));
+    }
+}
+// Hide until guides are released in GA.
+_define_property(GuidePush, "hidden", true);
+_define_property(GuidePush, "summary", "Push one or more guides from a local file system to Knock.");
+_define_property(GuidePush, "flags", {
+    environment: _core.Flags.string({
+        summary: "Pushing a guide is only allowed in the development environment",
+        default: _const.KnockEnv.Development,
+        options: [
+            _const.KnockEnv.Development
+        ]
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to push all guides from the target directory."
+    }),
+    "guides-dir": _flag.dirPath({
+        summary: "The target directory path to find all guides to push.",
+        dependsOn: [
+            "all"
+        ]
+    }),
+    commit: _core.Flags.boolean({
+        summary: "Push and commit the guide(s) at the same time"
+    }),
+    "commit-message": _core.Flags.string({
+        summary: "Use the given value as the commit message",
+        char: "m",
+        dependsOn: [
+            "commit"
+        ]
+    })
+});
+_define_property(GuidePush, "args", {
+    guideKey: _core.Args.string({
+        required: false
+    })
+});

package/dist/commands/guide/validate.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return GuideValidate;
+    }
+});
+const _core = require("@oclif/core");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _request = require("../../lib/helpers/request");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
+const _guide = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/guide"));
+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 GuideValidate extends _basecommand.default {
+    async run() {
+        // 1. Read all guide directories found for the given command.
+        const target = await _guide.ensureValidCommandTarget(this.props, this.runContext);
+        const [guides, readErrors] = await _guide.readAllForCommandTarget(target, {
+            withExtractedFiles: true
+        });
+        if (readErrors.length > 0) {
+            this.error((0, _error.formatErrors)(readErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        if (guides.length === 0) {
+            this.error(`No guide directories found in ${target.context.abspath}`);
+        }
+        // 2. Validate each guide data.
+        _ux.spinner.start(`‣ Validating`);
+        const apiErrors = await GuideValidate.validateAll(this.apiV1, this.props, guides);
+        if (apiErrors.length > 0) {
+            this.error((0, _error.formatErrors)(apiErrors, {
+                prependBy: "\n\n"
+            }));
+        }
+        _ux.spinner.stop();
+        // 3. Display a success message.
+        const guideKeys = guides.map((g)=>g.key);
+        this.log(`‣ Successfully validated ${guides.length} guide(s):\n` + (0, _string.indentString)(guideKeys.join("\n"), 4));
+    }
+    static async validateAll(api, props, guides) {
+        // TODO: Throw an error if a non validation error (e.g. authentication error)
+        // instead of printing out same error messages repeatedly.
+        const errorPromises = guides.map(async (guide)=>{
+            const resp = await api.validateGuide(props, {
+                ...guide.content,
+                key: guide.key
+            });
+            if ((0, _request.isSuccessResp)(resp)) return;
+            const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _guide.guideJsonPath(guide), "ApiError");
+            return error;
+        });
+        const errors = (await Promise.all(errorPromises)).filter((e)=>Boolean(e));
+        return errors;
+    }
+}
+_define_property(GuideValidate, "summary", "Validate one or more guides from a local file system.");
+// Hide until guides are released in GA.
+_define_property(GuideValidate, "hidden", true);
+_define_property(GuideValidate, "flags", {
+    environment: _core.Flags.string({
+        summary: "Validating a guide is only done in the development environment",
+        default: _const.KnockEnv.Development,
+        options: [
+            _const.KnockEnv.Development
+        ]
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to validate all guides from the target directory."
+    }),
+    "guides-dir": _flag.dirPath({
+        summary: "The target directory path to find all guides to validate.",
+        dependsOn: [
+            "all"
+        ]
+    })
+});
+_define_property(GuideValidate, "args", {
+    guideKey: _core.Args.string({
+        required: false
+    })
+});

package/dist/commands/knock.js

@@ -112,6 +112,9 @@ class Knock extends _basecommand.default {
         this.log("");
         this.log("Thank you for using Knock, and have a nice day! 🙂");
     }
+    constructor(...args){
+        super(...args), _define_property(this, "requiresAuth", false);
+    }
 }
 // Because, it's a secret :)
 _define_property(Knock, "hidden", true);

package/dist/commands/login.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return Login;
+    }
+});
+const _auth = /*#__PURE__*/ _interop_require_default(require("../lib/auth"));
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../lib/base-command"));
+const _ux = require("../lib/helpers/ux");
+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 Login extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        if (flags["service-token"]) {
+            this.log("Service token provided, skipping login.");
+            return;
+        }
+        _ux.spinner.start("‣ Authenticating with Knock...");
+        const resp = await _auth.default.waitForAccessToken(this.sessionContext.dashboardOrigin, this.sessionContext.authOrigin);
+        _ux.spinner.stop();
+        await this.configStore.set({
+            userSession: resp
+        });
+        this.log("‣ Successfully authenticated with Knock.");
+    }
+    constructor(...args){
+        super(...args), _define_property(this, "requiresAuth", false);
+    }
+}

package/dist/commands/logout.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return Logout;
+    }
+});
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../lib/base-command"));
+const _ux = require("../lib/helpers/ux");
+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 Logout extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        if (flags["service-token"]) {
+            this.log("Service token provided, skipping logout.");
+            return;
+        }
+        _ux.spinner.start("‣ Logging out of Knock...");
+        await this.configStore.set({
+            userSession: undefined
+        });
+        _ux.spinner.stop();
+        this.log("‣ Successfully logged out of Knock. See you around.");
+    }
+    constructor(...args){
+        super(...args), _define_property(this, "requiresAuth", false);
+    }
+}

package/dist/commands/whoami.js

@@ -34,10 +34,14 @@ class Whoami extends _basecommand.default {
         const resp = await (0, _request.withSpinner)(()=>this.apiV1.whoami());
         const { flags } = this.props;
         if (flags.json) return resp.data;
-        this.log(`‣ Successfully verified the provided service token:`);
-        const info = [
+        this.log(`‣ Successfully authenticated:`);
+        let info = [];
+        info = resp.data.service_token_name ? [
             `Account name: ${resp.data.account_name}`,
             `Service token name: ${resp.data.service_token_name}`
+        ] : [
+            `Account name: ${resp.data.account_name}`,
+            `User ID: ${resp.data.user_id}`
         ];
         this.log((0, _string.indentString)(info.join("\n"), 4));
     }