@knocklabs/cli 0.3.1 → 1.0.0-rc.1

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

@@ -0,0 +1,139 @@
+"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 generateMessageTypeDir () {
+        return generateMessageTypeDir;
+    },
+    get generateMessageTypeFromTemplate () {
+        return generateMessageTypeFromTemplate;
+    },
+    get scaffoldMessageTypeDirBundle () {
+        return scaffoldMessageTypeDirBundle;
+    },
+    get validateMessageTypeKey () {
+        return validateMessageTypeKey;
+    }
+});
+const _lodash = require("lodash");
+const _string = require("../../helpers/string");
+const _templates = /*#__PURE__*/ _interop_require_wildcard(require("../../templates"));
+const _constisomorphic = require("../shared/const.isomorphic");
+const _processorisomorphic = require("./processor.isomorphic");
+const _reader = require("./reader");
+const _writer = require("./writer");
+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 validateMessageTypeKey = (input)=>{
+    if (!(0, _string.checkSlugifiedFormat)(input, {
+        onlyLowerCase: true
+    })) {
+        return "must include only lowercase alphanumeric, dash, or underscore characters";
+    }
+    return undefined;
+};
+/*
+ * Returns the default scaffolded preview content.
+ */ const defaultPreviewContent = ()=>{
+    return `{{ name }}`;
+};
+/*
+ * Scaffolds a new message type directory bundle with default content.
+ */ const scaffoldMessageTypeDirBundle = (attrs)=>{
+    const previewFilePath = "preview.txt";
+    const defaultPreview = defaultPreviewContent();
+    const messageTypeJson = {
+        name: attrs.name,
+        description: "",
+        variants: [
+            {
+                key: "default",
+                name: "Default",
+                fields: []
+            }
+        ],
+        [`preview${_constisomorphic.FILEPATH_MARKER}`]: previewFilePath
+    };
+    return {
+        [_processorisomorphic.MESSAGE_TYPE_JSON]: messageTypeJson,
+        [previewFilePath]: defaultPreview
+    };
+};
+const generateMessageTypeDir = async (messageTypeDirCtx, attrs)=>{
+    const bundle = scaffoldMessageTypeDirBundle(attrs);
+    return (0, _writer.writeMessageTypeDirFromBundle)(messageTypeDirCtx, bundle);
+};
+const generateMessageTypeFromTemplate = async (messageTypeDirCtx, templateString, attrs)=>{
+    let tempDir;
+    try {
+        // Download the template directory into a temp directory
+        tempDir = await _templates.downloadTemplate(templateString);
+        // Create a message type directory context for the temp directory
+        const tempMessageTypeDirCtx = {
+            type: "message_type",
+            key: "temp",
+            abspath: tempDir,
+            exists: true
+        };
+        // Read the message_type.json from the temp directory we downloaded
+        const [messageType, errors] = await (0, _reader.readMessageTypeDir)(tempMessageTypeDirCtx, {
+            withExtractedFiles: true
+        });
+        if (errors.length > 0 || !messageType) {
+            throw new Error(`Invalid message type template: ${errors.join(", ")}`);
+        }
+        // Modify the message type data with the new attributes
+        const messageTypeData = (0, _lodash.cloneDeep)(messageType);
+        messageTypeData.name = attrs.name;
+        // Finally, we write the message type into the target message type directory
+        await (0, _writer.writeMessageTypeDirFromData)(messageTypeDirCtx, messageTypeData);
+    } finally{
+        await _templates.cleanupTempDir(tempDir);
+    }
+};

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

@@ -25,6 +25,7 @@ _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 _projectconfig = require("../../helpers/project-config");
 const _processorisomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
@@ -74,7 +75,7 @@ const lsMessageTypeJson = async (dirPath)=>{
     return exists ? messageTypeJsonPath : undefined;
 };
 const isMessageTypeDir = async (dirPath)=>Boolean(await lsMessageTypeJson(dirPath));
