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

package/src/api/mp/races.ts

@@ -1,211 +1,211 @@
-/**
- * Race shapes (docs/plans/race.md): params, live stats, racers and decided
- * results. Shared by the `race.*` socket ops and events, the race block of
- * a room, and `GET /race/history`. Each rule here is defined once.
- */
-import { z } from 'zod';
-import { HexColor, Millis, Slug, UserId } from '../../common';
-import { RACE_STATS_LIMITS } from '../../limits';
-
-/** A race param or stat key: a letter, then up to 23 letters, digits or `_`. */
-export const RaceKey = z.string().regex(/^[A-Za-z][A-Za-z0-9_]{0,23}$/);
-
-/** A race param value, one of the game's declared options: a number, a boolean or a short token. */
-export const RaceParamValue = z.union([
-  z.number(),
-  z.boolean(),
-  z.string().regex(/^[A-Za-z0-9_-]{1,24}$/),
-]);
-
-/**
- * The creator's choices, keyed by the manifest's `race.params[].key`. The
- * hub keeps only declared keys and option values (anything else becomes the
- * param's default), so everyone gets the same puzzle.
- */
-export const RaceParams = z.record(RaceKey, RaceParamValue);
-
-/** A race's params. */
-export type RaceParams = z.infer<typeof RaceParams>;
-
-/** Live stat values are clamped to ±1e9. */
-const STAT_LIMIT = 1e9;
-
-/**
- * A live stat value: a finite number (clamped to ±1e9), a boolean or a
- * `#rrggbb` colour (lower-cased). Never text.
- */
-export const RaceStatValue = z.union([
-  z.number().transform((n) => Math.max(-STAT_LIMIT, Math.min(STAT_LIMIT, n))),
-  z.boolean(),
-  HexColor.transform((c) => c.toLowerCase()),
-]);
-
-/** A live stat value, as cleaned by the hub. */
-export type RaceStatValue = z.output<typeof RaceStatValue>;
-
-/**
- * A racer's live stats, keyed like the manifest's `race.stats[].key`: at
- * most 12 keys and 600 bytes of JSON once cleaned.
- */
-export const RaceStats = z
-  .record(RaceKey, RaceStatValue)
-  .refine((s) => Object.keys(s).length <= RACE_STATS_LIMITS.maxKeys, `at most ${String(RACE_STATS_LIMITS.maxKeys)} stats`)
-  .refine((s) => JSON.stringify(s).length <= RACE_STATS_LIMITS.maxBytes, 'stats too large');
-
-/** A racer's stats. */
-export type RaceStats = z.infer<typeof RaceStats>;
-
-/** How far along a racer is, 0 to 1. The hub clamps values outside that range. */
-export const RaceProgress = z.number().transform((n) => Math.max(0, Math.min(1, n)));
-
-/** A race room's phase: waiting for racers → countdown → racing → done (→ countdown on a rematch). */
-export const RacePhase = z.enum(['waiting', 'countdown', 'racing', 'done']);
-
-/** A racer's state while the race runs. */
-export const RacerState = z.enum(['racing', 'finished', 'lost', 'forfeit', 'disconnected']);
-
-/** A value of {@link RacerState}. */
-export type RacerState = z.infer<typeof RacerState>;
-
-/** How a race ended: the winner finished, everyone else lost / gave up / dropped, or time ran out. */
-export const RaceOutcome = z.enum(['finished', 'lost', 'forfeit', 'disconnected', 'timeout']);
-
-/** A value of {@link RaceOutcome}. */
-export type RaceOutcome = z.infer<typeof RaceOutcome>;
-
-/** One racer's result. `beaten`: still racing when someone else won. */
-export const RacerResult = z.enum(['won', 'beaten', 'lost', 'forfeit', 'disconnected', 'timeout']);
-
-/** A value of {@link RacerResult}. */
-export type RacerResult = z.infer<typeof RacerResult>;
-
-/** Fields every live racer line has (room roster and result card). */
-const RacerLine = z.object({
-  userId: UserId,
-  /** The racer's username when the race began. */
-  name: z.string(),
-  /** Avatar token; never empty. */
-  avatar: z.string(),
-  stats: RaceStats,
-  /** 0..1, when the game reports it. */
-  progress: RaceProgress.optional(),
-});
-
-/** A racer in a race room's roster (RoomInfo.race.players). */
-export const Racer = RacerLine.extend({
-  state: RacerState,
-  /** Server-measured ms from the go to finishing or dropping out. */
-  ms: z.number().int().nonnegative().optional(),
-});
-
-/** A racer in a race room. */
-export type Racer = z.infer<typeof Racer>;
-
-/** One racer's line in a {@link RaceResult}. */
-export const RaceResultPlayer = RacerLine.extend({
-  /** 1 for the winner. */
-  place: z.number().int().positive(),
-  result: RacerResult,
-  /** Server-measured ms from the go to finishing or dropping out (the race's end for those still in). */
-  ms: z.number().int().nonnegative(),
-});
-
-/** Fields a decided race has both live and in the history. */
-const DecidedRace = z.object({
-  game: Slug,
-  params: RaceParams,
-  outcome: RaceOutcome,
-  /** Epoch ms of the go. */
-  startedAt: Millis,
-  /** Epoch ms. */
-  endedAt: Millis,
-  /** ms from the go to the decision. */
-  durationMs: z.number().int().nonnegative(),
-});
-
-/** A decided race: the `race.result` event, the `race.finish` ack and RoomInfo.race.result. */
-export const RaceResult = DecidedRace.extend({
-  /** The race's id in the history; `null` if recording it failed. */
-  id: z.number().int().positive().nullable(),
-  /** The room code. */
-  room: z.string(),
-  /** 1 for the room's first race, +1 per rematch. */
-  round: z.number().int().positive(),
-  seed: z.number().int().positive(),
-  /** `null` when nobody won (time ran out, or everyone dropped out). */
-  winnerId: UserId.nullable(),
-  /** In finishing order (place 1 first). */
-  players: z.array(RaceResultPlayer),
-});
-
-/** A decided race. */
-export type RaceResult = z.infer<typeof RaceResult>;
-
-/** The referee's view of a race room (RoomInfo.race). */
-export const RaceState = z.object({
-  phase: RacePhase,
-  /** 1 for the first race in the room, +1 per rematch; 0 while waiting for the first. */
-  round: z.number().int().nonnegative(),
-  params: RaceParams,
-  /** The countdown can start once this many racers are seated. */
-  minPlayers: z.number().int().positive(),
-  /** Everyone racing this round (empty while waiting for the first). */
-  players: z.array(Racer),
-  /** Who asked for a rematch since the last race. */
-  rematch: z.array(UserId),
-  /** Present once the countdown starts (never before, so nobody can pre-solve). */
-  seed: z.number().int().positive().optional(),
-  /** Epoch ms of the go (server clock); present with `seed`. */
-  startAt: Millis.optional(),
-  /** Present once the round is decided. */
-  result: RaceResult.optional(),
-});
-
-/** A race room's referee state. */
-export type RaceState = z.infer<typeof RaceState>;
-
-/** The countdown began (`race.start`): build the puzzle from `seed` + `params`. */
-export const RaceStart = z.object({
-  roomId: z.string(),
-  round: z.number().int().positive(),
-  seed: z.number().int().positive(),
-  params: RaceParams,
-  /** Epoch ms of the go (server clock). */
-  startAt: Millis,
-  /** ms until the go. */
-  startsIn: z.number().int().nonnegative(),
-  /** The racers' user ids. */
-  players: z.array(UserId),
-});
-
-/** A racer in a history record. Suspended opponents are `hidden`: id 0, name "A player", no avatar. */
-export const RaceRecordPlayer = z.object({
-  /** 0 when hidden. */
-  userId: z.number().int().nonnegative(),
-  username: z.string(),
-  /** Avatar token; `''` when hidden. */
-  avatar: z.string(),
-  guest: z.boolean(),
-  place: z.number().int().positive(),
-  result: RacerResult,
-  /** Server-measured ms from the go to finishing or dropping out. */
-  ms: z.number().int().nonnegative().optional(),
-  progress: RaceProgress.optional(),
-  stats: RaceStats,
-  hidden: z.literal(true).optional(),
-});
-
-/** One past race the player was in (`GET /race/history`). */
-export const RaceRecord = DecidedRace.extend({
-  id: z.number().int().positive(),
-  gameTitle: z.string(),
-  /** `null` when nobody won; 0 when the winner is hidden (suspended). */
-  winnerId: z.number().int().nonnegative().nullable(),
-  /** The signed-in player's own line (`null` only if their row is missing). */
-  me: RaceRecordPlayer.nullable(),
-  /** In place order. */
-  players: z.array(RaceRecordPlayer),
-});
-
-/** A past race. */
-export type RaceRecord = z.infer<typeof RaceRecord>;
+/**
+ * Race shapes (docs/plans/race.md): params, live stats, racers and decided
+ * results. Shared by the `race.*` socket ops and events, the race block of
+ * a room, and `GET /race/history`. Each rule here is defined once.
+ */
+import { z } from 'zod';
+import { HexColor, Millis, Slug, UserId } from '../../common';
+import { RACE_STATS_LIMITS } from '../../limits';
+
+/** A race param or stat key: a letter, then up to 23 letters, digits or `_`. */
+export const RaceKey = z.string().regex(/^[A-Za-z][A-Za-z0-9_]{0,23}$/);
+
+/** A race param value, one of the game's declared options: a number, a boolean or a short token. */
+export const RaceParamValue = z.union([
+  z.number(),
+  z.boolean(),
+  z.string().regex(/^[A-Za-z0-9_-]{1,24}$/),
+]);
+
+/**
+ * The creator's choices, keyed by the manifest's `race.params[].key`. The
+ * hub keeps only declared keys and option values (anything else becomes the
+ * param's default), so everyone gets the same puzzle.
+ */
+export const RaceParams = z.record(RaceKey, RaceParamValue);
+
+/** A race's params. */
+export type RaceParams = z.infer<typeof RaceParams>;
+
+/** Live stat values are clamped to ±1e9. */
+const STAT_LIMIT = 1e9;
+
+/**
+ * A live stat value: a finite number (clamped to ±1e9), a boolean or a
+ * `#rrggbb` colour (lower-cased). Never text.
+ */
+export const RaceStatValue = z.union([
+  z.number().transform((n) => Math.max(-STAT_LIMIT, Math.min(STAT_LIMIT, n))),
+  z.boolean(),
+  HexColor.transform((c) => c.toLowerCase()),
+]);
+
+/** A live stat value, as cleaned by the hub. */
+export type RaceStatValue = z.output<typeof RaceStatValue>;
+
+/**
+ * A racer's live stats, keyed like the manifest's `race.stats[].key`: at
+ * most 12 keys and 600 bytes of JSON once cleaned.
+ */
+export const RaceStats = z
+  .record(RaceKey, RaceStatValue)
+  .refine((s) => Object.keys(s).length <= RACE_STATS_LIMITS.maxKeys, `at most ${String(RACE_STATS_LIMITS.maxKeys)} stats`)
+  .refine((s) => JSON.stringify(s).length <= RACE_STATS_LIMITS.maxBytes, 'stats too large');
+
+/** A racer's stats. */
+export type RaceStats = z.infer<typeof RaceStats>;
+
+/** How far along a racer is, 0 to 1. The hub clamps values outside that range. */
+export const RaceProgress = z.number().transform((n) => Math.max(0, Math.min(1, n)));
+
+/** A race room's phase: waiting for racers → countdown → racing → done (→ countdown on a rematch). */
+export const RacePhase = z.enum(['waiting', 'countdown', 'racing', 'done']);
+
+/** A racer's state while the race runs. */
+export const RacerState = z.enum(['racing', 'finished', 'lost', 'forfeit', 'disconnected']);
+
+/** A value of {@link RacerState}. */
+export type RacerState = z.infer<typeof RacerState>;
+
+/** How a race ended: the winner finished, everyone else lost / gave up / dropped, or time ran out. */
+export const RaceOutcome = z.enum(['finished', 'lost', 'forfeit', 'disconnected', 'timeout']);
+
+/** A value of {@link RaceOutcome}. */
+export type RaceOutcome = z.infer<typeof RaceOutcome>;
+
+/** One racer's result. `beaten`: still racing when someone else won. */
+export const RacerResult = z.enum(['won', 'beaten', 'lost', 'forfeit', 'disconnected', 'timeout']);
+
+/** A value of {@link RacerResult}. */
+export type RacerResult = z.infer<typeof RacerResult>;
+
+/** Fields every live racer line has (room roster and result card). */
+const RacerLine = z.object({
+  userId: UserId,
+  /** The racer's username when the race began. */
+  name: z.string(),
+  /** Avatar token; never empty. */
+  avatar: z.string(),
+  stats: RaceStats,
+  /** 0..1, when the game reports it. */
+  progress: RaceProgress.optional(),
+});
+
+/** A racer in a race room's roster (RoomInfo.race.players). */
+export const Racer = RacerLine.extend({
+  state: RacerState,
+  /** Server-measured ms from the go to finishing or dropping out. */
+  ms: z.number().int().nonnegative().optional(),
+});
+
+/** A racer in a race room. */
+export type Racer = z.infer<typeof Racer>;
+
+/** One racer's line in a {@link RaceResult}. */
+export const RaceResultPlayer = RacerLine.extend({
+  /** 1 for the winner. */
+  place: z.number().int().positive(),
+  result: RacerResult,
+  /** Server-measured ms from the go to finishing or dropping out (the race's end for those still in). */
+  ms: z.number().int().nonnegative(),
+});
+
+/** Fields a decided race has both live and in the history. */
+const DecidedRace = z.object({
+  game: Slug,
+  params: RaceParams,
+  outcome: RaceOutcome,
+  /** Epoch ms of the go. */
+  startedAt: Millis,
+  /** Epoch ms. */
+  endedAt: Millis,
+  /** ms from the go to the decision. */
+  durationMs: z.number().int().nonnegative(),
+});
+
+/** A decided race: the `race.result` event, the `race.finish` ack and RoomInfo.race.result. */
+export const RaceResult = DecidedRace.extend({
+  /** The race's id in the history; `null` if recording it failed. */
+  id: z.number().int().positive().nullable(),
+  /** The room code. */
+  room: z.string(),
+  /** 1 for the room's first race, +1 per rematch. */
+  round: z.number().int().positive(),
+  seed: z.number().int().positive(),
+  /** `null` when nobody won (time ran out, or everyone dropped out). */
+  winnerId: UserId.nullable(),
+  /** In finishing order (place 1 first). */
+  players: z.array(RaceResultPlayer),
+});
+
+/** A decided race. */
+export type RaceResult = z.infer<typeof RaceResult>;
+
+/** The referee's view of a race room (RoomInfo.race). */
+export const RaceState = z.object({
+  phase: RacePhase,
+  /** 1 for the first race in the room, +1 per rematch; 0 while waiting for the first. */
+  round: z.number().int().nonnegative(),
+  params: RaceParams,
+  /** The countdown can start once this many racers are seated. */
+  minPlayers: z.number().int().positive(),
+  /** Everyone racing this round (empty while waiting for the first). */
+  players: z.array(Racer),
+  /** Who asked for a rematch since the last race. */
+  rematch: z.array(UserId),
+  /** Present once the countdown starts (never before, so nobody can pre-solve). */
+  seed: z.number().int().positive().optional(),
+  /** Epoch ms of the go (server clock); present with `seed`. */
+  startAt: Millis.optional(),
+  /** Present once the round is decided. */
+  result: RaceResult.optional(),
+});
+
+/** A race room's referee state. */
+export type RaceState = z.infer<typeof RaceState>;
+
+/** The countdown began (`race.start`): build the puzzle from `seed` + `params`. */
+export const RaceStart = z.object({
+  roomId: z.string(),
+  round: z.number().int().positive(),
+  seed: z.number().int().positive(),
+  params: RaceParams,
+  /** Epoch ms of the go (server clock). */
+  startAt: Millis,
+  /** ms until the go. */
+  startsIn: z.number().int().nonnegative(),
+  /** The racers' user ids. */
+  players: z.array(UserId),
+});
+
+/** A racer in a history record. Suspended opponents are `hidden`: id 0, name "A player", no avatar. */
+export const RaceRecordPlayer = z.object({
+  /** 0 when hidden. */
+  userId: z.number().int().nonnegative(),
+  username: z.string(),
+  /** Avatar token; `''` when hidden. */
+  avatar: z.string(),
+  guest: z.boolean(),
+  place: z.number().int().positive(),
+  result: RacerResult,
+  /** Server-measured ms from the go to finishing or dropping out. */
+  ms: z.number().int().nonnegative().optional(),
+  progress: RaceProgress.optional(),
+  stats: RaceStats,
+  hidden: z.literal(true).optional(),
+});
+
+/** One past race the player was in (`GET /race/history`). */
+export const RaceRecord = DecidedRace.extend({
+  id: z.number().int().positive(),
+  gameTitle: z.string(),
+  /** `null` when nobody won; 0 when the winner is hidden (suspended). */
+  winnerId: z.number().int().nonnegative().nullable(),
+  /** The signed-in player's own line (`null` only if their row is missing). */
+  me: RaceRecordPlayer.nullable(),
+  /** In place order. */
+  players: z.array(RaceRecordPlayer),
+});
+
+/** A past race. */
+export type RaceRecord = z.infer<typeof RaceRecord>;

