@halleyassist/rule-templater 0.0.17 → 0.0.19

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
+- **humanise_list**: Join array values into natural language, optionally with a custom joiner like `humanise_list("or")`
+- **humanise_time**: Convert seconds into a single human-readable unit like `1 hour`; optionally round down to a minimum unit such as `humanise_time("minute")` or `humanise_time("min")`
 - **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`
 
@@ -140,6 +142,14 @@ const prepared = parsed.prepare({
 // Chaining filters
 '${text|trim|upper}' with text='  hello  ' → HELLO
 
+// Humanise arrays
+'${names|humanise_list}' with names=['a','b','c'] → a, b and c
+'${names|humanise_list("or")}' with names=['a','b','c'] → a, b or c
+
+// Humanise time from seconds
+'${duration|humanise_time}' with duration=3600 → 1 hour
+'${duration|humanise_time("minute")}' with duration=71 → 1 minute
+
 // Time period conversion
 '${window|time_start}' with window={from:'08:00',to:'12:00'} → 08:00
 ```
@@ -232,7 +242,7 @@ This is useful for comparing against a hub's list of available functions to ensu
 
 ### `ruleTemplate.validate(variables)`
 
-Validates that all required variables are provided and have valid types.
+Validates that all required variables are provided, have valid types, and reference only known template filters.
 
 **Parameters:**
 - `variables` (object): Object mapping variable names to their values and types
@@ -243,6 +253,7 @@ Validates that all required variables are provided and have valid types.
 **Returns:** Object with:
 - `valid` (boolean): Whether validation passed
 - `errors` (array): Array of error messages (empty if valid)
+- `warnings` (array): Array of non-fatal warnings (empty if none)
 
 ### `ruleTemplate.prepare(variables)`
 
@@ -272,6 +283,10 @@ Extracts variables from a general string template.
 
 Prepares a general string template by replacing `${...}` placeholders with values and applying filters.
 
+### `generalTemplate.validate()`
+
+Validates the template itself and reports any unknown filters used in `${...}` chains.
+
 ### `RuleTemplate.validateVariableNode(astNode, variableType)` (Static)
 
 Helper method to validate that an AST node matches the expected variable type.