msw 0.49.2 → 1.0.0

package/lib/{SetupServerApi-70cc71a7.d.ts → SetupServerApi-39df862c.d.ts}

@@ -1,8 +1,8 @@
 import { IsomorphicResponse, BatchInterceptor, Interceptor, HttpRequestEventMap } from '@mswjs/interceptors';
-import { I as LifeCycleEventsMap, m as SetupApi, b as RequestHandler, l as SharedOptions } from './SetupApi-b2f0e5ac.js';
+import { L as LifeCycleEventsMap, S as SetupApi, K as SetupServer, c as RequestHandler, o as SharedOptions } from './glossary-de6278a9.js';
 
 type ServerLifecycleEventsMap = LifeCycleEventsMap<IsomorphicResponse>;
-declare class SetupServerApi extends SetupApi<ServerLifecycleEventsMap> {
+declare class SetupServerApi extends SetupApi<ServerLifecycleEventsMap> implements SetupServer {
     protected readonly interceptor: BatchInterceptor<Array<Interceptor<HttpRequestEventMap>>, HttpRequestEventMap>;
     private resolvedOptions;
     constructor(interceptors: Array<{

package/lib/{SetupApi-b2f0e5ac.d.ts → glossary-de6278a9.d.ts}

@@ -1,6 +1,7 @@
-import { StrictEventEmitter, EventMapType } from 'strict-event-emitter';
+import { Emitter, EventMap } from 'strict-event-emitter';
+import { PartialDeep } from 'type-fest';
+import { RequestInit as RequestInit$1, IsomorphicRequest, IsomorphicResponse } from '@mswjs/interceptors';
 import { FlatHeadersObject, Headers } from 'headers-polyfill';
-import { RequestInit as RequestInit$1, IsomorphicRequest } from '@mswjs/interceptors';
 
 type HeadersObject<KeyType extends string = string> = Record<KeyType, string | string[]>;
 /**
@@ -114,15 +115,16 @@ interface SharedOptions {
     onUnhandledRequest?: UnhandledRequestStrategy;
 }
 interface LifeCycleEventsMap<ResponseType> {
-    'request:start': (request: MockedRequest) => void;
-    'request:match': (request: MockedRequest) => void;
-    'request:unhandled': (request: MockedRequest) => void;
-    'request:end': (request: MockedRequest) => void;
-    'response:mocked': (response: ResponseType, requestId: string) => void;
-    'response:bypass': (response: ResponseType, requestId: string) => void;
-    unhandledException: (error: Error, request: MockedRequest) => void;
+    'request:start': [MockedRequest];
+    'request:match': [MockedRequest];
+    'request:unhandled': [MockedRequest];
+    'request:end': [MockedRequest];
+    'response:mocked': [response: ResponseType, requestId: string];
+    'response:bypass': [response: ResponseType, requestId: string];
+    unhandledException: [error: Error, request: MockedRequest];
+    [key: string]: Array<unknown>;
 }
-type LifeCycleEventEmitter<ResponseType extends Record<string | symbol, any>> = Pick<StrictEventEmitter<ResponseType>, 'on' | 'removeListener' | 'removeAllListeners'>;
+type LifeCycleEventEmitter<ResponseType extends Record<string | symbol, any>> = Pick<Emitter<ResponseType>, 'on' | 'removeListener' | 'removeAllListeners'>;
 
 type WorkerLifecycleEventsMap = LifeCycleEventsMap<Response>;
 type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
@@ -165,7 +167,7 @@ interface SerializedResponse<BodyType extends DefaultBodyType = any> {
 }
 type StartReturnType = Promise<ServiceWorkerRegistration | undefined>;
 type StopHandler = () => void;
-interface SetupWorkerApi {
+interface SetupWorker {
     /**
      * Registers and activates the mock Service Worker.
      * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
@@ -323,11 +325,11 @@ declare const status: (statusCode: number, statusText?: string) => ResponseTrans
 /**
  * Generic class for the mock API setup.
  */
-declare abstract class SetupApi<EventsMap extends EventMapType> {
+declare abstract class SetupApi<EventsMap extends EventMap> {
     protected initialHandlers: ReadonlyArray<RequestHandler>;
     protected currentHandlers: Array<RequestHandler>;
-    protected readonly emitter: StrictEventEmitter<EventsMap>;
-    protected readonly publicEmitter: StrictEventEmitter<EventsMap>;
+    protected readonly emitter: Emitter<EventsMap>;
+    protected readonly publicEmitter: Emitter<EventsMap>;
     readonly events: LifeCycleEventEmitter<EventsMap>;
     constructor(...initialHandlers: Array<RequestHandler>);
     private validateHandlers;
@@ -340,4 +342,44 @@ declare abstract class SetupApi<EventsMap extends EventMapType> {
     abstract printHandlers(): void;
 }
 
-export { AsyncResponseResolverReturnType as A, RequestMode as B, RequestRedirect as C, DefaultContext as D, RequestDestination as E, RequestPriority as F, RequestReferrerPolicy as G, MockedRequestInit as H, LifeCycleEventsMap as I, LifeCycleEventEmitter as L, MockedRequest as M, ResponseTransformer as R, SetupWorkerApi as S, set as a, RequestHandler as b, DefaultBodyType as c, delay as d, ResponseResolver as e, fetch as f, ResponseResolutionContext as g, SerializedResponse as h, RequestHandlerDefaultInfo as i, MockedResponse as j, ResponseLookupResult as k, SharedOptions as l, SetupApi as m, defaultResponse as n, createResponseComposition as o, defaultContext as p, StartOptions as q, response as r, status as s, ResponseResolverReturnType as t, DefaultRequestMultipartBody as u, ResponseComposition as v, ResponseCompositionOptions as w, ResponseFunction as x, DelayMode as y, RequestCache as z };
+type ServerLifecycleEventsMap = LifeCycleEventsMap<IsomorphicResponse>;
+interface SetupServer {
+    /**
+     * Starts requests interception based on the previously provided request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()`}
+     */
+    listen(options?: PartialDeep<SharedOptions>): void;
+    /**
+     * Stops requests interception by restoring all augmented modules.
+     * @see {@link https://mswjs.io/docs/api/setup-server/close `server.close()`}
+     */
+    close(): void;
+    /**
+     * Prepends given request handlers to the list of existing handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()`}
+     */
+    use(...handlers: RequestHandler[]): void;
+    /**
+     * Marks all request handlers that respond using `res.once()` as unused.
+     * @see {@link https://mswjs.io/docs/api/setup-server/restore-handlers `server.restore-handlers()`}
+     */
+    restoreHandlers(): void;
+    /**
+     * Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
+     * @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()`}
+     */
+    resetHandlers(...nextHandlers: RequestHandler[]): void;
+    /**
+     * Returns a readonly list of currently active request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/list-handlers `server.listHandlers()`}
+     */
+    listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, MockedRequest<DefaultBodyType>, any, MockedRequest<DefaultBodyType>>>;
+    /**
+     * Lists all active request handlers.
+     * @see {@link https://mswjs.io/docs/api/setup-server/print-handlers `server.print-handlers()`}
+     */
+    printHandlers(): void;
+    events: LifeCycleEventEmitter<ServerLifecycleEventsMap>;
+}
+
+export { AsyncResponseResolverReturnType as A, DelayMode as B, RequestCache as C, DefaultContext as D, RequestMode as E, RequestRedirect as F, RequestDestination as G, RequestPriority as H, RequestReferrerPolicy as I, MockedRequestInit as J, SetupServer as K, LifeCycleEventsMap as L, MockedRequest as M, ResponseTransformer as R, SetupApi as S, WorkerLifecycleEventsMap as W, set as a, SetupWorker as b, RequestHandler as c, delay as d, StartOptions as e, fetch as f, StartReturnType as g, DefaultBodyType as h, ResponseResolver as i, ResponseResolutionContext as j, SerializedResponse as k, RequestHandlerDefaultInfo as l, MockedResponse as m, ResponseLookupResult as n, SharedOptions as o, ServerLifecycleEventsMap as p, defaultResponse as q, response as r, status as s, createResponseComposition as t, defaultContext as u, ResponseResolverReturnType as v, DefaultRequestMultipartBody as w, ResponseComposition as x, ResponseCompositionOptions as y, ResponseFunction as z };