@couch-kit/display 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @couch-kit/display
 
+## 0.6.0
+
+### Minor Changes
+
+- [#208](https://github.com/faluciano/react-native-couch-kit/pull/208) [`99598d6`](https://github.com/faluciano/react-native-couch-kit/commit/99598d6796b0bd3042aa9f3fbd3bf44ee891b890) Thanks [@faluciano](https://github.com/faluciano)! - `RelayDisplayHost` gains `subscribeActions(listener)`, the runtime's complete action stream: the display's own dispatches, players' actions, and join/leave lifecycle actions. State updates are no longer sent through the relay while no phone has joined the game.
+
+### Patch Changes
+
+- Updated dependencies [[`f4b57e3`](https://github.com/faluciano/react-native-couch-kit/commit/f4b57e3fba385d18396781d22a413a1d8afcb909), [`99598d6`](https://github.com/faluciano/react-native-couch-kit/commit/99598d6796b0bd3042aa9f3fbd3bf44ee891b890), [`99598d6`](https://github.com/faluciano/react-native-couch-kit/commit/99598d6796b0bd3042aa9f3fbd3bf44ee891b890)]:
+  - @couch-kit/client@0.15.1
+  - @couch-kit/core@0.10.1
+  - @couch-kit/runtime@0.5.0
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.js

@@ -72,6 +72,7 @@ class RelayDisplayHost {
   }
   getState = () => this.runtime.getState();
   subscribe = (listener) => this.runtime.subscribe(listener);
+  subscribeActions = (listener) => this.runtime.subscribeActions(listener);
   dispatch = (action) => this.runtime.dispatch(action);
   stop() {
     this.stopped = true;

package/lib/relay-display-host.d.ts

@@ -1,15 +1,15 @@
-import { type GameHostRuntimeConfig } from "@couch-kit/runtime";
+import { type GameHostRuntimeConfig, type RuntimeActionListener } from "@couch-kit/runtime";
 import type { IGameState, IAction } from "@couch-kit/core";
 import { type RelayErrorCode } from "@couch-kit/client";
 /**
  * Default minimum interval (ms) between state broadcasts through a relay.
  *
- * Slower than the LAN default on purpose: a relay rate-limits every connection
- * (30 messages/second on the reference relays) and answers a breach by closing
- * the socket — which, for the display, ends the room. 20 broadcasts/second
- * leaves headroom for the unicast traffic the display also sends (WELCOME,
- * PONG, errors), so a game that updates continuously cannot talk itself out of
- * its own room.
+ * Slower than the LAN default on purpose: every frame the display sends is
+ * billed by the relay and counted against the display's rate limit, whose
+ * breach closes the socket — and, for the display, ends the room. 20
+ * broadcasts/second is smooth for a party game and leaves the display's budget
+ * (1200 messages/second on the reference relays) to the unicast replies it
+ * also sends: WELCOME, PONG, errors.
  */
 export declare const DEFAULT_RELAY_STATE_THROTTLE_MS = 50;
 /**
@@ -104,6 +104,12 @@ export declare class RelayDisplayHost<S extends IGameState, A extends IAction> {
     getState: () => S;
     /** Subscribe to state changes (for `useSyncExternalStore` or manual render). */
     subscribe: (listener: () => void) => (() => void);
+    /**
+     * Subscribe to every action the runtime reduces — the display's own
+     * dispatches, players' actions, and join/leave lifecycle actions. A
+     * `RelayDisplayHost` can be passed straight to `useActionRecorder({ source })`.
+     */
+    subscribeActions: (listener: RuntimeActionListener<S, A>) => (() => void);
     /** Dispatch a trusted host-display action. */
     dispatch: (action: A) => void;
     /** Tear down the runtime and relay socket. */

package/lib/relay-display-host.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relay-display-host.d.ts","sourceRoot":"","sources":["../src/relay-display-host.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,qBAAqB,EAE3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAGL,KAAK,cAAc,EAEpB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B,KAAK,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC;AAElE,0EAA0E;AAC1E,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAE9B,YAAY,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAIhD;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,OAAO,CACjB,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CACvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,+EAA+E;IAC/E,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAA6B;IACzD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAuC;IACvE,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAC3C,OAAO,CAAC,aAAa,CAAoC;IACzD,+EAA+E;IAC/E,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAiDjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,yEAAyE;IACzE,IAAI,MAAM,IAAI,kBAAkB,CAE/B;IAED,wCAAwC;IACxC,QAAQ,QAAO,CAAC,CAA4B;IAE5C,gFAAgF;IAChF,SAAS,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CACb;IAEnC,8CAA8C;IAC9C,QAAQ,WAAY,CAAC,KAAG,IAAI,CAAkC;IAE9D,8CAA8C;IAC9C,IAAI,IAAI,IAAI,CAQX;IAED,OAAO,CAAC,SAAS;IAMjB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iBAAiB;IAwBzB,OAAO,CAAC,YAAY;IAqBpB,OAAO,CAAC,kBAAkB;CA4C3B"}
+{"version":3,"file":"relay-display-host.d.ts","sourceRoot":"","sources":["../src/relay-display-host.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,qBAAqB,EAE1B,KAAK,qBAAqB,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAGL,KAAK,cAAc,EAEpB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B,KAAK,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC;AAElE,0EAA0E;AAC1E,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAE9B,YAAY,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAIhD;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,OAAO,CACjB,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CACvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,+EAA+E;IAC/E,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAA6B;IACzD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAuC;IACvE,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAC3C,OAAO,CAAC,aAAa,CAAoC;IACzD,+EAA+E;IAC/E,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAiDjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,yEAAyE;IACzE,IAAI,MAAM,IAAI,kBAAkB,CAE/B;IAED,wCAAwC;IACxC,QAAQ,QAAO,CAAC,CAA4B;IAE5C,gFAAgF;IAChF,SAAS,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CACb;IAEnC;;;;OAIG;IACH,gBAAgB,aAAc,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CAAC,MAAM,IAAI,CAAC,CAC9B;IAE1C,8CAA8C;IAC9C,QAAQ,WAAY,CAAC,KAAG,IAAI,CAAkC;IAE9D,8CAA8C;IAC9C,IAAI,IAAI,IAAI,CAQX;IAED,OAAO,CAAC,SAAS;IAMjB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iBAAiB;IAwBzB,OAAO,CAAC,YAAY;IAqBpB,OAAO,CAAC,kBAAkB;CA4C3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/display",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -51,9 +51,9 @@
     "clean": "rm -rf dist lib"
   },
   "dependencies": {
-    "@couch-kit/client": "0.15.0",
-    "@couch-kit/core": "0.10.0",
-    "@couch-kit/runtime": "0.4.0"
+    "@couch-kit/client": "0.15.1",
+    "@couch-kit/core": "0.10.1",
+    "@couch-kit/runtime": "0.5.0"
   },
   "devDependencies": {
     "typescript": "^7.0.0"

package/src/relay-display-host.ts

@@ -5,6 +5,7 @@ import {
   type AddressedMessage,
   type GameHostRuntimeConfig,
   type GameRuntimeTransport,
+  type RuntimeActionListener,
 } from "@couch-kit/runtime";
 import type { IGameState, IAction, HostMessage } from "@couch-kit/core";
 import {
@@ -17,12 +18,12 @@ import {
 /**
  * Default minimum interval (ms) between state broadcasts through a relay.
  *
- * Slower than the LAN default on purpose: a relay rate-limits every connection
- * (30 messages/second on the reference relays) and answers a breach by closing
- * the socket — which, for the display, ends the room. 20 broadcasts/second
- * leaves headroom for the unicast traffic the display also sends (WELCOME,
- * PONG, errors), so a game that updates continuously cannot talk itself out of
- * its own room.
+ * Slower than the LAN default on purpose: every frame the display sends is
+ * billed by the relay and counted against the display's rate limit, whose
+ * breach closes the socket — and, for the display, ends the room. 20
+ * broadcasts/second is smooth for a party game and leaves the display's budget
+ * (1200 messages/second on the reference relays) to the unicast replies it
+ * also sends: WELCOME, PONG, errors.
  */
 export const DEFAULT_RELAY_STATE_THROTTLE_MS = 50;
 
@@ -189,6 +190,14 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
   subscribe = (listener: () => void): (() => void) =>
     this.runtime.subscribe(listener);
 
+  /**
+   * Subscribe to every action the runtime reduces — the display's own
+   * dispatches, players' actions, and join/leave lifecycle actions. A
+   * `RelayDisplayHost` can be passed straight to `useActionRecorder({ source })`.
+   */
+  subscribeActions = (listener: RuntimeActionListener<S, A>): (() => void) =>
+    this.runtime.subscribeActions(listener);
+
   /** Dispatch a trusted host-display action. */
   dispatch = (action: A): void => this.runtime.dispatch(action);