@my-swu/simulator-client 0.1.0

package/schema/game-state.schema.json

@@ -0,0 +1,273 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "GameState",
+  "description": "Complete public projection of one match.\n\nBesides riding the wire, this type is embedded in persisted lobby and\ntournament records (per-player `startedAccess.access.snapshot`), so rows\nin storage keep whatever shape they were stored with. A field added\nwithout `#[serde(default)]` makes every older stored record fail strict\ndecode; either keep the default or extend the restoration tables in\n`swu-server/src/legacy_snapshots.rs` in the same change.",
+  "type": "object",
+  "properties": {
+    "actionAbilities": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/ActionAbilityView"
+      }
+    },
+    "activeEffects": {
+      "description": "Engine-authoritative outstanding public effects that are active now.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/ActiveEffectView"
+      }
+    },
+    "activePlayer": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "availableAttacks": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AvailableAttackView"
+      }
+    },
+    "availableCounters": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/TwinSunsCounter"
+      }
+    },
+    "availableLeaderDeploys": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LeaderDeployActionView"
+      }
+    },
+    "consecutivePasses": {
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "currentAttack": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/CurrentAttackStateView"
+    },
+    "delayedEffects": {
+      "description": "Engine-authoritative outstanding public effects waiting on later timing.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DelayedEffectView"
+      }
+    },
+    "eventsApplied": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "format": {
+      "description": "Match format requested at creation time.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchFormat"
+    },
+    "gameTimer": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameTimerStateView"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "groundArena": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/UnitStateView"
+      }
+    },
+    "initiative": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/InitiativeState"
+    },
+    "leaderAction": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LeaderActionView"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "matchId": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "pendingAbilities": {
+      "description": "Abilities awaiting input, in presentation order only.\n\nIndex `0` has no semantic meaning: it is whichever ability the engine\ncollected first in the current simultaneous batch. Clients that need a\nspecific ability must match on its identity\n(`id` / `sourceCardId` / `sourceUnitId` / `window` / `clauseId` /\n`family`), never on position.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/PendingAbilityView"
+      }
+    },
+    "pendingChoice": {
+      "description": "The one prompt payload the viewer is being asked for, if any.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/PendingChoiceView"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "pendingUndo": {
+      "description": "Sensitive multiplayer undo waiting for approval from the other human\nseats. Fully public: every viewer (including spectators) sees the same\nrequest, only the prompt actions differ per seat client-side.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/PendingUndoRequest"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "phase": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchPhase"
+    },
+    "playActions": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/PlayActionView"
+      }
+    },
+    "playerCount": {
+      "description": "Configured number of seats in clockwise order.",
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "players": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/SeatState"
+      }
+    },
+    "prompt": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/PromptState"
+    },
+    "rejectedPlayReasons": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RejectedPlayView"
+      }
+    },
+    "result": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchResult"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "roundNumber": {
+      "type": "integer",
+      "format": "uint16",
+      "maximum": 65535,
+      "minimum": 0
+    },
+    "series": {
+      "description": "Multi-game and format-event state for this match.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchSeriesView"
+    },
+    "spaceArena": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/UnitStateView"
+      }
+    },
+    "status": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchStatus"
+    },
+    "trilogyFormat": {
+      "description": "Constructed legality profile selected for Trilogy deck validation.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/ConstructedFormat"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "turnPlayer": {
+      "description": "The seat whose action-phase *turn* is currently in progress.\n\nUse this — not `active_player` — to answer \"whose turn is it\". The engine\nreassigns `active_player` to whoever must resolve a forced prompt (e.g.\nthe opponent distributing indirect damage from your card), but the turn\nitself stays with the player who began it. `None` outside the action\nphase (lobby / setup / regroup / once the match is decided).",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/NullableSeatView"
+    },
+    "twinSunsCounters": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/TwinSunsCountersView"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "undoDeclinedRequesters": {
+      "description": "Seats whose undo request was declined during the current turn; those\nseats cannot request an undo again until the next turn begins. Fully\npublic like the pending request itself.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+      }
+    },
+    "winner": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "winners": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+      }
+    }
+  },
+  "required": [
+    "matchId",
+    "format",
+    "playerCount",
+    "series",
+    "status",
+    "phase",
+    "prompt",
+    "roundNumber",
+    "turnPlayer",
+    "initiative",
+    "availableCounters",
+    "consecutivePasses",
+    "winners",
+    "eventsApplied",
+    "activeEffects",
+    "delayedEffects",
+    "currentAttack",
+    "pendingAbilities",
+    "availableLeaderDeploys",
+    "availableAttacks",
+    "playActions",
+    "rejectedPlayReasons",
+    "actionAbilities",
+    "groundArena",
+    "spaceArena",
+    "players"
+  ]
+}

package/schema/get-match-response.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "GetMatchResponse",
+  "type": "object",
+  "properties": {
+    "snapshot": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameState"
+    }
+  },
+  "required": [
+    "snapshot"
+  ]
+}

package/schema/health-response.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "HealthResponse",
+  "type": "object",
+  "properties": {
+    "status": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "status"
+  ]
+}

