@emeryld/rrroutes-client 2.0.13 → 2.1.1

package/dist/index.cjs

@@ -35,7 +35,9 @@ __export(index_exports, {
   buildRoomPayloadSchema: () => buildRoomPayloadSchema,
   buildSocketProvider: () => buildSocketProvider,
   createRouteClient: () => createRouteClient,
-  defaultFetcher: () => defaultFetcher
+  defaultFetcher: () => defaultFetcher,
+  useSocketClient: () => useSocketClient,
+  useSocketConnection: () => useSocketConnection
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -526,6 +528,7 @@ function buildSocketProvider(args) {
       {
         events,
         baseOptions,
+        providerDebug: baseOptions.debug,
         ...props
       }
     ),
@@ -559,7 +562,7 @@ function SocketProvider(props) {
           return;
         }
         if (!s) {
-          dbg(providerDebugRef.current, { type: "resolve", phase: "missing" });
+          dbg(providerDebugRef.current, { type: "resolve", phase: "socketMissing" });
           return;
         }
         setResolvedSocket(s);
@@ -581,11 +584,11 @@ function SocketProvider(props) {
   });
   const client = React.useMemo(() => {
     if (!socket) {
-      dbg(providerDebugRef.current, { type: "client", phase: "missing" });
+      dbg(providerDebugRef.current, { type: "client", phase: "init", missing: true });
       return null;
     }
     const c = new SocketClient(events, { ...baseOptions, socket });
-    dbg(providerDebugRef.current, { type: "client", phase: "ready" });
+    dbg(providerDebugRef.current, { type: "client", phase: "init", missing: false });
     return c;
   }, [events, baseOptions, socket]);
   React.useEffect(() => {
@@ -602,12 +605,8 @@ function SocketProvider(props) {
       }
     };
   }, [client, destroyLeaveMeta]);
