msw 0.40.2 → 0.42.0

package/lib/types/setupWorker/stop/createFallbackStop.d.ts

@@ -1,2 +0,0 @@
-import { SetupWorkerInternalContext, StopHandler } from '../glossary';
-export declare function createFallbackStop(context: SetupWorkerInternalContext): StopHandler;

package/lib/types/setupWorker/stop/createStop.d.ts

@@ -1,2 +0,0 @@
-import { SetupWorkerInternalContext, StopHandler } from '../glossary';
-export declare const createStop: (context: SetupWorkerInternalContext) => StopHandler;

package/lib/types/setupWorker/stop/utils/printStopMessage.d.ts

@@ -1,3 +0,0 @@
-export declare function printStopMessage(args?: {
-    quiet?: boolean;
-}): void;

package/lib/types/sharedOptions.d.ts

@@ -1,24 +0,0 @@
-import { StrictEventEmitter } from 'strict-event-emitter';
-import { MockedRequest } from './handlers/RequestHandler';
-import { UnhandledRequestStrategy } from './utils/request/onUnhandledRequest';
-export interface SharedOptions {
-    /**
-     * Specifies how to react to a request that has no corresponding
-     * request handler. Warns on unhandled requests by default.
-     *
-     * @example worker.start({ onUnhandledRequest: 'bypass' })
-     * @example worker.start({ onUnhandledRequest: 'warn' })
-     * @example server.listen({ onUnhandledRequest: 'error' })
-     */
-    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;
-    unhandledException: (error: Error, request: MockedRequest) => void;
-}
-export declare type LifeCycleEventEmitter<ResponseType> = Pick<StrictEventEmitter<ResponseType>, 'on' | 'removeListener' | 'removeAllListeners'>;

package/lib/types/typeUtils.d.ts

@@ -1,7 +0,0 @@
-import { ResponseTransformer } from './response';
-declare type Fn = (...arg: any[]) => any;
-export 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;
-export declare type GraphQLPayloadContext<QueryType extends Record<string, unknown>> = (payload: QueryType) => ResponseTransformer;
-export {};

package/lib/types/utils/NetworkError.d.ts

@@ -1,3 +0,0 @@
-export declare class NetworkError extends Error {
-    constructor(message: string);
-}

package/lib/types/utils/createBroadcastChannel.d.ts

@@ -1,18 +0,0 @@
-import { ServiceWorkerFetchEventTypes, ServiceWorkerIncomingEventsMap } from '../setupWorker/glossary';
-export interface ServiceWorkerMessage<EventType extends keyof ServiceWorkerIncomingEventsMap, EventPayload> {
-    type: EventType;
-    payload: EventPayload;
-}
-/**
- * Creates a communication channel between the client
- * and the Service Worker associated with the given event.
- */
-export declare const createBroadcastChannel: (event: MessageEvent) => {
-    /**
-     * Sends a text message to the connected Service Worker.
-     */
-    send(message: {
-        type: ServiceWorkerFetchEventTypes;
-        payload?: Record<string, any> | string;
-    }): void;
-};

package/lib/types/utils/deferNetworkRequestsUntil.d.ts

@@ -1,6 +0,0 @@
-/**
- * Intercepts and defers any requests on the page
- * until the Service Worker instance is ready.
- * Must only be used in a browser.
- */
-export declare function deferNetworkRequestsUntil(predicatePromise: Promise<any>): void;

package/lib/types/utils/getResponse.d.ts

@@ -1,15 +0,0 @@
-import { MockedResponse } from '../response';
-import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
-export interface ResponseLookupResult {
-    handler?: RequestHandler;
-    publicRequest?: any;
-    parsedRequest?: any;
-    response?: MockedResponse;
-}
-export interface ResponseResolutionContext {
-    baseUrl?: string;
-}
-/**
- * Returns a mocked response for a given request using following request handlers.
- */
-export declare const getResponse: <Request_1 extends MockedRequest<import("../handlers/RequestHandler").DefaultBodyType>, Handler extends RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, MockedRequest<import("../handlers/RequestHandler").DefaultBodyType>, any, MockedRequest<import("../handlers/RequestHandler").DefaultBodyType>>[]>(request: Request_1, handlers: Handler, resolutionContext?: ResponseResolutionContext | undefined) => Promise<ResponseLookupResult>;

