@augment-vir/assert 31.71.0 → 31.71.2

package/dist/assertions/values.d.ts

@@ -1,7 +1,17 @@
-import { type AnyObject, type MaybePromise, type NarrowToActual, type NarrowToExpected, type Values } from '@augment-vir/core';
+import { type AnyObject, type ArrayElement, type MaybePromise, type NarrowToActual, type NarrowToExpected, type Values } from '@augment-vir/core';
 import { type EmptyObject } from 'type-fest';
 import { type WaitUntilOptions } from '../guard-types/wait-until-function.js';
-export declare function isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent): child is Values<Parent>;
+/**
+ * Extracts the child value type from a parent passed to `isIn`/`isNotIn` style guards. Uses
+ * `ArrayElement` for arrays and tuples so that array-only properties like `length` are not leaked
+ * as candidate values, and `Values` for everything else.
+ *
+ * @category Assert : Util
+ * @category Package : @augment-vir/assert
+ * @package [`@augment-vir/assert`](https://www.npmjs.com/package/@augment-vir/assert)
+ */
+export type ChildOf<Parent> = Parent extends ReadonlyArray<unknown> ? ArrayElement<Parent> : Values<Parent>;
+export declare function isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent): child is ChildOf<Parent>;
 /**
  * All types that can be checked for emptiness. The empty variants of these types are represented in
  * {@link Empty}.
@@ -165,7 +175,7 @@ export declare const valueGuards: {
          * @see
          * - {@link assert.isNotIn} : the opposite assertion.
          */
-        isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent, failureMessage?: string | undefined): asserts child is Values<Parent>;
+        isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent, failureMessage?: string | undefined): asserts child is ChildOf<Parent>;
         /**
          * Asserts that child value is _not_ contained within a parent object, array, or string through
          * reference equality.
@@ -191,7 +201,7 @@ export declare const valueGuards: {
          * @see
          * - {@link assert.isIn} : the opposite assertion.
          */
-        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): asserts child is Exclude<Child, Values<Parent>>;
+        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): asserts child is Exclude<Child, ChildOf<Parent>>;
         /**
          * Asserts that a value is empty. Supports strings, Maps, Sets, objects, and arrays.
          *
@@ -377,7 +387,7 @@ export declare const valueGuards: {
          * @see
          * - {@link check.isNotIn} : the opposite check.
          */
-        isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent): child is Values<Parent>;
+        isIn<Parent extends object | string>(this: void, child: unknown, parent: Parent): child is ChildOf<Parent>;
         /**
          * Checks that child value is _not_ contained within a parent object, array, or string
          * through reference equality.
@@ -402,7 +412,7 @@ export declare const valueGuards: {
          * @see
          * - {@link check.isIn} : the opposite check.
          */
-        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): child is Exclude<Child, Values<Parent>>;
+        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): child is Exclude<Child, ChildOf<Parent>>;
         /**
          * Checks that a value is empty. Supports strings, Maps, Sets, objects, and arrays.
          *
@@ -598,7 +608,7 @@ export declare const valueGuards: {
          * @see
          * - {@link assertWrap.isNotIn} : the opposite assertion.
          */
-        isIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): Extract<Child, Values<Parent>>;
+        isIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): Extract<Child, ChildOf<Parent>>;
         /**
          * Asserts that child value is _not_ contained within a parent object, array, or string
          * through reference equality. Returns the child value if the assertion passes.
@@ -625,7 +635,7 @@ export declare const valueGuards: {
          * @see
          * - {@link assertWrap.isIn} : the opposite assertion.
          */
-        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): Exclude<Child, Values<Parent>>;
+        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent, failureMessage?: string | undefined): Exclude<Child, ChildOf<Parent>>;
         /**
          * Asserts that a value is empty. Supports strings, Maps, Sets, objects, and arrays. Returns
          * the value if the assertion passes.
@@ -815,7 +825,7 @@ export declare const valueGuards: {
          * @see
          * - {@link checkWrap.isNotIn} : the opposite check.
          */
-        isIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): Extract<Child, Values<Parent>> | undefined;
+        isIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): Extract<Child, ChildOf<Parent>> | undefined;
         /**
          * Checks that child value is _not_ contained within a parent object, array, or string
          * through reference equality.
@@ -840,7 +850,7 @@ export declare const valueGuards: {
          * @see
          * - {@link checkWrap.isIn} : the opposite check.
          */
