typeferry 0.6.0

package/dist/server/transports/websocket-transport.js

@@ -0,0 +1,174 @@
+import { WebSocketServer } from 'ws';
+import { TYPEFERRY_WS_PATH, isPongMessage, isRpcMessage, isRpcVoidMessage, Presentation, ServerEvents, } from '../../utils/index.js';
+import { ClientNode } from '../client-node.js';
+import { RoomRegistry } from '../room-registry.js';
+import { SocketState } from '../types.js';
+import { PING_INTERVAL_MS, PING_PAYLOAD, authenticateNode, handleRpc, handleRpcVoid, parseMeta, validateUuid, } from './ws-shared.js';
+export var WebSocketTransportEvents;
+(function (WebSocketTransportEvents) {
+    WebSocketTransportEvents["WEBSOCKET_SERVER_ERROR"] = "websocket:server:error";
+})(WebSocketTransportEvents || (WebSocketTransportEvents = {}));
+const UPGRADE_NOT_FOUND_RESPONSE = 'HTTP/1.1 404 Not Found\r\nConnection: close\r\nContent-Length: 0\r\n\r\n';
+const UPGRADE_FORBIDDEN_RESPONSE = 'HTTP/1.1 403 Forbidden\r\nConnection: close\r\nContent-Length: 0\r\n\r\n';
+/**
+ * Node.js WebSocket transport using the `ws` package.
+ */
+export class WebSocketTransport {
+    server;
+    wss;
+    rooms = new RoomRegistry();
+    path;
+    origins;
+    handshakeAuthenticator;
+    pingTimers = new Map();
+    pongReceived = new Map();
+    constructor(server, origins, opts) {
+        this.server = server;
+        this.path = opts?.path ?? TYPEFERRY_WS_PATH;
+        this.origins = origins?.length ? new Set(origins) : null;
+        this.handshakeAuthenticator = opts?.handshakeAuthenticator;
+        this.wss = new WebSocketServer({ noServer: true });
+        this.wss.on('error', (error) => server.emit(WebSocketTransportEvents.WEBSOCKET_SERVER_ERROR, error));
+        this.attachUpgradeHandler();
+    }
+    attachUpgradeHandler() {
+        const httpTransport = this.server.httpTransport;
+        if (!httpTransport.http) {
+            throw new Error('HTTP transport must exist before WebSocket attachment');
+        }
+        httpTransport.http.on('upgrade', (req, socket, head) => {
+            const url = new URL(req.url ?? '', 'http://localhost');
+            if (url.pathname !== this.path) {
+                this.rejectUpgrade(socket, UPGRADE_NOT_FOUND_RESPONSE);
+                return;
+            }
+            if (!this.server.acceptConnections) {
+                socket.destroy();
+                return;
+            }
+            if (!this.validateOrigin(req)) {
+                this.rejectUpgrade(socket, UPGRADE_FORBIDDEN_RESPONSE);
+                return;
+            }
+            this.wss.handleUpgrade(req, socket, head, ws => {
+                this.handleConnection(ws, req);
+            });
+        });
+    }
+    /** Flushes the HTTP rejection and then closes both halves of the raw socket. */
+    rejectUpgrade(socket, response) {
+        socket.end(response, () => socket.destroy());
+    }
+    validateOrigin(req) {
+        if (!this.origins)
+            return true;
+        const origin = req.headers.origin;
+        if (!origin)
+            return true;
+        return this.origins.has(origin);
+    }
+    handleConnection(ws, req) {
+        const url = new URL(req.url ?? '', 'http://localhost');
+        const uuid = validateUuid(url.searchParams.get('uuid'));
+        const token = url.searchParams.get('token') ?? undefined;
+        const meta = parseMeta(url.searchParams.get('meta'));
+        const handshake = {
+            path: url.pathname,
+            headers: Object.fromEntries(Object.entries(req.headers).flatMap(([name, value]) => {
+                if (typeof value === 'string')
+                    return [[name, value]];
+                if (Array.isArray(value))
+                    return [[name, value.join(', ')]];
+                return [];
+            })),
+            query: Object.fromEntries(url.searchParams.entries()),
+        };
+        const node = new ClientNode(this.server, ws, undefined, undefined, this.server.rateLimit);
+        node.setId(uuid);
+        node.meta = meta;
+        node.setTrackingProperties(req);
+        this.server.addClient(node);
+        this.server.emit(ServerEvents.CONNECTION, node);
+        ws.on('message', (raw) => {
+            this.handleMessage(node, raw);
+        });
+        ws.on('close', () => {
+            this.stopPing(ws);
+            this.rooms.leaveAll(ws);
+            node.close();
+            this.server.deleteClient(node);
+        });
+        ws.on('error', (error) => {
+            this.server.emit(ServerEvents.SOCKET_ERROR, ws, error);
+        });
+        this.startPing(ws);
+        authenticateNode(this.server, node, token, this.handshakeAuthenticator, handshake);
+    }
+    handleMessage(node, raw) {
+        try {
+            const text = typeof raw === 'string' ? raw : raw.toString('utf8');
+            const msg = Presentation.decode(text);
+            if (isRpcMessage(msg)) {
+                handleRpc(this.server, node, msg.id, msg.method, msg.params);
+            }
+            else if (isRpcVoidMessage(msg)) {
+                handleRpcVoid(this.server, node, msg.method, msg.params);
+            }
+            else if (isPongMessage(msg) && node.socket) {
+                this.pongReceived.set(node.socket, true);
+            }
+        }
+        catch {
+            // Malformed message — ignore
+        }
+    }
+    // ---------------------------------------------------------------------------
+    // Ping / Pong keep-alive
+    // ---------------------------------------------------------------------------
+    startPing(ws) {
+        this.pongReceived.set(ws, true);
+        const timer = setInterval(() => {
+            if (!this.pongReceived.get(ws)) {
+                ws.terminate();
+                return;
+            }
+            this.pongReceived.set(ws, false);
+            if (ws.readyState === SocketState.OPEN) {
+                ws.send(PING_PAYLOAD);
+            }
+        }, PING_INTERVAL_MS);
+        this.pingTimers.set(ws, timer);
+        ws.on('pong', () => {
+            this.pongReceived.set(ws, true);
+        });
+    }
+    stopPing(ws) {
+        const timer = this.pingTimers.get(ws);
+        if (timer) {
+            clearInterval(timer);
+            this.pingTimers.delete(ws);
+        }
+        this.pongReceived.delete(ws);
+    }
+    close() {
+        return new Promise((resolve, reject) => {
+            for (const [ws, timer] of this.pingTimers) {
+                clearInterval(timer);
+                if (ws.readyState === SocketState.OPEN)
+                    ws.close();
+            }
+            this.pingTimers.clear();
+            this.pongReceived.clear();
+            this.wss.close(error => {
+                if (error &&
+                    error.code !== 'ERR_SERVER_NOT_RUNNING' &&
+                    error.message !== 'The server is not running') {
+                    reject(error);
+                    return;
+                }
+                resolve();
+            });
+        });
+    }
+}
+//# sourceMappingURL=websocket-transport.js.map

