api-def 0.14.3 → 0.15.0-alpha.1

package/cjs/ApiConstants.d.ts

@@ -29,5 +29,6 @@ export declare const ResponseType: {
     readonly TEXT: "text";
     readonly ARRAY_BUFFER: "arraybuffer";
     readonly STREAM: "stream";
+    readonly WEBSOCKET: "websocket";
 };
 export type ResponseType = EnumOf<typeof ResponseType>;

package/cjs/ApiConstants.js

@@ -27,4 +27,5 @@ exports.ResponseType = {
     TEXT: "text",
     ARRAY_BUFFER: "arraybuffer",
     STREAM: "stream",
+    WEBSOCKET: "websocket",
 };

package/cjs/EndpointBuilder.d.ts

@@ -4,7 +4,7 @@ import type { ResponseType } from "./ApiConstants";
 import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes";
 import Endpoint, { type EndpointOptions } from "./Endpoint";
 import type { BodyValidationOptions, ValidationOptions } from "./Validation";
-type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : "stream" extends T ? AsyncIterable<Uint8Array> : unknown;
+type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : T extends "stream" ? AsyncIterable<Uint8Array> : T extends "websocket" ? WebSocket : unknown;
 export type EndpointBuildOptions<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined, TPath extends string = string, TResponseType extends ResponseType | undefined = undefined> = Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
     responseType?: TResponseType;
 };

package/cjs/Requester.js

