msw 0.20.5 → 0.21.3

package/node/node/createSetupServer.d.ts

@@ -0,0 +1,29 @@
+import { Interceptor } from 'node-request-interceptor';
+import { RequestHandlersList } from '../setupWorker/glossary';
+import { SharedOptions } from '../sharedOptions';
+/**
+ * Creates a `setupServer` API using given request interceptors.
+ * Useful to generate identical API using different patches to request issuing modules.
+ */
+export declare function createSetupServer(...interceptors: Interceptor[]): (...requestHandlers: RequestHandlersList) => {
+    /**
+     * Enables requests interception based on the previously provided mock definition.
+     */
+    listen(options?: SharedOptions | undefined): void;
+    /**
+     * Prepends given request handlers to the list of existing handlers.
+     */
+    use(...handlers: RequestHandlersList): void;
+    /**
+     * Marks all request handlers that respond using `res.once()` as unused.
+     */
+    restoreHandlers(): void;
+    /**
+     * Resets request handlers to the initial list given to the `setupServer` call, or to the explicit next request handlers list, if given.
+     */
+    resetHandlers(...nextHandlers: RequestHandlersList): void;
+    /**
+     * Stops requests interception by restoring all augmented modules.
+     */
+    close(): void;
+};

package/node/node/index.d.ts

@@ -0,0 +1,5 @@
+export { setupServer } from './setupServer'
+
+declare module 'types/context/body.d.ts' {
+  export const body: string
+}

package/node/node/setupServer.d.ts

@@ -0,0 +1,7 @@
+export declare const setupServer: (...requestHandlers: import("../setupWorker/glossary").RequestHandlersList) => {
+    listen(options?: import("../sharedOptions").SharedOptions | undefined): void;
+    use(...handlers: import("../setupWorker/glossary").RequestHandlersList): void;
+    restoreHandlers(): void;
+    resetHandlers(...nextHandlers: import("../setupWorker/glossary").RequestHandlersList): void;
+    close(): void;
+};

package/node/response.d.ts

@@ -0,0 +1,25 @@
+import { Headers } from 'headers-utils';
+export interface MockedResponse<BodyType = any> {
+    body: BodyType;
+    status: number;
+    statusText: string;
+    headers: Headers;
+    once: boolean;
+    delay?: number;
+}
+export declare type ResponseTransformer<BodyType = any> = (res: MockedResponse<BodyType>) => MockedResponse<BodyType>;
+declare type ResponseFunction<BodyType = any> = (...transformers: ResponseTransformer<BodyType>[]) => MockedResponse<BodyType>;
+export declare type ResponseComposition<BodyType = any> = ResponseFunction<BodyType> & {
+    /**
+     * Respond using a given mocked response to the first captured request.
+     * Does not affect any subsequent captured requests.
+     */
+    once: ResponseFunction<BodyType>;
+    networkError: (message: string) => void;
+};
+export declare const defaultResponse: Omit<MockedResponse, 'headers'>;
+export declare const response: ResponseFunction<any> & {
+    once: ResponseFunction<any>;
+    networkError(message: string): never;
+};
+export {};

package/node/utils/NetworkError.d.ts

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

package/node/utils/getResponse.d.ts

@@ -0,0 +1,14 @@
+import { RequestHandlersList } from '../setupWorker/glossary';
+import { RequestHandler, MockedRequest } from './handlers/requestHandler';
+import { MockedResponse } from '../response';
+interface ResponsePayload {
+    response: MockedResponse | null;
+    handler: RequestHandler<any, any> | null;
+    publicRequest?: any;
+    parsedRequest?: any;
+}
+/**
+ * Returns a mocked response for a given request using following request handlers.
+ */
+export declare const getResponse: <R extends MockedRequest<import("./handlers/requestHandler").DefaultRequestBodyType>, H extends RequestHandlersList>(req: R, handlers: H) => Promise<ResponsePayload>;
+export {};

