msw 0.40.2 → 0.41.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.
- package/config/constants.js +1 -3
- package/config/scripts/postinstall.js +32 -25
- package/lib/esm/index.js +1967 -1589
- package/lib/esm/index.js.map +1 -0
- package/lib/glossary-36cf4e2d.d.ts +331 -0
- package/lib/iife/index.js +9773 -21
- package/lib/iife/index.js.map +1 -0
- package/lib/index.d.ts +353 -0
- package/lib/index.js +2125 -0
- package/lib/index.js.map +1 -0
- package/lib/{esm/mockServiceWorker.js → mockServiceWorker.js} +1 -1
- package/lib/native/index.d.ts +9 -0
- package/lib/native/index.js +1532 -0
- package/lib/native/index.mjs +1532 -0
- package/lib/node/index.d.ts +15 -0
- package/lib/node/index.js +1601 -0
- package/lib/node/index.js.map +1 -0
- package/lib/node/index.mjs +1601 -0
- package/lib/node/index.mjs.map +1 -0
- package/native/package.json +3 -2
- package/node/package.json +3 -2
- package/package.json +11 -20
- package/lib/esm/errors-deps.js +0 -74
- package/lib/esm/fetch-deps.js +0 -1005
- package/lib/esm/graphql-deps.js +0 -3545
- package/lib/esm/graphql.js +0 -5
- package/lib/esm/index-deps.js +0 -21
- package/lib/esm/index2.js +0 -3
- package/lib/esm/matchRequestUrl-deps.js +0 -992
- package/lib/esm/rest-deps.js +0 -103
- package/lib/esm/rest.js +0 -5
- package/lib/esm/xml-deps.js +0 -44
- package/lib/iife/mockServiceWorker.js +0 -338
- package/lib/types/context/body.d.ts +0 -9
- package/lib/types/context/cookie.d.ts +0 -7
- package/lib/types/context/data.d.ts +0 -8
- package/lib/types/context/delay.d.ts +0 -15
- package/lib/types/context/errors.d.ts +0 -8
- package/lib/types/context/extensions.d.ts +0 -8
- package/lib/types/context/fetch.d.ts +0 -9
- package/lib/types/context/index.d.ts +0 -12
- package/lib/types/context/json.d.ts +0 -12
- package/lib/types/context/set.d.ts +0 -18
- package/lib/types/context/status.d.ts +0 -9
- package/lib/types/context/text.d.ts +0 -8
- package/lib/types/context/xml.d.ts +0 -9
- package/lib/types/graphql.d.ts +0 -74
- package/lib/types/handlers/GraphQLHandler.d.ts +0 -39
- package/lib/types/handlers/RequestHandler.d.ts +0 -103
- package/lib/types/handlers/RestHandler.d.ts +0 -47
- package/lib/types/index.d.ts +0 -26
- package/lib/types/native/index.d.ts +0 -1
- package/lib/types/node/createSetupServer.d.ts +0 -8
- package/lib/types/node/glossary.d.ts +0 -38
- package/lib/types/node/index.d.ts +0 -2
- package/lib/types/node/setupServer.d.ts +0 -6
- package/lib/types/response.d.ts +0 -35
- package/lib/types/rest.d.ts +0 -13
- package/lib/types/setupWorker/glossary.d.ts +0 -161
- package/lib/types/setupWorker/setupWorker.d.ts +0 -9
- package/lib/types/setupWorker/start/createFallbackStart.d.ts +0 -2
- package/lib/types/setupWorker/start/createStartHandler.d.ts +0 -2
- package/lib/types/setupWorker/start/utils/enableMocking.d.ts +0 -5
- package/lib/types/setupWorker/start/utils/getWorkerByRegistration.d.ts +0 -6
- package/lib/types/setupWorker/start/utils/getWorkerInstance.d.ts +0 -6
- package/lib/types/setupWorker/start/utils/prepareStartHandler.d.ts +0 -9
- package/lib/types/setupWorker/start/utils/printStartMessage.d.ts +0 -10
- package/lib/types/setupWorker/start/utils/validateWorkerScope.d.ts +0 -2
- package/lib/types/setupWorker/stop/createFallbackStop.d.ts +0 -2
- package/lib/types/setupWorker/stop/createStop.d.ts +0 -2
- package/lib/types/setupWorker/stop/utils/printStopMessage.d.ts +0 -3
- package/lib/types/sharedOptions.d.ts +0 -24
- package/lib/types/typeUtils.d.ts +0 -7
- package/lib/types/utils/NetworkError.d.ts +0 -3
- package/lib/types/utils/createBroadcastChannel.d.ts +0 -18
- package/lib/types/utils/deferNetworkRequestsUntil.d.ts +0 -6
- package/lib/types/utils/getResponse.d.ts +0 -15
- package/lib/types/utils/handleRequest.d.ts +0 -34
- package/lib/types/utils/internal/compose.d.ts +0 -14
- package/lib/types/utils/internal/devUtils.d.ts +0 -18
- package/lib/types/utils/internal/getCallFrame.d.ts +0 -4
- package/lib/types/utils/internal/isIterable.d.ts +0 -4
- package/lib/types/utils/internal/isObject.d.ts +0 -4
- package/lib/types/utils/internal/isStringEqual.d.ts +0 -4
- package/lib/types/utils/internal/jsonParse.d.ts +0 -5
- package/lib/types/utils/internal/mergeRight.d.ts +0 -5
- package/lib/types/utils/internal/parseGraphQLRequest.d.ts +0 -23
- package/lib/types/utils/internal/parseMultipartData.d.ts +0 -6
- package/lib/types/utils/internal/pipeEvents.d.ts +0 -6
- package/lib/types/utils/internal/requestHandlerUtils.d.ts +0 -4
- package/lib/types/utils/internal/requestIntegrityCheck.d.ts +0 -2
- package/lib/types/utils/internal/tryCatch.d.ts +0 -1
- package/lib/types/utils/internal/uuidv4.d.ts +0 -1
- package/lib/types/utils/logging/getStatusCodeColor.d.ts +0 -9
- package/lib/types/utils/logging/getTimestamp.d.ts +0 -4
- package/lib/types/utils/logging/prepareRequest.d.ts +0 -23
- package/lib/types/utils/logging/prepareResponse.d.ts +0 -10
- package/lib/types/utils/matching/matchRequestUrl.d.ts +0 -17
- package/lib/types/utils/matching/normalizePath.d.ts +0 -9
- package/lib/types/utils/request/getPublicUrlFromRequest.d.ts +0 -6
- package/lib/types/utils/request/getRequestCookies.d.ts +0 -7
- package/lib/types/utils/request/onUnhandledRequest.d.ts +0 -8
- package/lib/types/utils/request/parseBody.d.ts +0 -5
- package/lib/types/utils/request/parseIsomorphicRequest.d.ts +0 -6
- package/lib/types/utils/request/parseWorkerRequest.d.ts +0 -7
- package/lib/types/utils/request/pruneGetRequestBody.d.ts +0 -7
- package/lib/types/utils/request/readResponseCookies.d.ts +0 -3
- package/lib/types/utils/request/setRequestCookies.d.ts +0 -9
- package/lib/types/utils/url/cleanUrl.d.ts +0 -5
- package/lib/types/utils/url/getAbsoluteUrl.d.ts +0 -4
- package/lib/types/utils/url/getAbsoluteWorkerUrl.d.ts +0 -5
- package/lib/types/utils/url/isAbsoluteUrl.d.ts +0 -4
- package/lib/types/utils/worker/createFallbackRequestListener.d.ts +0 -4
- package/lib/types/utils/worker/createRequestListener.d.ts +0 -4
- package/lib/types/utils/worker/createResponseListener.d.ts +0 -3
- package/lib/umd/index.js +0 -31617
- package/lib/umd/mockServiceWorker.js +0 -338
- package/native/lib/index.js +0 -6384
- package/node/lib/index.js +0 -8276
package/lib/types/graphql.d.ts
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
import { DocumentNode } from 'graphql';
|
|
2
|
-
import { ResponseResolver } from './handlers/RequestHandler';
|
|
3
|
-
import { GraphQLHandler, GraphQLContext, GraphQLRequest, GraphQLVariables, GraphQLHandlerNameSelector } from './handlers/GraphQLHandler';
|
|
4
|
-
import { Path } from './utils/matching/matchRequestUrl';
|
|
5
|
-
export interface TypedDocumentNode<Result = {
|
|
6
|
-
[key: string]: any;
|
|
7
|
-
}, Variables = {
|
|
8
|
-
[key: string]: any;
|
|
9
|
-
}> extends DocumentNode {
|
|
10
|
-
__apiType?: (variables: Variables) => Result;
|
|
11
|
-
__resultType?: Result;
|
|
12
|
-
__variablesType?: Variables;
|
|
13
|
-
}
|
|
14
|
-
declare const standardGraphQLHandlers: {
|
|
15
|
-
/**
|
|
16
|
-
* Captures any GraphQL operation, regardless of its name, under the current scope.
|
|
17
|
-
* @example
|
|
18
|
-
* graphql.operation((req, res, ctx) => {
|
|
19
|
-
* return res(ctx.data({ name: 'John' }))
|
|
20
|
-
* })
|
|
21
|
-
* @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
|
|
22
|
-
*/
|
|
23
|
-
operation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLRequest<Variables>, GraphQLContext<Query>, any>) => GraphQLHandler<GraphQLRequest<Variables>>;
|
|
24
|
-
/**
|
|
25
|
-
* Captures a GraphQL query by a given name.
|
|
26
|
-
* @example
|
|
27
|
-
* graphql.query('GetUser', (req, res, ctx) => {
|
|
28
|
-
* return res(ctx.data({ user: { name: 'John' } }))
|
|
29
|
-
* })
|
|
30
|
-
* @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
|
|
31
|
-
*/
|
|
32
|
-
query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<Variables_1>>;
|
|
33
|
-
/**
|
|
34
|
-
* Captures a GraphQL mutation by a given name.
|
|
35
|
-
* @example
|
|
36
|
-
* graphql.mutation('SavePost', (req, res, ctx) => {
|
|
37
|
-
* return res(ctx.data({ post: { id: 'abc-123' } }))
|
|
38
|
-
* })
|
|
39
|
-
* @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
|
|
40
|
-
*/
|
|
41
|
-
mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<Variables_1>>;
|
|
42
|
-
};
|
|
43
|
-
declare function createGraphQLLink(url: Path): typeof standardGraphQLHandlers;
|
|
44
|
-
export declare const graphql: {
|
|
45
|
-
link: typeof createGraphQLLink;
|
|
46
|
-
/**
|
|
47
|
-
* Captures any GraphQL operation, regardless of its name, under the current scope.
|
|
48
|
-
* @example
|
|
49
|
-
* graphql.operation((req, res, ctx) => {
|
|
50
|
-
* return res(ctx.data({ name: 'John' }))
|
|
51
|
-
* })
|
|
52
|
-
* @see {@link https://mswjs.io/docs/api/graphql/operation `graphql.operation()`}
|
|
53
|
-
*/
|
|
54
|
-
operation: <Query extends Record<string, any>, Variables extends GraphQLVariables = GraphQLVariables>(resolver: ResponseResolver<GraphQLRequest<Variables>, GraphQLContext<Query>, any>) => GraphQLHandler<GraphQLRequest<Variables>>;
|
|
55
|
-
/**
|
|
56
|
-
* Captures a GraphQL query by a given name.
|
|
57
|
-
* @example
|
|
58
|
-
* graphql.query('GetUser', (req, res, ctx) => {
|
|
59
|
-
* return res(ctx.data({ user: { name: 'John' } }))
|
|
60
|
-
* })
|
|
61
|
-
* @see {@link https://mswjs.io/docs/api/graphql/query `graphql.query()`}
|
|
62
|
-
*/
|
|
63
|
-
query: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<Variables_1>>;
|
|
64
|
-
/**
|
|
65
|
-
* Captures a GraphQL mutation by a given name.
|
|
66
|
-
* @example
|
|
67
|
-
* graphql.mutation('SavePost', (req, res, ctx) => {
|
|
68
|
-
* return res(ctx.data({ post: { id: 'abc-123' } }))
|
|
69
|
-
* })
|
|
70
|
-
* @see {@link https://mswjs.io/docs/api/graphql/mutation `graphql.mutation()`}
|
|
71
|
-
*/
|
|
72
|
-
mutation: <Query_1 extends Record<string, any>, Variables_1 extends GraphQLVariables = GraphQLVariables>(operationName: GraphQLHandlerNameSelector | TypedDocumentNode<Query_1, Variables_1>, resolver: ResponseResolver<GraphQLRequest<Variables_1>, GraphQLContext<Query_1>, any>) => GraphQLHandler<GraphQLRequest<Variables_1>>;
|
|
73
|
-
};
|
|
74
|
-
export {};
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import { DocumentNode, OperationTypeNode } from 'graphql';
|
|
2
|
-
import { SerializedResponse } from '../setupWorker/glossary';
|
|
3
|
-
import { errors } from '../context/errors';
|
|
4
|
-
import { GraphQLPayloadContext } from '../typeUtils';
|
|
5
|
-
import { cookie } from '../context/cookie';
|
|
6
|
-
import { DefaultContext, MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
|
|
7
|
-
import { Path } from '../utils/matching/matchRequestUrl';
|
|
8
|
-
import { ParsedGraphQLRequest, GraphQLMultipartRequestBody } from '../utils/internal/parseGraphQLRequest';
|
|
9
|
-
export declare type ExpectedOperationTypeNode = OperationTypeNode | 'all';
|
|
10
|
-
export declare type GraphQLHandlerNameSelector = DocumentNode | RegExp | string;
|
|
11
|
-
export declare type GraphQLContext<QueryType extends Record<string, unknown>> = DefaultContext & {
|
|
12
|
-
data: GraphQLPayloadContext<QueryType>;
|
|
13
|
-
extensions: GraphQLPayloadContext<QueryType>;
|
|
14
|
-
errors: typeof errors;
|
|
15
|
-
cookie: typeof cookie;
|
|
16
|
-
};
|
|
17
|
-
export declare const graphqlContext: GraphQLContext<any>;
|
|
18
|
-
export declare type GraphQLVariables = Record<string, any>;
|
|
19
|
-
export interface GraphQLHandlerInfo extends RequestHandlerDefaultInfo {
|
|
20
|
-
operationType: ExpectedOperationTypeNode;
|
|
21
|
-
operationName: GraphQLHandlerNameSelector;
|
|
22
|
-
}
|
|
23
|
-
export declare type GraphQLRequestBody<VariablesType extends GraphQLVariables> = GraphQLJsonRequestBody<VariablesType> | GraphQLMultipartRequestBody | Record<string, any> | undefined;
|
|
24
|
-
export interface GraphQLJsonRequestBody<Variables extends GraphQLVariables> {
|
|
25
|
-
query: string;
|
|
26
|
-
variables?: Variables;
|
|
27
|
-
}
|
|
28
|
-
export interface GraphQLRequest<Variables extends GraphQLVariables> extends MockedRequest<GraphQLRequestBody<Variables>> {
|
|
29
|
-
variables: Variables;
|
|
30
|
-
}
|
|
31
|
-
export declare function isDocumentNode(value: DocumentNode | any): value is DocumentNode;
|
|
32
|
-
export declare class GraphQLHandler<Request extends GraphQLRequest<any> = GraphQLRequest<any>> extends RequestHandler<GraphQLHandlerInfo, Request, ParsedGraphQLRequest | null, GraphQLRequest<any>> {
|
|
33
|
-
private endpoint;
|
|
34
|
-
constructor(operationType: ExpectedOperationTypeNode, operationName: GraphQLHandlerNameSelector, endpoint: Path, resolver: ResponseResolver<any, any>);
|
|
35
|
-
parse(request: MockedRequest): ParsedGraphQLRequest<GraphQLVariables>;
|
|
36
|
-
protected getPublicRequest(request: Request, parsedResult: ParsedGraphQLRequest): GraphQLRequest<any>;
|
|
37
|
-
predicate(request: MockedRequest, parsedResult: ParsedGraphQLRequest): boolean;
|
|
38
|
-
log(request: Request, response: SerializedResponse, handler: this, parsedRequest: ParsedGraphQLRequest): void;
|
|
39
|
-
}
|
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
import { Headers } from 'headers-polyfill';
|
|
2
|
-
import { MaybePromise, MockedResponse, ResponseComposition } from '../response';
|
|
3
|
-
import { status } from '../context/status';
|
|
4
|
-
import { set } from '../context/set';
|
|
5
|
-
import { delay } from '../context/delay';
|
|
6
|
-
import { fetch } from '../context/fetch';
|
|
7
|
-
import { ResponseResolutionContext } from '../utils/getResponse';
|
|
8
|
-
import { SerializedResponse } from '../setupWorker/glossary';
|
|
9
|
-
export declare type DefaultContext = {
|
|
10
|
-
status: typeof status;
|
|
11
|
-
set: typeof set;
|
|
12
|
-
delay: typeof delay;
|
|
13
|
-
fetch: typeof fetch;
|
|
14
|
-
};
|
|
15
|
-
export declare const defaultContext: DefaultContext;
|
|
16
|
-
export declare type DefaultRequestMultipartBody = Record<string, string | File | (string | File)[]>;
|
|
17
|
-
export declare type DefaultBodyType = Record<string, any> | DefaultRequestMultipartBody | string | number | boolean | null | undefined;
|
|
18
|
-
export interface MockedRequest<Body = DefaultBodyType> {
|
|
19
|
-
id: string;
|
|
20
|
-
url: URL;
|
|
21
|
-
method: Request['method'];
|
|
22
|
-
headers: Headers;
|
|
23
|
-
cookies: Record<string, string>;
|
|
24
|
-
mode: Request['mode'];
|
|
25
|
-
keepalive: Request['keepalive'];
|
|
26
|
-
cache: Request['cache'];
|
|
27
|
-
destination: Request['destination'];
|
|
28
|
-
integrity: Request['integrity'];
|
|
29
|
-
credentials: Request['credentials'];
|
|
30
|
-
redirect: Request['redirect'];
|
|
31
|
-
referrer: Request['referrer'];
|
|
32
|
-
referrerPolicy: Request['referrerPolicy'];
|
|
33
|
-
body: Body;
|
|
34
|
-
bodyUsed: Request['bodyUsed'];
|
|
35
|
-
passthrough: typeof passthrough;
|
|
36
|
-
}
|
|
37
|
-
export interface RequestHandlerDefaultInfo {
|
|
38
|
-
header: string;
|
|
39
|
-
}
|
|
40
|
-
export interface RequestHandlerInternalInfo {
|
|
41
|
-
callFrame?: string;
|
|
42
|
-
}
|
|
43
|
-
declare type ContextMap = Record<string, (...args: any[]) => any>;
|
|
44
|
-
export declare type ResponseResolverReturnType<ReturnType> = ReturnType | undefined | void;
|
|
45
|
-
export declare type MaybeAsyncResponseResolverReturnType<ReturnType> = MaybePromise<ResponseResolverReturnType<ReturnType>>;
|
|
46
|
-
export declare type AsyncResponseResolverReturnType<ReturnType> = MaybeAsyncResponseResolverReturnType<ReturnType> | Generator<MaybeAsyncResponseResolverReturnType<ReturnType>, MaybeAsyncResponseResolverReturnType<ReturnType>, MaybeAsyncResponseResolverReturnType<ReturnType>>;
|
|
47
|
-
export declare type ResponseResolver<RequestType = MockedRequest, ContextType = typeof defaultContext, BodyType = any> = (req: RequestType, res: ResponseComposition<BodyType>, context: ContextType) => AsyncResponseResolverReturnType<MockedResponse<BodyType>>;
|
|
48
|
-
export interface RequestHandlerOptions<HandlerInfo> {
|
|
49
|
-
info: HandlerInfo;
|
|
50
|
-
resolver: ResponseResolver<any, any>;
|
|
51
|
-
ctx?: ContextMap;
|
|
52
|
-
}
|
|
53
|
-
export interface RequestHandlerExecutionResult<PublicRequestType> {
|
|
54
|
-
handler: RequestHandler;
|
|
55
|
-
parsedResult: any;
|
|
56
|
-
request: PublicRequestType;
|
|
57
|
-
response?: MockedResponse;
|
|
58
|
-
}
|
|
59
|
-
export declare abstract class RequestHandler<HandlerInfo extends RequestHandlerDefaultInfo = RequestHandlerDefaultInfo, Request extends MockedRequest = MockedRequest, ParsedResult = any, PublicRequest extends MockedRequest = Request> {
|
|
60
|
-
info: HandlerInfo & RequestHandlerInternalInfo;
|
|
61
|
-
shouldSkip: boolean;
|
|
62
|
-
private ctx;
|
|
63
|
-
private resolverGenerator?;
|
|
64
|
-
private resolverGeneratorResult?;
|
|
65
|
-
protected resolver: ResponseResolver<any, any>;
|
|
66
|
-
constructor(options: RequestHandlerOptions<HandlerInfo>);
|
|
67
|
-
/**
|
|
68
|
-
* Determine if the captured request should be mocked.
|
|
69
|
-
*/
|
|
70
|
-
abstract predicate(request: MockedRequest, parsedResult: ParsedResult, resolutionContext?: ResponseResolutionContext): boolean;
|
|
71
|
-
/**
|
|
72
|
-
* Print out the successfully handled request.
|
|
73
|
-
*/
|
|
74
|
-
abstract log(request: Request, response: SerializedResponse<any>, handler: this, parsedResult: ParsedResult): void;
|
|
75
|
-
/**
|
|
76
|
-
* Parse the captured request to extract additional information from it.
|
|
77
|
-
* Parsed result is then exposed to other methods of this request handler.
|
|
78
|
-
*/
|
|
79
|
-
parse(_request: MockedRequest, _resolutionContext?: ResponseResolutionContext): ParsedResult;
|
|
80
|
-
/**
|
|
81
|
-
* Test if this handler matches the given request.
|
|
82
|
-
*/
|
|
83
|
-
test(request: MockedRequest, resolutionContext?: ResponseResolutionContext): boolean;
|
|
84
|
-
/**
|
|
85
|
-
* Derive the publicly exposed request (`req`) instance of the response resolver
|
|
86
|
-
* from the captured request and its parsed result.
|
|
87
|
-
*/
|
|
88
|
-
protected getPublicRequest(request: MockedRequest, _parsedResult: ParsedResult): PublicRequest;
|
|
89
|
-
markAsSkipped(shouldSkip?: boolean): void;
|
|
90
|
-
/**
|
|
91
|
-
* Execute this request handler and produce a mocked response
|
|
92
|
-
* using the given resolver function.
|
|
93
|
-
*/
|
|
94
|
-
run(request: MockedRequest, resolutionContext?: ResponseResolutionContext): Promise<RequestHandlerExecutionResult<PublicRequest> | null>;
|
|
95
|
-
private wrapResolver;
|
|
96
|
-
private createExecutionResult;
|
|
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>;
|
|
103
|
-
export {};
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { body, cookie, json, text, xml } from '../context';
|
|
2
|
-
import { SerializedResponse } from '../setupWorker/glossary';
|
|
3
|
-
import { ResponseResolutionContext } from '../utils/getResponse';
|
|
4
|
-
import { Match, Path, PathParams } from '../utils/matching/matchRequestUrl';
|
|
5
|
-
import { DefaultBodyType, DefaultContext, MockedRequest, RequestHandler, RequestHandlerDefaultInfo, ResponseResolver } from './RequestHandler';
|
|
6
|
-
declare type RestHandlerMethod = string | RegExp;
|
|
7
|
-
export interface RestHandlerInfo extends RequestHandlerDefaultInfo {
|
|
8
|
-
method: RestHandlerMethod;
|
|
9
|
-
path: Path;
|
|
10
|
-
}
|
|
11
|
-
export declare enum RESTMethods {
|
|
12
|
-
HEAD = "HEAD",
|
|
13
|
-
GET = "GET",
|
|
14
|
-
POST = "POST",
|
|
15
|
-
PUT = "PUT",
|
|
16
|
-
PATCH = "PATCH",
|
|
17
|
-
OPTIONS = "OPTIONS",
|
|
18
|
-
DELETE = "DELETE"
|
|
19
|
-
}
|
|
20
|
-
export declare type RestContext = DefaultContext & {
|
|
21
|
-
cookie: typeof cookie;
|
|
22
|
-
text: typeof text;
|
|
23
|
-
body: typeof body;
|
|
24
|
-
json: typeof json;
|
|
25
|
-
xml: typeof xml;
|
|
26
|
-
};
|
|
27
|
-
export declare const restContext: RestContext;
|
|
28
|
-
export declare type RequestQuery = {
|
|
29
|
-
[queryName: string]: string;
|
|
30
|
-
};
|
|
31
|
-
export interface RestRequest<BodyType extends DefaultBodyType = DefaultBodyType, ParamsType extends PathParams = PathParams> extends MockedRequest<BodyType> {
|
|
32
|
-
params: ParamsType;
|
|
33
|
-
}
|
|
34
|
-
export declare type ParsedRestRequest = Match;
|
|
35
|
-
/**
|
|
36
|
-
* Request handler for REST API requests.
|
|
37
|
-
* Provides request matching based on method and URL.
|
|
38
|
-
*/
|
|
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>> {
|
|
40
|
-
constructor(method: RestHandlerMethod, path: Path, resolver: ResponseResolver<any, any>);
|
|
41
|
-
private checkRedundantQueryParameters;
|
|
42
|
-
parse(request: RequestType, resolutionContext?: ResponseResolutionContext): Match;
|
|
43
|
-
protected getPublicRequest(request: RequestType, parsedResult: ParsedRestRequest): RestRequest<any, PathParams>;
|
|
44
|
-
predicate(request: RequestType, parsedResult: ParsedRestRequest): boolean;
|
|
45
|
-
log(request: RequestType, response: SerializedResponse): void;
|
|
46
|
-
}
|
|
47
|
-
export {};
|
package/lib/types/index.d.ts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import * as context from './context';
|
|
2
|
-
export { context };
|
|
3
|
-
export { setupWorker } from './setupWorker/setupWorker';
|
|
4
|
-
export { response, defaultResponse, createResponseComposition, } from './response';
|
|
5
|
-
export { RequestHandler, defaultContext } from './handlers/RequestHandler';
|
|
6
|
-
export { rest } from './rest';
|
|
7
|
-
export { RestHandler, RESTMethods, restContext } from './handlers/RestHandler';
|
|
8
|
-
export { graphql } from './graphql';
|
|
9
|
-
export { GraphQLHandler, graphqlContext } from './handlers/GraphQLHandler';
|
|
10
|
-
export { matchRequestUrl } from './utils/matching/matchRequestUrl';
|
|
11
|
-
export { compose } from './utils/internal/compose';
|
|
12
|
-
export * from './utils/handleRequest';
|
|
13
|
-
export * from './utils/request/parseIsomorphicRequest';
|
|
14
|
-
export { cleanUrl } from './utils/url/cleanUrl';
|
|
15
|
-
/**
|
|
16
|
-
* Type definitions.
|
|
17
|
-
*/
|
|
18
|
-
export type { SetupWorkerApi, StartOptions } from './setupWorker/glossary';
|
|
19
|
-
export type { SharedOptions } from './sharedOptions';
|
|
20
|
-
export type { MockedRequest, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, DefaultBodyType, DefaultRequestMultipartBody, } from './handlers/RequestHandler';
|
|
21
|
-
export type { MockedResponse, ResponseTransformer, ResponseComposition, ResponseCompositionOptions, ResponseFunction, } from './response';
|
|
22
|
-
export type { RestContext, RequestQuery, RestRequest, ParsedRestRequest, } from './handlers/RestHandler';
|
|
23
|
-
export type { GraphQLContext, GraphQLVariables, GraphQLRequest, GraphQLRequestBody, GraphQLJsonRequestBody, } from './handlers/GraphQLHandler';
|
|
24
|
-
export type { Path, PathParams, Match } from './utils/matching/matchRequestUrl';
|
|
25
|
-
export type { DelayMode } from './context/delay';
|
|
26
|
-
export { ParsedGraphQLRequest } from './utils/internal/parseGraphQLRequest';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const setupServer: (...requestHandlers: import("..").RequestHandler<import("../handlers/RequestHandler").RequestHandlerDefaultInfo, import("..").MockedRequest<import("..").DefaultBodyType>, any, import("..").MockedRequest<import("..").DefaultBodyType>>[]) => import("../node").SetupServerApi;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { Interceptor } from '@mswjs/interceptors';
|
|
2
|
-
import { SetupServerApi } from './glossary';
|
|
3
|
-
import { RequestHandler } from '../handlers/RequestHandler';
|
|
4
|
-
/**
|
|
5
|
-
* Creates a `setupServer` API using given request interceptors.
|
|
6
|
-
* Useful to generate identical API using different patches to request issuing modules.
|
|
7
|
-
*/
|
|
8
|
-
export declare function createSetupServer(...interceptors: Interceptor[]): (...requestHandlers: RequestHandler[]) => SetupServerApi;
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import { PartialDeep } from 'type-fest';
|
|
2
|
-
import { IsomorphicResponse } from '@mswjs/interceptors';
|
|
3
|
-
import { RequestHandler } from '../handlers/RequestHandler';
|
|
4
|
-
import { LifeCycleEventEmitter, LifeCycleEventsMap, SharedOptions } from '../sharedOptions';
|
|
5
|
-
export declare type ServerLifecycleEventsMap = LifeCycleEventsMap<IsomorphicResponse>;
|
|
6
|
-
export interface SetupServerApi {
|
|
7
|
-
/**
|
|
8
|
-
* Starts requests interception based on the previously provided request handlers.
|
|
9
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/listen `server.listen()`}
|
|
10
|
-
*/
|
|
11
|
-
listen(options?: PartialDeep<SharedOptions>): void;
|
|
12
|
-
/**
|
|
13
|
-
* Stops requests interception by restoring all augmented modules.
|
|
14
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/close `server.close()`}
|
|
15
|
-
*/
|
|
16
|
-
close(): void;
|
|
17
|
-
/**
|
|
18
|
-
* Prepends given request handlers to the list of existing handlers.
|
|
19
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/use `server.use()`}
|
|
20
|
-
*/
|
|
21
|
-
use(...handlers: RequestHandler[]): void;
|
|
22
|
-
/**
|
|
23
|
-
* Marks all request handlers that respond using `res.once()` as unused.
|
|
24
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/restore-handlers `server.restore-handlers()`}
|
|
25
|
-
*/
|
|
26
|
-
restoreHandlers(): void;
|
|
27
|
-
/**
|
|
28
|
-
* Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
|
|
29
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/reset-handlers `server.reset-handlers()`}
|
|
30
|
-
*/
|
|
31
|
-
resetHandlers(...nextHandlers: RequestHandler[]): void;
|
|
32
|
-
/**
|
|
33
|
-
* Lists all active request handlers.
|
|
34
|
-
* @see {@link https://mswjs.io/docs/api/setup-server/print-handlers `server.print-handlers()`}
|
|
35
|
-
*/
|
|
36
|
-
printHandlers(): void;
|
|
37
|
-
events: LifeCycleEventEmitter<ServerLifecycleEventsMap>;
|
|
38
|
-
}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Sets up a requests interception in Node.js with the given request handlers.
|
|
3
|
-
* @param {RequestHandler[]} requestHandlers List of request handlers.
|
|
4
|
-
* @see {@link https://mswjs.io/docs/api/setup-server `setupServer`}
|
|
5
|
-
*/
|
|
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
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { Headers } from 'headers-polyfill';
|
|
2
|
-
export declare type MaybePromise<ValueType = any> = ValueType | Promise<ValueType>;
|
|
3
|
-
/**
|
|
4
|
-
* Internal representation of a mocked response instance.
|
|
5
|
-
*/
|
|
6
|
-
export interface MockedResponse<BodyType = any> {
|
|
7
|
-
body: BodyType;
|
|
8
|
-
status: number;
|
|
9
|
-
statusText: string;
|
|
10
|
-
headers: Headers;
|
|
11
|
-
once: boolean;
|
|
12
|
-
passthrough: boolean;
|
|
13
|
-
delay?: number;
|
|
14
|
-
}
|
|
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>>;
|
|
17
|
-
export declare type ResponseComposition<BodyType = any> = ResponseFunction<BodyType> & {
|
|
18
|
-
/**
|
|
19
|
-
* Respond using a given mocked response to the first captured request.
|
|
20
|
-
* Does not affect any subsequent captured requests.
|
|
21
|
-
*/
|
|
22
|
-
once: ResponseFunction<BodyType>;
|
|
23
|
-
networkError: (message: string) => void;
|
|
24
|
-
};
|
|
25
|
-
export declare const defaultResponse: Omit<MockedResponse, 'headers'>;
|
|
26
|
-
export declare type ResponseCompositionOptions<BodyType> = {
|
|
27
|
-
defaultTransformers?: ResponseTransformer<BodyType>[];
|
|
28
|
-
mockedResponseOverrides?: Partial<MockedResponse>;
|
|
29
|
-
};
|
|
30
|
-
export declare const defaultResponseTransformers: ResponseTransformer<any>[];
|
|
31
|
-
export declare function createResponseComposition<BodyType>(responseOverrides?: Partial<MockedResponse<BodyType>>, defaultTransformers?: ResponseTransformer<BodyType>[]): ResponseFunction;
|
|
32
|
-
export declare const response: ResponseFunction<any> & {
|
|
33
|
-
once: ResponseFunction<any>;
|
|
34
|
-
networkError(message: string): never;
|
|
35
|
-
};
|
package/lib/types/rest.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { DefaultBodyType, ResponseResolver } from './handlers/RequestHandler';
|
|
2
|
-
import { RestContext, RestHandler, RestRequest } from './handlers/RestHandler';
|
|
3
|
-
import { Path, PathParams } from './utils/matching/matchRequestUrl';
|
|
4
|
-
export declare const rest: {
|
|
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
|
-
};
|
|
@@ -1,161 +0,0 @@
|
|
|
1
|
-
import { FlatHeadersObject } from 'headers-polyfill';
|
|
2
|
-
import { StrictEventEmitter } from 'strict-event-emitter';
|
|
3
|
-
import { LifeCycleEventEmitter, LifeCycleEventsMap, SharedOptions } from '../sharedOptions';
|
|
4
|
-
import { ServiceWorkerMessage } from '../utils/createBroadcastChannel';
|
|
5
|
-
import { RequestHandler } from '../handlers/RequestHandler';
|
|
6
|
-
import { InterceptorApi } from '@mswjs/interceptors';
|
|
7
|
-
import { Path } from '../utils/matching/matchRequestUrl';
|
|
8
|
-
import { RequiredDeep } from '../typeUtils';
|
|
9
|
-
export declare type ResolvedPath = Path | URL;
|
|
10
|
-
declare type RequestWithoutMethods = Omit<Request, 'text' | 'body' | 'json' | 'blob' | 'arrayBuffer' | 'formData' | 'clone' | 'signal' | 'isHistoryNavigation' | 'isReloadNavigation'>;
|
|
11
|
-
/**
|
|
12
|
-
* Request representation received from the worker message event.
|
|
13
|
-
*/
|
|
14
|
-
export interface ServiceWorkerIncomingRequest extends RequestWithoutMethods {
|
|
15
|
-
/**
|
|
16
|
-
* Unique UUID of the request generated once the request is
|
|
17
|
-
* captured by the "fetch" event in the Service Worker.
|
|
18
|
-
*/
|
|
19
|
-
id: string;
|
|
20
|
-
/**
|
|
21
|
-
* Text response body.
|
|
22
|
-
*/
|
|
23
|
-
body: string | undefined;
|
|
24
|
-
}
|
|
25
|
-
export declare type ServiceWorkerIncomingResponse = Pick<Response, 'type' | 'ok' | 'status' | 'statusText' | 'body' | 'headers' | 'redirected'> & {
|
|
26
|
-
requestId: string;
|
|
27
|
-
};
|
|
28
|
-
/**
|
|
29
|
-
* Map of the events that can be received from the Service Worker.
|
|
30
|
-
*/
|
|
31
|
-
export interface ServiceWorkerIncomingEventsMap {
|
|
32
|
-
MOCKING_ENABLED: boolean;
|
|
33
|
-
INTEGRITY_CHECK_RESPONSE: string;
|
|
34
|
-
KEEPALIVE_RESPONSE: never;
|
|
35
|
-
REQUEST: ServiceWorkerIncomingRequest;
|
|
36
|
-
RESPONSE: ServiceWorkerIncomingResponse;
|
|
37
|
-
}
|
|
38
|
-
/**
|
|
39
|
-
* Map of the events that can be sent to the Service Worker
|
|
40
|
-
* from any execution context.
|
|
41
|
-
*/
|
|
42
|
-
export declare type ServiceWorkerOutgoingEventTypes = 'MOCK_ACTIVATE' | 'MOCK_DEACTIVATE' | 'INTEGRITY_CHECK_REQUEST' | 'KEEPALIVE_REQUEST' | 'CLIENT_CLOSED';
|
|
43
|
-
/**
|
|
44
|
-
* Map of the events that can be sent to the Service Worker
|
|
45
|
-
* only as a part of a single `fetch` event handler.
|
|
46
|
-
*/
|
|
47
|
-
export declare type ServiceWorkerFetchEventTypes = 'MOCK_SUCCESS' | 'MOCK_NOT_FOUND' | 'NETWORK_ERROR' | 'INTERNAL_ERROR';
|
|
48
|
-
export declare type WorkerLifecycleEventsMap = LifeCycleEventsMap<Response>;
|
|
49
|
-
export interface SetupWorkerInternalContext {
|
|
50
|
-
isMockingEnabled: boolean;
|
|
51
|
-
startOptions?: RequiredDeep<StartOptions>;
|
|
52
|
-
worker: ServiceWorker | null;
|
|
53
|
-
registration: ServiceWorkerRegistration | null;
|
|
54
|
-
requestHandlers: RequestHandler[];
|
|
55
|
-
emitter: StrictEventEmitter<WorkerLifecycleEventsMap>;
|
|
56
|
-
keepAliveInterval?: number;
|
|
57
|
-
workerChannel: {
|
|
58
|
-
/**
|
|
59
|
-
* Adds a Service Worker event listener.
|
|
60
|
-
*/
|
|
61
|
-
on<EventType extends keyof ServiceWorkerIncomingEventsMap>(eventType: EventType, callback: (event: MessageEvent, message: ServiceWorkerMessage<EventType, ServiceWorkerIncomingEventsMap[EventType]>) => void): void;
|
|
62
|
-
send<EventType extends ServiceWorkerOutgoingEventTypes>(eventType: EventType): void;
|
|
63
|
-
};
|
|
64
|
-
events: {
|
|
65
|
-
/**
|
|
66
|
-
* Adds an event listener on the given target.
|
|
67
|
-
* Returns a clean-up function that removes that listener.
|
|
68
|
-
*/
|
|
69
|
-
addListener<EventType extends Event = Event>(target: EventTarget, eventType: string, listener: (event: EventType) => void): () => void;
|
|
70
|
-
/**
|
|
71
|
-
* Removes all currently attached listeners.
|
|
72
|
-
*/
|
|
73
|
-
removeAllListeners(): void;
|
|
74
|
-
/**
|
|
75
|
-
* Awaits a given message type from the Service Worker.
|
|
76
|
-
*/
|
|
77
|
-
once<EventType extends keyof ServiceWorkerIncomingEventsMap>(eventType: EventType): Promise<ServiceWorkerMessage<EventType, ServiceWorkerIncomingEventsMap[EventType]>>;
|
|
78
|
-
};
|
|
79
|
-
useFallbackMode: boolean;
|
|
80
|
-
fallbackInterceptor?: InterceptorApi;
|
|
81
|
-
}
|
|
82
|
-
export declare type ServiceWorkerInstanceTuple = [
|
|
83
|
-
ServiceWorker | null,
|
|
84
|
-
ServiceWorkerRegistration
|
|
85
|
-
];
|
|
86
|
-
export declare type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
|
|
87
|
-
export interface StartOptions extends SharedOptions {
|
|
88
|
-
/**
|
|
89
|
-
* Service Worker registration options.
|
|
90
|
-
*/
|
|
91
|
-
serviceWorker?: {
|
|
92
|
-
/**
|
|
93
|
-
* Custom url to the worker script.
|
|
94
|
-
* @default "./mockServiceWorker.js"
|
|
95
|
-
*/
|
|
96
|
-
url?: string;
|
|
97
|
-
options?: RegistrationOptions;
|
|
98
|
-
};
|
|
99
|
-
/**
|
|
100
|
-
* Disables the logging of captured requests
|
|
101
|
-
* into browser's console.
|
|
102
|
-
* @default false
|
|
103
|
-
*/
|
|
104
|
-
quiet?: boolean;
|
|
105
|
-
/**
|
|
106
|
-
* Defers any network requests until the Service Worker
|
|
107
|
-
* instance is activated.
|
|
108
|
-
* @default true
|
|
109
|
-
*/
|
|
110
|
-
waitUntilReady?: boolean;
|
|
111
|
-
/**
|
|
112
|
-
* A custom lookup function to find a Mock Service Worker in the list
|
|
113
|
-
* of all registered Service Workers on the page.
|
|
114
|
-
*/
|
|
115
|
-
findWorker?: FindWorker;
|
|
116
|
-
}
|
|
117
|
-
export interface SerializedResponse<BodyType = any> {
|
|
118
|
-
status: number;
|
|
119
|
-
statusText: string;
|
|
120
|
-
headers: FlatHeadersObject;
|
|
121
|
-
body: BodyType;
|
|
122
|
-
}
|
|
123
|
-
export declare type StartReturnType = Promise<ServiceWorkerRegistration | undefined>;
|
|
124
|
-
export declare type StartHandler = (options: RequiredDeep<StartOptions>, initialOptions: StartOptions) => StartReturnType;
|
|
125
|
-
export declare type StopHandler = () => void;
|
|
126
|
-
export interface SetupWorkerApi {
|
|
127
|
-
/**
|
|
128
|
-
* Registers and activates the mock Service Worker.
|
|
129
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
|
|
130
|
-
*/
|
|
131
|
-
start: (options?: StartOptions) => StartReturnType;
|
|
132
|
-
/**
|
|
133
|
-
* Stops requests interception for the current client.
|
|
134
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/stop `worker.stop()`}
|
|
135
|
-
*/
|
|
136
|
-
stop: StopHandler;
|
|
137
|
-
/**
|
|
138
|
-
* Prepends given request handlers to the list of existing handlers.
|
|
139
|
-
* @param {RequestHandler[]} handlers List of runtime request handlers.
|
|
140
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/use `worker.use()`}
|
|
141
|
-
*/
|
|
142
|
-
use: (...handlers: RequestHandler[]) => void;
|
|
143
|
-
/**
|
|
144
|
-
* Marks all request handlers that respond using `res.once()` as unused.
|
|
145
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/restore-handlers `worker.restoreHandlers()`}
|
|
146
|
-
*/
|
|
147
|
-
restoreHandlers: () => void;
|
|
148
|
-
/**
|
|
149
|
-
* Resets request handlers to the initial list given to the `setupWorker` call, or to the explicit next request handlers list, if given.
|
|
150
|
-
* @param {RequestHandler[]} nextHandlers List of the new initial request handlers.
|
|
151
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/reset-handlers `worker.resetHandlers()`}
|
|
152
|
-
*/
|
|
153
|
-
resetHandlers: (...nextHandlers: RequestHandler[]) => void;
|
|
154
|
-
/**
|
|
155
|
-
* Lists all active request handlers.
|
|
156
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker/print-handlers `worker.printHandlers()`}
|
|
157
|
-
*/
|
|
158
|
-
printHandlers: () => void;
|
|
159
|
-
events: LifeCycleEventEmitter<WorkerLifecycleEventsMap>;
|
|
160
|
-
}
|
|
161
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { SetupWorkerApi } from './glossary';
|
|
2
|
-
import { RequestHandler } from '../handlers/RequestHandler';
|
|
3
|
-
/**
|
|
4
|
-
* Creates a new mock Service Worker registration
|
|
5
|
-
* with the given request handlers.
|
|
6
|
-
* @param {RequestHandler[]} requestHandlers List of request handlers
|
|
7
|
-
* @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
|
|
8
|
-
*/
|
|
9
|
-
export declare function setupWorker(...requestHandlers: RequestHandler[]): SetupWorkerApi;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { FindWorker } from '../../glossary';
|
|
2
|
-
/**
|
|
3
|
-
* Attempts to resolve a Service Worker instance from a given registration,
|
|
4
|
-
* regardless of its state (active, installing, waiting).
|
|
5
|
-
*/
|
|
6
|
-
export declare const getWorkerByRegistration: (registration: ServiceWorkerRegistration, absoluteWorkerUrl: string, findWorker: FindWorker) => ServiceWorker | null;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { ServiceWorkerInstanceTuple, FindWorker } from '../../glossary';
|
|
2
|
-
/**
|
|
3
|
-
* Returns an active Service Worker instance.
|
|
4
|
-
* When not found, registers a new Service Worker.
|
|
5
|
-
*/
|
|
6
|
-
export declare const getWorkerInstance: (url: string, options: RegistrationOptions | undefined, findWorker: FindWorker) => Promise<ServiceWorkerInstanceTuple>;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { RequiredDeep } from '../../../typeUtils';
|
|
2
|
-
import { SetupWorkerApi, SetupWorkerInternalContext, StartHandler, StartOptions } from '../../glossary';
|
|
3
|
-
export declare const DEFAULT_START_OPTIONS: RequiredDeep<StartOptions>;
|
|
4
|
-
/**
|
|
5
|
-
* Returns resolved worker start options, merging the default options
|
|
6
|
-
* with the given custom options.
|
|
7
|
-
*/
|
|
8
|
-
export declare function resolveStartOptions(initialOptions?: StartOptions): RequiredDeep<StartOptions>;
|
|
9
|
-
export declare function prepareStartHandler(handler: StartHandler, context: SetupWorkerInternalContext): SetupWorkerApi['start'];
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
export interface PrintStartMessageArgs {
|
|
2
|
-
quiet?: boolean;
|
|
3
|
-
message?: string;
|
|
4
|
-
workerUrl?: string;
|
|
5
|
-
workerScope?: string;
|
|
6
|
-
}
|
|
7
|
-
/**
|
|
8
|
-
* Prints a worker activation message in the browser's console.
|
|
9
|
-
*/
|
|
10
|
-
export declare function printStartMessage(args?: PrintStartMessageArgs): void;
|