msw 2.12.13 → 2.13.0

package/lib/browser/index.d.mts

@@ -1,7 +1,7 @@
-import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions.mjs";
-import { RequestHandler } from "../core/handlers/RequestHandler.mjs";
-import { WebSocketHandler } from "../core/handlers/WebSocketHandler.mjs";
-import { SetupApi } from "../core/SetupApi.mjs";
+import { AnyHandler } from "../core/experimental/handlers-controller.mjs";
+import { SharedOptions, LifeCycleEventEmitter } from "../core/sharedOptions.mjs";
+import { HttpNetworkFrameEventMap } from "../core/experimental/frames/http-frame.mjs";
+import { WebSocketNetworkFrameEventMap } from "../core/experimental/frames/websocket-frame.mjs";
 
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
 interface StartOptions extends SharedOptions {
@@ -26,6 +26,9 @@ interface StartOptions extends SharedOptions {
      * 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;
     /**
@@ -51,11 +54,11 @@ interface SetupWorker {
     stop: StopHandler;
     /**
      * Prepends given request handlers to the list of existing handlers.
-     * @param {RequestHandler[]} handlers List of runtime request handlers.
+     * @param {Array<AnyHandler>} handlers List of runtime request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()` API reference}
      */
-    use: (...handlers: Array<RequestHandler | WebSocketHandler>) => void;
+    use: (...handlers: Array<AnyHandler>) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
      *
@@ -64,39 +67,46 @@ interface SetupWorker {
     restoreHandlers: () => void;
     /**
      * Resets request handlers to the initial list given to the `setupWorker` call, or to the explicit next request handlers list, if given.
-     * @param {RequestHandler[]} nextHandlers List of the new initial request handlers.
+     * @param {Array<AnyHandler>} nextHandlers List of the new initial request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` API reference}
      */
-    resetHandlers: (...nextHandlers: Array<RequestHandler | WebSocketHandler>) => void;
+    resetHandlers: (...nextHandlers: Array<AnyHandler>) => void;
     /**
      * Returns a readonly list of currently active request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()` API reference}
      */
-    listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>;
+    listHandlers: () => ReadonlyArray<AnyHandler>;
     /**
      * Life-cycle events.
      * Life-cycle events allow you to subscribe to the internal library events occurring during the request/response handling.
      *
      * @see {@link https://mswjs.io/docs/api/life-cycle-events Life-cycle Events API reference}
      */
-    events: LifeCycleEventEmitter<LifeCycleEventsMap>;
+    events: LifeCycleEventEmitter<HttpNetworkFrameEventMap | WebSocketNetworkFrameEventMap>;
 }
 
-declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements SetupWorker {
-    private context;
-    constructor(...handlers: Array<RequestHandler | WebSocketHandler>);
-    private createWorkerContext;
-    start(options?: StartOptions): StartReturnType;
-    stop(): void;
-}
 /**
  * Sets up a requests interception in the browser with the given request handlers.
- * @param {RequestHandler[]} handlers List of request handlers.
+ * @param {Array<AnyHandler>} handlers List of request handlers.
  *
  * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
  */
-declare function setupWorker(...handlers: Array<RequestHandler | WebSocketHandler>): SetupWorker;
+declare function setupWorker(...handlers: Array<AnyHandler>): SetupWorker;
+/**
+ * @deprecated
+ * Please use the `defineNetwork` API instead.
+ */
+declare 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();
+}
 
 export { type SetupWorker, SetupWorkerApi, type StartOptions, setupWorker };

package/lib/browser/index.d.ts

@@ -1,7 +1,7 @@
-import { SharedOptions, LifeCycleEventEmitter, LifeCycleEventsMap } from "../core/sharedOptions";
-import { RequestHandler } from "../core/handlers/RequestHandler";
-import { WebSocketHandler } from "../core/handlers/WebSocketHandler";
-import { SetupApi } from "../core/SetupApi";
+import { AnyHandler } from "../core/experimental/handlers-controller";
+import { SharedOptions, LifeCycleEventEmitter } from "../core/sharedOptions";
+import { HttpNetworkFrameEventMap } from "../core/experimental/frames/http-frame";
+import { WebSocketNetworkFrameEventMap } from "../core/experimental/frames/websocket-frame";
 
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
 interface StartOptions extends SharedOptions {
@@ -26,6 +26,9 @@ interface StartOptions extends SharedOptions {
      * 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;
     /**
@@ -51,11 +54,11 @@ interface SetupWorker {
     stop: StopHandler;
     /**
      * Prepends given request handlers to the list of existing handlers.
-     * @param {RequestHandler[]} handlers List of runtime request handlers.
+     * @param {Array<AnyHandler>} handlers List of runtime request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()` API reference}
      */
-    use: (...handlers: Array<RequestHandler | WebSocketHandler>) => void;
+    use: (...handlers: Array<AnyHandler>) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
      *
@@ -64,39 +67,46 @@ interface SetupWorker {
     restoreHandlers: () => void;
     /**
      * Resets request handlers to the initial list given to the `setupWorker` call, or to the explicit next request handlers list, if given.
-     * @param {RequestHandler[]} nextHandlers List of the new initial request handlers.
+     * @param {Array<AnyHandler>} nextHandlers List of the new initial request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` API reference}
      */
-    resetHandlers: (...nextHandlers: Array<RequestHandler | WebSocketHandler>) => void;
+    resetHandlers: (...nextHandlers: Array<AnyHandler>) => void;
     /**
      * Returns a readonly list of currently active request handlers.
      *
      * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()` API reference}
      */
-    listHandlers(): ReadonlyArray<RequestHandler | WebSocketHandler>;
+    listHandlers: () => ReadonlyArray<AnyHandler>;
     /**
      * Life-cycle events.
      * Life-cycle events allow you to subscribe to the internal library events occurring during the request/response handling.
      *
      * @see {@link https://mswjs.io/docs/api/life-cycle-events Life-cycle Events API reference}
      */
-    events: LifeCycleEventEmitter<LifeCycleEventsMap>;
+    events: LifeCycleEventEmitter<HttpNetworkFrameEventMap | WebSocketNetworkFrameEventMap>;
 }
 
-declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements SetupWorker {
-    private context;
-    constructor(...handlers: Array<RequestHandler | WebSocketHandler>);
-    private createWorkerContext;
-    start(options?: StartOptions): StartReturnType;
-    stop(): void;
-}
 /**
  * Sets up a requests interception in the browser with the given request handlers.
- * @param {RequestHandler[]} handlers List of request handlers.
+ * @param {Array<AnyHandler>} handlers List of request handlers.
  *
  * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
  */
-declare function setupWorker(...handlers: Array<RequestHandler | WebSocketHandler>): SetupWorker;
+declare function setupWorker(...handlers: Array<AnyHandler>): SetupWorker;
+/**
+ * @deprecated
+ * Please use the `defineNetwork` API instead.
+ */
+declare 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();
+}
 
 export { type SetupWorker, SetupWorkerApi, type StartOptions, setupWorker };