@hichchi/utils 0.0.1-alpha.0

package/src/lib/object.utils.js

@@ -0,0 +1,414 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// noinspection JSUnusedGlobalSymbols
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prune = exports.omit = exports.getValueByPath = exports.searchMapValues = exports.groupBy = exports.getMapKeys = void 0;
+exports.deepCopy = deepCopy;
+exports.getMapKey = getMapKey;
+exports.objectToPathValueSet = objectToPathValueSet;
+exports.pathValueSetToObject = pathValueSetToObject;
+/**
+ * Deep copy an object.
+ * @template T Type of the object.
+ * @param {T} obj Object to copy.
+ * @returns {T} Copied object.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const object = {
+ *    name: "John Doe"
+ * }
+ *
+ * const copiedObject = deepCopy(object);
+ * ```
+ */
+function deepCopy(obj) {
+    if (Array.isArray(obj)) {
+        return obj.map(deepCopy);
+    }
+    else if (typeof obj === "object" && obj !== null) {
+        return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, deepCopy(value)]));
+    }
+    return obj;
+}
+/**
+ * Get the key of a map by value.
+ * @param {Map<string, unknown>} map Map to get key from.
+ * @param {unknown} value Value to get key for.
+ * @returns {string | undefined} Key of the map.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const user = new Map<string, string>([
+ *     ["firstName", "John"],
+ *     ["lastName", "Doe"],
+ *     ["preferredName", "John"],
+ *     ["age", 30],
+ * ]);
+ *
+ * const key = getMapKey(user, "value2");
+ *
+ * // Example output: "firstName"
+ * ```
+ */
+function getMapKey(map, value) {
+    var _a;
+    return (_a = [...Array.from(map.entries())].find(([, v]) => v === value)) === null || _a === void 0 ? void 0 : _a[0];
+}
+/**
+ * Get the keys of a map by partial value.
+ * @param {Map<string, string>} map Map to get keys from.
+ * @param {string} partialValue Partial value to get keys for.
+ * @returns - Keys of the map.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const user = new Map<string, string>([
+ *    ["firstName", "John"],
+ *    ["lastName", "Doe"],
+ *    ["preferredName", "John"],
+ *    ["age", 30],
+ * ]);
+ *
+ * const keys = getMapKeys(user, "Jo");
+ *
+ * // Example output
+ * ["firstName", "preferredName"]
+ * ```
+ */
+const getMapKeys = (map, partialValue) => {
+    const keys = [];
+    for (const [key, value] of Array.from(map.entries())) {
+        if (value.includes(partialValue)) {
+            keys.push(key);
+        }
+    }
+    return keys;
+};
+exports.getMapKeys = getMapKeys;
+/**
+ * Groups an array of objects by a key.
+ * @template K Type of the key.
+ * @template V Type of the object.
+ * @param {Array<V>} list Array of objects to group.
+ * @param {(input: V) => K} keyGetter Function to get the key from the object.
+ * @returns {Map<K | null, Array<V>>} Grouped objects.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * // group by age, all have unique names
+ * const users = [
+ *     { name: "John", age: 30 },
+ *     { name: "Jane", age: 25 },
+ *     { name: "Doe", age: 30 },
+ *     { name: "Smith", age: 25 },
+ *     { name: "Denis", age: 30 },
+ * ];
+ *
+ * const groupedUsers = groupBy(users, user => user.age);
+ *
+ * // Example output
+ * Map {
+ *     30 => [
+ *         { name: "John", age: 30 },
+ *         { name: "Doe", age: 30 },
+ *         { name: "Denis", age: 30 },
+ *     ],
+ *     25 => [
+ *         { name: "Jane", age: 25 },
+ *         { name: "Smith", age: 25 },
+ *     ],
+ * }
+ * ```
+ */
+const groupBy = (list, keyGetter) => {
+    const map = new Map();
+    list.forEach(item => {
+        const key = keyGetter(item);
+        const collection = map.get(key);
+        if (!collection) {
+            map.set(key, [item]);
+        }
+        else {
+            collection.push(item);
+        }
+    });
+    return map;
+};
+exports.groupBy = groupBy;
+/**
+ * Get the values of a map by partial value.
+ * @param {Map<string, string>} map Map to get values from.
+ * @param {string} partialValue Partial value to get values for.
+ * @returns {string[]} Values of the map.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const user = new Map<string, string>([
+ *     ["name", "John Doe"],
+ *     ["preferredName", "John"],
+ *     ["age", 30],
+ * ]);
+ *
+ * const values = getMapValues(user, "Jo");
+ *
+ * // Example output
+ * ["John Doe", "John"]
+ * ```
+ */
+const searchMapValues = (map, partialValue) => {
+    const values = [];
+    for (const [, value] of Array.from(map.entries())) {
+        if (value.includes(partialValue)) {
+            values.push(value);
+        }
+    }
+    return values;
+};
+exports.searchMapValues = searchMapValues;
+/**
+ * Get value from an object by path.
+ * @template T - Type of the value.
+ * @param {InfiniteObject} obj Object to get value from.
+ * @param {string} path Path to get value from.
+ * @returns {T | undefined} Value from the object.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const object = {
+ *     role: "user",
+ *     profile: {
+ *         name: "John Doe",
+ *         age: 30,
+ *         address: {
+ *             city: "New York",
+ *         },
+ *     },
+ * };
+ *
+ * const value = getValueByPath<string>(object, "profile.address.city");
+ *
+ * // Example output: "New York"
+ * ```
+ */
+const getValueByPath = (obj, path) => {
+    const keys = path.split("."); // Split the path into an array of keys
+    let value = obj;
+    for (const key of keys) {
+        // noinspection RegExpRedundantEscape
+        const regExp = /^(\w+)\[(\d+)\]$/;
+        const isArrayIndex = regExp.exec(key); // Check if the key is an array index
+        if (isArrayIndex) {
+            const arrayKey = isArrayIndex[1];
+            // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+            const index = Number(isArrayIndex[2]);
+            if (arrayKey && Array.isArray(value[arrayKey]) && index >= 0 && index < value[arrayKey].length) {
+                value = value[arrayKey][index]; // Update the value to the array element
+            }
+            else {
+                return undefined; // Return undefined if the array index is invalid
+            }
+        }
+        else if (value && typeof value === "object" && key in value) {
+            value = value[key]; // Update the value to the nested property
+        }
+        else {
+            return undefined; // Return undefined if any key is not found
+        }
+    }
+    return value;
+};
+exports.getValueByPath = getValueByPath;
+/**
+ * Convert an object to a path value set
+ * @template T The type of the value
+ * @param {LiteralObject} obj The object
+ * @returns {PathValueSet<T>} The path value set
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const object = {
+ *     role: "user",
+ *     profile: {
+ *         name: "John Doe",
+ *         age: 30,
+ *         address: {
+ *             city: "New York",
+ *         },
+ *     },
+ * };
+ *
+ * const pathValueSet = objectToPathValueSet(object);
+ *
+ * // Example output
+ * {
+ *     "role": "user",
+ *     "profile.name": "John Doe",
+ *     "profile.age": 30,
+ *     "profile.address.city": "New York",
+ * }
+ *    ```
+ */
+function objectToPathValueSet(obj) {
+    const result = {};
+    function traverse(obj, path = []) {
+        for (const key in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                const value = obj[key];
+                if (typeof value === "object" && !Array.isArray(value)) {
+                    traverse(value, [...path, key]);
+                }
+                else {
+                    result[[...path, key].join(".")] = value;
+                }
+            }
+        }
+    }
+    traverse(obj);
+    return result;
+}
+/**
+ * Convert the path value set to an object
+ * @template R The return type
+ * @param {PathValueSet} pathValueSet The path value set
+ * @returns {R} The object with the path value set converted
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const pathValueSet = {
+ *     "role": "user",
+ *     "profile.name": "John Doe",
+ *     "profile.age": 30,
+ *     "profile.address.city": "New York",
+ * }
+ *
+ * const object = pathValueSetToObject(pathValueSet);
+ *
+ * // Example output
+ * {
+ *     role: "user",
+ *     profile: {
+ *         name: "John Doe",
+ *         age: 30,
+ *         address: {
+ *             city: "New York",
+ *         },
+ *     },
+ * }
+ * ```
+ *
+ */
+function pathValueSetToObject(pathValueSet) {
+    const object = {};
+    // Helper function to validate paths
+    const isValidPath = (path) => {
+        const regex = /^[a-zA-Z0-9_.-]+$/;
+        return path.split(".").every(part => regex.test(part));
+    };
+    // Helper function to set nested properties
+    const setObjectValue = (obj, keys, value) => {
+        const [firstKey, ...remainingKeys] = keys;
+        if (remainingKeys.length === 0) {
+            obj[firstKey] = value; // Set value at the final key
+            return;
+        }
+        // Initialize the key if it doesn't exist
+        obj[firstKey] = obj[firstKey] || {};
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        setObjectValue(obj[firstKey], remainingKeys, value); // Recurse for the rest of the keys
+        // TODO: Fix type for above
+    };
+    for (const path in pathValueSet) {
+        if (Object.prototype.hasOwnProperty.call(pathValueSet, path)) {
+            if (!isValidPath(path)) {
+                continue; // Skip invalid paths
+            }
+            const value = pathValueSet[path];
+            const keys = path.split("."); // Split path into keys
+            setObjectValue(object, keys, value); // Use helper to populate the object
+        }
+    }
+    return object;
+}
+/**
+ * Omits undefined properties and properties in the keys array from an object.
+ * @template T Type of the object.
+ * @param {Partial<T>} obj - Object to omit properties from.
+ * @param {(keyof T)[]} keys - Array of keys to omit.
+ * @returns {Partial<T>} - Object with omitted properties.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const object = {
+ *     role: "user",
+ *     name: "John Doe",
+ *     age: 30,
+ *     address: undefined,
+ * };
+ *
+ * omit(object, ["role"]);
+ *
+ * // Example output
+ * {
+ *     name: "John Doe",
+ *     age: 30,
+ * }
+ * ```
+ */
+const omit = (obj, keys) => {
+    if (obj) {
+        Object.keys(obj).forEach(key => {
+            return (obj[key] === undefined || (keys === null || keys === void 0 ? void 0 : keys.includes(key))) && delete obj[key];
+        });
+    }
+    return obj;
+};
+exports.omit = omit;
+/**
+ * Prune an object by removing all empty, null, undefined, and prototype properties.
+ * @template T Type of the object.
+ * @param {T} obj Object to prune.
+ * @param {boolean} [omitPrototype] Omit prototype properties.
+ * @returns {T} Pruned object.
+ *
+ * @example
+ * ```TypeScript
+ * // Example usage
+ * const object = {
+ *     role: "user",
+ *     profile: {
+ *         name: "John Doe",
+ *         age: 30,
+ *         address: undefined,
+ *         city: "New York",
+ *     },
+ * };
+ */
+const prune = (obj, omitPrototype) => {
+    const objClone = {};
+    if (typeof obj !== "object") {
+        return objClone;
+    }
+    for (const key in obj) {
+        if (!omitPrototype || Object.prototype.hasOwnProperty.call(obj, key)) {
+            if (obj[key] !== null && typeof obj[key] === "object") {
+                objClone[key] = (0, exports.prune)(obj[key], omitPrototype);
+            }
+            else if (obj[key] !== null && obj[key] !== undefined && obj[key] !== "") {
+                objClone[key] = obj[key];
+            }
+        }
+    }
+    return objClone;
+};
+exports.prune = prune;
+//# sourceMappingURL=object.utils.js.map

