@my-swu/simulator-client 0.1.0

package/schema/match-history-deck-stats-request.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryDeckStatsRequest",
+  "description": "Request for private simulator results attached to My SWU deck ids.",
+  "type": "object",
+  "properties": {
+    "deckIds": {
+      "description": "Stable My SWU deck ids to aggregate.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "identities": {
+      "description": "Signed account identity used to authorize private result rows.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    }
+  },
+  "required": [
+    "identities",
+    "deckIds"
+  ]
+}

package/schema/match-history-deck-stats-response.schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryDeckStatsResponse",
+  "description": "Private deck-result aggregates returned to one signed-in player.",
+  "type": "object",
+  "properties": {
+    "decks": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DeckStats"
+      }
+    }
+  },
+  "required": [
+    "decks"
+  ]
+}

package/schema/match-history-entry.schema.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryEntry",
+  "description": "One match-history row returned to the SDK.",
+  "type": "object",
+  "properties": {
+    "completedAtMs": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "createdAtMs": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "format": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchFormat"
+    },
+    "historyId": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "players": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchHistoryPlayerSummary"
+      }
+    },
+    "replayAvailable": {
+      "description": "Whether an authorized terminal replay archive is available.",
+      "type": "boolean"
+    },
+    "restoreEligibility": {
+      "description": "Versioned server policy deciding whether this row can be restored.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryRestoreEligibility"
+    },
+    "result": true,
+    "section": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistorySection"
+    },
+    "seed": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "series": true,
+    "sourceMatchId": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "status": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryStatus"
+    },
+    "updatedAtMs": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "historyId",
+    "sourceMatchId",
+    "section",
+    "status",
+    "format",
+    "seed",
+    "players",
+    "series",
+    "createdAtMs",
+    "updatedAtMs",
+    "restoreEligibility",
+    "replayAvailable"
+  ]
+}

package/schema/match-history-list-request.schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryListRequest",
+  "description": "Request body for listing history entries owned by the supplied identities.",
+  "type": "object",
+  "properties": {
+    "cursor": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "identities": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "limit": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "section": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistorySection"
+    },
+    "status": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryStatus"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "section",
+    "identities"
+  ]
+}

package/schema/match-history-list-response.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryListResponse",
+  "description": "Response body for history list calls.",
+  "type": "object",
+  "properties": {
+    "entries": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchHistoryEntry"
+      }
+    },
+    "nextCursor": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "entries"
+  ]
+}

package/schema/match-history-replay-request.schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryReplayRequest",
+  "description": "Request body for loading a completed, authorized match replay.",
+  "type": "object",
+  "properties": {
+    "identities": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    }
+  },
+  "required": [
+    "identities"
+  ]
+}

package/schema/match-history-replay-response.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryReplayResponse",
+  "description": "Response body for a completed match replay request.",
+  "type": "object",
+  "properties": {
+    "archive": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchHistoryReplayArchive"
+    }
+  },
+  "required": [
+    "archive"
+  ]
+}

package/schema/match-history-restore-request.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchHistoryRestoreRequest",
+  "description": "Request body for restoring one saved history entry.",
+  "type": "object",
+  "properties": {
+    "identities": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "restoreRequestId": {
+      "description": "Stable browser-generated operation id used to make retries idempotent.",
+      "type": "string",
+      "format": "uuid"
+    }
+  },
+  "required": [
+    "identities",
+    "restoreRequestId"
+  ]
+}

package/schema/match-save-payload.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MatchSavePayload",
+  "description": "Full state snapshot of one match, suitable for stateless transport.\n\nSDK consumers persist this however they like (clipboard, IndexedDB, file\ndownload, server upload). The simulator does not store it on disk.",
+  "type": "object",
+  "properties": {
+    "aiOpponents": {
+      "description": "AI seat configs. Restore re-spawns drivers from these; MCTS trees and\nRNG state are deliberately rebuilt from restored gameplay state.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AiOpponentConfig"
+      }
+    },
+    "aiPaused": {
+      "description": "Whether AI was manually paused when this snapshot was captured.",
+      "type": "boolean"
+    },
+    "copiedCards": {
+      "description": "Wire mirror of the [`UnitState::copied_card`] Arcs that the inner\nstate could not embed. Keyed by `unit.instance_id`. Empty when no\nactive unit has a copied card.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/UnitCopiedCardEntry"
+      }
+    },
+    "lessonScenarioId": {
+      "description": "Authored Learn scenario whose scripted AI opener remains active.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "restoreAuthorizationSignature": {
+      "description": "Server-generated HMAC-SHA256 capability over every other payload field\nplus the out-of-band seat token authorized to export this save. The\ntoken itself is never embedded. Public restore verifies this signature\nwithout loading the source session, so a save survives source cleanup\nand restarts while rejecting any payload or token tampering. Local and\nhistory saves leave this as `None`.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "seats": {
+      "description": "Per-seat deck definitions, used at restore to rebuild the catalog\n`Arc` maps that the inner [`MatchState`] skipped at serialize time.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchSaveSeat"
+      }
+    },
+    "sourceMatchId": {
+      "description": "Match id of the original session this save was captured from. The\nrestored match gets a fresh id; this field is for traceability only.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "state": {
+      "description": "The serialized engine state. Catalog `Arc`s are skip-default here\nand grafted on by the restore path before the state goes live.\n\nOpaque to the public schema — SDK consumers should treat this as an\nimplementation-defined object that round-trips byte-for-byte. Pinning\nevery engine sub-struct into the schema would couple the SDK type\nsurface to the entire engine, which we explicitly do not want."
+    },
+    "version": {
+      "description": "Wire-format version. Always [`MATCH_SAVE_VERSION`] for newly minted\npayloads; restore rejects mismatches.",
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    }
+  },
+  "required": [
+    "version",
+    "sourceMatchId",
+    "seats",
+    "aiOpponents",
+    "aiPaused",
+    "copiedCards",
+    "state"
+  ]
+}

