msw 0.41.1 → 0.42.2

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { R as ResponseTransformer, s as status, a as set, d as delay, f as fetch, b as RequestHandler, S as SetupWorkerApi, D as DefaultContext, c as DefaultBodyType, M as MockedRequest, e as ResponseResolver, g as ResponseResolutionContext, h as SerializedResponse, i as RequestHandlerDefaultInfo, j as MockedResponse, k as ResponseLookupResult, l as SharedOptions, m as ServerLifecycleEventsMap } from './glossary-eda04a15.js';
-export { A as AsyncResponseResolverReturnType, c as DefaultBodyType, u as DefaultRequestMultipartBody, y as DelayMode, M as MockedRequest, j as MockedResponse, b as RequestHandler, v as ResponseComposition, w as ResponseCompositionOptions, x as ResponseFunction, e as ResponseResolver, t as ResponseResolverReturnType, R as ResponseTransformer, S as SetupWorkerApi, l as SharedOptions, q as StartOptions, o as createResponseComposition, p as defaultContext, n as defaultResponse, r as response } from './glossary-eda04a15.js';
+import { R as ResponseTransformer, s as status, a as set, d as delay, f as fetch, b as RequestHandler, S as SetupWorkerApi, D as DefaultContext, c as DefaultBodyType, M as MockedRequest, e as ResponseResolver, g as ResponseResolutionContext, h as SerializedResponse, i as RequestHandlerDefaultInfo, j as MockedResponse, k as ResponseLookupResult, l as SharedOptions, m as ServerLifecycleEventsMap } from './glossary-58eca5a8.js';
+export { A as AsyncResponseResolverReturnType, c as DefaultBodyType, u as DefaultRequestMultipartBody, y as DelayMode, M as MockedRequest, j as MockedResponse, b as RequestHandler, v as ResponseComposition, w as ResponseCompositionOptions, x as ResponseFunction, e as ResponseResolver, t as ResponseResolverReturnType, R as ResponseTransformer, S as SetupWorkerApi, l as SharedOptions, q as StartOptions, o as createResponseComposition, p as defaultContext, n as defaultResponse, r as response } from './glossary-58eca5a8.js';
 import * as cookieUtils from 'cookie';
 import { GraphQLError, OperationTypeNode, DocumentNode } from 'graphql';
 import { StrictEventEmitter } from 'strict-event-emitter';
@@ -7,6 +7,25 @@ import { IsomorphicRequest } from '@mswjs/interceptors';
 import 'type-fest';
 import 'headers-polyfill';
 
+declare type Path = string | RegExp;
+declare type PathParams<KeyType extends keyof any = string> = {
+    [ParamName in KeyType]: string | ReadonlyArray<string>;
+};
+interface Match {
+    matches: boolean;
+    params?: PathParams;
+}
+/**
+ * Returns the result of matching given request URL against a mask.
+ */
+declare function matchRequestUrl(url: URL, path: Path, baseUrl?: string): Match;
+
+declare type Fn = (...arg: any[]) => any;
+declare type RequiredDeep<Type, U extends Record<string, unknown> | Fn | undefined = undefined> = Type extends Fn ? Type : Type extends Record<string, any> ? {
+    [Key in keyof Type]-?: NonNullable<Type[Key]> extends NonNullable<U> ? NonNullable<Type[Key]> : RequiredDeep<NonNullable<Type[Key]>, U>;
+} : Type;
+declare type GraphQLPayloadContext<QueryType extends Record<string, unknown>> = (payload: QueryType) => ResponseTransformer;
+
 /**
  * Sets a given cookie on the mocked response.
  * @example res(ctx.cookie('name', 'value'))
@@ -20,13 +39,7 @@ declare const cookie: (name: string, value: string, options?: cookieUtils.Cookie
  * res(ctx.body(JSON.stringify({ key: 'value' })))
  * @see {@link https://mswjs.io/docs/api/context/body `ctx.body()`}
  */
-declare const body: <BodyType extends string | Blob | BufferSource | ReadableStream<any> | FormData>(value: BodyType) => ResponseTransformer<BodyType, any>;
-
-declare type Fn = (...arg: any[]) => any;
-declare type RequiredDeep<Type, U extends Record<string, unknown> | Fn | undefined = undefined> = Type extends Fn ? Type : Type extends Record<string, any> ? {
-    [Key in keyof Type]-?: NonNullable<Type[Key]> extends NonNullable<U> ? NonNullable<Type[Key]> : RequiredDeep<NonNullable<Type[Key]>, U>;
-} : Type;
-declare type GraphQLPayloadContext<QueryType extends Record<string, unknown>> = (payload: QueryType) => ResponseTransformer;
+declare const body: <BodyType extends string | Blob | BufferSource | FormData | ReadableStream<any>>(value: BodyType) => ResponseTransformer<BodyType, any>;
 
 /**
  * Sets a given payload as a GraphQL response body.
@@ -51,19 +64,6 @@ declare const extensions: GraphQLPayloadContext<Record<string, unknown>>;
  */
 declare const errors: <ErrorsType extends readonly Partial<GraphQLError>[] | null | undefined>(errorsList: ErrorsType) => ResponseTransformer<string>;
 
-declare type Path = string | RegExp;
-declare type PathParams<KeyType extends keyof any = string> = {
-    [ParamName in KeyType]: string | ReadonlyArray<string>;
-};
-interface Match {
-    matches: boolean;
-    params?: PathParams;
-}
-/**
- * Returns the result of matching given request URL against a mask.
- */
-declare function matchRequestUrl(url: URL, path: Path, baseUrl?: string): Match;
-
 /**
  * Sets the given value as the JSON body of the response.
  * Appends a `Content-Type: application/json` header on the
@@ -183,6 +183,14 @@ declare const rest: {
     options: <RequestBodyType_7 extends DefaultBodyType = DefaultBodyType, Params_7 extends PathParams<keyof Params_7> = PathParams<string>, ResponseBody_7 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_7, Params_7>, RestContext, ResponseBody_7>) => RestHandler<MockedRequest<DefaultBodyType>>;
 };
 
+declare type ForbiddenFieldNames = '' | 'data' | 'errors' | 'extensions';
+/**
+ * Set a custom field on the GraphQL mocked response.
+ * @example res(ctx.fields('customField', value))
+ * @see {@link https://mswjs.io/docs/api/context/field}
+ */
+declare const field: <FieldNameType extends string, FieldValueType>(fieldName: FieldNameType extends ForbiddenFieldNames ? never : FieldNameType, fieldValue: FieldValueType) => ResponseTransformer<string>;
+
 interface ParsedGraphQLQuery {
     operationType: OperationTypeNode;
     operationName?: string;
@@ -204,6 +212,7 @@ declare type GraphQLContext<QueryType extends Record<string, unknown>> = Default
     extensions: GraphQLPayloadContext<QueryType>;
     errors: typeof errors;
     cookie: typeof cookie;
+    field: typeof field;
 };
 declare const graphqlContext: GraphQLContext<any>;
 declare type GraphQLVariables = Record<string, any>;