@diffenderfer-games/hub 2.0.0-next.0 → 2.0.0-next.1

package/src/realtime/room-types.ts

@@ -1,125 +1,125 @@
-/**
- * Hub relay rooms as games see them through `hub.rooms`: realtime
- * multiplayer for static games, relayed (never refereed) by the hub.
- */
-import type { Json, RoomInfo } from '@diffenderfer-games/hub-contract';
-import type { RoomChatLine, RoomMessage } from './wire-types';
-
-/** The shared room state (a JSON object, at most 32 KB). */
-export type RoomState = Record<string, Json>;
-
-/** Options for `hub.rooms.create`. `game` defaults to the current slug. */
-export interface RoomCreateOptions {
-  /** The game slug (default: this page's game). */
-  game?: string;
-  /** The game mode. */
-  mode?: string;
-  /** Listed in `hub.rooms.list` (default false). */
-  public?: boolean;
-  /** Seats. */
-  maxPlayers?: number;
-  /** `host` (default): guests' unaddressed sends reach the host only. `relay`: everyone hears every send. */
-  model?: 'host' | 'relay';
-  /** Seat this party in the room. */
-  partyId?: string;
-}
-
-/** Options for joining a room or race. */
-export interface JoinOptions {
-  /** Watch instead of taking a seat (if the game allows spectators). */
-  spectate?: boolean;
-}
-
-/** Events a {@link HubRoom} emits, name → payload. */
-export interface RoomEvents {
-  /** The room changed: roster, ready flags, phase, host. */
-  room: RoomInfo;
-  /** A relayed game message. */
-  msg: RoomMessage;
-  /** The shared state after a change. */
-  state: RoomState;
-  /** A moderated chat line. */
-  chat: RoomChatLine;
-  /** The host removed me. */
-  kicked: { roomId: string };
-  /**
-   * The room is gone for this tab. `reason`: empty, ended, host_left,
-   * other_tab, moved, removed, or `gone` (client-side: the seat couldn't be
-   * reclaimed after a reconnect, e.g. the host restarted).
-   */
-  closed: { reason: string };
-  /** The host ended the match (phase → `ended`); `results` is what it passed to `end()`. Fires once. */
-  ended: { room: RoomInfo; results?: Json };
-  /** A player left mid-game (or their reconnect grace ran out). */
-  abandoned: { userId: number; reason?: string };
-}
-
-/** Who I am in a room. */
-export interface RoomSelf {
-  /** My user id. */
-  userId: number;
-  /** I host the room. */
-  host: boolean;
-  /** I'm watching, not seated. */
-  spectator: boolean;
-}
-
-/** Options for {@link HubRoom.send}. */
-export interface RoomSendOptions {
-  /** Send to this seat only. */
-  to?: number;
-}
-
-/** Options for {@link HubRoom.setState}. */
-export interface RoomStateOptions {
-  /** Replace the whole state instead of shallow-merging the patch. */
-  replace?: boolean;
-}
-
-/** A live hub relay room, as games see it. */
-export interface HubRoom {
-  /** The room as last reported. */
-  readonly info: RoomInfo;
-  /** The shared room state (at most 32 KB). */
-  readonly state: RoomState;
-  /** Who I am in this room. */
-  readonly me: RoomSelf;
-  /** Subscribe to a room event. Returns the unsubscribe function. */
-  on<Name extends keyof RoomEvents>(event: Name, listener: (payload: RoomEvents[Name]) => void): () => void;
-  /** Mark my seat ready (or not). */
-  ready(isReady: boolean): Promise<void>;
-  /** Set my seat's small game data (team, colour…), at most 2 KB. */
-  seat(seatData: Json): Promise<void>;
-  /** Host: start the match. */
-  start(): Promise<void>;
-  /** Relay a game message. */
-  send(message: Json, options?: RoomSendOptions): Promise<void>;
-  /** Change the shared state. */
-  setState(patch: RoomState, options?: RoomStateOptions): Promise<void>;
-  /** Free-text chat; resolves with the delivered (maybe softened) text, rejects with a content rejection. */
-  chat(text: string): Promise<string>;
-  /** Send a quick-chat phrase. */
-  quick(phraseId: string): Promise<void>;
-  /** Host: remove a player. */
-  kick(userId: number): Promise<void>;
-  /** Leave the room. */
-  leave(): Promise<void>;
-  /** Host: end the match, with optional results for everyone. */
-  end(results?: Json): Promise<void>;
-}
-
-/** Options for `hub.rooms.list`. */
-export interface RoomListOptions {
-  /** Only rooms in this mode. */
-  mode?: string;
-}
-
-/** `hub.rooms`: hub relay rooms (static games, no server). */
-export interface HubRoomsApi {
-  /** Create a room and take its first seat. */
-  create(options?: RoomCreateOptions): Promise<HubRoom>;
-  /** Join a room by its 5-character code or its id. */
-  join(codeOrId: string, options?: JoinOptions): Promise<HubRoom>;
-  /** Public rooms in the lobby phase for this game. */
-  list(options?: RoomListOptions): Promise<RoomInfo[]>;
-}
+/**
+ * Hub relay rooms as games see them through `hub.rooms`: realtime
+ * multiplayer for static games, relayed (never refereed) by the hub.
+ */
+import type { Json, RoomInfo } from '@diffenderfer-games/hub-contract';
+import type { RoomChatLine, RoomMessage } from './wire-types';
+
+/** The shared room state (a JSON object, at most 32 KB). */
+export type RoomState = Record<string, Json>;
+
+/** Options for `hub.rooms.create`. `game` defaults to the current slug. */
+export interface RoomCreateOptions {
+  /** The game slug (default: this page's game). */
+  game?: string;
+  /** The game mode. */
+  mode?: string;
+  /** Listed in `hub.rooms.list` (default false). */
+  public?: boolean;
+  /** Seats. */
+  maxPlayers?: number;
+  /** `host` (default): guests' unaddressed sends reach the host only. `relay`: everyone hears every send. */
+  model?: 'host' | 'relay';
+  /** Seat this party in the room. */
+  partyId?: string;
+}
+
+/** Options for joining a room or race. */
+export interface JoinOptions {
+  /** Watch instead of taking a seat (if the game allows spectators). */
+  spectate?: boolean;
+}
+
+/** Events a {@link HubRoom} emits, name → payload. */
+export interface RoomEvents {
+  /** The room changed: roster, ready flags, phase, host. */
+  room: RoomInfo;
+  /** A relayed game message. */
+  msg: RoomMessage;
+  /** The shared state after a change. */
+  state: RoomState;
+  /** A moderated chat line. */
+  chat: RoomChatLine;
+  /** The host removed me. */
+  kicked: { roomId: string };
+  /**
+   * The room is gone for this tab. `reason`: empty, ended, host_left,
+   * other_tab, moved, removed, or `gone` (client-side: the seat couldn't be
+   * reclaimed after a reconnect, e.g. the host restarted).
+   */
+  closed: { reason: string };
+  /** The host ended the match (phase → `ended`); `results` is what it passed to `end()`. Fires once. */
+  ended: { room: RoomInfo; results?: Json };
+  /** A player left mid-game (or their reconnect grace ran out). */
+  abandoned: { userId: number; reason?: string };
+}
+
+/** Who I am in a room. */
+export interface RoomSelf {
+  /** My user id. */
+  userId: number;
+  /** I host the room. */
+  host: boolean;
+  /** I'm watching, not seated. */
+  spectator: boolean;
+}
+
+/** Options for {@link HubRoom.send}. */
+export interface RoomSendOptions {
+  /** Send to this seat only. */
+  to?: number;
+}
+
+/** Options for {@link HubRoom.setState}. */
+export interface RoomStateOptions {
+  /** Replace the whole state instead of shallow-merging the patch. */
+  replace?: boolean;
+}
+
+/** A live hub relay room, as games see it. */
+export interface HubRoom {
+  /** The room as last reported. */
+  readonly info: RoomInfo;
+  /** The shared room state (at most 32 KB). */
+  readonly state: RoomState;
+  /** Who I am in this room. */
+  readonly me: RoomSelf;
+  /** Subscribe to a room event. Returns the unsubscribe function. */
+  on<Name extends keyof RoomEvents>(event: Name, listener: (payload: RoomEvents[Name]) => void): () => void;
+  /** Mark my seat ready (or not). */
+  ready(isReady: boolean): Promise<void>;
+  /** Set my seat's small game data (team, colour…), at most 2 KB. */
+  seat(seatData: Json): Promise<void>;
+  /** Host: start the match. */
+  start(): Promise<void>;
+  /** Relay a game message. */
+  send(message: Json, options?: RoomSendOptions): Promise<void>;
+  /** Change the shared state. */
+  setState(patch: RoomState, options?: RoomStateOptions): Promise<void>;
+  /** Free-text chat; resolves with the delivered (maybe softened) text, rejects with a content rejection. */
+  chat(text: string): Promise<string>;
+  /** Send a quick-chat phrase. */
+  quick(phraseId: string): Promise<void>;
+  /** Host: remove a player. */
+  kick(userId: number): Promise<void>;
+  /** Leave the room. */
+  leave(): Promise<void>;
+  /** Host: end the match, with optional results for everyone. */
+  end(results?: Json): Promise<void>;
+}
+
+/** Options for `hub.rooms.list`. */
+export interface RoomListOptions {
+  /** Only rooms in this mode. */
+  mode?: string;
+}
+
+/** `hub.rooms`: hub relay rooms (static games, no server). */
+export interface HubRoomsApi {
+  /** Create a room and take its first seat. */
+  create(options?: RoomCreateOptions): Promise<HubRoom>;
+  /** Join a room by its 5-character code or its id. */
+  join(codeOrId: string, options?: JoinOptions): Promise<HubRoom>;
+  /** Public rooms in the lobby phase for this game. */
+  list(options?: RoomListOptions): Promise<RoomInfo[]>;
+}

