msw 0.39.2 → 0.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/lib/esm/graphql-deps.js +4 -10
  3. package/lib/esm/graphql.js +2 -2
  4. package/lib/esm/index.js +54 -10
  5. package/lib/esm/{RequestHandler-deps.js → matchRequestUrl-deps.js} +192 -173
  6. package/lib/esm/mockServiceWorker.js +1 -1
  7. package/lib/esm/rest-deps.js +4 -10
  8. package/lib/esm/rest.js +1 -1
  9. package/lib/iife/index.js +2 -2
  10. package/lib/iife/mockServiceWorker.js +1 -1
  11. package/lib/types/handlers/GraphQLHandler.d.ts +2 -10
  12. package/lib/types/handlers/RequestHandler.d.ts +18 -8
  13. package/lib/types/handlers/RestHandler.d.ts +5 -9
  14. package/lib/types/index.d.ts +1 -1
  15. package/lib/types/native/index.d.ts +1 -1
  16. package/lib/types/node/setupServer.d.ts +1 -1
  17. package/lib/types/response.d.ts +4 -2
  18. package/lib/types/rest.d.ts +9 -9
  19. package/lib/types/setupWorker/glossary.d.ts +1 -0
  20. package/lib/types/setupWorker/start/utils/printStartMessage.d.ts +3 -2
  21. package/lib/types/sharedOptions.d.ts +1 -0
  22. package/lib/types/utils/getResponse.d.ts +1 -1
  23. package/lib/types/utils/handleRequest.d.ts +2 -2
  24. package/lib/types/utils/internal/requestHandlerUtils.d.ts +1 -1
  25. package/lib/types/utils/logging/prepareRequest.d.ts +2 -1
  26. package/lib/types/utils/matching/matchRequestUrl.d.ts +3 -1
  27. package/lib/umd/index.js +246 -195
  28. package/lib/umd/mockServiceWorker.js +1 -1
  29. package/native/lib/index.js +537 -489
  30. package/node/lib/index.js +537 -489
  31. package/package.json +12 -5
package/lib/iife/mockServiceWorker.js CHANGED
@@ -2,7 +2,7 @@
2
2
  /* tslint:disable */
3
3
 