package/dist/server/transports/websocket-transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-transport.js","sourceRoot":"","sources":["../../../src/server/transports/websocket-transport.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAA;AAEpC,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAGtC,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,SAAS,EAGT,YAAY,GACb,MAAM,aAAa,CAAA;AAOpB,MAAM,CAAN,IAAY,wBAEX;AAFD,WAAY,wBAAwB;IAClC,6EAAiD,CAAA;AACnD,CAAC,EAFW,wBAAwB,KAAxB,wBAAwB,QAEnC;AAED,MAAM,0BAA0B,GAC9B,0EAA0E,CAAA;AAC5E,MAAM,0BAA0B,GAC9B,0EAA0E,CAAA;AAc5E;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC7B,MAAM,CAAQ;IACd,GAAG,CAAiB;IACpB,KAAK,GAAG,IAAI,YAAY,EAAE,CAAA;IAElB,IAAI,CAAQ;IACZ,OAAO,CAAoB;IAC3B,sBAAsB,CAAkC;IACxD,UAAU,GAAG,IAAI,GAAG,EAAmD,CAAA;IACvE,YAAY,GAAG,IAAI,GAAG,EAA4B,CAAA;IAE1D,YACE,MAAc,EACd,OAA6B,EAC7B,IAAgC;QAEhC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,iBAAiB,CAAA;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACxD,IAAI,CAAC,sBAAsB,GAAG,IAAI,EAAE,sBAAsB,CAAA;QAE1D,IAAI,CAAC,GAAG,GAAG,IAAI,eAAe,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE,CACpC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,sBAAsB,EAAE,KAAK,CAAC,CACpE,CAAA;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC7B,CAAC;IAEO,oBAAoB;QAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,aAAkC,CAAA;QACpE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;QAC1E,CAAC;QACD,aAAa,CAAC,IAAI,CAAC,EAAE,CACnB,SAAS,EACT,CAAC,GAAyB,EAAE,MAAc,EAAE,IAAY,EAAE,EAAE;YAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAA;YAEtD,IAAI,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC/B,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;gBACtD,OAAM;YACR,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBACnC,MAAM,CAAC,OAAO,EAAE,CAAA;gBAChB,OAAM;YACR,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;gBACtD,OAAM;YACR,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE;gBAC7C,IAAI,CAAC,gBAAgB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;YAChC,CAAC,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;IACH,CAAC;IAED,gFAAgF;IACxE,aAAa,CAAC,MAAc,EAAE,QAAgB;QACpD,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAC9C,CAAC;IAEO,cAAc,CAAC,GAAyB;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAA;QAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAA;QACjC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IAEO,gBAAgB,CAAC,EAAa,EAAE,GAAyB;QAC/D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAA;QAEtD,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;QACvD,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,SAAS,CAAA;QACxD,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;QACpD,MAAM,SAAS,GAAuB;YACpC,IAAI,EAAE,GAAG,CAAC,QAAQ;YAClB,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;gBACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;oBAAE,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;gBACrD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBAC3D,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CACH;YACD,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;SACtD,CAAA;QAED,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,IAAI,CAAC,MAAM,EACX,EAAE,EACF,SAAS,EACT,SAAS,EACT,IAAI,CAAC,MAAM,CAAC,SAAS,CACtB,CAAA;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;QAE/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAE/C,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAoB,EAAE,EAAE;YACxC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACjB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACvB,IAAI,CAAC,KAAK,EAAE,CAAA;YACZ,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;QAClB,gBAAgB,CACd,IAAI,CAAC,MAAM,EACX,IAAI,EACJ,KAAK,EACL,IAAI,CAAC,sBAAsB,EAC3B,SAAS,CACV,CAAA;IACH,CAAC;IAEO,aAAa,CAAC,IAAgB,EAAE,GAAoB;QAC1D,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YACjE,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAgB,IAAI,CAAC,CAAA;YAEpD,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;YAC1D,CAAC;iBAAM,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YAC1C,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,6BAA6B;QAC/B,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,yBAAyB;IACzB,8EAA8E;IAEtE,SAAS,CAAC,EAAa;QAC7B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAE/B,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC/B,EAAE,CAAC,SAAS,EAAE,CAAA;gBACd,OAAM;YACR,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;YAEhC,IAAI,EAAE,CAAC,UAAU,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;gBACvC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACvB,CAAC;QACH,CAAC,EAAE,gBAAgB,CAAC,CAAA;QAEpB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;QAE9B,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,QAAQ,CAAC,EAAa;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,aAAa,CAAC,KAAK,CAAC,CAAA;YACpB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC5B,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC9B,CAAC;IAED,KAAK;QACH,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC1C,aAAa,CAAC,KAAK,CAAC,CAAA;gBACpB,IAAI,EAAE,CAAC,UAAU,KAAK,WAAW,CAAC,IAAI;oBAAE,EAAE,CAAC,KAAK,EAAE,CAAA;YACpD,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;YACvB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;YAEzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACrB,IACE,KAAK;oBACJ,KAA+B,CAAC,IAAI,KAAK,wBAAwB;oBAClE,KAAK,CAAC,OAAO,KAAK,2BAA2B,EAC7C,CAAC;oBACD,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;gBACR,CAAC;gBACD,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/server/transports/ws-shared.d.ts