package/src/realtime/rooms-forwarder.ts

@@ -1,79 +1,79 @@
-/**
- * `hub.rooms`: hub relay rooms, forwarded to the social runtime. Each room is
- * wrapped so its rejections use the core client's error classes.
- */
-import type { Json, RoomInfo } from '@diffenderfer-games/hub-contract';
-import { pageBridge, rethrowAsHubError } from './bridge';
-import type { HubRoom, HubRoomsApi, RoomEvents, RoomSelf, RoomSendOptions, RoomState, RoomStateOptions } from './room-types';
-
-/** A runtime room whose rejections are re-created as the core client's errors. */
-class ForwardedRoom implements HubRoom {
-  private readonly room: HubRoom;
-
-  constructor(room: HubRoom) {
-    this.room = room;
-  }
-
-  get info(): RoomInfo {
-    return this.room.info;
-  }
-
-  get state(): RoomState {
-    return this.room.state;
-  }
-
-  get me(): RoomSelf {
-    return this.room.me;
-  }
-
-  on<Name extends keyof RoomEvents>(event: Name, listener: (payload: RoomEvents[Name]) => void): () => void {
-    return this.room.on(event, listener);
-  }
-
-  ready(isReady: boolean): Promise<void> {
-    return rethrowAsHubError(this.room.ready(isReady));
-  }
-
-  seat(seatData: Json): Promise<void> {
-    return rethrowAsHubError(this.room.seat(seatData));
-  }
-
-  start(): Promise<void> {
-    return rethrowAsHubError(this.room.start());
-  }
-
-  send(message: Json, options?: RoomSendOptions): Promise<void> {
-    return rethrowAsHubError(this.room.send(message, options));
-  }
-
-  setState(patch: RoomState, options?: RoomStateOptions): Promise<void> {
-    return rethrowAsHubError(this.room.setState(patch, options));
-  }
-
-  chat(text: string): Promise<string> {
-    return rethrowAsHubError(this.room.chat(text));
-  }
-
-  quick(phraseId: string): Promise<void> {
-    return rethrowAsHubError(this.room.quick(phraseId));
-  }
-
-  kick(userId: number): Promise<void> {
-    return rethrowAsHubError(this.room.kick(userId));
-  }
-
-  leave(): Promise<void> {
-    return rethrowAsHubError(this.room.leave());
-  }
-
-  end(results?: Json): Promise<void> {
-    return rethrowAsHubError(this.room.end(results));
-  }
-}
-
-/** `hub.rooms`: hub relay rooms. */
-export const roomsForwarder: HubRoomsApi = {
-  create: (options) => pageBridge.call(async (realtime) => new ForwardedRoom(await realtime.rooms.create(options))),
-  join: (codeOrId, options) => pageBridge.call(async (realtime) => new ForwardedRoom(await realtime.rooms.join(codeOrId, options))),
-  list: (options) => pageBridge.call((realtime) => realtime.rooms.list(options)),
-};
+/**
+ * `hub.rooms`: hub relay rooms, forwarded to the social runtime. Each room is
+ * wrapped so its rejections use the core client's error classes.
+ */
+import type { Json, RoomInfo } from '@diffenderfer-games/hub-contract';
+import { pageBridge, rethrowAsHubError } from './bridge';
+import type { HubRoom, HubRoomsApi, RoomEvents, RoomSelf, RoomSendOptions, RoomState, RoomStateOptions } from './room-types';
+
+/** A runtime room whose rejections are re-created as the core client's errors. */
+class ForwardedRoom implements HubRoom {
+  private readonly room: HubRoom;
+
+  constructor(room: HubRoom) {
+    this.room = room;
+  }
+
+  get info(): RoomInfo {
+    return this.room.info;
+  }
+
+  get state(): RoomState {
+    return this.room.state;
+  }
+
+  get me(): RoomSelf {
+    return this.room.me;
+  }
+
+  on<Name extends keyof RoomEvents>(event: Name, listener: (payload: RoomEvents[Name]) => void): () => void {
+    return this.room.on(event, listener);
+  }
+
+  ready(isReady: boolean): Promise<void> {
+    return rethrowAsHubError(this.room.ready(isReady));
+  }
+
+  seat(seatData: Json): Promise<void> {
+    return rethrowAsHubError(this.room.seat(seatData));
+  }
+
+  start(): Promise<void> {
+    return rethrowAsHubError(this.room.start());
+  }
+
+  send(message: Json, options?: RoomSendOptions): Promise<void> {
+    return rethrowAsHubError(this.room.send(message, options));
+  }
+
+  setState(patch: RoomState, options?: RoomStateOptions): Promise<void> {
+    return rethrowAsHubError(this.room.setState(patch, options));
+  }
+
+  chat(text: string): Promise<string> {
+    return rethrowAsHubError(this.room.chat(text));
+  }
+
+  quick(phraseId: string): Promise<void> {
+    return rethrowAsHubError(this.room.quick(phraseId));
+  }
+
+  kick(userId: number): Promise<void> {
+    return rethrowAsHubError(this.room.kick(userId));
+  }
+
+  leave(): Promise<void> {
+    return rethrowAsHubError(this.room.leave());
+  }
+
+  end(results?: Json): Promise<void> {
+    return rethrowAsHubError(this.room.end(results));
+  }
+}
+
+/** `hub.rooms`: hub relay rooms. */
+export const roomsForwarder: HubRoomsApi = {
+  create: (options) => pageBridge.call(async (realtime) => new ForwardedRoom(await realtime.rooms.create(options))),
+  join: (codeOrId, options) => pageBridge.call(async (realtime) => new ForwardedRoom(await realtime.rooms.join(codeOrId, options))),
+  list: (options) => pageBridge.call((realtime) => realtime.rooms.list(options)),
+};

