@knocklabs/cli 0.1.18 → 0.1.20

package/dist/lib/marshal/message-type/writer.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    pruneMessageTypesIndexDir: function() {
+        return pruneMessageTypesIndexDir;
+    },
+    writeMessageTypeDirFromData: function() {
+        return writeMessageTypeDirFromData;
+    },
+    writeMessageTypesIndexDir: function() {
+        return writeMessageTypesIndexDir;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _lodash = require("lodash");
+const _const = require("../../helpers/const");
+const _json = require("../../helpers/json");
+const _helpers = require("./helpers");
+const _processorisomorphic = require("./processor.isomorphic");
+const _reader = require("./reader");
+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 writeMessageTypeDirFromData = async (messageTypeDirCtx, remoteMessageType)=>{
+    // If the message type directory exists on the file system (i.e. previously
+    // pulled before), then read the message type file to use as a reference.
+    const [localMessageType] = messageTypeDirCtx.exists ? await (0, _reader.readMessageTypeDir)(messageTypeDirCtx, {
+        withExtractedFiles: true
+    }) : [];
+    const bundle = (0, _processorisomorphic.buildMessageTypeDirBundle)(remoteMessageType, localMessageType);
+    return writeMessageTypeDirFromBundle(messageTypeDirCtx, bundle);
+};
+/*
+ * A lower level write function that takes a constructed message type dir bundle
+ * and writes it into a message type directory on a local file system.
+ *
+ * It does not make any assumptions about how the message type directory bundle
+ * was built; for example, it can be from parsing the message type data fetched
+ * from the Knock API, or built manually for scaffolding purposes.
+ */ const writeMessageTypeDirFromBundle = async (messageTypeDirCtx, messageTypeDirBundle)=>{
+    const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
+    try {
+        if (messageTypeDirCtx.exists) {
+            await _fsextra.copy(messageTypeDirCtx.abspath, backupDirPath);
+            await _fsextra.emptyDir(messageTypeDirCtx.abspath);
+        }
+        const promises = Object.entries(messageTypeDirBundle).map(([relpath, fileContent])=>{
+            const filePath = _nodepath.resolve(messageTypeDirCtx.abspath, relpath);
+            return relpath === _processorisomorphic.MESSAGE_TYPE_JSON ? _fsextra.outputJson(filePath, fileContent, {
+                spaces: _json.DOUBLE_SPACES
+            }) : _fsextra.outputFile(filePath, fileContent !== null && fileContent !== void 0 ? fileContent : "");
+        });
+        await Promise.all(promises);
+    } catch (error) {
+        // In case of any error, wipe the target directory that is likely in a bad
+        // state then restore the backup if one existed before.
+        if (messageTypeDirCtx.exists) {
+            await _fsextra.emptyDir(messageTypeDirCtx.abspath);
+            await _fsextra.copy(backupDirPath, messageTypeDirCtx.abspath);
+        } else {
+            await _fsextra.remove(messageTypeDirCtx.abspath);
+        }
+        throw error;
+    } finally{
+        // Always clean up the backup directory in the temp sandbox.
+        await _fsextra.remove(backupDirPath);
+    }
+};
+/*
+ * Prunes the index directory by removing any files, or directories that aren't
+ * message type dirs found in fetched message types. We want to preserve any
+ * message type dirs that are going to be updated with remote message types, so
+ * extracted links can be respected.
+ */ const pruneMessageTypesIndexDir = async (indexDirCtx, remoteMessageTypes)=>{
+    const messageTypesByKey = Object.fromEntries(remoteMessageTypes.map((w)=>[
+            w.key.toLowerCase(),
+            w
+        ]));
+    const dirents = await _fsextra.readdir(indexDirCtx.abspath, {
+        withFileTypes: true
+    });
+    const promises = dirents.map(async (dirent)=>{
+        const direntName = dirent.name.toLowerCase();
+        const direntPath = _nodepath.resolve(indexDirCtx.abspath, direntName);
+        if (await (0, _helpers.isMessageTypeDir)(direntPath) && messageTypesByKey[direntName]) {
+            return;
+        }
+        await _fsextra.remove(direntPath);
+    });
+    await Promise.all(promises);
+};
+const writeMessageTypesIndexDir = async (indexDirCtx, remoteMessageTypes)=>{
+    const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
+    try {
+        // If the index directory already exists, back it up in the temp sandbox
+        // before wiping it clean.
+        if (indexDirCtx.exists) {
+            await _fsextra.copy(indexDirCtx.abspath, backupDirPath);
+            await pruneMessageTypesIndexDir(indexDirCtx, remoteMessageTypes);
+        }
+        // Write given remote message types into the given message types dir path.
+        const promises = remoteMessageTypes.map(async (messageType)=>{
+            const messageTypeDirPath = _nodepath.resolve(indexDirCtx.abspath, messageType.key);
+            const messageTypeDirCtx = {
+                type: "message_type",
+                key: messageType.key,
+                abspath: messageTypeDirPath,
+                exists: indexDirCtx.exists ? await (0, _helpers.isMessageTypeDir)(messageTypeDirPath) : false
+            };
+            return writeMessageTypeDirFromData(messageTypeDirCtx, messageType);
+        });
+        await Promise.all(promises);
+    } catch (error) {
+        console.log(error);
+        // In case of any error, wipe the index directory that is likely in a bad
+        // state then restore the backup if one existed before.
+        if (indexDirCtx.exists) {
+            await _fsextra.emptyDir(indexDirCtx.abspath);
+            await _fsextra.copy(backupDirPath, indexDirCtx.abspath);
+        } else {
+            await _fsextra.remove(indexDirCtx.abspath);
+        }
+        throw error;
+    } finally{
+        // Always clean up the backup directory in the temp sandbox.
+        await _fsextra.remove(backupDirPath);
+    }
+};

package/dist/lib/marshal/partial/helpers.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    ensureValidCommandTarget: function() {
+        return ensureValidCommandTarget;
+    },
+    isPartialDir: function() {
+        return isPartialDir;
+    },
+    lsPartialJson: function() {
+        return lsPartialJson;
+    },
+    partialJsonPath: function() {
+        return partialJsonPath;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+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 partialJsonPath = (partialDirCtx)=>_nodepath.resolve(partialDirCtx.abspath, _processorisomorphic.PARTIAL_JSON);
+const lsPartialJson = async (dirPath)=>{
+    const partialJsonPath = _nodepath.resolve(dirPath, _processorisomorphic.PARTIAL_JSON);
+    const exists = await _fsextra.pathExists(partialJsonPath);
+    return exists ? partialJsonPath : undefined;
+};
+const isPartialDir = async (dirPath)=>Boolean(await lsPartialJson(dirPath));
+const ensureValidCommandTarget = async (props, runContext)=>{
+    const { args, flags } = props;
+    const { commandId, resourceDir: resourceDirCtx, cwd: runCwd } = runContext;
+    // If the target resource is a different type than the current resource dir
+    // type, error out.
+    if (resourceDirCtx && resourceDirCtx.type !== "partial") {
+        return _core.ux.error(`Cannot run ${commandId} inside a ${resourceDirCtx.type} directory`);
+    }
+    // Cannot accept both partial key arg and --all flag.
+    if (flags.all && args.partialKey) {
+        return _core.ux.error(`partialKey arg \`${args.partialKey}\` cannot also be provided when using --all`);
+    }
+    // --all flag is given, which means no partial key arg.
+    if (flags.all) {
+        // If --all flag used inside a partial directory, then require a partials
+        // dir path.
+        if (resourceDirCtx && !flags["partials-dir"]) {
+            return _core.ux.error("Missing required flag partials-dir");
+        }
+        // Targeting all partial dirs in the partials index dir.
+        // TODO: Default to the knock project config first if present before cwd.
+        const defaultToCwd = {
+            abspath: runCwd,
+            exists: true
+        };
+        const indexDirCtx = flags["partials-dir"] || defaultToCwd;
+        return {
+            type: "partialsIndexDir",
+            context: indexDirCtx
+        };
+    }
+    // Partial key arg is given, which means no --all flag.
+    if (args.partialKey) {
+        if (resourceDirCtx && resourceDirCtx.key !== args.partialKey) {
+            return _core.ux.error(`Cannot run ${commandId} \`${args.partialKey}\` inside another partial directory:\n${resourceDirCtx.key}`);
+        }
+        const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(runCwd, args.partialKey);
+        const partialDirCtx = {
+            type: "partial",
+            key: args.partialKey,
+            abspath: targetDirPath,
+            exists: await isPartialDir(targetDirPath)
+        };
+        return {
+            type: "partialDir",
+            context: partialDirCtx
+        };
+    }
+    // From this point on, we have neither a partial key arg nor --all flag.
+    // If running inside a partial directory, then use that partial directory.
+    if (resourceDirCtx) {
+        return {
+            type: "partialDir",
+            context: resourceDirCtx
+        };
+    }
+    return _core.ux.error("Missing 1 required arg:\npartialKey");
+};

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

@@ -2,8 +2,11 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./helpers"), exports);
 _export_star(require("./processor.isomorphic"), exports);
+_export_star(require("./reader"), exports);
 _export_star(require("./types"), exports);
+_export_star(require("./writer"), 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/partial/reader.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    readAllForCommandTarget: function() {
+        return readAllForCommandTarget;
+    },
+    readPartialDir: function() {
+        return readPartialDir;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
+const _core = require("@oclif/core");
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+const _lodash = require("lodash");
+const _error = require("../../helpers/error");
+const _json = require("../../helpers/json");
+const _objectisomorphic = require("../../helpers/object.isomorphic");
+const _helpers = require("../shared/helpers");
+const _constisomorphic = require("../shared/const.isomorphic");
+const _helpers1 = require("./helpers");
+const _processorisomorphic = require("./processor.isomorphic");
+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;
+}
+/*
+ * For the given list of partial directory contexts, read each partial dir and
+ * return partial directory data.
+ */ const readPartialDirs = async (partialDirCtxs, opts = {})=>{
+    const partials = [];
+    const errors = [];
+    for (const partialDirCtx of partialDirCtxs){
+        // eslint-disable-next-line no-await-in-loop
+        const [partial, readErrors] = await readPartialDir(partialDirCtx, opts);
+        if (readErrors.length > 0) {
+            const partialJsonPath = _nodepath.default.resolve(partialDirCtx.abspath, _processorisomorphic.PARTIAL_JSON);
+            const e = new _error.SourceError((0, _error.formatErrors)(readErrors), partialJsonPath);
+            errors.push(e);
+            continue;
+        }
+        partials.push({
+            ...partialDirCtx,
+            content: partial
+        });
+    }
+    return [
+        partials,
+        errors
+    ];
+};
+const readPartialDir = async (partialDirCtx, opts = {})=>{
+    const { abspath } = partialDirCtx;
+    const { withExtractedFiles = false, withReadonlyField = false } = opts;
+    const dirExists = await _fsextra.pathExists(abspath);
+    if (!dirExists) throw new Error(`${abspath} does not exist`);
+    const partialJsonPath = await (0, _helpers1.lsPartialJson)(abspath);
+    if (!partialJsonPath) throw new Error(`${abspath} is not a partial directory`);
+    const result = await (0, _json.readJson)(partialJsonPath);
+    if (!result[0]) return result;
+    let [partialJson] = result;
+    partialJson = withReadonlyField ? partialJson : (0, _objectisomorphic.omitDeep)(partialJson, [
+        "__readonly"
+    ]);
+    return withExtractedFiles ? joinExtractedFiles(partialDirCtx, partialJson) : [
+        partialJson,
+        []
+    ];
+};
+const joinExtractedFiles = async (partialDirCtx, partialJson)=>{
+    // Tracks any errors encountered during traversal. Mutated in place.
+    const errors = [];
+    // Tracks each new valid extracted file path seen (rebased to be relative to
+    // partial.json) in the partial json node. Mutated in place, and used
+    // to validate the uniqueness of an extracted path encountered.
+    const uniqueFilePaths = {};
+    (0, _objectisomorphic.mapValuesDeep)(partialJson, (relpath, key, parts)=>{
+        // If not marked with the @suffix, there's nothing to do.
+        if (!_constisomorphic.FILEPATH_MARKED_RE.test(key)) return;
+        const objPathToFieldStr = _objectisomorphic.ObjPath.stringify(parts);
+        const inlinObjPathStr = objPathToFieldStr.replace(_constisomorphic.FILEPATH_MARKED_RE, "");
+        // If there is inlined content present already, then nothing more to do.
+        if ((0, _lodash.hasIn)(partialJson, inlinObjPathStr)) return;
+        // Check if the extracted path found at the current field path is valid
+        const invalidFilePathError = (0, _helpers.validateExtractedFilePath)(relpath, _nodepath.default.resolve(partialDirCtx.abspath, _processorisomorphic.PARTIAL_JSON), uniqueFilePaths, objPathToFieldStr);
+        if (invalidFilePathError) {
+            errors.push(invalidFilePathError);
+            // Wipe the invalid file path in the node so the final partial json
+            // object ends up with only valid file paths, this way partial writer
+            // can see only valid file paths and use those when pulling.
+            (0, _lodash.set)(partialJson, inlinObjPathStr, undefined);
+            (0, _lodash.set)(partialJson, objPathToFieldStr, undefined);
+            return;
+        }
+        // By this point we have a valid extracted file path, so attempt to read the file.
+        const [content, readExtractedFileError] = (0, _helpers.readExtractedFileSync)(relpath, partialDirCtx, key);
+        if (readExtractedFileError) {
+            errors.push(readExtractedFileError);
+            // If there's an error, replace the extracted file path with the original one, and set the
+            // inlined field path in partial object with empty content, so we know
+            // we do not need to try inlining again.
+            (0, _lodash.set)(partialJson, objPathToFieldStr, relpath);
+            (0, _lodash.set)(partialJson, inlinObjPathStr, undefined);
+            return;
+        }
+        // Inline the file content and remove the extracted file path.
+        (0, _lodash.set)(partialJson, objPathToFieldStr, relpath);
+        (0, _lodash.set)(partialJson, inlinObjPathStr, content);
+    });
+    return [
+        partialJson,
+        errors
+    ];
+};
+const readAllForCommandTarget = async (target, opts = {})=>{
+    const { type: targetType, context: targetCtx } = target;
+    if (!targetCtx.exists) {
+        const subject = targetType === "partialDir" ? "a partial directory at" : "partial directories in";
+        return _core.ux.error(`Cannot locate ${subject} \`${targetCtx.abspath}\``);
+    }
+    switch(targetType){
+        case "partialDir":
+            {
+                return readPartialDirs([
+                    targetCtx
+                ], opts);
+            }
+        case "partialsIndexDir":
+            {
+                const dirents = await _fsextra.readdir(targetCtx.abspath, {
+                    withFileTypes: true
+                });
+                const promises = dirents.map(async (dirent)=>{
+                    const abspath = _nodepath.default.resolve(targetCtx.abspath, dirent.name);
+                    const partialDirCtx = {
+                        type: "partial",
+                        key: dirent.name,
+                        abspath,
+                        exists: await (0, _helpers1.isPartialDir)(abspath)
+                    };
+                    return partialDirCtx;
+                });
+                const partialDirCtxs = (await Promise.all(promises)).filter((partialDirCtx)=>partialDirCtx.exists);
+                return readPartialDirs(partialDirCtxs, opts);
+            }
+        default:
+            throw new Error(`Invalid partial command target: ${target}`);
+    }
+};

package/dist/lib/marshal/partial/types.js

@@ -8,10 +8,10 @@ Object.defineProperty(exports, "PartialType", {
         return PartialType;
     }
 });
-var PartialType;
-(function(PartialType) {
+var PartialType = /*#__PURE__*/ function(PartialType) {
     PartialType["Html"] = "html";
     PartialType["Json"] = "json";
     PartialType["Markdown"] = "markdown";
     PartialType["Text"] = "text";
-})(PartialType || (PartialType = {}));
+    return PartialType;
+}({});