@@ -0,0 +1,37 @@
+import type { ClientNode } from '../client-node.js';
+import type { Server } from '../server.js';
+export declare const AUTH_TIMEOUT_MS = 5000;
+export declare const MAX_UUID_LENGTH = 64;
+export declare const MAX_META_SIZE = 10000;
+export declare const PING_INTERVAL_MS = 25000;
+/** Pre-encoded ping payload — avoids EJSON.stringify on every tick. */
+export declare const PING_PAYLOAD: string;
+/**
+ * Framework-neutral metadata exposed to an application handshake authenticator.
+ */
+export interface WebSocketHandshake {
+    readonly path: string;
+    readonly headers: Readonly<Record<string, string>>;
+    readonly query: Readonly<Record<string, string>>;
+}
+/**
+ * Optional application-owned authentication for an admitted WebSocket.
+ */
+export type WebSocketHandshakeAuthenticator = (node: ClientNode, handshake: WebSocketHandshake) => unknown | Promise<unknown>;
+/** Handles an RPC call and sends the response correlated by `id`. */
+export declare function handleRpc(server: Server, node: ClientNode, id: string, method: string, params?: unknown): Promise<void>;
+/** Handles fire-and-forget RPC calls (no response sent). */
+export declare function handleRpcVoid(server: Server, node: ClientNode, method: string, params?: unknown): Promise<void>;
+/** Sends a correlated RPC response to the client. */
+export declare function sendResponse(node: ClientNode, id: string, result?: unknown, error?: string, errors?: unknown): void;
+/**
+ * Authenticates a node after connection. Guards against the node
+ * disconnecting during the async auth call.
+ */
+export declare function authenticateNode(server: Server, node: ClientNode, token: string | undefined, handshakeAuthenticator?: WebSocketHandshakeAuthenticator, handshake?: WebSocketHandshake): Promise<void>;
+/** Validates and sanitizes a UUID from the client query string. */
+export declare function validateUuid(uuid: unknown): string;
+/** Validates and sanitizes a meta object. */
+export declare function validateMeta(meta: unknown): Record<string, unknown>;
+/** Parses meta from a query string value (JSON-encoded in the URL). */
+export declare function parseMeta(raw: string | null): Record<string, unknown>;

package/dist/server/transports/ws-shared.js

