@truto/replace-placeholders 1.0.0

package/README.md

@@ -0,0 +1,112 @@
+# @truto/replace-placeholders
+
+Replace placeholders in strings, arrays, and objects easily. This package internally utilizes the [wild-wild-path](https://www.npmjs.com/package/wild-wild-path) library and supports all path formats provided by it.
+
+## Installation
+
+```bash
+npm install @truto/replace-placeholders
+```
+
+## Usage
+
+### Basic
+
+```javascript
+import replacePlaceholders from '@truto/replace-placeholders';
+
+const result = replacePlaceholders('{{foo}}', { foo: 'bar' });
+console.log(result);  // Outputs: 'bar'
+```
+
+### Advanced Usage with Different Data Types
+
+#### Strings
+
+```javascript
+console.log(replacePlaceholders('{{foo}}', { foo: 'bar' }));  // Outputs: 'bar'
+console.log(replacePlaceholders('{{foo-bar.something}}', { 'foo-bar': { something: true } }));  // Outputs: 'true'
+console.log(replacePlaceholders('{{foo}} {{bar:bool}}', { foo: 'bar', bar: 'false' }));  // Outputs: 'bar false'
+```
+
+#### Arrays
+
+```javascript
+console.log(replacePlaceholders(['{{foo}}'], { foo: 'bar' }));  // Outputs: ['bar']
+console.log(replacePlaceholders(['{{foo}}', '{{bar:num}}'], { foo: 'bar', bar: '1.34' }));  // Outputs: ['bar', 1.34]
+```
+
+#### Objects
+
+```javascript
+console.log(replacePlaceholders({ foo: '{{foo}}' }, { foo: 'bar' }));  // Outputs: { foo: 'bar' }
+console.log(replacePlaceholders({ foo: '{{foo}}', bar: '{{bar:int}}' }, { foo: 'bar', bar: 1 }));  // Outputs: { foo: 'bar', bar: 1 }
+```
+
+### Conversion Types
+
+```javascript
+console.log(replacePlaceholders('{{foo:int}}', { foo: '1' }));  // Outputs: 1
+console.log(replacePlaceholders('{{foo:num}}', { foo: '1.1' }));  // Outputs: 1.1
+console.log(replacePlaceholders('{{foo:bool}}', { foo: 'true' }));  // Outputs: true
+console.log(replacePlaceholders('{{foo:json}}', { foo: '{"foo":"bar"}' }));  // Outputs: { foo: 'bar' }
+console.log(replacePlaceholders('{{foo:null}}', { foo: 'null' }));  // Outputs: null
+// ... add other examples ...
+```
+
+### Conditional Replacements (Fallback Values)
+
+Using a `|` (pipe) character, you can provide fallback values right within the placeholder. The function will pick the first non-`undefined` value for the replacement.
+
+```javascript
+console.log(replacePlaceholders('{{foo|bar}}', { foo: 'foo', bar: 'bar' }));  // Outputs: 'foo'
+console.log(replacePlaceholders('{{foo:str|bar:int}}', { bar: 1 }));  // Outputs: 1
+console.log(replacePlaceholders('{{foo.bar:str|bar:str}}', { foo: { bar: 'bar' } }));  // Outputs: 'bar'
+console.log(replacePlaceholders('{{foo.bar|bar:str}}', { foo: { bar: true } }));  // Outputs: 'true'
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+```
+MIT License
+
+Copyright (c) 2023 Yin Yang Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## Contributing
+
+We welcome contributions from the community! If you wish to contribute, please follow these steps:
+
+1. **Fork the repository**: Click on the 'Fork' button at the top right of this page and clone your forked repository to your local machine.
+
+2. **Create a new branch**: Create a new branch named after the feature or fix you are working on. For example: `feature/new-placeholder-syntax` or `fix/issue-123`.
+
+3. **Make your changes**: Make the necessary modifications to the code. Ensure that you adhere to the existing coding standards and conventions.
+
+4. **Commit your changes**: Commit your changes with a clear and concise commit message that describes the changes you made.
+
+5. **Push to your fork**: Push your changes to your forked repository on GitHub.
+
+6. **Submit a pull request**: Create a new pull request from your forked repository to the main repository. Please ensure that your pull request describes the changes you made, references any related issues, and has been tested on the latest version of the package.
+
+Please note: By contributing to this project, you agree to abide by the code of conduct and that your contributions will be licensed under the MIT license (as per the LICENSE section).

package/dist/main.cjs

@@ -0,0 +1,102 @@
+var $g5Y9E$traverse = require("traverse");
+var $g5Y9E$lodashes = require("lodash-es");
+var $g5Y9E$wildwildpath = require("wild-wild-path");
+
+function $parcel$defineInteropFlag(a) {
+  Object.defineProperty(a, '__esModule', {value: true, configurable: true});
+}
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+function $parcel$interopDefault(a) {
+  return a && a.__esModule ? a.default : a;
+}
+
+$parcel$defineInteropFlag(module.exports);
+
+$parcel$export(module.exports, "default", () => $80bd448eb6ea085b$export$2e2bcd8739ae039);
+
+
+
+
+function $a169b0c20575e4d3$var$replace(str = "", obj = {}) {
+    const regex = /{{([\w-.|:]+)}}/gi;
+    const matches = str.match(regex);
+    let result = str;
+    if (matches) matches.forEach((match)=>{
+        const parts = match.slice(2, -2).split("|");
+        const isNullAllowed = parts.some((part)=>part.includes(":null"));
+        let value = undefined;
+        for (const part of parts){
+            const [path, ...typeParts] = part.split(":");
+            const type = typeParts[0] || "str";
+            const tempValue = (0, $g5Y9E$wildwildpath.get)(obj, path.trim());
+            if (tempValue !== undefined) {
+                value = $a169b0c20575e4d3$var$typeCast(tempValue, type, match === str);
+                break;
+            }
+        }
+        if (value === undefined) {
+            if (isNullAllowed) value = null;
+            else value = match // Keep the placeholder intact
+            ;
+        }
+        if (match === str) result = value;
+        else result = result.replace(match, value);
+    });
+    return result;
+}
+function $a169b0c20575e4d3$var$typeCast(value, type, isWholeString) {
+    if (value === undefined || value === null) return value;
+    let castValue;
+    switch(type){
+        case "null":
+            if (value === "null" || value === null) return null;
+            return isWholeString ? value : "null";
+        case "int":
+            castValue = parseInt(value);
+            return isNaN(castValue) ? value : castValue;
+        case "num":
+            castValue = parseFloat(value);
+            return isNaN(castValue) ? value : castValue;
+        case "str":
+            return String(value);
+        case "bool":
+            if (value === "true" || value === true) return true;
+            if (value === "false" || value === false) return false;
+            return value // Return the original value if it's not 'true' or 'false'
+            ;
+        case "json":
+            if (isWholeString) {
+                if ((0, $g5Y9E$lodashes.isPlainObject)(value)) return value;
+                try {
+                    return JSON.parse(value);
+                } catch (err) {
+                    return value;
+                }
+            }
+            return value;
+        case "any":
+            return value;
+        default:
+            throw new Error(`Unsupported type: ${type}`);
+    }
+}
+var $a169b0c20575e4d3$export$2e2bcd8739ae039 = $a169b0c20575e4d3$var$replace;
+
+
+function $72af1098ef591494$export$2e2bcd8739ae039(obj, context) {
+    if ((0, $g5Y9E$lodashes.isString)(obj)) return (0, $a169b0c20575e4d3$export$2e2bcd8739ae039)(obj, context);
+    if ((0, $g5Y9E$lodashes.isArray)(obj)) return obj.map((item)=>$72af1098ef591494$export$2e2bcd8739ae039(item, context));
+    if ((0, $g5Y9E$lodashes.isPlainObject)(obj)) return (0, ($parcel$interopDefault($g5Y9E$traverse)))(obj).map(function(value) {
+        if (this.circular) this.remove();
+        else if ((0, $g5Y9E$lodashes.isString)(value)) this.update((0, $a169b0c20575e4d3$export$2e2bcd8739ae039)(value, context));
+    });
+    throw new Error("Invalid type");
+}
+
+
+var $80bd448eb6ea085b$export$2e2bcd8739ae039 = (0, $72af1098ef591494$export$2e2bcd8739ae039);
+
+
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;ACAA;;ACAA;;AAGA,SAAS,8BACP,MAAM,EAAE,EACR,MAAc,CAAC,CAAC,EAQN;IACV,MAAM,QAAQ;IACd,MAAM,UAAU,IAAI,KAAK,CAAC;IAC1B,IAAI,SAAuB;IAE3B,IAAI,SACF,QAAQ,OAAO,CAAC,CAAA,QAAS;QACvB,MAAM,QAAQ,MAAM,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC;QACvC,MAAM,gBAAgB,MAAM,IAAI,CAAC,CAAA,OAAQ,KAAK,QAAQ,CAAC;QAEvD,IAAI,QAAa;QACjB,KAAK,MAAM,QAAQ,MAAO;YACxB,MAAM,CAAC,MAAM,GAAG,UAAU,GAAG,KAAK,KAAK,CAAC;YACxC,MAAM,OAAe,SAAS,CAAC,EAAE,IAAI;YAErC,MAAM,YAAY,CAAA,GAAA,uBAAO,AAAD,EAAE,KAAK,KAAK,IAAI;YACxC,IAAI,cAAc,WAAW;gBAC3B,QAAQ,+BAAS,WAAW,MAAM,UAAU;gBAC5C,KAAK;YACP,CAAC;QACH;QAEA,IAAI,UAAU;YACZ,IAAI,eACF,QAAQ,IAAI;iBAEZ,QAAQ,MAAM,8BAA8B;;SAE/C;QAED,IAAI,UAAU,KACZ,SAAS;aAET,SAAS,OAAO,OAAO,CAAC,OAAO;IAEnC;IAGF,OAAO;AACT;AAEA,SAAS,+BACP,KAAc,EACd,IAAY,EACZ,aAAsB,EAQZ;IACV,IAAI,UAAU,aAAa,UAAU,IAAI,EAAE,OAAO;IAElD,IAAI;IACJ,OAAQ;QACN,KAAK;YACH,IAAI,UAAU,UAAU,UAAU,IAAI,EAAE,OAAO,IAAI;YACnD,OAAO,gBAAgB,QAAQ,MAAM;QACvC,KAAK;YACH,YAAY,SAAS;YACrB,OAAO,MAAM,aAAa,QAAQ,SAAS;QAC7C,KAAK;YACH,YAAY,WAAW;YACvB,OAAO,MAAM,aAAa,QAAQ,SAAS;QAC7C,KAAK;YACH,OAAO,OAAO;QAChB,KAAK;YACH,IAAI,UAAU,UAAU,UAAU,IAAI,EAAE,OAAO,IAAI;YACnD,IAAI,UAAU,WAAW,UAAU,KAAK,EAAE,OAAO,KAAK;YACtD,OAAO,MAAM,0DAA0D;;QACzE,KAAK;YACH,IAAI,eAAe;gBACjB,IAAI,CAAA,GAAA,6BAAa,AAAD,EAAE,QAAQ,OAAO;gBACjC,IAAI;oBACF,OAAO,KAAK,KAAK,CAAC;gBACpB,EAAE,OAAO,KAAK;oBACZ,OAAO;gBACT;YACF,CAAC;YACD,OAAO;QACT,KAAK;YACH,OAAO;QACT;YACE,MAAM,IAAI,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,EAAC;IAChD;AACF;IAEA,2CAAe;;;ADnGA,kDACb,GAAsE,EACtE,OAAgC,EAC7B;IACH,IAAI,CAAA,GAAA,wBAAO,EAAE,MACX,OAAO,CAAA,GAAA,wCAAM,EAAE,KAAK;IAGtB,IAAI,CAAA,GAAA,uBAAO,AAAD,EAAE,MACV,OAAO,IAAI,GAAG,CAAC,CAAA,OAAQ,yCAAoB,MAAM;IAGnD,IAAI,CAAA,GAAA,6BAAY,EAAE,MAChB,OAAO,CAAA,GAAA,yCAAO,EAAE,KAAK,GAAG,CAAC,SAAU,KAAK,EAAE;QACxC,IAAI,IAAI,CAAC,QAAQ,EACf,IAAI,CAAC,MAAM;aACN,IAAI,CAAA,GAAA,wBAAQ,AAAD,EAAE,QAClB,IAAI,CAAC,MAAM,CAAC,CAAA,GAAA,wCAAO,AAAD,EAAE,OAAO;IAE/B;IAGF,MAAM,IAAI,MAAM,gBAAe;AACjC;;AD1BA;IACA,2CAAe,CAAA,GAAA,wCAAkB","sources":["index.ts","replacePlaceholders.ts","replace.ts"],"sourcesContent":["import replacePlaceholders from './replacePlaceholders';\nexport default replacePlaceholders;\n","import traverse from 'traverse'\nimport { isString, isArray, isPlainObject } from 'lodash-es'\nimport replace from './replace'\nexport default function replacePlaceholders<T>(\n  obj: T extends string | string[] | Record<string, unknown> ? T : never,\n  context: Record<string, unknown>\n): T {\n  if (isString(obj)) {\n    return replace(obj, context) as T\n  }\n\n  if (isArray(obj)) {\n    return obj.map(item => replacePlaceholders(item, context)) as T\n  }\n\n  if (isPlainObject(obj)) {\n    return traverse(obj).map(function (value) {\n      if (this.circular) {\n        this.remove()\n      } else if (isString(value)) {\n        this.update(replace(value, context))\n      }\n    })\n  }\n\n  throw new Error('Invalid type')\n}\n","import { get as getWild } from 'wild-wild-path'\nimport { isPlainObject } from 'lodash-es'\n\nfunction replace(\n  str = '',\n  obj: object = {}\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  const regex = /{{([\\w-.|:]+)}}/gi\n  const matches = str.match(regex)\n  let result: string | any = str\n\n  if (matches) {\n    matches.forEach(match => {\n      const parts = match.slice(2, -2).split('|')\n      const isNullAllowed = parts.some(part => part.includes(':null'))\n\n      let value: any = undefined\n      for (const part of parts) {\n        const [path, ...typeParts] = part.split(':')\n        const type: string = typeParts[0] || 'str'\n\n        const tempValue = getWild(obj, path.trim())\n        if (tempValue !== undefined) {\n          value = typeCast(tempValue, type, match === str)\n          break\n        }\n      }\n\n      if (value === undefined) {\n        if (isNullAllowed) {\n          value = null\n        } else {\n          value = match // Keep the placeholder intact\n        }\n      }\n\n      if (match === str) {\n        result = value\n      } else {\n        result = result.replace(match, value)\n      }\n    })\n  }\n\n  return result\n}\n\nfunction typeCast(\n  value: unknown,\n  type: string,\n  isWholeString: boolean\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  if (value === undefined || value === null) return value\n\n  let castValue: any\n  switch (type) {\n    case 'null':\n      if (value === 'null' || value === null) return null\n      return isWholeString ? value : 'null'\n    case 'int':\n      castValue = parseInt(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'num':\n      castValue = parseFloat(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'str':\n      return String(value)\n    case 'bool':\n      if (value === 'true' || value === true) return true\n      if (value === 'false' || value === false) return false\n      return value // Return the original value if it's not 'true' or 'false'\n    case 'json':\n      if (isWholeString) {\n        if (isPlainObject(value)) return value\n        try {\n          return JSON.parse(value as string)\n        } catch (err) {\n          return value\n        }\n      }\n      return value\n    case 'any':\n      return value\n    default:\n      throw new Error(`Unsupported type: ${type}`)\n  }\n}\n\nexport default replace\n"],"names":[],"version":3,"file":"main.cjs.map"}

package/dist/module.js

@@ -0,0 +1,90 @@
+import $hCgyA$traverse from "traverse";
+import {isString as $hCgyA$isString, isArray as $hCgyA$isArray, isPlainObject as $hCgyA$isPlainObject} from "lodash-es";
+import {get as $hCgyA$get} from "wild-wild-path";
+
+
+
+
+
+function $67f2b908c91abfcc$var$replace(str = "", obj = {}) {
+    const regex = /{{([\w-.|:]+)}}/gi;
+    const matches = str.match(regex);
+    let result = str;
+    if (matches) matches.forEach((match)=>{
+        const parts = match.slice(2, -2).split("|");
+        const isNullAllowed = parts.some((part)=>part.includes(":null"));
+        let value = undefined;
+        for (const part of parts){
+            const [path, ...typeParts] = part.split(":");
+            const type = typeParts[0] || "str";
+            const tempValue = (0, $hCgyA$get)(obj, path.trim());
+            if (tempValue !== undefined) {
+                value = $67f2b908c91abfcc$var$typeCast(tempValue, type, match === str);
+                break;
+            }
+        }
+        if (value === undefined) {
+            if (isNullAllowed) value = null;
+            else value = match // Keep the placeholder intact
+            ;
+        }
+        if (match === str) result = value;
+        else result = result.replace(match, value);
+    });
+    return result;
+}
+function $67f2b908c91abfcc$var$typeCast(value, type, isWholeString) {
+    if (value === undefined || value === null) return value;
+    let castValue;
+    switch(type){
+        case "null":
+            if (value === "null" || value === null) return null;
+            return isWholeString ? value : "null";
+        case "int":
+            castValue = parseInt(value);
+            return isNaN(castValue) ? value : castValue;
+        case "num":
+            castValue = parseFloat(value);
+            return isNaN(castValue) ? value : castValue;
+        case "str":
+            return String(value);
+        case "bool":
+            if (value === "true" || value === true) return true;
+            if (value === "false" || value === false) return false;
+            return value // Return the original value if it's not 'true' or 'false'
+            ;
+        case "json":
+            if (isWholeString) {
+                if ((0, $hCgyA$isPlainObject)(value)) return value;
+                try {
+                    return JSON.parse(value);
+                } catch (err) {
+                    return value;
+                }
+            }
+            return value;
+        case "any":
+            return value;
+        default:
+            throw new Error(`Unsupported type: ${type}`);
+    }
+}
+var $67f2b908c91abfcc$export$2e2bcd8739ae039 = $67f2b908c91abfcc$var$replace;
+
+
+function $4e62acd4800cacd9$export$2e2bcd8739ae039(obj, context) {
+    if ((0, $hCgyA$isString)(obj)) return (0, $67f2b908c91abfcc$export$2e2bcd8739ae039)(obj, context);
+    if ((0, $hCgyA$isArray)(obj)) return obj.map((item)=>$4e62acd4800cacd9$export$2e2bcd8739ae039(item, context));
+    if ((0, $hCgyA$isPlainObject)(obj)) return (0, $hCgyA$traverse)(obj).map(function(value) {
+        if (this.circular) this.remove();
+        else if ((0, $hCgyA$isString)(value)) this.update((0, $67f2b908c91abfcc$export$2e2bcd8739ae039)(value, context));
+    });
+    throw new Error("Invalid type");
+}
+
+
+var $c3f6c693698dc7cd$export$2e2bcd8739ae039 = (0, $4e62acd4800cacd9$export$2e2bcd8739ae039);
+
+
+export {$c3f6c693698dc7cd$export$2e2bcd8739ae039 as default};
+//# sourceMappingURL=module.js.map

package/dist/module.js.map

@@ -0,0 +1 @@
+{"mappings":";;;;ACAA;;ACAA;;AAGA,SAAS,8BACP,MAAM,EAAE,EACR,MAAc,CAAC,CAAC,EAQN;IACV,MAAM,QAAQ;IACd,MAAM,UAAU,IAAI,KAAK,CAAC;IAC1B,IAAI,SAAuB;IAE3B,IAAI,SACF,QAAQ,OAAO,CAAC,CAAA,QAAS;QACvB,MAAM,QAAQ,MAAM,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC;QACvC,MAAM,gBAAgB,MAAM,IAAI,CAAC,CAAA,OAAQ,KAAK,QAAQ,CAAC;QAEvD,IAAI,QAAa;QACjB,KAAK,MAAM,QAAQ,MAAO;YACxB,MAAM,CAAC,MAAM,GAAG,UAAU,GAAG,KAAK,KAAK,CAAC;YACxC,MAAM,OAAe,SAAS,CAAC,EAAE,IAAI;YAErC,MAAM,YAAY,CAAA,GAAA,UAAO,AAAD,EAAE,KAAK,KAAK,IAAI;YACxC,IAAI,cAAc,WAAW;gBAC3B,QAAQ,+BAAS,WAAW,MAAM,UAAU;gBAC5C,KAAK;YACP,CAAC;QACH;QAEA,IAAI,UAAU;YACZ,IAAI,eACF,QAAQ,IAAI;iBAEZ,QAAQ,MAAM,8BAA8B;;SAE/C;QAED,IAAI,UAAU,KACZ,SAAS;aAET,SAAS,OAAO,OAAO,CAAC,OAAO;IAEnC;IAGF,OAAO;AACT;AAEA,SAAS,+BACP,KAAc,EACd,IAAY,EACZ,aAAsB,EAQZ;IACV,IAAI,UAAU,aAAa,UAAU,IAAI,EAAE,OAAO;IAElD,IAAI;IACJ,OAAQ;QACN,KAAK;YACH,IAAI,UAAU,UAAU,UAAU,IAAI,EAAE,OAAO,IAAI;YACnD,OAAO,gBAAgB,QAAQ,MAAM;QACvC,KAAK;YACH,YAAY,SAAS;YACrB,OAAO,MAAM,aAAa,QAAQ,SAAS;QAC7C,KAAK;YACH,YAAY,WAAW;YACvB,OAAO,MAAM,aAAa,QAAQ,SAAS;QAC7C,KAAK;YACH,OAAO,OAAO;QAChB,KAAK;YACH,IAAI,UAAU,UAAU,UAAU,IAAI,EAAE,OAAO,IAAI;YACnD,IAAI,UAAU,WAAW,UAAU,KAAK,EAAE,OAAO,KAAK;YACtD,OAAO,MAAM,0DAA0D;;QACzE,KAAK;YACH,IAAI,eAAe;gBACjB,IAAI,CAAA,GAAA,oBAAa,AAAD,EAAE,QAAQ,OAAO;gBACjC,IAAI;oBACF,OAAO,KAAK,KAAK,CAAC;gBACpB,EAAE,OAAO,KAAK;oBACZ,OAAO;gBACT;YACF,CAAC;YACD,OAAO;QACT,KAAK;YACH,OAAO;QACT;YACE,MAAM,IAAI,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,EAAC;IAChD;AACF;IAEA,2CAAe;;;ADnGA,kDACb,GAAsE,EACtE,OAAgC,EAC7B;IACH,IAAI,CAAA,GAAA,eAAO,EAAE,MACX,OAAO,CAAA,GAAA,wCAAM,EAAE,KAAK;IAGtB,IAAI,CAAA,GAAA,cAAO,AAAD,EAAE,MACV,OAAO,IAAI,GAAG,CAAC,CAAA,OAAQ,yCAAoB,MAAM;IAGnD,IAAI,CAAA,GAAA,oBAAY,EAAE,MAChB,OAAO,CAAA,GAAA,eAAO,EAAE,KAAK,GAAG,CAAC,SAAU,KAAK,EAAE;QACxC,IAAI,IAAI,CAAC,QAAQ,EACf,IAAI,CAAC,MAAM;aACN,IAAI,CAAA,GAAA,eAAQ,AAAD,EAAE,QAClB,IAAI,CAAC,MAAM,CAAC,CAAA,GAAA,wCAAO,AAAD,EAAE,OAAO;IAE/B;IAGF,MAAM,IAAI,MAAM,gBAAe;AACjC;;AD1BA;IACA,2CAAe,CAAA,GAAA,wCAAkB","sources":["index.ts","replacePlaceholders.ts","replace.ts"],"sourcesContent":["import replacePlaceholders from './replacePlaceholders';\nexport default replacePlaceholders;\n","import traverse from 'traverse'\nimport { isString, isArray, isPlainObject } from 'lodash-es'\nimport replace from './replace'\nexport default function replacePlaceholders<T>(\n  obj: T extends string | string[] | Record<string, unknown> ? T : never,\n  context: Record<string, unknown>\n): T {\n  if (isString(obj)) {\n    return replace(obj, context) as T\n  }\n\n  if (isArray(obj)) {\n    return obj.map(item => replacePlaceholders(item, context)) as T\n  }\n\n  if (isPlainObject(obj)) {\n    return traverse(obj).map(function (value) {\n      if (this.circular) {\n        this.remove()\n      } else if (isString(value)) {\n        this.update(replace(value, context))\n      }\n    })\n  }\n\n  throw new Error('Invalid type')\n}\n","import { get as getWild } from 'wild-wild-path'\nimport { isPlainObject } from 'lodash-es'\n\nfunction replace(\n  str = '',\n  obj: object = {}\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  const regex = /{{([\\w-.|:]+)}}/gi\n  const matches = str.match(regex)\n  let result: string | any = str\n\n  if (matches) {\n    matches.forEach(match => {\n      const parts = match.slice(2, -2).split('|')\n      const isNullAllowed = parts.some(part => part.includes(':null'))\n\n      let value: any = undefined\n      for (const part of parts) {\n        const [path, ...typeParts] = part.split(':')\n        const type: string = typeParts[0] || 'str'\n\n        const tempValue = getWild(obj, path.trim())\n        if (tempValue !== undefined) {\n          value = typeCast(tempValue, type, match === str)\n          break\n        }\n      }\n\n      if (value === undefined) {\n        if (isNullAllowed) {\n          value = null\n        } else {\n          value = match // Keep the placeholder intact\n        }\n      }\n\n      if (match === str) {\n        result = value\n      } else {\n        result = result.replace(match, value)\n      }\n    })\n  }\n\n  return result\n}\n\nfunction typeCast(\n  value: unknown,\n  type: string,\n  isWholeString: boolean\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  if (value === undefined || value === null) return value\n\n  let castValue: any\n  switch (type) {\n    case 'null':\n      if (value === 'null' || value === null) return null\n      return isWholeString ? value : 'null'\n    case 'int':\n      castValue = parseInt(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'num':\n      castValue = parseFloat(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'str':\n      return String(value)\n    case 'bool':\n      if (value === 'true' || value === true) return true\n      if (value === 'false' || value === false) return false\n      return value // Return the original value if it's not 'true' or 'false'\n    case 'json':\n      if (isWholeString) {\n        if (isPlainObject(value)) return value\n        try {\n          return JSON.parse(value as string)\n        } catch (err) {\n          return value\n        }\n      }\n      return value\n    case 'any':\n      return value\n    default:\n      throw new Error(`Unsupported type: ${type}`)\n  }\n}\n\nexport default replace\n"],"names":[],"version":3,"file":"module.js.map"}

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+declare function replacePlaceholders<T>(obj: T extends string | string[] | Record<string, unknown> ? T : never, context: Record<string, unknown>): T;
+export default replacePlaceholders;
+
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"ACGA,qCAA4C,CAAC,EAC3C,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,EACtE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,CAAC,CAoBH;ACzBD,eAAe,mBAAmB,CAAC","sources":["replace.ts","replacePlaceholders.ts","index.ts"],"sourcesContent":["import { get as getWild } from 'wild-wild-path'\nimport { isPlainObject } from 'lodash-es'\n\nfunction replace(\n  str = '',\n  obj: object = {}\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  const regex = /{{([\\w-.|:]+)}}/gi\n  const matches = str.match(regex)\n  let result: string | any = str\n\n  if (matches) {\n    matches.forEach(match => {\n      const parts = match.slice(2, -2).split('|')\n      const isNullAllowed = parts.some(part => part.includes(':null'))\n\n      let value: any = undefined\n      for (const part of parts) {\n        const [path, ...typeParts] = part.split(':')\n        const type: string = typeParts[0] || 'str'\n\n        const tempValue = getWild(obj, path.trim())\n        if (tempValue !== undefined) {\n          value = typeCast(tempValue, type, match === str)\n          break\n        }\n      }\n\n      if (value === undefined) {\n        if (isNullAllowed) {\n          value = null\n        } else {\n          value = match // Keep the placeholder intact\n        }\n      }\n\n      if (match === str) {\n        result = value\n      } else {\n        result = result.replace(match, value)\n      }\n    })\n  }\n\n  return result\n}\n\nfunction typeCast(\n  value: unknown,\n  type: string,\n  isWholeString: boolean\n):\n  | string\n  | number\n  | boolean\n  | Record<string, unknown>\n  | null\n  | undefined\n  | unknown {\n  if (value === undefined || value === null) return value\n\n  let castValue: any\n  switch (type) {\n    case 'null':\n      if (value === 'null' || value === null) return null\n      return isWholeString ? value : 'null'\n    case 'int':\n      castValue = parseInt(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'num':\n      castValue = parseFloat(value as string)\n      return isNaN(castValue) ? value : castValue\n    case 'str':\n      return String(value)\n    case 'bool':\n      if (value === 'true' || value === true) return true\n      if (value === 'false' || value === false) return false\n      return value // Return the original value if it's not 'true' or 'false'\n    case 'json':\n      if (isWholeString) {\n        if (isPlainObject(value)) return value\n        try {\n          return JSON.parse(value as string)\n        } catch (err) {\n          return value\n        }\n      }\n      return value\n    case 'any':\n      return value\n    default:\n      throw new Error(`Unsupported type: ${type}`)\n  }\n}\n\nexport default replace\n","import traverse from 'traverse'\nimport { isString, isArray, isPlainObject } from 'lodash-es'\nimport replace from './replace'\nexport default function replacePlaceholders<T>(\n  obj: T extends string | string[] | Record<string, unknown> ? T : never,\n  context: Record<string, unknown>\n): T {\n  if (isString(obj)) {\n    return replace(obj, context) as T\n  }\n\n  if (isArray(obj)) {\n    return obj.map(item => replacePlaceholders(item, context)) as T\n  }\n\n  if (isPlainObject(obj)) {\n    return traverse(obj).map(function (value) {\n      if (this.circular) {\n        this.remove()\n      } else if (isString(value)) {\n        this.update(replace(value, context))\n      }\n    })\n  }\n\n  throw new Error('Invalid type')\n}\n","import replacePlaceholders from './replacePlaceholders';\nexport default replacePlaceholders;\n"],"names":[],"version":3,"file":"types.d.ts.map"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@truto/replace-placeholders",
+  "version": "1.0.0",
+  "description": "Efficiently replace placeholders in strings, arrays, and objects using data from specified paths. Powered by 'wild-wild-path' and 'lodash' for robust functionality.",
+  "repository": "https://github.com/trutohq/replace-placeholders.git",
+  "dependencies": {
+    "wild-wild-path": "4.0.0",
+    "lodash-es": "4.17.21",
+    "traverse": "0.6.7"
+  },
+  "source": "index.ts",
+  "main": "dist/main.cjs",
+  "module": "dist/module.js",
+  "types": "dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/main.cjs",
+      "import": "./dist/module.js"
+    }
+  },
+  "targets": {
+    "main": {
+      "isLibrary": true
+    },
+    "module": {
+      "isLibrary": true
+    }
+  },
+  "type": "module",
+  "license": "MIT",
+  "volta": {
+    "node": "18.13.0",
+    "yarn": "1.22.19"
+  },
+  "devDependencies": {
+    "@parcel/packager-ts": "2.8.3",
+    "@parcel/transformer-typescript-types": "2.8.3",
+    "@types/lodash-es": "4.17.7",
+    "@types/traverse": "0.6.32",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "eslint": "8.29.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "parcel": "2.8.3",
+    "prettier": "2.8.4",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.5",
+    "vitest": "0.34.2"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "parcel watch",
+    "build": "rm -rf dist && parcel build",
+    "check": "tsc --noEmit",
+    "prepublishOnly": "yarn build",
+    "test": "vitest"
+  }
+}