package/src/realtime/runtime-api.ts

@@ -1,49 +1,49 @@
-/**
- * The realtime API the hub's social runtime (`/_hub/social.js`) installs on
- * the page, and that `hub.presence`, `hub.social`, `hub.mp`, `hub.rooms`,
- * `hub.notify` and `hub.race` forward to.
- */
-import type { HubMpApi } from './multiplayer-types';
-import type { HubRaceApi } from './race-types';
-import type { HubRoomsApi } from './room-types';
-import type { HubNotifyApi, HubPresenceApi, HubSocialApi } from './social-types';
-
-/**
- * The realtime feature version the runtime reports in {@link RealtimeApi.version}.
- * 2 added races; a client feature-detects newer additions with it.
- */
-export const REALTIME_FEATURE_VERSION = 2;
-
-/**
- * The cross-bundle shape number of the `rt` page singleton (plan §4.4). The
- * runtime registers with it through `claimSingleton`; bump it only when the
- * shape of {@link RealtimeApi} changes incompatibly.
- */
-export const REALTIME_SINGLETON_API = 1;
-
-/** The window event the runtime fires once it has installed itself. */
-export const REALTIME_READY_EVENT = 'hub:rt-ready';
-
-/** The window event the menu fires when the runtime failed to load (its reason is on `window.__HUB_RT_ERROR__`). */
-export const REALTIME_FAILED_EVENT = 'hub:rt-failed';
-
-/**
- * Installed by the social runtime as the page's `rt` singleton (and the v1
- * alias `window.__HUB_RT__`).
- */
-export interface RealtimeApi {
-  /** The runtime's feature version (see {@link REALTIME_FEATURE_VERSION}). */
-  readonly version: number;
-  /** Presence reporting. */
-  presence: HubPresenceApi;
-  /** Friends and the social dialogs. */
-  social: HubSocialApi;
-  /** Invites, launches, the leave guard and tickets. */
-  mp: HubMpApi;
-  /** Hub relay rooms. */
-  rooms: HubRoomsApi;
-  /** Toast behaviour. */
-  notify: HubNotifyApi;
-  /** Races (feature version 2 and later). */
-  race?: HubRaceApi;
-}
+/**
+ * The realtime API the hub's social runtime (`/_hub/social.js`) installs on
+ * the page, and that `hub.presence`, `hub.social`, `hub.mp`, `hub.rooms`,
+ * `hub.notify` and `hub.race` forward to.
+ */
+import type { HubMpApi } from './multiplayer-types';
+import type { HubRaceApi } from './race-types';
+import type { HubRoomsApi } from './room-types';
+import type { HubNotifyApi, HubPresenceApi, HubSocialApi } from './social-types';
+
+/**
+ * The realtime feature version the runtime reports in {@link RealtimeApi.version}.
+ * 2 added races; a client feature-detects newer additions with it.
+ */
+export const REALTIME_FEATURE_VERSION = 2;
+
+/**
+ * The cross-bundle shape number of the `rt` page singleton (plan §4.4). The
+ * runtime registers with it through `claimSingleton`; bump it only when the
+ * shape of {@link RealtimeApi} changes incompatibly.
+ */
+export const REALTIME_SINGLETON_API = 1;
+
+/** The window event the runtime fires once it has installed itself. */
+export const REALTIME_READY_EVENT = 'hub:rt-ready';
+
+/** The window event the menu fires when the runtime failed to load (its reason is on `window.__HUB_RT_ERROR__`). */
+export const REALTIME_FAILED_EVENT = 'hub:rt-failed';
+
+/**
+ * Installed by the social runtime as the page's `rt` singleton (and the v1
+ * alias `window.__HUB_RT__`).
+ */
+export interface RealtimeApi {
+  /** The runtime's feature version (see {@link REALTIME_FEATURE_VERSION}). */
+  readonly version: number;
+  /** Presence reporting. */
+  presence: HubPresenceApi;
+  /** Friends and the social dialogs. */
+  social: HubSocialApi;
+  /** Invites, launches, the leave guard and tickets. */
+  mp: HubMpApi;
+  /** Hub relay rooms. */
+  rooms: HubRoomsApi;
+  /** Toast behaviour. */
+  notify: HubNotifyApi;
+  /** Races (feature version 2 and later). */
+  race?: HubRaceApi;
+}

