@clipboard-health/rules-engine 1.1.1 → 1.1.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/rules-engine",
   "description": "",
-  "version": "1.1.1",
+  "version": "1.1.5",
   "bugs": "https://github.com/clipboardhealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.6.3",
@@ -22,5 +22,6 @@
     "embed": "embedme README.md"
   },
   "type": "commonjs",
-  "typings": "./src/index.d.ts"
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
 }

package/src/index.js

@@ -0,0 +1,7 @@
+"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"), 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,wDAA8B"}

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

@@ -0,0 +1,6 @@
+import { type ReadonlyDeep } from "type-fest";
+import { type RuleContext } from "./rule";
+/**
+ * Rule output is immutable, do not modify existing items, only append using this function.
+ */
+export declare function appendOutput<TInput, TOutput>(context: RuleContext<TInput, TOutput>, output: ReadonlyDeep<TOutput>): RuleContext<TInput, TOutput>;

package/src/lib/append-output.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendOutput = appendOutput;
+/**
+ * Rule output is immutable, do not modify existing items, only append using this function.
+ */
+function appendOutput(context, output) {
+    return {
+        input: context.input,
+        output: [...context.output, output],
+    };
+}
+//# 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":";;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.d.ts

@@ -0,0 +1,29 @@
+import { type ReadonlyDeep } from "type-fest";
+export interface RuleContext<TInput, TOutput> {
+    /**
+     * Input is immutable, rules must not modify it.
+     */
+    input: ReadonlyDeep<TInput>;
+    /**
+     * Output is immutable, do not modify existing items, only append.
+     *
+     * @see {@link appendOutput}
+     */
+    output: ReadonlyArray<ReadonlyDeep<TOutput>>;
+}
+export interface Rule<TInput, TOutput, TContext extends RuleContext<TInput, TOutput> = RuleContext<TInput, TOutput>> {
+    /**
+     * Returns whether the rule should run or not.
+     *
+     * Only the `input` and not the full `context` is passed to `runIf`. This prevents rules from
+     * relying on `output`, which may be appended to by previous rules by the time `run` is called.
+     */
+    runIf: (input: ReadonlyDeep<TInput>) => boolean;
+    /**
+     * A pure function that runs rule logic and returns a new context by appending to the output
+     * array.
+     *
+     * @see {@link appendOutput}
+     */
+    run: (context: TContext) => TContext;
+}

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,7 @@
+import { type Rule, type RuleContext } from "../rule";
+/**
+ * Run all rules that return true for `runIf`.
+ *
+ * @param rules The rules to run.
+ */
+export declare function all<TInput, TOutput, TContext extends RuleContext<TInput, TOutput>>(...rules: Array<Rule<TInput, TOutput, TContext>>): Rule<TInput, TOutput, TContext>;

package/src/lib/runners/all.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.all = all;
+/**
+ * Run all rules that return true for `runIf`.
+ *
+ * @param rules The rules to run.
+ */
+function all(...rules) {
+    return {
+        runIf: (input) => rules.some((rule) => rule.runIf(input)),
+        run: (context) => rules
+            .filter((rule) => rule.runIf(context.input))
+            .reduce((previousContext, rule) => rule.run(previousContext), context),
+    };
+}
+//# 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":";;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/first-match.d.ts

@@ -0,0 +1,7 @@
+import { type Rule, type RuleContext } from "../rule";
+/**
+ * Run the first rule that returns true for `runIf`.
+ *
+ * @param rules The rules to run.
+ */
+export declare function firstMatch<TInput, TOutput, TContext extends RuleContext<TInput, TOutput>>(...rules: Array<Rule<TInput, TOutput, TContext>>): Rule<TInput, TOutput, TContext>;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firstMatch = firstMatch;
+/**
+ * Run the first rule that returns true for `runIf`.
+ *
+ * @param rules The rules to run.
+ */
+function firstMatch(...rules) {
+    return {
+        runIf: (input) => rules.some((rule) => rule.runIf(input)),
+        run: (context) => {
+            const rule = rules.find((rule) => rule.runIf(context.input));
+            return rule ? rule.run(context) : context;
+        },
+    };
+}
+//# 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":";;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

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

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

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

