msw 2.15.0 → 3.0.0

package/src/{core/handlers/HttpHandler.ts → http/http-handler.ts}

@@ -1,25 +1,25 @@
-import { type ResponseResolutionContext } from '../utils/executeHandlers'
-import { devUtils } from '../utils/internal/devUtils'
-import { isStringEqual } from '../utils/internal/isStringEqual'
-import { getStatusCodeColor } from '../utils/logging/getStatusCodeColor'
-import { getTimestamp } from '../utils/logging/getTimestamp'
-import { serializeRequest } from '../utils/logging/serializeRequest'
-import { serializeResponse } from '../utils/logging/serializeResponse'
+import type { ResponseResolutionContext } from '#core/utils/execute-handlers'
+import { devUtils } from '#core/utils/internal/dev-utils'
+import { isStringEqual } from '#core/utils/internal/is-string-equal'
+import { getStatusCodeColor } from '#core/utils/logging/get-status-code-color'
+import { getTimestamp } from '#core/utils/logging/get-timestamp'
+import { serializeRequest } from '#core/utils/logging/serialize-request'
+import { serializeResponse } from '#core/utils/logging/serialize-response'
 import {
   matchRequestUrl,
   type Match,
   type Path,
   type PathParams,
-} from '../utils/matching/matchRequestUrl'
-import { toPublicUrl } from '../utils/request/toPublicUrl'
-import { getAllRequestCookies } from '../utils/request/getRequestCookies'
-import { cleanUrl } from '../utils/url/cleanUrl'
+} from '#core/utils/matching/match-request-url'
+import { toPublicUrl } from '#core/utils/request/to-public-url'
+import { getAllRequestCookies } from '#core/utils/request/get-request-cookies'
+import { getCleanUrlString } from '#utils/get-clean-url-string'
 import {
   RequestHandler,
   type RequestHandlerDefaultInfo,
   type RequestHandlerOptions,
   type ResponseResolver,
-} from './RequestHandler'
+} from '#core/handlers/request-handler'
 
 export type HttpHandlerMethod = string | RegExp
 
@@ -56,10 +56,9 @@ export type HttpCustomPredicate<Params extends PathParams> = (args: {
   request: Request
   cookies: Record<string, string>
 }) =>
-  | HttpCustomPredicateResult<Params>
-  | Promise<HttpCustomPredicateResult<Params>>
+  HttpCustomPredicateResult<Params> | Promise<HttpCustomPredicateResult<Params>>
 
-export type HttpCustomPredicateResult<Params extends PathParams> =
+type HttpCustomPredicateResult<Params extends PathParams> =
   | boolean
   | {
       matches: boolean
@@ -67,8 +66,7 @@ export type HttpCustomPredicateResult<Params extends PathParams> =
     }
 
 export type HttpRequestPredicate<Params extends PathParams> =
-  | Path
-  | HttpCustomPredicate<Params>
+  Path | HttpCustomPredicate<Params>
 
 /**
  * Request handler for HTTP requests.
@@ -108,7 +106,7 @@ export class HttpHandler extends RequestHandler<
       return
     }
 
-    const url = cleanUrl(path)
+    const url = getCleanUrlString(path)
 
     // Bypass request handler URLs that have no redundant characters.
     if (url === path) {

package/src/{core/HttpResponse.test.ts → http/http-response.test.ts}

@@ -1,10 +1,8 @@
-/**
- * @vitest-environment node
- */
+// @vitest-environment node
 import { TextEncoder } from 'util'
-import { HttpResponse, kDefaultContentType } from './HttpResponse'
+import { HttpResponse, kDefaultContentType } from './http-response'
 