package/lib/types/utils/handleRequest.d.ts

@@ -1,34 +0,0 @@
-import { StrictEventEmitter } from 'strict-event-emitter';
-import { MockedRequest, RequestHandler } from '../handlers/RequestHandler';
-import { ServerLifecycleEventsMap } from '../node/glossary';
-import { MockedResponse } from '../response';
-import { SharedOptions } from '../sharedOptions';
-import { RequiredDeep } from '../typeUtils';
-import { ResponseLookupResult } from './getResponse';
-export interface HandleRequestOptions<ResponseType> {
-    /**
-     * Options for the response resolution process.
-     */
-    resolutionContext?: {
-        baseUrl?: string;
-    };
-    /**
-     * Transforms a `MockedResponse` instance returned from a handler
-     * to a response instance supported by the lower tooling (i.e. interceptors).
-     */
-    transformResponse?(response: MockedResponse<string>): ResponseType;
-    /**
-     * Invoked whenever a request is performed as-is.
-     */
-    onPassthroughResponse?(request: MockedRequest): void;
-    /**
-     * Invoked when the mocked response is ready to be sent.
-     */
-    onMockedResponse?(response: ResponseType, handler: RequiredDeep<ResponseLookupResult>): void;
-    /**
-     * Invoked when the mocked response is sent.
-     * Respects the response delay duration.
-     */
-    onMockedResponseSent?(response: ResponseType, handler: RequiredDeep<ResponseLookupResult>): void;
-}
-export declare function handleRequest<ResponseType extends Record<string, any> = MockedResponse<string>>(request: MockedRequest, handlers: RequestHandler[], options: RequiredDeep<SharedOptions>, emitter: StrictEventEmitter<ServerLifecycleEventsMap>, handleRequestOptions?: HandleRequestOptions<ResponseType>): Promise<ResponseType | undefined>;

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

@@ -1,14 +0,0 @@
-declare type ArityOneFunction = (arg: any) => any;
-declare type LengthOfTuple<Tuple extends any[]> = Tuple extends {
-    length: infer L;
-} ? L : never;
-declare type DropFirstInTuple<Tuple extends any[]> = ((...args: Tuple) => any) extends (arg: any, ...rest: infer LastArg) => any ? LastArg : Tuple;
-declare type LastInTuple<Tuple extends any[]> = Tuple[LengthOfTuple<DropFirstInTuple<Tuple>>];
-declare type FirstFnParameterType<Functions extends ArityOneFunction[]> = Parameters<LastInTuple<Functions>>[any];
-declare type LastFnParameterType<Functions extends ArityOneFunction[]> = ReturnType<Functions[0]>;
-/**
- * Composes a given list of functions into a new function that
- * executes from right to left.
- */
-export declare function compose<Functions extends ArityOneFunction[], LeftReturnType extends FirstFnParameterType<Functions>, RightReturnType extends LastFnParameterType<Functions>>(...fns: Functions): (...args: [LeftReturnType] extends [never] ? never[] : [LeftReturnType]) => RightReturnType;
-export {};

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

@@ -1,18 +0,0 @@
-/**
- * Formats a given message by appending the library's prefix string.
- */
-declare function formatMessage(message: string, ...positionals: any[]): string;
-/**
- * Prints a library-specific warning.
- */
-declare function warn(message: string, ...positionals: any[]): void;
-/**
- * Prints a library-specific error.
- */
-declare function error(message: string, ...positionals: any[]): void;
-export declare const devUtils: {
-    formatMessage: typeof formatMessage;
-    warn: typeof warn;
-    error: typeof error;
-};
-export {};

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

@@ -1,4 +0,0 @@
-/**
- * Return the stack trace frame of a function's invocation.
- */
-export declare function getCallFrame(error: Error): string | undefined;

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

