msw 0.28.2 → 0.29.0

package/lib/iife/mockServiceWorker.js

@@ -1,11 +1,12 @@
+/* eslint-disable */
+/* tslint:disable */
+
 /**
  * Mock Service Worker.
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
  */
-/* eslint-disable */
-/* tslint:disable */
 
 const INTEGRITY_CHECKSUM = '82ef9b96d8393b6da34527d1d6e19187'
 const bypassHeaderName = 'x-msw-bypass'

package/lib/types/handlers/GraphQLHandler.d.ts

@@ -1,5 +1,5 @@
 import { OperationTypeNode } from 'graphql';
-import { Mask, ResponseWithSerializedHeaders } from '../setupWorker/glossary';
+import { Mask, SerializedResponse } from '../setupWorker/glossary';
 import { set } from '../context/set';
 import { status } from '../context/status';
 import { delay } from '../context/delay';
@@ -38,5 +38,5 @@ export declare class GraphQLHandler<Request extends GraphQLRequest<any> = GraphQ
     parse(request: MockedRequest): ParsedGraphQLRequest<GraphQLVariables>;
     protected getPublicRequest(request: Request, parsedResult: ParsedGraphQLRequest): GraphQLRequest<any>;
     predicate(request: MockedRequest, parsedResult: ParsedGraphQLRequest): boolean;
-    log(request: Request, response: ResponseWithSerializedHeaders<any>): void;
+    log(request: Request, response: SerializedResponse<any>): void;
 }

package/lib/types/handlers/RequestHandler.d.ts

@@ -61,7 +61,7 @@ export declare abstract class RequestHandler<HandlerInfo extends Record<string,
     /**
      * Print out the successfully handled request.
      */
-    abstract log(request: Request, res: any, handler: this, parsedResult: ParsedResult): void;
+    abstract log(request: Request, response: any, handler: this, parsedResult: ParsedResult): void;
     /**
      * Parse the captured request to extract additional information from it.
      * Parsed result is then exposed to other methods of this request handler.

package/lib/types/handlers/RestHandler.d.ts

@@ -1,6 +1,6 @@
 import { Match } from 'node-match-path';
 import { body, cookie, delay, fetch, json, set, status, text, xml } from '../context';
-import { Mask, ResponseWithSerializedHeaders } from '../setupWorker/glossary';
+import { Mask, SerializedResponse } from '../setupWorker/glossary';
 import { DefaultRequestBody, MockedRequest, RequestHandler, ResponseResolver } from './RequestHandler';
 interface RestHandlerInfo {
     method: string;
@@ -47,6 +47,6 @@ export declare class RestHandler<RequestType extends MockedRequest<DefaultReques
     parse(request: RequestType): Match;
     protected getPublicRequest(request: RequestType, parsedResult: ParsedRestRequest): RestRequest<any, RequestParams>;
     predicate(request: RequestType, parsedResult: ParsedRestRequest): boolean;
-    log(request: RequestType, response: ResponseWithSerializedHeaders<any>): void;
+    log(request: RequestType, response: SerializedResponse<any>): void;
 }
 export {};

package/lib/types/node/glossary.d.ts

@@ -1,3 +1,4 @@
+import { PartialDeep } from 'type-fest';
 import { IsomorphicResponse } from '@mswjs/interceptors';
 import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
 import { SharedOptions } from '../sharedOptions';
@@ -14,7 +15,7 @@ export interface SetupServerApi {
      * Starts requests interception based on the previously provided request handlers.
      * @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()`}
      */
