msw 0.33.1 → 0.35.0

package/lib/iife/mockServiceWorker.js

@@ -2,13 +2,13 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (0.33.1).
+ * Mock Service Worker (0.35.0).
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
  */
 
-const INTEGRITY_CHECKSUM = 'a615cd395ea10f948a628bce3857a385'
+const INTEGRITY_CHECKSUM = 'f0a916b13c8acc2b526a03a6d26df85f'
 const bypassHeaderName = 'x-msw-bypass'
 const activeClientIds = new Set()
 
@@ -221,13 +221,11 @@ async function getResponse(event, client, requestId) {
 
       console.error(
         `\
-[MSW] Request handler function for "%s %s" has thrown the following exception:
+[MSW] Uncaught exception in the request handler for "%s %s":
 
-${parsedBody.errorType}: ${parsedBody.message}
-(see more detailed error stack trace in the mocked response body)
+${parsedBody.location}
 
-This exception has been gracefully handled as a 500 response, however, it's strongly recommended to resolve this error.
-If you wish to mock an error response, please refer to this guide: https://mswjs.io/docs/recipes/mocking-error-responses\
+This exception has been gracefully handled as a 500 response, however, it's strongly recommended to resolve this error, as it indicates a mistake in your code. If you wish to mock an error response, please see this guide: https://mswjs.io/docs/recipes/mocking-error-responses\
 `,
         request.method,
         request.url,
@@ -271,11 +269,22 @@ self.addEventListener('fetch', function (event) {
 
   return event.respondWith(
     handleRequest(event, requestId).catch((error) => {
+      if (error.name === 'NetworkError') {
+        console.warn(
+          '[MSW] Successfully emulated a network error for the "%s %s" request.',
+          request.method,
+          request.url,
+        )
+        return
+      }
+
+      // At this point, any exception indicates an issue with the original request/response.
       console.error(
-        '[MSW] Failed to mock a "%s" request to "%s": %s',
+        `\
+[MSW] Caught an exception from the "%s %s" request (%s). This is probably not a problem with Mock Service Worker. There is likely an additional logging output above.`,
         request.method,
         request.url,
-        error,
+        `${error.name}: ${error.message}`,
       )
     }),
   )

package/lib/types/graphql.d.ts

@@ -1,6 +1,15 @@
+import { DocumentNode } from 'graphql';
 import { Path } from 'node-match-path';
 import { ResponseResolver } from './handlers/RequestHandler';
 import { GraphQLHandler, GraphQLContext, GraphQLRequest, GraphQLVariables, GraphQLHandlerNameSelector } from './handlers/GraphQLHandler';
+export interface TypedDocumentNode<Result = {
+    [key: string]: any;
+}, Variables = {
+    [key: string]: any;
+}> extends DocumentNode {
+    __resultType?: Result;
+    __variablesType?: Variables;
+}
 declare const standardGraphQLHandlers: {
     /**
      * Captures any GraphQL operation, regardless of its name, under the current scope.
@@ -19,7 +28,7 @@ declare const standardGraphQLHandlers: {
      * })
      * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
      */
-    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
+    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
     /**
      * Captures a GraphQL mutation by a given name.
      * @example
@@ -28,7 +37,7 @@ declare const standardGraphQLHandlers: {
      * })
      * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
      */
-    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
+    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
 };
 declare function createGraphQLLink(url: Path): typeof standardGraphQLHandlers;
 export declare const graphql: {
@@ -50,7 +59,7 @@ export declare const graphql: {
      * })
      * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
      */
-    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
+    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
     /**
      * Captures a GraphQL mutation by a given name.
      * @example
@@ -59,6 +68,6 @@ export declare const graphql: {
      * })
      * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
      */
-    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
+    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<any>>;
 };
 export {};

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

@@ -1,4 +1,4 @@
-import { OperationTypeNode } from 'graphql';
+import { DocumentNode, OperationTypeNode } from 'graphql';
 import { Path } from 'node-match-path';
 import { SerializedResponse } from '../setupWorker/glossary';
 import { set } from '../context/set';
@@ -11,7 +11,7 @@ import { cookie } from '../context/cookie';
 import { MockedRequest, RequestHandler, ResponseResolver } from './RequestHandler';
 import { ParsedGraphQLRequest, GraphQLMultipartRequestBody } from '../utils/internal/parseGraphQLRequest';
 export declare type ExpectedOperationTypeNode = OperationTypeNode | 'all';
-export declare type GraphQLHandlerNameSelector = RegExp | string;
+export declare type GraphQLHandlerNameSelector = DocumentNode | RegExp | string;
 export declare type GraphQLContext<QueryType> = {
     set: typeof set;
     status: typeof status;
@@ -35,6 +35,7 @@ export interface GraphQLJsonRequestBody<Variables extends GraphQLVariables> {
 export interface GraphQLRequest<Variables extends GraphQLVariables> extends MockedRequest<GraphQLRequestBody<Variables>> {
     variables: Variables;
 }
+export declare function isDocumentNode(value: DocumentNode | any): value is DocumentNode;
 export declare class GraphQLHandler<Request extends GraphQLRequest<any> = GraphQLRequest<any>> extends RequestHandler<GraphQLHandlerInfo, Request, ParsedGraphQLRequest | null, GraphQLRequest<any>> {
     private endpoint;
     constructor(operationType: ExpectedOperationTypeNode, operationName: GraphQLHandlerNameSelector, endpoint: Path, resolver: ResponseResolver<any, any>);

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

@@ -1,15 +1,8 @@
 import { PartialDeep } from 'type-fest';
 import { IsomorphicResponse } from '@mswjs/interceptors';
-import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
-import { SharedOptions } from '../sharedOptions';
-export interface ServerLifecycleEventsMap {
-    'request:start': (request: MockedRequest) => void;
-    'request:match': (request: MockedRequest) => void;
-    'request:unhandled': (request: MockedRequest) => void;
-    'request:end': (request: MockedRequest) => void;
-    'response:mocked': (response: IsomorphicResponse, requestId: string) => void;
-    'response:bypass': (response: IsomorphicResponse, requestId: string) => void;
-}
+import { RequestHandler } from '../handlers/RequestHandler';
+import { LifeCycleEventEmitter, LifeCycleEventsMap, SharedOptions } from '../sharedOptions';
+export declare type ServerLifecycleEventsMap = LifeCycleEventsMap<IsomorphicResponse>;
 export interface SetupServerApi {
     /**
      * Starts requests interception based on the previously provided request handlers.
@@ -41,8 +34,5 @@ export interface SetupServerApi {
      * @see {@link https://mswjs.io/docs/api/setup-server/print-handlers `server.print-handlers()`}
      */
     printHandlers(): void;
-    /**
-     * Attaches a listener to one of the life-cycle events.
-     */
-    on<EventType extends keyof ServerLifecycleEventsMap>(eventType: EventType, listener: ServerLifecycleEventsMap[EventType]): void;
+    events: LifeCycleEventEmitter<ServerLifecycleEventsMap>;
 }

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

@@ -2,9 +2,9 @@ import { Path } from 'node-match-path';
 import { PartialDeep } from 'type-fest';
 import { FlatHeadersObject } from 'headers-utils';
 import { StrictEventEmitter } from 'strict-event-emitter';
-import { SharedOptions } from '../sharedOptions';
+import { LifeCycleEventEmitter, LifeCycleEventsMap, SharedOptions } from '../sharedOptions';
 import { ServiceWorkerMessage } from '../utils/createBroadcastChannel';
-import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
+import { RequestHandler } from '../handlers/RequestHandler';
 import { InterceptorApi } from '@mswjs/interceptors';
 export declare type ResolvedPath = Path | URL;
 declare type RequestWithoutMethods = Omit<Request, 'text' | 'body' | 'json' | 'blob' | 'arrayBuffer' | 'formData' | 'clone' | 'signal' | 'isHistoryNavigation' | 'isReloadNavigation'>;
@@ -45,14 +45,7 @@ export declare type ServiceWorkerOutgoingEventTypes = 'MOCK_ACTIVATE' | 'MOCK_DE
  * only as a part of a single `fetch` event handler.
  */
 export declare type ServiceWorkerFetchEventTypes = 'MOCK_SUCCESS' | 'MOCK_NOT_FOUND' | 'NETWORK_ERROR' | 'INTERNAL_ERROR';
-export interface WorkerLifecycleEventsMap {
-    'request:start': (request: MockedRequest) => void;
-    'request:match': (request: MockedRequest) => void;
-    'request:unhandled': (request: MockedRequest) => void;
-    'request:end': (request: MockedRequest) => void;
-    'response:mocked': (response: Response, requestId: string) => void;
-    'response:bypass': (response: Response, requestId: string) => void;
-}
+export declare type WorkerLifecycleEventsMap = LifeCycleEventsMap<Response>;
 export interface SetupWorkerInternalContext {
     startOptions?: StartOptions;
     worker: ServiceWorker | null;
@@ -156,9 +149,6 @@ export interface SetupWorkerApi {
      * @see {@link https://mswjs.io/docs/api/setup-worker/print-handlers `worker.printHandlers()`}
      */
     printHandlers: () => void;
-    /**
-     * Attaches a listener to one of the life-cycle events.
-     */
-    on<EventType extends keyof WorkerLifecycleEventsMap>(eventType: EventType, listener: WorkerLifecycleEventsMap[EventType]): void;
+    events: LifeCycleEventEmitter<WorkerLifecycleEventsMap>;
 }
 export {};

package/lib/types/sharedOptions.d.ts

@@ -1,3 +1,5 @@
+import { StrictEventEmitter } from 'strict-event-emitter';
+import { MockedRequest } from './handlers/RequestHandler';
 import { UnhandledRequestStrategy } from './utils/request/onUnhandledRequest';
 export interface SharedOptions {
     /**
@@ -10,3 +12,12 @@ export interface SharedOptions {
      */
     onUnhandledRequest: UnhandledRequestStrategy;
 }
+export 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;
+}
+export declare type LifeCycleEventEmitter<ResponseType> = Pick<StrictEventEmitter<ResponseType>, 'on' | 'removeListener' | 'removeAllListeners'>;

package/lib/types/utils/internal/parseGraphQLRequest.d.ts

@@ -1,4 +1,4 @@
-import { OperationTypeNode } from 'graphql';
+import { DocumentNode, OperationTypeNode } from 'graphql';
 import { GraphQLVariables } from '../../handlers/GraphQLHandler';
 import { MockedRequest } from '../../handlers/RequestHandler';
 export interface ParsedGraphQLQuery {
@@ -8,6 +8,7 @@ export interface ParsedGraphQLQuery {
 export declare type ParsedGraphQLRequest<VariablesType extends GraphQLVariables = GraphQLVariables> = (ParsedGraphQLQuery & {
     variables?: VariablesType;
 }) | undefined;
+export declare function parseDocumentNode(node: DocumentNode): ParsedGraphQLQuery;
 export declare type GraphQLParsedOperationsMap = Record<string, string[]>;
 export declare type GraphQLMultipartRequestBody = {
     operations: string;

package/lib/types/utils/internal/pipeEvents.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { EventEmitter } from 'stream';
+/**
+ * Pipes all emitted events from one emitter to another.
+ */
+export declare function pipeEvents(source: EventEmitter, destination: EventEmitter): void;

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

@@ -1,4 +1,9 @@
+export declare enum StatusCodeColor {
+    Success = "#69AB32",
+    Warning = "#F0BB4B",
+    Danger = "#E95F5D"
+}
 /**
  * Returns a HEX color for a given response status code number.
  */
-export declare function getStatusCodeColor(status: number): "#69AB32" | "#F0BB4B" | "#E95F5D";
+export declare function getStatusCodeColor(status: number): StatusCodeColor;