crossws 0.4.3 → 0.4.5

package/adapters/bunny.d.ts

@@ -0,0 +1,2 @@
+export * from "../dist/adapters/bunny.mjs";
+export { default } from "../dist/adapters/bunny.mjs";

package/dist/THIRD-PARTY-LICENSES.md

@@ -0,0 +1,33 @@
+# Licenses of Bundled Dependencies
+
+The published artifact additionally contains code with the following licenses:
+MIT
+
+# Bundled Dependencies
+
+## ws
+
+License: MIT
+By: Einar Otto Stangvik
+Repository: https://github.com/websockets/ws
+
+> Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com>
+> Copyright (c) 2013 Arnout Kazemier and contributors
+> Copyright (c) 2016 Luigi Pinca and contributors
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy of
+> this software and associated documentation files (the "Software"), to deal in
+> the Software without restriction, including without limitation the rights to
+> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+> the Software, and to permit persons to whom the Software is furnished to do so,
+> subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+> FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+> COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+> IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/_chunks/_request.mjs

@@ -1,8 +1,7 @@
-//#region src/_request.ts
 const StubRequest = /* @__PURE__ */ (() => {
 	class StubRequest {
 		url;
-		_signal;
+		_abortController;
 		_headers;
 		_init;
 		constructor(url, init = {}) {
@@ -20,7 +19,8 @@ const StubRequest = /* @__PURE__ */ (() => {
 			return "GET";
 		}
 		get signal() {
-			return this._signal ??= new AbortSignal();
+			if (!this._abortController) this._abortController = new AbortController();
+			return this._abortController.signal;
 		}
 		get cache() {
 			return "default";
@@ -77,6 +77,4 @@ const StubRequest = /* @__PURE__ */ (() => {
 	Object.setPrototypeOf(StubRequest.prototype, globalThis.Request.prototype);
 	return StubRequest;
 })();
-
-//#endregion
-export { StubRequest as t };
+export { StubRequest as t };

package/dist/_chunks/_types.d.mts

@@ -1,16 +1,16 @@
 import { a as Hooks } from "./adapter.mjs";
 import { n as BunOptions } from "./bun.mjs";
+import { n as BunnyOptions } from "./bunny.mjs";
 import { n as CloudflareOptions } from "./cloudflare.mjs";
 import { n as DenoOptions } from "./deno.mjs";
 import { n as NodeOptions } from "./node.mjs";
 import { n as SSEOptions } from "./sse.mjs";
 import { Server, ServerOptions, ServerPlugin, ServerRequest } from "srvx";
-
-//#region src/server/_types.d.ts
 type WSOptions = Partial<Hooks> & {
   resolve?: (req: ServerRequest) => Partial<Hooks> | Promise<Partial<Hooks>>;
   options?: {
     bun?: BunOptions;
+    bunny?: BunnyOptions;
     deno?: DenoOptions;
     node?: NodeOptions;
     sse?: SSEOptions;
@@ -20,5 +20,4 @@ type WSOptions = Partial<Hooks> & {
 type ServerWithWSOptions = ServerOptions & {
   websocket?: WSOptions;
 };
-//#endregion
 export { WSOptions as n, ServerWithWSOptions as t };

package/dist/_chunks/adapter.d.mts

@@ -1,14 +1,8 @@
 import { a as WebSocket } from "./web.mjs";
-
-//#region src/error.d.ts
 declare class WSError extends Error {
   constructor(...args: any[]);
 }
-//#endregion
-//#region src/utils.d.ts
 declare const kNodeInspect: unique symbol;
-//#endregion
-//#region src/peer.d.ts
 interface PeerContext extends Record<string, unknown> {}
 interface AdapterInternal {
   ws: unknown;
@@ -26,21 +20,21 @@ declare abstract class Peer<Internal extends AdapterInternal = AdapterInternal>
   get context(): PeerContext;
   get namespace(): string;
   /**
-       * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the peer.
-       */
+   * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the peer.
+   */
   get id(): string;
   /** IP address of the peer */
   get remoteAddress(): string | undefined;
   /** upgrade request */
   get request(): Request;
   /**
-       * Get the [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) instance.
-       *
-       * **Note:** crossws adds polyfill for the following properties if native values are not available:
-       * - `protocol`: Extracted from the `sec-websocket-protocol` header.
-       * - `extensions`: Extracted from the `sec-websocket-extensions` header.
-       * - `url`: Extracted from the request URL (http -> ws).
-       * */
+   * Get the [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) instance.
+   *
+   * **Note:** crossws adds polyfill for the following properties if native values are not available:
+   * - `protocol`: Extracted from the `sec-websocket-protocol` header.
+   * - `extensions`: Extracted from the `sec-websocket-extensions` header.
+   * - `url`: Extracted from the request URL (http -> ws).
+   * */
   get websocket(): Partial<WebSocket>;
   /** All connected peers to the server */
   get peers(): Set<Peer>;
@@ -66,8 +60,6 @@ declare abstract class Peer<Internal extends AdapterInternal = AdapterInternal>
   [Symbol.toStringTag](): "WebSocket";
   [kNodeInspect](): unknown;
 }
-//#endregion
-//#region src/message.d.ts
 declare class Message implements Partial<MessageEvent> {
   #private;
   /** Access to the original [message event](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/message_event) if available. */
@@ -78,46 +70,44 @@ declare class Message implements Partial<MessageEvent> {
   readonly rawData: unknown;
   constructor(rawData: unknown, peer: Peer, event?: MessageEvent);
   /**
-       * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the message.
-       */
+   * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the message.
+   */
   get id(): string;
   /**
-       * Get data as [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) value.
-       *
-       * If raw data is in any other format or string, it will be automatically converted and encoded.
-       */
+   * Get data as [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) value.
+   *
+   * If raw data is in any other format or string, it will be automatically converted and encoded.
+   */
   uint8Array(): Uint8Array;
   /**
-       * Get data as [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) value.
-       *
-       * If raw data is in any other format or string, it will be automatically converted and encoded.
-       */
+   * Get data as [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) value.
+   *
+   * If raw data is in any other format or string, it will be automatically converted and encoded.
+   */
   arrayBuffer(): ArrayBuffer | SharedArrayBuffer;
   /**
-       * Get data as [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) value.
-       *
-       * If raw data is in any other format or string, it will be automatically converted and encoded. */
+   * Get data as [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) value.
+   *
+   * If raw data is in any other format or string, it will be automatically converted and encoded. */
   blob(): Blob;
   /**
-       * Get stringified text version of the message.
-       *
-       * If raw data is in any other format, it will be automatically converted and decoded.
-       */
+   * Get stringified text version of the message.
+   *
+   * If raw data is in any other format, it will be automatically converted and decoded.
+   */
   text(): string;
   /**
-       * Get parsed version of the message text with [`JSON.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
-       */
+   * Get parsed version of the message text with [`JSON.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
+   */
   json<T = unknown>(): T;
   /**
-       * Message data (value varies based on `peer.websocket.binaryType`).
-       */
+   * Message data (value varies based on `peer.websocket.binaryType`).
+   */
   get data(): unknown;
   toString(): string;
   [Symbol.toPrimitive](): string;
   [kNodeInspect](): unknown;
 }
-//#endregion
-//#region src/hooks.d.ts
 declare function defineHooks<T extends Partial<Hooks> = Partial<Hooks>>(hooks: T): T;
 type ResolveHooks = (request: Request & {
   readonly context?: PeerContext;
@@ -125,22 +115,27 @@ type ResolveHooks = (request: Request & {
 type MaybePromise<T> = T | Promise<T>;
 interface Hooks {
   /**
-       * Upgrading a request to a WebSocket connection.
-       *
-       * - You can throw a Response to abort the upgrade.
-       * - You can return { headers } to modify the response.
-       * - You can return { namespace } to change the pub/sub namespace.
-       * - You can return { context } to provide a custom peer context.
-       *
-       * @param request
-       * @throws {Response}
-       */
+   * Upgrading a request to a WebSocket connection.
+   *
+   * - You can throw a Response to abort the upgrade.
+   * - You can return { headers } to modify the response.
+   * - You can return { namespace } to change the pub/sub namespace.
+   * - You can return { context } to provide a custom peer context.
+   * - You can return { handled: true } to signal that the upgrade has
+   *   already been performed by the hook (e.g. delegated to an external
+   *   node-style `(req, socket, head)` handler). The adapter will then
+   *   leave the socket alone and skip its own upgrade.
+   *
+   * @param request
+   * @throws {Response}
+   */
   upgrade: (request: Request & {
     readonly context?: Record<string, unknown>;
   }) => MaybePromise<{
     headers?: HeadersInit;
     namespace?: string;
     context?: PeerContext;
+    handled?: boolean;
   } | Response | void>;
   /** A message is received */
   message: (peer: Peer, message: Message) => MaybePromise<void>;
@@ -154,8 +149,6 @@ interface Hooks {
   /** An error occurs */
   error: (peer: Peer, error: WSError) => MaybePromise<void>;
 }
-//#endregion
-//#region src/adapter.d.ts
 interface AdapterInstance {
   readonly peers: Map<string, Set<Peer>>;
   readonly publish: (topic: string, data: unknown, options?: {
@@ -170,5 +163,4 @@ interface AdapterOptions {
 }
 type Adapter<AdapterT extends AdapterInstance = AdapterInstance, Options extends AdapterOptions = AdapterOptions> = (options?: Options) => AdapterT;
 declare function defineWebSocketAdapter<AdapterT extends AdapterInstance = AdapterInstance, Options extends AdapterOptions = AdapterOptions>(factory: Adapter<AdapterT, Options>): Adapter<AdapterT, Options>;
-//#endregion
 export { Hooks as a, Message as c, PeerContext as d, WSError as f, defineWebSocketAdapter as i, AdapterInternal as l, AdapterInstance as n, ResolveHooks as o, AdapterOptions as r, defineHooks as s, Adapter as t, Peer as u };

package/dist/_chunks/adapter.mjs

@@ -1,4 +1,3 @@
-//#region src/hooks.ts
 var AdapterHookable = class {
 	options;
 	constructor(options) {
@@ -32,6 +31,11 @@ var AdapterHookable = class {
 				namespace,
 				endResponse: res
 			};
+			if (res.handled) return {
+				context,
+				namespace,
+				handled: true
+			};
 			if (res.headers) return {
 				context,
 				namespace,
@@ -55,9 +59,6 @@ var AdapterHookable = class {
 function defineHooks(hooks) {
 	return hooks;
 }
-
-//#endregion
-//#region src/adapter.ts
 function adapterUtils(globalPeers) {
 	return {
 		peers: globalPeers,
@@ -88,6 +89,4 @@ function getPeers(globalPeers, namespace) {
 function defineWebSocketAdapter(factory) {
 	return factory;
 }
-
-//#endregion
-export { defineHooks as a, AdapterHookable as i, defineWebSocketAdapter as n, getPeers as r, adapterUtils as t };
+export { defineHooks as a, AdapterHookable as i, defineWebSocketAdapter as n, getPeers as r, adapterUtils as t };

package/dist/_chunks/bun.d.mts

@@ -1,7 +1,5 @@
 import { d as PeerContext, n as AdapterInstance, r as AdapterOptions, t as Adapter, u as Peer } from "./adapter.mjs";
 import { Server, ServerWebSocket, WebSocketHandler } from "bun";
-
-//#region src/adapters/bun.d.ts
 interface BunAdapter extends AdapterInstance {
   websocket: WebSocketHandler<ContextData>;
   handleUpgrade(req: Request, server: Server<ContextData>): Promise<Response | undefined>;
@@ -34,5 +32,4 @@ declare class BunPeer extends Peer<{
   close(code?: number, reason?: string): void;
   terminate(): void;
 }
-//#endregion
 export { BunOptions as n, bunAdapter as r, BunAdapter as t };

package/dist/_chunks/bunny.d.mts

@@ -0,0 +1,22 @@
+import { n as AdapterInstance, r as AdapterOptions, t as Adapter } from "./adapter.mjs";
+interface BunnyAdapter extends AdapterInstance {
+  handleUpgrade(req: Request): Promise<Response>;
+}
+interface BunnyOptions extends AdapterOptions {
+  /**
+   * The WebSocket subprotocol to use for the connection.
+   */
+  protocol?: string;
+  /**
+   * The number of seconds to wait for a pong response before closing the connection.
+   * If the client does not respond within this timeout, the connection is deemed
+   * unhealthy and closed, emitting the close and error events.
+   * If no data is transmitted from the client for 2 minutes, the connection
+   * will be closed regardless of this configuration.
+   *
+   * @default 30
+   */
+  idleTimeout?: number;
+}
+declare const bunnyAdapter: Adapter<BunnyAdapter, BunnyOptions>;
+export { BunnyOptions as n, bunnyAdapter as r, BunnyAdapter as t };

package/dist/_chunks/cloudflare.d.mts

@@ -2,34 +2,32 @@ import { n as AdapterInstance, r as AdapterOptions, t as Adapter } from "./adapt
 import { a as WebSocket$1 } from "./web.mjs";
 import { DurableObject } from "cloudflare:workers";
 import * as CF from "@cloudflare/workers-types";
-
-//#region src/adapters/cloudflare.d.ts
 type WSDurableObjectStub = CF.DurableObjectStub & {
   webSocketPublish?: (topic: string, data: unknown, opts: any) => Promise<void>;
 };
 type ResolveDurableStub = (req: CF.Request | undefined, env: unknown, context: CF.ExecutionContext | undefined) => WSDurableObjectStub | undefined | Promise<WSDurableObjectStub | undefined>;
 interface CloudflareOptions extends AdapterOptions {
   /**
-       * Durable Object binding name from environment.
-       *
-       * **Note:** This option will be ignored if `resolveDurableStub` is provided.
-       *
-       * @default "$DurableObject"
-       */
+   * Durable Object binding name from environment.
+   *
+   * **Note:** This option will be ignored if `resolveDurableStub` is provided.
+   *
+   * @default "$DurableObject"
+   */
   bindingName?: string;
   /**
-       * Durable Object instance name.
-       *
-       * **Note:** This option will be ignored if `resolveDurableStub` is provided.
-       *
-       * @default "crossws"
-       */
+   * Durable Object instance name.
+   *
+   * **Note:** This option will be ignored if `resolveDurableStub` is provided.
+   *
+   * @default "crossws"
+   */
   instanceName?: string;
   /**
-       * Custom function that resolves Durable Object binding to handle the WebSocket upgrade.
-       *
-       * **Note:** This option will override `bindingName` and `instanceName`.
-       */
+   * Custom function that resolves Durable Object binding to handle the WebSocket upgrade.
+   *
+   * **Note:** This option will override `bindingName` and `instanceName`.
+   */
   resolveDurableStub?: ResolveDurableStub;
 }
 declare const cloudflareAdapter: Adapter<CloudflareDurableAdapter, CloudflareOptions>;
@@ -41,5 +39,4 @@ interface CloudflareDurableAdapter extends AdapterInstance {
   handleDurablePublish: (obj: DurableObject, topic: string, data: unknown, opts: any) => Promise<void>;
   handleDurableClose(obj: DurableObject, ws: WebSocket | CF.WebSocket | WebSocket$1, code: number, reason: string, wasClean: boolean): Promise<void>;
 }
-//#endregion
 export { CloudflareOptions as n, cloudflareAdapter as r, CloudflareDurableAdapter as t };

package/dist/_chunks/deno.d.mts

@@ -1,6 +1,4 @@
 import { n as AdapterInstance, r as AdapterOptions, t as Adapter } from "./adapter.mjs";
-
-//#region src/adapters/deno.d.ts
 interface DenoAdapter extends AdapterInstance {
   handleUpgrade(req: Request, info: ServeHandlerInfo): Promise<Response>;
 }
@@ -13,5 +11,4 @@ type ServeHandlerInfo = {
   };
 };
 declare const denoAdapter: Adapter<DenoAdapter, DenoOptions>;
-//#endregion
 export { DenoOptions as n, denoAdapter as r, DenoAdapter as t };

package/dist/_chunks/error.mjs

@@ -1,10 +1,7 @@
-//#region src/error.ts
 var WSError = class extends Error {
 	constructor(...args) {
 		super(...args);
 		this.name = "WSError";
 	}
 };
-
-//#endregion
-export { WSError as t };
+export { WSError as t };