Adds missingIf support to hasKeyRelationship

package.json

@@ -2,7 +2,7 @@
   "name": "typanion",
   "description": "Simple runtime TypeScript validator library",
   "homepage": "https://mael.dev/typanion/",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "main": "sources/index",
   "license": "MIT",
   "sideEffects": false,

sources/predicates/helperPredicates.ts

@@ -248,12 +248,9 @@ const keyRelationships = {
  * Create a validator that checks that, when the specified subject property is
  * set, the relationship is satisfied.
  */
-export function hasKeyRelationship(subject: string, relationship: KeyRelationship, others: string[], {
-  ignore = [],
-}: {
-  ignore?: any[],
-} = {}) {
-  const skipped = new Set(ignore);
+export function hasKeyRelationship(subject: string, relationship: KeyRelationship, others: string[], options?: { ignore?: any[], missingIf?: MissingType }) {
+  const skipped = new Set(options?.ignore ?? []);
+  const check = checks[options?.missingIf ?? 'missing'];
 
   const otherSet = new Set(others);
   const spec = keyRelationships[relationship];
@@ -265,12 +262,12 @@ export function hasKeyRelationship(subject: string, relationship: KeyRelationshi
   return makeValidator<{[key: string]: unknown}>({
     test: (value, state) => {
       const keys = new Set(Object.keys(value));
-      if (!keys.has(subject) || skipped.has(value[subject]))
+      if (!check(keys, subject, value) || skipped.has(value[subject]))
         return true;
 
       const problems: string[] = [];
       for (const key of otherSet)
-        if ((keys.has(key) && !skipped.has(value[key])) !== spec.expect)
+        if ((check(keys, key, value) && !skipped.has(value[key])) !== spec.expect)
           problems.push(key);
 
       if (problems.length >= 1)

tests/index.test.ts

@@ -508,6 +508,17 @@ const ERROR_TESTS: {
     [{foo: 42, bar: false, baz: 42}, [`.: Property "foo" forbids using property "baz"`]],
     [{foo: 42, qux: 42}, []],
   ],
+}, {
+  validator: () => t.cascade(t.isRecord(t.isUnknown()), [t.hasKeyRelationship(`foo`, t.KeyRelationship.Forbids, [`bar`, `baz`], {missingIf: `falsy`})]),
+  tests: [
+    [{foo: 42}, []],
+    [{bar: 42}, []],
+    [{foo: false, bar: 42}, []],
+    [{foo: 42, bar: false}, []],
+    [{foo: 42, bar: false, baz: false}, []],
+    [{foo: 42, bar: false, baz: 42}, [`.: Property "foo" forbids using property "baz"`]],
+    [{foo: 42, qux: 42}, []],
+  ],
 }, {
   validator: () => t.cascade(t.isRecord(t.isUnknown()), [t.hasKeyRelationship(`foo`, t.KeyRelationship.Requires, [`bar`, `baz`])]),
   tests: [