@@ -0,0 +1,188 @@
+/**
+ * Shared WebSocket transport logic used by both the ws-based and
+ * Shared WebSocket protocol helpers, kept separate from listener lifecycle.
+ */
+import { Errors, MessageType, Presentation, PublicError, SchemaValidationError, ServerEvents, } from '../../utils/index.js';
+import { redactMethodTelemetry } from '../method.js';
+import { SocketState } from '../types.js';
+export const AUTH_TIMEOUT_MS = 5000;
+export const MAX_UUID_LENGTH = 64;
+export const MAX_META_SIZE = 10000;
+export const PING_INTERVAL_MS = 25000;
+/** Pre-encoded ping payload — avoids EJSON.stringify on every tick. */
+export const PING_PAYLOAD = Presentation.encode({ t: MessageType.PING });
+// ---------------------------------------------------------------------------
+// RPC handling
+// ---------------------------------------------------------------------------
+/** Handles an RPC call and sends the response correlated by `id`. */
+export async function handleRpc(server, node, id, method, params) {
+    if (node.limiter && !node.limiter.tryRemoveTokens(1)) {
+        return sendResponse(node, id, undefined, Errors.RATE_LIMIT_EXCEEDED);
+    }
+    const methodInstance = server.methods.get(method);
+    if (!methodInstance) {
+        return sendResponse(node, id, undefined, Errors.METHOD_NOT_FOUND);
+    }
+    if (methodInstance.isProtected && !node.authenticated) {
+        return sendResponse(node, id, undefined, Errors.METHOD_FORBIDDEN);
+    }
+    try {
+        const result = await methodInstance.exec(params, node);
+        sendResponse(node, id, result);
+    }
+    catch (error) {
+        handleRpcError(server, node, methodInstance, error, id, method, params);
+    }
+}
+/** Handles fire-and-forget RPC calls (no response sent). */
+export async function handleRpcVoid(server, node, method, params) {
+    if (node.limiter && !node.limiter.tryRemoveTokens(1)) {
+        console.warn('[TypeFerry] Rate limit exceeded for void call:', method);
+        return;
+    }
+    const methodInstance = server.methods.get(method);
+    if (!methodInstance) {
+        console.warn('[TypeFerry] Method not found for void call:', method);
+        return;
+    }
+    if (methodInstance.isProtected && !node.authenticated) {
+        console.warn('[TypeFerry] Method forbidden for void call:', method);
+        return;
+    }
+    try {
+        await methodInstance.exec(params, node);
+    }
+    catch (error) {
+        if (methodInstance.isSensitive) {
+            console.error(`[TypeFerry] Sensitive void method "${method}" failed`);
+        }
+        else {
+            console.error('[TypeFerry] Void method execution error:', error);
+        }
+        server.emit(ServerEvents.METHOD_ERROR, {
+            error: redactMethodTelemetry(methodInstance, error),
+            method,
+            params: redactMethodTelemetry(methodInstance, params),
+            userId: node.userId,
+            userEmail: node.context?.user?.email,
+            remoteAddress: node.remoteAddress,
+            userAgent: node.userAgent,
+        });
+    }
+}
+/** Sends a correlated RPC response to the client. */
+export function sendResponse(node, id, result, error, errors) {
+    if (!node.socket || node.socket.readyState !== SocketState.OPEN)
+        return;
+    const payload = {
+        t: MessageType.RPC_RESPONSE,
+        id,
+    };
+    if (error) {
+        payload.error = error;
+        if (errors)
+            payload.errors = errors;
+    }
+    else {
+        payload.result = result;
+    }
+    node.socket.send(Presentation.encode(payload));
+}
+function handleRpcError(server, node, methodInstance, error, id, method, params) {
+    if (error instanceof PublicError) {
+        return sendResponse(node, id, undefined, error.message);
+    }
+    if (methodInstance.isSensitive) {
+        console.error(`[TypeFerry] Sensitive method "${method}" failed`);
+    }
+    else {
+        console.error(error);
+    }
+    server.emit(ServerEvents.METHOD_ERROR, {
+        error: redactMethodTelemetry(methodInstance, error),
+        method,
+        params: redactMethodTelemetry(methodInstance, params),
+        userId: node.userId,
+        userEmail: node.context?.user?.email,
+        remoteAddress: node.remoteAddress,
+        userAgent: node.userAgent,
+    });
+    if (error instanceof SchemaValidationError) {
+        return sendResponse(node, id, undefined, error.message, error.errors);
+    }
+    sendResponse(node, id, undefined, Errors.INTERNAL_ERROR);
+}
+// ---------------------------------------------------------------------------
+// Authentication
+// ---------------------------------------------------------------------------
+/**
+ * Authenticates a node after connection. Guards against the node
+ * disconnecting during the async auth call.
+ */
+export async function authenticateNode(server, node, token, handshakeAuthenticator, handshake) {
+    if (!handshakeAuthenticator && (!server.isAuthEnabled || !token)) {
+        node.emitAuthResult(false);
+        return;
+    }
+    try {
+        const authPromise = handshakeAuthenticator
+            ? Promise.resolve(handshakeAuthenticator(node, handshake ?? { path: '', headers: {}, query: {} }))
+            : server.auth.call(node, { token });
+        const timeoutPromise = new Promise((_, reject) => setTimeout(() => reject(new Error('Auth timeout')), AUTH_TIMEOUT_MS));
+        const result = await Promise.race([authPromise, timeoutPromise]);
+        if (!node.socket || node.socket.readyState !== SocketState.OPEN)
+            return;
+        if (result) {
+            node.authenticated = true;
+            node.setContext(result);
+            server.emit(ServerEvents.AUTHENTICATION, node);
+        }
+        node.emitAuthResult(node.authenticated);
+    }
+    catch (error) {
+        console.error('[TypeFerry] Auth error:', error);
+        if (node.socket?.readyState === SocketState.OPEN) {
+            node.emitAuthResult(false);
+        }
+    }
+}
+// ---------------------------------------------------------------------------
+// Connection parameter validation
+// ---------------------------------------------------------------------------
+/** Validates and sanitizes a UUID from the client query string. */
+export function validateUuid(uuid) {
+    if (typeof uuid !== 'string' ||
+        uuid.length === 0 ||
+        uuid.length > MAX_UUID_LENGTH) {
+        return (crypto.randomUUID?.() ??
+            `${Date.now()}-${Math.random().toString(36).slice(2)}`);
+    }
+    return uuid.replace(/[^a-zA-Z0-9-]/g, '').slice(0, MAX_UUID_LENGTH);
+}
+/** Validates and sanitizes a meta object. */
+export function validateMeta(meta) {
+    if (!meta || typeof meta !== 'object' || Array.isArray(meta))
+        return {};
+    try {
+        if (JSON.stringify(meta).length > MAX_META_SIZE) {
+            console.warn('[TypeFerry] Meta object too large, ignoring');
+            return {};
+        }
+    }
+    catch {
+        return {};
+    }
+    return meta;
+}
+/** Parses meta from a query string value (JSON-encoded in the URL). */
+export function parseMeta(raw) {
+    if (!raw)
+        return {};
+    try {
+        return validateMeta(JSON.parse(raw));
+    }
+    catch {
+        return {};
+    }
+}
+//# sourceMappingURL=ws-shared.js.map

