@couch-kit/client 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @couch-kit/client
 
+## 0.6.0
+
+### Minor Changes
+
+- Fix player state not restored on page refresh
+
+  Players now maintain their identity across page refreshes and network reconnections. The library uses a stable player ID derived from a persistent session secret (stored in localStorage) instead of the ephemeral WebSocket socket ID.
+
+  **New features:**
+  - `__PLAYER_RECONNECTED__` internal action: dispatched when a returning player reconnects, preserving all game data (hand, score, turn, etc.)
+  - `__PLAYER_REMOVED__` internal action: dispatched when a disconnected player times out (default: 5 minutes), permanently removing them from state
+  - Race-safe disconnect handling: prevents marking a player as disconnected if they've already reconnected on a new socket
+  - Secret validation: malformed session secrets are rejected at the JOIN boundary
+
+  **Breaking changes:**
+  - `state.players` keys are now stable derived player IDs instead of ephemeral socket IDs
+  - `playerId` returned by `useGameClient()` and sent in `WELCOME` messages is now a stable identifier that persists across reconnections
+  - `secret` field in `JOIN` payload is now required (was optional)
+
+  **Security:**
+  - Raw session secret is never stored on `IPlayer` or broadcast to clients
+  - Only the derived public player ID is shared in game state
+
+### Patch Changes
+
+- Updated dependencies
+  - @couch-kit/core@0.5.0
+
 ## 0.5.1
 
 ### Patch Changes

package/README.md

@@ -40,7 +40,7 @@ Returns:
 
 - `status`: `'connecting' | 'connected' | 'disconnected' | 'error'`
 - `state`: current controller state (optimistic + hydrated)
-- `playerId`: server-assigned player id (after `WELCOME`)
+- `playerId`: stable public identifier derived from the session secret. Persists across page refreshes and reconnections (the same player always gets the same `playerId`).
 - `sendAction(action)`: optimistic dispatch + send to host
 - `getServerTime()`: NTP-ish server time based on periodic ping/pong
 - `rtt`: round-trip time (ms) to the server, updated periodically via PING/PONG
@@ -94,7 +94,7 @@ export default function Controller() {
   const {
     status, // 'connecting' | 'connected' | 'disconnected' | 'error'
     state, // The current game state (synced with Host)
-    playerId, // Your unique session ID
+    playerId, // Stable identifier, persists across reconnections
     sendAction, // Function to send actions to Host
   } = useGameClient({
     reducer: gameReducer,

package/dist/index.js

@@ -156,6 +156,13 @@ function useGameClient(config) {
           case MessageTypes2.PONG:
             handlePongRef.current(msg.payload);
             break;
+          case MessageTypes2.RECONNECTED:
+            setPlayerId(msg.payload.playerId);
+            dispatchLocal({
+              type: InternalActionTypes.HYDRATE,
+              payload: msg.payload.state
+            });
+            break;
         }
       } catch (e) {
         console.error("Failed to parse message", e);

package/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAUL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAC;AAGzB,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;IACpC,YAAY,EAAE,CAAC,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,EACnE,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;yBA8Mc,CAAC;;IAqBvC,8EAA8E;;IAE9E,0EAA0E;;IAE1E,+EAA+E;;EAGlF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAUL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAC;AAGzB,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;IACpC,YAAY,EAAE,CAAC,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,EACnE,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;yBAsNc,CAAC;;IAqBvC,8EAA8E;;IAE9E,0EAA0E;;IAE1E,+EAA+E;;EAGlF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/client",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "React hooks for phone controllers in Couch Kit party games — WebSocket client and action dispatch",
   "license": "MIT",
   "repository": {
@@ -43,7 +43,7 @@
     "clean": "rm -rf dist lib"
   },
   "dependencies": {
-    "@couch-kit/core": "0.4.0"
+    "@couch-kit/core": "0.5.0"
   },
   "devDependencies": {
     "react": "^18.2.0",

package/src/client.ts

@@ -179,6 +179,14 @@ export function useGameClient<S extends IGameState, A extends IAction>(
           case MessageTypes.PONG:
             handlePongRef.current(msg.payload);
             break;
+
+          case MessageTypes.RECONNECTED:
+            setPlayerId(msg.payload.playerId);
+            dispatchLocal({
+              type: InternalActionTypes.HYDRATE,
+              payload: msg.payload.state as S,
+            } as InternalAction<S>);
+            break;
         }
       } catch (e) {
         console.error("Failed to parse message", e);