@halleyassist/rule-templater 0.0.13 → 0.0.14

package/README.md

@@ -321,6 +321,75 @@ The following variable types are supported:
 - `boolean array`
 - `object array`
 
+### Time Type Formats
+
+The time-related variable types use the following structures when passed to `prepare()` or `validate()`:
+
+#### `time value`
+
+Use a time-of-day string such as `08:00`.
+
+```javascript
+{
+    value: '08:00',
+    type: 'time value'
+}
+```
+
+This is useful when a rule expects a single time value, for example:
+
+```javascript
+const prepared = parsed.prepare({
+    START_TIME: { value: '08:00', type: 'time value' }
+});
+```
+
+#### `time period`
+
+Use an object with `from` and `to` properties, both using the same time-of-day string format as `time value`.
+
+```javascript
+{
+    value: {
+        from: '08:00',
+        to: '12:00'
+    },
+    type: 'time period'
+}
+```
+
+When rendered into a rule template, this becomes:
+
+```text
+08:00 TO 12:00
+```
+
+#### `time period ago`
+
+Use the same structure as `time period`, plus an `ago` tuple containing:
+
+- the numeric offset
+- the rule time unit token, for example `HOURS`
+
+```javascript
+{
+    value: {
+        from: '08:00',
+        to: '12:00',
+        ago: [2, 'HOURS']
+    },
+    type: 'time period ago'
+}
+```
+
+When rendered into a rule template, this becomes:
+
+```text
+08:00 TO 12:00 AGO 2 HOURS
+```
+
+The `time_start` and `time_end` filters can extract `from` and `to` from either `time period` or `time period ago` and convert them to `time value`.
+
 ## License
 
 ISC

package/dist/rule-templater.browser.js

@@ -3665,6 +3665,7 @@ const VariableTypes = [
     'time period',
     'time period ago',
     'time value',
+    'number time',
     'string array',
     'number array',
     'boolean array',
@@ -3678,6 +3679,7 @@ const AllowedTypeMapping = {
     'time period': ['time_period_atom'],
     'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
+    'number time': ['number_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
     'boolean array': ['boolean_array'],
@@ -4129,7 +4131,9 @@ const TemplateFilters = {
     number: varData => {
         varData.value = Number(varData.value);
         varData.type = 'number';
-
+        if(isNaN(varData.value)){
+            throw new Error(`Value "${varData.value}" cannot be converted to a number`);
+        }
     },
 
     // Convert to boolean

package/package.json

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

package/src/RuleTemplate.js

@@ -15,6 +15,7 @@ const VariableTypes = [
     'time period',
     'time period ago',
     'time value',
+    'number time',
     'string array',
     'number array',
     'boolean array',
@@ -28,6 +29,7 @@ const AllowedTypeMapping = {
     'time period': ['time_period_atom'],
     'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
+    'number time': ['number_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
     'boolean array': ['boolean_array'],

package/src/RuleTemplate.production.js

@@ -15,6 +15,7 @@ const VariableTypes = [
     'time period',
     'time period ago',
     'time value',
+    'number time',
     'string array',
     'number array',
     'boolean array',
@@ -28,6 +29,7 @@ const AllowedTypeMapping = {
     'time period': ['time_period_atom'],
     'time period ago': ['time_period_atom'],
     'time value': ['time_value_atom', 'tod_atom'],
+    'number time': ['number_atom'],
     'string array': ['string_array'],
     'number array': ['number_array'],
     'boolean array': ['boolean_array'],

package/src/TemplateFilters.js

@@ -52,7 +52,9 @@ const TemplateFilters = {
     number: varData => {
         varData.value = Number(varData.value);
         varData.type = 'number';
-
+        if(isNaN(varData.value)){
+            throw new Error(`Value "${varData.value}" cannot be converted to a number`);
+        }
     },
 
     // Convert to boolean