package/dist/server/transports/ws-shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-shared.js","sourceRoot":"","sources":["../../../src/server/transports/ws-shared.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,MAAM,EACN,WAAW,EACX,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,YAAY,GACb,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,qBAAqB,EAAe,MAAM,WAAW,CAAA;AAE9D,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEtC,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAA;AACnC,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAA;AACjC,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAA;AAClC,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAA;AAErC,uEAAuE;AACvE,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;AAmBxE,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAc,EACd,IAAgB,EAChB,EAAU,EACV,MAAc,EACd,MAAgB;IAEhB,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAA;IACtE,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEjD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACnE,CAAC;IAED,IAAI,cAAc,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACtD,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACnE,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACtD,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACzE,CAAC;AACH,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAc,EACd,IAAgB,EAChB,MAAc,EACd,MAAgB;IAEhB,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,CAAA;QACtE,OAAM;IACR,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEjD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,MAAM,CAAC,CAAA;QACnE,OAAM;IACR,CAAC;IAED,IAAI,cAAc,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACtD,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,MAAM,CAAC,CAAA;QACnE,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,sCAAsC,MAAM,UAAU,CAAC,CAAA;QACvE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;QAClE,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;YACrC,KAAK,EAAE,qBAAqB,CAAC,cAAc,EAAE,KAAK,CAAC;YACnD,MAAM;YACN,MAAM,EAAE,qBAAqB,CAAC,cAAc,EAAE,MAAM,CAAC;YACrD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK;YACpC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,YAAY,CAC1B,IAAgB,EAChB,EAAU,EACV,MAAgB,EAChB,KAAc,EACd,MAAgB;IAEhB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,WAAW,CAAC,IAAI;QAAE,OAAM;IAEvE,MAAM,OAAO,GAA4B;QACvC,CAAC,EAAE,WAAW,CAAC,YAAY;QAC3B,EAAE;KACH,CAAA;IAED,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,KAAK,GAAG,KAAK,CAAA;QACrB,IAAI,MAAM;YAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAA;IACrC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,GAAG,MAAM,CAAA;IACzB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,cAAc,CACrB,MAAc,EACd,IAAgB,EAChB,cAAgC,EAChC,KAAc,EACd,EAAU,EACV,MAAc,EACd,MAAe;IAEf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;QACjC,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IACzD,CAAC;IAED,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,iCAAiC,MAAM,UAAU,CAAC,CAAA;IAClE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;QACrC,KAAK,EAAE,qBAAqB,CAAC,cAAc,EAAE,KAAK,CAAC;QACnD,MAAM;QACN,MAAM,EAAE,qBAAqB,CAAC,cAAc,EAAE,MAAM,CAAC;QACrD,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK;QACpC,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC,CAAA;IAEF,IAAI,KAAK,YAAY,qBAAqB,EAAE,CAAC;QAC3C,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACvE,CAAC;IAED,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,cAAc,CAAC,CAAA;AAC1D,CAAC;AAED,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAE9E;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAc,EACd,IAAgB,EAChB,KAAyB,EACzB,sBAAwD,EACxD,SAA8B;IAE9B,IAAI,CAAC,sBAAsB,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACjE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAC1B,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,sBAAsB;YACxC,CAAC,CAAC,OAAO,CAAC,OAAO,CACb,sBAAsB,CACpB,IAAI,EACJ,SAAS,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAClD,CACF;YACH,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACrC,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAC/C,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,EAAE,eAAe,CAAC,CACrE,CAAA;QAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAA;QAEhE,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,WAAW,CAAC,IAAI;YAAE,OAAM;QAEvE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;YACzB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACvB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAA;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,UAAU,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;YACjD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,kCAAkC;AAClC,8EAA8E;AAE9E,mEAAmE;AACnE,MAAM,UAAU,YAAY,CAAC,IAAa;IACxC,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,eAAe,EAC7B,CAAC;QACD,OAAO,CACL,MAAM,CAAC,UAAU,EAAE,EAAE;YACrB,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CACvD,CAAA;IACH,CAAC;IACD,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAA;AACrE,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,YAAY,CAAC,IAAa;IACxC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAA;IACvE,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;YAChD,OAAO,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAA;YAC3D,OAAO,EAAE,CAAA;QACX,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,IAA+B,CAAA;AACxC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,SAAS,CAAC,GAAkB;IAC1C,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAA;IACnB,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC"}

