msw 2.10.0 → 2.10.2

package/lib/mockServiceWorker.js

@@ -7,7 +7,7 @@
  * - Please do NOT modify this file.
  */
 
-const PACKAGE_VERSION = '2.10.0'
+const PACKAGE_VERSION = '2.10.2'
 const INTEGRITY_CHECKSUM = 'f5825c521429caf22a4dd13b66e243af'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "2.10.0",
+  "version": "2.10.2",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
   "type": "commonjs",
   "main": "./lib/core/index.js",
@@ -218,7 +218,7 @@
     "@bundled-es-modules/statuses": "^1.0.1",
     "@bundled-es-modules/tough-cookie": "^0.1.6",
     "@inquirer/confirm": "^5.0.0",
-    "@mswjs/interceptors": "^0.38.7",
+    "@mswjs/interceptors": "^0.39.1",
     "@open-draft/deferred-promise": "^2.2.0",
     "@open-draft/until": "^2.1.0",
     "@types/cookie": "^0.6.0",
@@ -280,7 +280,7 @@
     "vitest-environment-miniflare": "^2.14.4",
     "webpack": "^5.95.0",
     "webpack-http-server": "^0.5.0",
-    "msw": "2.10.0"
+    "msw": "2.10.2"
   },
   "peerDependencies": {
     "typescript": ">= 4.8.x"

package/src/core/HttpResponse.ts

@@ -10,7 +10,10 @@ export interface HttpResponseInit extends ResponseInit {
   type?: ResponseType
 }
 
-const bodyType: unique symbol = Symbol('bodyType')
+export const bodyType: unique symbol = Symbol('bodyType')
+export type DefaultUnsafeFetchResponse = Response & {
+  [bodyType]?: never
+}
 
 export interface StrictRequest<BodyType extends JsonBodyType> extends Request {
   json(): Promise<BodyType>
@@ -46,6 +49,10 @@ export class HttpResponse<
     decorateResponse(this, responseInit)
   }
 
+  static error(): HttpResponse<any> {
+    return super.error() as HttpResponse<any>
+  }
+
   /**
    * Create a `Response` with a `Content-Type: "text/plain"` body.
    * @example

package/src/core/handlers/RequestHandler.ts

@@ -6,8 +6,13 @@ import {
 } from '../utils/internal/isIterable'
 import type { ResponseResolutionContext } from '../utils/executeHandlers'
 import type { MaybePromise } from '../typeUtils'
-import type { HttpResponse, StrictRequest } from '..//HttpResponse'
+import {
+  StrictRequest,
+  HttpResponse,
+  DefaultUnsafeFetchResponse,
+} from '../HttpResponse'
 import type { HandlerKind } from './common'
+import type { GraphQLRequestBody } from './GraphQLHandler'
 
 export type DefaultRequestMultipartBody = Record<
   string,
@@ -42,9 +47,19 @@ export interface RequestHandlerInternalInfo {
 export type ResponseResolverReturnType<
   ResponseBodyType extends DefaultBodyType = undefined,
 > =
+  // If ResponseBodyType is a union and one of the types is `undefined`,
+  // allow plain Response as the type.
   | ([ResponseBodyType] extends [undefined]
       ? Response
-      : HttpResponse<ResponseBodyType>)
+      : /**
+         * Treat GraphQL response body type as a special case.
+         * For esome reason, making the default HttpResponse<T> | DefaultUnsafeFetchResponse
+         * union breaks the body type inference for HTTP requests.
+         * @see https://github.com/mswjs/msw/issues/2130
+         */
+        ResponseBodyType extends GraphQLRequestBody<any>
+        ? HttpResponse<ResponseBodyType> | DefaultUnsafeFetchResponse
+        : HttpResponse<ResponseBodyType>)
   | undefined
   | void
 

package/src/core/handlers/WebSocketHandler.ts

@@ -1,6 +1,10 @@
 import { Emitter } from 'strict-event-emitter'
 import { createRequestId } from '@mswjs/interceptors'
