msw 0.21.3 → 0.22.3

package/lib/esm/index.js

@@ -1,26 +1,26 @@
-import { c as createCommonjsModule, s as status, a as set, d as delay, f as fetch, l as lib$1, i as isNodeProcess } from './fetch-deps.js';
+import { c as createCommonjsModule, s as status, a as set, d as delay, f as fetch, l as lib$1, m as mergeRight, i as isNodeProcess } from './fetch-deps.js';
 import { p as parse_1 } from './xml-deps.js';
 import './errors-deps.js';
 export { i as context } from './index-deps.js';
 import { g as getPublicUrlFromRequest, i as isStringEqual } from './rest-deps.js';
 export { R as RESTMethods, r as rest, a as restContext } from './rest-deps.js';
-import { p as parseBody } from './matchRequestUrl-deps.js';
-export { m as matchRequestUrl } from './matchRequestUrl-deps.js';
+import { p as parseBody } from './getCallFrame-deps.js';
+export { m as matchRequestUrl } from './getCallFrame-deps.js';
 export { graphql, graphqlContext } from './graphql.js';
 
 /*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
 ***************************************************************************** */
 
 function __awaiter(thisArg, _arguments, P, generator) {
@@ -201,6 +201,17 @@ class NetworkError extends Error {
     }
 }
 
+/**
+ * Internal response transformer to ensure response JSON body
+ * is always stringified.
+ */
+const stringifyJsonBody = (res) => {
+    var _a, _b;
+    if (res.body && ((_b = (_a = res.headers) === null || _a === void 0 ? void 0 : _a.get('content-type')) === null || _b === void 0 ? void 0 : _b.endsWith('json'))) {
+        res.body = JSON.stringify(res.body);
+    }
+    return res;
+};
 const defaultResponse = {
     status: 200,
     statusText: 'OK',
@@ -208,16 +219,23 @@ const defaultResponse = {
     delay: 0,
     once: false,
 };
-function createResponseComposition(overrides = {}) {
+const defaultResponseTransformers = [
+    stringifyJsonBody,
+];
+function createResponseComposition(responseOverrides, defaultTransformers = defaultResponseTransformers) {
     return (...transformers) => {
-        const resolvedResponse = Object.assign({}, defaultResponse, {
+        const initialResponse = Object.assign({}, defaultResponse, {
             headers: new lib$1.Headers({
                 'x-powered-by': 'msw',
             }),
-        }, overrides);
-        if (transformers.length > 0) {
-            return compose(...transformers)(resolvedResponse);
-        }
+        }, responseOverrides);
+        const resolvedTransformers = [
+            ...defaultTransformers,
+            ...transformers,
+        ].filter(Boolean);
+        const resolvedResponse = resolvedTransformers.length > 0
+            ? compose(...resolvedTransformers)(initialResponse)
+            : initialResponse;
         return resolvedResponse;
     };
 }
@@ -304,9 +322,9 @@ const getResponse = (req, handlers) => __awaiter(void 0, void 0, void 0, functio
     };
 });
 
