@xylabs/vitest-matchers 5.0.94 → 5.0.96

package/README.md

@@ -1,43 +1,52 @@
 # @xylabs/vitest-matchers
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
-## Reference
+```sh
+yarn add {{name}}
+```
 
-**@xylabs/vitest-matchers**
+Using pnpm:
 
-***
+```sh
+pnpm add {{name}}
+```
 
-## Interfaces
+Using bun:
 
-| Interface | Description |
-| ------ | ------ |
-| [ExpectationResult](#interfaces/ExpectationResult) | Result returned by a custom matcher function. |
+```sh
+bun add {{name}}
+```
 
-## Variables
 
-| Variable | Description |
-| ------ | ------ |
-| [matchers](#variables/matchers) | Collection of custom Vitest matchers extending the built-in `expect` assertions. |
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
 
-### interfaces
+  ### vitest-matchers
 
-  ### <a id="ExpectationResult"></a>ExpectationResult
+    ### .temp-typedoc
+
+      ### interfaces
+
+        ### <a id="ExpectationResult"></a>ExpectationResult
 
 [**@xylabs/vitest-matchers**](#../README)
 
@@ -47,121 +56,578 @@ Result returned by a custom matcher function.
 
 ## Properties
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="actual"></a> `actual?` | `unknown` | The actual value received by the matcher. |
-| <a id="expected"></a> `expected?` | `unknown` | The expected value the matcher compared against. |
-| <a id="message"></a> `message` | () => `string` | Returns a human-readable failure or negation message. |
-| <a id="pass"></a> `pass` | `boolean` | Whether the matcher assertion passed. |
+### actual?
+
+```ts
+optional actual?: unknown;
+```
+
+The actual value received by the matcher.
+
+***
 
-### variables
+### expected?
 
-  ### <a id="matchers"></a>matchers
+```ts
+optional expected?: unknown;
+```
+
+The expected value the matcher compared against.
+
+***
+
+### message
+
+```ts
+message: () => string;
+```
+
+Returns a human-readable failure or negation message.
+
+### Returns
+
+`string`
+
+***
+
+### pass
+
+```ts
+pass: boolean;
+```
+
+Whether the matcher assertion passed.
+
+      ### variables
+
+        ### <a id="matchers"></a>matchers
 
 [**@xylabs/vitest-matchers**](#../README)
 
 ***
 
 ```ts
-const matchers: {
-  toBeArrayOfSize: ExpectationResult;
-  toBeArray: ExpectationResult;
-  toBeOneOf: ExpectationResult;
-  toBeNegative: ExpectationResult;
-  toBePositive: ExpectationResult;
-  toBeNumber: (received: unknown) => ExpectationResult;
-  toBeFunction: (received: unknown) => ExpectationResult;
-  toBeString: (received: unknown) => ExpectationResult;
-  toBeObject: ExpectationResult;
-  toBeInteger: ExpectationResult;
-  toBeFalse: ExpectationResult;
-  toBeTrue: ExpectationResult;
-  toContainAllValues: {
-     pass: boolean;
-     message: () => string;
-  };
-  toContainKey: {
-     pass: boolean;
-     message: () => string;
-  };
-  toInclude: {
-     pass: boolean;
-     message: () => string;
-  };
-  toIncludeAllMembers: ExpectationResult;
-  toContainAllKeys: ExpectationResult;
-  toContainValues: ExpectationResult;
-  toBeEmpty: ExpectationResult;
-  toBeValidDate: {
-     pass: boolean;
-     message: () => string;
-  };
-};
+const matchers: object;
 ```
 
 Collection of custom Vitest matchers extending the built-in `expect` assertions.
 
 ## Type Declaration
 
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| `toBeArrayOfSize()` | (`received`: `unknown`, `expectedSize`: `number`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is an array with the specified length. |
-| `toBeArray()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is an array. |
-| `toBeOneOf()` | (`received`: `unknown`, `expected`: `unknown`[]) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is one of the values in the expected array. |
-| `toBeNegative()` | (`received`: `number`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received number is negative (less than zero). |
-| `toBePositive()` | (`received`: `number`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received number is positive (greater than zero). |
-| <a id="property-tobenumber"></a> `toBeNumber()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is of type `number` and not NaN. |
-| <a id="property-tobefunction"></a> `toBeFunction()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is of type `function`. |
-| <a id="property-tobestring"></a> `toBeString()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is of type `string`. |
-| `toBeObject()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is a plain object (not an array or null). |
-| `toBeInteger()` | (`received`: `number`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received number is an integer. |
-| `toBeFalse()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is strictly `false`. |
-| `toBeTrue()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is strictly `true`. |
-| `toContainAllValues()` | (`received`: `unknown`, `expectedValues`: `unknown`[]) => \{ `pass`: `boolean`; `message`: () => `string`; \} | Asserts that all expected values are present in the received array or object values. |
-| `toContainKey()` | (`received`: `object`, `key`: `string`) => \{ `pass`: `boolean`; `message`: () => `string`; \} | Asserts that the received object contains the specified key. |
-| `toInclude()` | (`received`: `unknown`, `value`: `any`) => \{ `pass`: `boolean`; `message`: () => `string`; \} | Asserts that the received array, string, or object values include the specified value. |
-| `toIncludeAllMembers()` | (`received`: `unknown`[], `expected`: `unknown`[]) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts that the received array includes all members of the expected array. |
-| `toContainAllKeys()` | (`received`: `object`, `expectedKeys`: `string`[]) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts that the received object contains all of the specified keys. |
-| `toContainValues()` | (`received`: `object`, `expectedValues`: `unknown`[]) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts that the received object contains all of the specified values (using deep equality). |
-| `toBeEmpty()` | (`received`: `unknown`) => [`ExpectationResult`](#../interfaces/ExpectationResult) | Asserts the received value is empty (zero-length array/string, empty object, or empty Map/Set). |
-| `toBeValidDate()` | (`received`: `unknown`) => \{ `pass`: `boolean`; `message`: () => `string`; \} | Asserts the received value is a valid Date instance (not an invalid date). |
-
-
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
+### toBeArrayOfSize()
 
-## License
+```ts
+toBeArrayOfSize(received, expectedSize): ExpectationResult;
+```
 
-> See the [LICENSE](LICENSE) file for license details
+Asserts the received value is an array with the specified length.
 
-## Credits
+### Parameters
 
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+#### received
 
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+`unknown`
 
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/vitest-matchers.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/vitest-matchers
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+The value to check.
+
+#### expectedSize
+
+`number`
+
+The expected array length.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeArray()
+
+```ts
+toBeArray(received): ExpectationResult;
+```
+
+Asserts the received value is an array.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeOneOf()
+
+```ts
+toBeOneOf(received, expected): ExpectationResult;
+```
+
+Asserts the received value is one of the values in the expected array.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+#### expected
+
+`unknown`[]
+
+The array of acceptable values.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeNegative()
+
+```ts
+toBeNegative(received): ExpectationResult;
+```
+
+Asserts the received number is negative (less than zero).
+
+### Parameters
+
+#### received
+
+`number`
+
+The number to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBePositive()
+
+```ts
+toBePositive(received): ExpectationResult;
+```
+
+Asserts the received number is positive (greater than zero).
+
+### Parameters
+
+#### received
+
+`number`
+
+The number to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeNumber
+
+```ts
+toBeNumber: (received) => ExpectationResult;
+```
+
+Asserts the received value is of type `number` and not NaN.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeFunction
+
+```ts
+toBeFunction: (received) => ExpectationResult;
+```
+
+Asserts the received value is of type `function`.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeString
+
+```ts
+toBeString: (received) => ExpectationResult;
+```
+
+Asserts the received value is of type `string`.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeObject()
+
+```ts
+toBeObject(received): ExpectationResult;
+```
+
+Asserts the received value is a plain object (not an array or null).
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeInteger()
+
+```ts
+toBeInteger(received): ExpectationResult;
+```
+
+Asserts the received number is an integer.
+
+### Parameters
+
+#### received
+
+`number`
+
+The number to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeFalse()
+
+```ts
+toBeFalse(received): ExpectationResult;
+```
+
+Asserts the received value is strictly `false`.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
 
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/vitest-matchers
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/vitest-matchers
+### Returns
 
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/vitest-matchers/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/vitest-matchers
+[`ExpectationResult`](#../interfaces/ExpectationResult)
 
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/vitest-matchers
-[socket-link]: https://socket.dev/npm/package/@xylabs/vitest-matchers
+### toBeTrue()
+
+```ts
+toBeTrue(received): ExpectationResult;
+```
+
+Asserts the received value is strictly `true`.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toContainAllValues()
+
+```ts
+toContainAllValues(received, expectedValues): object;
+```
+
+Asserts that all expected values are present in the received array or object values.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The array or object to check.
+
+#### expectedValues
+
+`unknown`[]
+
+The values that must all be present.
+
+### Returns
+
+`object`
+
+#### pass
+
+```ts
+pass: boolean = false;
+```
+
+#### message
+
+```ts
+message: () => string;
+```
+
+##### Returns
+
+`string`
+
+### toContainKey()
+
+```ts
+toContainKey(received, key): object;
+```
+
+Asserts that the received object contains the specified key.
+
+### Parameters
+
+#### received
+
+`object`
+
+The object to check.
+
+#### key
+
+`string`
+
+The key that should be present.
+
+### Returns
+
+`object`
+
+#### pass
+
+```ts
+pass: boolean = true;
+```
+
+#### message
+
+```ts
+message: () => string;
+```
+
+##### Returns
+
+`string`
+
+### toInclude()
+
+```ts
+toInclude(received, value): object;
+```
+
+Asserts that the received array, string, or object values include the specified value.
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The array, string, or object to search within.
+
+#### value
+
+`any`
+
+The value to look for.
+
+### Returns
+
+`object`
+
+#### pass
+
+```ts
+pass: boolean;
+```
+
+#### message
+
+```ts
+message: () => string;
+```
+
+##### Returns
+
+`string`
+
+### toIncludeAllMembers()
+
+```ts
+toIncludeAllMembers(received, expected): ExpectationResult;
+```
+
+Asserts that the received array includes all members of the expected array.
+
+### Parameters
+
+#### received
+
+`unknown`[]
+
+The array to check.
+
+#### expected
+
+`unknown`[]
+
+The members that must all be present.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toContainAllKeys()
+
+```ts
+toContainAllKeys(received, expectedKeys): ExpectationResult;
+```
+
+Asserts that the received object contains all of the specified keys.
+
+### Parameters
+
+#### received
+
+`object`
+
+The object to check.
+
+#### expectedKeys
+
+`string`[]
+
+The keys that must all be present.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toContainValues()
+
+```ts
+toContainValues(received, expectedValues): ExpectationResult;
+```
+
+Asserts that the received object contains all of the specified values (using deep equality).
+
+### Parameters
+
+#### received
+
+`object`
+
+The object to check.
+
+#### expectedValues
+
+`unknown`[]
+
+The values that must all be present.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeEmpty()
+
+```ts
+toBeEmpty(received): ExpectationResult;
+```
+
+Asserts the received value is empty (zero-length array/string, empty object, or empty Map/Set).
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+[`ExpectationResult`](#../interfaces/ExpectationResult)
+
+### toBeValidDate()
+
+```ts
+toBeValidDate(received): object;
+```
+
+Asserts the received value is a valid Date instance (not an invalid date).
+
+### Parameters
+
+#### received
+
+`unknown`
+
+The value to check.
+
+### Returns
+
+`object`
+
+#### pass
+
+```ts
+pass: boolean = isValid;
+```
+
+#### message
+
+```ts
+message: () => string;
+```
+
+##### Returns
+
+`string`
+
+
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/vitest-matchers.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/vitest-matchers
+[license-badge]: https://img.shields.io/npm/l/@xylabs/vitest-matchers.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/vitest-matchers",
-  "version": "5.0.94",
+  "version": "5.0.96",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "log",
@@ -31,12 +31,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -45,16 +43,11 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/node": "^25.5.2",
-    "@xylabs/ts-scripts-common": "~7.7.3",
-    "@xylabs/ts-scripts-pnpm": "~7.7.3",
-    "@xylabs/tsconfig": "~7.7.3",
-    "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0",
-    "esbuild": "^0.28.0",
-    "typescript": "^5"
-  },
-  "peerDependencies": {
-    "vitest": ">=3 <5"
+    "@xylabs/toolchain": "~7.10.4",
+    "@xylabs/tsconfig": "~7.10.4",
+    "typescript": "^5",
+    "vite": "^8.0.8",
+    "vitest": "~4.1.4"
   },
   "engines": {
     "node": ">=18"