@clipboard-health/rules-engine 1.2.3 → 1.2.5

package/dist/README.md

@@ -0,0 +1,100 @@
+# @clipboard-health/rules-engine
+
+A pure functional rules engine with two rule runners:
+
+- `firstMatch`: Runs the first rule that matches the criteria
+- `all`: Runs all the rules that matches the criteria
+
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install @clipboard-health/rules-engine
+```
+
+## Usage
+
+```ts
+// ./examples/rules.ts
+
+import {
+  all,
+  appendOutput,
+  firstMatch,
+  type Rule,
+  type RuleContext,
+} from "@clipboard-health/rules-engine";
+
+interface Input {
+  number1: number;
+  number2: number;
+}
+
+interface Output {
+  result: number;
+}
+
+const exampleContext: RuleContext<Input, Output> = {
+  input: {
+    number1: 2,
+    number2: 5,
+  },
+  output: [],
+};
+
+const addNumbersIfPositiveRule: Rule<Input, Output> = {
+  runIf: (input) => input.number1 > 0 && input.number2 > 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 + number2;
+    return appendOutput(context, { result: sum });
+  },
+};
+
+const multiplyNumbersIfPositiveRule: Rule<Input, Output> = {
+  runIf: (input) => input.number1 > 0 && input.number2 > 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 * number2;
+    return appendOutput(context, { result: sum });
+  },
+};
+
+const divideNumbersIfNegative: Rule<Input, Output> = {
+  runIf: (input) => input.number1 < 0 && input.number2 < 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 * number2;
+    return appendOutput(context, { result: sum });
+  },
+};
+
+// Using all() applies all the rules to the context
+const allResult = all(
+  addNumbersIfPositiveRule,
+  divideNumbersIfNegative,
+  multiplyNumbersIfPositiveRule,
+).run(exampleContext);
+
+console.log(allResult.output);
+// => [{ result: 7 }, { result: 10 }]
+
+// Using firstMatch() applies the first the rules to the context
+const firstMatchResult = firstMatch(
+  divideNumbersIfNegative,
+  addNumbersIfPositiveRule,
+  multiplyNumbersIfPositiveRule,
+).run(exampleContext);
+
+console.log(firstMatchResult.output);
+// => [{ result: 7 }]
+```
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/dist/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@clipboard-health/rules-engine",
+  "description": "A pure functional rules engine.",
+  "version": "1.2.5",
+  "bugs": "https://github.com/clipboardhealth/core-utils/issues",
+  "dependencies": {
+    "tslib": "2.7.0",
+    "type-fest": "4.26.1"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "license": "MIT",
+  "main": "./dist/src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clipboardhealth/core-utils.git",
+    "directory": "packages/rules-engine"
+  },
+  "scripts": {
+    "embed": "embedme README.md"
+  },
+  "type": "commonjs",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,qDAA2B;AAC3B,wDAA8B"}

package/dist/src/lib/appendOutput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appendOutput.js","sourceRoot":"","sources":["../../../src/lib/appendOutput.ts"],"names":[],"mappings":";;AAOA,oCAQC;AAXD;;GAEG;AACH,SAAgB,YAAY,CAC1B,OAAqC,EACrC,MAA6B;IAE7B,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;KACpC,CAAC;AACJ,CAAC"}

package/{src → dist/src}/lib/rule.d.ts

@@ -5,9 +5,7 @@ export interface RuleContext<TInput, TOutput> {
      */
     input: ReadonlyDeep<TInput>;
     /**
-     * Output is immutable, do not modify existing items, only append.
-     *
-     * @see {@link appendOutput}
+     * Output is immutable, do not modify existing items, only append using {@link appendOutput}.
      */
     output: ReadonlyArray<ReadonlyDeep<TOutput>>;
 }

package/dist/src/lib/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../../src/lib/rule.ts"],"names":[],"mappings":""}

package/dist/src/lib/runners/all.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"all.js","sourceRoot":"","sources":["../../../../src/lib/runners/all.ts"],"names":[],"mappings":";;AAOA,kBAUC;AAfD;;;;GAIG;AACH,SAAgB,GAAG,CACjB,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CACf,KAAK;aACF,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC3C,MAAM,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC"}

package/dist/src/lib/runners/firstMatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firstMatch.js","sourceRoot":"","sources":["../../../../src/lib/runners/firstMatch.ts"],"names":[],"mappings":";;AAOA,gCAUC;AAfD;;;;GAIG;AACH,SAAgB,UAAU,CACxB,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE;YACf,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/src/lib/runners/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/runners/index.ts"],"names":[],"mappings":";;;AAAA,gDAAsB;AACtB,uDAA6B"}

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@clipboard-health/rules-engine",
   "description": "A pure functional rules engine.",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "bugs": "https://github.com/clipboardhealth/core-utils/issues",
   "dependencies": {
-    "tslib": "2.6.3",
-    "type-fest": "4.25.0"
+    "tslib": "2.7.0",
+    "type-fest": "4.26.1"
   },
+  "files": [
+    "dist"
+  ],
   "keywords": [],
   "license": "MIT",
-  "main": "./src/index.js",
+  "main": "./dist/src/index.js",
   "publishConfig": {
     "access": "public"
   },
@@ -22,6 +25,5 @@
     "embed": "embedme README.md"
   },
   "type": "commonjs",
-  "typings": "./src/index.d.ts",
-  "types": "./src/index.d.ts"
+  "typings": "./src/index.d.ts"
 }

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/rules-engine/src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,qDAA2B;AAC3B,wDAA8B"}

package/src/lib/appendOutput.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"appendOutput.js","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/appendOutput.ts"],"names":[],"mappings":";;AAOA,oCAQC;AAXD;;GAEG;AACH,SAAgB,YAAY,CAC1B,OAAqC,EACrC,MAA6B;IAE7B,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;KACpC,CAAC;AACJ,CAAC"}

package/src/lib/rule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/rule.ts"],"names":[],"mappings":""}

package/src/lib/runners/all.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"all.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/all.ts"],"names":[],"mappings":";;AAOA,kBAUC;AAfD;;;;GAIG;AACH,SAAgB,GAAG,CACjB,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CACf,KAAK;aACF,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC3C,MAAM,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC"}

package/src/lib/runners/firstMatch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"firstMatch.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/firstMatch.ts"],"names":[],"mappings":";;AAOA,gCAUC;AAfD;;;;GAIG;AACH,SAAgB,UAAU,CACxB,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzD,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE;YACf,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/src/lib/runners/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/index.ts"],"names":[],"mappings":";;;AAAA,gDAAsB;AACtB,uDAA6B"}