crossws 0.0.0 → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,67 @@
+declare class WebSocketError extends Error {
+    constructor(...args: any[]);
+}
+
+declare class WebSocketMessage {
+    readonly rawData: string | ArrayBuffer | Uint8Array;
+    readonly isBinary?: boolean | undefined;
+    constructor(rawData: string | ArrayBuffer | Uint8Array, isBinary?: boolean | undefined);
+    text(): string;
+    toString(): string;
+}
+
+type ReadyState = 0 | 1 | 2 | 3;
+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;
+}
+
+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 */
+    message: WSHook<[WebSocketMessage]>;
+    /** A socket is opened */
+    open: WSHook<[]>;
+    /** A socket is closed */
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
+    /** An error occurs */
+    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]>;
+}
+
+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, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.d.mts

@@ -0,0 +1,67 @@
+declare class WebSocketError extends Error {
+    constructor(...args: any[]);
+}
+
+declare class WebSocketMessage {
+    readonly rawData: string | ArrayBuffer | Uint8Array;
+    readonly isBinary?: boolean | undefined;
+    constructor(rawData: string | ArrayBuffer | Uint8Array, isBinary?: boolean | undefined);
+    text(): string;
+    toString(): string;
+}
+
+type ReadyState = 0 | 1 | 2 | 3;
+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;
+}
+
+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 */
+    message: WSHook<[WebSocketMessage]>;
+    /** A socket is opened */
+    open: WSHook<[]>;
+    /** A socket is closed */
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
+    /** An error occurs */
+    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]>;
+}
+
+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, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+declare class WebSocketError extends Error {
+    constructor(...args: any[]);
+}
+
+declare class WebSocketMessage {
+    readonly rawData: string | ArrayBuffer | Uint8Array;
+    readonly isBinary?: boolean | undefined;
+    constructor(rawData: string | ArrayBuffer | Uint8Array, isBinary?: boolean | undefined);
+    text(): string;
+    toString(): string;
+}
+
+type ReadyState = 0 | 1 | 2 | 3;
+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;
+}
+
+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 */
+    message: WSHook<[WebSocketMessage]>;
+    /** A socket is opened */
+    open: WSHook<[]>;
+    /** A socket is closed */
+    close: WSHook<[{
+        code?: number;
+        reason?: string;
+    }]>;
+    /** An error occurs */
+    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]>;
+}
+
+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, type WebSocketContext, WebSocketError, type WebSocketHooks, WebSocketMessage, WebSocketPeerBase, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.mjs

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

package/dist/shared/crossws.21e14e0d.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+function defineWebSocketAdapter(factory) {
+  return factory;
+}
+
+class WebSocketError extends Error {
+  constructor(...args) {
+    super(...args);
+    this.name = "WebSocketError";
+  }
+}
+
+class WebSocketMessage {
+  constructor(rawData, isBinary) {
+    this.rawData = rawData;
+    this.isBinary = isBinary;
+  }
+  text() {
+    return this.rawData.toString();
+  }
+  toString() {
+    return `<WebSocketMessage: ${this.text()}>`;
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.toString();
+  }
+}
+
+const ReadyStateMap = {
+  "-1": "unkown",
+  0: "connecting",
+  1: "open",
+  2: "closing",
+  3: "closed"
+};
+class WebSocketPeerBase {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  get id() {
+    return void 0;
+  }
+  get readyState() {
+    return -1;
+  }
+  toString() {
+    const readyState = ReadyStateMap[this.readyState];
+    return `<WebSocketPeer${this.id ? ` ${this.id}` : ""} (${readyState})>`;
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.toString();
+  }
+}
+
+exports.WebSocketError = WebSocketError;
+exports.WebSocketMessage = WebSocketMessage;
+exports.WebSocketPeerBase = WebSocketPeerBase;
+exports.defineWebSocketAdapter = defineWebSocketAdapter;