package/src/realtime/runtime-opener.ts

@@ -1,61 +1,61 @@
-/**
- * Opening the runtime's UI (a player card, the friends drawer, the race
- * sheet) from a game button. A tap must never look dead: if the runtime isn't
- * there within a moment the player is told it is loading, and if it never
- * arrives, how to recover.
- */
-import type { RealtimeBridge } from './bridge';
-import { hideFallbackNotice, showFallbackNotice } from './fallback-notice';
-import { readRuntimeFailure } from './page-runtime';
-import type { RealtimeApi } from './runtime-api';
-import { REALTIME_FAILED_EVENT } from './runtime-api';
-
-/** How long before "still loading" shows. */
-const SLOW_NOTICE_MS = 1500;
-/** How long the failure notice stays up. */
-const FAILURE_NOTICE_MS = 8000;
-
-/** Tell the player the social runtime failed, with the reason the menu recorded. */
-function showRuntimeFailure(): void {
-  const reason = readRuntimeFailure();
-  showFallbackNotice(`Friends couldn't load${reason === '' ? '' : ` (${reason})`}. Reload the page to try again.`, FAILURE_NOTICE_MS);
-}
-
-/** Make an opener: runs a UI call on the runtime once it is up, with the loading and failure notices. */
-export function createRuntimeOpener(bridge: RealtimeBridge): (openUi: (realtime: RealtimeApi) => void) => void {
-  return (openUi) => {
-    const loaded = bridge.current();
-    if (loaded !== null) {
-      openUi(loaded);
-      return;
-    }
-    // The menu already knows the runtime failed.
-    if (readRuntimeFailure() !== '') {
-      showRuntimeFailure();
-      return;
-    }
-    const slowTimer = setTimeout(() => {
-      showFallbackNotice('Friends are still loading…');
-    }, SLOW_NOTICE_MS);
-    let isSettled = false;
-    const onFailed = (): void => {
-      if (!isSettled) {
-        isSettled = true;
-        clearTimeout(slowTimer);
-        showRuntimeFailure();
-      }
-    };
-    if (typeof window !== 'undefined') {
-      window.addEventListener(REALTIME_FAILED_EVENT, onFailed, { once: true });
-    }
-    bridge.whenReady().then((realtime) => {
-      if (isSettled) {
-        return;
-      }
-      isSettled = true;
-      clearTimeout(slowTimer);
-      hideFallbackNotice();
-      openUi(realtime);
-    }, onFailed);
-  };
-}
+/**
+ * Opening the runtime's UI (a player card, the friends drawer, the race
+ * sheet) from a game button. A tap must never look dead: if the runtime isn't
+ * there within a moment the player is told it is loading, and if it never
+ * arrives, how to recover.
+ */
+import type { RealtimeBridge } from './bridge';
+import { hideFallbackNotice, showFallbackNotice } from './fallback-notice';
+import { readRuntimeFailure } from './page-runtime';
+import type { RealtimeApi } from './runtime-api';
+import { REALTIME_FAILED_EVENT } from './runtime-api';
+
+/** How long before "still loading" shows. */
+const SLOW_NOTICE_MS = 1500;
+/** How long the failure notice stays up. */
+const FAILURE_NOTICE_MS = 8000;
+
+/** Tell the player the social runtime failed, with the reason the menu recorded. */
+function showRuntimeFailure(): void {
+  const reason = readRuntimeFailure();
+  showFallbackNotice(`Friends couldn't load${reason === '' ? '' : ` (${reason})`}. Reload the page to try again.`, FAILURE_NOTICE_MS);
+}
+
+/** Make an opener: runs a UI call on the runtime once it is up, with the loading and failure notices. */
+export function createRuntimeOpener(bridge: RealtimeBridge): (openUi: (realtime: RealtimeApi) => void) => void {
+  return (openUi) => {
+    const loaded = bridge.current();
+    if (loaded !== null) {
+      openUi(loaded);
+      return;
+    }
+    // The menu already knows the runtime failed.
+    if (readRuntimeFailure() !== '') {
+      showRuntimeFailure();
+      return;
+    }
+    const slowTimer = setTimeout(() => {
+      showFallbackNotice('Friends are still loading…');
+    }, SLOW_NOTICE_MS);
+    let isSettled = false;
+    const onFailed = (): void => {
+      if (!isSettled) {
+        isSettled = true;
+        clearTimeout(slowTimer);
+        showRuntimeFailure();
+      }
+    };
+    if (typeof window !== 'undefined') {
+      window.addEventListener(REALTIME_FAILED_EVENT, onFailed, { once: true });
+    }
+    bridge.whenReady().then((realtime) => {
+      if (isSettled) {
+        return;
+      }
+      isSettled = true;
+      clearTimeout(slowTimer);
+      hideFallbackNotice();
+      openUi(realtime);
+    }, onFailed);
+  };
+}