crossws 0.1.1 → 0.1.3

package/dist/index.d.mts

@@ -2,40 +2,65 @@ declare class WebSocketError extends Error {
     constructor(...args: any[]);
 }
 
-declare class WebSocketMessage {
-    readonly rawData: string | ArrayBuffer | Uint8Array;
+declare class WSMessage {
+    readonly rawData: any;
     readonly isBinary?: boolean | undefined;
-    constructor(rawData: string | ArrayBuffer | Uint8Array, isBinary?: boolean | undefined);
+    constructor(rawData: any, isBinary?: boolean | undefined);
     text(): string;
     toString(): string;
 }
 
 type ReadyState = 0 | 1 | 2 | 3;
-interface WebSocketContext {
+interface WSRequest {
+    readonly url: string;
+    readonly headers: HeadersInit;
 }
-declare abstract class WebSocketPeerBase<T extends WebSocketContext = WebSocketContext> {
-    ctx: T;
-    constructor(ctx: T);
+declare abstract class WSPeer<AdapterContext = any> implements WSRequest {
+    ctx: AdapterContext;
+    _subscriptions: Set<string>;
+    constructor(ctx: AdapterContext);
     get id(): string | undefined;
+    get url(): string;
+    get headers(): HeadersInit;
     get readyState(): ReadyState | -1;
-    abstract send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number;
+    abstract send(message: any, options?: {
+        compress?: boolean;
+    }): number;
+    publish(topic: string, message: any, options?: {
+        compress?: boolean;
+    }): void;
+    subscribe(topic: string): void;
+    unsubscribe(topic: string): void;
     toString(): string;
 }
 
-type WSHook<ArgsT extends Array<any> = []> = (peer: WebSocketPeerBase, ...args: ArgsT) => void | Promise<void>;
-declare function defineWebSocketHooks(hooks: Partial<WebSocketHooks>): Partial<WebSocketHooks>;
+type MaybePromise<T> = T | Promise<T>;
+type _UserHooks = WebSocketHooks & AdapterHooks;
+type UserHooks = Partial<_UserHooks>;
+declare function defineWebSocketHooks<T extends UserHooks = UserHooks>(hooks: T): T;
+type UserHookName = Exclude<keyof _UserHooks, "$">;
+type CatchAllHandler = <Name extends UserHookName>(name: Name, ...args: Parameters<_UserHooks[Name]>) => MaybePromise<void>;
 interface WebSocketHooks {
+    /** Catch-all handler */
+    $: CatchAllHandler;
+    /** Upgrading */
+    upgrade: (req: WSRequest) => MaybePromise<void | {
+        headers?: HeadersInit;
+    }>;
     /** A message is received */
-    message: WSHook<[WebSocketMessage]>;
+    message: (peer: WSPeer, message: WSMessage) => MaybePromise<void>;
     /** A socket is opened */
-    open: WSHook<[]>;
+    open: (peer: WSPeer) => MaybePromise<void>;
     /** A socket is closed */
-    close: WSHook<[{
+    close: (peer: WSPeer, details: {
         code?: number;
         reason?: string;
-    }]>;
+    }) => MaybePromise<void>;
     /** An error occurs */
-    error: WSHook<[WebSocketError]>;
+    error: (peer: WSPeer, error: WebSocketError) => MaybePromise<void>;
+}
+type WSHook<ArgsT extends Array<any> = []> = (peer: WSPeer, ...args: ArgsT) => MaybePromise<void>;
+interface AdapterHooks {
     "bun:message": WSHook<[ws: any, message: any]>;
     "bun:open": WSHook<[ws: any]>;
     "bun:close": WSHook<[ws: any]>;
@@ -59,9 +84,32 @@ interface WebSocketHooks {
     "node:pong": WSHook<[data: Buffer]>;
     "node:unexpected-response": WSHook<[req: any, res: any]>;
     "node:upgrade": WSHook<[req: any]>;
+    "uws:open": WSHook<[ws: any]>;
+    "uws:message": WSHook<[ws: any, message: any, isBinary: boolean]>;
+    "uws:close": WSHook<[ws: any, code: number, message: any]>;
+    "uws:ping": WSHook<[ws: any, message: any]>;
+    "uws:pong": WSHook<[ws: any, message: any]>;
+    "uws:drain": WSHook<[ws: any]>;
+    "uws:upgrade": WSHook<[res: any, req: any, context: any]>;
+    "uws:subscription": WSHook<[
+        ws: any,
+        topic: any,
+        newCount: number,
+        oldCount: number
+    ]>;
 }
 
-type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks>, opts: OT) => RT;
+type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks & AdapterHooks>, 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 };
+interface CrossWS extends WebSocketHooks {
+    upgrade: (req: WSRequest) => Promise<{
+        headers: HeadersInit;
+    }>;
+}
+interface CrossWSOptions {
+    resolve?: (info: WSRequest | WSPeer) => UserHooks | Promise<UserHooks>;
+}
+declare function createCrossWS(hooks: UserHooks, options: CrossWSOptions): CrossWS;
+
+export { type AdapterHooks, type CrossWS, type CrossWSOptions, type UserHooks, WSMessage, WSPeer, type WSRequest, type WebSocketAdapter, WebSocketError, type WebSocketHooks, type _UserHooks, createCrossWS, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.d.ts

@@ -2,40 +2,65 @@ declare class WebSocketError extends Error {
     constructor(...args: any[]);
 }
 
-declare class WebSocketMessage {
-    readonly rawData: string | ArrayBuffer | Uint8Array;
+declare class WSMessage {
+    readonly rawData: any;
     readonly isBinary?: boolean | undefined;
-    constructor(rawData: string | ArrayBuffer | Uint8Array, isBinary?: boolean | undefined);
+    constructor(rawData: any, isBinary?: boolean | undefined);
     text(): string;
     toString(): string;
 }
 
 type ReadyState = 0 | 1 | 2 | 3;
-interface WebSocketContext {
+interface WSRequest {
+    readonly url: string;
+    readonly headers: HeadersInit;
 }
-declare abstract class WebSocketPeerBase<T extends WebSocketContext = WebSocketContext> {
-    ctx: T;
-    constructor(ctx: T);
+declare abstract class WSPeer<AdapterContext = any> implements WSRequest {
+    ctx: AdapterContext;
+    _subscriptions: Set<string>;
+    constructor(ctx: AdapterContext);
     get id(): string | undefined;
+    get url(): string;
+    get headers(): HeadersInit;
     get readyState(): ReadyState | -1;
-    abstract send(message: string | ArrayBuffer | Uint8Array, compress?: boolean): number;
+    abstract send(message: any, options?: {
+        compress?: boolean;
+    }): number;
+    publish(topic: string, message: any, options?: {
+        compress?: boolean;
+    }): void;
+    subscribe(topic: string): void;
+    unsubscribe(topic: string): void;
     toString(): string;
 }
 
-type WSHook<ArgsT extends Array<any> = []> = (peer: WebSocketPeerBase, ...args: ArgsT) => void | Promise<void>;
-declare function defineWebSocketHooks(hooks: Partial<WebSocketHooks>): Partial<WebSocketHooks>;
+type MaybePromise<T> = T | Promise<T>;
+type _UserHooks = WebSocketHooks & AdapterHooks;
+type UserHooks = Partial<_UserHooks>;
+declare function defineWebSocketHooks<T extends UserHooks = UserHooks>(hooks: T): T;
+type UserHookName = Exclude<keyof _UserHooks, "$">;
+type CatchAllHandler = <Name extends UserHookName>(name: Name, ...args: Parameters<_UserHooks[Name]>) => MaybePromise<void>;
 interface WebSocketHooks {
+    /** Catch-all handler */
+    $: CatchAllHandler;
+    /** Upgrading */
+    upgrade: (req: WSRequest) => MaybePromise<void | {
+        headers?: HeadersInit;
+    }>;
     /** A message is received */
-    message: WSHook<[WebSocketMessage]>;
+    message: (peer: WSPeer, message: WSMessage) => MaybePromise<void>;
     /** A socket is opened */
-    open: WSHook<[]>;
+    open: (peer: WSPeer) => MaybePromise<void>;
     /** A socket is closed */
-    close: WSHook<[{
+    close: (peer: WSPeer, details: {
         code?: number;
         reason?: string;
-    }]>;
+    }) => MaybePromise<void>;
     /** An error occurs */
-    error: WSHook<[WebSocketError]>;
+    error: (peer: WSPeer, error: WebSocketError) => MaybePromise<void>;
+}
+type WSHook<ArgsT extends Array<any> = []> = (peer: WSPeer, ...args: ArgsT) => MaybePromise<void>;
+interface AdapterHooks {
     "bun:message": WSHook<[ws: any, message: any]>;
     "bun:open": WSHook<[ws: any]>;
     "bun:close": WSHook<[ws: any]>;
@@ -59,9 +84,32 @@ interface WebSocketHooks {
     "node:pong": WSHook<[data: Buffer]>;
     "node:unexpected-response": WSHook<[req: any, res: any]>;
     "node:upgrade": WSHook<[req: any]>;
+    "uws:open": WSHook<[ws: any]>;
+    "uws:message": WSHook<[ws: any, message: any, isBinary: boolean]>;
+    "uws:close": WSHook<[ws: any, code: number, message: any]>;
+    "uws:ping": WSHook<[ws: any, message: any]>;
+    "uws:pong": WSHook<[ws: any, message: any]>;
+    "uws:drain": WSHook<[ws: any]>;
+    "uws:upgrade": WSHook<[res: any, req: any, context: any]>;
+    "uws:subscription": WSHook<[
+        ws: any,
+        topic: any,
+        newCount: number,
+        oldCount: number
+    ]>;
 }
 
-type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks>, opts: OT) => RT;
+type WebSocketAdapter<RT = any, OT = any> = (hooks: Partial<WebSocketHooks & AdapterHooks>, 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 };
+interface CrossWS extends WebSocketHooks {
+    upgrade: (req: WSRequest) => Promise<{
+        headers: HeadersInit;
+    }>;
+}
+interface CrossWSOptions {
+    resolve?: (info: WSRequest | WSPeer) => UserHooks | Promise<UserHooks>;
+}
+declare function createCrossWS(hooks: UserHooks, options: CrossWSOptions): CrossWS;
+
+export { type AdapterHooks, type CrossWS, type CrossWSOptions, type UserHooks, WSMessage, WSPeer, type WSRequest, type WebSocketAdapter, WebSocketError, type WebSocketHooks, type _UserHooks, createCrossWS, defineWebSocketAdapter, defineWebSocketHooks };

package/dist/index.mjs

@@ -1,4 +1,5 @@
-export { W as WebSocketError, a as WebSocketMessage, b as WebSocketPeerBase, d as defineWebSocketAdapter } from './shared/crossws.9536f626.mjs';
+export { W as WSMessage, a as WSPeer, c as createCrossWS, d as defineWebSocketAdapter } from './shared/crossws.a6b0a7cc.mjs';
+export { W as WebSocketError } from './shared/crossws.6f7f02b3.mjs';
 
 function defineWebSocketHooks(hooks) {
   return hooks;

package/dist/shared/crossws.6009d265.cjs

@@ -0,0 +1,156 @@
+'use strict';
+
+function defineWebSocketAdapter(factory) {
+  return factory;
+}
+
+function createCrossWS(hooks, options) {
+  const _callHook = options.resolve ? async function(name, info, ...args) {
+    const hooks2 = await options.resolve?.(info);
+    const hook = hooks2?.[name];
+    return hook?.(info, ...args);
+  } : void 0;
+  return {
+    async $(name, ...args) {
+      await Promise.all([hooks.$?.(name, ...args), _callHook?.(name, ...args)]);
+    },
+    async upgrade(req) {
+      const upgradeResults = await Promise.all([
+        hooks.upgrade?.(req),
+        _callHook?.("upgrade", req)
+      ]);
+      const headers = /* @__PURE__ */ Object.create(null);
+      for (const result of upgradeResults) {
+        if (result?.headers) {
+          Object.assign(headers, result.headers);
+        }
+      }
+      return { headers };
+    },
+    async message(peer, message) {
+      await Promise.all([
+        hooks.message?.(peer, message),
+        _callHook?.("message", peer, message)
+      ]);
+    },
+    async open(peer) {
+      await Promise.all([hooks.open?.(peer), _callHook?.("open", peer)]);
+    },
+    async close(peer, { code, reason }) {
+      await Promise.all([
+        hooks.close?.(peer, { code, reason }),
+        _callHook?.("close", peer, { code, reason })
+      ]);
+    },
+    async error(peer, error) {
+      await Promise.all([
+        hooks.error?.(peer, error),
+        _callHook?.("error", peer, error)
+      ]);
+    }
+  };
+}
+
+function toBufferLike(val) {
+  if (val === void 0 || val === null) {
+    return "";
+  }
+  if (typeof val === "string") {
+    return val;
+  }
+  if (isPlainObject(val)) {
+    return JSON.stringify(val);
+  }
+  return val;
+}
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object") {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
+    return false;
+  }
+  if (Symbol.iterator in value) {
+    return false;
+  }
+  if (Symbol.toStringTag in value) {
+    return Object.prototype.toString.call(value) === "[object Module]";
+  }
+  return true;
+}
+
+class WSMessage {
+  constructor(rawData, isBinary) {
+    this.rawData = rawData;
+    this.isBinary = isBinary;
+  }
+  text() {
+    if (typeof this.rawData === "string") {
+      return this.rawData;
+    }
+    const buff = toBufferLike(this.rawData);
+    if (typeof buff === "string") {
+      return buff;
+    }
+    return new TextDecoder().decode(buff);
+  }
+  toString() {
+    return this.text();
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.text();
+  }
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const ReadyStateMap = {
+  "-1": "unknown",
+  0: "connecting",
+  1: "open",
+  2: "closing",
+  3: "closed"
+};
+class WSPeer {
+  constructor(ctx) {
+    this.ctx = ctx;
+    __publicField(this, "_subscriptions", /* @__PURE__ */ new Set());
+  }
+  get id() {
+    return "??";
+  }
+  get url() {
+    return "/";
+  }
+  get headers() {
+    return {};
+  }
+  get readyState() {
+    return -1;
+  }
+  publish(topic, message, options) {
+  }
+  subscribe(topic) {
+    this._subscriptions.add(topic);
+  }
+  unsubscribe(topic) {
+    this._subscriptions.delete(topic);
+  }
+  toString() {
+    return `${this.id || ""}${this.readyState === 1 || this.readyState === -1 ? "" : ` [${ReadyStateMap[this.readyState]}]`}`;
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.toString();
+  }
+}
+
+exports.WSMessage = WSMessage;
+exports.WSPeer = WSPeer;
+exports.createCrossWS = createCrossWS;
+exports.defineWebSocketAdapter = defineWebSocketAdapter;
+exports.toBufferLike = toBufferLike;

package/dist/shared/crossws.6f7f02b3.mjs

@@ -0,0 +1,8 @@
+class WebSocketError extends Error {
+  constructor(...args) {
+    super(...args);
+    this.name = "WebSocketError";
+  }
+}
+
+export { WebSocketError as W };

package/dist/shared/crossws.a6b0a7cc.mjs

@@ -0,0 +1,150 @@
+function defineWebSocketAdapter(factory) {
+  return factory;
+}
+
+function createCrossWS(hooks, options) {
+  const _callHook = options.resolve ? async function(name, info, ...args) {
+    const hooks2 = await options.resolve?.(info);
+    const hook = hooks2?.[name];
+    return hook?.(info, ...args);
+  } : void 0;
+  return {
+    async $(name, ...args) {
+      await Promise.all([hooks.$?.(name, ...args), _callHook?.(name, ...args)]);
+    },
+    async upgrade(req) {
+      const upgradeResults = await Promise.all([
+        hooks.upgrade?.(req),
+        _callHook?.("upgrade", req)
+      ]);
+      const headers = /* @__PURE__ */ Object.create(null);
+      for (const result of upgradeResults) {
+        if (result?.headers) {
+          Object.assign(headers, result.headers);
+        }
+      }
+      return { headers };
+    },
+    async message(peer, message) {
+      await Promise.all([
+        hooks.message?.(peer, message),
+        _callHook?.("message", peer, message)
+      ]);
+    },
+    async open(peer) {
+      await Promise.all([hooks.open?.(peer), _callHook?.("open", peer)]);
+    },
+    async close(peer, { code, reason }) {
+      await Promise.all([
+        hooks.close?.(peer, { code, reason }),
+        _callHook?.("close", peer, { code, reason })
+      ]);
+    },
+    async error(peer, error) {
+      await Promise.all([
+        hooks.error?.(peer, error),
+        _callHook?.("error", peer, error)
+      ]);
+    }
+  };
+}
+
+function toBufferLike(val) {
+  if (val === void 0 || val === null) {
+    return "";
+  }
+  if (typeof val === "string") {
+    return val;
+  }
+  if (isPlainObject(val)) {
+    return JSON.stringify(val);
+  }
+  return val;
+}
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object") {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
+    return false;
+  }
+  if (Symbol.iterator in value) {
+    return false;
+  }
+  if (Symbol.toStringTag in value) {
+    return Object.prototype.toString.call(value) === "[object Module]";
+  }
+  return true;
+}
+
+class WSMessage {
+  constructor(rawData, isBinary) {
+    this.rawData = rawData;
+    this.isBinary = isBinary;
+  }
+  text() {
+    if (typeof this.rawData === "string") {
+      return this.rawData;
+    }
+    const buff = toBufferLike(this.rawData);
+    if (typeof buff === "string") {
+      return buff;
+    }
+    return new TextDecoder().decode(buff);
+  }
+  toString() {
+    return this.text();
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.text();
+  }
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const ReadyStateMap = {
+  "-1": "unknown",
+  0: "connecting",
+  1: "open",
+  2: "closing",
+  3: "closed"
+};
+class WSPeer {
+  constructor(ctx) {
+    this.ctx = ctx;
+    __publicField(this, "_subscriptions", /* @__PURE__ */ new Set());
+  }
+  get id() {
+    return "??";
+  }
+  get url() {
+    return "/";
+  }
+  get headers() {
+    return {};
+  }
+  get readyState() {
+    return -1;
+  }
+  publish(topic, message, options) {
+  }
+  subscribe(topic) {
+    this._subscriptions.add(topic);
+  }
+  unsubscribe(topic) {
+    this._subscriptions.delete(topic);
+  }
+  toString() {
+    return `${this.id || ""}${this.readyState === 1 || this.readyState === -1 ? "" : ` [${ReadyStateMap[this.readyState]}]`}`;
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return this.toString();
+  }
+}
+
+export { WSMessage as W, WSPeer as a, createCrossWS as c, defineWebSocketAdapter as d, toBufferLike as t };

package/dist/shared/crossws.deae10fd.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+class WebSocketError extends Error {
+  constructor(...args) {
+    super(...args);
+    this.name = "WebSocketError";
+  }
+}
+
+exports.WebSocketError = WebSocketError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crossws",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers",
   "repository": "unjs/crossws",
   "license": "MIT",
@@ -49,6 +49,11 @@
       "types": "./dist/adapters/node.d.ts",
       "import": "./dist/adapters/node.mjs",
       "require": "./dist/adapters/node.cjs"
+    },
+    "./adapters/uws": {
+      "types": "./dist/adapters/uws.d.ts",
+      "import": "./dist/adapters/uws.mjs",
+      "require": "./dist/adapters/uws.cjs"
     }
   },
   "main": "./dist/index.cjs",
@@ -61,28 +66,37 @@
   ],
   "scripts": {
     "build": "unbuild",
-    "play:node": "jiti playground/node.ts",
-    "play:bun": "bun playground/bun.ts",
-    "play:deno": "deno run -A playground/deno.ts",
-    "play:cf": "wrangler dev --port 3001",
+    "dev": "pnpm play:node",
     "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src",
     "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src -w",
     "prepack": "pnpm run build",
-    "release": "pnpm test && changelogen --release && npm publish && git push --follow-tags",
+    "play:bun": "bun playground/bun.ts",
+    "play:cf": "wrangler dev --port 3001",
+    "play:deno": "deno run --unstable-sloppy-imports -A playground/deno.ts",
+    "play:node": "jiti playground/node.ts",
+    "play:uws": "jiti playground/uws.ts",
+    "release": "pnpm test && pnpm build && changelogen --release && npm publish && git push --follow-tags",
     "test": "pnpm lint && pnpm test:types",
     "test:types": "tsc --noEmit --skipLibCheck"
   },
+  "resolutions": {
+    "crossws": "workspace:*"
+  },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20240117.0",
+    "@deno/types": "^0.0.1",
     "@types/bun": "^1.0.4",
     "@types/node": "^20.11.10",
     "@types/web": "^0.0.135",
     "@types/ws": "^8.5.10",
+    "automd": "^0.3.6",
     "changelogen": "^0.5.5",
     "consola": "^3.2.3",
     "eslint": "^8.56.0",
     "eslint-config-unjs": "^0.2.1",
+    "h3": "^1.10.1",
     "jiti": "^1.21.0",
+    "listhen": "^1.6.0",
     "prettier": "^3.2.4",
     "typescript": "^5.3.3",
     "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.33.0",
@@ -90,5 +104,13 @@
     "wrangler": "^3.25.0",
     "ws": "^8.16.0"
   },
+  "peerDependencies": {
+    "uWebSockets.js": "*"
+  },
+  "peerDependenciesMeta": {
+    "uWebSockets.js": {
+      "optional": true
+    }
+  },
   "packageManager": "pnpm@8.15.0"
 }