galaxy-game/pkg/schema/fbs/lobby.fbs

// lobby contains FlatBuffers payloads used by the authenticated gateway
// boundary for Game Lobby. The wire shapes here mirror the trusted
// internal lobby REST surface; gateway derives the calling `user_id`
// from the verified session and forwards it as `X-User-Id` to lobby.
namespace lobby;

// GameSummary stores one game record returned by the lobby list
// endpoints. owner_user_id is empty for public games (no human owner).
// current_turn carries the runtime's most recent observed turn number
// (zero before the engine produces its first snapshot); the user
// surface uses it to read the corresponding `user.games.report`
// without an extra round-trip. The shape matches `lobby/openapi.yaml`
// `MyGameSummary`.
table GameSummary {
  game_id:string;
  game_name:string;
  game_type:string;
  status:string;
  owner_user_id:string;
  min_players:int32;
  max_players:int32;
  enrollment_ends_at_ms:int64;
  created_at_ms:int64;
  updated_at_ms:int64;
  current_turn:int32;
}

// MyGamesListRequest stores the authenticated read request for the
// caller's games. Empty body — gateway derives identity from the
// authenticated session.
table MyGamesListRequest {
}

// MyGamesListResponse stores the list of games the caller participates
// in.
table MyGamesListResponse {
  items:[GameSummary];
}

// PublicGamesListRequest stores the paginated read request for joinable
// public games. Page numbers start at 1; backend caps page_size.
table PublicGamesListRequest {
  page:int32;
  page_size:int32;
}

// PublicGamesListResponse stores one page of public games together with
// the pagination metadata.
table PublicGamesListResponse {
  items:[GameSummary];
  page:int32;
  page_size:int32;
  total:int32;
}

// ApplicationSummary stores one application record. decided_at_ms is 0
// while the application is pending.
table ApplicationSummary {
  application_id:string;
  game_id:string;
  applicant_user_id:string;
  race_name:string;
  status:string;
  created_at_ms:int64;
  decided_at_ms:int64;
}

// MyApplicationsListRequest stores the authenticated read request for
// the caller's applications. Empty body.
table MyApplicationsListRequest {
}

// MyApplicationsListResponse stores the caller's applications in the
// order the backend returns them.
table MyApplicationsListResponse {
  items:[ApplicationSummary];
}

// InviteSummary stores one invite record. invited_user_id is empty for
// code-based invites; code is empty for user-bound invites;
// decided_at_ms is 0 while the invite is still pending.
table InviteSummary {
  invite_id:string;
  game_id:string;
  inviter_user_id:string;
  invited_user_id:string;
  code:string;
  race_name:string;
  status:string;
  created_at_ms:int64;
  expires_at_ms:int64;
  decided_at_ms:int64;
}

// MyInvitesListRequest stores the authenticated read request for the
// caller's invites. Empty body.
table MyInvitesListRequest {
}

// MyInvitesListResponse stores the caller's invite list.
table MyInvitesListResponse {
  items:[InviteSummary];
}

// OpenEnrollmentRequest stores the owner-only command that transitions
// a game from `draft` to `enrollment_open`.
table OpenEnrollmentRequest {
  game_id:string;
}

// OpenEnrollmentResponse stores the resulting game status.
table OpenEnrollmentResponse {
  game_id:string;
  status:string;
}

// GameCreateRequest stores the create-game command. Visibility is
// always `private` for the user surface; the gateway rejects any other
// value before forwarding to backend.
table GameCreateRequest {
  game_name:string;
  description:string;
  min_players:int32;
  max_players:int32;
  start_gap_hours:int32;
  start_gap_players:int32;
  enrollment_ends_at_ms:int64;
  turn_schedule:string;
  target_engine_version:string;
}

// GameCreateResponse wraps the freshly created game projected onto the
// shared GameSummary shape.
table GameCreateResponse {
  game:GameSummary;
}

// ApplicationSubmitRequest stores the submit-application command for a
// public game in `enrollment_open`.
table ApplicationSubmitRequest {
  game_id:string;
  race_name:string;
}

// ApplicationSubmitResponse wraps the freshly created application
// record.
table ApplicationSubmitResponse {
  application:ApplicationSummary;
}

// InviteRedeemRequest accepts a pending invite and creates the
// corresponding membership.
table InviteRedeemRequest {
  game_id:string;
  invite_id:string;
}

// InviteRedeemResponse wraps the updated invite record (status
// transitioned to `accepted`).
table InviteRedeemResponse {
  invite:InviteSummary;
}

// InviteDeclineRequest terminally declines a pending invite.
table InviteDeclineRequest {
  game_id:string;
  invite_id:string;
}

// InviteDeclineResponse wraps the updated invite record (status
// transitioned to `declined`).
table InviteDeclineResponse {
  invite:InviteSummary;
}

// ErrorBody stores the canonical lobby error envelope code/message
// pair.
table ErrorBody {
  code:string;
  message:string;
}

// ErrorResponse wraps ErrorBody for the FlatBuffers payload boundary.
table ErrorResponse {
  error:ErrorBody;
}

root_type MyGamesListResponse;