@couch-kit/client 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @couch-kit/client
 
+## 0.12.0
+
+### Minor Changes
+
+- [#155](https://github.com/faluciano/react-native-couch-kit/pull/155) [`4f297a1`](https://github.com/faluciano/react-native-couch-kit/commit/4f297a19c442541703c3bee7bee26354ae3476a4) Thanks [@faluciano](https://github.com/faluciano)! - Hidden information can now be hidden for real: `GameHostRuntimeConfig` takes an
+  optional `project(state, playerId)` that narrows the authoritative state to what
+  one player may see.
+
+  Without it the runtime broadcasts the same state to everyone, so hiding a hand
+  depends on the client choosing not to look — any player could read opponents'
+  cards from devtools. With it, the data never reaches their device: the runtime
+  sends each connection its own projection, in `WELCOME`, `RECONNECTED`, and every
+  state update.
+
+  Games with no hidden information omit `project` and are unchanged — state is
+  still broadcast in one frame.
+
+  Because a projected client holds a _view_ rather than the whole state, it cannot
+  run the game reducer, so `ClientConfig.reducer` is now optional. Omit it and the
+  client renders what the host sends (no optimistic updates); a round trip is
+  imperceptible for turn-based games, and it is what makes the guarantee real.
+
 ## 0.11.0
 
 ### Minor Changes

package/dist/index.js

@@ -168,7 +168,7 @@ function useGameClient(config) {
   const [status, setStatus] = useState2("disconnected");
   const [playerId, setPlayerId] = useState2(null);
   const [disconnectReason, setDisconnectReason] = useState2(null);
-  const [state, dispatchLocal] = useReducer(createGameReducer(config.reducer), config.initialState);
+  const [state, dispatchLocal] = useReducer(createGameReducer(config.reducer ?? ((current) => current)), config.initialState);
   const socketRef = useRef2(null);
   const reconnectAttempts = useRef2(0);
   const reconnectTimer = useRef2(null);

package/lib/client.d.ts

@@ -3,7 +3,17 @@ import { type CreateClientTransport } from "./transport";
 export interface ClientConfig<S extends IGameState, A extends IAction> {
     url?: string;
     wsPort?: number;
-    reducer: (state: S, action: A) => S;
+    /**
+     * Applies actions locally for an optimistic update before the host confirms.
+     *
+     * **Omit it when the host projects state per player** (`project` in
+     * `GameHostRuntimeConfig`): the client then holds a *view* rather than the
+     * whole state, and the game reducer cannot run over a partial view. Without a
+     * reducer the client simply renders what the host sends — a round trip that
+     * is imperceptible for turn-based games, and the price of hidden information
+     * never reaching the device.
+     */
+    reducer?: (state: S, action: A) => S;
     initialState: S;
     name?: string;
     avatar?: string;

package/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAC;AASzB,OAAO,EAIL,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AAErB,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;IAChB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,EACnE,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;IAyOxB;;;;OAIG;;yBAvBmC,CAAC;;IA2BvC,8EAA8E;;IAE9E,0EAA0E;;IAE1E,+EAA+E;;EAGlF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAC;AASzB,OAAO,EAIL,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;IACrC,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;IAChB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,EACnE,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;IA2OxB;;;;OAIG;;yBAvBmC,CAAC;;IA2BvC,8EAA8E;;IAE9E,0EAA0E;;IAE1E,+EAA+E;;EAGlF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/client",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/client.ts

@@ -29,7 +29,17 @@ import {
 export interface ClientConfig<S extends IGameState, A extends IAction> {
   url?: string; // Full WebSocket URL (overrides auto-detection)
   wsPort?: number; // WebSocket port (default: auto-detected as HTTP port + 2)
-  reducer: (state: S, action: A) => S;
+  /**
+   * Applies actions locally for an optimistic update before the host confirms.
+   *
+   * **Omit it when the host projects state per player** (`project` in
+   * `GameHostRuntimeConfig`): the client then holds a *view* rather than the
+   * whole state, and the game reducer cannot run over a partial view. Without a
+   * reducer the client simply renders what the host sends — a round trip that
+   * is imperceptible for turn-based games, and the price of hidden information
+   * never reaching the device.
+   */
+  reducer?: (state: S, action: A) => S;
   initialState: S;
   name?: string; // Player display name (default: "Player")
   avatar?: string; // Player avatar emoji (default: "\u{1F600}")
@@ -83,9 +93,11 @@ export function useGameClient<S extends IGameState, A extends IAction>(
   const [disconnectReason, setDisconnectReason] = useState<string | null>(null);
 
   // Local Optimistic State
-  // Wrap the user's reducer with createGameReducer to handle HYDRATE automatically
+  // Wrap the user's reducer with createGameReducer to handle HYDRATE automatically.
+  // With no reducer (server-projected views) the identity function keeps HYDRATE
+  // working while local application becomes a no-op.
   const [state, dispatchLocal] = useReducer(
-    createGameReducer(config.reducer),
+    createGameReducer(config.reducer ?? ((current: S) => current)),
     config.initialState,
   );