paraphrase 3.1.1 → 3.1.3

package/{types/index.d.ts → index.d.ts}

@@ -34,11 +34,12 @@ interface Phraser {
  *
  * phraser('Hello, ${name}', {name: 'Martin'})
  */
-export declare function paraphrase(...args: (RegExp | RegExp[] | IParaphraseOptions)[]): Phraser;
-export declare const dollar: Phraser;
-export declare const double: Phraser;
-export declare const single: Phraser;
-export declare const percent: Phraser;
-export declare const hash: Phraser;
-export declare const loose: Phraser;
-export {};
+declare function paraphrase(...args: (RegExp | RegExp[] | IParaphraseOptions)[]): Phraser;
+declare const dollar: Phraser;
+declare const double: Phraser;
+declare const single: Phraser;
+declare const percent: Phraser;
+declare const hash: Phraser;
+declare const loose: Phraser;
+
+export { dollar, double, hash, loose, paraphrase, percent, single };

package/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -17,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   dollar: () => dollar,
   double: () => double,
   hash: () => hash,
@@ -27,7 +28,7 @@ __export(src_exports, {
   percent: () => percent,
   single: () => single
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/notate/index.ts
 function notate(source, string = "") {
@@ -46,28 +47,11 @@ function notate(source, string = "") {
 var isObject = (obj) => `${obj}` === "[object Object]";
 
 // src/flavours/index.ts
-var flavours = {
-  /**
-   * Template: 'Hello, ${name}'
-   */
-  dollar: /\${([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, {{name}}'
-   */
-  double: /{{([^{}]*)}}/gm,
-  /**
-   * Template: 'Hello, {name}'
-   */
-  single: /{([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, #{name}'
-   */
-  hash: /#{([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, %{name}'
-   */
-  percent: /%{([^{}]*)}/gm
-};
+var dollarPattern = /\${([^{}]*)}/gm;
+var doublePattern = /{{([^{}]*)}}/gm;
+var singlePattern = /{([^{}]*)}/gm;
+var hashPattern = /#{([^{}]*)}/gm;
+var percentPattern = /%{([^{}]*)}/gm;
 
 // src/index.ts
 var VALID_RESULT_TYPES = Object.seal([
@@ -91,9 +75,7 @@ function paraphrase(...args) {
         `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`
       );
     }
-    if (!data) {
-      return string;
-    }
+    if (!data) return string;
     if (VALID_RESULT_TYPES.includes(typeof data)) {
       data = [data, ...replacements];
     }
@@ -112,17 +94,17 @@ function paraphrase(...args) {
   });
   return phraser;
 }
-var dollar = paraphrase(flavours.dollar);
-var double = paraphrase(flavours.double);
-var single = paraphrase(flavours.single);
-var percent = paraphrase(flavours.percent);
-var hash = paraphrase(flavours.hash);
+var dollar = paraphrase(dollarPattern);
+var double = paraphrase(doublePattern);
+var single = paraphrase(singlePattern);
+var percent = paraphrase(percentPattern);
+var hash = paraphrase(hashPattern);
 var loose = paraphrase(
-  flavours.dollar,
-  flavours.double,
-  flavours.percent,
-  flavours.hash,
-  flavours.single
+  dollarPattern,
+  doublePattern,
+  percentPattern,
+  hashPattern,
+  singlePattern
 );
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -134,4 +116,4 @@ var loose = paraphrase(
   percent,
   single
 });
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -1,7 +1 @@
-{
-  "version": 3,
-  "sources": ["src/index.ts", "src/notate/index.ts", "src/isObject/index.ts", "src/flavours/index.ts"],
-  "sourcesContent": ["import { notate } from \"./notate/index\";\nimport { isObject } from \"./isObject/index\";\nimport { flavours } from \"./flavours/index\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * Data to use for interpolation, preferrably an object, but an array will work too, and a primitive values will be treated as an array of \"...rest\" arguments\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`\n      );\n    }\n\n    if (!data) {\n      return string;\n    }\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : data[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n        ? \"\"\n        : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(flavours.dollar);\nexport const double = paraphrase(flavours.double);\nexport const single = paraphrase(flavours.single);\nexport const percent = paraphrase(flavours.percent);\nexport const hash = paraphrase(flavours.hash);\nexport const loose = paraphrase(\n  flavours.dollar,\n  flavours.double,\n  flavours.percent,\n  flavours.hash,\n  flavours.single\n);\n", "/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source\n    );\n}\n", "/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n", "export const flavours: Record<string, RegExp> = {\n  /**\n   * Template: 'Hello, ${name}'\n   */\n  dollar: /\\${([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, {{name}}'\n   */\n  double: /{{([^{}]*)}}/gm,\n  /**\n   * Template: 'Hello, {name}'\n   */\n  single: /{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, #{name}'\n   */\n  hash: /#{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, %{name}'\n   */\n  percent: /%{([^{}]*)}/gm,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,WAAW;AAAA,IAC3E;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,UAAU;;;ACLrD,IAAM,WAAmC;AAAA;AAAA;AAAA;AAAA,EAI9C,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,MAAM;AAAA;AAAA;AAAA;AAAA,EAIN,SAAS;AACX;;;AHdA,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,WAAW;AAAA,MAC/E;AAAA,IACF;AAEA,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAEA,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IAC1B,KAAK,OAAO,KAAK,CAAC;AAEtB,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACR,KACA;AAAA,IACN;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,UAAU,WAAW,SAAS,OAAO;AAC3C,IAAM,OAAO,WAAW,SAAS,IAAI;AACrC,IAAM,QAAQ;AAAA,EACnB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AACX;",
-  "names": ["string"]
-}
+{"version":3,"sources":["src/index.ts","src/notate/index.ts","src/isObject/index.ts","src/flavours/index.ts"],"sourcesContent":["import { notate } from \"./notate/index.ts\";\nimport { isObject } from \"./isObject/index.ts\";\nimport {\n  dollarPattern,\n  doublePattern,\n  percentPattern,\n  hashPattern,\n  singlePattern,\n} from \"./flavours/index.ts\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * Data to use for interpolation, preferrably an object, but an array will work too, and a primitive values will be treated as an array of \"...rest\" arguments\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`,\n      );\n    }\n\n    if (!data) return string;\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : (data as Record<string, any>)[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n          ? \"\"\n          : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string,\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(dollarPattern);\nexport const double = paraphrase(doublePattern);\nexport const single = paraphrase(singlePattern);\nexport const percent = paraphrase(percentPattern);\nexport const hash = paraphrase(hashPattern);\nexport const loose = paraphrase(\n  dollarPattern,\n  doublePattern,\n  percentPattern,\n  hashPattern,\n  singlePattern,\n);\n","/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`,\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source,\n    );\n}\n","/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n","/**\n * Template: 'Hello, ${name}'\n */\nexport const dollarPattern = /\\${([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, {{name}}'\n */\nexport const doublePattern = /{{([^{}]*)}}/gm;\n\n/**\n * Template: 'Hello, {name}'\n */\nexport const singlePattern = /{([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, #{name}'\n */\nexport const hashPattern = /#{([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, %{name}'\n */\nexport const percentPattern = /%{([^{}]*)}/gm;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,MAAM,KAAK,MAAM;AAAA,IACjF;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,GAAG,OAAO;;;ACFrD,IAAM,gBAAgB;AAKtB,IAAM,gBAAgB;AAKtB,IAAM,gBAAgB;AAKtB,IAAM,cAAc;AAKpB,IAAM,iBAAiB;;;AHV9B,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,MAAM,KAAK,MAAM;AAAA,MACrF;AAAA,IACF;AAEA,QAAI,CAAC,KAAM,QAAO;AAElB,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IACzB,KAA6B,OAAO,KAAK,CAAC;AAE/C,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACN,KACA;AAAA,IACR;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,UAAU,WAAW,cAAc;AACzC,IAAM,OAAO,WAAW,WAAW;AACnC,IAAM,QAAQ;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":["string"]}

package/index.mjs

@@ -15,28 +15,11 @@ function notate(source, string = "") {
 var isObject = (obj) => `${obj}` === "[object Object]";
 
 // src/flavours/index.ts
-var flavours = {
-  /**
-   * Template: 'Hello, ${name}'
-   */
-  dollar: /\${([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, {{name}}'
-   */
-  double: /{{([^{}]*)}}/gm,
-  /**
-   * Template: 'Hello, {name}'
-   */
-  single: /{([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, #{name}'
-   */
-  hash: /#{([^{}]*)}/gm,
-  /**
-   * Template: 'Hello, %{name}'
-   */
-  percent: /%{([^{}]*)}/gm
-};
+var dollarPattern = /\${([^{}]*)}/gm;
+var doublePattern = /{{([^{}]*)}}/gm;
+var singlePattern = /{([^{}]*)}/gm;
+var hashPattern = /#{([^{}]*)}/gm;
+var percentPattern = /%{([^{}]*)}/gm;
 
 // src/index.ts
 var VALID_RESULT_TYPES = Object.seal([
@@ -60,9 +43,7 @@ function paraphrase(...args) {
         `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`
       );
     }
-    if (!data) {
-      return string;
-    }
+    if (!data) return string;
     if (VALID_RESULT_TYPES.includes(typeof data)) {
       data = [data, ...replacements];
     }
@@ -81,17 +62,17 @@ function paraphrase(...args) {
   });
   return phraser;
 }
-var dollar = paraphrase(flavours.dollar);
-var double = paraphrase(flavours.double);
-var single = paraphrase(flavours.single);
-var percent = paraphrase(flavours.percent);
-var hash = paraphrase(flavours.hash);
+var dollar = paraphrase(dollarPattern);
+var double = paraphrase(doublePattern);
+var single = paraphrase(singlePattern);
+var percent = paraphrase(percentPattern);
+var hash = paraphrase(hashPattern);
 var loose = paraphrase(
-  flavours.dollar,
-  flavours.double,
-  flavours.percent,
-  flavours.hash,
-  flavours.single
+  dollarPattern,
+  doublePattern,
+  percentPattern,
+  hashPattern,
+  singlePattern
 );
 export {
   dollar,
@@ -102,4 +83,4 @@ export {
   percent,
   single
 };
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -1,7 +1 @@
-{
-  "version": 3,
-  "sources": ["src/notate/index.ts", "src/isObject/index.ts", "src/flavours/index.ts", "src/index.ts"],
-  "sourcesContent": ["/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source\n    );\n}\n", "/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n", "export const flavours: Record<string, RegExp> = {\n  /**\n   * Template: 'Hello, ${name}'\n   */\n  dollar: /\\${([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, {{name}}'\n   */\n  double: /{{([^{}]*)}}/gm,\n  /**\n   * Template: 'Hello, {name}'\n   */\n  single: /{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, #{name}'\n   */\n  hash: /#{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, %{name}'\n   */\n  percent: /%{([^{}]*)}/gm,\n};\n", "import { notate } from \"./notate/index\";\nimport { isObject } from \"./isObject/index\";\nimport { flavours } from \"./flavours/index\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * Data to use for interpolation, preferrably an object, but an array will work too, and a primitive values will be treated as an array of \"...rest\" arguments\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`\n      );\n    }\n\n    if (!data) {\n      return string;\n    }\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : data[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n        ? \"\"\n        : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(flavours.dollar);\nexport const double = paraphrase(flavours.double);\nexport const single = paraphrase(flavours.single);\nexport const percent = paraphrase(flavours.percent);\nexport const hash = paraphrase(flavours.hash);\nexport const loose = paraphrase(\n  flavours.dollar,\n  flavours.double,\n  flavours.percent,\n  flavours.hash,\n  flavours.single\n);\n"],
-  "mappings": ";AAsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,WAAW;AAAA,IAC3E;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,UAAU;;;ACLrD,IAAM,WAAmC;AAAA;AAAA;AAAA;AAAA,EAI9C,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,MAAM;AAAA;AAAA;AAAA;AAAA,EAIN,SAAS;AACX;;;ACdA,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,WAAW;AAAA,MAC/E;AAAA,IACF;AAEA,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAEA,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IAC1B,KAAK,OAAO,KAAK,CAAC;AAEtB,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACR,KACA;AAAA,IACN;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,UAAU,WAAW,SAAS,OAAO;AAC3C,IAAM,OAAO,WAAW,SAAS,IAAI;AACrC,IAAM,QAAQ;AAAA,EACnB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AACX;",
-  "names": ["string"]
-}
+{"version":3,"sources":["src/notate/index.ts","src/isObject/index.ts","src/flavours/index.ts","src/index.ts"],"sourcesContent":["/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`,\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source,\n    );\n}\n","/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n","/**\n * Template: 'Hello, ${name}'\n */\nexport const dollarPattern = /\\${([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, {{name}}'\n */\nexport const doublePattern = /{{([^{}]*)}}/gm;\n\n/**\n * Template: 'Hello, {name}'\n */\nexport const singlePattern = /{([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, #{name}'\n */\nexport const hashPattern = /#{([^{}]*)}/gm;\n\n/**\n * Template: 'Hello, %{name}'\n */\nexport const percentPattern = /%{([^{}]*)}/gm;\n","import { notate } from \"./notate/index.ts\";\nimport { isObject } from \"./isObject/index.ts\";\nimport {\n  dollarPattern,\n  doublePattern,\n  percentPattern,\n  hashPattern,\n  singlePattern,\n} from \"./flavours/index.ts\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * Data to use for interpolation, preferrably an object, but an array will work too, and a primitive values will be treated as an array of \"...rest\" arguments\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`,\n      );\n    }\n\n    if (!data) return string;\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : (data as Record<string, any>)[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n          ? \"\"\n          : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string,\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(dollarPattern);\nexport const double = paraphrase(doublePattern);\nexport const single = paraphrase(singlePattern);\nexport const percent = paraphrase(percentPattern);\nexport const hash = paraphrase(hashPattern);\nexport const loose = paraphrase(\n  dollarPattern,\n  doublePattern,\n  percentPattern,\n  hashPattern,\n  singlePattern,\n);\n"],"mappings":";AAsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,MAAM,KAAK,MAAM;AAAA,IACjF;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,GAAG,OAAO;;;ACFrD,IAAM,gBAAgB;AAKtB,IAAM,gBAAgB;AAKtB,IAAM,gBAAgB;AAKtB,IAAM,cAAc;AAKpB,IAAM,iBAAiB;;;ACV9B,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,MAAM,KAAK,MAAM;AAAA,MACrF;AAAA,IACF;AAEA,QAAI,CAAC,KAAM,QAAO;AAElB,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IACzB,KAA6B,OAAO,KAAK,CAAC;AAE/C,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACN,KACA;AAAA,IACR;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,SAAS,WAAW,aAAa;AACvC,IAAM,UAAU,WAAW,cAAc;AACzC,IAAM,OAAO,WAAW,WAAW;AACnC,IAAM,QAAQ;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":["string"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paraphrase",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "🧩 Create flavoured string template interpolation",
   "keywords": [
     "string",
@@ -39,25 +39,24 @@
       "default": "./index.js"
     }
   },
-  "types": "./types/index.d.ts",
+  "types": "./index.d.ts",
   "files": [
     "index.js",
     "index.js.map",
     "index.mjs",
     "index.mjs.map",
-    "types/index.d.ts"
+    "index.d.ts"
   ],
   "scripts": {
-    "test": "jest",
+    "test": "node --test **/test.ts",
     "format": "prettier --write .",
-    "build": "./scripts/build.sh",
+    "build": "tsup src/index.ts --format cjs,esm --dts --out-dir . --sourcemap",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@types/jest": "^29.4.0",
-    "esbuild": "^0.17.4",
-    "jest": "^29.4.0",
-    "prettier": "^2.8.3",
-    "ts-jest": "^29.0.5"
+    "@types/node": "^25.0.10",
+    "prettier": "^3.0.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   }
 }