package/.eslintrc.json

@@ -1,8 +0,0 @@
-{
-  "extends": ["../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "parserOptions": {
-    "project": "tsconfig.lint.json",
-    "tsconfigRootDir": "packages/rules-engine"
-  }
-}

package/examples/rules.ts

@@ -1,71 +0,0 @@
-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 }]

package/jest.config.ts

@@ -1,19 +0,0 @@
-export default {
-  coverageDirectory: "../../coverage/packages/rules-engine",
-  coveragePathIgnorePatterns: [],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100,
-    },
-  },
-  displayName: "rules-engine",
-  moduleFileExtensions: ["ts", "js"],
-  preset: "../../jest.preset.js",
-  testEnvironment: "node",
-  transform: {
-    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }],
-  },
-};

package/project.json

@@ -1,33 +0,0 @@
-{
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "name": "rules-engine",
-  "projectType": "library",
-  "sourceRoot": "packages/rules-engine/src",
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "options": {
-        "assets": ["packages/rules-engine/*.md"],
-        "main": "packages/rules-engine/src/index.js",
-        "outputPath": "dist/packages/rules-engine",
-        "tsConfig": "packages/rules-engine/tsconfig.lib.json"
-      },
-      "outputs": ["{options.outputPath}"]
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "options": {
-        "lintFilePatterns": ["packages/rules-engine/**/*.[jt]s"],
-        "maxWarnings": 0
-      },
-      "outputs": ["{options.outputFile}"]
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "options": {
-        "jestConfig": "packages/rules-engine/jest.config.ts"
-      }
-    }
-  }
-}

package/src/lib/append-output.ts

@@ -1,16 +0,0 @@
-import { type ReadonlyDeep } from "type-fest";
-
-import { type RuleContext } from "./rule";
-
-/**
- * Rule output is immutable, do not modify existing items, only append using this function.
- */
-export function appendOutput<TInput, TOutput>(
-  context: RuleContext<TInput, TOutput>,
-  output: ReadonlyDeep<TOutput>,
-): RuleContext<TInput, TOutput> {
-  return {
-    input: context.input,
-    output: [...context.output, output],
-  };
-}

package/src/lib/rule.ts

@@ -1,37 +0,0 @@
-import { type ReadonlyDeep } from "type-fest";
-
-export interface RuleContext<TInput, TOutput> {
-  /**
-   * Input is immutable, rules must not modify it.
-   */
-  input: ReadonlyDeep<TInput>;
-
-  /**
-   * Output is immutable, do not modify existing items, only append.
-   *
-   * @see {@link appendOutput}
-   */
-  output: ReadonlyArray<ReadonlyDeep<TOutput>>;
-}
-
-export interface Rule<
-  TInput,
-  TOutput,
-  TContext extends RuleContext<TInput, TOutput> = RuleContext<TInput, TOutput>,
-> {
-  /**
-   * Returns whether the rule should run or not.
-   *
-   * Only the `input` and not the full `context` is passed to `runIf`. This prevents rules from
-   * relying on `output`, which may be appended to by previous rules by the time `run` is called.
-   */
-  runIf: (input: ReadonlyDeep<TInput>) => boolean;
-
-  /**
-   * A pure function that runs rule logic and returns a new context by appending to the output
-   * array.
-   *
-   * @see {@link appendOutput}
-   */
-  run: (context: TContext) => TContext;
-}

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

