@halleyassist/rule-templater 0.0.9 → 0.0.11

package/README.md

@@ -121,6 +121,8 @@ const prepared = parsed.prepare({
 - **round**: Round number to nearest integer
 - **floor**: Round number down
 - **ceil**: Round number up
+- **time_start**: Extract `from` from `time period` / `time period ago` and convert to `time value`
+- **time_end**: Extract `to` from `time period` / `time period ago` and convert to `time value`
 
 #### Filter Examples
 
@@ -137,6 +139,9 @@ const prepared = parsed.prepare({
 
 // Chaining filters
 '${text|trim|upper}' with text='  hello  ' → HELLO
+
+// Time period conversion
+'${window|time_start}' with window={from:'08:00',to:'12:00'} → 08:00
 ```
 
 ## API
@@ -222,13 +227,16 @@ Helper method to validate that an AST node matches the expected variable type.
 
 Access to the filter functions used by the template engine. Can be extended with custom filters.
 
+Custom filters receive a cloned `varData` object (`{ value, type }`) used for template rendering. They can mutate both fields without mutating the original input variables.
+
 **Example:**
 ```javascript
 const RuleTemplate = require('@halleyassist/rule-templater');
 
 // Add a custom filter
-RuleTemplate.TemplateFilters.reverse = (value) => {
-    return String(value).split('').reverse().join('');
+RuleTemplate.TemplateFilters.reverse = (varData) => {
+    varData.value = String(varData.value).split('').reverse().join('');
+    return varData;
 };
 
 // Use the custom filter

package/dist/rule-templater.browser.js

@@ -3663,6 +3663,7 @@ const VariableTypes = [
     'boolean',
     'object',
     'time period',
+    'time period ago',
     'time value',
     'string array',
     'number array',
@@ -3675,6 +3676,7 @@ const AllowedTypeMapping = {
     'number': ['number_atom', 'math_expr'],
     'boolean': ['boolean_atom', 'boolean_expr'],
     'time period': ['time_period_atom'],
+    'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
@@ -3697,7 +3699,8 @@ for(const rule of TemplateGrammar){
 // Add template_value as an alternative to value_atom so templates can be parsed
 const valueAtomIdx = extendedGrammar.findIndex(r => r.name === 'value_atom');
 if (valueAtomIdx !== -1) {
-    extendedGrammar[valueAtomIdx].bnf.push(['template_value']);
+    extendedGrammar[valueAtomIdx] = Object.assign({}, extendedGrammar[valueAtomIdx]);
+    extendedGrammar[valueAtomIdx].bnf = extendedGrammar[valueAtomIdx].bnf.concat([['template_value']]);
 }
 
 // Export the parser rules for potential external use
@@ -3984,12 +3987,12 @@ class RuleTemplate {
             throw new Error(`Variable '${varName}' not provided in variables object`);
         }
         
-        const varData = variables[varName];
+        let varData = variables[varName];
         if (typeof varData !== 'object' || !varData.hasOwnProperty('value')) {
             throw new Error(`Variable '${varName}' must be an object with 'value' property`);
         }
-        
-        let { value, type } = varData;
+
+        varData = Object.assign({}, varData);
         
         // Require type property for all variables
         if (!varData.hasOwnProperty('type')) {
@@ -3997,8 +4000,8 @@ class RuleTemplate {
         }
         
         // Validate type
-        if (!VariableTypes.includes(type)) {
-            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        if (!VariableTypes.includes(varData.type)) {
+            throw new Error(`Invalid variable type '${varData.type}' for variable '${varName}'`);
         }
         
         // Apply filters if present
@@ -4007,27 +4010,42 @@ class RuleTemplate {
                 if (!TemplateFilters[filterName]) {
                     throw new Error(`Unknown filter '${filterName}'`);
                 }
-                value = TemplateFilters[filterName](value);
+               
+                TemplateFilters[filterName](varData);
             }
-            // After applying filters, the result is already a string representation
-            return String(value);
         }
-        
-        // Convert value to string representation based on type
+
+        return this._serializeVarData(varData, varName);
+    }
+
+    _serializeVarData(varData, varName) {
+        const { value, type } = varData;
+
+        if (!VariableTypes.includes(type)) {
+            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        }
+
         if (type === 'string') {
-            // Escape backslashes first, then quotes in string values.
-            // Order is critical: escaping backslashes first prevents double-escaping.
-            // E.g., "test\" becomes "test\\" then "test\\\"" (correct)
-            // If reversed, "test\" would become "test\\"" then "test\\\\"" (incorrect)
             return `"${String(value).replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
-        } else if (type === 'number') {
+        }
+
+        if (type === 'number') {
             return String(value);
-        } else if (type === 'boolean') {
+        }
+
+        if (type === 'boolean') {
             return value ? 'true' : 'false';
-        } else {
-            // Default behavior - just insert the value as-is
-            return String(value);
         }
+
+        if (type === 'time period' || type === 'time period ago') {
+            let ret = `${value.from} TO ${value.to}`;
+            if(value.ago) {
+                ret += ` AGO ${value.ago[0]} ${value.ago[1]}`;
+            }
+            return ret;
+        }
+
+        return String(value);
     }
 
     /**
@@ -4062,59 +4080,153 @@ They are applied in the template syntax as ${variable|filter} or ${variable|filt
 */
 const TemplateFilters = {
     // Convert value to JSON string representation
-    string: value => JSON.stringify(String(value)),
-    
+    string: varData => {
+        varData.value = String(varData.value);
+        varData.type = 'string';
+
+    },
+
     // Convert to uppercase
-    upper: value => String(value).toUpperCase(),
-    
+    upper: varData => {
+        varData.value = String(varData.value).toUpperCase();
+        varData.type = 'string';
+
+    },
+
     // Convert to lowercase
-    lower: value => String(value).toLowerCase(),
-    
+    lower: varData => {
+        varData.value = String(varData.value).toLowerCase();
+        varData.type = 'string';
+
+    },
+
     // Capitalize first letter
-    capitalize: value => {
-        const str = String(value);
-        return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+    capitalize: varData => {
+        const str = String(varData.value);
+        varData.value = str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+        varData.type = 'string';
+
     },
-    
+
     // Convert to title case
-    title: value => {
-        return String(value).split(' ')
+    title: varData => {
+        varData.value = String(varData.value).split(' ')
             .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
             .join(' ');
+        varData.type = 'string';
+
     },
-    
+
     // Trim whitespace
-    trim: value => String(value).trim(),
-    
+    trim: varData => {
+        varData.value = String(varData.value).trim();
+        varData.type = 'string';
+
+    },
+
     // Convert to number
-    number: value => Number(value),
-    
+    number: varData => {
+        varData.value = Number(varData.value);
+        varData.type = 'number';
+
+    },
+
     // Convert to boolean
-    boolean: value => {
-        if (typeof value === 'boolean') return value;
+    boolean: varData => {
+        const value = varData.value;
+        if (typeof value === 'boolean') {
+            varData.type = 'boolean';
+
+        }
+
         if (typeof value === 'string') {
             const lower = value.toLowerCase();
-            if (lower === 'true' || lower === '1' || lower === 'yes') return true;
-            if (lower === 'false' || lower === '0' || lower === 'no') return false;
+            if (lower === 'true' || lower === '1' || lower === 'yes') {
+                varData.value = true;
+                varData.type = 'boolean';
+
+            }
+            if (lower === 'false' || lower === '0' || lower === 'no') {
+                varData.value = false;
+                varData.type = 'boolean';
+
+            }
         }
-        return Boolean(value);
+
+        varData.value = Boolean(value);
+        varData.type = 'boolean';
+
     },
-    
+
     // Convert to absolute value (for numbers)
-    abs: value => Math.abs(Number(value)),
-    
+    abs: varData => {
+        varData.value = Math.abs(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Round number
-    round: value => Math.round(Number(value)),
-    
+    round: varData => {
+        varData.value = Math.round(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Floor number
-    floor: value => Math.floor(Number(value)),
-    
+    floor: varData => {
+        varData.value = Math.floor(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Ceil number
-    ceil: value => Math.ceil(Number(value)),
-    
+    ceil: varData => {
+        varData.value = Math.ceil(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Default value if empty/null/undefined
-    default: (value, defaultValue = '') => {
-        return (value === null || value === undefined || value === '') ? defaultValue : value;
+    default: (varData, defaultValue = '') => {
+        varData.value = (varData.value === null || varData.value === undefined || varData.value === '') ? defaultValue : varData.value;
+        if (typeof varData.value === 'string') {
+            varData.type = 'string';
+        } else if (typeof varData.value === 'number') {
+            varData.type = 'number';
+        } else if (typeof varData.value === 'boolean') {
+            varData.type = 'boolean';
+        }
+
+    },
+
+    // Extract start time from time period/time period ago as time value
+    time_start: varData => {
+        if (varData.type === 'time period' || varData.type === 'time period ago') {
+            if (!varData.value || typeof varData.value !== 'object' || !Object.prototype.hasOwnProperty.call(varData.value, 'from')) {
+                throw new Error('time_start filter requires value.from for time period types');
+            }
+
+            varData.value = varData.value.from;
+            varData.type = 'time value';
+            return;
+        }
+
+        throw new Error('time_start filter requires variable type to be \"time period\" or \"time period ago\"');
+    },
+
+    // Extract end time from time period/time period ago as time value
+    time_end: varData => {
+        if (varData.type === 'time period' || varData.type === 'time period ago') {
+            if (!varData.value || typeof varData.value !== 'object' || !Object.prototype.hasOwnProperty.call(varData.value, 'to')) {
+                throw new Error('time_end filter requires value.from for time period types');
+            }
+
+            varData.value = varData.value.to;
+            varData.type = 'time value';
+            return;
+        }
+
+        throw new Error('time_end filter requires variable type to be \"time period\" or \"time period ago\"');
     }
 }
 

package/index.d.ts

@@ -30,7 +30,7 @@ export interface ASTNode {
     [key: string]: any;
 }
 
-export type FilterFunction = (value: any) => any;
+export type FilterFunction = (varData: VariableValue, ...args: any[]) => VariableValue | any;
 
 export interface TemplateFiltersType {
     string: FilterFunction;
@@ -46,6 +46,7 @@ export interface TemplateFiltersType {
     floor: FilterFunction;
     ceil: FilterFunction;
     default: FilterFunction;
+    time_start: FilterFunction;
     [key: string]: FilterFunction;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halleyassist/rule-templater",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "The grammar for HalleyAssist rules",
   "main": "src/RuleTemplater.production.js",
   "browser": "./dist/rule-templater.browser.js",

package/src/RuleTemplater.js

@@ -13,6 +13,7 @@ const VariableTypes = [
     'boolean',
     'object',
     'time period',
+    'time period ago',
     'time value',
     'string array',
     'number array',
@@ -25,6 +26,7 @@ const AllowedTypeMapping = {
     'number': ['number_atom', 'math_expr'],
     'boolean': ['boolean_atom', 'boolean_expr'],
     'time period': ['time_period_atom'],
+    'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
@@ -47,7 +49,8 @@ for(const rule of TemplateGrammar){
 // Add template_value as an alternative to value_atom so templates can be parsed
 const valueAtomIdx = extendedGrammar.findIndex(r => r.name === 'value_atom');
 if (valueAtomIdx !== -1) {
-    extendedGrammar[valueAtomIdx].bnf.push(['template_value']);
+    extendedGrammar[valueAtomIdx] = Object.assign({}, extendedGrammar[valueAtomIdx]);
+    extendedGrammar[valueAtomIdx].bnf = extendedGrammar[valueAtomIdx].bnf.concat([['template_value']]);
 }
 
 // Export the parser rules for potential external use
@@ -334,12 +337,12 @@ class RuleTemplate {
             throw new Error(`Variable '${varName}' not provided in variables object`);
         }
         
-        const varData = variables[varName];
+        let varData = variables[varName];
         if (typeof varData !== 'object' || !varData.hasOwnProperty('value')) {
             throw new Error(`Variable '${varName}' must be an object with 'value' property`);
         }
-        
-        let { value, type } = varData;
+
+        varData = Object.assign({}, varData);
         
         // Require type property for all variables
         if (!varData.hasOwnProperty('type')) {
@@ -347,8 +350,8 @@ class RuleTemplate {
         }
         
         // Validate type
-        if (!VariableTypes.includes(type)) {
-            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        if (!VariableTypes.includes(varData.type)) {
+            throw new Error(`Invalid variable type '${varData.type}' for variable '${varName}'`);
         }
         
         // Apply filters if present
@@ -357,27 +360,42 @@ class RuleTemplate {
                 if (!TemplateFilters[filterName]) {
                     throw new Error(`Unknown filter '${filterName}'`);
                 }
-                value = TemplateFilters[filterName](value);
+               
+                TemplateFilters[filterName](varData);
             }
-            // After applying filters, the result is already a string representation
-            return String(value);
         }
-        
-        // Convert value to string representation based on type
+
+        return this._serializeVarData(varData, varName);
+    }
+
+    _serializeVarData(varData, varName) {
+        const { value, type } = varData;
+
+        if (!VariableTypes.includes(type)) {
+            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        }
+
         if (type === 'string') {
-            // Escape backslashes first, then quotes in string values.
-            // Order is critical: escaping backslashes first prevents double-escaping.
-            // E.g., "test\" becomes "test\\" then "test\\\"" (correct)
-            // If reversed, "test\" would become "test\\"" then "test\\\\"" (incorrect)
             return `"${String(value).replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
-        } else if (type === 'number') {
+        }
+
+        if (type === 'number') {
             return String(value);
-        } else if (type === 'boolean') {
+        }
+
+        if (type === 'boolean') {
             return value ? 'true' : 'false';
-        } else {
-            // Default behavior - just insert the value as-is
-            return String(value);
         }
+
+        if (type === 'time period' || type === 'time period ago') {
+            let ret = `${value.from} TO ${value.to}`;
+            if(value.ago) {
+                ret += ` AGO ${value.ago[0]} ${value.ago[1]}`;
+            }
+            return ret;
+        }
+
+        return String(value);
     }
 
     /**

package/src/RuleTemplater.production.js

@@ -13,6 +13,7 @@ const VariableTypes = [
     'boolean',
     'object',
     'time period',
+    'time period ago',
     'time value',
     'string array',
     'number array',
@@ -25,6 +26,7 @@ const AllowedTypeMapping = {
     'number': ['number_atom', 'math_expr'],
     'boolean': ['boolean_atom', 'boolean_expr'],
     'time period': ['time_period_atom'],
+    'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
@@ -47,7 +49,8 @@ for(const rule of TemplateGrammar){
 // Add template_value as an alternative to value_atom so templates can be parsed
 const valueAtomIdx = extendedGrammar.findIndex(r => r.name === 'value_atom');
 if (valueAtomIdx !== -1) {
-    extendedGrammar[valueAtomIdx].bnf.push(['template_value']);
+    extendedGrammar[valueAtomIdx] = Object.assign({}, extendedGrammar[valueAtomIdx]);
+    extendedGrammar[valueAtomIdx].bnf = extendedGrammar[valueAtomIdx].bnf.concat([['template_value']]);
 }
 
 // Export the parser rules for potential external use
@@ -334,12 +337,12 @@ class RuleTemplate {
             throw new Error(`Variable '${varName}' not provided in variables object`);
         }
         
-        const varData = variables[varName];
+        let varData = variables[varName];
         if (typeof varData !== 'object' || !varData.hasOwnProperty('value')) {
             throw new Error(`Variable '${varName}' must be an object with 'value' property`);
         }
-        
-        let { value, type } = varData;
+
+        varData = Object.assign({}, varData);
         
         // Require type property for all variables
         if (!varData.hasOwnProperty('type')) {
@@ -347,8 +350,8 @@ class RuleTemplate {
         }
         
         // Validate type
-        if (!VariableTypes.includes(type)) {
-            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        if (!VariableTypes.includes(varData.type)) {
+            throw new Error(`Invalid variable type '${varData.type}' for variable '${varName}'`);
         }
         
         // Apply filters if present
@@ -357,27 +360,42 @@ class RuleTemplate {
                 if (!TemplateFilters[filterName]) {
                     throw new Error(`Unknown filter '${filterName}'`);
                 }
-                value = TemplateFilters[filterName](value);
+               
+                TemplateFilters[filterName](varData);
             }
-            // After applying filters, the result is already a string representation
-            return String(value);
         }
-        
-        // Convert value to string representation based on type
+
+        return this._serializeVarData(varData, varName);
+    }
+
+    _serializeVarData(varData, varName) {
+        const { value, type } = varData;
+
+        if (!VariableTypes.includes(type)) {
+            throw new Error(`Invalid variable type '${type}' for variable '${varName}'`);
+        }
+
         if (type === 'string') {
-            // Escape backslashes first, then quotes in string values.
-            // Order is critical: escaping backslashes first prevents double-escaping.
-            // E.g., "test\" becomes "test\\" then "test\\\"" (correct)
-            // If reversed, "test\" would become "test\\"" then "test\\\\"" (incorrect)
             return `"${String(value).replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
-        } else if (type === 'number') {
+        }
+
+        if (type === 'number') {
             return String(value);
-        } else if (type === 'boolean') {
+        }
+
+        if (type === 'boolean') {
             return value ? 'true' : 'false';
-        } else {
-            // Default behavior - just insert the value as-is
-            return String(value);
         }
+
+        if (type === 'time period' || type === 'time period ago') {
+            let ret = `${value.from} TO ${value.to}`;
+            if(value.ago) {
+                ret += ` AGO ${value.ago[0]} ${value.ago[1]}`;
+            }
+            return ret;
+        }
+
+        return String(value);
     }
 
     /**

package/src/TemplateFilters.js

@@ -4,59 +4,153 @@ They are applied in the template syntax as ${variable|filter} or ${variable|filt
 */
 const TemplateFilters = {
     // Convert value to JSON string representation
-    string: value => JSON.stringify(String(value)),
-    
+    string: varData => {
+        varData.value = String(varData.value);
+        varData.type = 'string';
+
+    },
+
     // Convert to uppercase
-    upper: value => String(value).toUpperCase(),
-    
+    upper: varData => {
+        varData.value = String(varData.value).toUpperCase();
+        varData.type = 'string';
+
+    },
+
     // Convert to lowercase
-    lower: value => String(value).toLowerCase(),
-    
+    lower: varData => {
+        varData.value = String(varData.value).toLowerCase();
+        varData.type = 'string';
+
+    },
+
     // Capitalize first letter
-    capitalize: value => {
-        const str = String(value);
-        return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+    capitalize: varData => {
+        const str = String(varData.value);
+        varData.value = str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+        varData.type = 'string';
+
     },
-    
+
     // Convert to title case
-    title: value => {
-        return String(value).split(' ')
+    title: varData => {
+        varData.value = String(varData.value).split(' ')
             .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
             .join(' ');
+        varData.type = 'string';
+
     },
-    
+
     // Trim whitespace
-    trim: value => String(value).trim(),
-    
+    trim: varData => {
+        varData.value = String(varData.value).trim();
+        varData.type = 'string';
+
+    },
+
     // Convert to number
-    number: value => Number(value),
-    
+    number: varData => {
+        varData.value = Number(varData.value);
+        varData.type = 'number';
+
+    },
+
     // Convert to boolean
-    boolean: value => {
-        if (typeof value === 'boolean') return value;
+    boolean: varData => {
+        const value = varData.value;
+        if (typeof value === 'boolean') {
+            varData.type = 'boolean';
+
+        }
+
         if (typeof value === 'string') {
             const lower = value.toLowerCase();
-            if (lower === 'true' || lower === '1' || lower === 'yes') return true;
-            if (lower === 'false' || lower === '0' || lower === 'no') return false;
+            if (lower === 'true' || lower === '1' || lower === 'yes') {
+                varData.value = true;
+                varData.type = 'boolean';
+
+            }
+            if (lower === 'false' || lower === '0' || lower === 'no') {
+                varData.value = false;
+                varData.type = 'boolean';
+
+            }
         }
-        return Boolean(value);
+
+        varData.value = Boolean(value);
+        varData.type = 'boolean';
+
     },
-    
+
     // Convert to absolute value (for numbers)
-    abs: value => Math.abs(Number(value)),
-    
+    abs: varData => {
+        varData.value = Math.abs(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Round number
-    round: value => Math.round(Number(value)),
-    
+    round: varData => {
+        varData.value = Math.round(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Floor number
-    floor: value => Math.floor(Number(value)),
-    
+    floor: varData => {
+        varData.value = Math.floor(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Ceil number
-    ceil: value => Math.ceil(Number(value)),
-    
+    ceil: varData => {
+        varData.value = Math.ceil(Number(varData.value));
+        varData.type = 'number';
+
+    },
+
     // Default value if empty/null/undefined
-    default: (value, defaultValue = '') => {
-        return (value === null || value === undefined || value === '') ? defaultValue : value;
+    default: (varData, defaultValue = '') => {
+        varData.value = (varData.value === null || varData.value === undefined || varData.value === '') ? defaultValue : varData.value;
+        if (typeof varData.value === 'string') {
+            varData.type = 'string';
+        } else if (typeof varData.value === 'number') {
+            varData.type = 'number';
+        } else if (typeof varData.value === 'boolean') {
+            varData.type = 'boolean';
+        }
+
+    },
+
+    // Extract start time from time period/time period ago as time value
+    time_start: varData => {
+        if (varData.type === 'time period' || varData.type === 'time period ago') {
+            if (!varData.value || typeof varData.value !== 'object' || !Object.prototype.hasOwnProperty.call(varData.value, 'from')) {
+                throw new Error('time_start filter requires value.from for time period types');
+            }
+
+            varData.value = varData.value.from;
+            varData.type = 'time value';
+            return;
+        }
+
+        throw new Error('time_start filter requires variable type to be \"time period\" or \"time period ago\"');
+    },
+
+    // Extract end time from time period/time period ago as time value
+    time_end: varData => {
+        if (varData.type === 'time period' || varData.type === 'time period ago') {
+            if (!varData.value || typeof varData.value !== 'object' || !Object.prototype.hasOwnProperty.call(varData.value, 'to')) {
+                throw new Error('time_end filter requires value.from for time period types');
+            }
+
+            varData.value = varData.value.to;
+            varData.type = 'time value';
+            return;
+        }
+
+        throw new Error('time_end filter requires variable type to be \"time period\" or \"time period ago\"');
     }
 }