@@ -112,7 +112,8 @@ const makeRequest = async (context) => {
             context.addCanceller(canceler);
             const response = await promise;
             const parsedResponse = (await parseResponse(context, response));
-            if (!(0, ApiUtils_1.isAcceptableStatus)(parsedResponse.status, context.requestConfig.acceptableStatus)) {
+            if (!(context.responseType === "websocket" && parsedResponse.status === 101) &&
+                !(0, ApiUtils_1.isAcceptableStatus)(parsedResponse.status, context.requestConfig.acceptableStatus)) {
                 throw (0, RequestError_1.convertToRequestError)({
                     error: new Error(`[api-def] Invalid response status code '${parsedResponse.status}'`),
                     response: parsedResponse,

package/cjs/backend/AxiosRequestBackend.d.ts

@@ -3,12 +3,16 @@ import type { ApiResponse } from "../ApiTypes";
 import type RequestContext from "../RequestContext";
 import type RequestBackend from "./RequestBackend";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
+import { type WebSocketConstructor, type WebSocketResponse } from "./WebSocketRequest";
 export declare const isAxiosError: (error: Error) => error is AxiosError;
-export default class AxiosRequestBackend implements RequestBackend<AxiosResponse> {
+type AxiosBackendResponse = AxiosResponse | WebSocketResponse;
+export default class AxiosRequestBackend implements RequestBackend<AxiosBackendResponse> {
     readonly id = "axios";
-    constructor(axiosLibrary: any);
-    extractResponseFromError(error: Error): Promise<AxiosResponse | null | undefined>;
-    convertResponse<T>(context: RequestContext, response: AxiosResponse): Promise<ConvertedApiResponse<T>>;
-    makeRequest(context: RequestContext): RequestOperation<AxiosResponse>;
+    webSocketConstructor: WebSocketConstructor | undefined;
+    constructor(axiosLibrary: any, webSocketConstructor?: WebSocketConstructor);
+    extractResponseFromError(error: Error): Promise<AxiosBackendResponse | null | undefined>;
+    convertResponse<T>(context: RequestContext, response: AxiosBackendResponse): Promise<ConvertedApiResponse<T>>;
+    makeRequest(context: RequestContext): RequestOperation<AxiosBackendResponse>;
     getErrorInfo(_error: Error, _response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }
+export {};

package/cjs/backend/AxiosRequestBackend.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAxiosError = void 0;
 const ApiUtils_1 = require("../ApiUtils");
+const WebSocketRequest_1 = require("./WebSocketRequest");
 let axios;
 const isAxiosError = (error) => {
     return "isAxiosError" in error;
@@ -32,9 +33,13 @@ const getCacheHeaders = (browserCache) => {
     }
 };
 class AxiosRequestBackend {
-    constructor(axiosLibrary) {
+    constructor(axiosLibrary, webSocketConstructor) {
         this.id = "axios";
+        this.webSocketConstructor = (0, WebSocketRequest_1.getGlobalWebSocketConstructor)();
         axios = axiosLibrary;
+        if (webSocketConstructor !== undefined) {
+            this.webSocketConstructor = webSocketConstructor;
+        }
     }
     async extractResponseFromError(error) {
         if ((0, exports.isAxiosError)(error)) {
@@ -43,17 +48,30 @@ class AxiosRequestBackend {
         return undefined;
     }
     async convertResponse(context, response) {
-        const contentType = response.headers["content-type"];
+        if (context.responseType === "websocket") {
+            const webSocketResponse = response;
+            return {
+                method: context.method,
+                url: webSocketResponse.url,
+                data: webSocketResponse.webSocket,
+                headers: webSocketResponse.headers,
+                status: webSocketResponse.status,
+                state: context.requestConfig.state,
+                stats: context.stats,
+            };
+        }
+        const axiosResponse = response;
+        const contentType = axiosResponse.headers["content-type"];
         const responseType = context.responseType ?? (0, ApiUtils_1.inferResponseType)(contentType == null ? contentType : String(contentType));
         let data;
         if (responseType === "stream") {
             // For streaming responses, we create an async iterator from the response data
-            if (!response.data) {
+            if (!axiosResponse.data) {
                 throw new Error("[api-def] Response data is null for streaming response");
             }
             data = {
                 async *[Symbol.asyncIterator]() {
-                    const stream = response.data;
+                    const stream = axiosResponse.data;
                     if (stream[Symbol.asyncIterator]) {
                         yield* stream;
                     }
@@ -68,20 +86,23 @@ class AxiosRequestBackend {
             };
         }
         else {
-            data = response.data;
+            data = axiosResponse.data;
         }
         return {
             method: context.method,
-            url: response.request.res?.responseUrl ?? response.request?._redirectable?._currentUrl,
+            url: axiosResponse.request.res?.responseUrl ?? axiosResponse.request?._redirectable?._currentUrl,
             data: data,
-            headers: response.headers,
-            status: response.status,
+            headers: axiosResponse.headers,
+            status: axiosResponse.status,
             state: context.requestConfig.state,
-            __lowercaseHeaders: response._lowerCaseResponseHeaders,
+            __lowercaseHeaders: axiosResponse._lowerCaseResponseHeaders,
             stats: context.stats,
         };
     }
     makeRequest(context) {
+        if (context.responseType === "websocket") {
+            return (0, WebSocketRequest_1.makeWebSocketRequest)(context, this.webSocketConstructor);
+        }
         const { requestConfig } = context;
         const url = context.requestUrl;
         let canceler = null;

package/cjs/backend/FetchRequestBackend.d.ts

@@ -3,14 +3,18 @@ import type RequestContext from "../RequestContext";
 import { type Fetch } from "../Utils";
 import type RequestBackend from "./RequestBackend";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
-export default class FetchRequestBackend implements RequestBackend<Response> {
+import { type WebSocketConstructor, type WebSocketResponse } from "./WebSocketRequest";
+type FetchBackendResponse = Response | WebSocketResponse;
+export default class FetchRequestBackend implements RequestBackend<FetchBackendResponse> {
     fetch: (((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) & typeof fetch) | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     readonly id = "fetch";
-    constructor(fetchLibrary?: Fetch);
-    extractResponseFromError(error: Error): Promise<Response | null | undefined>;
-    convertResponse<T>(context: RequestContext, response: Response & {
+    constructor(fetchLibrary?: Fetch, webSocketConstructor?: WebSocketConstructor);
+    extractResponseFromError(error: Error): Promise<FetchBackendResponse | null | undefined>;
+    convertResponse<T>(context: RequestContext, response: FetchBackendResponse & {
         __text?: string;
     }): Promise<ConvertedApiResponse<T>>;
-    makeRequest(context: RequestContext): RequestOperation<Response>;
+    makeRequest(context: RequestContext): RequestOperation<FetchBackendResponse>;
     getErrorInfo(_error: Error, _response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }
+export {};

package/cjs/backend/FetchRequestBackend.js

@@ -37,11 +37,13 @@ const ApiUtils_1 = require("../ApiUtils");
 const RequestError_1 = require("../RequestError");
 const Utils = __importStar(require("../Utils"));
 const Utils_1 = require("../Utils");
+const WebSocketRequest_1 = require("./WebSocketRequest");
 class FetchError extends Error {
 }
 class FetchRequestBackend {
-    constructor(fetchLibrary) {
+    constructor(fetchLibrary, webSocketConstructor) {
         this.fetch = (0, Utils_1.getGlobalFetch)();
+        this.webSocketConstructor = (0, WebSocketRequest_1.getGlobalWebSocketConstructor)();
         this.id = "fetch";
         if (fetchLibrary !== undefined) {
             this.fetch = fetchLibrary;
@@ -50,6 +52,9 @@ class FetchRequestBackend {
                 this.fetch = fetchLibrary.bind((0, Utils_1.getGlobal)());
             }
         }
+        if (webSocketConstructor !== undefined) {
+            this.webSocketConstructor = webSocketConstructor;
+        }
     }
     async extractResponseFromError(error) {
         if ("response" in error) {
@@ -73,7 +78,13 @@ class FetchRequestBackend {
         let text;
         let data;
         try {
-            if (responseType === "arraybuffer") {
+            if (responseType === "websocket") {
+                data = response.webSocket;
+                if (!data) {
+                    throw new Error("[api-def] WebSocket response did not include a webSocket");
+                }
+            }
+            else if (responseType === "arraybuffer") {
                 data = await response.arrayBuffer();
             }
             else if (responseType === "json") {
@@ -110,6 +121,10 @@ class FetchRequestBackend {
         const abortSignal = abortController ? abortController.signal : undefined;
         let softAbort = false;
         let responded = false;
+        if (context.responseType === "websocket") {
+            responded = true;
+            return (0, WebSocketRequest_1.makeWebSocketRequest)(context, this.webSocketConstructor);
+        }
         const body = context.getParsedBody();
         const bodyJsonify = body !== null && typeof body === "object" && !Utils.isFormDataLike(body) && !(body instanceof URLSearchParams);
         const headers = Utils.assign({

package/cjs/backend/WebSocketRequest.d.ts

@@ -0,0 +1,11 @@
+import type RequestContext from "../RequestContext";
+import type { RequestOperation } from "./RequestBackend";
+export type WebSocketConstructor = new (url: string | URL, protocols?: string | string[]) => WebSocket;
+export type WebSocketResponse = {
+    status: 101;
+    headers: Headers;
+    url: string;
+    webSocket: WebSocket;
+};
+export declare const getGlobalWebSocketConstructor: () => WebSocketConstructor | undefined;
+export declare const makeWebSocketRequest: (context: RequestContext, webSocketConstructor: WebSocketConstructor | undefined) => RequestOperation<WebSocketResponse>;

package/cjs/backend/WebSocketRequest.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeWebSocketRequest = exports.getGlobalWebSocketConstructor = void 0;
+const getGlobalWebSocketConstructor = () => {
+    return typeof WebSocket !== "undefined" ? WebSocket : undefined;
+};
+exports.getGlobalWebSocketConstructor = getGlobalWebSocketConstructor;
+const makeWebSocketRequest = (context, webSocketConstructor) => {
+    if (!webSocketConstructor) {
+        throw new Error("[api-def] No WebSocket constructor was provided");
+    }
+    const url = context.requestUrl;
+    if (url.protocol === "http:") {
+        url.protocol = "ws:";
+    }
+    else if (url.protocol === "https:") {
+        url.protocol = "wss:";
+    }
+    const protocolHeader = context.requestConfig.headers?.["Sec-WebSocket-Protocol"];
+    const protocols = typeof protocolHeader === "string"
+        ? protocolHeader.split(",").map((protocol) => protocol.trim())
+        : typeof protocolHeader === "number" || typeof protocolHeader === "boolean"
+            ? String(protocolHeader)
+            : undefined;
+    const webSocket = new webSocketConstructor(url.href, protocols);
+    return {
+        promise: Promise.resolve({
+            status: 101,
+            headers: new Headers(),
+            url: url.href,
+            webSocket,
+        }),
+        canceler: () => webSocket.close(),
+    };
+};
+exports.makeWebSocketRequest = makeWebSocketRequest;

package/esm/ApiConstants.d.ts

@@ -29,5 +29,6 @@ export declare const ResponseType: {
     readonly TEXT: "text";
     readonly ARRAY_BUFFER: "arraybuffer";
     readonly STREAM: "stream";
+    readonly WEBSOCKET: "websocket";
 };
 export type ResponseType = EnumOf<typeof ResponseType>;

package/esm/ApiConstants.js

@@ -24,4 +24,5 @@ export const ResponseType = {
     TEXT: "text",
     ARRAY_BUFFER: "arraybuffer",
     STREAM: "stream",
+    WEBSOCKET: "websocket",
 };

package/esm/EndpointBuilder.d.ts

@@ -4,7 +4,7 @@ import type { ResponseType } from "./ApiConstants.js";
 import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes.js";
 import Endpoint, { type EndpointOptions } from "./Endpoint.js";
 import type { BodyValidationOptions, ValidationOptions } from "./Validation.js";
-type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : "stream" extends T ? AsyncIterable<Uint8Array> : unknown;
+type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : T extends "stream" ? AsyncIterable<Uint8Array> : T extends "websocket" ? WebSocket : unknown;
 export type EndpointBuildOptions<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined, TPath extends string = string, TResponseType extends ResponseType | undefined = undefined> = Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
     responseType?: TResponseType;
 };

package/esm/Requester.js

@@ -105,7 +105,8 @@ const makeRequest = async (context) => {
             context.addCanceller(canceler);
             const response = await promise;
             const parsedResponse = (await parseResponse(context, response));
-            if (!isAcceptableStatus(parsedResponse.status, context.requestConfig.acceptableStatus)) {
+            if (!(context.responseType === "websocket" && parsedResponse.status === 101) &&
+                !isAcceptableStatus(parsedResponse.status, context.requestConfig.acceptableStatus)) {
                 throw convertToRequestError({
                     error: new Error(`[api-def] Invalid response status code '${parsedResponse.status}'`),
                     response: parsedResponse,

package/esm/backend/AxiosRequestBackend.d.ts

@@ -3,12 +3,16 @@ import type { ApiResponse } from "../ApiTypes.js";
 import type RequestContext from "../RequestContext.js";
 import type RequestBackend from "./RequestBackend.js";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend.js";
+import { type WebSocketConstructor, type WebSocketResponse } from "./WebSocketRequest.js";
 export declare const isAxiosError: (error: Error) => error is AxiosError;
-export default class AxiosRequestBackend implements RequestBackend<AxiosResponse> {
+type AxiosBackendResponse = AxiosResponse | WebSocketResponse;
+export default class AxiosRequestBackend implements RequestBackend<AxiosBackendResponse> {
     readonly id = "axios";
-    constructor(axiosLibrary: any);
-    extractResponseFromError(error: Error): Promise<AxiosResponse | null | undefined>;
-    convertResponse<T>(context: RequestContext, response: AxiosResponse): Promise<ConvertedApiResponse<T>>;
-    makeRequest(context: RequestContext): RequestOperation<AxiosResponse>;
+    webSocketConstructor: WebSocketConstructor | undefined;
+    constructor(axiosLibrary: any, webSocketConstructor?: WebSocketConstructor);
+    extractResponseFromError(error: Error): Promise<AxiosBackendResponse | null | undefined>;
+    convertResponse<T>(context: RequestContext, response: AxiosBackendResponse): Promise<ConvertedApiResponse<T>>;
+    makeRequest(context: RequestContext): RequestOperation<AxiosBackendResponse>;
     getErrorInfo(_error: Error, _response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }
+export {};

package/esm/backend/AxiosRequestBackend.js

@@ -1,4 +1,5 @@
 import { inferResponseType } from "../ApiUtils.js";
+import { getGlobalWebSocketConstructor, makeWebSocketRequest, } from "./WebSocketRequest.js";
 let axios;
 export const isAxiosError = (error) => {
     return "isAxiosError" in error;
@@ -28,9 +29,13 @@ const getCacheHeaders = (browserCache) => {
     }
 };
 export default class AxiosRequestBackend {
-    constructor(axiosLibrary) {
+    constructor(axiosLibrary, webSocketConstructor) {
         this.id = "axios";
+        this.webSocketConstructor = getGlobalWebSocketConstructor();
         axios = axiosLibrary;
+        if (webSocketConstructor !== undefined) {
+            this.webSocketConstructor = webSocketConstructor;
+        }
     }
     async extractResponseFromError(error) {
         if (isAxiosError(error)) {
@@ -39,17 +44,30 @@ export default class AxiosRequestBackend {
         return undefined;
     }
     async convertResponse(context, response) {
-        const contentType = response.headers["content-type"];
+        if (context.responseType === "websocket") {
+            const webSocketResponse = response;
+            return {
+                method: context.method,
+                url: webSocketResponse.url,
+                data: webSocketResponse.webSocket,
+                headers: webSocketResponse.headers,
+                status: webSocketResponse.status,
+                state: context.requestConfig.state,
+                stats: context.stats,
+            };
+        }
+        const axiosResponse = response;
+        const contentType = axiosResponse.headers["content-type"];
         const responseType = context.responseType ?? inferResponseType(contentType == null ? contentType : String(contentType));
         let data;
         if (responseType === "stream") {
             // For streaming responses, we create an async iterator from the response data
-            if (!response.data) {
+            if (!axiosResponse.data) {
                 throw new Error("[api-def] Response data is null for streaming response");
             }
             data = {
                 async *[Symbol.asyncIterator]() {
-                    const stream = response.data;
+                    const stream = axiosResponse.data;
                     if (stream[Symbol.asyncIterator]) {
                         yield* stream;
                     }
@@ -64,20 +82,23 @@ export default class AxiosRequestBackend {
             };
         }
         else {
-            data = response.data;
+            data = axiosResponse.data;
         }
         return {
             method: context.method,
-            url: response.request.res?.responseUrl ?? response.request?._redirectable?._currentUrl,
+            url: axiosResponse.request.res?.responseUrl ?? axiosResponse.request?._redirectable?._currentUrl,
             data: data,
-            headers: response.headers,
-            status: response.status,
+            headers: axiosResponse.headers,
+            status: axiosResponse.status,
             state: context.requestConfig.state,
-            __lowercaseHeaders: response._lowerCaseResponseHeaders,
+            __lowercaseHeaders: axiosResponse._lowerCaseResponseHeaders,
             stats: context.stats,
         };
     }
     makeRequest(context) {
+        if (context.responseType === "websocket") {
+            return makeWebSocketRequest(context, this.webSocketConstructor);
+        }
         const { requestConfig } = context;
         const url = context.requestUrl;
         let canceler = null;

package/esm/backend/FetchRequestBackend.d.ts

@@ -3,14 +3,18 @@ import type RequestContext from "../RequestContext.js";
 import { type Fetch } from "../Utils.js";
 import type RequestBackend from "./RequestBackend.js";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend.js";
-export default class FetchRequestBackend implements RequestBackend<Response> {
+import { type WebSocketConstructor, type WebSocketResponse } from "./WebSocketRequest.js";
+type FetchBackendResponse = Response | WebSocketResponse;
+export default class FetchRequestBackend implements RequestBackend<FetchBackendResponse> {
     fetch: (((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) & typeof fetch) | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     readonly id = "fetch";
-    constructor(fetchLibrary?: Fetch);
-    extractResponseFromError(error: Error): Promise<Response | null | undefined>;
-    convertResponse<T>(context: RequestContext, response: Response & {
+    constructor(fetchLibrary?: Fetch, webSocketConstructor?: WebSocketConstructor);
+    extractResponseFromError(error: Error): Promise<FetchBackendResponse | null | undefined>;
+    convertResponse<T>(context: RequestContext, response: FetchBackendResponse & {
         __text?: string;
     }): Promise<ConvertedApiResponse<T>>;
-    makeRequest(context: RequestContext): RequestOperation<Response>;
+    makeRequest(context: RequestContext): RequestOperation<FetchBackendResponse>;
     getErrorInfo(_error: Error, _response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }
+export {};

package/esm/backend/FetchRequestBackend.js

@@ -2,11 +2,13 @@ import { inferResponseType } from "../ApiUtils.js";
 import { convertToRequestError, RequestErrorCode } from "../RequestError.js";
 import * as Utils from "../Utils.js";
 import { getGlobal, getGlobalFetch } from "../Utils.js";
+import { getGlobalWebSocketConstructor, makeWebSocketRequest, } from "./WebSocketRequest.js";
 class FetchError extends Error {
 }
 export default class FetchRequestBackend {
-    constructor(fetchLibrary) {
+    constructor(fetchLibrary, webSocketConstructor) {
         this.fetch = getGlobalFetch();
+        this.webSocketConstructor = getGlobalWebSocketConstructor();
         this.id = "fetch";
         if (fetchLibrary !== undefined) {
             this.fetch = fetchLibrary;
@@ -15,6 +17,9 @@ export default class FetchRequestBackend {
                 this.fetch = fetchLibrary.bind(getGlobal());
             }
         }
+        if (webSocketConstructor !== undefined) {
+            this.webSocketConstructor = webSocketConstructor;
+        }
     }
     async extractResponseFromError(error) {
         if ("response" in error) {
@@ -38,7 +43,13 @@ export default class FetchRequestBackend {
         let text;
         let data;
         try {
-            if (responseType === "arraybuffer") {
+            if (responseType === "websocket") {
+                data = response.webSocket;
+                if (!data) {
+                    throw new Error("[api-def] WebSocket response did not include a webSocket");
+                }
+            }
+            else if (responseType === "arraybuffer") {
                 data = await response.arrayBuffer();
             }
             else if (responseType === "json") {
@@ -75,6 +86,10 @@ export default class FetchRequestBackend {
         const abortSignal = abortController ? abortController.signal : undefined;
         let softAbort = false;
         let responded = false;
+        if (context.responseType === "websocket") {
+            responded = true;
+            return makeWebSocketRequest(context, this.webSocketConstructor);
+        }
         const body = context.getParsedBody();
         const bodyJsonify = body !== null && typeof body === "object" && !Utils.isFormDataLike(body) && !(body instanceof URLSearchParams);
         const headers = Utils.assign({

package/esm/backend/WebSocketRequest.d.ts

@@ -0,0 +1,11 @@
+import type RequestContext from "../RequestContext.js";
+import type { RequestOperation } from "./RequestBackend.js";
+export type WebSocketConstructor = new (url: string | URL, protocols?: string | string[]) => WebSocket;
+export type WebSocketResponse = {
+    status: 101;
+    headers: Headers;
+    url: string;
+    webSocket: WebSocket;
+};
+export declare const getGlobalWebSocketConstructor: () => WebSocketConstructor | undefined;
+export declare const makeWebSocketRequest: (context: RequestContext, webSocketConstructor: WebSocketConstructor | undefined) => RequestOperation<WebSocketResponse>;

package/esm/backend/WebSocketRequest.js

@@ -0,0 +1,31 @@
+export const getGlobalWebSocketConstructor = () => {
+    return typeof WebSocket !== "undefined" ? WebSocket : undefined;
+};
+export const makeWebSocketRequest = (context, webSocketConstructor) => {
+    if (!webSocketConstructor) {
+        throw new Error("[api-def] No WebSocket constructor was provided");
+    }
+    const url = context.requestUrl;
+    if (url.protocol === "http:") {
+        url.protocol = "ws:";
+    }
+    else if (url.protocol === "https:") {
+        url.protocol = "wss:";
+    }
+    const protocolHeader = context.requestConfig.headers?.["Sec-WebSocket-Protocol"];
+    const protocols = typeof protocolHeader === "string"
+        ? protocolHeader.split(",").map((protocol) => protocol.trim())
+        : typeof protocolHeader === "number" || typeof protocolHeader === "boolean"
+            ? String(protocolHeader)
+            : undefined;
+    const webSocket = new webSocketConstructor(url.href, protocols);
+    return {
+        promise: Promise.resolve({
+            status: 101,
+            headers: new Headers(),
+            url: url.href,
+            webSocket,
+        }),
+        canceler: () => webSocket.close(),
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.14.3",
+  "version": "0.15.0-alpha.1",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",