@@ -1,64 +0,0 @@
-import { type Rule, type RuleContext } from "../..";
-import { appendOutput } from "../append-output";
-import { all } from "./all";
-
-interface Input {
-  a: number;
-  b: number;
-}
-
-type Output = number;
-
-type TestContext = RuleContext<Input, Output>;
-
-type TestRule = Rule<Input, Output>;
-
-const context: TestContext = {
-  input: { a: 1, b: 2 },
-  output: [],
-};
-
-const testRule1: TestRule = {
-  runIf: () => false,
-  run: (context) => appendOutput(context, 1),
-};
-
-const testRule2: TestRule = {
-  runIf: () => true,
-  run: (context) => appendOutput(context, 2),
-};
-
-const testRule3: TestRule = {
-  runIf: () => true,
-  run: (context) => appendOutput(context, 3),
-};
-
-const testRule4: TestRule = {
-  runIf: () => false,
-  run: (context) => appendOutput(context, 4),
-};
-
-describe("all", () => {
-  describe("if", () => {
-    it("returns true if any rules are true", () => {
-      expect(all(testRule1, testRule2, testRule3).runIf(context.input)).toBe(true);
-    });
-
-    it("returns false if all rules are false", () => {
-      expect(all(testRule1, testRule4).runIf(context.input)).toBe(false);
-    });
-  });
-
-  describe("run", () => {
-    it("runs all the matching rules", () => {
-      expect(all(testRule1, testRule2, testRule3, testRule4).run(context)).toEqual({
-        ...context,
-        output: [2, 3],
-      });
-    });
-
-    it("returns the received context if no rule can be run", () => {
-      expect(all(testRule1, testRule4).run(context)).toEqual(context);
-    });
-  });
-});

package/src/lib/runners/all.ts

@@ -1,18 +0,0 @@
-import { type Rule, type RuleContext } from "../rule";
-
-/**
- * Run all rules that return true for `runIf`.
- *
- * @param rules The rules to run.
- */
-export function all<TInput, TOutput, TContext extends RuleContext<TInput, TOutput>>(
-  ...rules: Array<Rule<TInput, TOutput, TContext>>
-): Rule<TInput, TOutput, TContext> {
-  return {
-    runIf: (input) => rules.some((rule) => rule.runIf(input)),
-    run: (context) =>
-      rules
-        .filter((rule) => rule.runIf(context.input))
-        .reduce((previousContext, rule) => rule.run(previousContext), context),
-  };
-}

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

@@ -1,59 +0,0 @@
-import { type Rule, type RuleContext } from "../..";
-import { appendOutput } from "../append-output";
-import { firstMatch } from "./first-match";
-
-interface Input {
-  a: number;
-  b: number;
-}
-
-type Output = number;
-
-type TestContext = RuleContext<Input, Output>;
-
-type TestRule = Rule<Input, Output>;
-
-const context: TestContext = {
-  input: { a: 1, b: 2 },
-  output: [],
-};
-
-const testRule1: TestRule = {
-  runIf: () => false,
-  run: (context) => appendOutput(context, 1),
-};
-
-const testRule2: TestRule = {
-  runIf: () => true,
-  run: (context) => appendOutput(context, 2),
-};
-
-const testRule3: TestRule = {
-  runIf: () => false,
-  run: (context) => appendOutput(context, 3),
-};
-
-describe("firstMatch", () => {
-  describe("if", () => {
-    it("returns true if any rules are true", () => {
-      expect(firstMatch(testRule1, testRule2, testRule3).runIf(context.input)).toBe(true);
-    });
-
-    it("returns false if all rules are false", () => {
-      expect(firstMatch(testRule3).runIf(context.input)).toBe(false);
-    });
-  });
-
-  describe("run", () => {
-    it("runs the first matching rule", () => {
-      expect(firstMatch(testRule1, testRule2, testRule3).run(context)).toEqual({
-        ...context,
-        output: [2],
-      });
-    });
-
-    it("returns the received context if no rule can be run", () => {
-      expect(firstMatch(testRule1, testRule3).run(context)).toEqual(context);
-    });
-  });
-});

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

@@ -1,18 +0,0 @@
-import { type Rule, type RuleContext } from "../rule";
-
-/**
- * Run the first rule that returns true for `runIf`.
- *
- * @param rules The rules to run.
- */
-export function firstMatch<TInput, TOutput, TContext extends RuleContext<TInput, TOutput>>(
-  ...rules: Array<Rule<TInput, TOutput, TContext>>
-): Rule<TInput, TOutput, TContext> {
-  return {
-    runIf: (input) => rules.some((rule) => rule.runIf(input)),
-    run: (context) => {
-      const rule = rules.find((rule) => rule.runIf(context.input));
-      return rule ? rule.run(context) : context;
-    },
-  };
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc"
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.lint.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.lint.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": ["."]
-}

package/tsconfig.spec.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}

package/typedoc.json

@@ -1,4 +0,0 @@
-{
-  "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
-}