vitest-websocket-mock 0.4.0 → 0.6.0

package/README.md

@@ -97,7 +97,7 @@ A `WS` instance has the following attributes:
 on received messages easier:
 
 - `.toReceiveMessage`: async matcher that waits for the next message received
-  by the the mock websocket server, and asserts its content. It will time out
+  by the mock websocket server, and asserts its content. It will time out
   with a helpful message after 1000ms.
 - `.toHaveReceivedMessages`: synchronous matcher that checks that all the
   expected messages have been received by the mock websocket server.
@@ -319,7 +319,7 @@ under the hood to mock out WebSocket clients.
 Out of the box, Mock Socket will only mock out the global `WebSocket` object.
 If you are using a third-party WebSocket client library (eg. a Node.js
 implementation, like [`ws`](https://github.com/websockets/ws)), you'll need
-to set up a [manual mock](https://jestjs.io/docs/en/manual-mocks#mocking-node-modules):
+to set up a [manual mock](https://vitest.dev/api/vi.html#vi-mock):
 
 - Create a `__mocks__` folder in your project root
 - Add a new file in the `__mocks__` folder named after the library you want to
@@ -333,6 +333,19 @@ to set up a [manual mock](https://jestjs.io/docs/en/manual-mocks#mocking-node-mo
 export { WebSocket as default } from 'mock-socket';
 ```
 
+- Somewhere in the test files, call `vi.mock` with the name of the library you want to mock. For instance, for the `ws` library:
+
+```js
+// foo.test.js
+
+import WebSocket from 'ws';
+import { vi } from 'vitest';
+
+vi.mock('ws');
+
+// do some tests...
+```
+
 **NOTE** The `ws` library is not 100% compatible with the browser API, and
 the `mock-socket` library that `vitest-websocket-mock` uses under the hood only
 implements the browser API.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Server, Client, CloseOptions, ServerOptions } from 'mock-socket';
+import { Server, ServerOptions, Client, CloseOptions } from 'mock-socket';
 import { RawMatcherFn } from '@vitest/expect';
 
 /**
@@ -78,11 +78,11 @@ interface CustomMatchers<R = unknown> {
  * @copyright Akiomi Kamakura 2023
  */
 
-declare module 'vitest' {
+declare module '@vitest/expect' {
     interface Assertion<T = any> extends CustomMatchers<T> {
     }
     interface AsymmetricMatchersContaining extends CustomMatchers {
     }
 }
 
-export { ReceiveMessageOptions, WS, WS as default, deriveToHaveReceivedMessage, deriveToReceiveMessage };
+export { type ReceiveMessageOptions, WS, WS as default, deriveToHaveReceivedMessage, deriveToReceiveMessage };

package/dist/index.js

@@ -2,8 +2,7 @@ var __defProp = Object.defineProperty;
 var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
   get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
 }) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
+  if (typeof require !== "undefined") return require.apply(this, arguments);
   throw Error('Dynamic require of "' + x + '" is not supported');
 });
 var __export = (target, all) => {
@@ -172,7 +171,7 @@ function deriveToHaveReceivedMessage(name, fn) {
 
 // src/derivers/deriveToReceiveMessage.ts
 var WAIT_DELAY = 1e3;
-var TIMEOUT = Symbol("timeout");
+var TIMEOUT = /* @__PURE__ */ Symbol("timeout");
 function deriveToReceiveMessage(name, fn) {
   return async function(ws, expected, options) {
     const isWS = ws instanceof WS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-websocket-mock",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Mock websockets and assert complex websocket interactions with Vitest",
   "type": "module",
   "repository": {
@@ -36,7 +36,7 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.59.0",
     "@typescript-eslint/parser": "^5.59.0",
-    "@vitest/coverage-v8": "^2.0.3",
+    "@vitest/coverage-v8": "4.1.1",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-react-app": "^7.0.1",
@@ -45,20 +45,23 @@
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.2",
     "rimraf": "^4.1.2",
-    "tsup": "^7.0.0",
+    "tsup": "^8.5.1",
     "typescript": "^4.0.2",
-    "vite": "^5.0.6",
-    "vitest": "^2.0.3"
+    "vite": "^8.1.4",
+    "vitest": "4.1.1"
   },
   "peerDependencies": {
-    "vitest": ">=2"
+    "vitest": ">=4"
   },
   "dependencies": {
-    "@vitest/utils": "^2.0.3",
+    "@vitest/utils": "4.1.1",
     "mock-socket": "^9.2.1"
   },
   "files": [
     "dist",
     "LICENSE"
-  ]
+  ],
+  "overrides": {
+    "esbuild": "^0.28.1"
+  }
 }