@halleyassist/rule-templater 0.0.15 → 0.0.16

package/dist/rule-templater.browser.js

@@ -4311,6 +4311,7 @@ module.exports = TemplateFilters;
 },{}],19:[function(require,module,exports){
 const { Parser } = require('ebnf');
 const TemplateGrammar = require('./RuleTemplate.ebnf');
+const TemplateFilters = require('./TemplateFilters');
 const RuleParser = require('@halleyassist/rule-parser');
 const RuleParserRules = RuleParser.ParserRules;
 
@@ -4357,7 +4358,17 @@ class VariableValidate {
             };
         }
 
-        return VariableValidate.validateValue(variableData.type, variableData.value);
+        let normalizedVarData;
+        try {
+            normalizedVarData = VariableValidate._normalizeVarData(variableData);
+        } catch (error) {
+            return {
+                valid: false,
+                error: error.message
+            };
+        }
+
+        return VariableValidate.validateValue(normalizedVarData.type, normalizedVarData.value);
     }
 
     static validateValue(type, value) {
@@ -4424,6 +4435,49 @@ class VariableValidate {
         return ParserCache;
     }
 
+    static _normalizeVarData(variableData) {
+        const normalizedVarData = VariableValidate._cloneVarData(variableData);
+
+        if (!Object.prototype.hasOwnProperty.call(normalizedVarData, 'value')) {
+            throw new Error('Variable data must include a value property');
+        }
+
+        if (!Object.prototype.hasOwnProperty.call(normalizedVarData, 'filters')) {
+            return normalizedVarData;
+        }
+
+        if (!Array.isArray(normalizedVarData.filters)) {
+            throw new Error('Variable data filters must be an array');
+        }
+
+        for (const filterName of normalizedVarData.filters) {
+            if (!TemplateFilters[filterName]) {
+                throw new Error(`Unknown filter '${filterName}'`);
+            }
+
+            TemplateFilters[filterName](normalizedVarData);
+        }
+
+        return normalizedVarData;
+    }
+
+    static _cloneVarData(variableData) {
+        const cloned = Object.assign({}, variableData);
+        if (Array.isArray(cloned.filters)) {
+            cloned.filters = cloned.filters.slice();
+        }
+
+        if (cloned.value && typeof cloned.value === 'object') {
+            if (Array.isArray(cloned.value)) {
+                cloned.value = cloned.value.slice();
+            } else {
+                cloned.value = Object.assign({}, cloned.value);
+            }
+        }
+
+        return cloned;
+    }
+
     static _serializeString(value) {
         if (typeof value !== 'string') {
             return null;
@@ -4654,5 +4708,5 @@ VariableValidate.validators = Object.freeze({
 });
 
 module.exports = VariableValidate;
-},{"./RuleTemplate.ebnf":15,"@halleyassist/rule-parser":2,"ebnf":13}]},{},[14])(14)
+},{"./RuleTemplate.ebnf":15,"./TemplateFilters":18,"@halleyassist/rule-parser":2,"ebnf":13}]},{},[14])(14)
 });

package/index.d.ts

@@ -15,6 +15,7 @@ export interface VariableValue {
         to: string;
         ago?: [number, string];
     } | Record<string, any> | string[] | number[] | boolean[] | Record<string, any>[];
+    filters?: string[];
     type?: 'string' | 'number' | 'boolean' | 'object' | 'time period' | 'time period ago' | 'time value' | 'number time' | 'string array' | 'number array' | 'boolean array' | 'object array';
 }
 

package/package.json

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

package/src/VariableValidate.js

@@ -1,5 +1,6 @@
 const { Parser } = require('ebnf');
 const TemplateGrammar = require('./RuleTemplate.ebnf');
+const TemplateFilters = require('./TemplateFilters');
 const RuleParser = require('@halleyassist/rule-parser');
 const RuleParserRules = RuleParser.ParserRules;
 
@@ -46,7 +47,17 @@ class VariableValidate {
             };
         }
 
-        return VariableValidate.validateValue(variableData.type, variableData.value);
+        let normalizedVarData;
+        try {
+            normalizedVarData = VariableValidate._normalizeVarData(variableData);
+        } catch (error) {
+            return {
+                valid: false,
+                error: error.message
+            };
+        }
+
+        return VariableValidate.validateValue(normalizedVarData.type, normalizedVarData.value);
     }
 
     static validateValue(type, value) {
@@ -113,6 +124,49 @@ class VariableValidate {
         return ParserCache;
     }
 
+    static _normalizeVarData(variableData) {
+        const normalizedVarData = VariableValidate._cloneVarData(variableData);
+
+        if (!Object.prototype.hasOwnProperty.call(normalizedVarData, 'value')) {
+            throw new Error('Variable data must include a value property');
+        }
+
+        if (!Object.prototype.hasOwnProperty.call(normalizedVarData, 'filters')) {
+            return normalizedVarData;
+        }
+
+        if (!Array.isArray(normalizedVarData.filters)) {
+            throw new Error('Variable data filters must be an array');
+        }
+
+        for (const filterName of normalizedVarData.filters) {
+            if (!TemplateFilters[filterName]) {
+                throw new Error(`Unknown filter '${filterName}'`);
+            }
+
+            TemplateFilters[filterName](normalizedVarData);
+        }
+
+        return normalizedVarData;
+    }
+
+    static _cloneVarData(variableData) {
+        const cloned = Object.assign({}, variableData);
+        if (Array.isArray(cloned.filters)) {
+            cloned.filters = cloned.filters.slice();
+        }
+
+        if (cloned.value && typeof cloned.value === 'object') {
+            if (Array.isArray(cloned.value)) {
+                cloned.value = cloned.value.slice();
+            } else {
+                cloned.value = Object.assign({}, cloned.value);
+            }
+        }
+
+        return cloned;
+    }
+
     static _serializeString(value) {
         if (typeof value !== 'string') {
             return null;