@knocklabs/cli 0.2.0 → 0.2.2

package/dist/lib/helpers/request.js

@@ -12,16 +12,28 @@ _export(exports, {
     get formatErrorRespMessage () {
         return formatErrorRespMessage;
     },
+    get formatMgmtError () {
+        return formatMgmtError;
+    },
     get isSuccessResp () {
         return isSuccessResp;
     },
     get withSpinner () {
         return withSpinner;
+    },
+    get withSpinnerV2 () {
+        return withSpinnerV2;
     }
 });
+const _mgmt = /*#__PURE__*/ _interop_require_default(require("@knocklabs/mgmt"));
 const _core = require("@oclif/core");
 const _error = require("./error");
 const _ux = require("./ux");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
 const isSuccessResp = (resp)=>resp.status >= 200 && resp.status < 300;
 const formatErrorRespMessage = ({ status, data })=>{
     if (status === 500) {
@@ -36,16 +48,50 @@ const formatErrorRespMessage = ({ status, data })=>{
     }
     return message;
 };
+const formatMgmtError = (apiError)=>{
+    if (apiError.status === 500) {
+        return "An internal server error occurred";
+    }
+    var _apiError_error_message;
+    // Prefer the error message from the error object over
+    // the error message formatted by the Stainless SDK
+    const description = `${(_apiError_error_message = apiError.error.message) !== null && _apiError_error_message !== void 0 ? _apiError_error_message : apiError.message} (status: ${apiError.status})`;
+    var _apiError_error_errors;
+    const inputErrors = (_apiError_error_errors = apiError.error.errors) !== null && _apiError_error_errors !== void 0 ? _apiError_error_errors : [];
+    if (Array.isArray(inputErrors) && inputErrors.length > 0) {
+        const errs = inputErrors.map((e)=>new _error.JsonDataError(e.message, e.field));
+        return errs.length === 0 ? description : description + "\n\n" + (0, _error.formatErrors)(errs, {
+            indentBy: 2
+        });
+    }
+    return description;
+};
 const withSpinner = async (requestFn, opts = {})=>{
-    const { action = "‣ Loading", ensureSuccess = true } = opts;
+    const { action = "‣ Loading" } = opts;
     // Suppress printing the spinner in tests, oclif doesn't for some reasons.
     _ux.spinner.start(action);
     const resp = await requestFn();
     // Error out before the action stop so the spinner can update accordingly.
-    if (ensureSuccess && !isSuccessResp(resp)) {
+    if (!isSuccessResp(resp)) {
         const message = formatErrorRespMessage(resp);
         _core.ux.error(new _error.ApiError(message));
     }
     _ux.spinner.stop();
     return resp;
 };
+const withSpinnerV2 = async (requestFn, opts = {})=>{
+    const { action = "‣ Loading" } = opts;
+    // Suppress printing the spinner in tests, oclif doesn't for some reasons.
+    _ux.spinner.start(action);
+    try {
+        const resp = await requestFn();
+        _ux.spinner.stop();
+        return resp;
+    } catch (error) {
+        if (error instanceof _mgmt.default.APIError) {
+            const message = formatMgmtError(error);
+            return _core.ux.error(new _error.ApiError(message));
+        }
+        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/index.isomorphic.js

@@ -23,16 +23,20 @@ _export(exports, {
     get buildPartialDirBundle () {
         return _processorisomorphic3.buildPartialDirBundle;
     },
+    get buildReusableStepDirBundle () {
+        return _processorisomorphic4.buildReusableStepDirBundle;
+    },
     get buildTranslationDirBundle () {
-        return _processorisomorphic4.buildTranslationDirBundle;
+        return _processorisomorphic5.buildTranslationDirBundle;
     },
     get buildWorkflowDirBundle () {
-        return _processorisomorphic5.buildWorkflowDirBundle;
+        return _processorisomorphic6.buildWorkflowDirBundle;
     }
 });
 const _processorisomorphic = require("./email-layout/processor.isomorphic");
 const _processorisomorphic1 = require("./guide/processor.isomorphic");
 const _processorisomorphic2 = require("./message-type/processor.isomorphic");
 const _processorisomorphic3 = require("./partial/processor.isomorphic");
-const _processorisomorphic4 = require("./translation/processor.isomorphic");
-const _processorisomorphic5 = require("./workflow/processor.isomorphic");
+const _processorisomorphic4 = require("./reusable-step/processor.isomorphic");
+const _processorisomorphic5 = require("./translation/processor.isomorphic");
+const _processorisomorphic6 = require("./workflow/processor.isomorphic");

package/dist/lib/marshal/reusable-step/helpers.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get isReusableStepDir () {
+        return isReusableStepDir;
+    },
+    get lsReusableStepJson () {
+        return lsReusableStepJson;
+    },
+    get reusableStepJsonPath () {
+        return reusableStepJsonPath;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _processorisomorphic = require("./processor.isomorphic");
+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;
+}
+const reusableStepJsonPath = (reusableStepDirCtx)=>_nodepath.resolve(reusableStepDirCtx.abspath, _processorisomorphic.REUSABLE_STEP_JSON);
+const isReusableStepDir = async (dirPath)=>Boolean(await lsReusableStepJson(dirPath));
+const lsReusableStepJson = async (dirPath)=>{
+    const reusableStepJsonPath = _nodepath.resolve(dirPath, _processorisomorphic.REUSABLE_STEP_JSON);
+    const exists = await _fsextra.pathExists(reusableStepJsonPath);
+    return exists ? reusableStepJsonPath : undefined;
+};

package/dist/lib/marshal/reusable-step/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./processor.isomorphic"), 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)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/dist/lib/marshal/reusable-step/processor.isomorphic.js

@@ -0,0 +1,86 @@
+/*
+ * IMPORTANT:
+ *
+ * This file is suffixed with `.isomorphic` because the code in this file is
+ * meant to run not just in a nodejs environment but also in a browser. For this
+ * reason there are some restrictions for which nodejs imports are allowed in
+ * this module. See `.eslintrc.json` for more details.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get REUSABLE_STEP_JSON () {
+        return REUSABLE_STEP_JSON;
+    },
+    get buildReusableStepDirBundle () {
+        return buildReusableStepDirBundle;
+    }
+});
+const _lodash = require("lodash");
+const _objectisomorphic = require("../../helpers/object.isomorphic");
+const _constisomorphic = require("../shared/const.isomorphic");
+const _helpersisomorphic = require("../shared/helpers.isomorphic");
+const REUSABLE_STEP_JSON = "reusable_step.json";
+const compileExtractionSettings = (reusableStep)=>{
+    const extractableFields = (0, _lodash.get)(reusableStep, [
+        "__annotation",
+        "extractable_fields"
+    ], {});
+    const map = new Map();
+    for (const key of Object.keys(reusableStep)){
+        // If the field we are on is extractable, then add its extraction
+        // settings to the map with the current object path.
+        if (key in extractableFields) {
+            map.set([
+                key
+            ], extractableFields[key]);
+        }
+    }
+    return map;
+};
+const buildReusableStepDirBundle = (remoteReusableStep, localReusableStep = {})=>{
+    const bundle = {};
+    const mutRemoteReusableStep = (0, _lodash.cloneDeep)(remoteReusableStep);
+    // A map of extraction settings of every field in the reusable step
+    const compiledExtractionSettings = compileExtractionSettings(mutRemoteReusableStep);
+    // Iterate through each extractable field, determine whether we need to
+    // extract the field content, and if so, perform the extraction.
+    for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
+        // If this reusable step doesn't have this field path, then we don't extract.
+        if (!(0, _lodash.has)(mutRemoteReusableStep, objPathParts)) continue;
+        // If the field at this path is extracted in the local reusable step, then
+        // always extract; otherwise extract based on the field settings default.
+        const objPathStr = _objectisomorphic.ObjPath.stringify(objPathParts);
+        const extractedFilePath = (0, _lodash.get)(localReusableStep, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`);
+        const { default: extractByDefault, file_ext: fileExt } = extractionSettings;
+        if (!extractedFilePath && !extractByDefault) continue;
+        // By this point, we have a field where we need to extract its content.
+        const data = (0, _lodash.get)(mutRemoteReusableStep, objPathParts);
+        const fileName = objPathParts.pop();
+        // If we have an extracted file path from the local reusable step, we use that.
+        // In the other case we use the default path.
+        const relpath = typeof extractedFilePath === "string" ? extractedFilePath : `${fileName}.${fileExt}`;
+        // Perform the extraction by adding the content and its file path to the
+        // bundle for writing to the file system later. Then replace the field
+        // content with the extracted file path and mark the field as extracted
+        // with @ suffix.
+        const content = typeof data === "string" ? data : JSON.stringify(data, null, 2);
+        (0, _lodash.set)(bundle, [
+            relpath
+        ], content);
+        (0, _lodash.set)(mutRemoteReusableStep, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`, relpath);
+        (0, _lodash.unset)(mutRemoteReusableStep, objPathStr);
+    }
+    // At this point the bundle contains all extractable files, so we finally add
+    // the reusable step JSON relative path + the file content.
+    return (0, _lodash.set)(bundle, [
+        REUSABLE_STEP_JSON
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteReusableStep));
+};

package/dist/lib/marshal/{commit → reusable-step}/types.js

@@ -1,4 +1,3 @@
-// Commit payload data from the API.
 "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true

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