@clipboard-health/rules-engine 1.15.0 → 1.16.0

package/README.md

@@ -18,8 +18,11 @@ npm install @clipboard-health/rules-engine
 
 ## Usage
 
+<embedex source="packages/rules-engine/examples/rules.ts">
+
 ```ts
-// packages/rules-engine/examples/rules.ts
+import { deepEqual } from "node:assert/strict";
+
 import {
   all,
   appendOutput,
@@ -29,8 +32,8 @@ import {
 } from "@clipboard-health/rules-engine";
 
 interface Input {
-  number1: number;
-  number2: number;
+  a: number;
+  b: number;
 }
 
 interface Output {
@@ -39,36 +42,33 @@ interface Output {
 
 const exampleContext: RuleContext<Input, Output> = {
   input: {
-    number1: 2,
-    number2: 5,
+    a: 2,
+    b: 5,
   },
   output: [],
 };
 
 const addNumbersIfPositiveRule: Rule<Input, Output> = {
-  runIf: (input) => input.number1 > 0 && input.number2 > 0,
+  runIf: (input) => input.a > 0 && input.b > 0,
   run: (context) => {
-    const { number1, number2 } = context.input;
-    const sum = number1 + number2;
-    return appendOutput(context, { result: sum });
+    const { a, b } = context.input;
+    return appendOutput(context, { result: a + b });
   },
 };
 
 const multiplyNumbersIfPositiveRule: Rule<Input, Output> = {
-  runIf: (input) => input.number1 > 0 && input.number2 > 0,
+  runIf: (input) => input.a > 0 && input.b > 0,
   run: (context) => {
-    const { number1, number2 } = context.input;
-    const sum = number1 * number2;
-    return appendOutput(context, { result: sum });
+    const { a, b } = context.input;
+    return appendOutput(context, { result: a * b });
   },
 };
 
 const divideNumbersIfNegative: Rule<Input, Output> = {
-  runIf: (input) => input.number1 < 0 && input.number2 < 0,
+  runIf: (input) => input.a < 0 && input.b < 0,
   run: (context) => {
-    const { number1, number2 } = context.input;
-    const sum = number1 * number2;
-    return appendOutput(context, { result: sum });
+    const { a, b } = context.input;
+    return appendOutput(context, { result: a / b });
   },
 };
 
@@ -79,8 +79,7 @@ const allResult = all(
   multiplyNumbersIfPositiveRule,
 ).run(exampleContext);
 
-console.log(allResult.output);
-// => [{ result: 7 }, { result: 10 }]
+deepEqual(allResult.output, [{ result: 7 }, { result: 10 }]);
 
 // Using firstMatch() applies the first the rules to the context
 const firstMatchResult = firstMatch(
@@ -89,10 +88,11 @@ const firstMatchResult = firstMatch(
   multiplyNumbersIfPositiveRule,
 ).run(exampleContext);
 
-console.log(firstMatchResult.output);
-// => [{ result: 7 }]
+deepEqual(firstMatchResult.output, [{ result: 7 }]);
 ```
 
+</embedex>
+
 ## Local development commands
 
 See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/rules-engine",
   "description": "A pure functional rules engine to keep logic-dense code simple, reliable, understandable, and explainable.",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.0",