package/schema/match-spectator-access-response.schema.json

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

package/schema/meta-window.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MetaWindow",
+  "description": "A simulator-owned competitive period that scopes ranked ratings.",
+  "type": "object",
+  "properties": {
+    "endsAtMs": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "slug": {
+      "type": "string"
+    },
+    "startsAtMs": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "title": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "slug",
+    "title",
+    "startsAtMs"
+  ]
+}

package/schema/meta-windows-response.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "MetaWindowsResponse",
+  "description": "Public list of ranked meta windows and the currently active window.",
+  "type": "object",
+  "properties": {
+    "currentId": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "format": "uuid"
+    },
+    "windows": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MetaWindow"
+      }
+    }
+  },
+  "required": [
+    "windows"
+  ]
+}

package/schema/prepare-lobby-limited-ai-decks-request.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "PrepareLobbyLimitedAiDecksRequest",
+  "description": "Asks the limited-event host to prebuild every server-AI deck after the\nshared pool is complete. Human players may continue constructing decks\nwhile this request runs.",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/ranked-admin-status.schema.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedAdminStatus",
+  "description": "Operator-facing ranked queue gauges included in simulator admin status.",
+  "type": "object",
+  "properties": {
+    "adminAdmissionEnabled": {
+      "description": "Whether an administrator has requested that new ranked queue entries remain open.\n\nThis records the mutable switch even when immutable deployment configuration currently\nprevents ranked use. The effective queue gate below also accounts for deployment state.",
+      "type": "boolean"
+    },
+    "admissionEnabled": {
+      "description": "Whether new ranked queue entries are currently permitted.\n\nThis is false when either the immutable deployment capability is unavailable or an\nadministrator has paused ranked admission. Ranked reads remain available while paused.",
+      "type": "boolean"
+    },
+    "enabled": {
+      "description": "Whether deployment configuration supplies the ranked feature and identity secret.",
+      "type": "boolean"
+    },
+    "openWindowSlug": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "pendingMatches": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "searchingCount": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "enabled",
+    "adminAdmissionEnabled",
+    "admissionEnabled",
+    "searchingCount",
+    "pendingMatches"
+  ]
+}

package/schema/ranked-leaderboard-entry.schema.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedLeaderboardEntry",
+  "description": "One placement-complete entry on a ranked leaderboard.",
+  "type": "object",
+  "properties": {
+    "avatarUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "draws": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    },
+    "games": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    },
+    "losses": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    },
+    "profileUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "rank": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    },
+    "rating": {
+      "type": "integer",
+      "format": "int32"
+    },
+    "wins": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "rank",
+    "displayName",
+    "rating",
+    "games",
+    "wins",
+    "losses",
+    "draws"
+  ]
+}

package/schema/ranked-leaderboard-query.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedLeaderboardQuery",
+  "description": "Query parameters accepted by the ranked leaderboard endpoint.",
+  "type": "object",
+  "properties": {
+    "limit": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint32",
+      "minimum": 0
+    },
+    "offset": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint32",
+      "minimum": 0
+    },
+    "queue": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RankedQueue"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  }
+}

package/schema/ranked-leaderboard-response.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedLeaderboardResponse",
+  "description": "Paginated ranking entries for one meta window and queue.",
+  "type": "object",
+  "properties": {
+    "entries": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RankedLeaderboardEntry"
+      }
+    },
+    "total": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "total",
+    "entries"
+  ]
+}

package/schema/ranked-matchmaking-view.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedMatchmakingView",
+  "description": "Ranked queue identity projected inside a lobby snapshot.",
+  "type": "object",
+  "properties": {
+    "queue": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RankedQueue"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "queue"
+  ]
+}

package/schema/ranked-profile-request.schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RankedProfileRequest",
+  "description": "Authenticated request for one account's ranked profile.",
+  "type": "object",
+  "properties": {
+    "accountToken": {
+      "type": "string"
+    },
+    "metaWindowId": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "format": "uuid"
+    }
+  },
+  "required": [
+    "accountToken"
+  ]
+}