-  if (!client) {
-    dbg(providerDebugRef.current, { type: "render", phase: "waiting_for_socket" });
-    return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children: fallback ?? children });
-  }
-  dbg(providerDebugRef.current, { type: "render", phase: "provide" });
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(SocketCtx.Provider, { value: client, children });
+  dbg(providerDebugRef.current, { type: "render", hasClient: !!client });
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(SocketCtx.Provider, { value: client, children: client == null ? fallback ?? children : children });
 }
 function useSocketClient() {
   const ctx = React.useContext(SocketCtx);
@@ -652,46 +651,36 @@ var SocketClient = class {
       intervalMs: hb.intervalMs ?? 15e3,
       timeoutMs: hb.timeoutMs ?? 7500
     };
-    this.dbg({
-      type: "lifecycle",
-      phase: "init_start",
-      socketId: this.socket?.id ?? void 0,
-      details: {
-        environment: this.environment
-      }
-    });
     if (!this.socket) {
       this.dbg({
         type: "lifecycle",
-        phase: "init_socket_missing",
+        phase: "init",
         err: "Socket reference is null during initialization"
       });
     } else {
       this.dbg({
         type: "lifecycle",
-        phase: "init_ready",
-        socketId: this.socket.id,
-        details: {
-          heartbeatIntervalMs: this.hb.intervalMs,
-          heartbeatTimeoutMs: this.hb.timeoutMs
-        }
+        phase: "init",
+        heartbeatIntervalMs: this.hb.intervalMs,
+        heartbeatTimeoutMs: this.hb.timeoutMs,
+        environment: this.environment
       });
-      this.logSocketConfigSnapshot("init", "constructor");
+      this.logSocketConfigSnapshot("constructor");
     }
     this.onConnect = () => {
       if (!this.socket) {
-        this.dbg({ type: "connection", phase: "connect", err: "Socket is null" });
+        this.dbg({ type: "connection", phase: "connect_event", err: "Socket is null" });
         throw new Error("Socket is null in onConnect handler");
       }
       this.dbg({
         type: "connection",
-        phase: "connect",
+        phase: "connect_event",
         id: this.socket.id,
         details: {
           nsp: this.getNamespace(this.socket)
         }
       });
-      this.logSocketConfigSnapshot("update", "connect_event");
+      this.logSocketConfigSnapshot("connect_event");
       this.getSysEvent("sys:connect")({
         socket: this.socket,
         client: this
@@ -699,19 +688,19 @@ var SocketClient = class {
     };
     this.onReconnect = (attempt) => {
       if (!this.socket) {
-        this.dbg({ type: "connection", phase: "reconnect", err: "Socket is null" });
+        this.dbg({ type: "connection", phase: "reconnect_event", err: "Socket is null" });
         throw new Error("Socket is null in onReconnect handler");
       }
       this.dbg({
         type: "connection",
-        phase: "reconnect",
+        phase: "reconnect_event",
         attempt,
         id: this.socket.id,
         details: {
           nsp: this.getNamespace(this.socket)
         }
       });
-      this.logSocketConfigSnapshot("update", "reconnect_event");
+      this.logSocketConfigSnapshot("reconnect_event");
       this.getSysEvent("sys:reconnect")({
         attempt,
         socket: this.socket,
@@ -720,18 +709,18 @@ var SocketClient = class {
     };
     this.onDisconnect = (reason) => {
       if (!this.socket) {
-        this.dbg({ type: "connection", phase: "disconnect", err: "Socket is null" });
+        this.dbg({ type: "connection", phase: "disconnect_event", err: "Socket is null" });
         throw new Error("Socket is null in onDisconnect handler");
       }
       this.dbg({
         type: "connection",
-        phase: "disconnect",
+        phase: "disconnect_event",
         reason: String(reason),
         details: {
           roomsTracked: this.roomCounts.size
         }
       });
-      this.logSocketConfigSnapshot("update", "disconnect_event");
+      this.logSocketConfigSnapshot("disconnect_event");
       this.getSysEvent("sys:disconnect")({
         reason: String(reason),
         socket: this.socket,
@@ -740,16 +729,16 @@ var SocketClient = class {
     };
     this.onConnectError = (err) => {
       if (!this.socket) {
-        this.dbg({ type: "connection", phase: "connect_error", err: "Socket is null" });
+        this.dbg({ type: "connection", phase: "connect_error_event", err: "Socket is null" });
         throw new Error("Socket is null in onConnectError handler");
       }
       this.dbg({
         type: "connection",
-        phase: "connect_error",
+        phase: "connect_error_event",
         err: String(err),
         details: this.getVerboseDetails({ rawError: err })
       });
-      this.logSocketConfigSnapshot("update", "connect_error_event");
+      this.logSocketConfigSnapshot("connect_error_event");
       this.getSysEvent("sys:connect_error")({
         error: String(err),
         socket: this.socket,
@@ -758,14 +747,14 @@ var SocketClient = class {
     };
     this.onPong = (raw) => {
       if (!this.socket) {
-        this.dbg({ type: "heartbeat", action: "pong_recv", err: "Socket is null" });
+        this.dbg({ type: "heartbeat", phase: "pong_recv", err: "Socket is null" });
         throw new Error("Socket is null in onPong handler");
       }
       const parsed = this.config.pongPayload.safeParse(raw);
       if (!parsed.success) {
         this.dbg({
           type: "heartbeat",
-          action: "validation_failed",
+          phase: "validation_failed",
           err: `pong payload validation failed: ${parsed.error.message}`,
           details: this.getValidationDetails(parsed.error)
         });
@@ -774,7 +763,7 @@ var SocketClient = class {
       const validated = parsed.data;
       this.dbg({
         type: "heartbeat",
-        action: "pong_recv",
+        phase: "pong_recv",
         payload: validated
       });
       this.getSysEvent("sys:pong")({
@@ -821,16 +810,16 @@ var SocketClient = class {
       secure: typeof opts.secure === "boolean" ? opts.secure : void 0
     };
   }
-  logSocketConfigSnapshot(phase, reason) {
+  logSocketConfigSnapshot(reason) {
     if (!this.debug.logger || !this.debug.config) return;
     const snapshot = this.snapshotSocketConfig(this.socket);
     this.dbg({
       type: "config",
-      phase,
-      reason,
-      socketId: this.socket?.id,
-      snapshot: snapshot ?? void 0,
-      err: snapshot ? void 0 : "Socket unavailable for config snapshot"
+      phase: reason,
+      ...snapshot == null ? { err: "Socket is missing. " } : {
+        socketId: this.socket?.id,
+        snapshot
+      }
     });
   }
   getValidationDetails(error) {
@@ -894,11 +883,11 @@ var SocketClient = class {
    * call it yourself from any sysHandler to change when heartbeats start.
    */
   startHeartbeat() {
-    this.stopHeartbeat();
+    this.stopHeartbeat("stop_before_start");
     if (!this.socket) {
       this.dbg({
         type: "heartbeat",
-        action: "start",
+        phase: "start",
         err: "Socket is null"
       });
       return;
@@ -906,7 +895,7 @@ var SocketClient = class {
     const socket = this.socket;
     this.dbg({
       type: "heartbeat",
-      action: "start",
+      phase: "start",
       details: {
         intervalMs: this.hb.intervalMs,
         timeoutMs: this.hb.timeoutMs
@@ -916,7 +905,7 @@ var SocketClient = class {
       if (!socket) {
         this.dbg({
           type: "heartbeat",
-          action: "tick_skip",
+          phase: "tick_skip",
           err: "Socket missing during heartbeat tick"
         });
         return;
@@ -929,7 +918,7 @@ var SocketClient = class {
       if (!check.success) {
         this.dbg({
           type: "heartbeat",
-          action: "validation_failed",
+          phase: "validation_failed",
           err: "ping payload validation failed",
           details: this.getValidationDetails(check.error)
         });
@@ -942,7 +931,7 @@ var SocketClient = class {
       socket.emit("sys:ping", dataToSend);
       this.dbg({
         type: "heartbeat",
-        action: "ping_emit",
+        phase: "ping_emit",
         payload: dataToSend
       });
     };
@@ -955,7 +944,7 @@ var SocketClient = class {
    * This is called by the default 'sys:disconnect' handler, but you can also
    * call it yourself from any sysHandler to fully control heartbeat lifecycle.
    */
-  stopHeartbeat() {
+  stopHeartbeat(reason) {
     const hadTimer = Boolean(this.hbTimer);
     if (this.hbTimer) {
       clearInterval(this.hbTimer);
@@ -963,10 +952,9 @@ var SocketClient = class {
     }
     this.dbg({
       type: "heartbeat",
-      action: "stop",
-      details: {
-        hadTimer
-      }
+      phase: "stop",
+      reason,
+      hadTimer
     });
   }
   emit(event, payload, metadata) {
@@ -994,7 +982,7 @@ var SocketClient = class {
   }
   joinRooms(rooms, meta) {
     if (!this.socket) {
-      this.dbg({ type: "room", action: "join", rooms: this.toArray(rooms), err: "Socket is null" });
+      this.dbg({ type: "room", phase: "join", rooms: this.toArray(rooms), err: "Socket is null" });
       throw new Error("Socket is null in joinRooms method");
     }
     if (!this.getSysEvent("sys:room_join")({
@@ -1003,7 +991,7 @@ var SocketClient = class {
       socket: this.socket,
       client: this
     })) {
-      this.dbg({ type: "room", action: "join", rooms: this.toArray(rooms), err: "sys:room_join handler aborted join" });
+      this.dbg({ type: "room", phase: "join", rooms: this.toArray(rooms), err: "sys:room_join handler aborted join" });
       return;
     }
     const list = this.toArray(rooms);
@@ -1022,7 +1010,7 @@ var SocketClient = class {
         this.rollbackJoinIncrement(toJoin);
         this.dbg({
           type: "room",
-          action: "join",
+          phase: "join",
           rooms: toJoin,
           err: "payload validation failed",
           details: this.getValidationDetails(payloadResult.error)
@@ -1032,12 +1020,12 @@ var SocketClient = class {
       const payload = payloadResult.data;
       const normalizedRooms = this.toArray(payload.rooms);
       this.socket.emit("sys:room_join", payload);
-      this.dbg({ type: "room", action: "join", rooms: normalizedRooms });
+      this.dbg({ type: "room", phase: "join", rooms: normalizedRooms });
     }
   }
   leaveRooms(rooms, meta) {
     if (!this.socket) {
-      this.dbg({ type: "room", action: "leave", rooms: this.toArray(rooms), err: "Socket is null" });
+      this.dbg({ type: "room", phase: "leave", rooms: this.toArray(rooms), err: "Socket is null" });
       throw new Error("Socket is null in leaveRooms method");
     }
     if (!this.getSysEvent("sys:room_leave")({
@@ -1046,7 +1034,7 @@ var SocketClient = class {
       socket: this.socket,
       client: this
     })) {
-      this.dbg({ type: "room", action: "leave", rooms: this.toArray(rooms), err: "sys:room_leave handler aborted leave" });
+      this.dbg({ type: "room", phase: "leave", rooms: this.toArray(rooms), err: "sys:room_leave handler aborted leave" });
       return;
     }
     const list = this.toArray(rooms);
@@ -1067,7 +1055,7 @@ var SocketClient = class {
         this.rollbackLeaveDecrement(toLeave);
         this.dbg({
           type: "room",
-          action: "leave",
+          phase: "leave",
           rooms: toLeave,
           err: "payload validation failed",
           details: this.getValidationDetails(payloadResult.error)
@@ -1077,14 +1065,14 @@ var SocketClient = class {
       const payload = payloadResult.data;
       const normalizedRooms = this.toArray(payload.rooms);
       this.socket.emit("sys:room_leave", payload);
-      this.dbg({ type: "room", action: "leave", rooms: normalizedRooms });
+      this.dbg({ type: "room", phase: "leave", rooms: normalizedRooms });
     }
   }
   on(event, handler) {
     const schema = this.events[event].message;
-    this.dbg({ type: "register", action: "register", event });
+    this.dbg({ type: "register", phase: "register", event });
     if (!this.socket) {
-      this.dbg({ type: "register", action: "register", event, err: "Socket is null" });
+      this.dbg({ type: "register", phase: "register", event, err: "Socket is null" });
       return () => {
       };
     }
@@ -1152,7 +1140,7 @@ var SocketClient = class {
         s.delete(entry);
         if (s.size === 0) this.handlerMap.delete(String(event));
       }
-      this.dbg({ type: "register", action: "unregister", event });
+      this.dbg({ type: "register", phase: "unregister", event });
     };
   }
   /**
@@ -1160,7 +1148,7 @@ var SocketClient = class {
    * Call when disposing the client instance.
    */
   destroy(leaveMeta) {
-    this.stopHeartbeat();
+    this.stopHeartbeat("destroy");
     const socket = this.socket;
     this.dbg({
       type: "lifecycle",
@@ -1211,7 +1199,7 @@ var SocketClient = class {
       });
       return;
     }
-    this.stopHeartbeat();
+    this.stopHeartbeat("disconnect");
     this.socket.disconnect();
     this.dbg({
       type: "connection",
@@ -1221,7 +1209,7 @@ var SocketClient = class {
         nsp: this.getNamespace(this.socket)
       }
     });
-    this.logSocketConfigSnapshot("update", "disconnect_call");
+    this.logSocketConfigSnapshot("disconnect_call");
   }
   connect() {
     if (!this.socket) {
@@ -1241,7 +1229,7 @@ var SocketClient = class {
         nsp: this.getNamespace(this.socket)
       }
     });
-    this.logSocketConfigSnapshot("update", "connect_call");
+    this.logSocketConfigSnapshot("connect_call");
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
@@ -1250,6 +1238,8 @@ var SocketClient = class {
   buildRoomPayloadSchema,
   buildSocketProvider,
   createRouteClient,
-  defaultFetcher
+  defaultFetcher,
+  useSocketClient,
+  useSocketConnection
 });
 //# sourceMappingURL=index.cjs.map