@knocklabs/cli 0.1.22 → 0.1.23

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/workflow/generate-types.js

@@ -17,8 +17,9 @@ const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers
 const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
 const _page = require("../../lib/helpers/page");
 const _request = require("../../lib/helpers/request");
+const _typegen = require("../../lib/helpers/typegen");
 const _ux = require("../../lib/helpers/ux");
-const _typegenerator = require("../../lib/type-generator");
+const _workflow = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/workflow"));
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -82,17 +83,17 @@ class WorkflowGenerateTypes extends _basecommand.default {
     async run() {
         const { flags } = this.props;
         const fileExtension = flags["output-file"].abspath.split(".").pop();
-        const targetLanguage = (0, _typegenerator.getLanguageFromExtension)(fileExtension);
+        const targetLanguage = (0, _typegen.getLanguageFromExtension)(fileExtension);
         if (!targetLanguage) {
             this.error(new _error.ApiError(`Unsupported file extension: ${fileExtension}. We currently support .ts, .rb, .go, .py files only.`));
         }
         _ux.spinner.start(`‣ Loading workflows`);
-        // 1. List all workflows in the development environment.
+        // 1. List all workflows in the target environment.
         const workflows = await this.listAllWorkflows();
         _ux.spinner.stop();
         // 2. Generate types for all workflows.
         _ux.spinner.start(`‣ Generating types`);
-        const { result, workflows: workflowsWithValidTypes } = await (0, _typegenerator.generateWorkflowTypes)(workflows, targetLanguage);
+        const { result, workflows: workflowsWithValidTypes } = await _workflow.generateWorkflowTypes(workflows, targetLanguage);
         _ux.spinner.stop();
         if (!result) {
             this.log(`‣ No workflows with valid trigger data JSON schema found, skipping type generation`);
@@ -125,7 +126,7 @@ class WorkflowGenerateTypes extends _basecommand.default {
         }, workflows) : workflows;
     }
 }