package/dist/server/typeferry-async-local-storage.d.ts

@@ -0,0 +1,5 @@
+import { AsyncLocalStorage } from 'async_hooks';
+/**
+ * https://nodejs.org/api/async_context.html
+ */
+export declare const TypeFerryAsyncLocalStorage: AsyncLocalStorage<unknown>;

package/dist/server/typeferry-async-local-storage.js

@@ -0,0 +1,6 @@
+import { AsyncLocalStorage } from 'async_hooks';
+/**
+ * https://nodejs.org/api/async_context.html
+ */
+export const TypeFerryAsyncLocalStorage = new AsyncLocalStorage();
+//# sourceMappingURL=typeferry-async-local-storage.js.map

package/dist/server/typeferry-async-local-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeferry-async-local-storage.js","sourceRoot":"","sources":["../../src/server/typeferry-async-local-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,iBAAiB,EAAE,CAAA"}

package/dist/server/types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * WebSocket readyState constants matching the W3C spec.
+ * Used instead of instance-level constants to keep the socket contract small.
+ */
+export declare const SocketState: {
+    readonly CONNECTING: 0;
+    readonly OPEN: 1;
+    readonly CLOSING: 2;
+    readonly CLOSED: 3;
+};
+/**
+ * Minimal WebSocket interface consumed by TypeFerry server components.
+ */
+export interface TypeFerrySocket {
+    readonly readyState: number;
+    /** Bytes accepted by the runtime but not yet flushed to the network. */
+    readonly bufferedAmount?: number;
+    send(data: string | Buffer): void;
+    close(code?: number, reason?: string): void;
+}
+/** Result of a direct server-to-client event send. */
+export interface TypeFerrySendState {
+    /** Whether the frame was accepted by an open socket. */
+    readonly accepted: boolean;
+    /** Native bytes waiting to flush after the send. */
+    readonly bufferedBytes: number;
+}

package/dist/server/types.js

@@ -0,0 +1,11 @@
+/**
+ * WebSocket readyState constants matching the W3C spec.
+ * Used instead of instance-level constants to keep the socket contract small.
+ */
+export const SocketState = {
+    CONNECTING: 0,
+    OPEN: 1,
+    CLOSING: 2,
+    CLOSED: 3,
+};
+//# sourceMappingURL=types.js.map

package/dist/server/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/server/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,CAAC;IACb,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;CACD,CAAA"}

package/dist/utils/constants.d.ts

