@clipboard-health/rules-engine 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2023-12-20)
+
+
+### Features
+
+* **PRI-290:** Add rules-engine lib ([#477](https://github.com/ClipboardHealth/cbh-core/issues/477)) ([d7aa2ba](https://github.com/ClipboardHealth/cbh-core/commit/d7aa2ba3c698511c053a2b31dfe4b5e0e4a6081d))

package/README.md

@@ -0,0 +1,99 @@
+# @clipboard-health/rules-engine
+
+Exposes a functional rules-engine with 2 engines:
+
+- 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, firstMatch, type Rule, type RuleContext } from "@clipboard-health/rules-engine";
+
+interface Input {
+  number1: number;
+  number2: number;
+}
+
+interface Output {
+  result: number;
+}
+
+interface ExampleRuleContext extends RuleContext<Input, Output> {}
+
+const exampleContext: ExampleRuleContext = {
+  input: {
+    number1: 2,
+    number2: 5,
+  },
+  output: [],
+};
+
+const addNumbersIfPositiveRule: Rule<ExampleRuleContext> = {
+  runIf: (context) => context.input.number1 > 0 && context.input.number2 > 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 + number2;
+    context.output.push({ result: sum });
+    return context;
+  },
+};
+
+const multiplyNumbersIfPositiveRule: Rule<ExampleRuleContext> = {
+  runIf: (context) => context.input.number1 > 0 && context.input.number2 > 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 * number2;
+    context.output.push({ result: sum });
+    return context;
+  },
+};
+
+const divideNumbersIfNegative: Rule<ExampleRuleContext> = {
+  runIf: (context) => context.input.number1 < 0 && context.input.number2 < 0,
+  run: (context) => {
+    const { number1, number2 } = context.input;
+    const sum = number1 * number2;
+    context.output.push({ result: sum });
+    return context;
+  },
+};
+
+// Using all() applies all the rules to the context
+const allResult = all(
+  addNumbersIfPositiveRule,
+  divideNumbersIfNegative,
+  multiplyNumbersIfPositiveRule,
+).run(exampleContext);
+
+// eslint-disable-next-line no-console
+console.log(allResult.output); // AllResult.output = [{ result: 7 }, { result: 10 }]
+
+// Using firstMatch() applies the first the rules to the context
+const firstMatchResult = firstMatch(
+  divideNumbersIfNegative,
+  addNumbersIfPositiveRule,
+  multiplyNumbersIfPositiveRule,
+).run(exampleContext);
+
+// eslint-disable-next-line no-console
+console.log(firstMatchResult.output); // [{ result: 7 }]
+```
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@clipboard-health/rules-engine",
+  "version": "0.1.0",
+  "main": "./src/index.js",
+  "scripts": {
+    "build": "nx build rules-engine",
+    "embed": "embedme README.md",
+    "lint": "nx lint rules-engine",
+    "test": "nx test rules-engine"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./lib/append-output";
+export * from "./lib/rule";
+export * from "./lib/runners/all";
+export * from "./lib/runners/first-match";
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/rules-engine/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC"}

package/src/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/append-output"), exports);
+tslib_1.__exportStar(require("./lib/rule"), exports);
+tslib_1.__exportStar(require("./lib/runners/all"), exports);
+tslib_1.__exportStar(require("./lib/runners/first-match"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/rules-engine/src/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,qDAA2B;AAC3B,4DAAkC;AAClC,oEAA0C"}

package/src/lib/append-output.d.ts

@@ -0,0 +1,3 @@
+import { type RuleContext } from "./rule";
+export declare function appendOutput<TInput, TOutput>(context: RuleContext<TInput, TOutput>, output: TOutput): RuleContext<TInput, TOutput>;
+//# sourceMappingURL=append-output.d.ts.map

package/src/lib/append-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"append-output.d.ts","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/append-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE1C,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,EAC1C,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,MAAM,EAAE,OAAO,GACd,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAK9B"}

package/src/lib/append-output.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendOutput = void 0;
+function appendOutput(context, output) {
+    return {
+        input: context.input,
+        output: [...context.output, output],
+    };
+}
+exports.appendOutput = appendOutput;
+//# sourceMappingURL=append-output.js.map

package/src/lib/append-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"append-output.js","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/append-output.ts"],"names":[],"mappings":";;;AAEA,SAAgB,YAAY,CAC1B,OAAqC,EACrC,MAAe;IAEf,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;KACpC,CAAC;AACJ,CAAC;AARD,oCAQC"}

package/src/lib/rule.d.ts

@@ -0,0 +1,9 @@
+export interface RuleContext<TInput = unknown, TOutput = unknown> {
+    input: TInput;
+    output: TOutput[];
+}
+export interface Rule<TContext extends RuleContext> {
+    runIf: (context: TContext) => boolean;
+    run: (context: TContext) => TContext;
+}
+//# sourceMappingURL=rule.d.ts.map

package/src/lib/rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/rule.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,IAAI,CAAC,QAAQ,SAAS,WAAW;IAChD,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC;IACtC,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,QAAQ,CAAC;CACtC"}

package/src/lib/rule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rule.js.map

package/src/lib/rule.js.map

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

package/src/lib/runners/all.d.ts

@@ -0,0 +1,9 @@
+import { type Rule, type RuleContext } from "../..";
+/**
+ * Runs all the rules that return true for `runIf`.
+ *
+ * @param rules The rules to run.
+ * @returns Rule<TContext>
+ */
+export declare function all<TContext extends RuleContext>(...rules: Array<Rule<TContext>>): Rule<TContext>;
+//# sourceMappingURL=all.d.ts.map

package/src/lib/runners/all.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"all.d.ts","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/all.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,QAAQ,SAAS,WAAW,EAAE,GAAG,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAejG"}

package/src/lib/runners/all.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.all = void 0;
+/**
+ * Runs all the rules that return true for `runIf`.
+ *
+ * @param rules The rules to run.
+ * @returns Rule<TContext>
+ */
+function all(...rules) {
+    return {
+        runIf: function (context) {
+            return rules.some((rule) => rule.runIf(context));
+        },
+        run: function (context) {
+            return rules.reduce((previousContext, rule) => {
+                if (rule.runIf(context)) {
+                    return rule.run(previousContext);
+                }
+                return previousContext;
+            }, context);
+        },
+    };
+}
+exports.all = all;
+//# sourceMappingURL=all.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"all.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/all.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,GAAG,CAA+B,GAAG,KAA4B;IAC/E,OAAO;QACL,KAAK,EAAE,UAAU,OAAO;YACtB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,GAAG,EAAE,UAAU,OAAO;YACpB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE;gBAC5C,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;oBACvB,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;iBAClC;gBAED,OAAO,eAAe,CAAC;YACzB,CAAC,EAAE,OAAO,CAAC,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC;AAfD,kBAeC"}

package/src/lib/runners/first-match.d.ts

@@ -0,0 +1,9 @@
+import { type Rule, type RuleContext } from "../..";
+/**
+ * Runs the first rule that returns true for `runIf`.
+ *
+ * @param rules The rules to run.
+ * @returns A rule that runs the first rule that matches the context.
+ */
+export declare function firstMatch<TContext extends RuleContext>(...rules: Array<Rule<TContext>>): Rule<TContext>;
+//# sourceMappingURL=first-match.d.ts.map

package/src/lib/runners/first-match.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"first-match.d.ts","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/first-match.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,SAAS,WAAW,EACrD,GAAG,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAC9B,IAAI,CAAC,QAAQ,CAAC,CAWhB"}

package/src/lib/runners/first-match.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firstMatch = void 0;
+/**
+ * Runs the first rule that returns true for `runIf`.
+ *
+ * @param rules The rules to run.
+ * @returns A rule that runs the first rule that matches the context.
+ */
+function firstMatch(...rules) {
+    return {
+        runIf: function (context) {
+            return rules.some((rule) => rule.runIf(context));
+        },
+        run: function (context) {
+            const rule = rules.find((rule) => rule.runIf(context));
+            return rule ? rule.run(context) : context;
+        },
+    };
+}
+exports.firstMatch = firstMatch;
+//# sourceMappingURL=first-match.js.map

package/src/lib/runners/first-match.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"first-match.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/first-match.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,GAAG,KAA4B;IAE/B,OAAO;QACL,KAAK,EAAE,UAAU,OAAO;YACtB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,GAAG,EAAE,UAAU,OAAO;YACpB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAEvD,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC;AAbD,gCAaC"}