crossws 0.0.1 → 0.1.0

package/dist/index.cjs

@@ -1,13 +1,13 @@
 'use strict';
 
-const peer = require('./shared/crossws.002417e5.cjs');
+const peer = require('./shared/crossws.21e14e0d.cjs');
 
-function defineWebSocketHandler(handler) {
-  return handler;
+function defineWebSocketHooks(hooks) {
+  return hooks;
 }
 
 exports.WebSocketError = peer.WebSocketError;
 exports.WebSocketMessage = peer.WebSocketMessage;
-exports.WebSocketPeer = peer.WebSocketPeer;
+exports.WebSocketPeerBase = peer.WebSocketPeerBase;
 exports.defineWebSocketAdapter = peer.defineWebSocketAdapter;
-exports.defineWebSocketHandler = defineWebSocketHandler;
+exports.defineWebSocketHooks = defineWebSocketHooks;

package/dist/index.d.cts

@@ -11,27 +11,57 @@ declare class WebSocketMessage {
 }
 
 type ReadyState = 0 | 1 | 2 | 3;
-declare abstract class WebSocketPeer {
+interface WebSocketContext {
+}
+declare abstract class WebSocketPeerBase<T extends WebSocketContext = WebSocketContext> {
+    ctx: T;
+    constructor(ctx: T);
     get id(): string | undefined;
     get readyState(): ReadyState | -1;
     abstract send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number;
     toString(): string;
 }
 
-interface WebSocketHandler {
-    onEvent?(event: string, ...args: any[]): void;
+type WSHook<ArgsT extends Array<any> = []> = (peer: WebSocketPeerBase, ...args: ArgsT) => void | Promise<void>;
+declare function defineWebSocketHooks(hooks: Partial<WebSocketHooks>): Partial<WebSocketHooks>;
+interface WebSocketHooks {
     /** A message is received */
-    onMessage?(peer: WebSocketPeer, message: WebSocketMessage): void;
+    message: WSHook<[WebSocketMessage]>;
     /** A socket is opened */
-    onOpen?(peer: WebSocketPeer): void;
+    open: WSHook<[]>;
     /** A socket is closed */
-    onClose?(peer: WebSocketPeer, code: number, reason: string): void;
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
     /** An error occurs */
-    onError?(peer: WebSocketPeer, error: WebSocketError): void;
+    error: WSHook<[WebSocketError]>;
+    "bun:message": WSHook<[ws: any, message: any]>;
+    "bun:open": WSHook<[ws: any]>;
+    "bun:close": WSHook<[ws: any]>;
+    "bun:drain": WSHook<[]>;
+    "bun:error": WSHook<[ws: any, error: any]>;
+    "bun:ping": WSHook<[ws: any, data: any]>;
+    "bun:pong": WSHook<[ws: any, data: any]>;
+    "cloudflare:accept": WSHook<[]>;
+    "cloudflare:message": WSHook<[event: any]>;
+    "cloudflare:error": WSHook<[event: any]>;
+    "cloudflare:close": WSHook<[event: any]>;
+    "deno:open": WSHook<[]>;
+    "deno:message": WSHook<[event: any]>;
+    "deno:close": WSHook<[]>;
+    "deno:error": WSHook<[error: any]>;
+    "node:open": WSHook<[]>;
+    "node:message": WSHook<[data: any, isBinary: boolean]>;
+    "node:close": WSHook<[code: number, reason: Buffer]>;
+    "node:error": WSHook<[error: any]>;
+    "node:ping": WSHook<[data: Buffer]>;
+    "node:pong": WSHook<[data: Buffer]>;
+    "node:unexpected-response": WSHook<[req: any, res: any]>;
+    "node:upgrade": WSHook<[req: any]>;
 }
-declare function defineWebSocketHandler(handler: WebSocketHandler): WebSocketHandler;
 
-type WebSocketAdapter<RT = any, OT = any> = (handler: WebSocketHandler, opts: OT) => RT;
+type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks>, opts: OT) => RT;
 declare function defineWebSocketAdapter<RT, OT>(factory: WebSocketAdapter<RT, OT>): WebSocketAdapter<RT, OT>;
 
-export { type WebSocketAdapter, WebSocketError, type WebSocketHandler, WebSocketMessage, WebSocketPeer, defineWebSocketAdapter, defineWebSocketHandler };
+export { type WebSocketAdapter, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.d.mts

@@ -11,27 +11,57 @@ declare class WebSocketMessage {
 }
 
 type ReadyState = 0 | 1 | 2 | 3;
-declare abstract class WebSocketPeer {
+interface WebSocketContext {
+}
+declare abstract class WebSocketPeerBase<T extends WebSocketContext = WebSocketContext> {
+    ctx: T;
+    constructor(ctx: T);
     get id(): string | undefined;
     get readyState(): ReadyState | -1;
     abstract send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number;
     toString(): string;
 }
 
-interface WebSocketHandler {
-    onEvent?(event: string, ...args: any[]): void;
+type WSHook<ArgsT extends Array<any> = []> = (peer: WebSocketPeerBase, ...args: ArgsT) => void | Promise<void>;
+declare function defineWebSocketHooks(hooks: Partial<WebSocketHooks>): Partial<WebSocketHooks>;
+interface WebSocketHooks {
     /** A message is received */
-    onMessage?(peer: WebSocketPeer, message: WebSocketMessage): void;
+    message: WSHook<[WebSocketMessage]>;
     /** A socket is opened */
-    onOpen?(peer: WebSocketPeer): void;
+    open: WSHook<[]>;
     /** A socket is closed */
-    onClose?(peer: WebSocketPeer, code: number, reason: string): void;
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
     /** An error occurs */
-    onError?(peer: WebSocketPeer, error: WebSocketError): void;
+    error: WSHook<[WebSocketError]>;
+    "bun:message": WSHook<[ws: any, message: any]>;
+    "bun:open": WSHook<[ws: any]>;
+    "bun:close": WSHook<[ws: any]>;
+    "bun:drain": WSHook<[]>;
+    "bun:error": WSHook<[ws: any, error: any]>;
+    "bun:ping": WSHook<[ws: any, data: any]>;
+    "bun:pong": WSHook<[ws: any, data: any]>;
+    "cloudflare:accept": WSHook<[]>;
+    "cloudflare:message": WSHook<[event: any]>;
+    "cloudflare:error": WSHook<[event: any]>;
+    "cloudflare:close": WSHook<[event: any]>;
+    "deno:open": WSHook<[]>;
+    "deno:message": WSHook<[event: any]>;
+    "deno:close": WSHook<[]>;
+    "deno:error": WSHook<[error: any]>;
+    "node:open": WSHook<[]>;
+    "node:message": WSHook<[data: any, isBinary: boolean]>;
+    "node:close": WSHook<[code: number, reason: Buffer]>;
+    "node:error": WSHook<[error: any]>;
+    "node:ping": WSHook<[data: Buffer]>;
+    "node:pong": WSHook<[data: Buffer]>;
+    "node:unexpected-response": WSHook<[req: any, res: any]>;
+    "node:upgrade": WSHook<[req: any]>;
 }
-declare function defineWebSocketHandler(handler: WebSocketHandler): WebSocketHandler;
 
-type WebSocketAdapter<RT = any, OT = any> = (handler: WebSocketHandler, opts: OT) => RT;
+type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks>, opts: OT) => RT;
 declare function defineWebSocketAdapter<RT, OT>(factory: WebSocketAdapter<RT, OT>): WebSocketAdapter<RT, OT>;
 
-export { type WebSocketAdapter, WebSocketError, type WebSocketHandler, WebSocketMessage, WebSocketPeer, defineWebSocketAdapter, defineWebSocketHandler };
+export { type WebSocketAdapter, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.d.ts

@@ -11,27 +11,57 @@ declare class WebSocketMessage {
 }
 
 type ReadyState = 0 | 1 | 2 | 3;
-declare abstract class WebSocketPeer {
+interface WebSocketContext {
+}
+declare abstract class WebSocketPeerBase<T extends WebSocketContext = WebSocketContext> {
+    ctx: T;
+    constructor(ctx: T);
     get id(): string | undefined;
     get readyState(): ReadyState | -1;
     abstract send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number;
     toString(): string;
 }
 
-interface WebSocketHandler {
-    onEvent?(event: string, ...args: any[]): void;
+type WSHook<ArgsT extends Array<any> = []> = (peer: WebSocketPeerBase, ...args: ArgsT) => void | Promise<void>;
+declare function defineWebSocketHooks(hooks: Partial<WebSocketHooks>): Partial<WebSocketHooks>;
+interface WebSocketHooks {
     /** A message is received */
-    onMessage?(peer: WebSocketPeer, message: WebSocketMessage): void;
+    message: WSHook<[WebSocketMessage]>;
     /** A socket is opened */
-    onOpen?(peer: WebSocketPeer): void;
+    open: WSHook<[]>;
     /** A socket is closed */
-    onClose?(peer: WebSocketPeer, code: number, reason: string): void;
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
     /** An error occurs */
-    onError?(peer: WebSocketPeer, error: WebSocketError): void;
+    error: WSHook<[WebSocketError]>;
+    "bun:message": WSHook<[ws: any, message: any]>;
+    "bun:open": WSHook<[ws: any]>;
+    "bun:close": WSHook<[ws: any]>;
+    "bun:drain": WSHook<[]>;
+    "bun:error": WSHook<[ws: any, error: any]>;
+    "bun:ping": WSHook<[ws: any, data: any]>;
+    "bun:pong": WSHook<[ws: any, data: any]>;
+    "cloudflare:accept": WSHook<[]>;
+    "cloudflare:message": WSHook<[event: any]>;
+    "cloudflare:error": WSHook<[event: any]>;
+    "cloudflare:close": WSHook<[event: any]>;
+    "deno:open": WSHook<[]>;
+    "deno:message": WSHook<[event: any]>;
+    "deno:close": WSHook<[]>;
+    "deno:error": WSHook<[error: any]>;
+    "node:open": WSHook<[]>;
+    "node:message": WSHook<[data: any, isBinary: boolean]>;
+    "node:close": WSHook<[code: number, reason: Buffer]>;
+    "node:error": WSHook<[error: any]>;
+    "node:ping": WSHook<[data: Buffer]>;
+    "node:pong": WSHook<[data: Buffer]>;
+    "node:unexpected-response": WSHook<[req: any, res: any]>;
+    "node:upgrade": WSHook<[req: any]>;
 }
-declare function defineWebSocketHandler(handler: WebSocketHandler): WebSocketHandler;
 
-type WebSocketAdapter<RT = any, OT = any> = (handler: WebSocketHandler, opts: OT) => RT;
+type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks>, opts: OT) => RT;
 declare function defineWebSocketAdapter<RT, OT>(factory: WebSocketAdapter<RT, OT>): WebSocketAdapter<RT, OT>;
 
-export { type WebSocketAdapter, WebSocketError, type WebSocketHandler, WebSocketMessage, WebSocketPeer, defineWebSocketAdapter, defineWebSocketHandler };
+export { type WebSocketAdapter, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.mjs

@@ -1,7 +1,7 @@
-export { W as WebSocketError, a as WebSocketMessage, b as WebSocketPeer, d as defineWebSocketAdapter } from './shared/crossws.08866fa6.mjs';
+export { W as WebSocketError, a as WebSocketMessage, b as WebSocketPeerBase, d as defineWebSocketAdapter } from './shared/crossws.9536f626.mjs';
 
-function defineWebSocketHandler(handler) {
-  return handler;
+function defineWebSocketHooks(hooks) {
+  return hooks;
 }
 
-export { defineWebSocketHandler };
+export { defineWebSocketHooks };

package/dist/shared/{crossws.002417e5.cjs → crossws.21e14e0d.cjs}

@@ -20,7 +20,7 @@ class WebSocketMessage {
     return this.rawData.toString();
   }
   toString() {
-    return `[WebSocketMessage] ${this.text()}`;
+    return `<WebSocketMessage: ${this.text()}>`;
   }
   [Symbol.for("nodejs.util.inspect.custom")]() {
     return this.toString();
@@ -34,7 +34,10 @@ const ReadyStateMap = {
   2: "closing",
   3: "closed"
 };
-class WebSocketPeer {
+class WebSocketPeerBase {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
   get id() {
     return void 0;
   }
@@ -43,7 +46,7 @@ class WebSocketPeer {
   }
   toString() {
     const readyState = ReadyStateMap[this.readyState];
-    return `[WebSocketPeer] ${this.id || "-"} (${readyState})`;
+    return `<WebSocketPeer${this.id ? ` ${this.id}` : ""} (${readyState})>`;
   }
   [Symbol.for("nodejs.util.inspect.custom")]() {
     return this.toString();
@@ -52,5 +55,5 @@ class WebSocketPeer {
 
 exports.WebSocketError = WebSocketError;
 exports.WebSocketMessage = WebSocketMessage;
-exports.WebSocketPeer = WebSocketPeer;
+exports.WebSocketPeerBase = WebSocketPeerBase;
 exports.defineWebSocketAdapter = defineWebSocketAdapter;