@@ -0,0 +1,72 @@
+export declare enum TypeFerryEvents {
+    METHOD_REFRESH = "typeferry:method:refresh",
+    SERVER_SENT_EVENTS_CONNECTED = "server:sent:events:connected",
+    COMMIT_PENDING_SUBSCRIPTIONS = "commit:pending:subscriptions",
+    COMMIT_PENDING_UNSUBSCRIPTIONS = "commit:pending:unsubscriptions"
+}
+export declare enum WebSocketEvents {
+    OPEN = "open",
+    MESSAGE = "message",
+    CONNECTION = "connection",
+    CLOSE = "close",
+    ERROR = "error",
+    CONNECT = "connect",
+    DISCONNECT = "disconnect"
+}
+export declare enum ServerEvents {
+    AUTHENTICATION = "authentication",
+    LOGOUT = "logout",
+    UPGRADE = "upgrade",
+    REQUEST = "request",
+    HTTP_LISTENING = "http:listening",
+    WEBSOCKET_LISTENING = "websocket:listening",
+    CONNECTION = "connection",
+    DISCONNECTION = "disconnection",
+    DISCONNECT = "disconnect",
+    SOCKET_ERROR = "socket:error",
+    ERROR = "error",
+    REDIS_CONNECT = "redis:connect",
+    READY = "ready",
+    METHOD_EXECUTION = "method:execution",
+    METHOD_ERROR = "method:error",
+    CLOSED = "closed",
+    USER_DISCONNECTED = "user:disconnected"
+}
+export declare enum ClientEvents {
+    LOGOUT = "auth:logout",
+    ERROR = "error",
+    INITIALIZING = "initializing",
+    INITIALIZED = "initialized",
+    INITIALIZATION_FAILED = "initialization:failed",
+    INITIALIZATION_RETRY = "initialization:retry",
+    CONTEXT_CHANGED = "context:changed",
+    OUTBOUND_MESSAGE = "outbound:message",
+    INBOUND_MESSAGE = "inbound:message",
+    CONNECTING = "connecting",
+    WEBSOCKET_CONNECTED = "websocket:connected",
+    WEBSOCKET_CLOSED = "websocket:closed",
+    WEBSOCKET_RECONNECTING = "websocket:reconnecting",
+    CLOSE = "client:close"
+}
+export declare enum RedisListeners {
+    CONNECT = "connect",
+    EVENTS = "events",
+    MESSAGE = "message"
+}
+export declare const TYPEFERRY_WS_PATH = "/typeferry-ws";
+export declare const NO_CHANNEL = "NO_CHANNEL";
+export declare const CLIENT_ID_HEADER_KEY = "x-client-id";
+export declare const TOKEN_HEADER_KEY = "x-api-key";
+export declare enum Methods {
+    RPC_LOGIN = "rpc:login",
+    RPC_LOGOUT = "rpc:logout",
+    RPC_ON = "rpc:on",
+    RPC_OFF = "rpc:off",
+    LIST_METHODS = "list:methods"
+}
+export declare const WebSocketState: {
+    CONNECTING: number;
+    OPEN: number;
+    CLOSING: number;
+    CLOSED: number;
+};

package/dist/utils/constants.js

