@augment-vir/common 6.1.1 → 6.1.3

package/dist/cjs/augments/object.d.ts

@@ -45,6 +45,9 @@ export declare function matchesObjectShape<MatchThisGeneric extends object>(test
 export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
     [Prop in keyof BaseObject]: BaseObject[Prop] extends ReadonlyArray<any> ? AtLeastOneEntryArray<BaseObject[Prop]> : BaseObject[Prop] extends object ? ObjectWithAtLeastSingleEntryArrays<BaseObject[Prop]> : BaseObject[Prop];
 };
+type NestedBoolean<MatchObject extends object> = Partial<{
+    [Prop in keyof MatchObject]: MatchObject[Prop] extends object ? NestedBoolean<MatchObject[Prop]> | boolean : boolean;
+}>;
 /**
  * Asserts that the first input, testThisOne, matches the object shape of the second input,
  * compareToThisOne. Does not compare exact values of properties, only types.
@@ -58,7 +61,7 @@ export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
  * that exists. If more array values are present, they will be considered other possible types for
  * entries in that array.
  */
-export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean): asserts testThisOne is MatchThisGeneric;
+export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean, noCheckInnerValueOfTheseKeys?: NestedBoolean<typeof compareToThisOne>): asserts testThisOne is MatchThisGeneric;
 export declare function typedObjectFromEntries<KeyType extends PropertyKey, ValueType>(entries: ReadonlyArray<Readonly<[KeyType, ValueType]>>): Record<KeyType, ValueType>;
 export {};
 //# sourceMappingURL=object.d.ts.map

package/dist/cjs/augments/object.js

@@ -199,7 +199,7 @@ exports.matchesObjectShape = matchesObjectShape;
  * that exists. If more array values are present, they will be considered other possible types for
  * entries in that array.
  */
-function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false) {
+function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, noCheckInnerValueOfTheseKeys = {}) {
     const testKeys = getObjectTypedKeys(testThisOne);
     const matchKeys = new Set(getObjectTypedKeys(compareToThisOne));
     if (!allowExtraProps) {
@@ -209,6 +209,7 @@ function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps
         }
     }
     matchKeys.forEach((key) => {
+        var _a;
         if (!typedHasProperty(testThisOne, key)) {
             throw new Error(`test object does not have key "${String(key)}" from expected shape.`);
         }
@@ -217,11 +218,13 @@ function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps
         }
         const testValue = testThisOne[key];
         const shouldMatch = compareToThisOne[key];
-        compareInnerValue(testValue, shouldMatch, throwKeyError);
+        if (!noCheckInnerValueOfTheseKeys[key]) {
+            compareInnerValue(testValue, shouldMatch, throwKeyError, allowExtraProps, (_a = noCheckInnerValueOfTheseKeys[key]) !== null && _a !== void 0 ? _a : {});
+        }
     });
 }
 exports.assertMatchesObjectShape = assertMatchesObjectShape;
