@my-swu/simulator-client 0.1.0

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

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "CreateLimitedEventRequest",
+  "description": "Request body for creating one limited event.",
+  "type": "object",
+  "properties": {
+    "draftRounds": {
+      "description": "Optional chaos-draft round configuration.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DraftRoundConfig"
+      }
+    },
+    "kind": {
+      "description": "Limited event kind to create.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventKind"
+    },
+    "pickTimerEnabled": {
+      "description": "Whether the draft uses a per-pick countdown that auto-picks on timeout.",
+      "type": "boolean"
+    },
+    "playerCount": {
+      "description": "Number of players expected in this event.",
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "sealedPackCount": {
+      "description": "Optional sealed-only booster count per player. Defaults to 6.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "seed": {
+      "description": "Optional deterministic seed for generated boosters and draft leaders.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "setCode": {
+      "description": "Set code used for booster generation.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "kind",
+    "setCode",
+    "playerCount",
+    "draftRounds",
+    "pickTimerEnabled"
+  ]
+}

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

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "CreateLobbyRequest",
+  "type": "object",
+  "properties": {
+    "config": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LobbyConfig"
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own the host player's history.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "hostAuthenticated": {
+      "description": "Whether the host joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "hostAvatarUrl": {
+      "description": "Optional public avatar image URL for the host player.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hostName": {
+      "type": "string"
+    },
+    "hostProfileUrl": {
+      "description": "Optional public profile page URL for the host player.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "matchSeed": {
+      "description": "Optional deterministic seed reused for limited duel matches.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "packSeed": {
+      "description": "Optional deterministic seed for limited pack/leader generation.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "visibility": {
+      "description": "Whether the lobby should appear in public browsing surfaces.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LobbyVisibility"
+    }
+  },
+  "required": [
+    "config",
+    "visibility",
+    "hostName",
+    "hostAuthenticated",
+    "historyIdentities"
+  ]
+}

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

@@ -0,0 +1,124 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "CreateMatchRequest",
+  "type": "object",
+  "properties": {
+    "aiOpponents": {
+      "description": "Explicit AI-driven seats. In a two-player match use seat Two; Twin\nSuns may list every non-host AI seat.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/AiOpponentConfig"
+      }
+    },
+    "format": {
+      "description": "Requested match format.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchFormat"
+    },
+    "formatSetup": {
+      "description": "Optional setup data for multi-game and limited event formats.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/FormatSetupInput"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own the host's history entry.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "historySection": {
+      "description": "Setup section this match should appear under in server-side history.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistorySection"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "hostAuthenticated": {
+      "description": "Whether the host joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "hostAvatarUrl": {
+      "description": "Optional public avatar image URL for the host seat.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hostDeck": {
+      "description": "Deck used by the host player.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DeckInput"
+    },
+    "hostDeckId": {
+      "description": "Freeform client deck id for the host deck.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hostDeckTitle": {
+      "description": "Display title for the host deck.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hostName": {
+      "description": "Non-empty display name for the host seat. Surfaced in every viewer's\nsnapshot via `SeatState.name`, including anonymous hosts that use a\ngenerated local handle.",
+      "type": "string"
+    },
+    "hostProfileUrl": {
+      "description": "Optional public profile page URL for the host seat.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "playerCount": {
+      "description": "Requested player count. Twin Suns supports 2-4 players; other formats\ncurrently support exactly 2 players.",
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "scenario": {
+      "description": "Optional authored scenario selector for direct Learn match creation.",
+      "anyOf": [
+        {
+          "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/MatchScenarioInput"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "seed": {
+      "description": "Optional deterministic match seed.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "format",
+    "playerCount",
+    "historyIdentities",
+    "hostDeck",
+    "aiOpponents",
+    "hostName",
+    "hostAuthenticated"
+  ]
+}

package/schema/create-meta-window-request.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "CreateMetaWindowRequest",
+  "description": "Request to create a simulator-owned ranked meta window.",
+  "type": "object",
+  "properties": {
+    "slug": {
+      "type": "string"
+    },
+    "startsAtMs": {
+      "description": "Defaults to the server clock when omitted.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "title": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "slug",
+    "title"
+  ]
+}

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

@@ -0,0 +1,104 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "CreateTournamentRoomRequest",
+  "description": "Request body for creating one sealed/draft tournament room.",
+  "type": "object",
+  "properties": {
+    "bestOfMatches": {
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "draftRounds": {
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/DraftRoundConfig"
+      }
+    },
+    "eventKind": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LimitedEventKind"
+    },
+    "historyIdentities": {
+      "description": "Personal identities that should own the host player's history.",
+      "type": "array",
+      "items": {
+        "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/HistoryIdentityInput"
+      }
+    },
+    "hostAuthenticated": {
+      "description": "Whether the host joined from an authenticated app session.",
+      "type": "boolean"
+    },
+    "hostAvatarUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hostName": {
+      "type": "string"
+    },
+    "hostProfileUrl": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "matchSeed": {
+      "description": "Optional deterministic seed reused for every duel table match.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "packSeed": {
+      "description": "Optional deterministic seed for limited pack/leader generation.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    },
+    "pickTimerEnabled": {
+      "description": "Enables the per-pick countdown with auto-pick on timeout (draft only).",
+      "type": "boolean"
+    },
+    "playerCount": {
+      "type": "integer",
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "sealedPackCount": {
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint8",
+      "maximum": 255,
+      "minimum": 0
+    },
+    "setCode": {
+      "type": "string"
+    },
+    "visibility": {
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/LobbyVisibility"
+    }
+  },
+  "required": [
+    "eventKind",
+    "setCode",
+    "playerCount",
+    "bestOfMatches",
+    "draftRounds",
+    "pickTimerEnabled",
+    "visibility",
+    "hostName",
+    "hostAuthenticated",
+    "historyIdentities"
+  ]
+}

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

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

package/schema/error-payload.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ErrorPayload",
+  "type": "object",
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "reportId": {
+      "description": "Opaque support correlation id, present only when the server persisted\nan administrator-readable diagnostic bundle.",
+      "type": [
+        "string",
+        "null"
+      ],
+      "format": "uuid"
+    },
+    "retryAtMs": {
+      "description": "Epoch milliseconds when a rate-limited request may be retried.",
+      "type": [
+        "integer",
+        "null"
+      ],
+      "format": "uint64",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ]
+}

package/schema/format-event-request.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "FormatEventRequest",
+  "description": "HTTP request body for applying a format-event command.",
+  "type": "object",
+  "properties": {
+    "command": {
+      "description": "Out-of-game format command to apply.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/FormatEventCommand"
+    },
+    "seatToken": {
+      "description": "Seat token returned by match creation or join.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "seatToken",
+    "command"
+  ]
+}

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

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "FormatEventResponse",
+  "description": "HTTP response after applying a format-event command.",
+  "type": "object",
+  "properties": {
+    "snapshot": {
+      "description": "Updated match snapshot visible to the acting seat.",
+      "$ref": "https://simulator-sdk.my-swu.com/schema/common.json#/$defs/GameState"
+    }
+  },
+  "required": [
+    "snapshot"
+  ]
+}