-_define_property(WorkflowGenerateTypes, "description", "Generate types for all workflows in the development environment and write them to a file.");
+_define_property(WorkflowGenerateTypes, "description", "Generate types for all workflows in an environment and write them to a file.");
 _define_property(WorkflowGenerateTypes, "flags", {
     environment: _core.Flags.string({
         summary: "Select the environment to generate types for.",

package/dist/lib/api-v1.js

@@ -113,6 +113,8 @@ class ApiV1 {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
             promoted: flags.promoted,
+            resource_type: flags["resource-type"],
+            resource_id: flags["resource-id"],
             ...(0, _page.toPageParams)(flags)
         });
         return this.get("/commits", {
@@ -333,6 +335,65 @@ class ApiV1 {
             params
         });
     }
+    // By resources: Guides
+    async listGuides({ flags }) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            hide_uncommitted_changes: flags["hide-uncommitted-changes"],
+            include_json_schema: flags["include-json-schema"],
+            ...(0, _page.toPageParams)(flags)
+        });
+        return this.get("/guides", {
+            params
+        });
+    }
+    async getGuide({ args, flags }) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            hide_uncommitted_changes: flags["hide-uncommitted-changes"]
+        });
+        return this.get(`/guides/${args.guideKey}`, {
+            params
+        });
+    }
+    async validateGuide({ flags }, guide) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment
+        });
+        const data = {
+            guide
+        };
+        return this.put(`/guides/${guide.key}/validate`, data, {
+            params
+        });
+    }
+    async upsertGuide({ flags }, guide) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            annotate: flags.annotate,
+            commit: flags.commit,
+            commit_message: flags["commit-message"]
+        });
+        const data = {
+            guide
+        };
+        return this.put(`/guides/${guide.key}`, data, {
+            params
+        });
+    }
+    async activateGuide({ args, flags }) {
+        const params = (0, _objectisomorphic.prune)({
+            environment: flags.environment,
+            status: flags.status,
+            from: flags.from,
+            until: flags.until
+        });
+        return this.put(`/guides/${args.guideKey}/activate`, {}, {
+            params
+        });
+    }
     // By methods:
     async get(subpath, config) {
         return this.client.get(`/${API_VERSION}` + subpath, config);

package/dist/lib/helpers/const.js

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    KnockEnv: function() {
+    get KnockEnv () {
         return KnockEnv;
     },
-    isTestEnv: function() {
+    get isTestEnv () {
         return isTestEnv;
     },
-    sandboxDir: function() {
+    get sandboxDir () {
         return sandboxDir;
     }
 });

package/dist/lib/helpers/date.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    formatDate: function() {
+    get formatDate () {
         return formatDate;
     },
-    formatDateTime: function() {
+    get formatDateTime () {
         return formatDateTime;
     }
 });

package/dist/lib/helpers/error.js

@@ -5,29 +5,29 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    ApiError: function() {
+    get ApiError () {
         return ApiError;
     },
-    JsonDataError: function() {
+    get JsonDataError () {
         return JsonDataError;
     },
-    JsonSyntaxError: function() {
+    get JsonSyntaxError () {
         return JsonSyntaxError;
     },
-    LiquidParseError: function() {
+    get LiquidParseError () {
         return LiquidParseError;
     },
-    SourceError: function() {
+    get SourceError () {
         return SourceError;
     },
-    formatError: function() {
+    get formatError () {
         return formatError;
     },
-    formatErrors: function() {
+    get formatErrors () {
         return formatErrors;
     }
 });

package/dist/lib/helpers/flag.js

@@ -5,26 +5,26 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    booleanStr: function() {
+    get booleanStr () {
         return booleanStr;
     },
-    dirPath: function() {
+    get dirPath () {
         return dirPath;
     },
-    filePath: function() {
+    get filePath () {
         return filePath;
     },
-    jsonStr: function() {
+    get jsonStr () {
         return jsonStr;
     },
-    maybeJsonStr: function() {
+    get maybeJsonStr () {
         return maybeJsonStr;
     },
-    maybeJsonStrAsList: function() {
+    get maybeJsonStrAsList () {
         return maybeJsonStrAsList;
     }
 });

package/dist/lib/helpers/json.js

@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    DOUBLE_SPACES: function() {
+    get DOUBLE_SPACES () {
         return DOUBLE_SPACES;
     },
-    parseJson: function() {
+    get parseJson () {
         return parseJson;
     },
-    readJson: function() {
+    get readJson () {
         return readJson;
     },
-    tryJsonParse: function() {
+    get tryJsonParse () {
         return tryJsonParse;
     }
 });

package/dist/lib/helpers/object.isomorphic.js

@@ -12,29 +12,29 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    ObjPath: function() {
+    get ObjPath () {
         return ObjPath;
     },
-    getLastFound: function() {
+    get getLastFound () {
         return getLastFound;
     },
-    mapValuesDeep: function() {
+    get mapValuesDeep () {
         return mapValuesDeep;
     },
-    merge: function() {
+    get merge () {
         return merge;
     },
-    omitDeep: function() {
+    get omitDeep () {
         return omitDeep;
     },
-    prune: function() {
+    get prune () {
         return prune;
     },
-    split: function() {
+    get split () {
         return split;
     }
 });

package/dist/lib/helpers/page.js

@@ -5,32 +5,32 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    MAX_PAGINATION_LIMIT: function() {
+    get MAX_PAGINATION_LIMIT () {
         return MAX_PAGINATION_LIMIT;
     },
-    PageAction: function() {
+    get PageAction () {
         return PageAction;
     },
-    formatPageActionPrompt: function() {
+    get formatPageActionPrompt () {
         return formatPageActionPrompt;
     },
-    maybePromptPageAction: function() {
+    get maybePromptPageAction () {
         return maybePromptPageAction;
     },
-    pageFlags: function() {
+    get pageFlags () {
         return pageFlags;
     },
-    paramsForPageAction: function() {
+    get paramsForPageAction () {
         return paramsForPageAction;
     },
-    toPageParams: function() {
+    get toPageParams () {
         return toPageParams;
     },
-    validatePageActionInput: function() {
+    get validatePageActionInput () {
         return validatePageActionInput;
     }
 });

package/dist/lib/helpers/request.js

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    formatErrorRespMessage: function() {
+    get formatErrorRespMessage () {
         return formatErrorRespMessage;
     },
-    isSuccessResp: function() {
+    get isSuccessResp () {
         return isSuccessResp;
     },
-    withSpinner: function() {
+    get withSpinner () {
         return withSpinner;
     }
 });