@thegeem/protocol 0.1.33 → 0.1.35

package/dist/index.cjs

@@ -90,6 +90,7 @@ var HelpType = import_zod.z.enum([
 var Pv = import_zod.z.number().int().min(1).max(1e6).optional();
 var IdToken = import_zod.z.string().max(4096).optional();
 var Platform = import_zod.z.enum(["web", "ios", "android"]).optional();
+var AppVersion = import_zod.z.string().trim().max(24).regex(/^[0-9]+(\.[0-9]+){0,3}([-+][0-9A-Za-z.-]+)?$/, "bad app version").optional();
 var Avatar = import_zod.z.object({
   emoji: import_zod.z.string().min(1).max(16).transform((s) => s.replace(UNSAFE_CHARS, "")).refine((s) => s.length >= 1, "empty emoji"),
   color: import_zod.z.string().regex(/^#[0-9a-fA-F]{6}$/, "color must be #rrggbb")
@@ -97,7 +98,7 @@ var Avatar = import_zod.z.object({
 var Character = import_zod.z.enum(CHARACTER_IDS);
 var ClientMsg = import_zod.z.discriminatedUnion("t", [
   // room / lobby
-  import_zod.z.object({ t: import_zod.z.literal("createRoom"), name: DisplayName.optional(), avatar: Avatar.optional(), game: import_zod.z.enum(GAME_IDS).optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
+  import_zod.z.object({ t: import_zod.z.literal("createRoom"), name: DisplayName.optional(), avatar: Avatar.optional(), game: import_zod.z.enum(GAME_IDS).optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
   // Host sets/changes their display name AFTER createRoom (for anonymous one-tap
   // hosts who started nameless). Host-only; the relay re-broadcasts the lobby.
   // SUPERSEDED by setProfile (kept working for shipped builds).
@@ -111,8 +112,8 @@ var ClientMsg = import_zod.z.discriminatedUnion("t", [
   // view carries names+avatars so it updates live; dama/ersimha views are id-keyed (clients
   // map ids→names from the lobby roster), so a change there lands on the next lobby.
   import_zod.z.object({ t: import_zod.z.literal("setProfile"), name: DisplayName.optional(), avatar: Avatar.optional(), character: Character.optional() }),
-  import_zod.z.object({ t: import_zod.z.literal("joinRoom"), code: RoomCode, name: DisplayName, avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
-  import_zod.z.object({ t: import_zod.z.literal("resume"), code: RoomCode, token: import_zod.z.string().max(120), avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
+  import_zod.z.object({ t: import_zod.z.literal("joinRoom"), code: RoomCode, name: DisplayName, avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
+  import_zod.z.object({ t: import_zod.z.literal("resume"), code: RoomCode, token: import_zod.z.string().max(120), avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
   // `tally` (gs#46) = wins per PLAYER across every game this room has played tonight — «نتيجة الليلة».
   // Keyed by playerId, NOT by team: team names are recycled each game, so a per-team count means nothing
   // across a night. Survives playAgain. A One Device game credits nobody (its team slots hold no players).

package/dist/index.d.cts

@@ -122,6 +122,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     t: "createRoom";
     name?: string | undefined;
@@ -134,6 +135,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     t: "createRoom";
     name?: string | undefined;
@@ -146,6 +148,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"renameHost">;
     name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
@@ -203,6 +206,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     t: "joinRoom";
@@ -215,6 +219,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     code: string;
     t: "joinRoom";
@@ -227,6 +232,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"resume">;
     code: z.ZodString;
@@ -245,6 +251,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     t: "resume";
@@ -257,6 +264,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     code: string;
     t: "resume";
@@ -269,6 +277,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"setPlaying">;
     playerId: z.ZodOptional<z.ZodString>;
@@ -683,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;
@@ -945,16 +982,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;
@@ -986,4 +1026,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 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

@@ -122,6 +122,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     t: "createRoom";
     name?: string | undefined;
@@ -134,6 +135,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     t: "createRoom";
     name?: string | undefined;
@@ -146,6 +148,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"renameHost">;
     name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
@@ -203,6 +206,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     t: "joinRoom";
@@ -215,6 +219,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     code: string;
     t: "joinRoom";
@@ -227,6 +232,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"resume">;
     code: z.ZodString;
@@ -245,6 +251,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv: z.ZodOptional<z.ZodNumber>;
     idToken: z.ZodOptional<z.ZodString>;
     platform: z.ZodOptional<z.ZodEnum<["web", "ios", "android"]>>;
+    appVersion: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     t: "resume";
@@ -257,6 +264,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }, {
     code: string;
     t: "resume";
@@ -269,6 +277,7 @@ declare const ClientMsg: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
     pv?: number | undefined;
     idToken?: string | undefined;
     platform?: "web" | "ios" | "android" | undefined;
+    appVersion?: string | undefined;
 }>, z.ZodObject<{
     t: z.ZodLiteral<"setPlaying">;
     playerId: z.ZodOptional<z.ZodString>;
@@ -683,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;
@@ -945,16 +982,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;
@@ -986,4 +1026,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 QuestionView, ROOM_ALPHABET, type RosterEntry, type ServerMsg, type SoundName, type StrokePointView, type TeamSlotView, type TeamView, type YouContext, gameIdForPv, gamesForPv, modesForGame };

package/dist/index.js

@@ -53,6 +53,7 @@ var HelpType = z.enum([
 var Pv = z.number().int().min(1).max(1e6).optional();
 var IdToken = z.string().max(4096).optional();
 var Platform = z.enum(["web", "ios", "android"]).optional();
+var AppVersion = z.string().trim().max(24).regex(/^[0-9]+(\.[0-9]+){0,3}([-+][0-9A-Za-z.-]+)?$/, "bad app version").optional();
 var Avatar = z.object({
   emoji: z.string().min(1).max(16).transform((s) => s.replace(UNSAFE_CHARS, "")).refine((s) => s.length >= 1, "empty emoji"),
   color: z.string().regex(/^#[0-9a-fA-F]{6}$/, "color must be #rrggbb")
@@ -60,7 +61,7 @@ var Avatar = z.object({
 var Character = z.enum(CHARACTER_IDS);
 var ClientMsg = z.discriminatedUnion("t", [
   // room / lobby
-  z.object({ t: z.literal("createRoom"), name: DisplayName.optional(), avatar: Avatar.optional(), game: z.enum(GAME_IDS).optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
+  z.object({ t: z.literal("createRoom"), name: DisplayName.optional(), avatar: Avatar.optional(), game: z.enum(GAME_IDS).optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
   // Host sets/changes their display name AFTER createRoom (for anonymous one-tap
   // hosts who started nameless). Host-only; the relay re-broadcasts the lobby.
   // SUPERSEDED by setProfile (kept working for shipped builds).
@@ -74,8 +75,8 @@ var ClientMsg = z.discriminatedUnion("t", [
   // view carries names+avatars so it updates live; dama/ersimha views are id-keyed (clients
   // map ids→names from the lobby roster), so a change there lands on the next lobby.
   z.object({ t: z.literal("setProfile"), name: DisplayName.optional(), avatar: Avatar.optional(), character: Character.optional() }),
-  z.object({ t: z.literal("joinRoom"), code: RoomCode, name: DisplayName, avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
-  z.object({ t: z.literal("resume"), code: RoomCode, token: z.string().max(120), avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform }),
+  z.object({ t: z.literal("joinRoom"), code: RoomCode, name: DisplayName, avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
+  z.object({ t: z.literal("resume"), code: RoomCode, token: z.string().max(120), avatar: Avatar.optional(), character: Character.optional(), pv: Pv, idToken: IdToken, platform: Platform, appVersion: AppVersion }),
   // `tally` (gs#46) = wins per PLAYER across every game this room has played tonight — «نتيجة الليلة».
   // Keyed by playerId, NOT by team: team names are recycled each game, so a per-team count means nothing
   // across a night. Survives playAgain. A One Device game credits nobody (its team slots hold no players).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thegeem/protocol",
-  "version": "0.1.33",
+  "version": "0.1.35",
   "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",