package/src/lib/object.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.utils.js","sourceRoot":"","sources":["../../../../../libs/utils/src/lib/object.utils.ts"],"names":[],"mappings":";AAAA,uDAAuD;AACvD,qCAAqC;;;AAqBrC,4BAOC;AAuBD,8BAEC;AAyMD,oDAmBC;AAkCD,oDAqCC;AAnVD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,QAAQ,CAAI,GAAM;IAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,CAAC;IAC7C,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAiB,CAAC;IACjH,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,SAAS,CAAC,GAAyB,EAAE,KAAc;;IAC/D,OAAO,MAAA,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,0CAAG,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,MAAM,UAAU,GAAG,CAAC,GAAwB,EAAE,YAAoB,EAAY,EAAE;IACnF,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AARW,QAAA,UAAU,cAQrB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,MAAM,OAAO,GAAG,CAAO,IAAc,EAAE,SAA0B,EAA2B,EAAE;IACjG,MAAM,GAAG,GAAG,IAAI,GAAG,EAAe,CAAC;IACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAChB,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QACzB,CAAC;aAAM,CAAC;YACJ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,eAAe,GAAG,CAAC,GAAwB,EAAE,YAAoB,EAAY,EAAE;IACxF,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,eAAe,mBAQ1B;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,MAAM,cAAc,GAAG,CAAI,GAAmB,EAAE,IAAY,EAAiB,EAAE;IAClF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,uCAAuC;IAErE,IAAI,KAAK,GAAG,GAAG,CAAC;IAChB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,qCAAqC;QAErC,MAAM,MAAM,GAAG,kBAAkB,CAAC;QAClC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,qCAAqC;QAE5E,IAAI,YAAY,EAAE,CAAC;YACf,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACjC,+DAA+D;YAC/D,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,IAAI,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC7F,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,wCAAwC;YAC5E,CAAC;iBAAM,CAAC;gBACJ,OAAO,SAAS,CAAC,CAAC,iDAAiD;YACvE,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;YAC5D,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,0CAA0C;QAClE,CAAC;aAAM,CAAC;YACJ,OAAO,SAAS,CAAC,CAAC,2CAA2C;QACjE,CAAC;IACL,CAAC;IAED,OAAO,KAAU,CAAC;AACtB,CAAC,CAAC;AA3BW,QAAA,cAAc,kBA2BzB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,oBAAoB,CAAC,GAAkB;IACnD,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,SAAS,QAAQ,CAAC,GAAkB,EAAE,OAAiB,EAAE;QACrD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACpB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;gBACjD,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrD,QAAQ,CAAC,KAAsB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;gBAC7C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,GAAG,CAAC,CAAC;IAEd,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,oBAAoB,CAAa,YAAiC;IAC9E,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,oCAAoC;IACpC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE;QAC1C,MAAM,KAAK,GAAG,mBAAmB,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC;IAEF,2CAA2C;IAC3C,MAAM,cAAc,GAAG,CAAc,GAAwB,EAAE,IAAc,EAAE,KAAQ,EAAQ,EAAE;QAC7F,MAAM,CAAC,QAAQ,EAAE,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC;QAC1C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,6BAA6B;YACpD,OAAO;QACX,CAAC;QAED,yCAAyC;QACzC,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACpC,iEAAiE;QACjE,cAAc,CAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC,mCAAmC;QAC3F,2BAA2B;IAC/B,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,SAAS,CAAC,qBAAqB;YACnC,CAAC;YAED,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,uBAAuB;YACrD,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,oCAAoC;QAC7E,CAAC;IACL,CAAC;IAED,OAAO,MAAW,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,MAAM,IAAI,GAAG,CAAuC,GAAe,EAAE,IAAkB,EAAc,EAAE;IAC1G,IAAI,GAAG,EAAE,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,KAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAPW,QAAA,IAAI,QAOf;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,KAAK,GAAG,CAAI,GAAuB,EAAE,aAAuB,EAAK,EAAE;IAC5E,MAAM,QAAQ,GAAM,EAAO,CAAC;IAC5B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,QAAa,CAAC;IACzB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;YACnE,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAA,aAAK,EAAC,GAAG,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC;YACnD,CAAC;iBAAM,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxE,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,QAAa,CAAC;AACzB,CAAC,CAAC;AAhBW,QAAA,KAAK,SAgBhB"}

