@gorules/zen-engine 0.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 GoRules.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,169 @@
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## NodeJS ZEN Engine
+
+ZEN Engine is business friendly Open-Source Business Rules Engine (BRE) to execute decision models according to the [GoRules JSON Decision Model (JDM)](https://gorules.io/docs/rules-engine/json-decision-model) standard. It is written in **Rust** and provides native bindings for **NodeJS** and **Python**. ZEN Engine allows to load and execute JSON Decision Model (JDM) from JSON files.
+
+## Usage
+ZEN Engine is built as embeddable BRE for your **Rust**, **NodeJS** or **Python** applications.
+It parses JDM from JSON content. It is up to you to obtain the JSON content, e.g. from file system, database or service call.
+
+If you are looking for a **Decision-as-a-Service** (DaaS) over REST, take a look at [GoRules Cloud](https://gorules.io).
+
+### Installation
+```bash
+npm i @gorules/zen-engine
+```
+
+or
+
+```bash
+yarn add @gorules/zen-engine
+```
+
+### Simple Example
+To execute a simple decision you can use the code below.
+
+```typescript
+import { ZenEngine } from "@gorules/zen-engine";
+import fs from 'fs/promises';
+
+(async () => {
+  // Example filesystem content, it is up to you how you obtain content
+  const content = await fs.readFile('./jdm_graph.json');
+  const engine = new ZenEngine();
+
+  const decision = engine.createDecision(content);
+  const result = await decision.evaluate({input: 15});
+})();
+```
+
+### Loaders
+
+For more advanced use cases where you want to load multiple decisions and utilise graphs you can build loaders.
+
+```typescript
+import { ZenEngine } from "../index";
+import fs from 'fs/promises';
+import path from 'path';
+
+const dataRoot = path.join(__dirname, 'jdm_directory');
+
+const loader = async (key: string) => fs.readFile(path.join(testDataRoot, key))
+
+(async () => {
+  const engine = new ZenEngine({
+    loader
+  });
+
+  const result = await engine.evaluate('jdm_graph1.json', {input: 5});
+})();
+```
+When engine.evaluate is invoked it will call loader and pass a key expecting a content of the JDM decision graph.
+In the case above we will assume file `jdm_directory/jdm_graph1.json` exists.
+
+Similar to this example you can also utilise loader to load from different places, for example from REST API, from S3, Database, etc.
+
+
+## JSON Decision Model (JDM)
+
+JDM is a modeling standard for business decisions and business rules and is stored in a JSON format. Decision models are represented by graphs. Graphs are built using nodes and edges. Edges are used to pass the data from one node to another (left-side to right-side).
+
+You can try [Free Online Editor](https://editor.gorules.io) with built in Simulator.
+
+<img width="1258" alt="JSON Decision Model" src="https://user-images.githubusercontent.com/60513195/224425568-4a717e34-3d4b-4cc6-b031-8cd35f8ff459.png">
+
+[JSON Example](https://github.com/gorules/zen/blob/master/test-data/credit-analysis.json)
+
+Input node contains all data sent in the context, and Output node returns the data from the decision. Data flows from the Input Node towards Output Node evaluating all the Nodes in between and passing the data where nodes are connected.
+
+### Decision Tables
+Decision table is a node which allows business users to easily modify and add new rules in an intuitive way using spreadsheet like interface. The structure of decision table is defined by its schema. Schema consists of inputs and outputs.
+
+Decision tables are evaluated row by row from top to bottom, and depending on the hit policy a result is calculated.
+
+**Inputs**
+
+Input fields are commonly (qualified) names for example `cart.total` or `customer.country`.
+
+```json
+{
+  "cart": {
+    "total": 1000
+  },
+  "customer": {
+    "country": "US"
+  }
+}
+```
+
+Inputs are using business-friendly ZEN Expression Language. The language is designed to follow these principles:
+
+* Side-effect free
+* Dynamic types
+* Simple syntax for broad audiences
+
+List shows basic example of the unary tests in the Input Fields:
+
+| Input entry | Input Expression |
+| ---------|-----------|
+| "A" | the field equals "A" |
+| "A", "B" | the field is either "A" or "B"
+| 36 | the numeric value equals 36 |
+| < 36 | a value less than 36 |
+| > 36 | a value greater than 36 |
+| [20..39]                  | a value between 20 and 39 (inclusive) |
+| 20,39 | a value either 20 or 39 |
+| <20, >39 | a value either less than 20 or greater than 39|
+| true | the boolean value true |
+| false | the boolean value false |
+| | any value, even null/undefined |
+| null | the value null or undefined |
+
+Note: For the full list please visit [ZEN Expression Language](https://gorules.io/docs/rules-engine/expression-language/).
+
+**Outputs**
+
+The result of the decisionTableNode evaluation is:
+
+* an object if the hit policy of the decision table is FIRST and a rule matched. The structure is defined by the output fields. Qualified field names with a dot (.) inside lead to nested objects.
+* `null`/`undefined` if no rule matched in FIRST hit policy
+* an array of objects if the hit policy of the decision table is COLLECT (one array item for each matching rule) or empty array if no rules match
+
+Example:
+
+<img width="860" alt="Screenshot 2023-03-10 at 22 57 04" src="https://user-images.githubusercontent.com/60513195/224436208-a2266cec-d0c6-42c7-8607-a4071e6a950b.png">
+
+And the result would be:
+
+```json
+{
+  "flatProperty": "A",
+  "output": {
+    "nested": {
+      "property": "B"
+    },
+    "property": 36
+  }
+}
+```
+
+### Functions
+Function nodes are JavaScript lambdas that allow for quick and easy parsing, re-mapping or otherwise modifying the data. Inputs of the node are provided as function's arguments. Functions are executed on top of Google's V8 Engine that is built in into the ZEN Engine.
+
+```js
+const handler = (input) => {
+    return input;
+}
+```
+
+### Decision
+Decision is a special node whose purpose is for decision model to have an ability to call other/re-usable decision models during an execution.
+
+## Support matrix
+
+linux-x64-gnu   | linux-arm64-gnu |     darvin-x64        |      darvin-arm64   | win32-x64-msvc       
+:------------ |:------------------- |:------------------- |:------------------- |:-------------------
+yes | yes | yes | yes | yes
+
+We do not support linux-musl for now as we are relying on the GoogleV8 engine to run function blocks as isolates. 

package/index.d.ts

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface ZenEvaluateOptions {
+  maxDepth?: number
+  trace?: boolean
+}
+export interface JsZenEngineOptions {
+  loader?: (key: string) => Promise<Buffer>
+}
+export type JsZenDecision = ZenDecision
+export class ZenDecision {
+  constructor()
+  evaluate(context: any, opts?: JsZenEvaluateOptions | undefined | null): Promise<any>
+}
+export type JsZenEngine = ZenEngine
+export class ZenEngine {
+  constructor(options?: JsZenEngineOptions | undefined | null)
+  evaluate(key: string, context: any, opts?: ZenEvaluateOptions | undefined | null): Promise<any>
+  createDecision(content: Buffer): ZenDecision
+  getDecision(key: string): Promise<ZenDecision>
+}

package/index.js

@@ -0,0 +1,252 @@
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim();
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'zen-engine.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.android-arm64.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'zen-engine.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zen-engine.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'zen-engine.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zen-engine.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'zen-engine.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./zen-engine.darwin-universal.node')
+      } else {
+        nativeBinding = require('@gorules/zen-engine-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'zen-engine.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.darwin-x64.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zen-engine.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'zen-engine.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./zen-engine.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@gorules/zen-engine-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zen-engine.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zen-engine.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@gorules/zen-engine-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zen-engine.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zen-engine.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@gorules/zen-engine-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zen-engine.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zen-engine.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@gorules/zen-engine-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zen-engine.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zen-engine.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@gorules/zen-engine-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, 'zen-engine.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zen-engine.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('@gorules/zen-engine-linux-arm-gnueabihf')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { ZenDecision, ZenEngine } = nativeBinding
+
+module.exports.ZenDecision = ZenDecision
+module.exports.ZenEngine = ZenEngine

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@gorules/zen-engine",
+  "version": "0.1.0",
+  "main": "index.js",
+  "types": "./index.d.ts",
+  "license": "MIT",
+  "typings": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "napi": {
+    "name": "zen-engine",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "x86_64-apple-darwin",
+        "x86_64-unknown-linux-gnu",
+        "x86_64-pc-windows-msvc",
+        "aarch64-unknown-linux-gnu",
+        "aarch64-apple-darwin"
+      ]
+    },
+    "npmClient": "yarn"
+  },
+  "keywords": [
+    "gorules",
+    "zen-engine",
+    "business rules engine",
+    "rules engine",
+    "rule engine",
+    "bre",
+    "rule",
+    "rules",
+    "engine",
+    "decision",
+    "decision table",
+    "rust",
+    "N-API",
+    "napi-rs",
+    "node-rs"
+  ],
+  "author": "GoRules <hi@gorules.io> (https://gorules.io)",
+  "homepage": "https://github.com/gorules/zen",
+  "engines": {
+    "node": ">= 14"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@napi-rs/cli": "^2.14.8",
+    "@types/express": "^4.17.17",
+    "@types/node": "^18.15.0",
+    "babel-jest": "^29.5.0",
+    "express": "^4.18.2",
+    "jest": "^29.5.0",
+    "lerna": "^6.5.1",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5"
+  },
+  "bugs": {
+    "url": "https://github.com/gorules/zen/issues"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gorules/zen.git"
+  },
+  "scripts": {
+    "build": "napi build --platform --release --js index.js --dts index.d.ts",
+    "build:debug": "napi build --platform --js index.js --dts index.d.ts",
+    "test": "jest --forceExit",
+    "artifacts": "napi artifacts -d ../../artifacts",
+    "prepublishOnly": "napi prepublish",
+    "version": "napi version"
+  },
+  "gitHead": "b1a1242f04528a47cb4dfd83b4648ded9468dc89",
+  "optionalDependencies": {
+    "@gorules/zen-engine-darwin-x64": "0.1.0",
+    "@gorules/zen-engine-linux-x64-gnu": "0.1.0",
+    "@gorules/zen-engine-win32-x64-msvc": "0.1.0",
+    "@gorules/zen-engine-linux-arm64-gnu": "0.1.0",
+    "@gorules/zen-engine-darwin-arm64": "0.1.0"
+  }
+}