-function compareInnerValue(testValue, matchValue, throwKeyError) {
+function compareInnerValue(testValue, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys) {
     var _a;
     const testType = typeof testValue;
     const shouldMatchType = typeof matchValue;
@@ -250,7 +253,7 @@ function compareInnerValue(testValue, matchValue, throwKeyError) {
             const errors = matchValue
                 .map((matchValue) => {
                 try {
-                    compareInnerValue(testValueEntry, matchValue, throwKeyError);
+                    compareInnerValue(testValueEntry, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys);
                     return undefined;
                 }
                 catch (error) {
@@ -264,7 +267,7 @@ function compareInnerValue(testValue, matchValue, throwKeyError) {
         });
     }
     else if (isObject(matchValue)) {
-        assertMatchesObjectShape(testValue, matchValue);
+        assertMatchesObjectShape(testValue, matchValue, allowExtraProps, noCheckInnerValueOfTheseKeys);
     }
 }
 function typedObjectFromEntries(entries) {

package/dist/esm/augments/object.d.ts

@@ -45,6 +45,9 @@ export declare function matchesObjectShape<MatchThisGeneric extends object>(test
 export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
     [Prop in keyof BaseObject]: BaseObject[Prop] extends ReadonlyArray<any> ? AtLeastOneEntryArray<BaseObject[Prop]> : BaseObject[Prop] extends object ? ObjectWithAtLeastSingleEntryArrays<BaseObject[Prop]> : BaseObject[Prop];
 };
+type NestedBoolean<MatchObject extends object> = Partial<{
+    [Prop in keyof MatchObject]: MatchObject[Prop] extends object ? NestedBoolean<MatchObject[Prop]> | boolean : boolean;
+}>;
 /**
  * Asserts that the first input, testThisOne, matches the object shape of the second input,
  * compareToThisOne. Does not compare exact values of properties, only types.
@@ -58,7 +61,7 @@ export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
  * that exists. If more array values are present, they will be considered other possible types for
  * entries in that array.
  */
-export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean): asserts testThisOne is MatchThisGeneric;
+export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean, noCheckInnerValueOfTheseKeys?: NestedBoolean<typeof compareToThisOne>): asserts testThisOne is MatchThisGeneric;
 export declare function typedObjectFromEntries<KeyType extends PropertyKey, ValueType>(entries: ReadonlyArray<Readonly<[KeyType, ValueType]>>): Record<KeyType, ValueType>;
 export {};
 //# sourceMappingURL=object.d.ts.map

package/dist/esm/augments/object.js

@@ -180,7 +180,7 @@ export function matchesObjectShape(testThisOne, compareToThisOne, allowExtraProp
  * that exists. If more array values are present, they will be considered other possible types for
  * entries in that array.
  */
-export function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false) {
+export function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, noCheckInnerValueOfTheseKeys = {}) {
     const testKeys = getObjectTypedKeys(testThisOne);
     const matchKeys = new Set(getObjectTypedKeys(compareToThisOne));
     if (!allowExtraProps) {
@@ -190,6 +190,7 @@ export function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExt
         }
     }
     matchKeys.forEach((key) => {
+        var _a;
         if (!typedHasProperty(testThisOne, key)) {
             throw new Error(`test object does not have key "${String(key)}" from expected shape.`);
         }
@@ -198,10 +199,12 @@ export function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExt
         }
         const testValue = testThisOne[key];
         const shouldMatch = compareToThisOne[key];
-        compareInnerValue(testValue, shouldMatch, throwKeyError);
+        if (!noCheckInnerValueOfTheseKeys[key]) {
+            compareInnerValue(testValue, shouldMatch, throwKeyError, allowExtraProps, (_a = noCheckInnerValueOfTheseKeys[key]) !== null && _a !== void 0 ? _a : {});
+        }
     });
 }
-function compareInnerValue(testValue, matchValue, throwKeyError) {
+function compareInnerValue(testValue, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys) {
     var _a;
     const testType = typeof testValue;
     const shouldMatchType = typeof matchValue;
@@ -230,7 +233,7 @@ function compareInnerValue(testValue, matchValue, throwKeyError) {
             const errors = matchValue
                 .map((matchValue) => {
                 try {
-                    compareInnerValue(testValueEntry, matchValue, throwKeyError);
+                    compareInnerValue(testValueEntry, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys);
                     return undefined;
                 }
                 catch (error) {
@@ -244,7 +247,7 @@ function compareInnerValue(testValue, matchValue, throwKeyError) {
         });
     }
     else if (isObject(matchValue)) {
-        assertMatchesObjectShape(testValue, matchValue);
+        assertMatchesObjectShape(testValue, matchValue, allowExtraProps, noCheckInnerValueOfTheseKeys);
     }
 }
 export function typedObjectFromEntries(entries) {

package/dist/types/augments/object.d.ts

@@ -45,6 +45,9 @@ export declare function matchesObjectShape<MatchThisGeneric extends object>(test
 export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
     [Prop in keyof BaseObject]: BaseObject[Prop] extends ReadonlyArray<any> ? AtLeastOneEntryArray<BaseObject[Prop]> : BaseObject[Prop] extends object ? ObjectWithAtLeastSingleEntryArrays<BaseObject[Prop]> : BaseObject[Prop];
 };
+type NestedBoolean<MatchObject extends object> = Partial<{
+    [Prop in keyof MatchObject]: MatchObject[Prop] extends object ? NestedBoolean<MatchObject[Prop]> | boolean : boolean;
+}>;
 /**
  * Asserts that the first input, testThisOne, matches the object shape of the second input,
  * compareToThisOne. Does not compare exact values of properties, only types.
@@ -58,7 +61,7 @@ export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
  * that exists. If more array values are present, they will be considered other possible types for
  * entries in that array.
  */
-export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean): asserts testThisOne is MatchThisGeneric;
+export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean, noCheckInnerValueOfTheseKeys?: NestedBoolean<typeof compareToThisOne>): asserts testThisOne is MatchThisGeneric;
 export declare function typedObjectFromEntries<KeyType extends PropertyKey, ValueType>(entries: ReadonlyArray<Readonly<[KeyType, ValueType]>>): Record<KeyType, ValueType>;
 export {};
 //# sourceMappingURL=object.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "6.1.1",
+    "version": "6.1.3",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"