-    listen(options?: SharedOptions): void;
+    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()`}

package/lib/types/setupWorker/glossary.d.ts

@@ -1,11 +1,11 @@
-import { HeadersList } from 'headers-utils';
+import { PartialDeep } from 'type-fest';
+import { FlatHeadersObject } from 'headers-utils';
 import { StrictEventEmitter } from 'strict-event-emitter';
 import { MockedResponse } from '../response';
 import { SharedOptions } from '../sharedOptions';
 import { ServiceWorkerMessage } from '../utils/createBroadcastChannel';
-import { createStart } from './start/createStart';
-import { createStop } from './stop/createStop';
 import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
+import { InterceptorApi } from '@mswjs/interceptors';
 export declare type Mask = RegExp | string;
 export declare type ResolvedMask = Mask | URL;
 declare type RequestWithoutMethods = Omit<Request, 'text' | 'body' | 'json' | 'blob' | 'arrayBuffer' | 'formData' | 'clone' | 'signal' | 'isHistoryNavigation' | 'isReloadNavigation'>;
@@ -55,7 +55,7 @@ export interface WorkerLifecycleEventsMap {
     'response:bypass': (response: Response, requestId: string) => void;
 }
 export interface SetupWorkerInternalContext {
-    startOptions: StartOptions | undefined;
+    startOptions?: StartOptions;
     worker: ServiceWorker | null;
     registration: ServiceWorkerRegistration | null;
     requestHandlers: RequestHandler[];
@@ -83,50 +83,55 @@ export interface SetupWorkerInternalContext {
          */
         once<EventType extends keyof ServiceWorkerIncomingEventsMap>(eventType: EventType): Promise<ServiceWorkerMessage<EventType, ServiceWorkerIncomingEventsMap[EventType]>>;
     };
+    useFallbackMode: boolean;
+    fallbackInterceptor?: InterceptorApi;
 }
 export declare type ServiceWorkerInstanceTuple = [
     ServiceWorker | null,
     ServiceWorkerRegistration
 ];
 export declare type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
-export declare type StartOptions = SharedOptions & {
+export interface StartOptions extends SharedOptions {
     /**
      * Service Worker instance options.
      */
-    serviceWorker?: {
-        url?: string;
-        options?: RegistrationOptions;
+    serviceWorker: {
+        url: string;
+        options: RegistrationOptions;
     };
     /**
      * Disables the logging of captured requests
      * into browser's console.
      */
-    quiet?: boolean;
+    quiet: boolean;
     /**
      * Defers any network requests until the Service Worker
      * instance is ready. Defaults to `true`.
      */
-    waitUntilReady?: boolean;
+    waitUntilReady: boolean;
     /**
      * A custom lookup function to find a Mock Service Worker in the list
      * of all registered Service Workers on the page.
      */
-    findWorker?: FindWorker;
-};
-export declare type ResponseWithSerializedHeaders<BodyType = any> = Omit<MockedResponse<BodyType>, 'headers'> & {
-    headers: HeadersList;
+    findWorker: FindWorker;
+}
+export declare type SerializedResponse<BodyType = any> = Omit<MockedResponse<BodyType>, 'headers'> & {
+    headers: FlatHeadersObject;
 };
+export declare type StartReturnType = Promise<ServiceWorkerRegistration | undefined>;
+export declare type StartHandler = (options: StartOptions, initialOptions: PartialDeep<StartOptions>) => StartReturnType;
+export declare type StopHandler = () => void;
 export interface SetupWorkerApi {
     /**
      * Registers and activates the mock Service Worker.
      * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
      */
-    start: ReturnType<typeof createStart>;
+    start: (options?: PartialDeep<StartOptions>) => StartReturnType;
     /**
      * Stops requests interception for the current client.
      * @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()`}
      */
-    stop: ReturnType<typeof createStop>;
+    stop: StopHandler;
     /**
      * Prepends given request handlers to the list of existing handlers.
      * @param {RequestHandler[]} handlers List of runtime request handlers.

package/lib/types/setupWorker/start/createFallbackStart.d.ts

@@ -0,0 +1,2 @@
+import { SetupWorkerInternalContext, StartHandler } from '../glossary';
+export declare function createFallbackStart(context: SetupWorkerInternalContext): StartHandler;

package/lib/types/setupWorker/start/createStartHandler.d.ts

@@ -0,0 +1,2 @@
+import { SetupWorkerInternalContext, StartHandler } from '../glossary';
+export declare const createStartHandler: (context: SetupWorkerInternalContext) => StartHandler;

package/lib/types/setupWorker/start/utils/enableMocking.d.ts

@@ -0,0 +1,5 @@
+import { StartOptions, SetupWorkerInternalContext } from '../../glossary';
+/**
+ * Signals the worker to enable the interception of requests.
+ */
+export declare function enableMocking(context: SetupWorkerInternalContext, options: StartOptions): Promise<void>;

package/lib/types/setupWorker/start/utils/prepareStartHandler.d.ts

@@ -0,0 +1,9 @@
+import { PartialDeep } from 'type-fest';
+import { SetupWorkerApi, SetupWorkerInternalContext, StartHandler, StartOptions } from '../../glossary';
+export declare const DEFAULT_START_OPTIONS: StartOptions;
+/**
+ * Returns resolved worker start options, merging the default options
+ * with the given custom options.
+ */
+export declare function resolveStartOptions(initialOptions?: PartialDeep<StartOptions>): StartOptions;
+export declare function prepareStartHandler(handler: StartHandler, context: SetupWorkerInternalContext): SetupWorkerApi['start'];

package/lib/types/setupWorker/start/utils/printStartMessage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Prints a worker activation message in the browser's console.
+ */
+export declare function printStartMessage(args?: {
+    quiet?: boolean;
+    message?: string;
+}): void;

package/lib/types/setupWorker/stop/createFallbackStop.d.ts

@@ -0,0 +1,2 @@
+import { SetupWorkerInternalContext, StopHandler } from '../glossary';
+export declare function createFallbackStop(context: SetupWorkerInternalContext): StopHandler;

package/lib/types/setupWorker/stop/createStop.d.ts

@@ -1,2 +1,2 @@
-import { SetupWorkerInternalContext } from '../glossary';
-export declare const createStop: (context: SetupWorkerInternalContext) => () => void;
+import { SetupWorkerInternalContext, StopHandler } from '../glossary';
+export declare const createStop: (context: SetupWorkerInternalContext) => StopHandler;

package/lib/types/setupWorker/stop/utils/printStopMessage.d.ts

@@ -0,0 +1,3 @@
+export declare function printStopMessage(args?: {
+    quiet?: boolean;
+}): void;

package/lib/types/sharedOptions.d.ts