package/src/lib/string-template.utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Apply error message prefix to a valid template string
+ *
+ * Acceptable template tags:
+ * - `#{upperCase}`
+ * - `#{snakeCase}`
+ * - `#{upperSnakeCase}`
+ * - `#{lowerCase}`
+ * - `#{sentenceCase}`
+ * - `#{firstCase}`
+ *
+ * @example
+ * ```TypeScript
+ * applyTemplate(
+ *     'Cannot create a #{lowerCase} with this email. #{sentenceCase} already exists.',
+ *     'User'
+ * );
+ * // Output: Cannot create a user with this email. User exists.
+ * ```
+ *
+ * @param {string} str Template string to apply prefix
+ * @param {string} prefix Prefix to apply
+ * @returns {string} Prefix applied string
+ */
+export declare function applyTemplate(str: string, prefix: string): string;

package/src/lib/string-template.utils.js

@@ -0,0 +1,40 @@
+"use strict";
+// noinspection JSUnusedGlobalSymbols
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyTemplate = applyTemplate;
+const string_utils_1 = require("./string.utils");
+/**
+ * Apply error message prefix to a valid template string
+ *
+ * Acceptable template tags:
+ * - `#{upperCase}`
+ * - `#{snakeCase}`
+ * - `#{upperSnakeCase}`
+ * - `#{lowerCase}`
+ * - `#{sentenceCase}`
+ * - `#{firstCase}`
+ *
+ * @example
+ * ```TypeScript
+ * applyTemplate(
+ *     'Cannot create a #{lowerCase} with this email. #{sentenceCase} already exists.',
+ *     'User'
+ * );
+ * // Output: Cannot create a user with this email. User exists.
+ * ```
+ *
+ * @param {string} str Template string to apply prefix
+ * @param {string} prefix Prefix to apply
+ * @returns {string} Prefix applied string
+ */
+function applyTemplate(str, prefix) {
+    // TODO: Upgrade to export #{} as constants and include all string utils
+    return str
+        .replace("#{upperCase}", prefix.toUpperCase())
+        .replace("#{snakeCase}", (0, string_utils_1.toSnakeCase)(prefix))
+        .replace("#{upperSnakeCase}", (0, string_utils_1.toSnakeCase)(prefix, true))
+        .replace("#{lowerCase}", prefix.toLowerCase())
+        .replace("#{sentenceCase}", (0, string_utils_1.toSentenceCase)(prefix))
+        .replace("#{firstCase}", (0, string_utils_1.toFirstCase)(prefix));
+}
+//# sourceMappingURL=string-template.utils.js.map

package/src/lib/string-template.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-template.utils.js","sourceRoot":"","sources":["../../../../../libs/utils/src/lib/string-template.utils.ts"],"names":[],"mappings":";AAAA,qCAAqC;;AA4BrC,sCASC;AAnCD,iDAA0E;AAE1E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,aAAa,CAAC,GAAW,EAAE,MAAc;IACrD,wEAAwE;IACxE,OAAO,GAAG;SACL,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;SAC7C,OAAO,CAAC,cAAc,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SAC5C,OAAO,CAAC,mBAAmB,EAAE,IAAA,0BAAW,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACvD,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;SAC7C,OAAO,CAAC,iBAAiB,EAAE,IAAA,6BAAc,EAAC,MAAM,CAAC,CAAC;SAClD,OAAO,CAAC,cAAc,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC,CAAC;AACtD,CAAC"}