@thegeem/protocol 0.1.34 → 0.1.36

package/dist/index.d.cts

@@ -692,6 +692,34 @@ interface LobbyPlayer {
     /** Team index once the game has started; null/absent in the lobby. */
     teamIndex?: number | null;
 }
+/**
+ * Who is in the room, carried ON the game-state push (gs#71).
+ *
+ * `players[]` in the `lobby` frame is the only other carrier of names, and the lobby does not go out
+ * mid-game — deliberately, since a stray `lobby` under a running game bounces clients off their board
+ * (the gs#49 class). So a client that refreshed mid-game had NO roster for the rest of the game, and
+ * every id→name lookup degraded to whatever that client happened to use as its null-fallback: «؟» on
+ * web, the colour name in دامة on Android (readable by luck), and an empty string in ارسمها (a sentence
+ * with a hole in it).
+ *
+ * It rides ON the state message rather than arriving as a separate frame because both consuming teams
+ * asked for that independently, for the same reason: a roster in its own message can land either side
+ * of the state push, giving one render with names and one without on clients that redraw per state.
+ * Bundled, it cannot race.
+ *
+ * Unlike `LobbyPlayer` this INCLUDES THE HOST (`isHost`), who is filtered out of `lobby.players` by
+ * design and therefore has no row — yet needs a face wherever the host can appear, e.g. the `tally`.
+ */
+interface RosterEntry {
+    id: string;
+    name: string;
+    /** Privacy-safe avatar (emoji + color); absent if unset. */
+    avatar?: AvatarView;
+    /** True for the room's host, who has no row in `lobby.players`. */
+    isHost?: boolean;
+    /** Is this person currently connected? Mirrors `LobbyPlayer.connected`. */
+    connected?: boolean;
+}
 /** Per-recipient context attached to lobby/state pushes. */
 interface YouContext {
     id: string;
@@ -710,6 +738,25 @@ interface CategoryView {
     /** Category's brand color (hex, e.g. '#E8473F') for board coloring; absent if the category has none. */
     color?: string;
 }
+/**
+ * A content pack — the grouping the category strip renders as a row (geem-server#76).
+ *
+ * **The ARRAY ORDER is the pack order.** That is the point of this type: pack order previously had no
+ * home on the wire, so all four clients derived it by first-seen from `categories[]` (Android's
+ * `onlineGroupedPacks`, iOS's `order: [String]`, and web/TV their own). Four derivations of one fact,
+ * and when the server's own category order turned out to be non-deterministic the strip reshuffled
+ * between visits (gs#74) with nothing on the wire to pin it. One ordered array replaces all four.
+ *
+ * Deliberately NO `sortOrder` field: an ordered array already carries the order, and a positional index
+ * beside it would be the same fact stored twice — which is exactly the drift argument that made
+ * `has_image` a boolean rather than a filename. Position cannot disagree with itself.
+ */
+interface PackView {
+    id: string;
+    name: string;
+    /** Does this pack have cover art at `/assets/cat/pack-<id>.png`? Absent until the admin field ships. */
+    hasImage?: boolean;
+}
 type GameStatus = 'setup' | 'categorySelection' | 'inProgress' | 'completed';
 type GameplayFlow = 'classic' | 'openJudged' | 'noHost' | 'buzzer';
 type BuzzerGameMode = 'off' | 'solo' | 'race' | 'controller';
@@ -940,6 +987,7 @@ type ServerMsg = {
     hostPinned?: boolean;
     players: LobbyPlayer[];
     categories: CategoryView[];
+    packs?: PackView[];
     selectedCategoryIds: string[];
     teams: TeamSlotView[];
     hostActivity: 'configuring' | 'idle';
@@ -954,16 +1002,19 @@ type ServerMsg = {
     view: GameStateView;
     you: YouContext;
     teamConnected: boolean[];
+    roster?: RosterEntry[];
 } | {
     t: 'damaState';
     gameId: 'dama';
     view: DamaStateView;
     you: YouContext;
+    roster?: RosterEntry[];
 } | {
     t: 'ersimhaState';
     gameId: 'ersimha';
     view: ErsimhaStateView;
     you: YouContext;
+    roster?: RosterEntry[];
 } | {
     t: 'strokeBatch';
     from: string;
@@ -995,4 +1046,4 @@ type ServerMsg = {
     message: string;
 };
 
-export { type AvatarView, type BuzzerGameMode, CHARACTER_IDS, type CategoryView, type CharacterId, ClientMsg, type DamaMoveView, type DamaPieceView, type DamaStateView, EMOTE_IDS, type Effect, type EmoteId, type ErsimhaStateView, GAMES, GAME_IDS, type GameId, type GameInfo, type GameStateView, type GameStatus, type GameplayFlow, type HelpName, LIMITS, type LobbyPlayer, MIN_SUPPORTED_PV, MODES, MODE_IDS, type ModeId, type ModeInfo, PROTOCOL_VERSION, type QuestionView, ROOM_ALPHABET, type ServerMsg, type SoundName, type StrokePointView, type TeamSlotView, type TeamView, type YouContext, gameIdForPv, gamesForPv, modesForGame };
+export { type AvatarView, type BuzzerGameMode, CHARACTER_IDS, type CategoryView, type CharacterId, ClientMsg, type DamaMoveView, type DamaPieceView, type DamaStateView, EMOTE_IDS, type Effect, type EmoteId, type ErsimhaStateView, GAMES, GAME_IDS, type GameId, type GameInfo, type GameStateView, type GameStatus, type GameplayFlow, type HelpName, LIMITS, type LobbyPlayer, MIN_SUPPORTED_PV, MODES, MODE_IDS, type ModeId, type ModeInfo, PROTOCOL_VERSION, type PackView, type QuestionView, ROOM_ALPHABET, type RosterEntry, type ServerMsg, type SoundName, type StrokePointView, type TeamSlotView, type TeamView, type YouContext, gameIdForPv, gamesForPv, modesForGame };

package/dist/index.d.ts

@@ -692,6 +692,34 @@ interface LobbyPlayer {
     /** Team index once the game has started; null/absent in the lobby. */
     teamIndex?: number | null;
 }
+/**
+ * Who is in the room, carried ON the game-state push (gs#71).
+ *
+ * `players[]` in the `lobby` frame is the only other carrier of names, and the lobby does not go out
+ * mid-game — deliberately, since a stray `lobby` under a running game bounces clients off their board
+ * (the gs#49 class). So a client that refreshed mid-game had NO roster for the rest of the game, and
+ * every id→name lookup degraded to whatever that client happened to use as its null-fallback: «؟» on
+ * web, the colour name in دامة on Android (readable by luck), and an empty string in ارسمها (a sentence
+ * with a hole in it).
+ *
+ * It rides ON the state message rather than arriving as a separate frame because both consuming teams
+ * asked for that independently, for the same reason: a roster in its own message can land either side
+ * of the state push, giving one render with names and one without on clients that redraw per state.
+ * Bundled, it cannot race.
+ *
+ * Unlike `LobbyPlayer` this INCLUDES THE HOST (`isHost`), who is filtered out of `lobby.players` by
+ * design and therefore has no row — yet needs a face wherever the host can appear, e.g. the `tally`.
+ */
+interface RosterEntry {
+    id: string;
+    name: string;
+    /** Privacy-safe avatar (emoji + color); absent if unset. */
+    avatar?: AvatarView;
+    /** True for the room's host, who has no row in `lobby.players`. */
+    isHost?: boolean;
+    /** Is this person currently connected? Mirrors `LobbyPlayer.connected`. */
+    connected?: boolean;
+}
 /** Per-recipient context attached to lobby/state pushes. */
 interface YouContext {
     id: string;
@@ -710,6 +738,25 @@ interface CategoryView {
     /** Category's brand color (hex, e.g. '#E8473F') for board coloring; absent if the category has none. */
     color?: string;
 }
+/**
+ * A content pack — the grouping the category strip renders as a row (geem-server#76).
+ *
+ * **The ARRAY ORDER is the pack order.** That is the point of this type: pack order previously had no
+ * home on the wire, so all four clients derived it by first-seen from `categories[]` (Android's
+ * `onlineGroupedPacks`, iOS's `order: [String]`, and web/TV their own). Four derivations of one fact,
+ * and when the server's own category order turned out to be non-deterministic the strip reshuffled
+ * between visits (gs#74) with nothing on the wire to pin it. One ordered array replaces all four.
+ *
+ * Deliberately NO `sortOrder` field: an ordered array already carries the order, and a positional index
+ * beside it would be the same fact stored twice — which is exactly the drift argument that made
+ * `has_image` a boolean rather than a filename. Position cannot disagree with itself.
+ */
+interface PackView {
+    id: string;
+    name: string;
+    /** Does this pack have cover art at `/assets/cat/pack-<id>.png`? Absent until the admin field ships. */
+    hasImage?: boolean;
+}
 type GameStatus = 'setup' | 'categorySelection' | 'inProgress' | 'completed';
 type GameplayFlow = 'classic' | 'openJudged' | 'noHost' | 'buzzer';
 type BuzzerGameMode = 'off' | 'solo' | 'race' | 'controller';
@@ -940,6 +987,7 @@ type ServerMsg = {
     hostPinned?: boolean;
     players: LobbyPlayer[];
     categories: CategoryView[];
+    packs?: PackView[];
     selectedCategoryIds: string[];
     teams: TeamSlotView[];
     hostActivity: 'configuring' | 'idle';
@@ -954,16 +1002,19 @@ type ServerMsg = {
     view: GameStateView;
     you: YouContext;
     teamConnected: boolean[];
+    roster?: RosterEntry[];
 } | {
     t: 'damaState';
     gameId: 'dama';
     view: DamaStateView;
     you: YouContext;
+    roster?: RosterEntry[];
 } | {
     t: 'ersimhaState';
     gameId: 'ersimha';
     view: ErsimhaStateView;
     you: YouContext;
+    roster?: RosterEntry[];
 } | {
     t: 'strokeBatch';
     from: string;
@@ -995,4 +1046,4 @@ type ServerMsg = {
     message: string;
 };
 
-export { type AvatarView, type BuzzerGameMode, CHARACTER_IDS, type CategoryView, type CharacterId, ClientMsg, type DamaMoveView, type DamaPieceView, type DamaStateView, EMOTE_IDS, type Effect, type EmoteId, type ErsimhaStateView, GAMES, GAME_IDS, type GameId, type GameInfo, type GameStateView, type GameStatus, type GameplayFlow, type HelpName, LIMITS, type LobbyPlayer, MIN_SUPPORTED_PV, MODES, MODE_IDS, type ModeId, type ModeInfo, PROTOCOL_VERSION, type QuestionView, ROOM_ALPHABET, type ServerMsg, type SoundName, type StrokePointView, type TeamSlotView, type TeamView, type YouContext, gameIdForPv, gamesForPv, modesForGame };
+export { type AvatarView, type BuzzerGameMode, CHARACTER_IDS, type CategoryView, type CharacterId, ClientMsg, type DamaMoveView, type DamaPieceView, type DamaStateView, EMOTE_IDS, type Effect, type EmoteId, type ErsimhaStateView, GAMES, GAME_IDS, type GameId, type GameInfo, type GameStateView, type GameStatus, type GameplayFlow, type HelpName, LIMITS, type LobbyPlayer, MIN_SUPPORTED_PV, MODES, MODE_IDS, type ModeId, type ModeInfo, PROTOCOL_VERSION, type PackView, type QuestionView, ROOM_ALPHABET, type RosterEntry, type ServerMsg, type SoundName, type StrokePointView, type TeamSlotView, type TeamView, type YouContext, gameIdForPv, gamesForPv, modesForGame };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thegeem/protocol",
-  "version": "0.1.34",
+  "version": "0.1.36",
   "description": "Geem's wire protocol — shared zod schemas + TypeScript types for talking to the Geem game server over Socket.IO. The source of truth all clients implement against.",
   "license": "UNLICENSED",
   "homepage": "https://geem.tv",