fig-tree-evaluator 1.9.2 → 2.0.0

package/README.md

@@ -1,5 +1,7 @@
 # fig-tree-evaluator
 
+![Logo](images/FigTreeEvaluator_logo_1000.png)
+
 **FigTree Evaluator** is a module to evaluate JSON-structured expression trees. 
 
 A typical use case would be for evaluating **configuration** files, where you need to store dynamic values or arbitrary logic without allowing users to inject executable code. For example, a [form-builder app](https://github.com/openmsupply/conforma-web-app) might need to allow complex conditional logic for form element visibility based on previous responses, or for validation beyond what is available in standard validation libraries.
@@ -45,6 +47,8 @@ A range of built-in operators are available, from simple logic, arithmetic and s
 - [Development environment](#development-environment)
 - [Tests](#tests)
 - [Help, Feedback, Suggestions](#help-feedback-suggestions)
+- [Changelog](#changelog)
+- [Credit](#credit)
 
 <!-- /TOC -->
 ## The basics
@@ -1225,6 +1229,8 @@ After cloning:
 
 `yarn demo` -- launch a local version of the demo playground in your browser for building and testing expressions
 
+`yarn dev` -- execute anything in `/dev/playground.ts`. Use for testing/debugging.
+
 ## Tests
 
 There is a comprehensive [Jest](https://jestjs.io/) test suite for all aspects of fig-tree. To run all tests:
@@ -1237,4 +1243,21 @@ Individual tests can be run by string matching the argument to the test filename
 
 ## Help, Feedback, Suggestions
 
-Please open an issue: https://github.com/CarlosNZ/fig-tree-evaluator/issues
+Please open an issue: https://github.com/CarlosNZ/fig-tree-evaluator/issues
+
+## Changelog
+
+- **v2.0.0**: Re-write as stand-alone package. Major improvements include:
+  -  more [operators](#operator-reference)
+  -  operator (and property) [aliases](#operator--property-aliases)
+  -  more appropriately-named properties associated with each operator (as opposed to a single `children` array)
+  -  class-based Evaluator instances
+  -  runtime type-checking
+  -  better error handling and error reporting
+  -  more flexible output conversion
+  -  more well-organised codebase
+- **v1.x.x**: created specifically for [Conforma](https://github.com/openmsupply/conforma-server/wiki/Query-Syntax) application manager by [mSupplyFoundation](https://github.com/openmsupply). v2 is a complete re-write with numerous improvments, but should be 99% backwards compatible.
+
+
+## Credit
+Icon: Tree by ka reemov from <a href="https://thenounproject.com/icon/tree-2665898/" target="_blank" title="Tree Icon">Noun Project</a>

package/build/helpers.js

@@ -1,11 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorMessage = exports.convertOutputMethods = exports.checkRequiredNodes = exports.mapPropertyAliases = exports.fallbackOrError = exports.truncateString = exports.getOperatorName = exports.isOperatorNode = exports.parseIfJson = void 0;
-const mapKeys_1 = __importDefault(require("lodash/mapKeys"));
-const camelCase_1 = __importDefault(require("lodash/camelCase"));
+const change_case_1 = require("change-case");
 const parseIfJson = (input) => {
     if (typeof input !== 'string')
         return input;
@@ -21,7 +17,7 @@ exports.parseIfJson = parseIfJson;
 const isOperatorNode = (input) => input instanceof Object && 'operator' in input;
 exports.isOperatorNode = isOperatorNode;
 const standardiseOperatorName = (name) => {
-    const camelCaseName = (0, camelCase_1.default)(name);
+    const camelCaseName = (0, change_case_1.camelCase)(name);
     return camelCaseName ? camelCaseName : name;
 };
 const getOperatorName = (operator, operatorAliases) => operatorAliases[standardiseOperatorName(operator)];
@@ -37,8 +33,13 @@ const fallbackOrError = (fallback, errorMessage, returnErrorAsString = false) =>
         throw new Error((0, exports.truncateString)(errorMessage));
 };
 exports.fallbackOrError = fallbackOrError;
-const mapPropertyAliases = (propertyAliases, expression) => (0, mapKeys_1.default)(expression, (_, key) => key in propertyAliases ? propertyAliases[key] : key);
+const mapPropertyAliases = (propertyAliases, expression) => mapObjectKeys(expression, (key) => key in propertyAliases ? propertyAliases[key] : key);
 exports.mapPropertyAliases = mapPropertyAliases;
+const mapObjectKeys = (inputObj, mapFunction) => {
+    const keyVals = Object.entries(inputObj);
+    const mappedKeys = keyVals.map(([key, value]) => [mapFunction(key), value]);
+    return Object.fromEntries(mappedKeys);
+};
 const checkRequiredNodes = (requiredProps, expression) => {
     const missingProps = requiredProps.filter((prop) => !(prop in expression));
     if (missingProps.length === 0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fig-tree-evaluator",
-  "version": "1.9.2",
+  "version": "2.0.0",
   "description": "Module to evaluate JSON-structured expression trees",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -14,7 +14,6 @@
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^13.0.0",
     "@types/jest": "^27.5.1",
-    "@types/lodash": "^4.14.182",
     "@types/node": "^17.0.38",
     "@types/pg": "^8.6.5",
     "dotenv": "^16.0.1",
@@ -35,7 +34,7 @@
   },
   "dependencies": {
     "axios": "^0.27.2",
-    "lodash": "^4.17.21",
+    "change-case": "^4.1.2",
     "object-property-extractor": "^1.0.3"
   },
   "bugs": {