@my-swu/simulator-client 0.1.0

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

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SaveMatchRequest",
+  "description": "Request body for `POST /api/matches/{match_id}/save`.",
+  "type": "object",
+  "properties": {
+    "seatToken": {
+      "description": "Seat credential for the completed match being exported.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken"
+  ]
+}

package/schema/server-message.schema.json

@@ -0,0 +1,192 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ServerMessage",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/WelcomePayload"
+        },
+        "type": {
+          "type": "string",
+          "const": "welcome"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "description": "Full connection-state recovery snapshot. Initial connect, explicit sync,\nand lag recovery pair this with a [`MatchHistorySnapshot`].",
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameState"
+        },
+        "type": {
+          "type": "string",
+          "const": "snapshot"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "description": "Incremental authoritative snapshot for one committed match revision.\nClients must ignore revisions older than the newest update they applied.",
+      "type": "object",
+      "properties": {
+        "payload": {
+          "type": "object",
+          "properties": {
+            "revision": {
+              "description": "Monotonic revision assigned when the match transition committed.",
+              "type": "integer",
+              "format": "uint64",
+              "minimum": 0
+            },
+            "snapshot": {
+              "description": "Viewer-authorized state projected for this exact revision.",
+              "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameState"
+            }
+          },
+          "required": [
+            "revision",
+            "snapshot"
+          ]
+        },
+        "type": {
+          "type": "string",
+          "const": "snapshotUpdate"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchHistorySnapshot"
+        },
+        "type": {
+          "type": "string",
+          "const": "historySnapshot"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchHistoryFeedEntry"
+        },
+        "type": {
+          "type": "string",
+          "const": "historyEntry"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameEvent"
+        },
+        "type": {
+          "type": "string",
+          "const": "event"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/CardInteractionCue"
+        },
+        "type": {
+          "type": "string",
+          "const": "interactionCue"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AiStatusPayload"
+        },
+        "type": {
+          "type": "string",
+          "const": "aiStatus"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/ErrorPayload"
+        },
+        "type": {
+          "type": "string",
+          "const": "error"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "type": "object",
+          "properties": {
+            "nonce": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        },
+        "type": {
+          "type": "string",
+          "const": "pong"
+        }
+      },
+      "required": [
+        "type",
+        "payload"
+      ]
+    }
+  ]
+}

package/schema/set-ai-paused-request.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SetAiPausedRequest",
+  "type": "object",
+  "properties": {
+    "paused": {
+      "description": "Whether the AI driver should pause before choosing more commands.",
+      "type": "boolean"
+    },
+    "seatToken": {
+      "description": "Seat token returned by match creation, join, or restore.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken",
+    "paused"
+  ]
+}

package/schema/set-ai-paused-response.schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "AiStatusPayload",
+  "type": "object",
+  "properties": {
+    "seats": {
+      "description": "Authoritative status for every AI-controlled seat. An empty list means\nthe match has no AI controller.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AiSeatStatusPayload"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "seats"
+  ]
+}

package/schema/set-ranked-admission-request.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SetRankedAdmissionRequest",
+  "description": "Request body for allowing or pausing new ranked queue admissions.",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "description": "Whether new ranked queue admissions are allowed.",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "enabled"
+  ]
+}

package/schema/set-simulator-maintenance-request.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SetSimulatorMaintenanceRequest",
+  "description": "Request body for enabling or disabling simulator maintenance.",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "description": "Whether new simulator starts should be rejected.",
+      "type": "boolean"
+    },
+    "message": {
+      "description": "Optional operator-supplied note displayed by admin clients.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RequiredNullableMaintenanceMessage"
+    }
+  },
+  "required": [
+    "enabled",
+    "message"
+  ]
+}

package/schema/simulator-admin-status-response.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SimulatorAdminStatusResponse",
+  "description": "Admin status payload combining drain mode and live counters.",
+  "type": "object",
+  "properties": {
+    "acceptingNewMatches": {
+      "description": "Whether the engine is accepting new matches/sessions.",
+      "type": "boolean"
+    },
+    "checkedAtMs": {
+      "description": "Epoch milliseconds when this status was generated.",
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "maintenance": {
+      "description": "Current drain-mode state.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MaintenanceStatus"
+    },
+    "ranked": {
+      "description": "Ranked-ladder availability and queue health.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/RankedAdminStatus"
+    },
+    "stats": {
+      "description": "Current operational counters.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/SimulatorRuntimeStats"
+    }
+  },
+  "required": [
+    "acceptingNewMatches",
+    "maintenance",
+    "stats",
+    "ranked",
+    "checkedAtMs"
+  ]
+}