package/schema/join-limited-event-request.schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JoinLimitedEventRequest",
+  "description": "Empty request body for joining one limited event.",
+  "type": "object"
+}

package/schema/join-lobby-request.schema.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JoinLobbyRequest",
+  "type": "object",
+  "properties": {
+    "authenticated": {
+      "description": "Whether the joining player is authenticated in the app.",
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "description": "Optional public avatar image URL for the joining player.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own this player's history.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "name": {
+      "type": "string"
+    },
+    "profileUrl": {
+      "description": "Optional public profile page URL for the joining player.",
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "name",
+    "authenticated",
+    "historyIdentities"
+  ]
+}

package/schema/join-match-request.schema.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JoinMatchRequest",
+  "type": "object",
+  "properties": {
+    "authenticated": {
+      "description": "Whether this player joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "description": "Optional public avatar image URL for this joining seat.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "deck": {
+      "description": "Deck for the joining seat. Optional — a seat may join without a\ndeck and submit one later through\n`POST /api/matches/{match_id}/deck`; the seat cannot mark itself\nready until a deck has been submitted.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DeckInput"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "deckId": {
+      "description": "Freeform client deck id for the submitted deck.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "deckTitle": {
+      "description": "Display title for the submitted deck.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "formatSetup": {
+      "description": "Optional setup data for formats that register more than one deck or a pool.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/FormatSetupInput"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own this joined seat's history entry.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "name": {
+      "description": "Optional human-friendly display name for this joining seat. Same\npurpose as `CreateMatchRequest::host_name` — populates\n`SeatState.name` so other viewers can render the player's name\ninstead of the seat enum.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "profileUrl": {
+      "description": "Optional public profile page URL for this joining seat.",
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "authenticated",
+    "historyIdentities"
+  ]
+}

package/schema/join-tournament-room-request.schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JoinTournamentRoomRequest",
+  "description": "Request body for joining one tournament room.",
+  "type": "object",
+  "properties": {
+    "authenticated": {
+      "description": "Whether the joining player is authenticated in the app.",
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own this player's history.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "name": {
+      "type": "string"
+    },
+    "profileUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "name",
+    "authenticated",
+    "historyIdentities"
+  ]
+}

package/schema/join-tournament-table-request.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JoinTournamentTableRequest",
+  "description": "Request body for joining an open duel table.",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/kick-lobby-player-request.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "KickLobbyPlayerRequest",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/kick-lobby-spectator-request.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "KickLobbySpectatorRequest",
+  "description": "Authenticates a host request to remove one lobby spectator.",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/leave-lobby-request.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LeaveLobbyRequest",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/leave-match-request.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LeaveMatchRequest",
+  "description": "Authenticated request to record an intentional multiplayer departure.",
+  "type": "object",
+  "properties": {
+    "seatToken": {
+      "description": "Player seat credential; spectator credentials are never accepted.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken"
+  ]
+}

package/schema/leave-match-response.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LeaveMatchResponse",
+  "description": "Confirmation that a durable match-presence entry was recorded.",
+  "type": "object",
+  "properties": {
+    "matchId": {
+      "type": "string",
+      "format": "uuid"
+    }
+  },
+  "required": [
+    "matchId"
+  ]
+}

package/schema/leave-tournament-room-request.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LeaveTournamentRoomRequest",
+  "description": "Request body for recording an intentional tournament-room departure.",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/limited-event-access-response.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LimitedEventAccessResponse",
+  "description": "Response returned when a seat creates or joins one event.",
+  "type": "object",
+  "properties": {
+    "eventId": {
+      "description": "Limited event id.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "seatIndex": {
+      "description": "Zero-based seat index inside the pod.",
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "seatToken": {
+      "description": "Secret token used by this seat.",
+      "type": "string"
+    },
+    "snapshot": {
+      "description": "Snapshot visible to this seat.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventSnapshot"
+    }
+  },
+  "required": [
+    "eventId",
+    "seatIndex",
+    "seatToken",
+    "snapshot"
+  ]
+}

package/schema/limited-event-command-request.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LimitedEventCommandRequest",
+  "description": "Command request body for a limited event.",
+  "type": "object",
+  "properties": {
+    "command": {
+      "description": "Command to apply.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventCommand"
+    },
+    "seatToken": {
+      "description": "Seat token returned by create or join.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken",
+    "command"
+  ]
+}

package/schema/limited-event-preflight-response.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LimitedEventPreflightResponse",
+  "description": "Read-only limited-event pack-generation check.",
+  "type": "object",
+  "properties": {
+    "issues": {
+      "description": "Empty when every required booster pack can be generated.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventPreflightIssue"
+      }
+    },
+    "seed": {
+      "description": "Deterministic seed used by successful creation after this check.",
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "seed",
+    "issues"
+  ]
+}

package/schema/limited-event-response.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LimitedEventResponse",
+  "description": "Response body for limited event fetches and commands.",
+  "type": "object",
+  "properties": {
+    "snapshot": {
+      "description": "Snapshot visible to current requester.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventSnapshot"
+    }
+  },
+  "required": [
+    "snapshot"
+  ]
+}