@vitest/expect 4.1.0 → 4.1.2

package/dist/index.d.ts

@@ -164,6 +164,7 @@ interface SyncExpectationResult {
 	message: () => string;
 	actual?: any;
 	expected?: any;
+	meta?: object;
 }
 type AsyncExpectationResult = Promise<SyncExpectationResult>;
 type ExpectationResult = SyncExpectationResult | AsyncExpectationResult;
@@ -793,13 +794,13 @@ interface ChaiMockAssertion {
 	*/
 	nthCalledWith: <E extends any[]>(n: number, ...args: E) => void;
 	/**
-	* Checks that a spy returned successfully at least once.
-	* Chai-style equivalent of `toHaveReturned`.
+	* Checks that a spy returned a specific value at least once.
+	* Chai-style equivalent of `toHaveReturnedWith`.
 	*
 	* @example
-	* expect(spy).to.have.returned
+	* expect(spy).to.have.returned('value')
 	*/
-	readonly returned: Assertion;
+	returned: <E>(value: E) => void;
 	/**
 	* Checks that a spy returned a specific value at least once.
 	* Chai-style equivalent of `toHaveReturnedWith`.

package/dist/index.js

@@ -28,17 +28,18 @@ const ChaiStyleAssertions = (chai, utils) => {
 		});
 	}
 	function defMethod(name, delegateTo) {
-		utils.addChainableMethod(chai.Assertion.prototype, name, function(...args) {
+		utils.addMethod(chai.Assertion.prototype, name, function(...args) {
 			const jestMethod = chai.Assertion.prototype[delegateTo];
 			if (!jestMethod) {
 				throw new Error(`Cannot delegate to ${String(delegateTo)}: method not found. Ensure JestChaiExpect plugin is loaded first.`);
 			}
 			return jestMethod.call(this, ...args);
-		}, () => {});
+		});
 	}
+	// API to (somewhat) mirror sinon-chai
+	// https://github.com/chaijs/sinon-chai
 	defProperty("called", "toHaveBeenCalled");
 	defProperty("calledOnce", "toHaveBeenCalledOnce");
-	defProperty("returned", "toHaveReturned");
 	defPropertyWithArgs("calledTwice", "toHaveBeenCalledTimes", 2);
 	defPropertyWithArgs("calledThrice", "toHaveBeenCalledTimes", 3);
 	defMethod("callCount", "toHaveBeenCalledTimes");
@@ -46,12 +47,15 @@ const ChaiStyleAssertions = (chai, utils) => {
 	defMethod("calledOnceWith", "toHaveBeenCalledExactlyOnceWith");
 	defMethod("lastCalledWith", "toHaveBeenLastCalledWith");
 	defMethod("nthCalledWith", "toHaveBeenNthCalledWith");
+	defMethod("returned", "toHaveReturned");
 	defMethod("returnedWith", "toHaveReturnedWith");
 	defMethod("returnedTimes", "toHaveReturnedTimes");
 	defMethod("lastReturnedWith", "toHaveLastReturnedWith");
 	defMethod("nthReturnedWith", "toHaveNthReturnedWith");
 	defMethod("calledBefore", "toHaveBeenCalledBefore");
 	defMethod("calledAfter", "toHaveBeenCalledAfter");
+	// TODO: implement
+	// defMethod('thrown', 'toHaveThrown')
 };
 
 const MATCHERS_OBJECT = Symbol.for("matchers-object");
@@ -1733,7 +1737,7 @@ const JestChaiExpect = (chai, utils) => {
 					}
 					throw err;
 				});
-				return recordAsyncExpect(test, promise, createAssertionMessage(utils, this, !!args.length), error);
+				return recordAsyncExpect(test, promise, createAssertionMessage(utils, this, !!args.length), error, utils.flag(this, "soft"));
 			};
 		} });
 		return proxy;
@@ -1774,7 +1778,7 @@ const JestChaiExpect = (chai, utils) => {
 					}
 					throw err;
 				});
-				return recordAsyncExpect(test, promise, createAssertionMessage(utils, this, !!args.length), error);
+				return recordAsyncExpect(test, promise, createAssertionMessage(utils, this, !!args.length), error, utils.flag(this, "soft"));
 			};
 		} });
 		return proxy;
@@ -1851,10 +1855,11 @@ function getMatcherState(assertion, expect) {
 	};
 }
 class JestExtendError extends Error {
-	constructor(message, actual, expected) {
+	constructor(message, actual, expected, context) {
 		super(message);
 		this.actual = actual;
 		this.expected = expected;
+		this.context = context;
 	}
 }
 function JestExtendPlugin(c, expect, matchers) {
@@ -1865,17 +1870,23 @@ function JestExtendPlugin(c, expect, matchers) {
 				const result = expectAssertion.call(state, obj, ...args);
 				if (result && typeof result === "object" && typeof result.then === "function") {
 					const thenable = result;
-					return thenable.then(({ pass, message, actual, expected }) => {
+					return thenable.then(({ pass, message, actual, expected, meta }) => {
 						if (pass && isNot || !pass && !isNot) {
 							const errorMessage = customMessage != null ? customMessage : message();
-							throw new JestExtendError(errorMessage, actual, expected);
+							throw new JestExtendError(errorMessage, actual, expected, {
+								assertionName: expectAssertionName,
+								meta
+							});
 						}
 					});
 				}
-				const { pass, message, actual, expected } = result;
+				const { pass, message, actual, expected, meta } = result;
 				if (pass && isNot || !pass && !isNot) {
 					const errorMessage = customMessage != null ? customMessage : message();
-					throw new JestExtendError(errorMessage, actual, expected);
+					throw new JestExtendError(errorMessage, actual, expected, {
+						assertionName: expectAssertionName,
+						meta
+					});
 				}
 			}
 			const softWrapper = wrapAssertion(utils, expectAssertionName, expectWrapper);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -38,12 +38,12 @@
     "@standard-schema/spec": "^1.1.0",
     "@types/chai": "^5.2.2",
     "chai": "^6.2.2",
-    "tinyrainbow": "^3.0.3",
-    "@vitest/spy": "4.1.0",
-    "@vitest/utils": "4.1.0"
+    "tinyrainbow": "^3.1.0",
+    "@vitest/spy": "4.1.2",
+    "@vitest/utils": "4.1.2"
   },
   "devDependencies": {
-    "@vitest/runner": "4.1.0"
+    "@vitest/runner": "4.1.2"
   },
   "scripts": {
     "build": "premove dist && rollup -c",