fig-tree-evaluator 1.9.4 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -47,6 +47,8 @@ A range of built-in operators are available, from simple logic, arithmetic and s
47
47
  - [Development environment](#development-environment)
48
48
  - [Tests](#tests)
49
49
  - [Help, Feedback, Suggestions](#help-feedback-suggestions)
50
+ - [Changelog](#changelog)
51
+ - [Credit](#credit)
50
52
 
51
53
  <!-- /TOC -->
52
54
  ## The basics
@@ -1227,6 +1229,8 @@ After cloning:
1227
1229
 
1228
1230
  `yarn demo` -- launch a local version of the demo playground in your browser for building and testing expressions
1229
1231
 
1232
+ `yarn dev` -- execute anything in `/dev/playground.ts`. Use for testing/debugging.
1233
+
1230
1234
  ## Tests
1231
1235
 
1232
1236
  There is a comprehensive [Jest](https://jestjs.io/) test suite for all aspects of fig-tree. To run all tests:
@@ -1239,4 +1243,21 @@ Individual tests can be run by string matching the argument to the test filename
1239
1243
 
1240
1244
  ## Help, Feedback, Suggestions
1241
1245
 
1242
- Please open an issue: https://github.com/CarlosNZ/fig-tree-evaluator/issues
1246
+ Please open an issue: https://github.com/CarlosNZ/fig-tree-evaluator/issues
1247
+
1248
+ ## Changelog
1249
+
1250
+ - **v2.0.0**: Re-write as stand-alone package. Major improvements include:
1251
+ - more [operators](#operator-reference)
1252
+ - operator (and property) [aliases](#operator--property-aliases)
1253
+ - more appropriately-named properties associated with each operator (as opposed to a single `children` array)
1254
+ - class-based Evaluator instances
1255
+ - runtime type-checking
1256
+ - better error handling and error reporting
1257
+ - more flexible output conversion
1258
+ - more well-organised codebase
1259
+ - **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.
1260
+
1261
+
1262
+ ## Credit
1263
+ Icon: Tree by ka reemov from <a href="https://thenounproject.com/icon/tree-2665898/" target="_blank" title="Tree Icon">Noun Project</a>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fig-tree-evaluator",
3
- "version": "1.9.4",
3
+ "version": "2.0.0",
4
4
  "description": "Module to evaluate JSON-structured expression trees",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",