-        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): Exclude<Child, Values<Parent>> | undefined;
+        isNotIn<Parent extends object | string, Child>(this: void, child: Child, parent: Parent): Exclude<Child, ChildOf<Parent>> | undefined;
         /**
          * Checks that a value is empty. Supports strings, Maps, Sets, objects, and arrays.
          *
@@ -1074,7 +1084,7 @@ export declare const valueGuards: {
          * @see
          * - {@link waitUntil.isNotIn} : the opposite assertion.
          */
-        isIn: <Child, Parent>(this: void, parent: Parent, callback: () => MaybePromise<Child>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Child, Values<Parent>>>;
+        isIn: <Child, Parent>(this: void, parent: Parent, callback: () => MaybePromise<Child>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Child, ChildOf<Parent>>>;
         /**
          * Repeatedly calls a callback until its output is child value is _not_ contained within a
          * parent object, array, or string through reference equality. Once the callback output
@@ -1102,7 +1112,7 @@ export declare const valueGuards: {
          * @see
          * - {@link waitUntil.isIn} : the opposite assertion.
          */
-        isNotIn: <Child, Parent>(this: void, parent: Parent, callback: () => MaybePromise<Child>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Child, Values<Parent>>>;
+        isNotIn: <Child, Parent>(this: void, parent: Parent, callback: () => MaybePromise<Child>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Child, ChildOf<Parent>>>;
         /**
          * Repeatedly calls a callback until its output is a value is empty. Supports strings, Maps,
          * Sets, objects, and arrays. Once the callback output passes, it is returned. If the

package/dist/assertions/values.js

@@ -1,21 +1,28 @@
 import { stringify, } from '@augment-vir/core';
 import { AssertionError } from '../augments/assertion.error.js';
 import { createWaitUntil } from '../guard-types/wait-until-function.js';
+/**
+ * Returns the own enumerable values of `parent`. For arrays, returns the elements directly so that
+ * array-only properties like `length` are not treated as values. Throws if `Reflect.ownKeys` fails
+ * on the input.
+ */
+function getOwnValues(parent) {
+    if (Array.isArray(parent)) {
+        return parent;
+    }
+    return Reflect.ownKeys(parent).map((key) => parent[key]);
+}
 function hasValue(parent, value) {
     if (typeof parent === 'string') {
         return typeof value === 'string' && parent.includes(value);
     }
     /** Wrap this in a try/catch because `Reflect.ownKeys` can fail depending on what its input is. */
-    let hasValue = true;
     try {
-        hasValue = Reflect.ownKeys(parent)
-            .map((key) => parent[key])
-            .includes(value);
+        return getOwnValues(parent).includes(value);
     }
     catch {
         return false;
     }
-    return hasValue;
 }
 export function isIn(child, parent) {
     if (typeof parent === 'string') {
@@ -125,7 +132,7 @@ const assertions = {
         }
         else {
             try {
-                const actualValues = Reflect.ownKeys(parent).map((key) => parent[key]);
+                const actualValues = getOwnValues(parent);
                 missingValues = values.filter((value) => {
                     return !actualValues.includes(value);
                 });
@@ -180,7 +187,7 @@ const assertions = {
         }
         else {
             try {
-                const actualValues = Reflect.ownKeys(parent).map((key) => parent[key]);
+                const actualValues = getOwnValues(parent);
                 includedValues = values.filter((value) => {
                     return actualValues.includes(value);
                 });
@@ -715,7 +722,7 @@ export const valueGuards = {
             }
             else {
                 try {
-                    const actualValues = Reflect.ownKeys(parent).map((key) => parent[key]);
+                    const actualValues = getOwnValues(parent);
                     missingValues = values.filter((value) => {
                         return !actualValues.includes(value);
                     });
@@ -772,7 +779,7 @@ export const valueGuards = {
             }
             else {
                 try {
-                    const actualValues = Reflect.ownKeys(parent).map((key) => parent[key]);
+                    const actualValues = getOwnValues(parent);
                     includedValues = values.filter((value) => {
                         return actualValues.includes(value);
                     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/assert",
-    "version": "31.71.0",
+    "version": "31.71.2",
     "description": "A collection of assertions for test and production code alike.",
     "keywords": [
         "augment",
@@ -42,7 +42,7 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/core": "^31.71.0",
+        "@augment-vir/core": "^31.71.2",
         "@date-vir/duration": "^8.3.2",
         "deep-eql": "^5.0.2",
         "expect-type": "^1.3.0",