@rlanz/socket 0.0.1-4 → 0.0.1-6

package/build/{types-BBLNfcWk.d.ts → types-DiYaFvgi.d.ts}

@@ -1,8 +1,8 @@
 import { WebSocket } from 'ws';
 import { IncomingMessage } from 'node:http';
 import { MiddlewareAsClass } from '@adonisjs/core/types/http';
+import { HttpContext } from '@adonisjs/core/http';
 import { TransportFactory } from '@boringnode/bus/types/main';
-import './shared_types-Dw9AphfO.js';
 
 declare const PRESENCE_DATA_KEY = "__rlanzSocketPresence";
 type PresenceSocketData = Record<string, unknown> & {
@@ -10,7 +10,6 @@ type PresenceSocketData = Record<string, unknown> & {
 };
 interface PresenceUser {
     id: string;
-    name: string;
     joinedAt: Date;
     [key: string]: unknown;
 }
@@ -33,11 +32,11 @@ declare class PresenceManager {
     /**
      * Sets the socket fetcher used to build distributed snapshots.
      */
-    setSocketFetcher(fetchSockets: (channel: string) => Promise<PresenceSocket[]>): void;
+    setSocketFetcher(fetchSockets: ((channel: string) => Promise<PresenceSocket[]>) | null): void;
     /**
      * Adds a user to a channel.
      */
-    join(channel: string, socket: PresenceSocket, member: string | PresenceMember): void;
+    join(channel: string, socket: PresenceSocket, member: PresenceInfo): PresenceUser;
     /**
      * Removes a user from a channel.
      */
@@ -59,6 +58,10 @@ declare class PresenceManager {
      * Checks whether a socket is locally present in a channel.
      */
     hasLocal(channel: string, socketId: string): boolean;
+    /**
+     * Gets the presence user retained for one local socket.
+     */
+    getLocalUser(channel: string, socketId: string): PresenceUser | undefined;
     /**
      * Lists every local channel where a socket is present.
      */
@@ -77,6 +80,11 @@ interface ChannelBroadcaster {
         };
     };
 }
+/**
+ * Error whose message may intentionally be returned to a socket client.
+ */
+declare class SocketResponseError extends Error {
+}
 /**
  * Abstract class used to define a channel.
  *
@@ -121,7 +129,9 @@ interface ChannelBroadcaster {
  * }
  * ```
  */
-declare class BaseChannel<User = unknown, Events extends ChannelEventMap = ChannelEventMap, HttpContext = unknown> {
+declare class BaseChannel<User = unknown, ServerEvents = unknown> {
+    /** Type-only server event declarations consumed by generated browser client types. */
+    readonly $serverEvents: ServerEvents;
     /**
      * URL-like channel pattern, for example: 'chat/:roomId'.
      */
@@ -133,12 +143,12 @@ declare class BaseChannel<User = unknown, Events extends ChannelEventMap = Chann
     /**
      * Middlewares to run before subscription.
      */
-    static middlewares?: Middleware<any, any>[];
+    static middlewares?: Middleware<any>[];
     /**
      * Event handler map.
      * Ex: { 'chat:send': 'handleSend' }
      */
-    protected handlers: ChannelHandlerMap<User, Events, HttpContext>;
+    protected handlers: ChannelHandlerMap<User>;
     /**
      * Injected socket service.
      */
@@ -162,58 +172,60 @@ declare class BaseChannel<User = unknown, Events extends ChannelEventMap = Chann
     /**
      * Emits to every channel member.
      */
-    protected broadcast(event: string, data: unknown): void;
+    protected broadcast<K extends unknown extends ServerEvents ? string : keyof ServerEvents & string>(event: K, data: unknown extends ServerEvents ? unknown : ServerEvents[K & keyof ServerEvents]): void;
     /**
      * Emits to every channel member except one socket.
      */
-    protected broadcastExcept(socketId: string, event: string, data: unknown): void;
+    protected broadcastExcept<K extends unknown extends ServerEvents ? string : keyof ServerEvents & string>(socketId: string, event: K, data: unknown extends ServerEvents ? unknown : ServerEvents[K & keyof ServerEvents]): void;
     /**
      * Runs the middleware chain.
      *
      * middleware[0] -> middleware[1] -> ... -> subscribe
      */
-    $runMiddlewares(ctx: MiddlewareContext<User, HttpContext>): Promise<void>;
+    $runMiddlewares(ctx: MiddlewareContext<User>): Promise<void>;
     /**
      * Returns member information for presence.
      * Implement when options.presence = true.
      */
-    getPresenceInfo?(socket: AuthenticatedSocket<User, HttpContext>): PresenceMember;
+    getPresenceInfo?(socket: AuthenticatedSocket<User>): PresenceInfo;
     /**
      * Hook called when a socket joins the channel.
      */
-    onJoin?(socket: AuthenticatedSocket<User, HttpContext>, ...params: string[]): Promise<void>;
+    onJoin?(socket: AuthenticatedSocket<User>, ...params: string[]): Promise<void>;
     /**
      * Hook called when a socket leaves the channel.
      */
-    onLeave?(socket: AuthenticatedSocket<User, HttpContext>, ...params: string[]): Promise<void>;
+    onLeave?(socket: AuthenticatedSocket<User>, ...params: string[]): Promise<void>;
     /**
      * Hook called when a message is received on the channel.
      * Used as fallback when no event handler matches.
      */
-    onMessage?(socket: AuthenticatedSocket<User, HttpContext>, event: string, data: unknown): Promise<void>;
+    onMessage?(socket: AuthenticatedSocket<User>, event: string, data: unknown): Promise<void>;
     /**
      * Hook called when a member joins a presence channel.
      */
-    onMemberJoin?(socket: AuthenticatedSocket<User, HttpContext>, member: PresenceMember, ...params: string[]): Promise<void>;
+    onMemberJoin?(socket: AuthenticatedSocket<User>, member: PresenceMember, ...params: string[]): Promise<void>;
     /**
      * Hook called when a member leaves a presence channel.
      */
-    onMemberLeave?(socket: AuthenticatedSocket<User, HttpContext>, member: PresenceMember, ...params: string[]): Promise<void>;
+    onMemberLeave?(socket: AuthenticatedSocket<User>, member: PresenceMember, ...params: string[]): Promise<void>;
     /**
      * Dispatches a message to the matching handler.
      * Called by SocketService. Do not override.
      */
-    $handleMessage(socket: AuthenticatedSocket<User, HttpContext>, event: string, data: unknown): Promise<unknown>;
+    $handleMessage(socket: AuthenticatedSocket<User>, event: string, data: unknown): Promise<unknown>;
     /**
      * Runs the generic join hook. ChannelSubscriptions owns subscription lifecycle.
      */
-    $handleJoin(socket: AuthenticatedSocket<User, HttpContext>, ...params: string[]): Promise<void>;
+    $handleJoin(socket: AuthenticatedSocket<User>, ...params: string[]): Promise<void>;
     /**
      * Runs the generic leave hook. ChannelSubscriptions owns subscription lifecycle.
      */
-    $handleLeave(socket: AuthenticatedSocket<User, HttpContext>, ...params: string[]): Promise<void>;
-    $getPresenceInfo(socket: AuthenticatedSocket<User, HttpContext>): PresenceMember;
+    $handleLeave(socket: AuthenticatedSocket<User>, ...params: string[]): Promise<void>;
+    $getPresenceInfo(socket: AuthenticatedSocket<User>): PresenceInfo;
 }
+/** Constructor for any BaseChannel specialization. */
+type BaseChannelConstructor = typeof BaseChannel<any, any>;
 
 /**
  * Duration can be specified as milliseconds or as a human-readable string.
@@ -229,17 +241,37 @@ interface SocketTransportConfig {
     presenceTimeout?: Duration;
 }
 
-interface RawSocket<HttpContext = unknown> {
+/**
+ * Types shared between the server and the client.
+ */
+/**
+ * Message sent by the client to a channel.
+ */
+interface ChannelMessage {
+    channel: string;
+    event: string;
+    data?: unknown;
+}
+/**
+ * Channel handler acknowledgement response.
+ */
+interface ChannelAck<T = unknown> {
+    ok: boolean;
+    data?: T;
+    error?: string;
+}
+
+interface RawSocket {
     id: string;
     data: Record<string, unknown>;
     connection: WebSocket;
     request: IncomingMessage;
-    httpContext?: HttpContext;
+    httpContext: HttpContext;
 }
 /**
  * Socket exposed to channels after the HTTP upgrade.
  */
-interface AuthenticatedSocket<User = unknown, HttpContext = unknown> {
+interface AuthenticatedSocket<User = unknown> {
     /**
      * Unique socket ID.
      */
@@ -249,9 +281,9 @@ interface AuthenticatedSocket<User = unknown, HttpContext = unknown> {
      */
     user: User | undefined;
     /**
-     * Channels this socket is subscribed to.
+     * Returns the authenticated user or throws a client-safe unauthorized error.
      */
-    channels: Set<string>;
+    getUserOrFail(): User;
     /**
      * Emits an event to this socket.
      */
@@ -271,14 +303,17 @@ interface AuthenticatedSocket<User = unknown, HttpContext = unknown> {
     /**
      * Raw WebSocket connection metadata.
      */
-    raw: RawSocket<HttpContext>;
+    raw: RawSocket;
 }
-interface SocketUpgradeContext<HttpContext = unknown> {
-    httpContext?: HttpContext;
+/**
+ * Short-lived context for preparing and authenticating a WebSocket upgrade.
+ * Socket-lifetime mutable state belongs in AuthenticatedSocket.raw.data.
+ */
+interface SocketUpgradeContext {
+    httpContext: HttpContext;
 }
 type SocketAuthenticationResult<User = unknown> = User | false | null;
-type SocketAuthenticationHandler<User = unknown, HttpContext = unknown> = (ctx: SocketUpgradeContext<HttpContext>) => SocketAuthenticationResult<User> | Promise<SocketAuthenticationResult<User>>;
-type SocketHttpContextFactory<HttpContext = unknown> = (request: IncomingMessage) => HttpContext | Promise<HttpContext>;
+type SocketAuthenticationHandler<User = unknown> = (ctx: SocketUpgradeContext) => SocketAuthenticationResult<User> | Promise<SocketAuthenticationResult<User>>;
 /**
  * AdonisJS HTTP middleware executed for the WebSocket upgrade request.
  */
@@ -289,7 +324,7 @@ type SocketHttpMiddleware = (() => Promise<{
  * Result of matching a channel.
  */
 interface ChannelMatch {
-    channel: typeof BaseChannel;
+    channel: BaseChannelConstructor;
     pattern: string;
     params: Record<string, string>;
 }
@@ -300,18 +335,25 @@ interface ChannelOptions {
     presence?: boolean;
 }
 /**
- * Presence member information.
+ * Identity and channel-specific data returned for a presence member.
+ */
+interface PresenceInfo {
+    id: string;
+    data?: Record<string, unknown>;
+}
+/**
+ * Presence member exposed to snapshots and channel hooks.
  */
 interface PresenceMember {
     id: string;
-    name: string;
+    joinedAt?: never;
     [key: string]: unknown;
 }
 /**
  * Context passed to middlewares.
  */
-interface MiddlewareContext<User = unknown, HttpContext = unknown> {
-    socket: AuthenticatedSocket<User, HttpContext>;
+interface MiddlewareContext<User = unknown> {
+    socket: AuthenticatedSocket<User>;
     channel: string;
     params: Record<string, string>;
     presenceData?: Record<string, unknown> | PresenceData;
@@ -320,35 +362,34 @@ interface MiddlewareContext<User = unknown, HttpContext = unknown> {
 /**
  * Middleware function.
  */
-type MiddlewareFn<User = unknown, HttpContext = unknown> = (ctx: MiddlewareContext<User, HttpContext>, next: () => Promise<void>) => Promise<void>;
+type MiddlewareFn<User = unknown> = (ctx: MiddlewareContext<User>, next: () => Promise<void>) => Promise<void>;
 /**
  * Middleware class.
  */
-interface MiddlewareClass<User = unknown, HttpContext = unknown> {
-    handle: MiddlewareFn<User, HttpContext>;
+interface MiddlewareClass<User = unknown> {
+    handle: MiddlewareFn<User>;
 }
 /**
  * Middleware, either a function or a class.
  */
-type Middleware<User = unknown, HttpContext = unknown> = MiddlewareFn<User, HttpContext> | MiddlewareClass<User, HttpContext>;
-/**
- * Event handler map.
- */
-type ChannelEventMap = Record<string, unknown>;
-type ChannelHandlerFn<User = unknown, Events extends ChannelEventMap = ChannelEventMap, HttpContext = unknown, K extends keyof Events = keyof Events> = (socket: AuthenticatedSocket<User, HttpContext>, data: Events[K]) => unknown | Promise<unknown>;
-type ChannelHandlerMap<User = unknown, Events extends ChannelEventMap = ChannelEventMap, HttpContext = unknown> = {
-    [K in keyof Events]?: ChannelHandlerFn<User, Events, HttpContext, K>;
-};
+type Middleware<User = unknown> = MiddlewareFn<User> | MiddlewareClass<User>;
+/** Extracts the server-to-client event map declared by a channel instance. */
+type ChannelServerEventsOf<T> = T extends {
+    readonly $serverEvents: infer Events;
+} ? Events : unknown;
+type ChannelHandlerFn<User = unknown> = (socket: AuthenticatedSocket<User>, data: any) => unknown | Promise<unknown>;
+type ChannelHandlerMap<User = unknown> = Record<string, ChannelHandlerFn<User>>;
 /**
  * Package configuration.
  */
-interface SocketConfig<User = unknown, HttpContext = unknown> {
-    channels?: {
-        patterns?: string[];
-    };
+interface SocketConfig<User = unknown> {
     websocket?: {
         path?: string;
-        createContext?: SocketHttpContextFactory<HttpContext>;
+        /**
+         * Additional browser origins allowed to open a WebSocket connection.
+         * Same-origin requests and clients without an Origin header are allowed by default.
+         */
+        allowedOrigins?: string[];
         /**
          * HTTP middleware executed only for the WebSocket upgrade request.
          *
@@ -356,11 +397,7 @@ interface SocketConfig<User = unknown, HttpContext = unknown> {
          * websocket.authenticate. Channel middleware should be declared on channel classes.
          */
         middleware?: SocketHttpMiddleware[];
-        /**
-         * @internal
-         */
-        createContextOnUpgrade?: boolean;
-        authenticate?: SocketAuthenticationHandler<User, HttpContext>;
+        authenticate?: SocketAuthenticationHandler<User>;
         /**
          * Sends a WebSocket ping every configured duration.
          *
@@ -393,6 +430,18 @@ interface SocketConfig<User = unknown, HttpContext = unknown> {
          * Maximum buffered outbound WebSocket bytes accepted before the service closes the socket.
          */
         maxBufferedAmount?: number;
+        /**
+         * Maximum serialized size of one outbound WebSocket protocol message in bytes.
+         */
+        maxOutboundPayload?: number;
+        /**
+         * Maximum number of active channel subscriptions retained by one socket.
+         */
+        maxSubscriptionsPerSocket?: number;
+        /**
+         * Maximum accepted channel name length in characters.
+         */
+        maxChannelNameLength?: number;
     };
     /**
      * Optional transport used to synchronize broadcasts between SocketService instances.
@@ -410,22 +459,22 @@ interface SocketHealthSnapshot {
 /**
  * Events emitted by the service.
  */
-interface SocketEvents<User = unknown, HttpContext = unknown> {
+interface SocketEvents<User = unknown> {
     connect: {
-        socket: AuthenticatedSocket<User, HttpContext>;
+        socket: AuthenticatedSocket<User>;
     };
     disconnect: {
-        socket: AuthenticatedSocket<User, HttpContext>;
+        socket: AuthenticatedSocket<User>;
         reason: string;
     };
     subscribe: {
-        socket: AuthenticatedSocket<User, HttpContext>;
+        socket: AuthenticatedSocket<User>;
         channel: string;
     };
     unsubscribe: {
-        socket: AuthenticatedSocket<User, HttpContext>;
+        socket: AuthenticatedSocket<User>;
         channel: string;
     };
 }
 
-export { type AuthenticatedSocket as A, BaseChannel as B, type ChannelEventMap as C, type Duration as D, type Middleware as M, PresenceManager as P, type RawSocket as R, type SocketConfig as S, type SocketAuthenticationHandler as a, type ChannelHandlerFn as b, type ChannelHandlerMap as c, type ChannelMatch as d, type ChannelOptions as e, type MiddlewareClass as f, type MiddlewareContext as g, type MiddlewareFn as h, type PresenceMember as i, type SocketAuthenticationResult as j, type SocketEvents as k, type SocketHealthSnapshot as l, type SocketHttpContextFactory as m, type SocketHttpMiddleware as n, type SocketServiceStatus as o, type SocketUpgradeContext as p, type PresenceData as q };
+export { type AuthenticatedSocket as A, BaseChannel as B, type ChannelHandlerMap as C, type Duration as D, type Middleware as M, PresenceManager as P, type RawSocket as R, type SocketConfig as S, type ChannelServerEventsOf as a, type ChannelAck as b, type ChannelMessage as c, type SocketAuthenticationHandler as d, type BaseChannelConstructor as e, type ChannelHandlerFn as f, type ChannelMatch as g, type ChannelOptions as h, type MiddlewareClass as i, type MiddlewareContext as j, type MiddlewareFn as k, type PresenceInfo as l, type PresenceMember as m, type SocketAuthenticationResult as n, type SocketEvents as o, type SocketHealthSnapshot as p, type SocketHttpMiddleware as q, SocketResponseError as r, type SocketServiceStatus as s, type SocketUpgradeContext as t, type PresenceData as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rlanz/socket",
-  "version": "0.0.1-4",
+  "version": "0.0.1-6",
   "description": "WebSocket integration for AdonisJS",
   "type": "module",
   "main": "./build/index.js",
@@ -15,6 +15,7 @@
   "exports": {
     ".": "./build/index.js",
     "./provider": "./build/providers/socket_provider.js",
+    "./assembler_hook": "./build/src/assembler_hook.js",
     "./services/main": "./build/services/socket.js",
     "./decorators": "./build/src/decorators.js",
     "./health_check": "./build/src/health_check.js",
@@ -23,30 +24,35 @@
     "./types": "./build/src/types.js",
     "./types/tracing_channels": "./build/src/types/tracing_channels.js",
     "./client": "./build/src/client/index.js",
-    "./client/types": "./build/src/client/types.js"
+    "./client/types": "./build/src/client/types.js",
+    "./client/react": "./build/src/client/react.js",
+    "./client/vue": "./build/src/client/vue.js",
+    "./client/svelte": "./build/src/client/svelte.js"
   },
   "scripts": {
     "build": "npm run compile",
     "clean": "del-cli build",
     "compile": "npm run clean && tsup-node",
+    "check:package": "node --import=@poppinss/ts-exec bin/check_package.ts",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",
     "format": "oxfmt --check .",
     "format:fix": "oxfmt --write .",
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "npm run build && npm run check:package",
     "release": "release-it",
     "test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
     "typecheck": "tsc --noEmit",
     "version": "npm run build"
   },
   "dependencies": {
-    "@boringnode/bus": "^0.9.0",
+    "@boringnode/bus": "^0.9.1",
     "@lukeed/ms": "^2.0.2",
     "@poppinss/matchit": "^3.2.0",
     "emittery": "^1.2.0",
     "ws": "^8.21.0"
   },
   "devDependencies": {
+    "@adonisjs/assembler": "^8.0.0",
     "@adonisjs/core": "^7.0.1",
     "@adonisjs/tsconfig": "^2.0.0",
     "@japa/assert": "^4.2.0",
@@ -58,21 +64,38 @@
     "@opentelemetry/sdk-metrics": "^2.7.1",
     "@opentelemetry/sdk-trace-base": "^2.7.1",
     "@poppinss/ts-exec": "^1.4.4",
+    "@types/node": "^24.0.0",
+    "@types/react": "^19.1.9",
+    "@types/react-test-renderer": "^19.1.0",
+    "@types/scheduler": "^0",
     "@types/ws": "^8.18.1",
     "del-cli": "^7.0.0",
     "oxfmt": "^0.38.0",
     "oxlint": "^1.53.0",
+    "react": "^19.1.1",
+    "react-test-renderer": "^19.1.1",
     "release-it": "^19.2.4",
+    "scheduler": "^0.27.0",
+    "svelte": "^5.38.0",
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vue": "^3.5.18"
   },
   "peerDependencies": {
+    "@adonisjs/assembler": "^8.0.0",
     "@adonisjs/core": "^7.0.1",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^1.30.0 || ^2.0.0",
-    "@opentelemetry/instrumentation": "^0.200.0"
+    "@opentelemetry/instrumentation": "^0.200.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "svelte": "^4.0.0 || ^5.0.0",
+    "typescript": "^5.9.0 || ^6.0.0",
+    "vue": "^3.3.0"
   },
   "peerDependenciesMeta": {
+    "@adonisjs/assembler": {
+      "optional": true
+    },
     "@opentelemetry/api": {
       "optional": true
     },
@@ -81,6 +104,18 @@
     },
     "@opentelemetry/instrumentation": {
       "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "svelte": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
     }
   },
   "keywords": [

package/build/chunk-GKAD2UOA.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/tracing_channels.ts"],"sourcesContent":["import diagnostics_channel from 'node:diagnostics_channel'\nimport type {\n  SocketBroadcastMessage,\n  SocketChannelMessage,\n  SocketConnectMessage,\n  SocketDisconnectMessage,\n  SocketSubscribeMessage,\n  SocketUnsubscribeMessage,\n} from './types/tracing_channels.js'\n\nexport const connectChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.connect',\n  SocketConnectMessage\n>('rlanz.socket.connect')\n\nexport const disconnectChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.disconnect',\n  SocketDisconnectMessage\n>('rlanz.socket.disconnect')\n\nexport const subscribeChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.subscribe',\n  SocketSubscribeMessage\n>('rlanz.socket.subscribe')\n\nexport const unsubscribeChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.unsubscribe',\n  SocketUnsubscribeMessage\n>('rlanz.socket.unsubscribe')\n\nexport const channelMessageChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.message',\n  SocketChannelMessage\n>('rlanz.socket.message')\n\nexport const broadcastChannel = diagnostics_channel.tracingChannel<\n  'rlanz.socket.broadcast',\n  SocketBroadcastMessage\n>('rlanz.socket.broadcast')\n"],"mappings":";AAAA,OAAO,yBAAyB;AAUzB,IAAM,iBAAiB,oBAAoB,eAGhD,sBAAsB;AAEjB,IAAM,oBAAoB,oBAAoB,eAGnD,yBAAyB;AAEpB,IAAM,mBAAmB,oBAAoB,eAGlD,wBAAwB;AAEnB,IAAM,qBAAqB,oBAAoB,eAGpD,0BAA0B;AAErB,IAAM,wBAAwB,oBAAoB,eAGvD,sBAAsB;AAEjB,IAAM,mBAAmB,oBAAoB,eAGlD,wBAAwB;","names":[]}