@f-o-t/rules-engine 2.0.2 → 3.0.1

package/LICENSE.md

@@ -1,9 +1,21 @@
 MIT License
 
-Copyright (c) 2025 FOT
+Copyright (c) 2026 FOT (F-O-T)
 
-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:
+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 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.
+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

@@ -23,35 +23,65 @@ bun add @f-o-t/rules-engine
 ## Quick Start
 
 ```typescript
-import { createEngine, rule, all, num, str } from "@f-o-t/rules-engine";
+import { createEngine, createEvaluator } from "@f-o-t/rules-engine";
+import { z } from "zod";
 
-// Create an engine
-const engine = createEngine();
+// Define your consequence types
+const MyConsequences = {
+  send_email: z.object({
+    to: z.string().email(),
+    subject: z.string(),
+  }),
+  apply_discount: z.object({
+    percentage: z.number(),
+  }),
+};
+
+// Create engine with built-in operators
+const engine = createEngine({
+  consequences: MyConsequences,
+  evaluator: createEvaluator(), // Required!
+});
 
-// Add rules using the fluent builder
-engine.addRule(
-   rule()
-      .named("Premium Discount")
-      .when(
-         all(
-            num("orderTotal", "gt", 100),
-            str("customerType", "eq", "premium")
-         )
-      )
-      .then("apply_discount", { percentage: 15 })
-      .withPriority(100)
-      .tagged("pricing", "discount")
-      .build()
-);
+// Or with custom operators
+import { moneyOperators } from "@f-o-t/money/operators";
+
+const engine = createEngine({
+  consequences: MyConsequences,
+  operators: moneyOperators, // Convenience: engine creates evaluator
+});
 
-// Evaluate against context
+// Add rules
+engine.addRule({
+  name: "high-value-customer",
+  conditions: {
+    id: "g1",
+    operator: "AND",
+    conditions: [
+      {
+        id: "c1",
+        type: "number",
+        field: "totalPurchases",
+        operator: "gt",
+        value: 1000,
+      },
+    ],
+  },
+  consequences: [
+    {
+      type: "apply_discount",
+      payload: { percentage: 10 },
+    },
+  ],
+});
+
+// Evaluate
 const result = await engine.evaluate({
-   orderTotal: 150,
-   customerType: "premium",
+  totalPurchases: 1500,
 });
 
-console.log(result.matchedRules);    // Rules that matched
-console.log(result.consequences);    // Actions to execute
+console.log(result.matchedRules); // Rules that matched
+console.log(result.consequences); // Actions to take
 ```
 
 ## Building Conditions
@@ -125,6 +155,59 @@ const myRule = rule()
    .build();
 ```
 
+## Custom Operators
+
+Use custom operators from libraries like `@f-o-t/money`:
+
+```typescript
+import { createEngine } from "@f-o-t/rules-engine";
+import { moneyOperators } from "@f-o-t/money/operators";
+
+const engine = createEngine({
+  operators: moneyOperators,
+});
+
+engine.addRule({
+  name: "large-transaction",
+  conditions: {
+    id: "g1",
+    operator: "AND",
+    conditions: [
+      {
+        id: "c1",
+        type: "custom",
+        field: "amount",
+        operator: "money_gt",
+        value: { amount: "5000.00", currency: "BRL" },
+      },
+    ],
+  },
+  consequences: [
+    { type: "flag_for_review", payload: {} },
+  ],
+});
+```
+
+Create your own custom operators:
+
+```typescript
+import { createEngine, createOperator } from "@f-o-t/rules-engine";
+
+const customOperator = createOperator({
+  name: "is_valid_cpf",
+  type: "custom",
+  description: "Validate Brazilian CPF",
+  evaluate: (actual, expected) => {
+    // Your validation logic
+    return validateCPF(actual as string);
+  },
+});
+
+const engine = createEngine({
+  operators: { is_valid_cpf: customOperator },
+});
+```
+
 ## Engine API
 
 ### Rule Management

package/package.json

@@ -1,69 +1,36 @@
 {
-   "bugs": {
-      "url": "https://github.com/F-O-T/montte-nx/issues"
-   },
-   "description": "Type-safe, functional rules orchestration engine for TypeScript",
-   "dependencies": {
-      "@f-o-t/condition-evaluator": "2.0.0",
-      "zod": "4.3.4"
-   },
-   "devDependencies": {
-      "@biomejs/biome": "2.3.10",
-      "@types/bun": "1.3.5",
-      "bumpp": "10.3.2",
-      "bunup": "0.16.11",
-      "typescript": "5.9.3"
-   },
-   "exports": {
-      ".": {
-         "bun": "./src/index.ts",
-         "import": {
-            "default": "./dist/index.js",
-            "types": "./dist/index.d.ts"
-         },
-         "require": {
-            "default": "./dist/index.cjs",
-            "types": "./dist/index.d.cts"
-         },
-         "types": "./src/index.ts"
-      },
-      "./package.json": "./package.json"
-   },
-   "main": "./dist/index.cjs",
-   "files": [
-      "dist"
-   ],
-   "homepage": "https://github.com/F-O-T/montte-nx/blob/master/libraries/rules-engine",
-   "license": "MIT",
-   "module": "./dist/index.js",
-   "name": "@f-o-t/rules-engine",
-   "peerDependencies": {
-      "typescript": ">=4.5.0"
-   },
-   "peerDependenciesMeta": {
-      "typescript": {
-         "optional": true
-      }
-   },
-   "private": false,
-   "publishConfig": {
-      "access": "public"
-   },
-   "repository": {
-      "type": "git",
-      "url": "https://github.com/F-O-T/montte-nx.git"
-   },
-   "scripts": {
-      "build": "bunup",
-      "check": "biome check --write .",
-      "dev": "bunup --watch",
-      "release": "bumpp --commit --push --tag",
-      "test": "bun test",
-      "test:coverage": "bun test --coverage",
-      "test:watch": "bun test --watch",
-      "typecheck": "tsc"
-   },
-   "type": "module",
-   "types": "./dist/index.d.ts",
-   "version": "2.0.2"
+  "name": "@f-o-t/rules-engine",
+  "version": "3.0.1",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "bun x --bun fot build",
+    "test": "bun x --bun fot test",
+    "lint": "bun x --bun fot lint",
+    "format": "bun x --bun fot format",
+    "typecheck": "bun x --bun fot typecheck"
+  },
+  "dependencies": {
+    "@f-o-t/condition-evaluator": "^2.0.2",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@f-o-t/cli": "^1.0.0",
+    "@f-o-t/config": "^1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/F-O-T/libraries.git",
+    "directory": "libraries/rules-engine"
+  }
 }