@vitest/expect 3.2.0-beta.1 → 3.2.0-beta.3

package/dist/index.d.ts

@@ -9,6 +9,70 @@ declare const JEST_MATCHERS_OBJECT: unique symbol;
 declare const GLOBAL_EXPECT: unique symbol;
 declare const ASYMMETRIC_MATCHERS_OBJECT: unique symbol;
 
+/* eslint-disable unicorn/no-instanceof-builtins -- we check both */
+
+interface AsymmetricMatcherInterface {
+	asymmetricMatch: (other: unknown) => boolean;
+	toString: () => string;
+	getExpectedType?: () => string;
+	toAsymmetricMatcher?: () => string;
+}
+declare abstract class AsymmetricMatcher<
+	T,
+	State extends MatcherState = MatcherState
+> implements AsymmetricMatcherInterface {
+	protected sample: T;
+	protected inverse: boolean;
+	// should have "jest" to be compatible with its ecosystem
+	$$typeof: symbol;
+	constructor(sample: T, inverse?: boolean);
+	protected getMatcherContext(expect?: Chai.ExpectStatic): State;
+	abstract asymmetricMatch(other: unknown): boolean;
+	abstract toString(): string;
+	getExpectedType?(): string;
+	toAsymmetricMatcher?(): string;
+}
+declare class StringContaining extends AsymmetricMatcher<string> {
+	constructor(sample: string, inverse?: boolean);
+	asymmetricMatch(other: string): boolean;
+	toString(): string;
+	getExpectedType(): string;
+}
+declare class Anything extends AsymmetricMatcher<void> {
+	asymmetricMatch(other: unknown): boolean;
+	toString(): string;
+	toAsymmetricMatcher(): string;
+}
+declare class ObjectContaining extends AsymmetricMatcher<Record<string, unknown>> {
+	constructor(sample: Record<string, unknown>, inverse?: boolean);
+	getPrototype(obj: object): any;
+	hasProperty(obj: object | null, property: string): boolean;
+	asymmetricMatch(other: any): boolean;
+	toString(): string;
+	getExpectedType(): string;
+}
+declare class ArrayContaining<T = unknown> extends AsymmetricMatcher<Array<T>> {
+	constructor(sample: Array<T>, inverse?: boolean);
+	asymmetricMatch(other: Array<T>): boolean;
+	toString(): string;
+	getExpectedType(): string;
+}
+declare class Any extends AsymmetricMatcher<any> {
+	constructor(sample: unknown);
+	fnNameFor(func: Function): string;
+	asymmetricMatch(other: unknown): boolean;
+	toString(): string;
+	getExpectedType(): string;
+	toAsymmetricMatcher(): string;
+}
+declare class StringMatching extends AsymmetricMatcher<RegExp> {
+	constructor(sample: string | RegExp, inverse?: boolean);
+	asymmetricMatch(other: string): boolean;
+	toString(): string;
+	getExpectedType(): string;
+}
+declare const JestAsymmetricMatchers: ChaiPlugin;
+
 declare function matcherHint(matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions): string;
 declare function printReceived(object: unknown): string;
 declare function printExpected(value: unknown): string;