package/src/api/mp/rooms.ts

@@ -1,90 +1,90 @@
-/**
- * Hub relay rooms (multiplayer-impl.md §6): realtime multiplayer for static
- * games, relayed (never refereed) by the hub. A race is a room with a
- * `race` block on top. Shared by the `room.*` / `race.*` ops and events and
- * the `hello` snapshot.
- */
-import { z } from 'zod';
-import { Json, Slug, UserId } from '../../common';
-import { ChatMode } from '../../entities';
-import { GameMode, OpaqueId } from './parties';
-import { RaceState } from './races';
-
-/** A room's join code: 5 characters from `A-Z` and `2-9` (no `I`, `O`, `0`, `1`). */
-export const RoomCode = z.string().regex(/^[A-HJ-NP-Z2-9]{5}$/);
-
-/** A room's lifecycle: new players join only in the lobby. */
-export const RoomPhase = z.enum(['lobby', 'playing', 'ended']);
-
-/**
- * Who hears a send. `host` (default): guests' unaddressed sends reach the
- * host only. `relay`: every unaddressed send reaches everyone, sender
- * included.
- */
-export const RoomModel = z.enum(['host', 'relay']);
-
-/** A seat in a room, keyed by user (any tab of that user reclaims it). */
-export const RoomSeat = z.object({
-  userId: UserId,
-  /** The player's username when they sat down. */
-  name: z.string(),
-  /** Avatar token; never empty. */
-  avatar: z.string(),
-  ready: z.boolean(),
-  /** `false` while the seat is held for a dropped player's reconnect grace. */
-  connected: z.boolean(),
-  /** Small per-seat game data (team, colour…), at most 2 KB of JSON. */
-  data: Json.optional(),
-});
-
-/** The public description of a room (`room` event, room and race acks, the `hello` snapshot). */
-export const RoomInfo = z.object({
-  id: OpaqueId,
-  code: RoomCode,
-  game: Slug,
-  /** `race` for race rooms. */
-  mode: GameMode.optional(),
-  hostId: UserId,
-  /** Listed in `room.list` / `race.list`. */
-  public: z.boolean(),
-  phase: RoomPhase,
-  maxPlayers: z.number().int().positive(),
-  model: RoomModel,
-  seats: z.array(RoomSeat),
-  /** How many are watching. */
-  spectators: z.number().int().nonnegative(),
-  /** The chat mode for the seated players. */
-  chatMode: ChatMode,
-  /** Present on race rooms. */
-  race: RaceState.optional(),
-});
-
-/** A room. */
-export type RoomInfo = z.infer<typeof RoomInfo>;
-
-/** A room's shared state for late joiners: a JSON object, at most 32 KB. */
-export const RoomState = z.record(z.string(), Json);
-
-/** A relayed game message (`room.msg`, and a join's replay history). */
-export const RoomMessage = z.object({
-  from: UserId,
-  data: Json,
-  /** Per-room sequence number, shared with state patches. */
-  seq: z.number().int().positive(),
-  /** Set when the message went to one seat only. */
-  to: UserId.optional(),
-});
-
-/** How to find a room: by its code (case-insensitive) or its id. */
-export const RoomTarget = z.object({
-  code: z.string().optional(),
-  id: z.string().optional(),
-  /** Watch instead of taking a seat (if the game allows spectators). */
-  spectate: z.boolean().optional(),
-});
-
-/** Why a room went away for this tab (`room.closed`). */
-export const RoomClosedReason = z.enum(['empty', 'ended', 'host_left', 'moved', 'other_tab', 'removed']);
-
-/** Why a seat was freed (`room.abandoned`). */
-export const SeatGoneReason = z.enum(['left', 'abandoned', 'kicked']);
+/**
+ * Hub relay rooms (multiplayer-impl.md §6): realtime multiplayer for static
+ * games, relayed (never refereed) by the hub. A race is a room with a
+ * `race` block on top. Shared by the `room.*` / `race.*` ops and events and
+ * the `hello` snapshot.
+ */
+import { z } from 'zod';
+import { Json, Slug, UserId } from '../../common';
+import { ChatMode } from '../../entities';
+import { GameMode, OpaqueId } from './parties';
+import { RaceState } from './races';
+
+/** A room's join code: 5 characters from `A-Z` and `2-9` (no `I`, `O`, `0`, `1`). */
+export const RoomCode = z.string().regex(/^[A-HJ-NP-Z2-9]{5}$/);
+
+/** A room's lifecycle: new players join only in the lobby. */
+export const RoomPhase = z.enum(['lobby', 'playing', 'ended']);
+
+/**
+ * Who hears a send. `host` (default): guests' unaddressed sends reach the
+ * host only. `relay`: every unaddressed send reaches everyone, sender
+ * included.
+ */
+export const RoomModel = z.enum(['host', 'relay']);
+
+/** A seat in a room, keyed by user (any tab of that user reclaims it). */
+export const RoomSeat = z.object({
+  userId: UserId,
+  /** The player's username when they sat down. */
+  name: z.string(),
+  /** Avatar token; never empty. */
+  avatar: z.string(),
+  ready: z.boolean(),
+  /** `false` while the seat is held for a dropped player's reconnect grace. */
+  connected: z.boolean(),
+  /** Small per-seat game data (team, colour…), at most 2 KB of JSON. */
+  data: Json.optional(),
+});
+
+/** The public description of a room (`room` event, room and race acks, the `hello` snapshot). */
+export const RoomInfo = z.object({
+  id: OpaqueId,
+  code: RoomCode,
+  game: Slug,
+  /** `race` for race rooms. */
+  mode: GameMode.optional(),
+  hostId: UserId,
+  /** Listed in `room.list` / `race.list`. */
+  public: z.boolean(),
+  phase: RoomPhase,
+  maxPlayers: z.number().int().positive(),
+  model: RoomModel,
+  seats: z.array(RoomSeat),
+  /** How many are watching. */
+  spectators: z.number().int().nonnegative(),
+  /** The chat mode for the seated players. */
+  chatMode: ChatMode,
+  /** Present on race rooms. */
+  race: RaceState.optional(),
+});
+
+/** A room. */
+export type RoomInfo = z.infer<typeof RoomInfo>;
+
+/** A room's shared state for late joiners: a JSON object, at most 32 KB. */
+export const RoomState = z.record(z.string(), Json);
+
+/** A relayed game message (`room.msg`, and a join's replay history). */
+export const RoomMessage = z.object({
+  from: UserId,
+  data: Json,
+  /** Per-room sequence number, shared with state patches. */
+  seq: z.number().int().positive(),
+  /** Set when the message went to one seat only. */
+  to: UserId.optional(),
+});
+
+/** How to find a room: by its code (case-insensitive) or its id. */
+export const RoomTarget = z.object({
+  code: z.string().optional(),
+  id: z.string().optional(),
+  /** Watch instead of taking a seat (if the game allows spectators). */
+  spectate: z.boolean().optional(),
+});
+
+/** Why a room went away for this tab (`room.closed`). */
+export const RoomClosedReason = z.enum(['empty', 'ended', 'host_left', 'moved', 'other_tab', 'removed']);
+
+/** Why a seat was freed (`room.abandoned`). */
+export const SeatGoneReason = z.enum(['left', 'abandoned', 'kicked']);

