api-def 0.14.3 → 0.15.0-alpha.0

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.js

@@ -82,6 +82,9 @@ class AxiosRequestBackend {
         };
     }
     makeRequest(context) {
+        if (context.responseType === "websocket") {
+            throw new Error("[api-def] WebSocket responseType is only supported by FetchRequestBackend");
+        }
         const { requestConfig } = context;
         const url = context.requestUrl;
         let canceler = null;

package/cjs/backend/FetchRequestBackend.js

@@ -83,6 +83,12 @@ class FetchRequestBackend {
             else if (responseType === "stream") {
                 data = response.body;
             }
+            else if (responseType === "websocket") {
+                data = response.webSocket;
+                if (!data) {
+                    throw new Error("[api-def] WebSocket upgrade response did not include a webSocket");
+                }
+            }
             else {
                 data = await response.text();
             }
@@ -115,6 +121,8 @@ class FetchRequestBackend {
         const headers = Utils.assign({
             // logic from axios
             "Content-Type": bodyJsonify ? "application/json;charset=utf-8" : undefined,
+            Connection: context.responseType === "websocket" ? "Upgrade" : undefined,
+            Upgrade: context.responseType === "websocket" ? "websocket" : undefined,
         }, requestConfig.headers);
         const parsedHeaders = Object.keys(headers).reduce((parsedHeaders, key) => {
             const value = headers[key];
@@ -149,7 +157,7 @@ class FetchRequestBackend {
         }
         const promise = this.fetch(request).then((response) => {
             responded = true;
-            if (!response.ok) {
+            if (!response.ok && !(context.responseType === "websocket" && response.status === 101)) {
                 const error = new FetchError("Fetch failed");
                 error.response = response;
                 throw error;

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.js

@@ -78,6 +78,9 @@ export default class AxiosRequestBackend {
         };
     }
     makeRequest(context) {
+        if (context.responseType === "websocket") {
+            throw new Error("[api-def] WebSocket responseType is only supported by FetchRequestBackend");
+        }
         const { requestConfig } = context;
         const url = context.requestUrl;
         let canceler = null;

package/esm/backend/FetchRequestBackend.js

@@ -48,6 +48,12 @@ export default class FetchRequestBackend {
             else if (responseType === "stream") {
                 data = response.body;
             }
+            else if (responseType === "websocket") {
+                data = response.webSocket;
+                if (!data) {
+                    throw new Error("[api-def] WebSocket upgrade response did not include a webSocket");
+                }
+            }
             else {
                 data = await response.text();
             }
@@ -80,6 +86,8 @@ export default class FetchRequestBackend {
         const headers = Utils.assign({
             // logic from axios
             "Content-Type": bodyJsonify ? "application/json;charset=utf-8" : undefined,
+            Connection: context.responseType === "websocket" ? "Upgrade" : undefined,
+            Upgrade: context.responseType === "websocket" ? "websocket" : undefined,
         }, requestConfig.headers);
         const parsedHeaders = Object.keys(headers).reduce((parsedHeaders, key) => {
             const value = headers[key];
@@ -114,7 +122,7 @@ export default class FetchRequestBackend {
         }
         const promise = this.fetch(request).then((response) => {
             responded = true;
-            if (!response.ok) {
+            if (!response.ok && !(context.responseType === "websocket" && response.status === 101)) {
                 const error = new FetchError("Fetch failed");
                 error.response = response;
                 throw error;

package/package.json

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