package/{lib/types → node/utils}/handlers/requestHandler.d.ts

@@ -1,14 +1,15 @@
 import { Headers } from 'headers-utils';
-import { ResponseWithSerializedHeaders } from '../setupWorker/glossary';
-import { ResponseComposition, MockedResponse } from '../response';
-import { set } from '../context/set';
+import { ResponseWithSerializedHeaders } from '../../setupWorker/glossary';
+import { ResponseComposition, MockedResponse } from '../../response';
+import { set } from '../../context/set';
 export declare const defaultContext: {
-    status: (statusCode: number, statusText?: string | undefined) => import("../response").ResponseTransformer;
+    status: (statusCode: number, statusText?: string | undefined) => import("../../response").ResponseTransformer<any>;
     set: typeof set;
-    delay: (durationMs?: number | undefined) => import("../response").ResponseTransformer;
-    fetch: <ResponseType_1 = any>(input: string | MockedRequest, requestInit?: RequestInit) => Promise<ResponseType_1>;
+    delay: (durationMs?: number | undefined) => import("../../response").ResponseTransformer<any>;
+    fetch: (input: string | MockedRequest<DefaultRequestBodyType>, requestInit?: RequestInit) => Promise<Response>;
 };
-export interface MockedRequest {
+export declare type DefaultRequestBodyType = Record<string, any> | string | undefined;
+export interface MockedRequest<BodyType = DefaultRequestBodyType> {
     url: URL;
     method: Request['method'];
     headers: Headers;
@@ -22,7 +23,7 @@ export interface MockedRequest {
     redirect: Request['redirect'];
     referrer: Request['referrer'];
     referrerPolicy: Request['referrerPolicy'];
-    body: Record<string, any> | string | undefined;
+    body: BodyType;
     bodyUsed: Request['bodyUsed'];
     params: RequestParams;
 }
@@ -34,8 +35,8 @@ export declare type RequestParams = {
 };
 export declare type ResponseResolverReturnType<R> = R | undefined | void;
 export declare type AsyncResponseResolverReturnType<R> = Promise<ResponseResolverReturnType<R>> | ResponseResolverReturnType<R>;
-export declare type ResponseResolver<RequestType = MockedRequest, ContextType = typeof defaultContext> = (req: RequestType, res: ResponseComposition, context: ContextType) => AsyncResponseResolverReturnType<MockedResponse>;
-export interface RequestHandler<RequestType = MockedRequest, ContextType = typeof defaultContext, ParsedRequest = any, PublicRequest = RequestType> {
+export declare type ResponseResolver<RequestType = MockedRequest, ContextType = typeof defaultContext, BodyType = any> = (req: RequestType, res: ResponseComposition<BodyType>, context: ContextType) => AsyncResponseResolverReturnType<MockedResponse<BodyType>>;
+export interface RequestHandler<RequestType = MockedRequest, ContextType = typeof defaultContext, ParsedRequest = any, PublicRequest = RequestType, ResponseBodyType = any> {
     /**
      * Parses a captured request to retrieve additional
      * information meant for internal usage in the request handler.
@@ -52,7 +53,7 @@ export interface RequestHandler<RequestType = MockedRequest, ContextType = typeo
     /**
      * Returns a mocked response object to the captured request.
      */
-    resolver: ResponseResolver<RequestType, ContextType>;
+    resolver: ResponseResolver<RequestType, ContextType, ResponseBodyType>;
     /**
      * Returns a map of context utility functions available
      * under the `ctx` argument of request handler.
@@ -62,7 +63,7 @@ export interface RequestHandler<RequestType = MockedRequest, ContextType = typeo
      * Prints out a mocked request/response information
      * upon each request capture into browser's console.
      */
-    log: (req: PublicRequest, res: ResponseWithSerializedHeaders, handler: RequestHandler<RequestType, ContextType>, parsedRequest: ParsedRequest) => void;
+    log: (req: PublicRequest, res: ResponseWithSerializedHeaders, handler: RequestHandler<RequestType, ContextType, ParsedRequest, PublicRequest, ResponseBodyType>, parsedRequest: ParsedRequest) => void;
     /**
      * Describes whether this request handler should be skipped
      * when dealing with any subsequent matching requests.

package/node/utils/handlers/requestHandlerUtils.d.ts

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

package/node/utils/internal/compose.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Composes a given list of functions into a new function that
+ * executes from right to left.
+ */
+export declare function compose(...funcs: Array<(...args: any[]) => any>): (...args: any[]) => any;

package/node/utils/internal/isNodeProcess.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns a boolean indicating if the current process is running in NodeJS environment.
+ * @see https://github.com/mswjs/msw/pull/255
+ */
+export declare function isNodeProcess(): boolean | undefined;

package/node/utils/internal/jsonParse.d.ts

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

package/node/utils/request/getPublicUrlFromRequest.d.ts

@@ -0,0 +1,6 @@
+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/node/utils/request/onUnhandledRequest.d.ts

@@ -0,0 +1,5 @@
+import { MockedRequest } from '../handlers/requestHandler';
+declare type UnhandledRequestCallback = (req: MockedRequest) => void;
+export declare type OnUnhandledRequest = 'bypass' | 'warn' | 'error' | UnhandledRequestCallback;
+export declare function onUnhandledRequest(request: MockedRequest, onUnhandledRequest?: OnUnhandledRequest): void;
+export {};

package/node/utils/request/parseBody.d.ts

@@ -0,0 +1,5 @@
+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): import("../handlers/requestHandler").DefaultRequestBodyType;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "msw",
-  "version": "0.20.5",
-  "description": "Client-side API mocking using Service Workers.",
+  "version": "0.21.3",
+  "description": "Seamless REST/GraphQL API mocking library for browser and Node.",
   "main": "lib/umd/index.js",
   "module": "lib/esm/index.js",
   "types": "lib/types",
@@ -11,13 +11,13 @@
   "scripts": {
     "start": "cross-env NODE_ENV=development rollup -c rollup.config.ts -w",
     "clean": "rimraf lib node/**/*.js",
-    "lint": "eslint '{cli,config,src,test}/**/*.ts'",
+    "lint": "eslint \"{cli,config,src,test}/**/*.ts\"",
     "build": "yarn clean && cross-env NODE_ENV=production rollup -c rollup.config.ts",
     "test": "yarn test:unit && yarn test:integration",
     "test:unit": "cross-env BABEL_ENV=test jest --runInBand",
-    "test:integration": "node --max_old_space_size=8000 node_modules/.bin/jest --config=test/jest.config.js --runInBand",
+    "test:integration": "node --max_old_space_size=8000 node_modules/jest/bin/jest.js --config=test/jest.config.js --runInBand",
     "test:smoke": "config/scripts/smoke.sh",
-    "test:focused": "node_modules/.bin/ts-node --project=test/tsconfig.json test/focusedTest.ts",
+    "test:focused": "node node_modules/ts-node/dist/bin.js --project=test/tsconfig.json test/focusedTest.ts",
     "prepublishOnly": "yarn lint && yarn test:unit && yarn build && yarn test:integration"
   },
   "husky": {
@@ -64,52 +64,57 @@
     "@open-draft/until": "^1.0.3",
     "@types/cookie": "^0.4.0",
     "chalk": "^4.1.0",
+    "chokidar": "^3.4.2",
     "cookie": "^0.4.1",
     "graphql": "^15.3.0",
     "headers-utils": "^1.2.0",
-    "node-fetch": "^2.6.0",
+    "node-fetch": "^2.6.1",
     "node-match-path": "^0.4.4",
-    "node-request-interceptor": "^0.3.5",
+    "node-request-interceptor": "^0.5.1",
     "statuses": "^2.0.0",
-    "yargs": "^15.4.1"
+    "yargs": "^16.0.3"
   },
   "devDependencies": {
-    "@babel/core": "^7.10.5",
-    "@babel/preset-env": "^7.10.4",
-    "@rollup/plugin-commonjs": "^14.0.0",
+    "@babel/core": "^7.11.6",
+    "@babel/preset-env": "^7.11.5",
+    "@rollup/plugin-commonjs": "^15.0.0",
     "@rollup/plugin-inject": "^4.0.2",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^8.4.0",
+    "@rollup/plugin-node-resolve": "^9.0.0",
     "@rollup/plugin-replace": "^2.3.3",
-    "@types/jest": "^26.0.7",
-    "@types/node": "^14.0.27",
+    "@types/express": "^4.17.8",
+    "@types/fs-extra": "^9.0.1",
+    "@types/jest": "^26.0.13",
+    "@types/node": "^14.6.4",
     "@types/node-fetch": "^2.5.7",
-    "@types/puppeteer": "^3.0.1",
+    "@types/puppeteer": "^3.0.2",
     "@types/webpack-dev-server": "^3.11.0",
-    "@typescript-eslint/eslint-plugin": "^3.7.1",
-    "@typescript-eslint/parser": "^3.7.1",
+    "@typescript-eslint/eslint-plugin": "^4.1.0",
+    "@typescript-eslint/parser": "^4.1.0",
     "apollo-fetch": "^0.7.0",
     "babel-loader": "^8.1.0",
     "babel-minify": "^0.5.1",
     "cross-env": "^7.0.0",
-    "eslint": "^7.5.0",
+    "eslint": "^7.8.1",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.4",
-    "html-webpack-plugin": "^4.3.0",
-    "husky": "^4.2.5",
+    "express": "^4.17.1",
+    "fs-extra": "^9.0.1",
+    "html-webpack-plugin": "^4.4.1",
+    "husky": "^4.3.0",
     "ignore-loader": "^0.1.2",
-    "jest": "^26.1.0",
-    "lint-staged": "^10.2.11",
-    "prettier": "^2.0.5",
+    "jest": "^26.4.2",
+    "lint-staged": "^10.3.0",
+    "prettier": "^2.1.1",
     "puppeteer": "^5.2.1",
     "regenerator-runtime": "^0.13.7",
     "rimraf": "^3.0.2",
-    "rollup": "^2.23.0",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "ts-jest": "^26.1.4",
-    "ts-loader": "^8.0.1",
-    "ts-node": "^8.10.2",
-    "typescript": "^3.9.7",
+    "rollup": "^2.26.11",
+    "rollup-plugin-typescript2": "^0.27.2",
+    "ts-jest": "^26.3.0",
+    "ts-loader": "^8.0.3",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.2",
     "url-loader": "^4.1.0",
     "webpack": "^4.44.1",
     "webpack-cli": "^3.3.12",

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

@@ -1,5 +0,0 @@
-/**
- * Returns a parsed JSON from a given valid body string,
- * otherwise returns a given body string as-is.
- */
-export declare function getJsonBody(body: string): string | Record<string, any>;

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

@@ -1,2 +0,0 @@
-import { MockedRequest } from '../../handlers/requestHandler';
-export declare function parseRequestBody(body?: MockedRequest['body'], headers?: MockedRequest['headers']): string | Record<string, any> | undefined;

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

@@ -1,6 +0,0 @@
-import { Mask } from '../setupWorker/glossary';
-/**
- * Converts a given request handler mask into a URL, if given a valid URL string.
- * Otherwise, returns the mask as-is.
- */
-export declare function resolveMask(mask: Mask): URL | RegExp | string;

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

@@ -1,6 +0,0 @@
-import { Mask } from '../setupWorker/glossary';
-/**
- * Resolves a relative URL to the absolute URL with the same hostname.
- * Ignores regular expressions.
- */
-export declare const resolveRelativeUrl: <T extends Mask>(mask: T) => T;