@vitest/expect 4.0.0-beta.16 → 4.0.0-beta.18

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { MockInstance } from '@vitest/spy';
 import { Constructable } from '@vitest/utils';
 import { Formatter } from 'tinyrainbow';
+import { StandardSchemaV1 } from '@standard-schema/spec';
 import { diff, printDiffOrStringify } from '@vitest/utils/diff';
 export { DiffOptions } from '@vitest/utils/diff';
 import { stringify } from '@vitest/utils/display';
@@ -72,6 +73,14 @@ declare class StringMatching extends AsymmetricMatcher<RegExp> {
 	toString(): string;
 	getExpectedType(): string;
 }
+declare class SchemaMatching extends AsymmetricMatcher<StandardSchemaV1<unknown, unknown>> {
+	private result;
+	constructor(sample: StandardSchemaV1<unknown, unknown>, inverse?: boolean);
+	asymmetricMatch(other: unknown): boolean;
+	toString(): string;
+	getExpectedType(): string;
+	toAsymmetricMatcher(): string;
+}
 declare const JestAsymmetricMatchers: ChaiPlugin;
 
 declare function matcherHint(matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions): string;
@@ -230,6 +239,16 @@ interface AsymmetricMatchersContaining extends CustomMatcher {
 	* expect(5.11).toEqual(expect.closeTo(5.12)); // with default precision
 	*/
 	closeTo: (expected: number, precision?: number) => any;
+	/**
+	* Matches if the received value validates against a Standard Schema.
+	*
+	* @param schema - A Standard Schema V1 compatible schema object
+	*
+	* @example
+	* expect(user).toEqual(expect.schemaMatching(z.object({ name: z.string() })))
+	* expect(['hello', 'world']).toEqual([expect.schemaMatching(z.string()), expect.schemaMatching(z.string())])
+	*/
+	schemaMatching: (schema: unknown) => any;
 }
 type WithAsymmetricMatcher<T> = T | AsymmetricMatcher<unknown>;
 type DeeplyAllowMatchers<T> = T extends Array<infer Element> ? WithAsymmetricMatcher<T> | DeeplyAllowMatchers<Element>[] : T extends object ? WithAsymmetricMatcher<T> | { [K in keyof T] : DeeplyAllowMatchers<T[K]> } : WithAsymmetricMatcher<T>;
@@ -773,9 +792,13 @@ declare function getObjectSubset(object: any, subset: any, customTesters: Array<
 	subset: any;
 	stripped: number;
 };
+/**
+* Detects if an object is a Standard Schema V1 compatible schema
+*/
+declare function isStandardSchema(obj: any): obj is StandardSchemaV1;
 
 declare function getState<State extends MatcherState = MatcherState>(expect: ExpectStatic): State;
 declare function setState<State extends MatcherState = MatcherState>(state: Partial<State>, expect: ExpectStatic): void;
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, SchemaMatching, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, isStandardSchema, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
 export type { Assertion, AsymmetricMatcherInterface, AsymmetricMatchersContaining, AsyncExpectationResult, ChaiPlugin, DeeplyAllowMatchers, ExpectStatic, ExpectationResult, JestAssertion, MatcherHintOptions, MatcherState, Matchers, MatchersObject, PromisifyAssertion, RawMatcherFn, SyncExpectationResult, Tester, TesterContext };

package/dist/index.js

@@ -660,6 +660,12 @@ function getObjectSubset(object, subset, customTesters) {
 		stripped
 	};
 }
+/**
+* Detects if an object is a Standard Schema V1 compatible schema
+*/
+function isStandardSchema(obj) {
+	return !!obj && typeof obj === "object" && obj["~standard"] && typeof obj["~standard"].validate === "function";
+}
 
 if (!Object.hasOwn(globalThis, MATCHERS_OBJECT)) {
 	const globalState = new WeakMap();
@@ -952,6 +958,40 @@ class CloseTo extends AsymmetricMatcher {
 		].join(" ");
 	}
 }
+class SchemaMatching extends AsymmetricMatcher {
+	result;
+	constructor(sample, inverse = false) {
+		if (!isStandardSchema(sample)) {
+			throw new TypeError("SchemaMatching expected to receive a Standard Schema.");
+		}
+		super(sample, inverse);
+	}
+	asymmetricMatch(other) {
+		const result = this.sample["~standard"].validate(other);
+		// Check if the result is a Promise (async validation)
+		if (result instanceof Promise) {
+			throw new TypeError("Async schema validation is not supported in asymmetric matchers.");
+		}
+		this.result = result;
+		const pass = !this.result.issues || this.result.issues.length === 0;
+		return this.inverse ? !pass : pass;
+	}
+	toString() {
+		return `Schema${this.inverse ? "Not" : ""}Matching`;
+	}
+	getExpectedType() {
+		return "object";
+	}
+	toAsymmetricMatcher() {
+		var _this$result;
+		const { utils } = this.getMatcherContext();
+		const issues = ((_this$result = this.result) === null || _this$result === void 0 ? void 0 : _this$result.issues) || [];
+		if (issues.length > 0) {
+			return `${this.toString()} ${utils.stringify(this.result, undefined, { printBasicPrototype: false })}`;
+		}
+		return this.toString();
+	}
+}
 const JestAsymmetricMatchers = (chai, utils) => {
 	utils.addMethod(chai.expect, "anything", () => new Anything());
 	utils.addMethod(chai.expect, "any", (expected) => new Any(expected));
@@ -960,13 +1000,15 @@ const JestAsymmetricMatchers = (chai, utils) => {
 	utils.addMethod(chai.expect, "arrayContaining", (expected) => new ArrayContaining(expected));
 	utils.addMethod(chai.expect, "stringMatching", (expected) => new StringMatching(expected));
 	utils.addMethod(chai.expect, "closeTo", (expected, precision) => new CloseTo(expected, precision));
+	utils.addMethod(chai.expect, "schemaMatching", (expected) => new SchemaMatching(expected));
 	// defineProperty does not work
 	chai.expect.not = {
 		stringContaining: (expected) => new StringContaining(expected, true),
 		objectContaining: (expected) => new ObjectContaining(expected, true),
 		arrayContaining: (expected) => new ArrayContaining(expected, true),
 		stringMatching: (expected) => new StringMatching(expected, true),
-		closeTo: (expected, precision) => new CloseTo(expected, precision, true)
+		closeTo: (expected, precision) => new CloseTo(expected, precision, true),
+		schemaMatching: (expected) => new SchemaMatching(expected, true)
 	};
 };
 
@@ -1819,4 +1861,4 @@ const JestExtend = (chai, utils) => {
 	});
 };
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, SchemaMatching, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, customMatchers, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, isStandardSchema, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "4.0.0-beta.16",
+  "version": "4.0.0-beta.18",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -29,14 +29,15 @@
     "dist"
   ],
   "dependencies": {
+    "@standard-schema/spec": "^1.0.0",
     "@types/chai": "^5.2.2",
     "chai": "^6.0.1",
     "tinyrainbow": "^3.0.3",
-    "@vitest/spy": "4.0.0-beta.16",
-    "@vitest/utils": "4.0.0-beta.16"
+    "@vitest/utils": "4.0.0-beta.18",
+    "@vitest/spy": "4.0.0-beta.18"
   },
   "devDependencies": {
-    "@vitest/runner": "4.0.0-beta.16"
+    "@vitest/runner": "4.0.0-beta.18"
   },
   "scripts": {
     "build": "premove dist && rollup -c",