@clipboard-health/rules-engine 1.16.6 → 1.16.7

package/README.md

@@ -25,6 +25,7 @@ import { deepEqual } from "node:assert/strict";
 
 import {
   all,
+  allIf,
   appendOutput,
   firstMatch,
   type Rule,
@@ -89,6 +90,17 @@ const firstMatchResult = firstMatch(
 ).run(exampleContext);
 
 deepEqual(firstMatchResult.output, [{ result: 7 }]);
+
+// Using allIf() applies all the rules that return true for `runIf` to the context when the predicate
+// (a function received as firs argument) returns true
+const allIfResult = allIf(
+  (input) => input.a === 2,
+  divideNumbersIfNegative,
+  addNumbersIfPositiveRule,
+  multiplyNumbersIfPositiveRule,
+).run(exampleContext);
+
+deepEqual(allIfResult.output, [{ result: 7 }, { result: 10 }]);
 ```
 
 </embedex>

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@clipboard-health/rules-engine",
   "description": "A pure functional rules engine to keep logic-dense code simple, reliable, understandable, and explainable.",
-  "version": "1.16.6",
+  "version": "1.16.7",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.0",
-    "type-fest": "4.32.0"
+    "type-fest": "4.33.0"
   },
   "keywords": [
     "engine",

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

@@ -0,0 +1,16 @@
+import { type Rule, type RuleContext } from "../rule";
+/**
+ * Run all rules that return true for their runIf condition, but only when the predicate function returns true.
+ *
+ * @param allIfPredicate - Function that determines if rules should be evaluated
+ * @param rules - Array of rules to evaluate when predicate is true
+ * @returns A Rule that combines the behavior of all matching rules
+ *
+ * @example
+ * const rule = allIf(
+ *   (input) => input.type === 'special',
+ *   rule1,
+ *   rule2
+ * );
+ */
+export declare function allIf<TInput, TOutput, TContext extends RuleContext<TInput, TOutput>>(allIfPredicate: (input: RuleContext<TInput, TOutput>["input"]) => boolean, ...rules: Array<Rule<TInput, TOutput, TContext>>): Rule<TInput, TOutput, TContext>;

package/src/lib/runners/allIf.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allIf = allIf;
+/**
+ * Run all rules that return true for their runIf condition, but only when the predicate function returns true.
+ *
+ * @param allIfPredicate - Function that determines if rules should be evaluated
+ * @param rules - Array of rules to evaluate when predicate is true
+ * @returns A Rule that combines the behavior of all matching rules
+ *
+ * @example
+ * const rule = allIf(
+ *   (input) => input.type === 'special',
+ *   rule1,
+ *   rule2
+ * );
+ */
+function allIf(allIfPredicate, ...rules) {
+    return {
+        runIf: (input) => allIfPredicate(input),
+        run: (context) => rules
+            .filter((rule) => rule.runIf(context.input))
+            .reduce((previousContext, rule) => rule.run(previousContext), context),
+    };
+}
+//# sourceMappingURL=allIf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"allIf.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/allIf.ts"],"names":[],"mappings":";;AAgBA,sBAWC;AAzBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,KAAK,CACnB,cAAyE,EACzE,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC;QACvC,GAAG,EAAE,CAAC,OAAiB,EAAE,EAAE,CACzB,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/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./all";
+export * from "./allIf";
 export * from "./firstMatch";

package/src/lib/runners/index.js

@@ -2,5 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./all"), exports);
+tslib_1.__exportStar(require("./allIf"), exports);
 tslib_1.__exportStar(require("./firstMatch"), exports);
 //# sourceMappingURL=index.js.map

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

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

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

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

package/src/lib/runners/allIfFirst.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.allIfFirst = allIfFirst;
-/**
- * Run all rules that return true for `runIf` only if the first rule returns true.
- *
- * @param rules The rules to run.
- */
-function allIfFirst(...rules) {
-    return {
-        runIf: (input) => Boolean(rules[0]?.runIf(input)),
-        run: (context) => rules
-            .filter((rule) => rule.runIf(context.input))
-            .reduce((previousContext, rule) => rule.run(previousContext), context),
-    };
-}
-//# sourceMappingURL=allIfFirst.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"allIfFirst.js","sourceRoot":"","sources":["../../../../../../packages/rules-engine/src/lib/runners/allIfFirst.ts"],"names":[],"mappings":";;AAOA,gCAUC;AAfD;;;;GAIG;AACH,SAAgB,UAAU,CACxB,GAAG,KAA6C;IAEhD,OAAO;QACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QACjD,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"}