@knocklabs/cli 0.2.1 → 0.2.3

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/error.js

@@ -58,6 +58,11 @@ class CustomError extends Error {
     }
 }
 class ApiError extends CustomError {
+    constructor(message, status, code){
+        super(message), _define_property(this, "status", void 0), _define_property(this, "code", void 0);
+        this.status = status;
+        this.code = code;
+    }
 }
 class JsonSyntaxError extends CustomError {
 }

package/dist/lib/helpers/flag.js

@@ -12,6 +12,9 @@ _export(exports, {
     get booleanStr () {
         return booleanStr;
     },
+    get branch () {
+        return branch;
+    },
     get dirPath () {
         return dirPath;
     },
@@ -31,7 +34,10 @@ _export(exports, {
 const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _lodash = require("lodash");
+const _branch = require("./branch");
 const _json = require("./json");
+const _string = require("./string");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -131,3 +137,20 @@ 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,
+    // Memoize this flag's default. oclif runs this default function even when the flag is unused.
+    // Using lodash's once avoids unnecessarily reading the branch file multiple times.
+    default: (0, _lodash.once)(_branch.readSlugFromBranchFile)
+});

package/dist/lib/helpers/git.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "isFileIgnoredByGit", {
+    enumerable: true,
+    get: function() {
+        return isFileIgnoredByGit;
+    }
+});
+const _nodechild_process = require("node:child_process");
+const isFileIgnoredByGit = async (currDir, filePath)=>{
+    try {
+        (0, _nodechild_process.execSync)(`git check-ignore "${filePath}"`, {
+            cwd: currDir,
+            // Suppress output since we only care about exit status
+            stdio: "pipe"
+        });
+        // If we reach here, git check-ignore returned exit status 0 (file is ignored)
+        // See https://git-scm.com/docs/git-check-ignore#_exit_status
+        return true;
+    } catch  {
+        return false;
+    }
+};

package/dist/lib/helpers/request.js

@@ -90,7 +90,7 @@ const withSpinnerV2 = async (requestFn, opts = {})=>{
     } catch (error) {
         if (error instanceof _mgmt.default.APIError) {
             const message = formatMgmtError(error);
-            return _core.ux.error(new _error.ApiError(message));
+            return _core.ux.error(new _error.ApiError(message, error.status, error.error.code));
         }
         throw error;
     }

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/marshal/translation/helpers.js

@@ -178,7 +178,7 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     if (resourceDirCtx && resourceDirCtx.key !== localeCode) {
         return _core.ux.error(`Cannot run ${commandId} with \`${args.translationRef}\` inside a ${resourceDirCtx.key} directory`);
     }
-    const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(runCwd, localeCode);
+    const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : flags["translations-dir"] ? _nodepath.resolve(flags["translations-dir"].abspath, localeCode) : _nodepath.resolve(runCwd, localeCode);
     // Got translationRef arg but no --all flag, which means target only a single
     // translation file.
     if (!flags.all) {

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}`;