@jarenjs/core 0.67.0 → 0.72.0

package/README.md

@@ -179,6 +179,7 @@ The kernel is measured against one-pass loops written for one question and again
 import { compileMessageTemplate, compileMessageCatalog } from '@jarenjs/core/message';
 
 const t = compileMessageTemplate('must be {comparison} {limit}');
+// t.parameters is the frozen unique list ['comparison', 'limit'] from this parser.
 t({ comparison: '>=', limit: 18 });   // 'must be >= 18'
 ```
 

package/dist/types/message.d.ts

@@ -38,9 +38,11 @@ export declare function formatMessageValue(value: unknown): string;
  * instead of rendering as `undefined`); `{{` escapes a literal `{`.
  *
  * @param {string} template - The template text
- * @returns {(params: object, error?: object) => string} The compiled render closure
+ * @returns {((params: object, error?: object) => string) & { readonly parameters: readonly string[] }} The compiled render closure and its unique placeholder names
  */
-export declare function compileMessageTemplate(template: string): (params: object, error?: object) => string;
+export declare function compileMessageTemplate(template: string): ((params: object, error?: object) => string) & {
+    readonly parameters: readonly string[];
+};
 /**
  * Compile a catalog-like object into a functions-only frozen catalog.
  * Entries may be render closures (kept as-is) or template strings

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jarenjs/core",
   "private": false,
-  "version": "0.67.0",
+  "version": "0.72.0",
   "type": "module",
   "main": "./src/index.js",
   "types": "./dist/types/index.d.ts",

package/src/message.js

@@ -1,4 +1,5 @@
 //@ts-check
+import { setObjectMember } from './object.js';
 
 /**
  * Human-message templating: the shared half of every message catalog in
@@ -49,7 +50,7 @@ export function formatMessageValue(value) {
  * instead of rendering as `undefined`); `{{` escapes a literal `{`.
  *
  * @param {string} template - The template text
- * @returns {(params: object, error?: object) => string} The compiled render closure
+ * @returns {((params: object, error?: object) => string) & { readonly parameters: readonly string[] }} The compiled render closure and its unique placeholder names
  */
 export function compileMessageTemplate(template) {
   /** @type {string[]} literal parts between placeholders */
@@ -79,22 +80,24 @@ export function compileMessageTemplate(template) {
   }
   parts.push(literal);
 
-  if (names.length === 0) {
-    const text = parts[0];
-    return function renderLiteralTemplate() { return text; };
-  }
-
-  return function renderMessageTemplate(params) {
-    let out = parts[0];
-    for (let i = 0; i < names.length; ++i) {
-      const name = names[i];
-      out += (params != null && name in params)
-        ? formatTemplateParam(params[name])
-        : `{${name}}`;
-      out += parts[i + 1];
-    }
-    return out;
-  };
+  const render = names.length === 0
+    ? function renderLiteralTemplate() { return parts[0]; }
+    : function renderMessageTemplate(params) {
+      let out = parts[0];
+      for (let i = 0; i < names.length; ++i) {
+        const name = names[i];
+        out += (params != null && name in params)
+          ? formatTemplateParam(params[name])
+          : `{${name}}`;
+        out += parts[i + 1];
+      }
+      return out;
+    };
+  // Metadata comes from the parser that renders the message; consumers must
+  // never parse placeholders with a second, subtly different grammar.
+  return Object.defineProperty(render, 'parameters', {
+    value: Object.freeze([...new Set(names)]), enumerable: true,
+  });
 }
 
 /**
@@ -111,9 +114,9 @@ export function compileMessageCatalog(catalogLike) {
   const keys = Object.keys(catalogLike);
   for (let i = 0; i < keys.length; ++i) {
     const entry = catalogLike[keys[i]];
-    compiled[keys[i]] = typeof entry === 'function'
+    setObjectMember(compiled, keys[i], typeof entry === 'function'
       ? entry
-      : compileMessageTemplate(String(entry));
+      : compileMessageTemplate(String(entry)));
   }
   return Object.freeze(compiled);
 }