@knocklabs/cli 0.2.1 → 0.2.2

package/dist/commands/workflow/validate.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _const = require("../../lib/helpers/const");
 const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
@@ -102,7 +103,8 @@ class WorkflowValidate extends _basecommand.default {
         _ux.spinner.stop();
         // 3. Display a success message.
         const workflowKeys = workflows.map((w)=>w.key);
-        this.log(`‣ Successfully validated ${workflows.length} workflow(s):\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
+        const scope = (0, _command.formatCommandScope)(this.props.flags);
+        this.log(`‣ Successfully validated ${workflows.length} workflow(s) using ${scope}:\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
     }
     static async validateAll(api, props, workflows) {
         // TODO: Throw an error if a non validation error (e.g. authentication error)
@@ -129,6 +131,7 @@ _define_property(WorkflowValidate, "flags", {
             _const.KnockEnv.Development
         ]
     }),
+    branch: _flag.branch,
     all: _core.Flags.boolean({
         summary: "Whether to validate all workflows from the target directory."
     }),

package/dist/lib/api-v1.js

@@ -40,9 +40,6 @@ class ApiV1 {
     getToken(sessionContext) {
         return sessionContext.session ? sessionContext.session.accessToken : sessionContext.token;
     }
-    async ping() {
-        return this.get("/ping");
-    }
     async whoami() {
         return this.get("/whoami");
     }
@@ -50,6 +47,7 @@ class ApiV1 {
     async listWorkflows({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             ...(0, _page.toPageParams)(flags)
@@ -61,6 +59,7 @@ class ApiV1 {
     async getWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -71,6 +70,7 @@ class ApiV1 {
     async upsertWorkflow({ flags }, workflow) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -84,7 +84,8 @@ class ApiV1 {
     }
     async validateWorkflow({ flags }, workflow) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             workflow
@@ -96,6 +97,7 @@ class ApiV1 {
     async activateWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             status: flags.status
         });
         return this.put(`/workflows/${args.workflowKey}/activate`, {}, {
@@ -104,7 +106,8 @@ class ApiV1 {
     }
     async runWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = (0, _objectisomorphic.prune)({
             recipients: flags.recipients,
@@ -120,6 +123,7 @@ class ApiV1 {
     async listCommits({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             promoted: flags.promoted,
             resource_type: flags["resource-type"],
             resource_id: flags["resource-id"],
@@ -129,12 +133,10 @@ class ApiV1 {
             params
         });
     }
-    async getCommit({ args }) {
-        return this.get(`/commits/${args.id}`);
-    }
     async commitAllChanges({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             commit_message: flags["commit-message"]
         });
         return this.put(`/commits`, {}, {
@@ -156,6 +158,7 @@ class ApiV1 {
     async listTranslations({ flags }, filters = {}) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             locale_code: filters.localeCode,
             namespace: filters.namespace,
@@ -169,6 +172,7 @@ class ApiV1 {
     async getTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             namespace: translation.namespace,
             format: flags.format
@@ -180,6 +184,7 @@ class ApiV1 {
     async upsertTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             commit: flags.commit,
             commit_message: flags["commit-message"],
             namespace: translation.namespace
@@ -193,6 +198,7 @@ class ApiV1 {
     async validateTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             namespace: translation.namespace
         });
         const data = {
@@ -206,6 +212,7 @@ class ApiV1 {
     async listEmailLayouts({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             ...(0, _page.toPageParams)(flags)
@@ -217,6 +224,7 @@ class ApiV1 {
     async getEmailLayout({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -227,6 +235,7 @@ class ApiV1 {
     async upsertEmailLayout({ flags }, layout) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -240,7 +249,8 @@ class ApiV1 {
     }
     async validateEmailLayout({ flags }, layout) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             email_layout: layout
@@ -253,6 +263,7 @@ class ApiV1 {
     async listPartials({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             annotate: flags.annotate,
             ...(0, _page.toPageParams)(flags)
@@ -264,6 +275,7 @@ class ApiV1 {
     async getPartial({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -274,6 +286,7 @@ class ApiV1 {
     async upsertPartial({ flags }, partial) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -287,7 +300,8 @@ class ApiV1 {
     }
     async validatePartial({ flags }, partial) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             partial
@@ -300,6 +314,7 @@ class ApiV1 {
     async listMessageTypes({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             annotate: flags.annotate,
             ...(0, _page.toPageParams)(flags)
@@ -311,6 +326,7 @@ class ApiV1 {
     async getMessageType({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -321,6 +337,7 @@ class ApiV1 {
     async upsertMessageType({ flags }, messageType) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -334,7 +351,8 @@ class ApiV1 {
     }
     async validateMessageType({ flags }, messageType) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             message_type: messageType
@@ -347,6 +365,7 @@ class ApiV1 {
     async listGuides({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             include_json_schema: flags["include-json-schema"],
@@ -359,6 +378,7 @@ class ApiV1 {
     async getGuide({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -368,7 +388,8 @@ class ApiV1 {
     }
     async validateGuide({ flags }, guide) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             guide
@@ -380,6 +401,7 @@ class ApiV1 {
     async upsertGuide({ flags }, guide) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -394,6 +416,7 @@ class ApiV1 {
     async activateGuide({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             status: flags.status,
             from: flags.from,
             until: flags.until

package/dist/lib/helpers/arg.js

@@ -9,15 +9,16 @@ Object.defineProperty(exports, "CustomArgs", {
     }
 });
 const _core = require("@oclif/core");
-const slugArg = _core.Args.custom({
+const _string = require("./string");
+const slug = _core.Args.custom({
     parse: async (str)=>{
-        const slug = str.toLowerCase().trim().replace(/\s+/g, "-");
-        if (!slug) {
+        const slugifiedInput = (0, _string.slugify)(str);
+        if (!slugifiedInput) {
             throw new Error("Invalid slug provided");
         }
-        return slug;
+        return slugifiedInput;
     }
 });
 const CustomArgs = {
-    slugArg
+    slug
 };

package/dist/lib/helpers/command.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "formatCommandScope", {
+    enumerable: true,
+    get: function() {
+        return formatCommandScope;
+    }
+});
+const formatCommandScope = (flags)=>{
+    const { environment, branch } = flags;
+    return `\`${branch !== null && branch !== void 0 ? branch : environment}\` ${branch ? "branch" : "environment"}`;
+};

package/dist/lib/helpers/flag.js

@@ -12,6 +12,9 @@ _export(exports, {
     get booleanStr () {
         return booleanStr;
     },
+    get branch () {
+        return branch;
+    },
     get dirPath () {
         return dirPath;
     },
@@ -32,6 +35,7 @@ const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _json = require("./json");
+const _string = require("./string");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -131,3 +135,17 @@ const maybeJsonStrAsList = _core.Flags.custom({
         ];
     }
 });
+const slug = _core.Flags.custom({
+    parse: async (str)=>{
+        const slugifiedInput = (0, _string.slugify)(str);
+        if (!slugifiedInput) {
+            throw new Error("Invalid slug provided");
+        }
+        return slugifiedInput;
+    }
+});
+const branch = slug({
+    summary: "The slug of the branch to use.",
+    // TODO Hide until branching is released in GA
+    hidden: true
+});

package/dist/lib/helpers/string.js

@@ -16,6 +16,9 @@ _export(exports, {
     },
     get indentString () {
         return indentString;
+    },
+    get slugify () {
+        return slugify;
     }
 });
 const SLUG_FORMAT_RE = /^[\w-]+$/;
@@ -44,3 +47,4 @@ const indentString = (string, count = 0, options = {})=>{
     const regex = includeEmptyLines ? /^/gm : /^(?!\s*$)/gm;
     return string.replace(regex, indent.repeat(count));
 };
+const slugify = (input)=>input.toLowerCase().trim().replace(/\s+/g, "-");

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _export_star(require("./helpers"), exports);
-_export_star(require("./types"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/lib/resources.js

@@ -22,11 +22,16 @@ const ALL_RESOURCE_TYPES = [
     // Email layouts next, as workflows with email channel steps may reference them
     "email_layout",
     "workflow",
+    // Message types then guides, as guides use message types.
+    "message_type",
+    "guide",
     "translation"
 ];
 const RESOURCE_SUBDIRS = {
     email_layout: "layouts",
     partial: "partials",
     translation: "translations",
-    workflow: "workflows"
+    workflow: "workflows",
+    message_type: "message-types",
+    guide: "guides"
 };

package/dist/lib/urls.js

@@ -23,6 +23,9 @@ _export(exports, {
     },
     get authSuccessUrl () {
         return authSuccessUrl;
+    },
+    get viewWorkflowUrl () {
+        return viewWorkflowUrl;
     }
 });
 const DEFAULT_DASHBOARD_URL = "https://dashboard.knock.app";
@@ -30,3 +33,4 @@ const DEFAULT_AUTH_URL = "https://signin.knock.app";
 const DEFAULT_API_URL = "https://control.knock.app";
 const authSuccessUrl = (dashboardUrl)=>`${dashboardUrl}/auth/oauth/cli`;
 const authErrorUrl = (dashboardUrl, error)=>`${dashboardUrl}/auth/oauth/cli?error=${error}`;
+const viewWorkflowUrl = (dashboardUrl, accountSlug, envOrBranchSlug, workflowKey)=>`${dashboardUrl}/${accountSlug}/${envOrBranchSlug.toLowerCase()}/workflows/${workflowKey}`;