@@ -2,10 +2,11 @@ import { UnhandledRequestStrategy } from './utils/request/onUnhandledRequest';
 export interface SharedOptions {
     /**
      * Specifies how to react to a request that has no corresponding
-     * request handler. Bypasses such requests by default.
+     * request handler. Warns on unhandled requests by default.
      *
+     * @example worker.start({ onUnhandledRequest: 'bypass' })
      * @example worker.start({ onUnhandledRequest: 'warn' })
      * @example server.listen({ onUnhandledRequest: 'error' })
      */
-    onUnhandledRequest?: UnhandledRequestStrategy;
+    onUnhandledRequest: UnhandledRequestStrategy;
 }

package/lib/types/utils/getResponse.d.ts

@@ -1,6 +1,6 @@
 import { MockedResponse } from '../response';
 import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
-interface ResponsePayload {
+export interface ResponseLookupResult {
     handler?: RequestHandler;
     publicRequest?: any;
     parsedRequest?: any;
@@ -9,5 +9,4 @@ interface ResponsePayload {
 /**
  * Returns a mocked response for a given request using following request handlers.
  */
-export declare const getResponse: <Request_1 extends MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, Handler extends RequestHandler<Record<string, any>, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, any, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>>[]>(request: Request_1, handlers: Handler) => Promise<ResponsePayload>;
-export {};
+export declare const getResponse: <Request_1 extends MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, Handler extends RequestHandler<Record<string, any>, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, any, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>>[]>(request: Request_1, handlers: Handler) => Promise<ResponseLookupResult>;

package/lib/types/utils/handleRequest.d.ts

@@ -0,0 +1,27 @@
+import { StrictEventEmitter } from 'strict-event-emitter';
+import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
+import { ServerLifecycleEventsMap } from '../node/glossary';
+import { MockedResponse } from '../response';
+import { SharedOptions } from '../sharedOptions';
+import { ResponseLookupResult } from './getResponse';
+export interface HandleRequestOptions<ResponseType> {
+    /**
+     * Transforms a `MockedResponse` instance returned from a handler
+     * to a response instance
+     */
+    transformResponse?(response: MockedResponse<string>): ResponseType;
+    /**
+     * Invoked whenever returning a bypassed (as-is) response.
+     */
+    onBypassResponse?(request: MockedRequest): void;
+    /**
+     * Invoked when the mocked response is ready to be sent.
+     */
+    onMockedResponse?(response: ResponseType, handler: DeepRequired<ResponseLookupResult>): void;
+    /**
+     * Invoked when the mocked response is sent.
+     * Respects the response delay duration.
+     */
+    onMockedResponseSent?(response: ResponseType, handler: DeepRequired<ResponseLookupResult>): void;
+}
+export declare function handleRequest<ResponseType extends Record<string, any> = MockedResponse<string>>(request: MockedRequest, handlers: RequestHandler[], options: SharedOptions, emitter: StrictEventEmitter<ServerLifecycleEventsMap>, handleRequestOptions?: HandleRequestOptions<ResponseType>): Promise<ResponseType | undefined>;

package/lib/types/utils/logging/prepareResponse.d.ts

@@ -1,12 +1,12 @@
-import { ResponseWithSerializedHeaders } from '../../setupWorker/glossary';
+import { SerializedResponse } from '../../setupWorker/glossary';
 /**
  * Formats a mocked response for introspection in browser's console.
  */
-export declare function prepareResponse(res: ResponseWithSerializedHeaders<any>): {
+export declare function prepareResponse(res: SerializedResponse<any>): {
     body: string | Record<string, any> | undefined;
     status: number;
     statusText: string;
     once: boolean;
     delay?: number | undefined;
-    headers: import("headers-utils").HeadersList;
+    headers: import("headers-utils").FlatHeadersObject;
 };

package/lib/types/utils/request/parseIsomorphicRequest.d.ts

@@ -0,0 +1,6 @@
+import { IsomorphicRequest } from '@mswjs/interceptors';
+import { MockedRequest } from '../../handlers/RequestHandler';
+/**
+ * Converts a given isomorphic request to a `MockedRequest` instance.
+ */
+export declare function parseIsomorphicRequest(request: IsomorphicRequest): MockedRequest;

package/lib/types/utils/request/parseWorkerRequest.d.ts

@@ -1,3 +1,7 @@
 import { MockedRequest } from '../../handlers/RequestHandler';
 import { ServiceWorkerIncomingRequest } from '../../setupWorker/glossary';
+/**
+ * Converts a given request received from the Service Worker
+ * into a `MockedRequest` instance.
+ */
 export declare function parseWorkerRequest(rawRequest: ServiceWorkerIncomingRequest): MockedRequest;

package/lib/types/utils/worker/createFallbackRequestListener.d.ts

@@ -0,0 +1,3 @@
+import { InterceptorApi } from '@mswjs/interceptors';
+import { SetupWorkerInternalContext, StartOptions } from '../../setupWorker/glossary';
+export declare function createFallbackRequestListener(context: SetupWorkerInternalContext, options: StartOptions): InterceptorApi;