-const ensureValidCommandTarget = async (props, runContext)=>{
+const ensureValidCommandTarget = async (props, runContext, projectConfig)=>{
     const { args, flags } = props;
     const { commandId, resourceDir: resourceDirCtx, cwd: runCwd } = runContext;
     // If the target resource is a different type than the current resource dir
@@ -86,6 +87,8 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     if (flags.all && args.messageTypeKey) {
         return _core.ux.error(`messageTypeKey arg \`${args.messageTypeKey}\` cannot also be provided when using --all`);
     }
+    // Default to knock project config first if present, otherwise cwd.
+    const messageTypesIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(projectConfig, "message_type", runCwd);
     // --all flag is given, which means no message type key arg.
     if (flags.all) {
         // If --all flag used inside a message type directory, then require a message
@@ -93,16 +96,9 @@ const ensureValidCommandTarget = async (props, runContext)=>{
         if (resourceDirCtx && !flags["message-types-dir"]) {
             return _core.ux.error("Missing required flag message-types-dir");
         }
-        // Targeting all message type dirs in the message types index dir.
-        // TODO: Default to the knock project config first if present before cwd.
-        const defaultToCwd = {
-            abspath: runCwd,
-            exists: true
-        };
-        const indexDirCtx = flags["message-types-dir"] || defaultToCwd;
         return {
             type: "messageTypesIndexDir",
-            context: indexDirCtx
+            context: flags["message-types-dir"] || messageTypesIndexDirCtx
         };
     }
     // Message type key arg is given, which means no --all flag.
@@ -110,7 +106,7 @@ const ensureValidCommandTarget = async (props, runContext)=>{
         if (resourceDirCtx && resourceDirCtx.key !== args.messageTypeKey) {
             return _core.ux.error(`Cannot run ${commandId} \`${args.messageTypeKey}\` inside another message type directory:\n${resourceDirCtx.key}`);
         }
-        const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(runCwd, args.messageTypeKey);
+        const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(messageTypesIndexDirCtx.abspath, args.messageTypeKey);
         const messageTypeDirCtx = {
             type: "message_type",
             key: args.messageTypeKey,

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./generator"), exports);
 _export_star(require("./helpers"), exports);
 _export_star(require("./processor.isomorphic"), exports);
 _export_star(require("./reader"), exports);

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

@@ -12,6 +12,9 @@ _export(exports, {
     get pruneMessageTypesIndexDir () {
         return pruneMessageTypesIndexDir;
     },
+    get writeMessageTypeDirFromBundle () {
+        return writeMessageTypeDirFromBundle;
+    },
     get writeMessageTypeDirFromData () {
         return writeMessageTypeDirFromData;
     },
@@ -94,10 +97,11 @@ const writeMessageTypeDirFromData = async (messageTypeDirCtx, remoteMessageType,
             await _fsextra.emptyDir(messageTypeDirCtx.abspath);
         }
         const promises = Object.entries(messageTypeDirBundle).map(([relpath, fileContent])=>{
+            var _fileContent_toString;
             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 : "");
+            }) : _fsextra.outputFile(filePath, (_fileContent_toString = fileContent.toString()) !== null && _fileContent_toString !== void 0 ? _fileContent_toString : "");
         });
         await Promise.all(promises);
     } catch (error) {

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

@@ -0,0 +1,159 @@
+"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 generatePartialDir () {
+        return generatePartialDir;
+    },
+    get generatePartialFromTemplate () {
+        return generatePartialFromTemplate;
+    },
+    get scaffoldPartialDirBundle () {
+        return scaffoldPartialDirBundle;
+    },
+    get validatePartialKey () {
+        return validatePartialKey;
+    }
+});
+const _lodash = require("lodash");
+const _string = require("../../helpers/string");
+const _templates = /*#__PURE__*/ _interop_require_wildcard(require("../../templates"));
+const _constisomorphic = require("../shared/const.isomorphic");
+const _processorisomorphic = require("./processor.isomorphic");
+const _reader = require("./reader");
+const _types = require("./types");
+const _writer = require("./writer");
+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 validatePartialKey = (input)=>{
+    if (!(0, _string.checkSlugifiedFormat)(input, {
+        onlyLowerCase: true
+    })) {
+        return "must include only lowercase alphanumeric, dash, or underscore characters";
+    }
+    return undefined;
+};
+/*
+ * Maps the partial type to the correct file extension.
+ */ const partialTypeToFileExt = (type)=>{
+    switch(type){
+        case _types.PartialType.Html:
+            return "html";
+        case _types.PartialType.Json:
+            return "json";
+        case _types.PartialType.Markdown:
+            return "md";
+        case _types.PartialType.Text:
+        default:
+            return "txt";
+    }
+};
+/*
+ * Returns the default scaffolded content for a partial based on its type.
+ */ const defaultContentForType = (type)=>{
+    switch(type){
+        case _types.PartialType.Html:
+            return "<div>{{ content }}</div>";
+        case _types.PartialType.Json:
+            return "{}";
+        case _types.PartialType.Markdown:
+            return "**{{ content }}**";
+        case _types.PartialType.Text:
+        default:
+            return "{{ content }}";
+    }
+};
+/*
+ * Scaffolds a new partial directory bundle with default content.
+ */ const scaffoldPartialDirBundle = (attrs)=>{
+    const fileExt = partialTypeToFileExt(attrs.type);
+    const contentFilePath = `content.${fileExt}`;
+    const defaultContent = defaultContentForType(attrs.type);
+    const partialJson = {
+        name: attrs.name,
+        type: attrs.type,
+        [`content${_constisomorphic.FILEPATH_MARKER}`]: contentFilePath
+    };
+    return {
+        [_processorisomorphic.PARTIAL_JSON]: partialJson,
+        [contentFilePath]: defaultContent
+    };
+};
+const generatePartialDir = async (partialDirCtx, attrs)=>{
+    const bundle = scaffoldPartialDirBundle(attrs);
+    return (0, _writer.writePartialDirFromBundle)(partialDirCtx, bundle);
+};
+const generatePartialFromTemplate = async (partialDirCtx, templateString, attrs)=>{
+    let tempDir;
+    try {
+        // Download the template directory into a temp directory
+        tempDir = await _templates.downloadTemplate(templateString);
+        // Create a partial directory context for the temp directory
+        const tempPartialDirCtx = {
+            type: "partial",
+            key: "temp",
+            abspath: tempDir,
+            exists: true
+        };
+        // Read the partial.json from the temp directory we downloaded
+        const [partial, errors] = await (0, _reader.readPartialDir)(tempPartialDirCtx, {
+            withExtractedFiles: true
+        });
+        if (errors.length > 0 || !partial) {
+            throw new Error(`Invalid partial template: ${errors.join(", ")}`);
+        }
+        // Modify the partial data with the new attributes
+        const partialData = (0, _lodash.cloneDeep)(partial);
+        partialData.name = attrs.name;
+        // Finally, we write the partial into the target partial directory
+        await (0, _writer.writePartialDirFromData)(partialDirCtx, partialData);
+    } finally{
+        await _templates.cleanupTempDir(tempDir);
+    }
+};

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

@@ -25,6 +25,7 @@ _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 _projectconfig = require("../../helpers/project-config");
 const _processorisomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
@@ -74,7 +75,7 @@ const lsPartialJson = async (dirPath)=>{
     return exists ? partialJsonPath : undefined;
 };
 const isPartialDir = async (dirPath)=>Boolean(await lsPartialJson(dirPath));
-const ensureValidCommandTarget = async (props, runContext)=>{
+const ensureValidCommandTarget = async (props, runContext, projectConfig)=>{
     const { args, flags } = props;
     const { commandId, resourceDir: resourceDirCtx, cwd: runCwd } = runContext;
     // If the target resource is a different type than the current resource dir
@@ -86,6 +87,8 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     if (flags.all && args.partialKey) {
         return _core.ux.error(`partialKey arg \`${args.partialKey}\` cannot also be provided when using --all`);
     }
+    // Default to knock project config first if present, otherwise cwd.
+    const partialsIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(projectConfig, "partial", runCwd);
     // --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
@@ -93,16 +96,9 @@ const ensureValidCommandTarget = async (props, runContext)=>{
         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
+            context: flags["partials-dir"] || partialsIndexDirCtx
         };
     }
     // Partial key arg is given, which means no --all flag.
@@ -110,7 +106,7 @@ const ensureValidCommandTarget = async (props, runContext)=>{
         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 targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : _nodepath.resolve(partialsIndexDirCtx.abspath, args.partialKey);
         const partialDirCtx = {
             type: "partial",
             key: args.partialKey,

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./generator"), exports);
 _export_star(require("./helpers"), exports);
 _export_star(require("./processor.isomorphic"), exports);
 _export_star(require("./reader"), exports);

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

@@ -12,6 +12,9 @@ _export(exports, {
     get prunePartialsIndexDir () {
         return prunePartialsIndexDir;
     },
+    get writePartialDirFromBundle () {
+        return writePartialDirFromBundle;
+    },
     get writePartialDirFromData () {
         return writePartialDirFromData;
     },

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

@@ -42,6 +42,7 @@ const _core = require("@oclif/core");
 const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _localecodes = /*#__PURE__*/ _interop_require_default(require("locale-codes"));
 const _fs = require("../../helpers/fs");
+const _projectconfig = require("../../helpers/project-config");
 const _processorisomorphic = require("./processor.isomorphic");
 function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
@@ -136,7 +137,7 @@ const parseTranslationRef = (reference)=>{
     // Invalid pattern.
     return undefined;
 };
-const ensureValidCommandTarget = async (props, runContext)=>{
+const ensureValidCommandTarget = async (props, runContext, projectConfig)=>{
     const { flags, args } = props;
     const { commandId, resourceDir: resourceDirCtx, cwd: runCwd } = runContext;
     // Error, trying to run the command not in a translation directory.
@@ -147,6 +148,8 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     if (!args.translationRef && !flags.all) {
         _core.ux.error("At least one of translation ref arg or --all flag must be given");
     }
+    // Default to knock project config first if present, otherwise cwd.
+    const translationsIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(projectConfig, "translation", runCwd);
     // No translationRef arg, which means --all flag is used.
     if (!args.translationRef) {
         // Targeting all translation files in the current locale directory.
@@ -156,16 +159,9 @@ const ensureValidCommandTarget = async (props, runContext)=>{
                 context: resourceDirCtx
             };
         }
-        // Targeting all translation files in the translations index dir.
-        // TODO: Default to the knock project config first if present before cwd.
-        const defaultToCwd = {
-            abspath: runCwd,
-            exists: true
-        };
-        const indexDirCtx = flags["translations-dir"] || defaultToCwd;
         return {
             type: "translationsIndexDir",
-            context: indexDirCtx
+            context: flags["translations-dir"] || translationsIndexDirCtx
         };
     }
     // From this point on, we have translationRef so parse and validate the format.
@@ -178,7 +174,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 : flags["translations-dir"] ? _nodepath.resolve(flags["translations-dir"].abspath, localeCode) : _nodepath.resolve(runCwd, localeCode);
+    const targetDirPath = resourceDirCtx ? resourceDirCtx.abspath : flags["translations-dir"] ? _nodepath.resolve(flags["translations-dir"].abspath, localeCode) : _nodepath.resolve(translationsIndexDirCtx.abspath, localeCode);
     // Got translationRef arg but no --all flag, which means target only a single
     // translation file.
     if (!flags.all) {

package/dist/lib/marshal/translation/processor.isomorphic.js

@@ -32,14 +32,14 @@ const SUPPORTED_TRANSLATION_FORMATS = [
 const DEFAULT_TRANSLATION_FORMAT = "json";
 const formatRef = (localeCode, namespace)=>namespace ? `${namespace}.${localeCode}` : localeCode;
 const formatFileName = (input, options)=>{
-    var _options_format;
-    const extension = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : DEFAULT_TRANSLATION_FORMAT;
+    var _ref;
+    const extension = (_ref = options === null || options === void 0 ? void 0 : options.format) !== null && _ref !== void 0 ? _ref : DEFAULT_TRANSLATION_FORMAT;
     const ref = typeof input === "string" ? input : formatRef(input.locale_code, input.namespace);
     return `${ref}.${extension}`;
 };
 const buildTranslationDirBundle = (input, options)=>{
-    var _options_format;
-    const format = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : DEFAULT_TRANSLATION_FORMAT;
+    var _ref;
+    const format = (_ref = options === null || options === void 0 ? void 0 : options.format) !== null && _ref !== void 0 ? _ref : DEFAULT_TRANSLATION_FORMAT;
     if (Array.isArray(input)) {
         const translations = input;
         return Object.fromEntries(translations.map((translation)=>[

package/dist/lib/marshal/translation/writer.js

@@ -65,8 +65,8 @@ function _interop_require_wildcard(obj, nodeInterop) {
     return newObj;
 }
 const writeTranslationFile = async (translationFileCtx, translation, options)=>{
-    var _options_format;
-    const format = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : _processorisomorphic.DEFAULT_TRANSLATION_FORMAT;
+    var _ref;
+    const format = (_ref = options === null || options === void 0 ? void 0 : options.format) !== null && _ref !== void 0 ? _ref : _processorisomorphic.DEFAULT_TRANSLATION_FORMAT;
     switch(format){
         case "json":
             return _fsextra.outputJson(translationFileCtx.abspath, JSON.parse(translation.content), {