@00rez/form-runner 1.0.5 → 1.0.6

package/README.md

@@ -405,6 +405,73 @@ import { transformErrors } from '@00rez/form-runner';
 const errors = transformErrors(rawErrors, schema, uiSchema);
 ```
 
+### Interpolation Utilities
+
+The library provides utilities for dynamic text interpolation with support for multiple interpolation styles:
+
+#### interpolate
+
+The original interpolation function supporting `{{key}}` patterns for language dictionaries and `[[key]]` patterns for global data:
+
+```tsx
+import { interpolate } from '@00rez/form-runner';
+
+// Replace {{key}} with language data and [[key]] with global data
+const result = interpolate(
+  { label: 'Hello {{name}}', value: '[[globalVar]]' },
+  { name: 'John' },           // Language/data dictionary
+  { globalVar: 'Global!' }    // Global data (optional)
+);
+// Result: { label: 'Hello John', value: 'Global!' }
+```
+
+#### interpolateWithI18next
+
+A string-focused function with i18next-compatible format. Supports `{{variable}}` patterns with fallback to global data:
+
+```tsx
+import { interpolateWithI18next } from '@00rez/form-runner';
+
+const result = interpolateWithI18next(
+  'Hello {{name}}, you have {{count}} messages',
+  { name: 'John', count: 5 },
+  { count: 10 }  // Fallback global data (optional)
+);
+// Result: 'Hello John, you have 5 messages'
+```
+
+**Features:**
+- Supports nested object access with dot notation: `{{user.profile.name}}`
+- Returns numeric values as strings
+- Falls back to `globalData` if value not found in primary values
+- Returns unmatched patterns unchanged
+
+#### interpolateObjectWithI18next
+
+Recursively interpolates all strings in objects and arrays using i18next format:
+
+```tsx
+import { interpolateObjectWithI18next } from '@00rez/form-runner';
+
+const schema = {
+  title: 'Welcome {{userName}}',
+  properties: {
+    message: { type: 'string', title: 'Message: {{itemCount}} items' },
+  },
+};
+
+const result = interpolateObjectWithI18next(
+  schema,
+  { userName: 'Alice', itemCount: 42 }
+);
+// Result: { title: 'Welcome Alice', properties: { message: { ... title: 'Message: 42 items' } } }
+```
+
+**Use cases:**
+- Interpolating entire form schemas
+- Dynamic form configuration with i18next
+- Maintaining structure while replacing text values
+
 ## Custom Validation
 
 Use the validator's composition to add custom keywords:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@00rez/form-runner",
-    "version": "1.0.5",
+    "version": "1.0.6",
     "license": "MIT",
     "type": "module",
     "main": "./dist/index.umd.js",