4
4
  /**
5
- * Mock Service Worker (0.39.2).
5
+ * Mock Service Worker (0.40.0).
6
6
  * @see https://github.com/mswjs/msw
7
7
  * - Please do NOT modify this file.
8
8
  * - Please do NOT serve this file on production.
package/lib/types/handlers/GraphQLHandler.d.ts CHANGED
@@ -1,22 +1,14 @@
1
1
  import { DocumentNode, OperationTypeNode } from 'graphql';
2
2
  import { SerializedResponse } from '../setupWorker/glossary';
3
- import { set } from '../context/set';
4
- import { status } from '../context/status';
5
- import { delay } from '../context/delay';
6
- import { fetch } from '../context/fetch';
7
3
  import { errors } from '../context/errors';
8
4
  import { GraphQLPayloadContext } from '../typeUtils';
9
5
  import { cookie } from '../context/cookie';
10
- import { MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
6
+ import { DefaultContext, MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
11
7
  import { Path } from '../utils/matching/matchRequestUrl';
12
8
  import { ParsedGraphQLRequest, GraphQLMultipartRequestBody } from '../utils/internal/parseGraphQLRequest';
13
9
  export declare type ExpectedOperationTypeNode = OperationTypeNode | 'all';
14
10
  export declare type GraphQLHandlerNameSelector = DocumentNode | RegExp | string;
15
- export declare type GraphQLContext<QueryType extends Record<string, unknown>> = {
16
- set: typeof set;
17
- status: typeof status;
18
- delay: typeof delay;
19
- fetch: typeof fetch;
11
+ export declare type GraphQLContext<QueryType extends Record<string, unknown>> = DefaultContext & {
20
12
  data: GraphQLPayloadContext<QueryType>;
21
13
  extensions: GraphQLPayloadContext<QueryType>;
22
14
  errors: typeof errors;
package/lib/types/handlers/RequestHandler.d.ts CHANGED
@@ -1,17 +1,21 @@
1
1
  import { Headers } from 'headers-polyfill';
2
- import { MockedResponse, ResponseComposition } from '../response';
2
+ import { MaybePromise, MockedResponse, ResponseComposition } from '../response';
3
+ import { status } from '../context/status';
3
4
  import { set } from '../context/set';
5
+ import { delay } from '../context/delay';
6
+ import { fetch } from '../context/fetch';
4
7
  import { ResponseResolutionContext } from '../utils/getResponse';
5
8
  import { SerializedResponse } from '../setupWorker/glossary';
6
- export declare const defaultContext: {
7
- status: (statusCode: number, statusText?: string | undefined) => import("../response").ResponseTransformer<any, any>;
9
+ export declare type DefaultContext = {
10
+ status: typeof status;
8
11
  set: typeof set;
9
- delay: (durationOrMode?: number | import("../context/delay").DelayMode | undefined) => import("../response").ResponseTransformer<any, any>;
10
- fetch: (input: string | MockedRequest<DefaultRequestBody>, requestInit?: RequestInit) => Promise<Response>;
12
+ delay: typeof delay;
13
+ fetch: typeof fetch;
11
14
  };
15
+ export declare const defaultContext: DefaultContext;
12
16
  export declare type DefaultRequestMultipartBody = Record<string, string | File | (string | File)[]>;
13
- export declare type DefaultRequestBody = Record<string, any> | DefaultRequestMultipartBody | string | number | boolean | null | undefined;
14
- export interface MockedRequest<Body = DefaultRequestBody> {
17
+ export declare type DefaultBodyType = Record<string, any> | DefaultRequestMultipartBody | string | number | boolean | null | undefined;
18
+ export interface MockedRequest<Body = DefaultBodyType> {
15
19
  id: string;
16
20
  url: URL;
17
21
  method: Request['method'];
@@ -28,6 +32,7 @@ export interface MockedRequest<Body = DefaultRequestBody> {
28
32
  referrerPolicy: Request['referrerPolicy'];
29
33
  body: Body;
30
34
  bodyUsed: Request['bodyUsed'];
35
+ passthrough: typeof passthrough;
31
36
  }
32
37
  export interface RequestHandlerDefaultInfo {
33
38
  header: string;
@@ -37,7 +42,7 @@ export interface RequestHandlerInternalInfo {
37
42
  }
38
43
  declare type ContextMap = Record<string, (...args: any[]) => any>;
39
44
  export declare type ResponseResolverReturnType<ReturnType> = ReturnType | undefined | void;
40
- export declare type MaybeAsyncResponseResolverReturnType<ReturnType> = ResponseResolverReturnType<ReturnType> | Promise<ResponseResolverReturnType<ReturnType>>;
45
+ export declare type MaybeAsyncResponseResolverReturnType<ReturnType> = MaybePromise<ResponseResolverReturnType<ReturnType>>;
41
46
  export declare type AsyncResponseResolverReturnType<ReturnType> = MaybeAsyncResponseResolverReturnType<ReturnType> | Generator<MaybeAsyncResponseResolverReturnType<ReturnType>, MaybeAsyncResponseResolverReturnType<ReturnType>, MaybeAsyncResponseResolverReturnType<ReturnType>>;
42
47
  export declare type ResponseResolver<RequestType = MockedRequest, ContextType = typeof defaultContext, BodyType = any> = (req: RequestType, res: ResponseComposition<BodyType>, context: ContextType) => AsyncResponseResolverReturnType<MockedResponse<BodyType>>;
43
48
  export interface RequestHandlerOptions<HandlerInfo> {
@@ -90,4 +95,9 @@ export declare abstract class RequestHandler<HandlerInfo extends RequestHandlerD
90
95
  private wrapResolver;
91
96
  private createExecutionResult;
92
97
  }
98
+ /**
99
+ * Bypass this intercepted request.
100
+ * This will make a call to the actual endpoint requested.
101
+ */
102
+ export declare function passthrough(): MockedResponse<null>;
93
103
  export {};