package/schema/simulator-availability-response.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SimulatorAvailabilityResponse",
+  "description": "Public simulator availability payload.",
+  "type": "object",
+  "properties": {
+    "acceptingNewMatches": {
+      "description": "Whether the engine is accepting new matches/sessions.",
+      "type": "boolean"
+    },
+    "checkedAtMs": {
+      "description": "Epoch milliseconds when this status was generated.",
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "maintenance": {
+      "description": "Current drain-mode state.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MaintenanceStatus"
+    }
+  },
+  "required": [
+    "acceptingNewMatches",
+    "maintenance",
+    "checkedAtMs"
+  ]
+}

package/schema/simulator-report-list-response.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SimulatorReportListResponse",
+  "description": "One cursor-paginated admin report list page.",
+  "type": "object",
+  "properties": {
+    "nextCursor": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "reports": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/SimulatorReportSummary"
+      }
+    }
+  },
+  "required": [
+    "reports"
+  ]
+}

package/schema/simulator-report-response.schema.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SimulatorReportResponse",
+  "description": "Full sanitized support bundle returned only by the simulator admin API.",
+  "type": "object",
+  "properties": {
+    "bundle": true,
+    "bundleAvailable": {
+      "type": "boolean"
+    },
+    "failureKind": {
+      "type": "string"
+    },
+    "firstOccurredAtMs": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "matchId": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "message": {
+      "type": "string"
+    },
+    "occurredAtMs": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0
+    },
+    "occurrenceCount": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    },
+    "operation": {
+      "type": "string"
+    },
+    "reportId": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "seat": {
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/Seat"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "snapshotRevision": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "source": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "reportId",
+    "firstOccurredAtMs",
+    "occurredAtMs",
+    "occurrenceCount",
+    "matchId",
+    "source",
+    "operation",
+    "failureKind",
+    "bundleAvailable",
+    "message"
+  ]
+}

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

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SpectateLobbyRequest",
+  "type": "object",
+  "properties": {
+    "authenticated": {
+      "description": "Whether the spectator joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "description": "Optional public avatar image URL for the spectator.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "profileUrl": {
+      "description": "Optional public profile page URL for the spectator.",
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "name",
+    "authenticated"
+  ]
+}

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

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SpectateMatchRequest",
+  "type": "object",
+  "properties": {
+    "authenticated": {
+      "description": "Whether this spectator joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "avatarUrl": {
+      "description": "Optional public avatar image URL for the spectator.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "profileUrl": {
+      "description": "Optional public profile page URL for the spectator.",
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "name",
+    "authenticated"
+  ]
+}

package/schema/start-lobby-limited-match-request.schema.json

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

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

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

package/schema/start-tournament-event-request.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "StartTournamentEventRequest",
+  "description": "Request body for starting the sealed/draft event inside a tournament room.",
+  "type": "object",
+  "properties": {
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken"
+  ]
+}

package/schema/submit-lobby-limited-deck-request.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SubmitLobbyLimitedDeckRequest",
+  "type": "object",
+  "properties": {
+    "deck": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DeckInput"
+    },
+    "deckId": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "deckTitle": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "formatSetup": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/FormatSetupInput"
+    },
+    "playerToken": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "playerToken",
+    "deck",
+    "formatSetup"
+  ]
+}

package/schema/submit-match-deck-request.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SubmitMatchDeckRequest",
+  "description": "Body for `POST /api/matches/{match_id}/deck` — submits (or replaces)\nthe deck of a joined seat while the match is still gathering players.\nRejected once the seat is ready or the match has started.",
+  "type": "object",
+  "properties": {
+    "deck": {
+      "description": "Deck to register for this seat.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DeckInput"
+    },
+    "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"
+        }
+      ]
+    },
+    "seatToken": {
+      "description": "Seat token returned by match creation, join, or restore.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken",
+    "deck"
+  ]
+}

package/schema/submit-match-deck-response.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "SubmitMatchDeckResponse",
+  "type": "object",
+  "properties": {
+    "snapshot": {
+      "description": "Updated match snapshot visible to the submitting seat.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameState"
+    }
+  },
+  "required": [
+    "snapshot"
+  ]
+}