msw 0.0.0-fetch.rc-20 → 0.0.0-fetch.rc-22

package/README.md

@@ -1,3 +1,6 @@
+> [!IMPORTANT]\
+> **MSW 2.0 is finally here! 🎉** Read the [Release notes](https://github.com/mswjs/msw/releases/tag/v2.0.0) and please follow the [**Migration guidelines**](https://mswjs.io/docs/migrations/1.x-to-2.x) to upgrade. If you're having any questions while upgrading, please reach out in our [Discord server](https://discord.gg/z29WbnfDC5).
+
 <br />
 
 <p align="center">
@@ -25,7 +28,7 @@
 
 - **Seamless**. A dedicated layer of requests interception at your disposal. Keep your application's code and tests unaware of whether something is mocked or not.
 - **Deviation-free**. Request the same production resources and test the actual behavior of your app. Augment an existing API, or design it as you go when there is none.
-- **Familiar & Powerful**. Use [Express](https://github.com/expressjs/express)-like routing syntax to capture requests. Use parameters, wildcards, and regular expressions to match requests, and respond with necessary status codes, headers, cookies, delays, or completely custom resolvers.
+- **Familiar & Powerful**. Use [Express](https://github.com/expressjs/express)-like routing syntax to intercept requests. Use parameters, wildcards, and regular expressions to match requests, and respond with necessary status codes, headers, cookies, delays, or completely custom resolvers.
 
 ---
 
@@ -53,7 +56,7 @@ This README will give you a brief overview on the library but there's no better
 
 ### How does it work?
 
-In-browser usage is what sets Mock Service Worker apart from other tools. Utilizing the [Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API), which can intercept requests for the purpose of caching, Mock Service Worker responds to captured requests with your mock definition on the network level. This way your application knows nothing about the mocking.
+In-browser usage is what sets Mock Service Worker apart from other tools. Utilizing the [Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API), which can intercept requests for the purpose of caching, Mock Service Worker responds to intercepted requests with your mock definition on the network level. This way your application knows nothing about the mocking.
 
 **Take a look at this quick presentation on how Mock Service Worker functions in a browser:**
 

package/lib/browser/index.d.ts

@@ -16,7 +16,7 @@ interface StartOptions extends SharedOptions {
         options?: RegistrationOptions;
     };
     /**
-     * Disables the logging of captured requests
+     * Disables the logging of the intercepted requests
      * into browser's console.
      * @default false
      */
@@ -38,36 +38,48 @@ type StopHandler = () => void;
 interface SetupWorker {
     /**
      * Registers and activates the mock Service Worker.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()` API reference}
      */
     start: (options?: StartOptions) => StartReturnType;
     /**
      * Stops requests interception for the current client.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()` API reference}
      */
     stop: StopHandler;
     /**
      * Prepends given request handlers to the list of existing handlers.
      * @param {RequestHandler[]} handlers List of runtime request handlers.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()` API reference}
      */
     use: (...handlers: RequestHandler[]) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/restore-handlers `worker.restoreHandlers()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/restore-handlers `worker.restoreHandlers()` API reference}
      */
     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.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()` API reference}
      */
     resetHandlers: (...nextHandlers: RequestHandler[]) => void;
     /**
      * Returns a readonly list of currently active request handlers.
-     * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/setup-worker/list-handlers `worker.listHandlers()` API reference}
      */
     listHandlers(): ReadonlyArray<RequestHandler<RequestHandlerDefaultInfo, any>>;
+    /**
+     * 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>;
 }
 
@@ -84,7 +96,8 @@ declare class SetupWorkerApi extends SetupApi<LifeCycleEventsMap> implements Set
 /**
  * Sets up a requests interception in the browser with the given request handlers.
  * @param {RequestHandler[]} handlers List of request handlers.
- * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
+ *
+ * @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker()` API reference}
  */
 declare function setupWorker(...handlers: Array<RequestHandler>): SetupWorker;
 

package/lib/browser/index.js

@@ -259,7 +259,7 @@ var createRequestListener = (context, options) => {
             messageChannel.postMessage("NOT_FOUND");
           },
           onMockedResponse(_0, _1) {
-            return __async(this, arguments, function* (response, { handler, parsedRequest }) {
+            return __async(this, arguments, function* (response, { handler, parsedResult }) {
               const responseClone = response.clone();
               const responseInit = (0, import_toResponseInit.toResponseInit)(response);
               const responseStream = responseClone.body;
@@ -274,7 +274,11 @@ var createRequestListener = (context, options) => {
               );
               if (!options.quiet) {
                 context.emitter.once("response:mocked", ({ response: response2 }) => {
-                  handler.log(requestCloneForLogs, response2, parsedRequest);
+                  handler.log({
+                    request: requestCloneForLogs,
+                    response: response2,
+                    parsedResult
+                  });
                 });
               }
             });
@@ -317,9 +321,9 @@ function requestIntegrityCheck(context, serviceWorker) {
     const { payload: actualChecksum } = yield context.events.once(
       "INTEGRITY_CHECK_RESPONSE"
     );
-    if (actualChecksum !== "3343a047c60712815551260184217eb5") {
+    if (actualChecksum !== "0877fcdc026242810f5bfde0d7178db4") {
       throw new Error(
-        `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"3343a047c60712815551260184217eb5"}).`
+        `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"0877fcdc026242810f5bfde0d7178db4"}).`
       );
     }
     return serviceWorker;
@@ -535,10 +539,14 @@ function createFallbackRequestListener(context, options) {
       options,
       context.emitter,
       {
-        onMockedResponse(_, { handler, parsedRequest }) {
+        onMockedResponse(_, { handler, parsedResult }) {
           if (!options.quiet) {
             context.emitter.once("response:mocked", ({ response: response2 }) => {
-              handler.log(requestCloneForLogs, response2, parsedRequest);
+              handler.log({
+                request: requestCloneForLogs,
+                response: response2,
+                parsedResult
+              });
             });
           }
         }

package/lib/browser/index.mjs

@@ -235,7 +235,7 @@ var createRequestListener = (context, options) => {
             messageChannel.postMessage("NOT_FOUND");
           },
           onMockedResponse(_0, _1) {
-            return __async(this, arguments, function* (response, { handler, parsedRequest }) {
+            return __async(this, arguments, function* (response, { handler, parsedResult }) {
               const responseClone = response.clone();
               const responseInit = toResponseInit(response);
               const responseStream = responseClone.body;
@@ -250,7 +250,11 @@ var createRequestListener = (context, options) => {
               );
               if (!options.quiet) {
                 context.emitter.once("response:mocked", ({ response: response2 }) => {
-                  handler.log(requestCloneForLogs, response2, parsedRequest);
+                  handler.log({
+                    request: requestCloneForLogs,
+                    response: response2,
+                    parsedResult
+                  });
                 });
               }
             });
@@ -293,9 +297,9 @@ function requestIntegrityCheck(context, serviceWorker) {
     const { payload: actualChecksum } = yield context.events.once(
       "INTEGRITY_CHECK_RESPONSE"
     );
-    if (actualChecksum !== "3343a047c60712815551260184217eb5") {
+    if (actualChecksum !== "0877fcdc026242810f5bfde0d7178db4") {
       throw new Error(
-        `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"3343a047c60712815551260184217eb5"}).`
+        `Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"0877fcdc026242810f5bfde0d7178db4"}).`
       );
     }
     return serviceWorker;
@@ -513,10 +517,14 @@ function createFallbackRequestListener(context, options) {
       options,
       context.emitter,
       {
-        onMockedResponse(_, { handler, parsedRequest }) {
+        onMockedResponse(_, { handler, parsedResult }) {
           if (!options.quiet) {
             context.emitter.once("response:mocked", ({ response: response2 }) => {
-              handler.log(requestCloneForLogs, response2, parsedRequest);
+              handler.log({
+                request: requestCloneForLogs,
+                response: response2,
+                parsedResult
+              });
             });
           }
         }

package/lib/core/{GraphQLHandler-ef45ae39.d.ts → GraphQLHandler-a441dd03.d.ts}

@@ -1,5 +1,5 @@
 import { OperationTypeNode, DocumentNode, GraphQLError } from 'graphql';
-import { g as RequestHandlerDefaultInfo, D as DefaultBodyType, R as RequestHandler, a as ResponseResolver, f as RequestHandlerOptions } from './RequestHandler-7c716cf7.js';
+import { g as RequestHandlerDefaultInfo, D as DefaultBodyType, R as RequestHandler, a as ResponseResolver, f as RequestHandlerOptions } from './RequestHandler-b59044ae.js';
 import { Path } from './utils/matching/matchRequestUrl.js';
 
 interface ParsedGraphQLQuery {
@@ -49,14 +49,26 @@ declare function isDocumentNode(value: DocumentNode | any): value is DocumentNod
 declare class GraphQLHandler extends RequestHandler<GraphQLHandlerInfo, ParsedGraphQLRequest, GraphQLResolverExtras<any>> {
     private endpoint;
     constructor(operationType: ExpectedOperationTypeNode, operationName: GraphQLHandlerNameSelector, endpoint: Path, resolver: ResponseResolver<GraphQLResolverExtras<any>, any, any>, options?: RequestHandlerOptions);
-    parse(request: Request): Promise<ParsedGraphQLRequest<GraphQLVariables>>;
-    predicate(request: Request, parsedResult: ParsedGraphQLRequest): boolean;
-    protected extendInfo(_request: Request, parsedResult: ParsedGraphQLRequest<GraphQLVariables>): {
+    parse(args: {
+        request: Request;
+    }): Promise<ParsedGraphQLRequest<GraphQLVariables>>;
+    predicate(args: {
+        request: Request;
+        parsedResult: ParsedGraphQLRequest;
+    }): boolean;
+    protected extendResolverArgs(args: {
+        request: Request;
+        parsedResult: ParsedGraphQLRequest<GraphQLVariables>;
+    }): {
         query: string;
         operationName: string;
         variables: GraphQLVariables;
     };
-    log(request: Request, response: Response, parsedRequest: ParsedGraphQLRequest): Promise<void>;
+    log(args: {
+        request: Request;
+        response: Response;
+        parsedResult: ParsedGraphQLRequest;
+    }): Promise<void>;
 }
 
-export { ExpectedOperationTypeNode as E, GraphQLHandler as G, ParsedGraphQLRequest as P, GraphQLVariables as a, GraphQLRequestBody as b, GraphQLJsonRequestBody as c, GraphQLResolverExtras as d, GraphQLResponseBody as e, GraphQLHandlerNameSelector as f, ParsedGraphQLQuery as g, GraphQLParsedOperationsMap as h, GraphQLMultipartRequestBody as i, parseGraphQLRequest as j, GraphQLHandlerInfo as k, isDocumentNode as l, parseDocumentNode as p };
+export { ExpectedOperationTypeNode as E, GraphQLHandler as G, ParsedGraphQLRequest as P, GraphQLVariables as a, GraphQLRequestBody as b, GraphQLJsonRequestBody as c, GraphQLHandlerNameSelector as d, GraphQLResolverExtras as e, GraphQLResponseBody as f, ParsedGraphQLQuery as g, GraphQLParsedOperationsMap as h, GraphQLMultipartRequestBody as i, parseGraphQLRequest as j, GraphQLHandlerInfo as k, isDocumentNode as l, parseDocumentNode as p };

package/lib/core/HttpResponse.d.ts

@@ -1,2 +1,2 @@
-export { e as HttpResponse, H as HttpResponseInit, S as StrictRequest, d as StrictResponse } from './RequestHandler-7c716cf7.js';
+export { e as HttpResponse, H as HttpResponseInit, S as StrictRequest, d as StrictResponse } from './RequestHandler-b59044ae.js';
 import './typeUtils.js';

package/lib/core/{RequestHandler-7c716cf7.d.ts → RequestHandler-b59044ae.d.ts}

@@ -2,7 +2,7 @@ import { MaybePromise } from './typeUtils.js';
 
 interface ResponseLookupResult {
     handler: RequestHandler;
-    parsedRequest?: any;
+    parsedResult?: any;
     response?: Response;
 }
 interface ResponseResolutionContext {
@@ -27,9 +27,15 @@ interface StrictResponse<BodyType extends DefaultBodyType> extends Response {
     readonly [bodyType]: BodyType;
 }
 /**
- * A `Response` class superset with a stricter response body type.
+ * A drop-in replacement for the standard `Response` class
+ * to allow additional features, like mocking the response `Set-Cookie` header.
+ *
  * @example
  * new HttpResponse('Hello world', { status: 201 })
+ * HttpResponse.json({ name: 'John' })
+ * HttpResponse.formData(form)
+ *
+ * @see {@link https://mswjs.io/docs/api/http-response `HttpResponse` API reference}
  */
 declare class HttpResponse extends Response {
     constructor(body?: BodyInit | null, init?: HttpResponseInit);
@@ -117,28 +123,48 @@ declare abstract class RequestHandler<HandlerInfo extends RequestHandlerDefaultI
     private options?;
     constructor(args: RequestHandlerArgs<HandlerInfo, HandlerOptions>);
     /**
-     * Determine if the captured request should be mocked.
+     * Determine if the intercepted request should be mocked.
      */
-    abstract predicate(request: Request, parsedResult: ParsedResult, resolutionContext?: ResponseResolutionContext): boolean;
+    abstract predicate(args: {
+        request: Request;
+        parsedResult: ParsedResult;
+        resolutionContext?: ResponseResolutionContext;
+    }): boolean;
     /**
      * Print out the successfully handled request.
      */
-    abstract log(request: Request, response: Response, parsedResult: ParsedResult): void;
+    abstract log(args: {
+        request: Request;
+        response: Response;
+        parsedResult: ParsedResult;
+    }): void;
     /**
-     * Parse the captured request to extract additional information from it.
+     * Parse the intercepted request to extract additional information from it.
      * Parsed result is then exposed to other methods of this request handler.
      */
-    parse(_request: Request, _resolutionContext?: ResponseResolutionContext): Promise<ParsedResult>;
+    parse(_args: {
+        request: Request;
+        resolutionContext?: ResponseResolutionContext;
+    }): Promise<ParsedResult>;
     /**
      * Test if this handler matches the given request.
      */
-    test(request: Request, resolutionContext?: ResponseResolutionContext): Promise<boolean>;
-    protected extendInfo(_request: Request, _parsedResult: ParsedResult): ResolverExtras;
+    test(args: {
+        request: Request;
+        resolutionContext?: ResponseResolutionContext;
+    }): Promise<boolean>;
+    protected extendResolverArgs(_args: {
+        request: Request;
+        parsedResult: ParsedResult;
+    }): ResolverExtras;
     /**
      * Execute this request handler and produce a mocked response
      * using the given resolver function.
      */
-    run(request: StrictRequest<any>, resolutionContext?: ResponseResolutionContext): Promise<RequestHandlerExecutionResult<ParsedResult> | null>;
+    run(args: {
+        request: StrictRequest<any>;
+        resolutionContext?: ResponseResolutionContext;
+    }): Promise<RequestHandlerExecutionResult<ParsedResult> | null>;
     private wrapResolver;
     private createExecutionResult;
 }

package/lib/core/SetupApi.d.ts

@@ -1,5 +1,5 @@
 import { EventMap, Emitter } from 'strict-event-emitter';
-import { R as RequestHandler, g as RequestHandlerDefaultInfo } from './RequestHandler-7c716cf7.js';
+import { R as RequestHandler, g as RequestHandlerDefaultInfo } from './RequestHandler-b59044ae.js';
 import { LifeCycleEventEmitter } from './sharedOptions.js';
 import { Disposable } from './utils/internal/Disposable.js';
 import './typeUtils.js';

package/lib/core/bypass.d.ts

@@ -1,6 +1,6 @@
 type BypassRequestInput = string | URL | Request;
 /**
- * Creates a `Request` instance that will always be bypassed by MSW.
+ * Creates a `Request` instance that will always be ignored by MSW.
  *
  * @example
  * import { bypass } from 'msw'
@@ -8,6 +8,8 @@ type BypassRequestInput = string | URL | Request;
  * fetch(bypass('/resource'))
  * fetch(bypass(new URL('/resource', 'https://example.com)))
  * fetch(bypass(new Request('https://example.com/resource')))
+ *
+ * @see {@link https://mswjs.io/docs/api/bypass `bypass()` API reference}
  */
 declare function bypass(input: BypassRequestInput, init?: RequestInit): Request;
 

package/lib/core/delay.d.ts

@@ -5,10 +5,13 @@ declare const NODE_SERVER_RESPONSE_TIME = 5;
 type DelayMode = 'real' | 'infinite';
 /**
  * Delays the response by the given duration (ms).
+ *
  * @example
  * await delay() // emulate realistic server response time
  * await delay(1200) // delay response by 1200ms
  * await delay('infinite') // delay response infinitely
+ *
+ * @see {@link https://mswjs.io/docs/api/delay `delay()` API reference}
  */
 declare function delay(durationOrMode?: DelayMode | number): Promise<void>;
 

package/lib/core/graphql.d.ts

@@ -1,6 +1,6 @@
 import { DocumentNode } from 'graphql';
-import { a as ResponseResolver, f as RequestHandlerOptions } from './RequestHandler-7c716cf7.js';
-import { a as GraphQLVariables, d as GraphQLResolverExtras, e as GraphQLResponseBody, G as GraphQLHandler, f as GraphQLHandlerNameSelector } from './GraphQLHandler-ef45ae39.js';
+import { a as ResponseResolver, f as RequestHandlerOptions } from './RequestHandler-b59044ae.js';
+import { a as GraphQLVariables, d as GraphQLHandlerNameSelector, e as GraphQLResolverExtras, f as GraphQLResponseBody, G as GraphQLHandler } from './GraphQLHandler-a441dd03.js';
 import { Path } from './utils/matching/matchRequestUrl.js';
 import './typeUtils.js';
 
@@ -15,63 +15,95 @@ interface TypedDocumentNode<Result = {
 }
 declare const standardGraphQLHandlers: {
     /**
-     * Captures any GraphQL operation, regardless of its name, under the current scope.
-     * @example
-     * graphql.operation(() => {
-     *   return HttpResponse.json({ data: { name: 'John' } })
-     * })
-     * @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
-     */
-    operation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>) => GraphQLHandler;
-    /**
-     * Captures a GraphQL query by a given name.
+     * Intercepts a GraphQL query by a given name.
+     *
      * @example
      * graphql.query('GetUser', () => {
      *   return HttpResponse.json({ data: { user: { name: 'John' } } })
      * })
-     * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphqlqueryqueryname-resolver `graphql.query()` API reference}
      */
-    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>, options?: RequestHandlerOptions) => GraphQLHandler;
+    query: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query, Variables>, resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>, options?: RequestHandlerOptions) => GraphQLHandler;
     /**
-     * Captures a GraphQL mutation by a given name.
+     * Intercepts a GraphQL mutation by its name.
+     *
      * @example
      * graphql.mutation('SavePost', () => {
      *   return HttpResponse.json({ data: { post: { id: 'abc-123 } } })
      * })
-     * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphqlmutationmutationname-resolver `graphql.query()` API reference}
+     *
      */
-    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>, options?: RequestHandlerOptions) => GraphQLHandler;
-};
-declare function createGraphQLLink(url: Path): typeof standardGraphQLHandlers;
-declare const graphql: {
-    link: typeof createGraphQLLink;
+    mutation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query, Variables>, resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>, options?: RequestHandlerOptions) => GraphQLHandler;
     /**
-     * Captures any GraphQL operation, regardless of its name, under the current scope.
+     * Intercepts any GraphQL operation, regardless of its type or name.
+     *
      * @example
      * graphql.operation(() => {
      *   return HttpResponse.json({ data: { name: 'John' } })
      * })
-     * @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphloperationresolver `graphql.operation()` API reference}
      */
-    operation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>) => GraphQLHandler;
+    operation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>) => GraphQLHandler;
+};
+declare function createGraphQLLink(url: Path): typeof standardGraphQLHandlers;
+/**
+ * A namespace to intercept and mock GraphQL operations
+ *
+ * @example
+ * graphql.query('GetUser', resolver)
+ * graphql.mutation('DeletePost', resolver)
+ *
+ * @see {@link https://mswjs.io/docs/api/graphql `graphql` API reference}
+ */
+declare const graphql: {
+    /**
+     * Intercepts GraphQL operations scoped by the given URL.
+     *
+     * @example
+     * const github = graphql.link('https://api.github.com/graphql')
+     * github.query('GetRepo', resolver)
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphqllinkurl `graphql.link()` API reference}
+     */
+    link: typeof createGraphQLLink;
     /**
-     * Captures a GraphQL query by a given name.
+     * Intercepts a GraphQL query by a given name.
+     *
      * @example
      * graphql.query('GetUser', () => {
      *   return HttpResponse.json({ data: { user: { name: 'John' } } })
      * })
-     * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphqlqueryqueryname-resolver `graphql.query()` API reference}
      */
-    query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>, options?: RequestHandlerOptions) => GraphQLHandler;
+    query: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query, Variables>, resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>, options?: RequestHandlerOptions) => GraphQLHandler;
     /**
-     * Captures a GraphQL mutation by a given name.
+     * Intercepts a GraphQL mutation by its name.
+     *
      * @example
      * graphql.mutation('SavePost', () => {
      *   return HttpResponse.json({ data: { post: { id: 'abc-123 } } })
      * })
-     * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphqlmutationmutationname-resolver `graphql.query()` API reference}
+     *
+     */
+    mutation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query, Variables>, resolver: ResponseResolver<GraphQLResolverExtras<Variables>, null, GraphQLResponseBody<Query>>, options?: RequestHandlerOptions) => GraphQLHandler;
+    /**
+     * Intercepts any GraphQL operation, regardless of its type or name.
+     *
+     * @example
+     * graphql.operation(() => {
+     *   return HttpResponse.json({ data: { name: 'John' } })
+     * })
+     *
+     * @see {@link https://mswjs.io/docs/api/graphql#graphloperationresolver `graphql.operation()` API reference}
      */
-    mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>, options?: RequestHandlerOptions) => GraphQLHandler;
+    operation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLResolverExtras<Variables_1>, null, GraphQLResponseBody<Query_1>>) => GraphQLHandler;
 };
 
 export { TypedDocumentNode, graphql };

package/lib/core/graphql.js

@@ -57,32 +57,39 @@ function createGraphQLOperationHandler(url) {
 }
 const standardGraphQLHandlers = {
   /**
-   * Captures any GraphQL operation, regardless of its name, under the current scope.
-   * @example
-   * graphql.operation(() => {
-   *   return HttpResponse.json({ data: { name: 'John' } })
-   * })
-   * @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
-   */
-  operation: createGraphQLOperationHandler("*"),
-  /**
-   * Captures a GraphQL query by a given name.
+   * Intercepts a GraphQL query by a given name.
+   *
    * @example
    * graphql.query('GetUser', () => {
    *   return HttpResponse.json({ data: { user: { name: 'John' } } })
    * })
-   * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqlqueryqueryname-resolver `graphql.query()` API reference}
    */
   query: createScopedGraphQLHandler("query", "*"),
   /**
-   * Captures a GraphQL mutation by a given name.
+   * Intercepts a GraphQL mutation by its name.
+   *
    * @example
    * graphql.mutation('SavePost', () => {
    *   return HttpResponse.json({ data: { post: { id: 'abc-123 } } })
    * })
-   * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqlmutationmutationname-resolver `graphql.query()` API reference}
+   *
    */
-  mutation: createScopedGraphQLHandler("mutation", "*")
+  mutation: createScopedGraphQLHandler("mutation", "*"),
+  /**
+   * Intercepts any GraphQL operation, regardless of its type or name.
+   *
+   * @example
+   * graphql.operation(() => {
+   *   return HttpResponse.json({ data: { name: 'John' } })
+   * })
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphloperationresolver `graphql.operation()` API reference}
+   */
+  operation: createGraphQLOperationHandler("*")
 };
 function createGraphQLLink(url) {
   return {
@@ -92,5 +99,14 @@ function createGraphQLLink(url) {
   };
 }
 const graphql = __spreadProps(__spreadValues({}, standardGraphQLHandlers), {
+  /**
+   * Intercepts GraphQL operations scoped by the given URL.
+   *
+   * @example
+   * const github = graphql.link('https://api.github.com/graphql')
+   * github.query('GetRepo', resolver)
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqllinkurl `graphql.link()` API reference}
+   */
   link: createGraphQLLink
 });

package/lib/core/graphql.mjs

@@ -38,32 +38,39 @@ function createGraphQLOperationHandler(url) {
 }
 const standardGraphQLHandlers = {
   /**
-   * Captures any GraphQL operation, regardless of its name, under the current scope.
-   * @example
-   * graphql.operation(() => {
-   *   return HttpResponse.json({ data: { name: 'John' } })
-   * })
-   * @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
-   */
-  operation: createGraphQLOperationHandler("*"),
-  /**
-   * Captures a GraphQL query by a given name.
+   * Intercepts a GraphQL query by a given name.
+   *
    * @example
    * graphql.query('GetUser', () => {
    *   return HttpResponse.json({ data: { user: { name: 'John' } } })
    * })
-   * @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqlqueryqueryname-resolver `graphql.query()` API reference}
    */
   query: createScopedGraphQLHandler("query", "*"),
   /**
-   * Captures a GraphQL mutation by a given name.
+   * Intercepts a GraphQL mutation by its name.
+   *
    * @example
    * graphql.mutation('SavePost', () => {
    *   return HttpResponse.json({ data: { post: { id: 'abc-123 } } })
    * })
-   * @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqlmutationmutationname-resolver `graphql.query()` API reference}
+   *
    */
-  mutation: createScopedGraphQLHandler("mutation", "*")
+  mutation: createScopedGraphQLHandler("mutation", "*"),
+  /**
+   * Intercepts any GraphQL operation, regardless of its type or name.
+   *
+   * @example
+   * graphql.operation(() => {
+   *   return HttpResponse.json({ data: { name: 'John' } })
+   * })
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphloperationresolver `graphql.operation()` API reference}
+   */
+  operation: createGraphQLOperationHandler("*")
 };
 function createGraphQLLink(url) {
   return {
@@ -73,6 +80,15 @@ function createGraphQLLink(url) {
   };
 }
 const graphql = __spreadProps(__spreadValues({}, standardGraphQLHandlers), {
+  /**
+   * Intercepts GraphQL operations scoped by the given URL.
+   *
+   * @example
+   * const github = graphql.link('https://api.github.com/graphql')
+   * github.query('GetRepo', resolver)
+   *
+   * @see {@link https://mswjs.io/docs/api/graphql#graphqllinkurl `graphql.link()` API reference}
+   */
   link: createGraphQLLink
 });
 export {