package/lib/types/handlers/RestHandler.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- import { body, cookie, delay, fetch, json, set, status, text, xml } from '../context';
1
+ import { body, cookie, json, text, xml } from '../context';
2
2
  import { SerializedResponse } from '../setupWorker/glossary';
3
3
  import { ResponseResolutionContext } from '../utils/getResponse';
4
4
  import { Match, Path, PathParams } from '../utils/matching/matchRequestUrl';
5
- import { DefaultRequestBody, MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
5
+ import { DefaultBodyType, DefaultContext, MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
6
6
  declare type RestHandlerMethod = string | RegExp;
7
7
  export interface RestHandlerInfo extends RequestHandlerDefaultInfo {
8
8
  method: RestHandlerMethod;
@@ -17,22 +17,18 @@ export declare enum RESTMethods {
17
17
  OPTIONS = "OPTIONS",
18
18
  DELETE = "DELETE"
19
19
  }
20
- export declare type RestContext = {
21
- set: typeof set;
22
- status: typeof status;
20
+ export declare type RestContext = DefaultContext & {
23
21
  cookie: typeof cookie;
24
22
  text: typeof text;
25
23
  body: typeof body;
26
24
  json: typeof json;
27
25
  xml: typeof xml;
28
- delay: typeof delay;
29
- fetch: typeof fetch;
30
26
  };
31
27
  export declare const restContext: RestContext;
32
28
  export declare type RequestQuery = {
33
29
  [queryName: string]: string;
34
30
  };
35
- export interface RestRequest<BodyType extends DefaultRequestBody = DefaultRequestBody, ParamsType extends PathParams = PathParams> extends MockedRequest<BodyType> {
31
+ export interface RestRequest<BodyType extends DefaultBodyType = DefaultBodyType, ParamsType extends PathParams = PathParams> extends MockedRequest<BodyType> {
36
32
  params: ParamsType;
37
33
  }
38
34
  export declare type ParsedRestRequest = Match;
@@ -40,7 +36,7 @@ export declare type ParsedRestRequest = Match;
40
36
  * Request handler for REST API requests.
41
37
  * Provides request matching based on method and URL.
42
38
  */
43
- export declare class RestHandler<RequestType extends MockedRequest<DefaultRequestBody> = MockedRequest<DefaultRequestBody>> extends RequestHandler<RestHandlerInfo, RequestType, ParsedRestRequest, RestRequest<RequestType extends MockedRequest<infer RequestBodyType> ? RequestBodyType : any, PathParams>> {
39
+ export declare class RestHandler<RequestType extends MockedRequest<DefaultBodyType> = MockedRequest<DefaultBodyType>> extends RequestHandler<RestHandlerInfo, RequestType, ParsedRestRequest, RestRequest<RequestType extends MockedRequest<infer RequestBodyType> ? RequestBodyType : any, PathParams>> {
44
40
  constructor(method: RestHandlerMethod, path: Path, resolver: ResponseResolver<any, any>);
45
41
  private checkRedundantQueryParameters;
46
42
  parse(request: RequestType, resolutionContext?: ResponseResolutionContext): Match;
package/lib/types/index.d.ts CHANGED
@@ -17,7 +17,7 @@ export { cleanUrl } from './utils/url/cleanUrl';
17
17
  */
18
18
  export type { SetupWorkerApi, StartOptions } from './setupWorker/glossary';
19
19
  export type { SharedOptions } from './sharedOptions';
20
- export type { MockedRequest, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, DefaultRequestBody, DefaultRequestMultipartBody, } from './handlers/RequestHandler';
20
+ export type { MockedRequest, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, DefaultBodyType, DefaultRequestMultipartBody, } from './handlers/RequestHandler';
21
21
  export type { MockedResponse, ResponseTransformer, ResponseComposition, ResponseCompositionOptions, ResponseFunction, } from './response';
22
22
  export type { RestContext, RequestQuery, RestRequest, ParsedRestRequest, } from './handlers/RestHandler';
23
23
  export type { GraphQLContext, GraphQLVariables, GraphQLRequest, GraphQLRequestBody, GraphQLJsonRequestBody, } from './handlers/GraphQLHandler';
package/lib/types/native/index.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const setupServer: (...requestHandlers: import("..").RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, import("..").MockedRequest<import("..").DefaultRequestBody>, any, import("..").MockedRequest<import("..").DefaultRequestBody>>[]) => import("../node").SetupServerApi;
1
+ export declare const setupServer: (...requestHandlers: import("..").RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, import("..").MockedRequest<import("..").DefaultBodyType>, any, import("..").MockedRequest<import("..").DefaultBodyType>>[]) => import("../node").SetupServerApi;
package/lib/types/node/setupServer.d.ts CHANGED
@@ -3,4 +3,4 @@
3
3
  * @param {RequestHandler[]} requestHandlers List of request handlers.
4
4
  * @see {@link https://mswjs.io/docs/api/setup-server `setupServer`}
5
5
  */
6
- export declare const setupServer: (...requestHandlers: import("..").RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, import("..").MockedRequest<import("..").DefaultRequestBody>, any, import("..").MockedRequest<import("..").DefaultRequestBody>>[]) => import("./glossary").SetupServerApi;
6
+ export declare const setupServer: (...requestHandlers: import("..").RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, import("..").MockedRequest<import("..").DefaultBodyType>, any, import("..").MockedRequest<import("..").DefaultBodyType>>[]) => import("./glossary").SetupServerApi;
package/lib/types/response.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { Headers } from 'headers-polyfill';
2
+ export declare type MaybePromise<ValueType = any> = ValueType | Promise<ValueType>;
2
3
  /**
3
4
  * Internal representation of a mocked response instance.
4
5
  */
@@ -8,10 +9,11 @@ export interface MockedResponse<BodyType = any> {
8
9
  statusText: string;
9
10
  headers: Headers;
10
11
  once: boolean;
12
+ passthrough: boolean;
11
13
  delay?: number;
12
14
  }
13
- export declare type ResponseTransformer<BodyType extends TransformerBodyType = any, TransformerBodyType = any> = (res: MockedResponse<TransformerBodyType>) => MockedResponse<BodyType> | Promise<MockedResponse<BodyType>>;
14
- export declare type ResponseFunction<BodyType = any> = (...transformers: ResponseTransformer<BodyType>[]) => MockedResponse<BodyType> | Promise<MockedResponse<BodyType>>;
15
+ export declare type ResponseTransformer<BodyType extends TransformerBodyType = any, TransformerBodyType = any> = (res: MockedResponse<TransformerBodyType>) => MaybePromise<MockedResponse<BodyType>>;
16
+ export declare type ResponseFunction<BodyType = any> = (...transformers: ResponseTransformer<BodyType>[]) => MaybePromise<MockedResponse<BodyType>>;
15
17
  export declare type ResponseComposition<BodyType = any> = ResponseFunction<BodyType> & {
16
18
  /**
17
19
  * Respond using a given mocked response to the first captured request.
package/lib/types/rest.d.ts CHANGED
@@ -1,13 +1,13 @@
1
- import { DefaultRequestBody, ResponseResolver } from './handlers/RequestHandler';
1
+ import { DefaultBodyType, ResponseResolver } from './handlers/RequestHandler';
2
2
  import { RestContext, RestHandler, RestRequest } from './handlers/RestHandler';
3
3
  import { Path, PathParams } from './utils/matching/matchRequestUrl';
4
4
  export declare const rest: {
5
- all: <RequestBodyType extends DefaultRequestBody = DefaultRequestBody, Params extends PathParams = PathParams, ResponseBody extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType, Params>, RestContext, ResponseBody>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
6
- head: <RequestBodyType_1 extends DefaultRequestBody = DefaultRequestBody, Params_1 extends PathParams = PathParams, ResponseBody_1 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<never, Params_1>, RestContext, ResponseBody_1>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
7
- get: <RequestBodyType_2 extends DefaultRequestBody = DefaultRequestBody, Params_2 extends PathParams = PathParams, ResponseBody_2 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<never, Params_2>, RestContext, ResponseBody_2>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
8
- post: <RequestBodyType_3 extends DefaultRequestBody = DefaultRequestBody, Params_3 extends PathParams = PathParams, ResponseBody_3 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_3, Params_3>, RestContext, ResponseBody_3>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
9
- put: <RequestBodyType_4 extends DefaultRequestBody = DefaultRequestBody, Params_4 extends PathParams = PathParams, ResponseBody_4 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_4, Params_4>, RestContext, ResponseBody_4>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
10
- delete: <RequestBodyType_5 extends DefaultRequestBody = DefaultRequestBody, Params_5 extends PathParams = PathParams, ResponseBody_5 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_5, Params_5>, RestContext, ResponseBody_5>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
11
- patch: <RequestBodyType_6 extends DefaultRequestBody = DefaultRequestBody, Params_6 extends PathParams = PathParams, ResponseBody_6 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_6, Params_6>, RestContext, ResponseBody_6>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
12
- options: <RequestBodyType_7 extends DefaultRequestBody = DefaultRequestBody, Params_7 extends PathParams = PathParams, ResponseBody_7 extends DefaultRequestBody = DefaultRequestBody>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_7, Params_7>, RestContext, ResponseBody_7>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultRequestBody>>;
5
+ all: <RequestBodyType extends DefaultBodyType = DefaultBodyType, Params extends PathParams<keyof Params> = PathParams<string>, ResponseBody extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType, Params>, RestContext, ResponseBody>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
6
+ head: <RequestBodyType_1 extends DefaultBodyType = DefaultBodyType, Params_1 extends PathParams<keyof Params_1> = PathParams<string>, ResponseBody_1 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<never, Params_1>, RestContext, ResponseBody_1>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
7
+ get: <RequestBodyType_2 extends DefaultBodyType = DefaultBodyType, Params_2 extends PathParams<keyof Params_2> = PathParams<string>, ResponseBody_2 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<never, Params_2>, RestContext, ResponseBody_2>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
8
+ post: <RequestBodyType_3 extends DefaultBodyType = DefaultBodyType, Params_3 extends PathParams<keyof Params_3> = PathParams<string>, ResponseBody_3 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_3, Params_3>, RestContext, ResponseBody_3>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
9
+ put: <RequestBodyType_4 extends DefaultBodyType = DefaultBodyType, Params_4 extends PathParams<keyof Params_4> = PathParams<string>, ResponseBody_4 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_4, Params_4>, RestContext, ResponseBody_4>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
10
+ delete: <RequestBodyType_5 extends DefaultBodyType = DefaultBodyType, Params_5 extends PathParams<keyof Params_5> = PathParams<string>, ResponseBody_5 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_5, Params_5>, RestContext, ResponseBody_5>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
11
+ patch: <RequestBodyType_6 extends DefaultBodyType = DefaultBodyType, Params_6 extends PathParams<keyof Params_6> = PathParams<string>, ResponseBody_6 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_6, Params_6>, RestContext, ResponseBody_6>) => RestHandler<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
12
+ 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<import("./handlers/RequestHandler").MockedRequest<DefaultBodyType>>;
13
13
  };
package/lib/types/setupWorker/glossary.d.ts CHANGED
@@ -47,6 +47,7 @@ export declare type ServiceWorkerOutgoingEventTypes = 'MOCK_ACTIVATE' | 'MOCK_DE
47
47
  export declare type ServiceWorkerFetchEventTypes = 'MOCK_SUCCESS' | 'MOCK_NOT_FOUND' | 'NETWORK_ERROR' | 'INTERNAL_ERROR';
48
48
  export declare type WorkerLifecycleEventsMap = LifeCycleEventsMap<Response>;
49
49
  export interface SetupWorkerInternalContext {
50
+ isMockingEnabled: boolean;
50
51
  startOptions?: RequiredDeep<StartOptions>;
51
52
  worker: ServiceWorker | null;
52
53
  registration: ServiceWorkerRegistration | null;
package/lib/types/setupWorker/start/utils/printStartMessage.d.ts CHANGED
@@ -1,9 +1,10 @@
1
- interface PrintStartMessageArgs {
1
+ export interface PrintStartMessageArgs {
2
2
  quiet?: boolean;
3
3
  message?: string;
4
+ workerUrl?: string;
5
+ workerScope?: string;
4
6
  }
5
7
  /**
6
8
  * Prints a worker activation message in the browser's console.
7
9
  */
8
10
  export declare function printStartMessage(args?: PrintStartMessageArgs): void;
9
- export {};
package/lib/types/sharedOptions.d.ts CHANGED
@@ -19,5 +19,6 @@ export interface LifeCycleEventsMap<ResponseType> {
19
19
  'request:end': (request: MockedRequest) => void;
20
20
  'response:mocked': (response: ResponseType, requestId: string) => void;
21
21
  'response:bypass': (response: ResponseType, requestId: string) => void;
22
+ unhandledException: (error: Error, request: MockedRequest) => void;
22
23
  }
23
24
  export declare type LifeCycleEventEmitter<ResponseType> = Pick<StrictEventEmitter<ResponseType>, 'on' | 'removeListener' | 'removeAllListeners'>;
package/lib/types/utils/getResponse.d.ts CHANGED
@@ -12,4 +12,4 @@ export interface ResponseResolutionContext {
12
12
  /**
13
13
  * Returns a mocked response for a given request using following request handlers.
14
14
  */
15
- export declare const getResponse: <Request_1 extends MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, Handler extends RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>, any, MockedRequest<import("../handlers/RequestHandler").DefaultRequestBody>>[]>(request: Request_1, handlers: Handler, resolutionContext?: ResponseResolutionContext | undefined) => Promise<ResponseLookupResult>;
15
+ 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 CHANGED
@@ -18,9 +18,9 @@ export interface HandleRequestOptions<ResponseType> {
18
18
  */
19
19
  transformResponse?(response: MockedResponse<string>): ResponseType;
20
20
  /**
21
- * Invoked whenever returning a bypassed (as-is) response.
21
+ * Invoked whenever a request is performed as-is.
22
22
  */
23
- onBypassResponse?(request: MockedRequest): void;
23
+ onPassthroughResponse?(request: MockedRequest): void;
24
24
  /**
25
25
  * Invoked when the mocked response is ready to be sent.
26
26
  */
package/lib/types/utils/internal/requestHandlerUtils.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { RequestHandler } from '../../handlers/RequestHandler';
2
2
  export declare function use(currentHandlers: RequestHandler[], ...handlers: RequestHandler[]): void;
3
3
  export declare function restoreHandlers(handlers: RequestHandler[]): void;
4
- export declare function resetHandlers(initialHandlers: RequestHandler[], ...nextHandlers: RequestHandler[]): RequestHandler<import("../../handlers/RequestHandler").RequestHandlerDefaultInfo, import("../../handlers/RequestHandler").MockedRequest<import("../../handlers/RequestHandler").DefaultRequestBody>, any, import("../../handlers/RequestHandler").MockedRequest<import("../../handlers/RequestHandler").DefaultRequestBody>>[];
4
+ 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/logging/prepareRequest.d.ts CHANGED
@@ -17,6 +17,7 @@ export declare function prepareRequest(request: MockedRequest): {
17
17
  redirect: RequestRedirect;
18
18
  referrer: string;
19
19
  referrerPolicy: ReferrerPolicy;
20
- body: import("../../handlers/RequestHandler").DefaultRequestBody;
20
+ body: import("../../handlers/RequestHandler").DefaultBodyType;
21
21
  bodyUsed: boolean;
22
+ passthrough: typeof import("../../handlers/RequestHandler").passthrough;
22
23
  };
package/lib/types/utils/matching/matchRequestUrl.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  export declare type Path = string | RegExp;
2
- export declare type PathParams = Record<string, string | ReadonlyArray<string>>;
2
+ export declare type PathParams<KeyType extends keyof any = string> = {
3
+ [ParamName in KeyType]: string | ReadonlyArray<string>;
4
+ };
3
5
  export interface Match {
4
6
  matches: boolean;
5
7
  params?: PathParams;