-import type { WebSocketConnectionData } from '@mswjs/interceptors/WebSocket'
+import type {
+  WebSocketClientConnectionProtocol,
+  WebSocketConnectionData,
+  WebSocketServerConnectionProtocol,
+} from '@mswjs/interceptors/WebSocket'
 import {
   type Match,
   type Path,
@@ -18,7 +22,10 @@ export type WebSocketHandlerEventMap = {
   connection: [args: WebSocketHandlerConnection]
 }
 
-export interface WebSocketHandlerConnection extends WebSocketConnectionData {
+export interface WebSocketHandlerConnection {
+  client: WebSocketClientConnectionProtocol
+  server: WebSocketServerConnectionProtocol
+  info: WebSocketConnectionData['info']
   params: PathParams
 }
 
@@ -67,7 +74,9 @@ export class WebSocketHandler {
     return args.parsedResult.match.matches
   }
 
-  public async run(connection: WebSocketConnectionData): Promise<boolean> {
+  public async run(
+    connection: Omit<WebSocketHandlerConnection, 'params'>,
+  ): Promise<boolean> {
     const parsedResult = this.parse({
       url: connection.client.url,
     })

package/src/core/ws/WebSocketClientManager.ts

@@ -1,7 +1,7 @@
 import type {
   WebSocketData,
-  WebSocketClientConnection,
   WebSocketClientConnectionProtocol,
+  WebSocketClientEventMap,
 } from '@mswjs/interceptors/WebSocket'
 import { WebSocketClientStore } from './WebSocketClientStore'
 import { WebSocketMemoryClientStore } from './WebSocketMemoryClientStore'
@@ -105,7 +105,9 @@ export class WebSocketClientManager {
     this.channel.postMessage({ type: 'db:update' })
   }
 
-  private async addClient(client: WebSocketClientConnection): Promise<void> {
+  private async addClient(
+    client: WebSocketClientConnectionProtocol,
+  ): Promise<void> {
     await this.store.add(client)
     // Sync the in-memory clients in this runtime with the
     // updated database. This pulls in all the stored clients.
@@ -119,7 +121,9 @@ export class WebSocketClientManager {
    * connection object because `addConnection()` is called only
    * for the opened connections in the same runtime.
    */
-  public async addConnection(client: WebSocketClientConnection): Promise<void> {
+  public async addConnection(
+    client: WebSocketClientConnectionProtocol,
+  ): Promise<void> {
     // Store this client in the map of clients created in this runtime.
     // This way, the manager can distinguish between this runtime clients
     // and extraneous runtime clients when synchronizing clients storage.
@@ -208,4 +212,30 @@ export class WebSocketRemoteClientConnection
       },
     } as WebSocketBroadcastChannelMessage)
   }
+
+  addEventListener<EventType extends keyof WebSocketClientEventMap>(
+    _type: EventType,
+    _listener: (
+      this: WebSocket,
+      event: WebSocketClientEventMap[EventType],
+    ) => void,
+    _options?: AddEventListenerOptions | boolean,
+  ): void {
+    throw new Error(
+      'WebSocketRemoteClientConnection.addEventListener is not supported',
+    )
+  }
+
+  removeEventListener<EventType extends keyof WebSocketClientEventMap>(
+    _event: EventType,
+    _listener: (
+      this: WebSocket,
+      event: WebSocketClientEventMap[EventType],
+    ) => void,
+    _options?: EventListenerOptions | boolean,
+  ): void {
+    throw new Error(
+      'WebSocketRemoteClientConnection.removeEventListener is not supported',
+    )
+  }
 }

package/lib/core/GraphQLHandler-DOXAygvT.d.mts

@@ -1,100 +0,0 @@
-import { OperationTypeNode, DocumentNode, GraphQLError } from 'graphql';
-import { D as DefaultBodyType, R as RequestHandler, g as RequestHandlerDefaultInfo, a as ResponseResolver, c as RequestHandlerOptions } from './HttpResponse-BOGtXZ-B.mjs';
-import { Match, Path } from './utils/matching/matchRequestUrl.mjs';
-
-interface ParsedGraphQLQuery {
-    operationType: OperationTypeNode;
-    operationName?: string;
-}
-type ParsedGraphQLRequest<VariablesType extends GraphQLVariables = GraphQLVariables> = (ParsedGraphQLQuery & {
-    query: string;
-    variables?: VariablesType;
-}) | undefined;
-declare function parseDocumentNode(node: DocumentNode): ParsedGraphQLQuery;
-type GraphQLParsedOperationsMap = Record<string, string[]>;
-type GraphQLMultipartRequestBody = {
-    operations: string;
-    map?: string;
-} & {
-    [fileName: string]: File;
-};
-/**
- * Determines if a given request can be considered a GraphQL request.
- * Does not parse the query and does not guarantee its validity.
- */
-declare function parseGraphQLRequest(request: Request): Promise<ParsedGraphQLRequest>;
-
-type ExpectedOperationTypeNode = OperationTypeNode | 'all';
-type GraphQLHandlerNameSelector = DocumentNode | RegExp | string;
-type GraphQLQuery = Record<string, any> | null;
-type GraphQLVariables = Record<string, any>;
-interface GraphQLHandlerInfo extends RequestHandlerDefaultInfo {
-    operationType: ExpectedOperationTypeNode;
-    operationName: GraphQLHandlerNameSelector;
-}
-type GraphQLRequestParsedResult = {
-    match: Match;
-    cookies: Record<string, string>;
-} & (ParsedGraphQLRequest<GraphQLVariables>
-/**
- * An empty version of the ParsedGraphQLRequest
- * which simplifies the return type of the resolver
- * when the request is to a non-matching endpoint
- */
- | {
-    operationType?: undefined;
-    operationName?: undefined;
-    query?: undefined;
-    variables?: undefined;
-});
-type GraphQLResolverExtras<Variables extends GraphQLVariables> = {
-    query: string;
-    operationName: string;
-    variables: Variables;
-    cookies: Record<string, string>;
-};
-type GraphQLRequestBody<VariablesType extends GraphQLVariables> = GraphQLJsonRequestBody<VariablesType> | GraphQLMultipartRequestBody | Record<string, any> | undefined;
-interface GraphQLJsonRequestBody<Variables extends GraphQLVariables> {
-    query: string;
-    variables?: Variables;
-}
-type GraphQLResponseBody<BodyType extends DefaultBodyType> = {
-    data?: BodyType | null;
-    errors?: readonly Partial<GraphQLError>[] | null;
-    extensions?: Record<string, any>;
-} | null | undefined;
-declare function isDocumentNode(value: DocumentNode | any): value is DocumentNode;
-declare class GraphQLHandler extends RequestHandler<GraphQLHandlerInfo, GraphQLRequestParsedResult, GraphQLResolverExtras<any>> {
-    private endpoint;
-    static parsedRequestCache: WeakMap<Request, ParsedGraphQLRequest<GraphQLVariables>>;
-    constructor(operationType: ExpectedOperationTypeNode, operationName: GraphQLHandlerNameSelector, endpoint: Path, resolver: ResponseResolver<GraphQLResolverExtras<any>, any, any>, options?: RequestHandlerOptions);
-    /**
-     * Parses the request body, once per request, cached across all
-     * GraphQL handlers. This is done to avoid multiple parsing of the
-     * request body, which each requires a clone of the request.
-     */
-    parseGraphQLRequestOrGetFromCache(request: Request): Promise<ParsedGraphQLRequest<GraphQLVariables>>;
-    parse(args: {
-        request: Request;
-    }): Promise<GraphQLRequestParsedResult>;
-    predicate(args: {
-        request: Request;
-        parsedResult: GraphQLRequestParsedResult;
-    }): boolean;
-    protected extendResolverArgs(args: {
-        request: Request;
-        parsedResult: GraphQLRequestParsedResult;
-    }): {
-        query: string;
-        operationName: string;
-        variables: GraphQLVariables;
-        cookies: Record<string, string>;
-    };
-    log(args: {
-        request: Request;
-        response: Response;
-        parsedResult: GraphQLRequestParsedResult;
-    }): Promise<void>;
-}
-
-export { type ExpectedOperationTypeNode as E, GraphQLHandler as G, type ParsedGraphQLRequest as P, type GraphQLQuery as a, type GraphQLVariables as b, type GraphQLRequestBody as c, type GraphQLJsonRequestBody as d, type GraphQLHandlerNameSelector as e, type GraphQLResolverExtras as f, type GraphQLResponseBody as g, type ParsedGraphQLQuery as h, type GraphQLParsedOperationsMap as i, type GraphQLMultipartRequestBody as j, parseGraphQLRequest as k, type GraphQLHandlerInfo as l, type GraphQLRequestParsedResult as m, isDocumentNode as n, parseDocumentNode as p };

package/lib/core/GraphQLHandler-noP9MRWa.d.ts

@@ -1,100 +0,0 @@
-import { OperationTypeNode, DocumentNode, GraphQLError } from 'graphql';
-import { D as DefaultBodyType, R as RequestHandler, g as RequestHandlerDefaultInfo, a as ResponseResolver, c as RequestHandlerOptions } from './HttpResponse-DzeJL_i8.js';
-import { Match, Path } from './utils/matching/matchRequestUrl.js';
-
-interface ParsedGraphQLQuery {
-    operationType: OperationTypeNode;
-    operationName?: string;
-}
-type ParsedGraphQLRequest<VariablesType extends GraphQLVariables = GraphQLVariables> = (ParsedGraphQLQuery & {
-    query: string;
-    variables?: VariablesType;
-}) | undefined;
-declare function parseDocumentNode(node: DocumentNode): ParsedGraphQLQuery;
-type GraphQLParsedOperationsMap = Record<string, string[]>;
-type GraphQLMultipartRequestBody = {
-    operations: string;
-    map?: string;
-} & {
-    [fileName: string]: File;
-};
-/**
- * Determines if a given request can be considered a GraphQL request.
- * Does not parse the query and does not guarantee its validity.
- */
-declare function parseGraphQLRequest(request: Request): Promise<ParsedGraphQLRequest>;
-
-type ExpectedOperationTypeNode = OperationTypeNode | 'all';
-type GraphQLHandlerNameSelector = DocumentNode | RegExp | string;
-type GraphQLQuery = Record<string, any> | null;
-type GraphQLVariables = Record<string, any>;
-interface GraphQLHandlerInfo extends RequestHandlerDefaultInfo {
-    operationType: ExpectedOperationTypeNode;
-    operationName: GraphQLHandlerNameSelector;
-}
-type GraphQLRequestParsedResult = {
-    match: Match;
-    cookies: Record<string, string>;
-} & (ParsedGraphQLRequest<GraphQLVariables>
-/**
- * An empty version of the ParsedGraphQLRequest
- * which simplifies the return type of the resolver
- * when the request is to a non-matching endpoint
- */
- | {
-    operationType?: undefined;
-    operationName?: undefined;
-    query?: undefined;
-    variables?: undefined;
-});
-type GraphQLResolverExtras<Variables extends GraphQLVariables> = {
-    query: string;
-    operationName: string;
-    variables: Variables;
-    cookies: Record<string, string>;
-};
-type GraphQLRequestBody<VariablesType extends GraphQLVariables> = GraphQLJsonRequestBody<VariablesType> | GraphQLMultipartRequestBody | Record<string, any> | undefined;
-interface GraphQLJsonRequestBody<Variables extends GraphQLVariables> {
-    query: string;
-    variables?: Variables;
-}
-type GraphQLResponseBody<BodyType extends DefaultBodyType> = {
-    data?: BodyType | null;
-    errors?: readonly Partial<GraphQLError>[] | null;
-    extensions?: Record<string, any>;
-} | null | undefined;
-declare function isDocumentNode(value: DocumentNode | any): value is DocumentNode;
-declare class GraphQLHandler extends RequestHandler<GraphQLHandlerInfo, GraphQLRequestParsedResult, GraphQLResolverExtras<any>> {
-    private endpoint;
-    static parsedRequestCache: WeakMap<Request, ParsedGraphQLRequest<GraphQLVariables>>;
-    constructor(operationType: ExpectedOperationTypeNode, operationName: GraphQLHandlerNameSelector, endpoint: Path, resolver: ResponseResolver<GraphQLResolverExtras<any>, any, any>, options?: RequestHandlerOptions);
-    /**
-     * Parses the request body, once per request, cached across all
-     * GraphQL handlers. This is done to avoid multiple parsing of the
-     * request body, which each requires a clone of the request.
-     */
-    parseGraphQLRequestOrGetFromCache(request: Request): Promise<ParsedGraphQLRequest<GraphQLVariables>>;
-    parse(args: {
-        request: Request;
-    }): Promise<GraphQLRequestParsedResult>;
-    predicate(args: {
-        request: Request;
-        parsedResult: GraphQLRequestParsedResult;
-    }): boolean;
-    protected extendResolverArgs(args: {
-        request: Request;
-        parsedResult: GraphQLRequestParsedResult;
-    }): {
-        query: string;
-        operationName: string;
-        variables: GraphQLVariables;
-        cookies: Record<string, string>;
-    };
-    log(args: {
-        request: Request;
-        response: Response;
-        parsedResult: GraphQLRequestParsedResult;
-    }): Promise<void>;
-}
-
-export { type ExpectedOperationTypeNode as E, GraphQLHandler as G, type ParsedGraphQLRequest as P, type GraphQLQuery as a, type GraphQLVariables as b, type GraphQLRequestBody as c, type GraphQLJsonRequestBody as d, type GraphQLHandlerNameSelector as e, type GraphQLResolverExtras as f, type GraphQLResponseBody as g, type ParsedGraphQLQuery as h, type GraphQLParsedOperationsMap as i, type GraphQLMultipartRequestBody as j, parseGraphQLRequest as k, type GraphQLHandlerInfo as l, type GraphQLRequestParsedResult as m, isDocumentNode as n, parseDocumentNode as p };