@@ -65,7 +129,9 @@ interface MatcherState {
 	isExpectingAssertions?: boolean;
 	isExpectingAssertionsError?: Error | null;
 	isNot: boolean;
+	// environment: VitestEnvironment
 	promise: string;
+	// snapshotState: SnapshotState
 	suppressedErrors: Array<Error>;
 	testPath?: string;
 	utils: ReturnType<typeof getMatcherUtils> & {
@@ -85,15 +151,22 @@ interface SyncExpectationResult {
 }
 type AsyncExpectationResult = Promise<SyncExpectationResult>;
 type ExpectationResult = SyncExpectationResult | AsyncExpectationResult;
-interface RawMatcherFn<T extends MatcherState = MatcherState> {
-	(this: T, received: any, ...expected: Array<any>): ExpectationResult;
+interface RawMatcherFn<
+	T extends MatcherState = MatcherState,
+	E extends Array<any> = Array<any>
+> {
+	(this: T, received: any, ...expected: E): ExpectationResult;
 }
-type MatchersObject<T extends MatcherState = MatcherState> = Record<string, RawMatcherFn<T>> & ThisType<T>;
-interface ExpectStatic extends Chai.ExpectStatic, AsymmetricMatchersContaining {
+// Allow unused `T` to preserve its name for extensions.
+// Type parameter names must be identical when extending those types.
+// eslint-disable-next-line
+interface Matchers<T = any> {}
+type MatchersObject<T extends MatcherState = MatcherState> = Record<string, RawMatcherFn<T>> & ThisType<T> & { [K in keyof Matchers<T>]? : RawMatcherFn<T, Parameters<Matchers<T>[K]>> };
+interface ExpectStatic extends Chai.ExpectStatic, Matchers, AsymmetricMatchersContaining {
 	<T>(actual: T, message?: string): Assertion<T>;
 	extend: (expects: MatchersObject) => void;
-	anything: () => any;
-	any: (constructor: unknown) => any;
+	anything: () => AsymmetricMatcher<unknown>;
+	any: (constructor: unknown) => AsymmetricMatcher<unknown>;
 	getState: () => MatcherState;
 	setState: (state: Partial<MatcherState>) => void;
 	not: AsymmetricMatchersContaining;
@@ -135,14 +208,14 @@ interface AsymmetricMatchersContaining extends CustomMatcher {
 	* @example
 	* expect({ a: '1', b: 2 }).toEqual(expect.objectContaining({ a: '1' }))
 	*/
-	objectContaining: <T = any>(expected: T) => any;
+	objectContaining: <T = any>(expected: DeeplyAllowMatchers<T>) => any;
 	/**
 	* Matches if the received array contains all elements in the expected array.
 	*
 	* @example
 	* expect(['a', 'b', 'c']).toEqual(expect.arrayContaining(['b', 'a']));
 	*/
-	arrayContaining: <T = unknown>(expected: Array<T>) => any;
+	arrayContaining: <T = unknown>(expected: Array<DeeplyAllowMatchers<T>>) => any;
 	/**
 	* Matches if the received string or regex matches the expected pattern.
 	*
@@ -162,6 +235,7 @@ interface AsymmetricMatchersContaining extends CustomMatcher {
 	*/
 	closeTo: (expected: number, precision?: number) => any;
 }
+type DeeplyAllowMatchers<T> = T extends Array<infer Element> ? (DeeplyAllowMatchers<Element> | Element)[] : T extends object ? { [K in keyof T] : DeeplyAllowMatchers<T[K]> | AsymmetricMatcher<unknown> } : T;
 interface JestAssertion<T = any> extends jest.Matchers<void, T>, CustomMatcher {
 	/**
 	* Used when you want to check that two objects have the same value.
@@ -170,14 +244,14 @@ interface JestAssertion<T = any> extends jest.Matchers<void, T>, CustomMatcher {
 	* @example
 	* expect(user).toEqual({ name: 'Alice', age: 30 });
 	*/
-	toEqual: <E>(expected: E) => void;
+	toEqual: <E>(expected: DeeplyAllowMatchers<E>) => void;
 	/**
 	* Use to test that objects have the same types as well as structure.
 	*
 	* @example
 	* expect(user).toStrictEqual({ name: 'Alice', age: 30 });
 	*/
-	toStrictEqual: <E>(expected: E) => void;
+	toStrictEqual: <E>(expected: DeeplyAllowMatchers<E>) => void;
 	/**
 	* Checks that a value is what you expect. It calls `Object.is` to compare values.
 	* Don't use `toBe` with floating-point numbers.
@@ -204,7 +278,7 @@ interface JestAssertion<T = any> extends jest.Matchers<void, T>, CustomMatcher {
 	*   address: { city: 'Wonderland' }
 	* });
 	*/
-	toMatchObject: <E extends object | any[]>(expected: E) => void;
+	toMatchObject: <E extends object | any[]>(expected: DeeplyAllowMatchers<E>) => void;
 	/**
 	* Used when you want to check that an item is in a list.
 	* For testing the items in the list, this uses `===`, a strict equality check.
@@ -556,7 +630,7 @@ type VitestAssertion<
 > = { [K in keyof A] : A[K] extends Chai.Assertion ? Assertion<T> : A[K] extends (...args: any[]) => any ? A[K] : VitestAssertion<A[K], T> } & ((type: string, message?: string) => Assertion);
 type Promisify<O> = { [K in keyof O] : O[K] extends (...args: infer A) => infer R ? Promisify<O[K]> & ((...args: A) => Promise<R>) : O[K] };
 type PromisifyAssertion<T> = Promisify<Assertion<T>>;
-interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAssertion<T> {
+interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAssertion<T>, Matchers<T> {
 	/**
 	* Ensures a value is of a specific type.
 	*
@@ -661,81 +735,50 @@ interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAss
 	rejects: PromisifyAssertion<T>;
 }
 declare global {
+	// support augmenting jest.Matchers by other libraries
+	// eslint-disable-next-line ts/no-namespace
 	namespace jest {
-		interface Matchers<
+		// eslint-disable-next-line unused-imports/no-unused-vars, ts/no-empty-object-type
+interface Matchers<
 			R,
 			T = {}
 		> {}
 	}
 }
 
+// selectively ported from https://github.com/jest-community/jest-extended
 declare const customMatchers: MatchersObject;
 
-interface AsymmetricMatcherInterface {
-	asymmetricMatch: (other: unknown) => boolean;
-	toString: () => string;
-	getExpectedType?: () => string;
-	toAsymmetricMatcher?: () => string;
-}
-declare abstract class AsymmetricMatcher<
-	T,
-	State extends MatcherState = MatcherState
-> implements AsymmetricMatcherInterface {
-	protected sample: T;
-	protected inverse: boolean;
-	$$typeof: symbol;
-	constructor(sample: T, inverse?: boolean);
-	protected getMatcherContext(expect?: Chai.ExpectStatic): State;
-	abstract asymmetricMatch(other: unknown): boolean;
-	abstract toString(): string;
-	getExpectedType?(): string;
-	toAsymmetricMatcher?(): string;
-}
-declare class StringContaining extends AsymmetricMatcher<string> {
-	constructor(sample: string, inverse?: boolean);
-	asymmetricMatch(other: string): boolean;
-	toString(): string;
-	getExpectedType(): string;
-}
-declare class Anything extends AsymmetricMatcher<void> {
-	asymmetricMatch(other: unknown): boolean;
-	toString(): string;
-	toAsymmetricMatcher(): string;
-}
-declare class ObjectContaining extends AsymmetricMatcher<Record<string, unknown>> {
-	constructor(sample: Record<string, unknown>, inverse?: boolean);
-	getPrototype(obj: object): any;
-	hasProperty(obj: object | null, property: string): boolean;
-	asymmetricMatch(other: any): boolean;
-	toString(): string;
-	getExpectedType(): string;
-}
-declare class ArrayContaining<T = unknown> extends AsymmetricMatcher<Array<T>> {
-	constructor(sample: Array<T>, inverse?: boolean);
-	asymmetricMatch(other: Array<T>): boolean;
-	toString(): string;
-	getExpectedType(): string;
-}
-declare class Any extends AsymmetricMatcher<any> {
-	constructor(sample: unknown);
-	fnNameFor(func: Function): string;
-	asymmetricMatch(other: unknown): boolean;
-	toString(): string;
-	getExpectedType(): string;
-	toAsymmetricMatcher(): string;
-}
-declare class StringMatching extends AsymmetricMatcher<RegExp> {
-	constructor(sample: string | RegExp, inverse?: boolean);
-	asymmetricMatch(other: string): boolean;
-	toString(): string;
-	getExpectedType(): string;
-}
-declare const JestAsymmetricMatchers: ChaiPlugin;
-
+// Jest Expect Compact
 declare const JestChaiExpect: ChaiPlugin;
 
 declare const JestExtend: ChaiPlugin;
 
+/*
+Copyright (c) 2008-2016 Pivotal Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+// Extracted out of jasmine 2.5.2
 declare function equals(a: unknown, b: unknown, customTesters?: Array<Tester>, strictCheck?: boolean): boolean;
 declare function isAsymmetric(obj: any): boolean;
 declare function hasAsymmetric(obj: any, seen?: Set<any>): boolean;
@@ -761,4 +804,4 @@ declare function getState<State extends MatcherState = MatcherState>(expect: Exp
 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 type { Assertion, AsymmetricMatcherInterface, AsymmetricMatchersContaining, AsyncExpectationResult, ChaiPlugin, ExpectStatic, ExpectationResult, JestAssertion, MatcherHintOptions, MatcherState, MatchersObject, PromisifyAssertion, RawMatcherFn, SyncExpectationResult, Tester, TesterContext };
+export type { Assertion, AsymmetricMatcherInterface, AsymmetricMatchersContaining, AsyncExpectationResult, ChaiPlugin, DeeplyAllowMatchers, ExpectStatic, ExpectationResult, JestAssertion, MatcherHintOptions, MatcherState, Matchers, MatchersObject, PromisifyAssertion, RawMatcherFn, SyncExpectationResult, Tester, TesterContext };