@@ -1,4 +0,0 @@
-/**
- * Determines if the given function is an iterator.
- */
-export declare function isIterable<IteratorType>(fn: any): fn is Generator<IteratorType, IteratorType, IteratorType>;

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

@@ -1,4 +0,0 @@
-/**
- * Determines if the given value is an object.
- */
-export declare function isObject(value: any): boolean;

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

@@ -1,4 +0,0 @@
-/**
- * Performs a case-insensitive comparison of two given strings.
- */
-export declare function isStringEqual(actual: string, expected: string): boolean;

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

@@ -1,5 +0,0 @@
-/**
- * Parses a given value into a JSON.
- * Does not throw an exception on an invalid JSON string.
- */
-export declare function jsonParse<ValueType extends Record<string, any>>(value: any): ValueType | undefined;

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

@@ -1,5 +0,0 @@
-/**
- * Deeply merges two given objects with the right one
- * having a priority during property assignment.
- */
-export declare function mergeRight(left: Record<string, any>, right: Record<string, any>): Record<string, any>;

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

@@ -1,23 +0,0 @@
-import { DocumentNode, OperationTypeNode } from 'graphql';
-import { GraphQLVariables } from '../../handlers/GraphQLHandler';
-import { MockedRequest } from '../../handlers/RequestHandler';
-export interface ParsedGraphQLQuery {
-    operationType: OperationTypeNode;
-    operationName?: string;
-}
-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;
-    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.
- */
-export declare function parseGraphQLRequest(request: MockedRequest<any>): ParsedGraphQLRequest;

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

@@ -1,6 +0,0 @@
-import { DefaultRequestMultipartBody } from '../../handlers/RequestHandler';
-/**
- * Parses a given string as a multipart/form-data.
- * Does not throw an exception on an invalid multipart string.
- */
-export declare function parseMultipartData<T extends DefaultRequestMultipartBody>(data: string, headers?: Headers): T | undefined;

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

@@ -1,6 +0,0 @@
-/// <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/internal/requestHandlerUtils.d.ts

@@ -1,4 +0,0 @@
-import { RequestHandler } from '../../handlers/RequestHandler';
-export declare function use(currentHandlers: RequestHandler[], ...handlers: RequestHandler[]): void;
-export declare function restoreHandlers(handlers: RequestHandler[]): void;
-export declare function resetHandlers(initialHandlers: RequestHandler[], ...nextHandlers: RequestHandler[]): RequestHandler<import("../../handlers/RequestHandler").RequestHandlerDefaultInfo, import("../../handlers/RequestHandler").MockedRequest<import("../../handlers/RequestHandler").DefaultBodyType>, any, import("../../handlers/RequestHandler").MockedRequest<import("../../handlers/RequestHandler").DefaultBodyType>>[];

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

@@ -1,2 +0,0 @@
-import { SetupWorkerInternalContext } from '../../setupWorker/glossary';
-export declare function requestIntegrityCheck(context: SetupWorkerInternalContext, serviceWorker: ServiceWorker): Promise<ServiceWorker>;

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

@@ -1 +0,0 @@
-export declare function tryCatch<Fn extends (...args: any[]) => any>(fn: Fn, onException?: (error: Error) => void): ReturnType<Fn> | undefined;

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

@@ -1 +0,0 @@
-export declare function uuidv4(): string;

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

@@ -1,9 +0,0 @@
-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): StatusCodeColor;

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

@@ -1,4 +0,0 @@
-/**
- * Returns a timestamp string in a "HH:MM:SS" format.
- */
-export declare function getTimestamp(): string;

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

@@ -1,23 +0,0 @@
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Formats a mocked request for introspection in browser's console.
- */
-export declare function prepareRequest(request: MockedRequest): {
-    headers: Record<string, string>;
-    id: string;
-    url: URL;
-    method: string;
-    cookies: Record<string, string>;
-    mode: RequestMode;
-    keepalive: boolean;
-    cache: RequestCache;
-    destination: RequestDestination;
-    integrity: string;
-    credentials: RequestCredentials;
-    redirect: RequestRedirect;
-    referrer: string;
-    referrerPolicy: ReferrerPolicy;
-    body: import("../../handlers/RequestHandler").DefaultBodyType;
-    bodyUsed: boolean;
-    passthrough: typeof import("../../handlers/RequestHandler").passthrough;
-};

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