package/src/api/mp/snapshot.ts

@@ -1,17 +1,17 @@
-/** The multiplayer part of the socket `hello` snapshot (multiplayer-impl.md §4.5). */
-import { z } from 'zod';
-import { Invite, Party } from './parties';
-import { RoomInfo } from './rooms';
-
-/**
- * The multiplayer fields of the `hello` ack, to spread into the snapshot
- * schema (`z.object({ ...other, ...MultiplayerSnapshot.shape })`).
- */
-export const MultiplayerSnapshot = z.object({
-  /** Pending invites addressed to me. */
-  invites: z.array(Invite),
-  /** The party I'm in, or `null`. */
-  party: Party.nullable(),
-  /** The room seat I still hold (not ended), or `null`; `room.join` it again to reconnect. */
-  room: RoomInfo.nullable(),
-});
+/** The multiplayer part of the socket `hello` snapshot (multiplayer-impl.md §4.5). */
+import { z } from 'zod';
+import { Invite, Party } from './parties';
+import { RoomInfo } from './rooms';
+
+/**
+ * The multiplayer fields of the `hello` ack, to spread into the snapshot
+ * schema (`z.object({ ...other, ...MultiplayerSnapshot.shape })`).
+ */
+export const MultiplayerSnapshot = z.object({
+  /** Pending invites addressed to me. */
+  invites: z.array(Invite),
+  /** The party I'm in, or `null`. */
+  party: Party.nullable(),
+  /** The room seat I still hold (not ended), or `null`; `room.join` it again to reconnect. */
+  room: RoomInfo.nullable(),
+});