import { Iterable, AsyncIterable } from './utils/internal/isIterable.js'; import { MaybePromise, NoInfer } from './typeUtils.js'; interface HandlersExecutionResult { handler: RequestHandler; parsedResult?: any; response?: Response; } interface ResponseResolutionContext { baseUrl?: string; } /** * Executes the list of request handlers against the given request. * Returns the execution result object containing any matching request * handler and any mocked response it returned. */ declare const executeHandlers: >({ request, requestId, handlers, resolutionContext, }: { request: Request; requestId: string; handlers: Handlers; resolutionContext?: ResponseResolutionContext; }) => Promise; type DefaultRequestMultipartBody = Record>; type DefaultBodyType = Record | DefaultRequestMultipartBody | string | number | boolean | null | undefined; type JsonBodyType = Record | string | number | boolean | null | undefined; interface RequestHandlerDefaultInfo { header: string; } interface RequestHandlerInternalInfo { callFrame?: string; } type ResponseResolverReturnType = ([ResponseBodyType] extends [undefined] ? Response : StrictResponse) | undefined | void; type MaybeAsyncResponseResolverReturnType = MaybePromise>; type AsyncResponseResolverReturnType = MaybePromise | Iterable, MaybeAsyncResponseResolverReturnType, MaybeAsyncResponseResolverReturnType> | AsyncIterable, MaybeAsyncResponseResolverReturnType, MaybeAsyncResponseResolverReturnType>>; type ResponseResolverInfo, RequestBodyType extends DefaultBodyType = DefaultBodyType> = { request: StrictRequest; requestId: string; } & ResolverExtraInfo; type ResponseResolver = Record, RequestBodyType extends DefaultBodyType = DefaultBodyType, ResponseBodyType extends DefaultBodyType = undefined> = (info: ResponseResolverInfo) => AsyncResponseResolverReturnType; interface RequestHandlerArgs { info: HandlerInfo; resolver: ResponseResolver; options?: HandlerOptions; } interface RequestHandlerOptions { once?: boolean; } interface RequestHandlerExecutionResult | undefined> { handler: RequestHandler; parsedResult?: ParsedResult; request: Request; requestId: string; response?: Response; } declare abstract class RequestHandler | undefined = any, ResolverExtras extends Record = any, HandlerOptions extends RequestHandlerOptions = RequestHandlerOptions> { static cache: WeakMap, StrictRequest>; private readonly __kind; info: HandlerInfo & RequestHandlerInternalInfo; /** * Indicates whether this request handler has been used * (its resolver has successfully executed). */ isUsed: boolean; protected resolver: ResponseResolver; private resolverIterator?; private resolverIteratorResult?; private options?; constructor(args: RequestHandlerArgs); /** * Determine if the intercepted request should be mocked. */ abstract predicate(args: { request: Request; parsedResult: ParsedResult; resolutionContext?: ResponseResolutionContext; }): boolean; /** * Print out the successfully handled request. */ abstract log(args: { request: Request; response: Response; parsedResult: ParsedResult; }): void; /** * Parse the intercepted request to extract additional information from it. * Parsed result is then exposed to other methods of this request handler. */ parse(_args: { request: Request; resolutionContext?: ResponseResolutionContext; }): Promise; /** * Test if this handler matches the given request. * * This method is not used internally but is exposed * as a convenience method for consumers writing custom * handlers. */ test(args: { request: Request; resolutionContext?: ResponseResolutionContext; }): Promise; protected extendResolverArgs(_args: { request: Request; parsedResult: ParsedResult; }): ResolverExtras; private cloneRequestOrGetFromCache; /** * Execute this request handler and produce a mocked response * using the given resolver function. */ run(args: { request: StrictRequest; requestId: string; resolutionContext?: ResponseResolutionContext; }): Promise | null>; private wrapResolver; private createExecutionResult; } interface HttpResponseInit extends ResponseInit { type?: ResponseType; } declare const bodyType: unique symbol; interface StrictRequest extends Request { json(): Promise; } /** * Opaque `Response` type that supports strict body type. */ interface StrictResponse extends Response { readonly [bodyType]: BodyType; } /** * 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); /** * Create a `Response` with a `Content-Type: "text/plain"` body. * @example * HttpResponse.text('hello world') * HttpResponse.text('Error', { status: 500 }) */ static text(body?: NoInfer | null, init?: HttpResponseInit): StrictResponse; /** * Create a `Response` with a `Content-Type: "application/json"` body. * @example * HttpResponse.json({ firstName: 'John' }) * HttpResponse.json({ error: 'Not Authorized' }, { status: 401 }) */ static json(body?: NoInfer | null, init?: HttpResponseInit): StrictResponse; /** * Create a `Response` with a `Content-Type: "application/xml"` body. * @example * HttpResponse.xml(``) * HttpResponse.xml(`
`, { status: 201 }) */ static xml(body?: BodyType | null, init?: HttpResponseInit): Response; /** * Create a `Response` with a `Content-Type: "text/html"` body. * @example * HttpResponse.html(`

Jane Doe

`) * HttpResponse.html(`
Main text
`, { status: 201 }) */ static html(body?: BodyType | null, init?: HttpResponseInit): Response; /** * Create a `Response` with an `ArrayBuffer` body. * @example * const buffer = new ArrayBuffer(3) * const view = new Uint8Array(buffer) * view.set([1, 2, 3]) * * HttpResponse.arrayBuffer(buffer) */ static arrayBuffer(body?: ArrayBuffer | SharedArrayBuffer, init?: HttpResponseInit): Response; /** * Create a `Response` with a `FormData` body. * @example * const data = new FormData() * data.set('name', 'Alice') * * HttpResponse.formData(data) */ static formData(body?: FormData, init?: HttpResponseInit): Response; } export { type AsyncResponseResolverReturnType as A, type DefaultBodyType as D, type HttpResponseInit as H, type JsonBodyType as J, type MaybeAsyncResponseResolverReturnType as M, RequestHandler as R, type StrictRequest as S, type ResponseResolver as a, type ResponseResolverReturnType as b, type RequestHandlerOptions as c, type DefaultRequestMultipartBody as d, type StrictResponse as e, HttpResponse as f, type RequestHandlerDefaultInfo as g, type ResponseResolutionContext as h, type HandlersExecutionResult as i, executeHandlers as j, type RequestHandlerInternalInfo as k, type ResponseResolverInfo as l, type RequestHandlerArgs as m, type RequestHandlerExecutionResult as n };