@@ -1,10 +0,0 @@
-import { SerializedResponse } from '../../setupWorker/glossary';
-/**
- * Formats a mocked response for introspection in the browser's console.
- */
-export declare function prepareResponse(res: SerializedResponse<any>): {
-    body: string | number | boolean | Record<string, any> | null | undefined;
-    status: number;
-    statusText: string;
-    headers: import("headers-polyfill").FlatHeadersObject;
-};

package/lib/types/utils/matching/matchRequestUrl.d.ts

@@ -1,17 +0,0 @@
-export declare type Path = string | RegExp;
-export declare type PathParams<KeyType extends keyof any = string> = {
-    [ParamName in KeyType]: string | ReadonlyArray<string>;
-};
-export interface Match {
-    matches: boolean;
-    params?: PathParams;
-}
-/**
- * Coerce a path supported by MSW into a path
- * supported by "path-to-regexp".
- */
-export declare function coercePath(path: string): string;
-/**
- * Returns the result of matching given request URL against a mask.
- */
-export declare function matchRequestUrl(url: URL, path: Path, baseUrl?: string): Match;

package/lib/types/utils/matching/normalizePath.d.ts

@@ -1,9 +0,0 @@
-import type { Path } from './matchRequestUrl';
-/**
- * Normalizes a given request handler path:
- * - Preserves RegExp.
- * - Removes query parameters and hashes.
- * - Rebases relative URLs against the "baseUrl" or the current location.
- * - Preserves relative URLs in Node.js, unless specified otherwise.
- */
-export declare function normalizePath(path: Path, baseUrl?: string): Path;

package/lib/types/utils/request/getPublicUrlFromRequest.d.ts

@@ -1,6 +0,0 @@
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Returns a relative URL if the given request URL is relative to the current origin.
- * Otherwise returns an absolute URL.
- */
-export declare const getPublicUrlFromRequest: (request: MockedRequest) => string;

package/lib/types/utils/request/getRequestCookies.d.ts

@@ -1,7 +0,0 @@
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Returns relevant document cookies based on the request `credentials` option.
- */
-export declare function getRequestCookies(request: MockedRequest): {
-    [key: string]: string;
-};

package/lib/types/utils/request/onUnhandledRequest.d.ts

@@ -1,8 +0,0 @@
-import { MockedRequest, RequestHandler } from '../../handlers/RequestHandler';
-export interface UnhandledRequestPrint {
-    warning(): void;
-    error(): void;
-}
-export declare type UnhandledRequestCallback = (request: MockedRequest, print: UnhandledRequestPrint) => void;
-export declare type UnhandledRequestStrategy = 'bypass' | 'warn' | 'error' | UnhandledRequestCallback;
-export declare function onUnhandledRequest(request: MockedRequest, handlers: RequestHandler[], strategy?: UnhandledRequestStrategy): void;

package/lib/types/utils/request/parseBody.d.ts

@@ -1,5 +0,0 @@
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Parses a given request/response body based on the "Content-Type" header.
- */
-export declare function parseBody(body?: MockedRequest['body'], headers?: Headers): string | number | boolean | Record<string, any> | null | undefined;

package/lib/types/utils/request/parseIsomorphicRequest.d.ts

@@ -1,6 +0,0 @@
-import { IsomorphicRequest } from '@mswjs/interceptors';
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Converts a given isomorphic request to a `MockedRequest` instance.
- */
-export declare function parseIsomorphicRequest(request: IsomorphicRequest): MockedRequest;

package/lib/types/utils/request/parseWorkerRequest.d.ts

@@ -1,7 +0,0 @@
-import { RestRequest } from '../../handlers/RestHandler';
-import { ServiceWorkerIncomingRequest } from '../../setupWorker/glossary';
-/**
- * Converts a given request received from the Service Worker
- * into a `MockedRequest` instance.
- */
-export declare function parseWorkerRequest(rawRequest: ServiceWorkerIncomingRequest): RestRequest;

