@emeryld/rrroutes-client 2.6.0 → 2.6.2

package/dist/sockets/socket.client.context.d.ts

@@ -1,7 +1,7 @@
+import { EventMap, Payload, SocketConnectionConfigOutput, SocketSchemaOutput } from '@emeryld/rrroutes-contract';
 import * as React from 'react';
 import { Socket } from 'socket.io-client';
-import { SocketClient, SocketClientOptions, ClientCtx, ServerEnvelope } from './socket.client.index';
-import { EventMap, SocketConnectionConfigOutput, Payload, SocketSchemaOutput } from '@emeryld/rrroutes-contract';
+import { ClientCtx, ServerEnvelope, SocketClient, SocketClientOptions } from './socket.client.index';
 /** === Provider-side debug === */
 type HookDebugReason = 'init' | 'change';
 type HookDebugValue = string | number | boolean | null | undefined;
@@ -57,7 +57,7 @@ type Rooms = string[] | string | undefined;
 export type UseSocketConnectionArgs<T extends EventMap, K extends keyof T & string, C extends SocketConnectionConfigOutput> = {
     event: K;
     rooms?: Rooms;
-    onMessage: (payload: Payload<T, K>, meta: {
+    onMessage: (payload: Payload<T, K>, meta?: {
         envelope: ServerEnvelope<T, K>;
         ctx: ClientCtx;
     }) => void;

package/dist/sockets/socket.client.index.d.ts

@@ -7,13 +7,13 @@ export type ServerEnvelope<T extends EventMap, K extends keyof T & string> = {
     sentTo: string[];
     data?: Payload<T, K>;
     metadata?: Record<string, unknown>;
+    rooms: string[];
 };
 export type ClientCtx = {
     receivedAt: Date;
     latencyMs?: number;
     nsp?: string;
     socketId?: string;
-    rooms?: string[];
     socket?: MaybeSocket;
     reply?: (data?: unknown) => void;
 };
@@ -101,7 +101,7 @@ export declare class SocketClient<T extends EventMap, C extends SocketConnection
     emit<K extends keyof T & string>(event: K, payload: Payload<T, K>, metadata?: Record<string, unknown>): void;
     joinRooms(rooms: string[] | string, meta: SocketSchemaOutput<C['joinMetaMessage']>): Promise<() => Promise<void>>;
     leaveRooms(rooms: string[] | string, meta: SocketSchemaOutput<C['leaveMetaMessage']>): Promise<void>;
-    on<K extends keyof T & string>(event: K, handler: (payload: Payload<T, K>, meta: {
+    on<K extends keyof T & string>(event: K, handler: (payload: Payload<T, K>, meta?: {
         envelope: ServerEnvelope<T, K>;
         ctx: ClientCtx;
     }) => void): () => void;

package/dist/sockets/socketedRoute/socket.client.helper.d.ts

@@ -2,6 +2,42 @@ import type { AnyLeafLowProfile, EventMap, InferOutput, Payload, SocketConnectio
 import type { BuiltInfinite, BuiltQuery, DataShape, InfiniteUseEndpointResultFor, QueryUseEndpointResultFor, UseEndpointArgs } from '../../routesV3.client.types';
 import type { ClientCtx, ServerEnvelope, SocketClient } from '../socket.client.index';
 type RoomsInput = string | string[] | undefined | null;
+type HookDebugReason = 'init' | 'change';
+type HookDebugValue = string | number | boolean | null | undefined;
+export type SocketedRouteDebugEvent = {
+    type: 'client';
+    phase: 'ready' | 'missing';
+    err?: string;
+} | {
+    type: 'render';
+    renderCount: number;
+    hasClient: boolean;
+    argsKey: string;
+    rooms: string[];
+    roomsKey: string;
+    joinMetaKey: string;
+    leaveMetaKey: string;
+} | {
+    type: 'hook';
+    phase: 'endpoint_on_receive_effect' | 'derive_rooms_effect' | 'join_rooms_effect' | 'apply_socket_effect';
+    reason: HookDebugReason;
+    changes: Array<{
+        dependency: string;
+        previous: HookDebugValue;
+        next: HookDebugValue;
+    }>;
+} | {
+    type: 'room';
+    phase: 'join_attempt' | 'join_skip' | 'join_error' | 'leave_attempt' | 'leave_skip' | 'leave_error';
+    rooms: string[];
+    reason?: string;
+    err?: string;
+};
+export type SocketedRouteDebugOptions = {
+    logger?: (event: SocketedRouteDebugEvent) => void;
+} & {
+    [P in SocketedRouteDebugEvent['type']]?: boolean;
+};
 type SocketedBuilt<L extends AnyLeafLowProfile> = L['cfg']['feed'] extends true ? BuiltInfinite<L> : BuiltQuery<L>;
 type SocketedRouteResult<L extends AnyLeafLowProfile> = (L['cfg']['feed'] extends true ? InfiniteUseEndpointResultFor<L> : QueryUseEndpointResultFor<L>) & {
     rooms: string[];
@@ -15,11 +51,13 @@ export type SocketedRouteOptions<L extends AnyLeafLowProfile, Events extends Eve
     };
     applySocket: {
         [K in keyof Events & string]?: (prev: DataShape<L> | undefined, payload: Payload<Events, K>, meta: {
-            envelope: ServerEnvelope<Events, K>;
-            ctx: ClientCtx;
+            envelope?: ServerEnvelope<Events, keyof Events & string>;
+            ctx?: ClientCtx;
+            args: UseEndpointArgs<L>;
         }) => DataShape<L> | undefined;
     };
     useSocketClient: () => SocketClient<Events, C>;
+    debug?: SocketedRouteDebugOptions;
 };
 /**
  * Compose a GET endpoint with socket wiring:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emeryld/rrroutes-client",
-  "version": "2.6.0",
+  "version": "2.6.2",
   "private": false,
   "type": "module",
   "main": "dist/index.cjs",