@clipboard-health/rules-engine 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.1.3](https://github.com/ClipboardHealth/cbh-core/compare/rules-engine-0.1.2...rules-engine-0.1.3) (2024-07-11)
+
+## [0.1.3](https://github.com/ClipboardHealth/cbh-core/compare/rules-engine-0.1.2...rules-engine-0.1.3) (2024-07-11)
+
+## [0.1.2](https://github.com/ClipboardHealth/cbh-core/compare/rules-engine-0.1.1...rules-engine-0.1.2) (2024-02-27)
+
+
+### Bug Fixes
+
+* **deps:** update dependency type-fest to v4 ([#531](https://github.com/ClipboardHealth/cbh-core/issues/531)) ([f366907](https://github.com/ClipboardHealth/cbh-core/commit/f36690743f2373fc6c62a589a6b50fa7f660bbae))
+
 ## [0.1.1](https://github.com/ClipboardHealth/cbh-core/compare/rules-engine-0.1.0...rules-engine-0.1.1) (2023-12-22)
 
 ## 0.1.0 (2023-12-20)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/rules-engine",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "main": "./src/index.js",
   "scripts": {
     "build": "nx build rules-engine",
@@ -9,7 +9,7 @@
     "test": "nx test rules-engine"
   },
   "dependencies": {
-    "type-fest": "4.8.3"
+    "type-fest": "4.10.3"
   },
   "type": "commonjs"
 }

package/src/lib/rule.d.ts

@@ -16,11 +16,12 @@ export interface Rule<TInput, TOutput, TContext extends RuleContext<TInput, TOut
      * 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 modified by previous rules by the time `run` is called.
+     * relying on `output`, which may be appended to by previous rules by the time `run` is called.
      */
     runIf: (input: ReadonlyDeep<TInput>) => boolean;
     /**
-     * Runs the actual rule and returns a new context by appending to the output array.
+     * A pure function that runs rule logic and returns a new context by appending to the output
+     * array.
      *
      * @see {@link appendOutput}
      */

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

@@ -1 +1 @@
-{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,MAAM,WAAW,WAAW,CAAC,MAAM,EAAE,OAAO;IAC1C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,IAAI,CACnB,MAAM,EACN,OAAO,EACP,QAAQ,SAAS,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC;IAE5E;;;;;OAKG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC;IAEhD;;;;OAIG;IACH,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,QAAQ,CAAC;CACtC"}
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../../../packages/rules-engine/src/lib/rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,MAAM,WAAW,WAAW,CAAC,MAAM,EAAE,OAAO;IAC1C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,IAAI,CACnB,MAAM,EACN,OAAO,EACP,QAAQ,SAAS,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC;IAE5E;;;;;OAKG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC;IAEhD;;;;;OAKG;IACH,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,QAAQ,CAAC;CACtC"}