package/lib/types/utils/request/pruneGetRequestBody.d.ts

@@ -1,7 +0,0 @@
-import { ServiceWorkerIncomingRequest } from '../../setupWorker/glossary';
-declare type Input = Pick<ServiceWorkerIncomingRequest, 'method' | 'body'>;
-/**
- * Ensures that an empty GET request body is always represented as `undefined`.
- */
-export declare function pruneGetRequestBody(request: Input): ServiceWorkerIncomingRequest['body'];
-export {};

package/lib/types/utils/request/readResponseCookies.d.ts

@@ -1,3 +0,0 @@
-import { MockedResponse } from '../../response';
-import { MockedRequest } from '../../handlers/RequestHandler';
-export declare function readResponseCookies(request: MockedRequest, response: MockedResponse): void;

package/lib/types/utils/request/setRequestCookies.d.ts

@@ -1,9 +0,0 @@
-import { MockedRequest } from '../../handlers/RequestHandler';
-/**
- * Sets relevant cookies on the request.
- * Request cookies are taken from the following sources:
- * - Immediate (own) request cookies (those in the "Cookie" request header);
- * - From the `document.cookie` based on the request's `credentials` value;
- * - From the internal cookie store that persists/hydrates cookies in Node.js
- */
-export declare function setRequestCookies(request: MockedRequest): void;

package/lib/types/utils/url/cleanUrl.d.ts

@@ -1,5 +0,0 @@
-export declare function getSearchParams(path: string): URLSearchParams;
-/**
- * Removes query parameters and hashes from a given URL string.
- */
-export declare function cleanUrl(path: string): string;

package/lib/types/utils/url/getAbsoluteUrl.d.ts

@@ -1,4 +0,0 @@
-/**
- * Returns an absolute URL based on the given path.
- */
-export declare function getAbsoluteUrl(path: string, baseUrl?: string): string;

package/lib/types/utils/url/getAbsoluteWorkerUrl.d.ts

@@ -1,5 +0,0 @@
-/**
- * Returns an absolute Service Worker URL based on the given
- * relative URL (known during the registration).
- */
-export declare function getAbsoluteWorkerUrl(relativeUrl: string): string;

package/lib/types/utils/url/isAbsoluteUrl.d.ts

@@ -1,4 +0,0 @@
-/**
- * Determines if the given URL string is an absolute URL.
- */
-export declare function isAbsoluteUrl(url: string): boolean;

package/lib/types/utils/worker/createFallbackRequestListener.d.ts

@@ -1,4 +0,0 @@
-import { InterceptorApi } from '@mswjs/interceptors';
-import { SetupWorkerInternalContext, StartOptions } from '../../setupWorker/glossary';
-import { RequiredDeep } from '../../typeUtils';
-export declare function createFallbackRequestListener(context: SetupWorkerInternalContext, options: RequiredDeep<StartOptions>): InterceptorApi;

package/lib/types/utils/worker/createRequestListener.d.ts

@@ -1,4 +0,0 @@
-import { StartOptions, SetupWorkerInternalContext, ServiceWorkerIncomingEventsMap } from '../../setupWorker/glossary';
-import { ServiceWorkerMessage } from '../createBroadcastChannel';
-import { RequiredDeep } from '../../typeUtils';
-export declare const createRequestListener: (context: SetupWorkerInternalContext, options: RequiredDeep<StartOptions>) => (event: MessageEvent, message: ServiceWorkerMessage<'REQUEST', ServiceWorkerIncomingEventsMap['REQUEST']>) => Promise<void>;

package/lib/types/utils/worker/createResponseListener.d.ts

@@ -1,3 +0,0 @@
-import { ServiceWorkerIncomingEventsMap, SetupWorkerInternalContext } from '../../setupWorker/glossary';
-import { ServiceWorkerMessage } from '../createBroadcastChannel';
-export declare function createResponseListener(context: SetupWorkerInternalContext): (_: MessageEvent, message: ServiceWorkerMessage<'RESPONSE', ServiceWorkerIncomingEventsMap['RESPONSE']>) => void;