-function onUnhandledRequest(request, onUnhandledRequest = 'bypass') {
-    if (typeof onUnhandledRequest === 'function') {
-        onUnhandledRequest(request);
+function onUnhandledRequest(request, handler = 'bypass') {
+    if (typeof handler === 'function') {
+        handler(request);
         return;
     }
     const publicUrl = getPublicUrlFromRequest(request);
@@ -317,7 +335,7 @@ function onUnhandledRequest(request, onUnhandledRequest = 'bypass') {
   rest.${request.method.toLowerCase()}('${publicUrl}', (req, res, ctx) => {
     return res(ctx.text('body'))
   })`;
-    switch (onUnhandledRequest) {
+    switch (handler) {
         case 'error': {
             throw new Error(`[MSW] Error: ${message}`);
         }
@@ -446,8 +464,8 @@ function requestIntegrityCheck(context, serviceWorker) {
         const { payload: actualChecksum } = yield context.events.once('INTEGRITY_CHECK_RESPONSE');
         // Compare the response from the Service Worker and the
         // global variable set by webpack upon build.
-        if (actualChecksum !== "d1e0e502f550d40a34bee90822e4bf98") {
-            throw new Error(`Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"d1e0e502f550d40a34bee90822e4bf98"}).`);
+        if (actualChecksum !== "65d33ca82955e1c5928aed19d1bdf3f9") {
+            throw new Error(`Currently active Service Worker (${actualChecksum}) is behind the latest published one (${"65d33ca82955e1c5928aed19d1bdf3f9"}).`);
         }
         return serviceWorker;
     });
@@ -478,30 +496,6 @@ function deferNetworkRequestsUntil(predicatePromise) {
     });
 }
 
-function isObject(obj) {
-    return typeof obj === 'object';
-}
-/**
- * Deeply merges two given objects with the right one
- * having a priority during property assignment.
- */
-function mergeRight(a, b) {
-    const result = Object.assign({}, a);
-    Object.entries(b).forEach(([key, value]) => {
-        const existingValue = result[key];
-        if (Array.isArray(existingValue) && Array.isArray(value)) {
-            result[key] = existingValue.concat(value);
-            return;
-        }
-        if (isObject(existingValue) && isObject(value)) {
-            result[key] = mergeRight(existingValue, value);
-            return;
-        }
-        result[key] = value;
-    });
-    return result;
-}
-
 const DEFAULT_START_OPTIONS = {
     serviceWorker: {
         url: '/mockServiceWorker.js',
@@ -691,7 +685,19 @@ function setupWorker(...requestHandlers) {
         resetHandlers(...nextHandlers) {
             context.requestHandlers = resetHandlers(requestHandlers, ...nextHandlers);
         },
+        printHandlers() {
+            context.requestHandlers.forEach((handler) => {
+                const meta = handler.getMetaInfo();
+                console.groupCollapsed(meta.header);
+                console.log(`Declaration: ${meta.callFrame}`);
+                console.log('Resolver: %s', handler.resolver);
+                if (['rest'].includes(meta.type)) {
+                    console.log('Match:', `https://mswjs.io/repl?path=${meta.mask}`);
+                }
+                console.groupEnd();
+            });
+        },
     };
 }
 
-export { defaultContext, response, setupWorker };
+export { createResponseComposition, defaultContext, defaultResponse, response, setupWorker };

package/lib/esm/mockServiceWorker.js

@@ -7,7 +7,7 @@
 /* eslint-disable */
 /* tslint:disable */
 
-const INTEGRITY_CHECKSUM = 'd1e0e502f550d40a34bee90822e4bf98'
+const INTEGRITY_CHECKSUM = '65d33ca82955e1c5928aed19d1bdf3f9'
 const bypassHeaderName = 'x-msw-bypass'
 
 let clients = {}
@@ -74,11 +74,22 @@ self.addEventListener('message', async function (event) {
   }
 })
 