-it('creates a plain response', async () => {
+test('creates a plain response', async () => {
   const response = new HttpResponse(null, { status: 301 })
   expect(response.status).toBe(301)
   expect(response.statusText).toBe('Moved Permanently')
@@ -13,12 +11,12 @@ it('creates a plain response', async () => {
   expect(Object.fromEntries(response.headers.entries())).toEqual({})
 })
 
-it('supports non-configurable status codes', () => {
+test('supports non-configurable status codes', () => {
   expect(new HttpResponse(null, { status: 101 })).toHaveProperty('status', 101)
 })
 
 describe('HttpResponse.text()', () => {
-  it('creates a text response', async () => {
+  test('creates a text response', async () => {
     const response = HttpResponse.text('hello world', { status: 201 })
 
     expect(response.status).toBe(201)
@@ -32,7 +30,7 @@ describe('HttpResponse.text()', () => {
     expect(kDefaultContentType in response).toBe(true)
   })
 
-  it('creates a text response with special characters', async () => {
+  test('creates a text response with special characters', async () => {
     const response = HttpResponse.text('안녕 세상', { status: 201 })
 
     expect(response.status).toBe(201)
@@ -45,7 +43,7 @@ describe('HttpResponse.text()', () => {
     })
   })
 
-  it('allows overriding the "Content-Type" response header', async () => {
+  test('allows overriding the "Content-Type" response header', async () => {
     const response = HttpResponse.text('hello world', {
       headers: { 'Content-Type': 'text/plain; charset=utf-8' },
     })
@@ -61,7 +59,7 @@ describe('HttpResponse.text()', () => {
     expect(kDefaultContentType in response).toBe(false)
   })
 
-  it('allows overriding the "Content-Length" response header', async () => {
+  test('allows overriding the "Content-Length" response header', async () => {
     const response = HttpResponse.text('hello world', {
       headers: { 'Content-Length': '32' },
     })
@@ -74,7 +72,7 @@ describe('HttpResponse.text()', () => {
 })
 
 describe('HttpResponse.json()', () => {
-  it('creates a json response given an object', async () => {
+  test('creates a json response given an object', async () => {
     const response = HttpResponse.json({ firstName: 'John' })
 
     expect(response.status).toBe(200)
@@ -88,7 +86,7 @@ describe('HttpResponse.json()', () => {
     expect(kDefaultContentType in response).toBe(true)
   })
 
-  it('creates a json response given an object with special characters', async () => {
+  test('creates a json response given an object with special characters', async () => {
     const response = HttpResponse.json({ firstName: '제로' })
 
     expect(response.status).toBe(200)
@@ -101,7 +99,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('creates a json response given an array', async () => {
+  test('creates a json response given an array', async () => {
     const response = HttpResponse.json([1, 2, 3])
 
     expect(response.status).toBe(200)
@@ -114,7 +112,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('creates a json response given a plain string', async () => {
+  test('creates a json response given a plain string', async () => {
     const response = HttpResponse.json(`"hello"`)
 
     expect(response.status).toBe(200)
@@ -127,7 +125,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('creates a json response given a number', async () => {
+  test('creates a json response given a number', async () => {
     const response = HttpResponse.json(123)
 
     expect(response.status).toBe(200)
@@ -140,7 +138,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('creates a json response given a json ReadableStream', async () => {
+  test('creates a json response given a json ReadableStream', async () => {
     const encoder = new TextEncoder()
     const stream = new ReadableStream({
       start(controller) {
@@ -165,7 +163,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('allows overriding the "Content-Type" response header', async () => {
+  test('allows overriding the "Content-Type" response header', async () => {
     const response = HttpResponse.json(
       { a: 1 },
       {
@@ -186,7 +184,7 @@ describe('HttpResponse.json()', () => {
     })
   })
 
-  it('allows overriding the "Content-Length" response header', async () => {
+  test('allows overriding the "Content-Length" response header', async () => {
     const response = HttpResponse.json(
       { a: 1 },
       {
@@ -202,7 +200,7 @@ describe('HttpResponse.json()', () => {
 })
 
 describe('HttpResponse.xml()', () => {
-  it('creates an xml response', async () => {
+  test('creates an xml response', async () => {
     const response = HttpResponse.xml('<user name="John" />')
 
     expect(kDefaultContentType in response).toBe(true)
@@ -216,7 +214,7 @@ describe('HttpResponse.xml()', () => {
     expect(kDefaultContentType in response).toBe(true)
   })
 
-  it('allows overriding the "Content-Type" response header', async () => {
+  test('allows overriding the "Content-Type" response header', async () => {
     const response = HttpResponse.xml('<user name="John" />', {
       headers: {
         'Content-Type': 'text/xml; charset=utf-8',
@@ -235,7 +233,7 @@ describe('HttpResponse.xml()', () => {
 })
 
 describe('HttpResponse.html()', () => {
-  it('creates an html response', async () => {
+  test('creates an html response', async () => {
     const response = HttpResponse.html('<p class="author">Jane Doe</p>')
 
     expect(response.status).toBe(200)
@@ -250,7 +248,7 @@ describe('HttpResponse.html()', () => {
     expect(kDefaultContentType in response).toBe(true)
   })
 
-  it('allows overriding the "Content-Type" response header', async () => {
+  test('allows overriding the "Content-Type" response header', async () => {
     const response = HttpResponse.html('<p class="author">Jane Doe</p>', {
       headers: {
         'Content-Type': 'text/html; charset=utf-8',
@@ -271,7 +269,7 @@ describe('HttpResponse.html()', () => {
 })
 
 describe('HttpResponse.arrayBuffer()', () => {
-  it('creates an array buffer response', async () => {
+  test('creates an array buffer response', async () => {
     const buffer = new TextEncoder().encode('hello world')
     const response = HttpResponse.arrayBuffer(buffer)
 
@@ -288,7 +286,7 @@ describe('HttpResponse.arrayBuffer()', () => {
     expect(kDefaultContentType in response).toBe(true)
   })
 
-  it('allows overriding the "Content-Type" response header', async () => {
+  test('allows overriding the "Content-Type" response header', async () => {
     const buffer = new TextEncoder().encode('hello world')
     const response = HttpResponse.arrayBuffer(buffer, {
       headers: {
@@ -309,7 +307,7 @@ describe('HttpResponse.arrayBuffer()', () => {
     expect(kDefaultContentType in response).toBe(false)
   })
 
-  it('creates an array buffer response from a shared array buffer', async () => {
+  test('creates an array buffer response from a shared array buffer', async () => {
     const arrayBuffer = new TextEncoder().encode('hello world')
 
     // Copy the data from the array buffer to a shared array buffer
@@ -331,7 +329,7 @@ describe('HttpResponse.arrayBuffer()', () => {
     })
   })
 
-  it('allows overriding the "Content-Type" response header for shared array buffers', async () => {
+  test('allows overriding the "Content-Type" response header for shared array buffers', async () => {
     const arrayBuffer = new TextEncoder().encode('hello world')
 
     // Copy the data from the array buffer to a shared array buffer
@@ -359,7 +357,7 @@ describe('HttpResponse.arrayBuffer()', () => {
   })
 })
 
-it('creates a form data response', async () => {
+test('creates a form data response', async () => {
   const formData = new FormData()
   formData.append('firstName', 'John')
   const response = HttpResponse.formData(formData)

package/src/{core/HttpResponse.ts → http/http-response.ts}

@@ -1,16 +1,21 @@
 import { FetchResponse } from '@mswjs/interceptors'
-import type { DefaultBodyType, JsonBodyType } from './handlers/RequestHandler'
-import type { NoInfer } from './typeUtils'
+import type {
+  DefaultBodyType,
+  JsonBodyType,
+} from '#core/handlers/request-handler'
+import type { TransparentNoInfer } from '#core/type-utils'
 import {
   decorateResponse,
   normalizeResponseInit,
-} from './utils/HttpResponse/decorators'
+} from '#core/utils/response-decorators'
+import { kDefaultContentType, bodyType } from './symbols'
+
+export { kDefaultContentType }
 
 export interface HttpResponseInit extends ResponseInit {
   type?: ResponseType
 }
 
-export const bodyType: unique symbol = Symbol('bodyType')
 export type DefaultUnsafeFetchResponse = Response & {
   [bodyType]?: never
 }
@@ -20,16 +25,6 @@ export interface StrictRequest<BodyType extends JsonBodyType> extends Request {
   clone(): StrictRequest<BodyType>
 }
 
-/**
- * Opaque `Response` type that supports strict body type.
- *
- * @deprecated Please use {@link HttpResponse} instead.
- */
-export type StrictResponse<BodyType extends DefaultBodyType> =
-  HttpResponse<BodyType>
-
-export const kDefaultContentType = Symbol.for('kDefaultContentType')
-
 /**
  * A drop-in replacement for the standard `Response` class
  * to allow additional features, like mocking the response `Set-Cookie` header.
@@ -46,7 +41,10 @@ export class HttpResponse<
 > extends FetchResponse {
   readonly [bodyType]: BodyType = null as any
 
-  constructor(body?: NoInfer<BodyType> | null, init?: HttpResponseInit) {
+  constructor(
+    body?: TransparentNoInfer<BodyType> | null,
+    init?: HttpResponseInit,
+  ) {
     const responseInit = normalizeResponseInit(init)
     super(body as BodyInit, responseInit)
     decorateResponse(this, responseInit)
@@ -63,7 +61,7 @@ export class HttpResponse<
    * HttpResponse.text('Error', { status: 500 })
    */
   static text<BodyType extends string>(
-    body?: NoInfer<BodyType> | null,
+    body?: TransparentNoInfer<BodyType> | null,
     init?: HttpResponseInit,
   ): HttpResponse<BodyType> {
     const responseInit = normalizeResponseInit(init)
@@ -102,7 +100,7 @@ export class HttpResponse<
    * HttpResponse.json({ error: 'Not Authorized' }, { status: 401 })
    */
   static json<BodyType extends JsonBodyType>(
-    body?: NoInfer<BodyType> | null | undefined,
+    body?: TransparentNoInfer<BodyType> | null | undefined,
     init?: HttpResponseInit,
   ): HttpResponse<BodyType> {
     const responseInit = normalizeResponseInit(init)

package/src/{core → http}/http.ts

@@ -1,15 +1,15 @@
-import {
-  type DefaultBodyType,
-  type RequestHandlerOptions,
-  type ResponseResolver,
-} from './handlers/RequestHandler'
+import type {
+  DefaultBodyType,
+  RequestHandlerOptions,
+  ResponseResolver,
+} from '#core/handlers/request-handler'
 import {
   HttpMethods,
   HttpHandler,
   type HttpRequestResolverExtras,
   type HttpRequestPredicate,
-} from './handlers/HttpHandler'
-import type { PathParams } from './utils/matching/matchRequestUrl'
+} from './http-handler'
+import type { PathParams } from '#core/utils/matching/match-request-url'
 
 export type HttpRequestHandler = <
   Params extends PathParams<keyof Params> = PathParams,

package/src/http/index.test.ts

@@ -0,0 +1,19 @@
+import { http, HttpHandler, HttpResponse } from './index'
+
+test('exposes the http request handler namespace', () => {
+  expect(Object.keys(http)).toEqual([
+    'all',
+    'head',
+    'get',
+    'post',
+    'put',
+    'delete',
+    'patch',
+    'options',
+  ])
+})
+
+test('exposes the HttpHandler and HttpResponse classes', () => {
+  expect(http.get('/resource', () => {})).toBeInstanceOf(HttpHandler)
+  expect(HttpResponse.json({})).toBeInstanceOf(Response)
+})

package/src/http/index.ts

@@ -0,0 +1,22 @@
+export {
+  http,
+  type HttpRequestHandler,
+  type HttpResponseResolver,
+} from './http'
+
+export {
+  HttpHandler,
+  HttpMethods,
+  type RequestQuery,
+  type HttpRequestParsedResult,
+  type HttpHandlerInfo,
+  type HttpRequestResolverExtras,
+  type HttpHandlerMethod,
+  type HttpCustomPredicate,
+} from './http-handler'
+
+export {
+  HttpResponse,
+  type HttpResponseInit,
+  type StrictRequest,
+} from './http-response'

package/src/http/symbols.ts

@@ -0,0 +1,19 @@
+/**
+ * Symbols of the `msw/http` module.
+ *
+ * @note A standalone module so consumers interested only in a symbol
+ * (e.g. `msw/graphql`) don't pull the modules that use it into
+ * their graph.
+ */
+
+/**
+ * Marks a response whose `Content-Type` header was inferred by the
+ * library instead of being set explicitly by the developer.
+ */
+export const kDefaultContentType = Symbol.for('kDefaultContentType')
+
+/**
+ * Associates the mocked response body type with the response instance
+ * for stricter typing of the response resolvers.
+ */
+export const bodyType: unique symbol = Symbol('bodyType')

package/src/iife/index.ts

@@ -1,2 +1,4 @@
 export * from '#core'
 export * from '../browser'
+export * from '../graphql'
+export * from '../ws'