@@ -0,0 +1,79 @@
+export var TypeFerryEvents;
+(function (TypeFerryEvents) {
+    TypeFerryEvents["METHOD_REFRESH"] = "typeferry:method:refresh";
+    TypeFerryEvents["SERVER_SENT_EVENTS_CONNECTED"] = "server:sent:events:connected";
+    TypeFerryEvents["COMMIT_PENDING_SUBSCRIPTIONS"] = "commit:pending:subscriptions";
+    TypeFerryEvents["COMMIT_PENDING_UNSUBSCRIPTIONS"] = "commit:pending:unsubscriptions";
+})(TypeFerryEvents || (TypeFerryEvents = {}));
+export var WebSocketEvents;
+(function (WebSocketEvents) {
+    WebSocketEvents["OPEN"] = "open";
+    WebSocketEvents["MESSAGE"] = "message";
+    WebSocketEvents["CONNECTION"] = "connection";
+    WebSocketEvents["CLOSE"] = "close";
+    WebSocketEvents["ERROR"] = "error";
+    WebSocketEvents["CONNECT"] = "connect";
+    WebSocketEvents["DISCONNECT"] = "disconnect";
+})(WebSocketEvents || (WebSocketEvents = {}));
+export var ServerEvents;
+(function (ServerEvents) {
+    ServerEvents["AUTHENTICATION"] = "authentication";
+    ServerEvents["LOGOUT"] = "logout";
+    ServerEvents["UPGRADE"] = "upgrade";
+    ServerEvents["REQUEST"] = "request";
+    ServerEvents["HTTP_LISTENING"] = "http:listening";
+    ServerEvents["WEBSOCKET_LISTENING"] = "websocket:listening";
+    ServerEvents["CONNECTION"] = "connection";
+    ServerEvents["DISCONNECTION"] = "disconnection";
+    ServerEvents["DISCONNECT"] = "disconnect";
+    ServerEvents["SOCKET_ERROR"] = "socket:error";
+    ServerEvents["ERROR"] = "error";
+    ServerEvents["REDIS_CONNECT"] = "redis:connect";
+    ServerEvents["READY"] = "ready";
+    ServerEvents["METHOD_EXECUTION"] = "method:execution";
+    ServerEvents["METHOD_ERROR"] = "method:error";
+    ServerEvents["CLOSED"] = "closed";
+    ServerEvents["USER_DISCONNECTED"] = "user:disconnected";
+})(ServerEvents || (ServerEvents = {}));
+export var ClientEvents;
+(function (ClientEvents) {
+    ClientEvents["LOGOUT"] = "auth:logout";
+    ClientEvents["ERROR"] = "error";
+    ClientEvents["INITIALIZING"] = "initializing";
+    ClientEvents["INITIALIZED"] = "initialized";
+    ClientEvents["INITIALIZATION_FAILED"] = "initialization:failed";
+    ClientEvents["INITIALIZATION_RETRY"] = "initialization:retry";
+    ClientEvents["CONTEXT_CHANGED"] = "context:changed";
+    ClientEvents["OUTBOUND_MESSAGE"] = "outbound:message";
+    ClientEvents["INBOUND_MESSAGE"] = "inbound:message";
+    ClientEvents["CONNECTING"] = "connecting";
+    ClientEvents["WEBSOCKET_CONNECTED"] = "websocket:connected";
+    ClientEvents["WEBSOCKET_CLOSED"] = "websocket:closed";
+    ClientEvents["WEBSOCKET_RECONNECTING"] = "websocket:reconnecting";
+    ClientEvents["CLOSE"] = "client:close";
+})(ClientEvents || (ClientEvents = {}));
+export var RedisListeners;
+(function (RedisListeners) {
+    RedisListeners["CONNECT"] = "connect";
+    RedisListeners["EVENTS"] = "events";
+    RedisListeners["MESSAGE"] = "message";
+})(RedisListeners || (RedisListeners = {}));
+export const TYPEFERRY_WS_PATH = '/typeferry-ws';
+export const NO_CHANNEL = 'NO_CHANNEL';
+export const CLIENT_ID_HEADER_KEY = 'x-client-id';
+export const TOKEN_HEADER_KEY = 'x-api-key';
+export var Methods;
+(function (Methods) {
+    Methods["RPC_LOGIN"] = "rpc:login";
+    Methods["RPC_LOGOUT"] = "rpc:logout";
+    Methods["RPC_ON"] = "rpc:on";
+    Methods["RPC_OFF"] = "rpc:off";
+    Methods["LIST_METHODS"] = "list:methods";
+})(Methods || (Methods = {}));
+export const WebSocketState = {
+    CONNECTING: 0,
+    OPEN: 1,
+    CLOSING: 2,
+    CLOSED: 3,
+};
+//# sourceMappingURL=constants.js.map

package/dist/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,8DAA2C,CAAA;IAC3C,gFAA6D,CAAA;IAE7D,gFAA6D,CAAA;IAC7D,oFAAiE,CAAA;AACnE,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAN,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;AAC3B,CAAC,EARW,eAAe,KAAf,eAAe,QAQ1B;AAED,MAAM,CAAN,IAAY,YAkBX;AAlBD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;IACnB,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;IAC3C,yCAAyB,CAAA;IACzB,+CAA+B,CAAA;IAC/B,yCAAyB,CAAA;IACzB,6CAA6B,CAAA;IAC7B,+BAAe,CAAA;IACf,+CAA+B,CAAA;IAC/B,+BAAe,CAAA;IACf,qDAAqC,CAAA;IACrC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;IACjB,uDAAuC,CAAA;AACzC,CAAC,EAlBW,YAAY,KAAZ,YAAY,QAkBvB;AAED,MAAM,CAAN,IAAY,YAiBX;AAjBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,+BAAe,CAAA;IACf,6CAA6B,CAAA;IAC7B,2CAA2B,CAAA;IAC3B,+DAA+C,CAAA;IAC/C,6DAA6C,CAAA;IAC7C,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,mDAAmC,CAAA;IACnC,yCAAyB,CAAA;IAEzB,2DAA2C,CAAA;IAC3C,qDAAqC,CAAA;IACrC,iEAAiD,CAAA;IAEjD,sCAAsB,CAAA;AACxB,CAAC,EAjBW,YAAY,KAAZ,YAAY,QAiBvB;AAED,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;AACrB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAA;AAEhD,MAAM,CAAC,MAAM,UAAU,GAAG,YAAY,CAAA;AAEtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAAA;AACjD,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAA;AAE3C,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,kCAAuB,CAAA;IACvB,oCAAyB,CAAA;IACzB,4BAAiB,CAAA;IACjB,8BAAmB,CAAA;IACnB,wCAA6B,CAAA;AAC/B,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB;AAED,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,UAAU,EAAE,CAAC;IACb,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;CACV,CAAA"}

package/dist/utils/environment.d.ts

@@ -0,0 +1,8 @@
+export declare namespace Environment {
+    const isNode: boolean;
+    const isBrowser: boolean;
+    const isTest: boolean;
+    const isDevelopment: boolean;
+    const canUseDOM: boolean;
+    const isServer: boolean;
+}