@couch-kit/display 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @couch-kit/display
 
+## 0.3.0
+
+### Minor Changes
+
+- [#158](https://github.com/faluciano/react-native-couch-kit/pull/158) [`509ea7c`](https://github.com/faluciano/react-native-couch-kit/commit/509ea7c02aa6f2e56ebf01e781d6de74f0ded021) Thanks [@faluciano](https://github.com/faluciano)! - Let the relay assign room codes
+
+  `RelayDisplayHost`'s `roomId` is now optional. Omit it and the relay mints an
+  unused six-character code, reported through the new `onRoomCode` callback and
+  the `roomCode` getter.
+
+  A display could never check its own code for collisions — only the relay knows
+  which codes are live — so a self-chosen code could land on a game already in
+  progress, and did so only after it was on screen. Minted codes are drawn from
+  the CSPRNG over a 32-character alphabet without `O`/`0` or `I`/`1`, giving about
+  1.07 billion codes.
+
+  Existing callers that pass `roomId` keep their current behaviour, including
+  `ROOM_EXISTS` when the code is taken. New callers should expect the code to
+  arrive one round trip after connecting rather than being known up front:
+
+  ```ts
+  const [roomCode, setRoomCode] = useState<string | null>(null);
+  new RelayDisplayHost({ url, onRoomCode: setRoomCode, reducer, initialState });
+  ```
+
+  Relays need a matching update to mint: both bundled implementations
+  (`services/relay`, `services/relay-worker`) support it. A display that omits
+  `roomId` against an older relay gets `MALFORMED`.
+
+### Patch Changes
+
+- Updated dependencies [[`509ea7c`](https://github.com/faluciano/react-native-couch-kit/commit/509ea7c02aa6f2e56ebf01e781d6de74f0ded021)]:
+  - @couch-kit/client@0.13.0
+
+## 0.2.3
+
+### Patch Changes
+
+- Updated dependencies [[`4f297a1`](https://github.com/faluciano/react-native-couch-kit/commit/4f297a19c442541703c3bee7bee26354ae3476a4)]:
+  - @couch-kit/runtime@0.2.0
+  - @couch-kit/client@0.12.0
+
 ## 0.2.2
 
 ### Patch Changes

package/dist/index.js

@@ -12,17 +12,19 @@ import {
 class RelayDisplayHost {
   runtime;
   ws;
-  roomId;
+  assignedRoomId;
+  onRoomCode;
   peers = new Set;
   constructor(options) {
-    const { url, roomId, ...runtimeConfig } = options;
-    this.roomId = roomId;
+    const { url, roomId, onRoomCode, ...runtimeConfig } = options;
+    this.assignedRoomId = roomId ?? null;
+    this.onRoomCode = onRoomCode;
     this.runtime = new GameHostRuntime(runtimeConfig);
     this.ws = new WebSocket(relayRoomUrl(url, roomId));
     this.ws.onopen = () => {
       this.ws.send(JSON.stringify({
         type: RelayMessageTypes.CREATE_ROOM,
-        roomId: this.roomId
+        roomId: this.assignedRoomId ?? undefined
       }));
     };
     this.ws.onmessage = (event) => {
@@ -41,6 +43,9 @@ class RelayDisplayHost {
     };
     this.runtime.setTransport(transport);
   }
+  get roomCode() {
+    return this.assignedRoomId;
+  }
   getState = () => this.runtime.getState();
   subscribe = (listener) => this.runtime.subscribe(listener);
   dispatch = (action) => this.runtime.dispatch(action);
@@ -52,7 +57,7 @@ class RelayDisplayHost {
   sendEnvelope(message, to) {
     const envelope = {
       type: RelayMessageTypes.DATA,
-      roomId: this.roomId,
+      roomId: this.assignedRoomId ?? undefined,
       data: JSON.stringify(message)
     };
     if (to !== undefined)
@@ -83,6 +88,10 @@ class RelayDisplayHost {
         this.runtime.handleMessage(msg.from, parsed).catch((err) => this.runtime.handleError(err instanceof Error ? err : new Error(String(err))));
         break;
       }
+      case RelayMessageTypes.ROOM_CREATED:
+        this.assignedRoomId = msg.roomId;
+        this.onRoomCode?.(msg.roomId);
+        break;
       case RelayMessageTypes.ERROR:
         this.runtime.handleError(new Error(msg.message));
         break;

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

@@ -10,8 +10,23 @@ import type { IGameState, IAction } from "@couch-kit/core";
 export interface RelayDisplayHostOptions<S extends IGameState, A extends IAction> extends GameHostRuntimeConfig<S, A> {
     /** WebSocket URL of the shared relay server. */
     url: string;
-    /** Room code phones will use to reach this display. */
-    roomId: string;
+    /**
+     * Room code phones will use to reach this display.
+     *
+     * Omit it — the normal case — and the relay allocates one, reporting it via
+     * {@link RelayDisplayHostOptions.onRoomCode} and {@link RelayDisplayHost.roomCode}.
+     * Only the relay can tell whether a code is already in use, so a code chosen
+     * here may be rejected as `ROOM_EXISTS`; supply one only when something
+     * outside the relay already fixed it.
+     */
+    roomId?: string;
+    /**
+     * Called once the room exists and its code is known.
+     *
+     * A minted code is not available synchronously, so a display renders a
+     * placeholder until this fires — roughly a round trip to the relay.
+     */
+    onRoomCode?: (roomCode: string) => void;
 }
 /**
  * Browser **display host** for the cross-network relay transport.
@@ -33,10 +48,18 @@ export interface RelayDisplayHostOptions<S extends IGameState, A extends IAction
 export declare class RelayDisplayHost<S extends IGameState, A extends IAction> {
     private readonly runtime;
     private readonly ws;
-    private readonly roomId;
+    /** Null until the relay confirms the room, when the code is relay-assigned. */
+    private assignedRoomId;
+    private readonly onRoomCode?;
     /** Connected phone connection ids (relay peer ids). */
     private readonly peers;
     constructor(options: RelayDisplayHostOptions<S, A>);
+    /**
+     * The room code phones join with, or `null` before the relay has assigned
+     * one. See {@link RelayDisplayHostOptions.onRoomCode} to be told when it
+     * arrives.
+     */
+    get roomCode(): string | null;
     /** Current authoritative game state. */
     getState: () => S;
     /** Subscribe to state changes (for `useSyncExternalStore` or manual render). */

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,EAIL,KAAK,qBAAqB,EAE3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AAOxE;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,CAC9E,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;CAChB;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,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAE3C,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAoCjD;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,CAIX;IAED,OAAO,CAAC,YAAY;IAUpB,OAAO,CAAC,kBAAkB;CAqC3B"}
+{"version":3,"file":"relay-display-host.d.ts","sourceRoot":"","sources":["../src/relay-display-host.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,qBAAqB,EAE3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AAOxE;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,CAC9E,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;CACzC;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,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAE3C,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAwCjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;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,CAIX;IAED,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,kBAAkB;CA2C3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/display",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -51,9 +51,9 @@
     "clean": "rm -rf dist lib"
   },
   "dependencies": {
-    "@couch-kit/client": "0.11.0",
+    "@couch-kit/client": "0.13.0",
     "@couch-kit/core": "0.9.3",
-    "@couch-kit/runtime": "0.1.0"
+    "@couch-kit/runtime": "0.2.0"
   },
   "devDependencies": {
     "typescript": "^7.0.0"

package/src/relay-display-host.ts

@@ -23,8 +23,23 @@ export interface RelayDisplayHostOptions<S extends IGameState, A extends IAction
   extends GameHostRuntimeConfig<S, A> {
   /** WebSocket URL of the shared relay server. */
   url: string;
-  /** Room code phones will use to reach this display. */
-  roomId: string;
+  /**
+   * Room code phones will use to reach this display.
+   *
+   * Omit it — the normal case — and the relay allocates one, reporting it via
+   * {@link RelayDisplayHostOptions.onRoomCode} and {@link RelayDisplayHost.roomCode}.
+   * Only the relay can tell whether a code is already in use, so a code chosen
+   * here may be rejected as `ROOM_EXISTS`; supply one only when something
+   * outside the relay already fixed it.
+   */
+  roomId?: string;
+  /**
+   * Called once the room exists and its code is known.
+   *
+   * A minted code is not available synchronously, so a display renders a
+   * placeholder until this fires — roughly a round trip to the relay.
+   */
+  onRoomCode?: (roomCode: string) => void;
 }
 
 /**
@@ -47,21 +62,27 @@ export interface RelayDisplayHostOptions<S extends IGameState, A extends IAction
 export class RelayDisplayHost<S extends IGameState, A extends IAction> {
   private readonly runtime: GameHostRuntime<S, A>;
   private readonly ws: WebSocket;
-  private readonly roomId: string;
+  /** Null until the relay confirms the room, when the code is relay-assigned. */
+  private assignedRoomId: string | null;
+  private readonly onRoomCode?: (roomCode: string) => void;
   /** Connected phone connection ids (relay peer ids). */
   private readonly peers = new Set<string>();
 
   constructor(options: RelayDisplayHostOptions<S, A>) {
-    const { url, roomId, ...runtimeConfig } = options;
-    this.roomId = roomId;
+    const { url, roomId, onRoomCode, ...runtimeConfig } = options;
+    this.assignedRoomId = roomId ?? null;
+    this.onRoomCode = onRoomCode;
     this.runtime = new GameHostRuntime<S, A>(runtimeConfig);
     this.ws = new WebSocket(relayRoomUrl(url, roomId));
 
     this.ws.onopen = () => {
+      // No roomId asks the relay to allocate one. Sending the field as
+      // undefined omits it from the JSON, which is what the relay reads as
+      // "you pick".
       this.ws.send(
         JSON.stringify({
           type: RelayMessageTypes.CREATE_ROOM,
-          roomId: this.roomId,
+          roomId: this.assignedRoomId ?? undefined,
         }),
       );
     };
@@ -89,6 +110,15 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
     this.runtime.setTransport(transport);
   }
 
+  /**
+   * The room code phones join with, or `null` before the relay has assigned
+   * one. See {@link RelayDisplayHostOptions.onRoomCode} to be told when it
+   * arrives.
+   */
+  get roomCode(): string | null {
+    return this.assignedRoomId;
+  }
+
   /** Current authoritative game state. */
   getState = (): S => this.runtime.getState();
 
@@ -109,7 +139,10 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
   private sendEnvelope(message: HostMessage, to?: string): void {
     const envelope: Record<string, unknown> = {
       type: RelayMessageTypes.DATA,
-      roomId: this.roomId,
+      // The relay routes by the sender's membership, not this field, so it is
+      // only ever informational — and nothing is sent before a peer joins,
+      // which cannot happen until the room exists.
+      roomId: this.assignedRoomId ?? undefined,
       data: JSON.stringify(message),
     };
     if (to !== undefined) envelope.to = to;
@@ -147,10 +180,16 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
           );
         break;
       }
+      case RelayMessageTypes.ROOM_CREATED:
+        // Carries the code when the relay chose it, and confirms the code when
+        // the caller supplied one.
+        this.assignedRoomId = msg.roomId;
+        this.onRoomCode?.(msg.roomId);
+        break;
       case RelayMessageTypes.ERROR:
         this.runtime.handleError(new Error(msg.message));
         break;
-      // ROOM_CREATED / ROOM_JOINED are acknowledgements; no action needed.
+      // ROOM_JOINED is an acknowledgement; no action needed.
     }
   }
 }