-self.addEventListener('fetch', async function (event) {
+self.addEventListener('fetch', function (event) {
   const { clientId, request } = event
   const requestClone = request.clone()
   const getOriginalResponse = () => fetch(requestClone)
 
+  // Bypass navigation requests.
+  if (request.mode === 'navigate') {
+    return
+  }
+
+  // Bypass mocking if the current client isn't present in the internal clients map
+  // (i.e. has the mocking disabled).
+  if (!clients[clientId]) {
+    return
+  }
+
   // Opening the DevTools triggers the "only-if-cached" request
   // that cannot be handled by the worker. Bypass such requests.
   if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
@@ -89,20 +100,15 @@ self.addEventListener('fetch', async function (event) {
     new Promise(async (resolve, reject) => {
       const client = await event.target.clients.get(clientId)
 
-      if (
-        // Bypass mocking when no clients active
-        !client ||
-        // Bypass mocking if the current client has mocking disabled
-        !clients[clientId] ||
-        // Bypass mocking for navigation requests
-        request.mode === 'navigate'
-      ) {
+      // Bypass mocking when the request client is not active.
+      if (!client) {
         return resolve(getOriginalResponse())
       }
 
       // Bypass requests with the explicit bypass header
       if (requestClone.headers.get(bypassHeaderName) === 'true') {
         const modifiedHeaders = serializeHeaders(requestClone.headers)
+
         // Remove the bypass header to comply with the CORS preflight check
         delete modifiedHeaders[bypassHeaderName]
 

package/lib/esm/rest-deps.js

@@ -1,6 +1,6 @@
 import { c as createCommonjsModule, b as commonjsGlobal, a as set, s as status, j as json, d as delay, f as fetch } from './fetch-deps.js';
 import { c as cookie, b as body, t as text, x as xml } from './xml-deps.js';
-import { g as getUrlByMask, m as matchRequestUrl, a as prepareRequest, b as prepareResponse, c as getTimestamp, d as getStatusCodeColor } from './matchRequestUrl-deps.js';
+import { g as getUrlByMask, a as getCallFrame, m as matchRequestUrl, b as prepareRequest, c as prepareResponse, d as getTimestamp, e as getStatusCodeColor } from './getCallFrame-deps.js';
 
 var punycode = createCommonjsModule(function (module, exports) {
 (function(root) {
@@ -1388,6 +1388,7 @@ const restContext = {
 const createRestHandler = (method) => {
     return (mask, resolver) => {
         const resolvedMask = getUrlByMask(mask);
+        const callFrame = getCallFrame();
         return {
             parse(req) {
                 // Match the request during parsing to prevent matching it twice
@@ -1438,6 +1439,14 @@ ${queryParams
                 console.log('Response', loggedResponse);
                 console.groupEnd();
             },
+            getMetaInfo() {
+                return {
+                    type: 'rest',
+                    header: `[rest] ${method} ${mask.toString()}`,
+                    mask,
+                    callFrame,
+                };
+            },
         };
     };
 };

package/lib/esm/rest.js

@@ -1,4 +1,4 @@
 import './fetch-deps.js';
 import './xml-deps.js';
 export { R as RESTMethods, r as rest, a as restContext } from './rest-deps.js';
-import './matchRequestUrl-deps.js';
+import './getCallFrame-deps.js';

package/lib/types/context/errors.d.ts

@@ -1,8 +1,8 @@
 import { GraphQLError } from 'graphql';
 import { ResponseTransformer } from '../response';
 /**
- * Returns a list of GraphQL errors.
+ * Sets a given list of GraphQL errors on the mocked response.
  */
-export declare const errors: (errorsList: Partial<GraphQLError>[]) => ResponseTransformer<{
-    errors: Partial<GraphQLError>[];
+export declare const errors: <ErrorsType extends Partial<GraphQLError>[] | null | undefined>(errorsList: ErrorsType) => ResponseTransformer<{
+    errors: ErrorsType;
 }>;

package/lib/types/context/json.d.ts

@@ -1,4 +1,7 @@
 import { ResponseTransformer } from '../response';
+declare type JSONContextOptions = {
+    merge?: boolean;
+};
 /**
  * Sets the given value as the JSON body of the response.
  * @example
@@ -6,4 +9,5 @@ import { ResponseTransformer } from '../response';
  * res(json('Some string'))
  * res(json([1, '2', false, { ok: true }]))
  */
-export declare const json: <BodyType>(body: BodyType) => ResponseTransformer<BodyType>;
+export declare const json: <BodyTypeJSON>(body: BodyTypeJSON, { merge }?: JSONContextOptions) => ResponseTransformer<BodyTypeJSON>;
+export {};

package/lib/types/index.d.ts

@@ -1,8 +1,9 @@
 import * as context from './context';
 export { setupWorker } from './setupWorker/setupWorker';
-export { MockedResponse, ResponseTransformer, response } from './response';
+export { SetupWorkerApi } from './setupWorker/glossary';
+export { response, defaultResponse, createResponseComposition, MockedResponse, ResponseTransformer, ResponseComposition, ResponseCompositionOptions, ResponseFunction, } from './response';
 export { context };
-export { MockedRequest, RequestHandler, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, defaultContext, } from './utils/handlers/requestHandler';
+export { defaultContext, MockedRequest, RequestHandler, RequestHandlerMetaInfo, RequestParams, RequestQuery, ResponseResolver, ResponseResolverReturnType, AsyncResponseResolverReturnType, } from './utils/handlers/requestHandler';
 export { rest, restContext, RESTMethods, ParsedRestRequest } from './rest';
 export { graphql, graphqlContext, GraphQLMockedRequest, GraphQLMockedContext, GraphQLRequestPayload, GraphQLResponseResolver, GraphQLRequestParsedResult, } from './graphql';
 export { matchRequestUrl } from './utils/matching/matchRequestUrl';

package/lib/types/native/index.d.ts

@@ -1,7 +1 @@
-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;
-};
+export declare const setupServer: (...requestHandlers: import("../setupWorker/glossary").RequestHandlersList) => import("../node").SetupServerApi;

package/lib/types/node/createSetupServer.d.ts

@@ -1,29 +1,8 @@
 import { Interceptor } from 'node-request-interceptor';
 import { RequestHandlersList } from '../setupWorker/glossary';
-import { SharedOptions } from '../sharedOptions';
+import { SetupServerApi } from './glossary';
 /**
  * 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;
-};
+export declare function createSetupServer(...interceptors: Interceptor[]): (...requestHandlers: RequestHandlersList) => SetupServerApi;

package/{node/node/createSetupServer.d.ts → lib/types/node/glossary.d.ts}

@@ -1,29 +1,28 @@
-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) => {
+import { RequestHandlersList } from '../setupWorker/glossary';
+export interface SetupServerApi {
     /**
      * Enables requests interception based on the previously provided mock definition.
      */
-    listen(options?: SharedOptions | undefined): void;
+    listen: (options?: SharedOptions) => void;
     /**
      * Prepends given request handlers to the list of existing handlers.
      */
-    use(...handlers: RequestHandlersList): void;
+    use: (...handlers: RequestHandlersList) => void;
     /**
      * Marks all request handlers that respond using `res.once()` as unused.
      */
-    restoreHandlers(): void;
+    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;
+    resetHandlers: (...nextHandlers: RequestHandlersList) => void;
+    /**
+     * Lists all active request handlers.
+     */
+    printHandlers: () => void;
     /**
      * Stops requests interception by restoring all augmented modules.
      */
-    close(): void;
-};
+    close: () => void;
+}

package/lib/types/node/index.d.ts

@@ -1 +1,2 @@
 export { setupServer } from './setupServer';
+export { SetupServerApi } from './glossary';

package/lib/types/node/setupServer.d.ts

@@ -1,7 +1 @@
-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;
-};
+export declare const setupServer: (...requestHandlers: import("../setupWorker/glossary").RequestHandlersList) => import("./glossary").SetupServerApi;

package/lib/types/response.d.ts

@@ -8,7 +8,7 @@ export interface MockedResponse<BodyType = any> {
     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 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.
@@ -18,8 +18,13 @@ export declare type ResponseComposition<BodyType = any> = ResponseFunction<BodyT
     networkError: (message: string) => void;
 };
 export declare const defaultResponse: Omit<MockedResponse, 'headers'>;
+export declare type ResponseCompositionOptions<BodyType> = {
+    defaultTransformers?: ResponseTransformer<BodyType>[];
+    mockedResponseOverrides?: Partial<MockedResponse>;
+};
+export declare const defaultResponseTransformers: ResponseTransformer<any>[];
+export declare function createResponseComposition<BodyType>(responseOverrides?: Partial<MockedResponse<BodyType>>, defaultTransformers?: ResponseTransformer<BodyType>[]): ResponseFunction;
 export declare const response: ResponseFunction<any> & {
     once: ResponseFunction<any>;
     networkError(message: string): never;
 };
-export {};