msw 2.15.0 → 3.0.0

package/package.json

@@ -1,183 +1,81 @@
 {
   "name": "msw",
-  "version": "2.15.0",
+  "version": "3.0.0",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
-  "type": "commonjs",
+  "type": "module",
   "main": "./lib/core/index.js",
-  "module": "./lib/core/index.mjs",
   "types": "./lib/core/index.d.ts",
   "exports": {
     ".": {
-      "module-sync": {
-        "types": "./lib/core/index.d.mts",
-        "default": "./lib/core/index.mjs"
-      },
-      "module": {
-        "types": "./lib/core/index.d.mts",
-        "default": "./lib/core/index.mjs"
-      },
-      "react-native": {
-        "import": {
-          "types": "./lib/core/index.d.mts",
-          "default": "./lib/core/index.mjs"
-        },
-        "default": {
-          "types": "./lib/core/index.d.ts",
-          "default": "./lib/core/index.js"
-        }
-      },
-      "import": {
-        "types": "./lib/core/index.d.mts",
-        "default": "./lib/core/index.mjs"
-      },
-      "default": {
-        "types": "./lib/core/index.d.ts",
-        "default": "./lib/core/index.js"
-      }
+      "types": "./lib/core/index.d.ts",
+      "default": "./lib/core/index.js"
     },
     "./browser": {
-      "module-sync": {
-        "types": "./lib/browser/index.d.mts",
-        "default": "./lib/browser/index.mjs"
-      },
-      "module": {
-        "types": "./lib/browser/index.d.mts",
-        "default": "./lib/browser/index.mjs"
-      },
-      "browser": {
-        "types": "./lib/browser/index.d.mts",
-        "default": "./lib/browser/index.mjs"
-      },
-      "import": {
-        "types": "./lib/browser/index.d.mts",
-        "default": "./lib/browser/index.mjs"
-      },
+      "types": "./lib/browser/index.d.ts",
       "node": null,
-      "react-native": null,
-      "default": {
-        "types": "./lib/browser/index.d.ts",
-        "default": "./lib/browser/index.js"
-      }
+      "default": "./lib/browser/index.js"
     },
     "./node": {
-      "module-sync": {
-        "types": "./lib/node/index.d.mts",
-        "default": "./lib/node/index.mjs"
-      },
-      "module": {
-        "types": "./lib/node/index.d.mts",
-        "default": "./lib/node/index.mjs"
-      },
-      "node": {
-        "require": "./lib/node/index.js",
-        "import": "./lib/node/index.mjs"
-      },
-      "import": {
-        "types": "./lib/node/index.d.mts",
-        "default": "./lib/node/index.mjs"
-      },
+      "types": "./lib/node/index.d.ts",
       "browser": null,
-      "react-native": null,
-      "default": {
-        "types": "./lib/node/index.d.ts",
-        "default": "./lib/node/index.js"
-      }
+      "default": "./lib/node/index.js"
     },
-    "./native": {
-      "browser": null,
-      "react-native": {
-        "import": {
-          "types": "./lib/native/index.d.mts",
-          "default": "./lib/native/index.mjs"
-        },
-        "default": {
-          "types": "./lib/native/index.d.ts",
-          "default": "./lib/native/index.js"
-        }
-      },
-      "import": {
-        "types": "./lib/native/index.d.mts",
-        "default": "./lib/native/index.mjs"
-      },
-      "default": {
-        "types": "./lib/native/index.d.ts",
-        "default": "./lib/native/index.js"
-      }
+    "./vite": {
+      "types": "./lib/vite/index.d.ts",
+      "default": "./lib/vite/index.js"
+    },
+    "./vite/client": {
+      "types": "./src/vite/client.d.ts"
+    },
+    "./http": {
+      "types": "./lib/http/index.d.ts",
+      "default": "./lib/http/index.js"
+    },
+    "./graphql": {
+      "types": "./lib/graphql/index.d.ts",
+      "default": "./lib/graphql/index.js"
     },
-    "./core/http": {
-      "module-sync": {
-        "types": "./lib/core/http.d.mts",
-        "default": "./lib/core/http.mjs"
-      },
-      "module": {
-        "types": "./lib/core/http.d.mts",
-        "default": "./lib/core/http.mjs"
-      },
-      "import": {
-        "types": "./lib/core/http.d.mts",
-        "default": "./lib/core/http.mjs"
-      },
-      "default": {
-        "types": "./lib/core/http.d.ts",
-        "default": "./lib/core/http.js"
-      }
+    "./ws": {
+      "types": "./lib/ws/index.d.ts",
+      "default": "./lib/ws/index.js"
     },
-    "./core/graphql": {
-      "module-sync": {
-        "types": "./lib/core/graphql.d.mts",
-        "default": "./lib/core/graphql.mjs"
-      },
-      "module": {
-        "types": "./lib/core/graphql.d.mts",
-        "default": "./lib/core/graphql.mjs"
-      },
-      "import": {
-        "types": "./lib/core/graphql.d.mts",
-        "default": "./lib/core/graphql.mjs"
-      },
-      "default": {
-        "types": "./lib/core/graphql.d.ts",
-        "default": "./lib/core/graphql.js"
-      }
+    "./sse": {
+      "types": "./lib/sse/index.d.ts",
+      "default": "./lib/sse/index.js"
     },
-    "./core/ws": {
-      "module-sync": {
-        "types": "./lib/core/ws.d.mts",
-        "default": "./lib/core/ws.mjs"
-      },
-      "module": {
-        "types": "./lib/core/ws.d.mts",
-        "default": "./lib/core/ws.mjs"
-      },
-      "import": {
-        "types": "./lib/core/ws.d.mts",
-        "default": "./lib/core/ws.mjs"
-      },
-      "default": {
-        "types": "./lib/core/ws.d.ts",
-        "default": "./lib/core/ws.js"
-      }
+    "./utils/*": {
+      "types": "./lib/utils/*.d.ts",
+      "default": "./lib/utils/*.js"
     },
     "./experimental": {
-      "import": "./lib/core/experimental/index.mjs",
+      "types": "./lib/core/experimental/index.d.ts",
       "default": "./lib/core/experimental/index.js"
     },
     "./mockServiceWorker.js": "./lib/mockServiceWorker.js",
     "./package.json": "./package.json"
   },
   "imports": {
-    "#core": "./src/core",
-    "#core/*": "./src/core/*"
+    "#core": "./src/core/index.ts",
+    "#core/*": "./src/core/*.ts",
+    "#http": "./src/http/index.ts",
+    "#http/*": "./src/http/*.ts",
+    "#graphql": "./src/graphql/index.ts",
+    "#graphql/*": "./src/graphql/*.ts",
+    "#ws": "./src/ws/index.ts",
+    "#ws/*": "./src/ws/*.ts",
+    "#sse": "./src/sse/index.ts",
+    "#sse/*": "./src/sse/*.ts",
+    "#utils/*": "./src/utils/*.ts"
   },
   "bin": {
     "msw": "cli/index.js"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22.12.0"
   },
   "lint-staged": {
     "**/*.ts": [
-      "oxlint --fix"
+      "oxlint --fix --no-error-on-unmatched-pattern"
     ],
     "**/*.{ts,json}": [
       "prettier --write"
@@ -195,15 +93,11 @@
   "license": "MIT",
   "funding": "https://github.com/sponsors/mswjs",
   "files": [
-    "config/package.json",
     "config/constants.js",
     "config/scripts/postinstall.js",
     "cli",
     "lib",
     "src",
-    "browser",
-    "node",
-    "native",
     "LICENSE.md",
     "README.md"
   ],
@@ -223,76 +117,76 @@
   "sideEffects": false,
   "dependencies": {
     "@inquirer/confirm": "^6.0.11",
-    "@mswjs/interceptors": "^0.41.3",
-    "@open-draft/deferred-promise": "^3.0.0",
-    "@types/statuses": "^2.0.6",
-    "cookie": "^1.1.1",
-    "graphql": "^16.13.2",
+    "@msw/url": "^0.1.2",
+    "@mswjs/interceptors": "^0.45.5",
+    "cookie": "^2.0.1",
     "headers-polyfill": "^5.0.1",
     "is-node-process": "^1.2.0",
     "outvariant": "^1.4.3",
-    "path-to-regexp": "^6.3.0",
-    "picocolors": "^1.1.1",
-    "rettime": "^0.11.11",
-    "statuses": "^2.0.2",
-    "strict-event-emitter": "^0.5.1",
-    "tough-cookie": "^6.0.1",
+    "rettime": "^0.11.12",
+    "tough-cookie": "^6.0.2",
     "type-fest": "^5.5.0",
     "until-async": "^3.0.2",
-    "yargs": "^17.7.2"
+    "yargs": "^18.2.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.5.0",
-    "@commitlint/config-conventional": "^20.5.0",
+    "@commitlint/cli": "^21.2.1",
+    "@commitlint/config-conventional": "^21.2.0",
     "@epic-web/test-server": "^0.1.6",
-    "@fastify/websocket": "^11.2.0",
+    "@fastify/websocket": "^11.3.0",
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@open-draft/test-server": "^0.4.2",
     "@ossjs/release": "^0.11.1",
     "@playwright/test": "^1.59.1",
     "@types/express": "^5.0.6",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "~22.19.17",
-    "@types/serviceworker": "^0.0.194",
-    "@web/dev-server": "^0.4.6",
+    "@types/node": "~24.19.0",
+    "@types/serviceworker": "^0.0.202",
+    "@types/ws": "^8.18.1",
+    "@vitest/browser-playwright": "5.0.2",
+    "@web/dev-server": "^1.0.0",
     "axios": "^1.15.0",
-    "babel-minify": "^0.5.1",
     "commitizen": "^4.3.1",
     "cross-env": "^10.1.0",
-    "cross-fetch": "^4.1.0",
     "cz-conventional-changelog": "3.3.0",
     "esbuild": "^0.28.0",
-    "esbuild-loader": "^4.4.3",
     "express": "^5.2.1",
     "fastify": "^5.8.5",
     "fs-teardown": "^0.3.0",
     "glob": "^13.0.6",
-    "jsdom": "^25.0.1",
+    "graphql": "^17.0.2",
+    "graphql-ws": "^6.1.1",
+    "graphql-yoga": "^5.21.2",
+    "jsdom": "^30.1.1",
     "json-bigint": "^1.0.0",
-    "knip": "^6.4.1",
-    "lint-staged": "^16.4.0",
-    "oxlint": "^1.0.0",
+    "knip": "^6.34.0",
+    "lint-staged": "^17.1.1",
+    "msw": "^3.0.0",
+    "oxlint": "^1.75.0",
     "page-with": "^0.6.1",
-    "prettier": "^3.8.3",
-    "publint": "^0.3.18",
-    "regenerator-runtime": "^0.14.1",
+    "prettier": "^3.9.6",
+    "publint": "^0.3.22",
     "rimraf": "^6.1.3",
     "simple-git-hooks": "^2.13.1",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3",
-    "undici": "^7.28.0",
-    "url-loader": "^4.1.1",
-    "vitest": "^4.1.4",
-    "webpack": "^5.106.2",
-    "webpack-http-server": "^0.5.0",
-    "msw": "^2.15.0"
+    "tsdown": "^0.23.0",
+    "typescript": "^7.0.2",
+    "vite": "^8.1.5",
+    "vitest": "^5.0.2",
+    "ws": "^8.21.3"
   },
   "peerDependencies": {
-    "typescript": ">= 4.8.x"
+    "graphql": ">=16",
+    "typescript": ">=5.9.x",
+    "vite": ">=6"
   },
   "peerDependenciesMeta": {
+    "graphql": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
+    },
+    "vite": {
+      "optional": true
     }
   },
   "config": {
@@ -306,24 +200,22 @@
     "commit-msg": "pnpm commitlint --edit $1"
   },
   "scripts": {
-    "start": "tsup --watch",
+    "dev": "tsdown --watch",
     "clean": "rimraf ./lib",
     "lint": "oxlint ./cli ./src ./test",
-    "build": "pnpm clean && cross-env NODE_ENV=production tsup && pnpm patch:dts",
-    "patch:dts": "node \"./config/scripts/patch-ts.js\"",
+    "build": "pnpm clean && cross-env NODE_ENV=production tsdown",
     "publint": "publint",
-    "test": "pnpm test:unit && pnpm test:node && pnpm test:browser && pnpm test:native && pnpm test:memory",
-    "test:unit": "vitest",
-    "test:node": "vitest --config=./test/node/vitest.config.ts",
-    "test:native": "vitest --config=./test/native/vitest.config.ts",
-    "test:browser": "playwright test -c ./test/browser/playwright.config.ts",
+    "test": "vitest",
+    "test:unit": "vitest --project=unit",
+    "test:node": "vitest --project=node",
+    "test:browser": "vitest --project=browser",
+    "test:memory": "vitest --project=memory --project=memory-browser",
+    "test:playwright": "playwright test -c ./test/playwright.config.ts",
     "test:modules:node": "vitest run --config=./test/modules/node/vitest.config.ts",
     "test:modules:browser": "playwright test -c ./test/modules/browser/playwright.config.ts",
-    "test:e2e": "vitest run --config=./test/e2e/vitest.config.ts",
-    "test:ts": "vitest --config=./test/typings/vitest.config.ts",
-    "test:memory": "vitest --config=./test/memory/vitest.config.ts",
+    "test:e2e": "vitest --project=e2e",
+    "test:ts": "vitest --project=types",
     "release": "release publish",
-    "postinstall": "node -e \"import('./config/scripts/postinstall.js').catch(() => void 0)\"",
     "knip": "knip"
   }
 }

package/src/browser/default-network-options.ts

@@ -0,0 +1,31 @@
+import { WebSocketInterceptor } from '@mswjs/interceptors/WebSocket'
+import type { DefineNetworkOptions } from '#core/experimental/define-network'
+import {
+  InterceptorSource,
+  type InterceptorSourceOptions,
+} from '#core/experimental/sources/interceptor-source'
+import { ServiceWorkerSource } from './sources/service-worker-source'
+import { FallbackHttpSource } from './sources/fallback-http-source'
+import { supportsServiceWorker } from './utils/supports'
+
+export function createDefaultNetworkOptions(
+  workerUrl = '/mockServiceWorker.js',
+): DefineNetworkOptions<
+  [ServiceWorkerSource | FallbackHttpSource, InterceptorSource]
+> {
+  return {
+    sources: [
+      supportsServiceWorker()
+        ? new ServiceWorkerSource({ serviceWorker: { url: workerUrl } })
+        : new FallbackHttpSource({}),
+      new InterceptorSource({
+        interceptors: [
+          new WebSocketInterceptor() as InterceptorSourceOptions['interceptors'][number],
+        ],
+      }),
+    ],
+    onUnhandledFrame: 'warn',
+  }
+}
+
+export const defaultNetworkOptions = createDefaultNetworkOptions()

package/src/browser/glossary.ts

@@ -1,8 +1,8 @@
-import type { LifeCycleEventEmitter, SharedOptions } from '#core/sharedOptions'
-import type { RequiredDeep } from '#core/typeUtils'
+import type { LifeCycleEventEmitter, SharedOptions } from '#core/shared-options'
 import type { HttpNetworkFrameEventMap } from '#core/experimental/frames/http-frame'
 import type { WebSocketNetworkFrameEventMap } from '#core/experimental/frames/websocket-frame'
 import type { AnyHandler } from '#core/experimental/handlers-controller'
+import type { NetworkReadyState } from '#core/experimental/define-network'
 
 export interface StringifiedResponse extends ResponseInit {
   body: string | ArrayBuffer | ReadableStream<Uint8Array> | null
@@ -38,16 +38,6 @@ export interface StartOptions extends SharedOptions {
    */
   quiet?: boolean
 
-  /**
-   * Defers any network requests until the Service Worker
-   * instance is activated.
-   * @default true
-   * @deprecated
-   * Please use a proper browser integration instead.
-   * @see https://mswjs.io/docs/integrations/browser
-   */
-  waitUntilReady?: boolean
-
   /**
    * A custom lookup function to find a Mock Service Worker in the list
    * of all registered Service Workers on the page.
@@ -55,29 +45,27 @@ export interface StartOptions extends SharedOptions {
   findWorker?: FindWorker
 }
 
-export type StartReturnType = Promise<ServiceWorkerRegistration | undefined>
-
-export type StartHandler = (
-  options: RequiredDeep<StartOptions>,
-  initialOptions: StartOptions,
-) => StartReturnType
-
-export type StopHandler = () => void
-
 export interface SetupWorker {
+  /**
+   * The current ready state of the underlying network.
+   */
+  readonly readyState: NetworkReadyState
+
   /**
    * Registers and activates the mock Service Worker.
    *
    * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()` API reference}
    */
-  start: (options?: StartOptions) => StartReturnType
+  start: (
+    options?: StartOptions,
+  ) => Promise<ServiceWorkerRegistration | undefined>
 
   /**
    * Stops requests interception for the current client.
    *
    * @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()` API reference}
    */
-  stop: StopHandler
+  stop: () => Promise<void> | void
 
   /**
    * Prepends given request handlers to the list of existing handlers.

package/src/browser/index.ts

@@ -1,2 +1,6 @@
-export { setupWorker, SetupWorkerApi } from './setup-worker'
+export { setupWorker } from './setup-worker'
 export type { SetupWorker, StartOptions } from './glossary'
+export {
+  defaultNetworkOptions,
+  createDefaultNetworkOptions,
+} from './default-network-options'

package/src/browser/setup-worker.ts

@@ -7,20 +7,11 @@ import {
 } from '#core/experimental/define-network'
 import type { AnyHandler } from '#core/experimental/handlers-controller'
 import { InterceptorSource } from '#core/experimental/sources/interceptor-source'
-import { fromLegacyOnUnhandledRequest } from '#core/experimental/compat'
-import type { LifeCycleEventEmitter } from '#core/sharedOptions'
-import type { HttpNetworkFrameEventMap } from '#core/experimental/frames/http-frame'
-import type { WebSocketNetworkFrameEventMap } from '#core/experimental/frames/websocket-frame'
-import { devUtils } from '#core/utils/internal/devUtils'
+import { devUtils } from '#core/utils/internal/dev-utils'
 import { supportsServiceWorker } from './utils/supports'
 import { ServiceWorkerSource } from './sources/service-worker-source'
 import { FallbackHttpSource } from './sources/fallback-http-source'
-import type {
-  SetupWorker,
-  StartOptions,
-  StartReturnType,
-  StopHandler,
-} from './glossary'
+import type { SetupWorker } from './glossary'
 
 const DEFAULT_WORKER_URL = '/mockServiceWorker.js'
 
@@ -46,23 +37,16 @@ export function setupWorker(...handlers: Array<AnyHandler>): SetupWorker {
   })
 
   return {
+    get readyState() {
+      return network.readyState
+    },
     async start(options) {
-      if (options?.waitUntilReady != null) {
-        devUtils.warn(
-          `The "waitUntilReady" option has been deprecated. Please remove it from this "worker.start()" call. Follow the recommended Browser integration (https://mswjs.io/docs/integrations/browser) to eliminate any race conditions between the Service Worker registration and any requests made by your application on initial render.`,
-        )
-      }
-
-      /**
-       * @todo @fixme
-       * This is kept for backward-compatibility reasons. We don't really need this check anymore.
-       */
-      if (network.readyState === NetworkReadyState.ENABLED) {
-        devUtils.warn(
-          'Found a redundant "worker.start()" call. Note that starting the worker while mocking is already enabled will have no effect. Consider removing this "worker.start()" call.',
-        )
-        return
-      }
+      invariant(
+        network.readyState === NetworkReadyState.DISABLED,
+        devUtils.formatMessage(
+          'Failed to call "worker.start()": the worker is already started. Remove the redundant "worker.start()" call.',
+        ),
+      )
 
       const httpSource = supportsServiceWorker()
         ? await ServiceWorkerSource.from({
@@ -82,12 +66,10 @@ export function setupWorker(...handlers: Array<AnyHandler>): SetupWorker {
         sources: [
           httpSource,
           new InterceptorSource({
-            interceptors: [new WebSocketInterceptor() as any],
+            interceptors: [new WebSocketInterceptor()],
           }),
         ],
-        onUnhandledFrame: fromLegacyOnUnhandledRequest(() => {
-          return options?.onUnhandledRequest || 'warn'
-        }),
+        onUnhandledFrame: options?.onUnhandledFrame ?? 'warn',
         context: {
           quiet: options?.quiet,
         },
@@ -100,15 +82,8 @@ export function setupWorker(...handlers: Array<AnyHandler>): SetupWorker {
         return registration
       }
     },
-    stop() {
-      if (network.readyState === NetworkReadyState.DISABLED) {
-        devUtils.warn(
-          `Found a redundant "worker.stop()" call. Notice that stopping the worker after it has already been stopped has no effect. Consider removing this "worker.stop()" call.`,
-        )
-        return
-      }
-
-      network.disable()
+    async stop() {
+      await network.disable()
       window.postMessage({ type: 'msw/worker:stop' })
     },
     events: network.events,
@@ -118,31 +93,3 @@ export function setupWorker(...handlers: Array<AnyHandler>): SetupWorker {
     listHandlers: network.listHandlers.bind(network),
   }
 }
-
-/**
- * @deprecated
- * Please use the `defineNetwork` API instead.
- */
-export class SetupWorkerApi implements SetupWorker {
-  start: (options?: StartOptions) => StartReturnType
-  stop: StopHandler
-  use: (...handlers: Array<AnyHandler>) => void
-  resetHandlers: (...nextHandlers: Array<AnyHandler>) => void
-  restoreHandlers: () => void
-  listHandlers: () => ReadonlyArray<AnyHandler>
-  events: LifeCycleEventEmitter<
-    HttpNetworkFrameEventMap & WebSocketNetworkFrameEventMap
-  >
-
-  constructor() {
-    const worker = setupWorker()
-
-    this.start = worker.start.bind(worker)
-    this.stop = worker.stop.bind(worker)
-    this.use = worker.use.bind(worker)
-    this.resetHandlers = worker.resetHandlers.bind(worker)
-    this.restoreHandlers = worker.restoreHandlers.bind(worker)
-    this.listHandlers = worker.listHandlers.bind(worker)
-    this.events = worker.events
-  }
-}

package/src/browser/sources/fallback-http-source.ts

@@ -1,7 +1,7 @@
 import { FetchInterceptor } from '@mswjs/interceptors/fetch'
 import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'
 import { InterceptorSource } from '#core/experimental/sources/interceptor-source'
-import { devUtils } from '#core/utils/internal/devUtils'
+import { devUtils } from '#core/utils/internal/dev-utils'
 
 interface FallbackHttpSourceOptions {
   quiet?: boolean