@my-swu/simulator-client

---

@my-swu/simulator-client / MatchAccessRecoveryResponse

Type Alias: MatchAccessRecoveryResponse

MatchAccessRecoveryResponse = { access: MatchAccessResponse; kind: "recovered"; } | { kind: "unavailable"; }

Defined in: packages/ts-sdk/src/generated/types/common.ts:3898

Result of recovering current private access for a live Solo-versus-AI match.

Unavailable deliberately combines unknown, unauthorized, inactive, and ineligible matches so this endpoint cannot be used to probe match state.

Example:

import type { MatchAccessRecoveryResponse } from '@my-swu/simulator-client'

const matchAccessRecoveryResponse: MatchAccessRecoveryResponse = {
  "kind": "recovered",
  "access": {
    "matchId": 'example',
    "seat": "one",
    "seatToken": 'example',
    "snapshot": {
      "matchId": 'example',
      "format": "premier",
      "playerCount": 2,
      "series": {
        "format": "premier",
        "bestOfGames": 1,
        "currentGameNumber": 0,
        "games": [],
        "seats": [],
      },
      "status": "lobby",
      "phase": "lobby",
      "prompt": "lobbyReady",
      "roundNumber": 0,
      "turnPlayer": "one",
      "initiative": {
        "available": false,
      },
      "availableCounters": [],
      "consecutivePasses": 0,
      "winners": [],
      "eventsApplied": 0,
      "activeEffects": [],
      "delayedEffects": [],
      "currentAttack": {
        "attackerId": 0,
        "target": {
          "playerBase": {
            "seat": "one",
          },
        },
      },
      "pendingAbilities": [],
      "availableLeaderDeploys": [],
      "availableAttacks": [],
      "playActions": [],
      "rejectedPlayReasons": [],
      "actionAbilities": [],
      "groundArena": [],
      "spaceArena": [],
      "players": [],
    },
  },
}

console.log(matchAccessRecoveryResponse)

Union Members

Type Literal

Example:

import type { MatchAccessRecoveryResponse } from '@my-swu/simulator-client'

const matchAccessRecoveryResponse: MatchAccessRecoveryResponse = {
  "kind": "recovered",
  "access": {
    "matchId": 'example',
    "seat": "one",
    "seatToken": 'example',
    "snapshot": {
      "matchId": 'example',
      "format": "premier",
      "playerCount": 2,
      "series": {
        "format": "premier",
        "bestOfGames": 1,
        "currentGameNumber": 0,
        "games": [],
        "seats": [],
      },
      "status": "lobby",
      "phase": "lobby",
      "prompt": "lobbyReady",
      "roundNumber": 0,
      "turnPlayer": "one",
      "initiative": {
        "available": false,
      },
      "availableCounters": [],
      "consecutivePasses": 0,
      "winners": [],
      "eventsApplied": 0,
      "activeEffects": [],
      "delayedEffects": [],
      "currentAttack": {
        "attackerId": 0,
        "target": {
          "playerBase": {
            "seat": "one",
          },
        },
      },
      "pendingAbilities": [],
      "availableLeaderDeploys": [],
      "availableAttacks": [],
      "playActions": [],
      "rejectedPlayReasons": [],
      "actionAbilities": [],
      "groundArena": [],
      "spaceArena": [],
      "players": [],
    },
  },
}

console.log(matchAccessRecoveryResponse)

{ access: MatchAccessResponse; kind: "recovered"; }

access

access: MatchAccessResponse

Current private host capability for the existing live runtime.

kind

kind: "recovered"

---

Type Literal

Example:

import type { MatchAccessRecoveryResponse } from '@my-swu/simulator-client'

const matchAccessRecoveryResponse: MatchAccessRecoveryResponse = {
  "kind": "recovered",
  "access": {
    "matchId": 'example',
    "seat": "one",
    "seatToken": 'example',
    "snapshot": {
      "matchId": 'example',
      "format": "premier",
      "playerCount": 2,
      "series": {
        "format": "premier",
        "bestOfGames": 1,
        "currentGameNumber": 0,
        "games": [],
        "seats": [],
      },
      "status": "lobby",
      "phase": "lobby",
      "prompt": "lobbyReady",
      "roundNumber": 0,
      "turnPlayer": "one",
      "initiative": {
        "available": false,
      },
      "availableCounters": [],
      "consecutivePasses": 0,
      "winners": [],
      "eventsApplied": 0,
      "activeEffects": [],
      "delayedEffects": [],
      "currentAttack": {
        "attackerId": 0,
        "target": {
          "playerBase": {
            "seat": "one",
          },
        },
      },
      "pendingAbilities": [],
      "availableLeaderDeploys": [],
      "availableAttacks": [],
      "playActions": [],
      "rejectedPlayReasons": [],
      "actionAbilities": [],
      "groundArena": [],
      "spaceArena": [],
      "players": [],
    },
  },
}

console.log(matchAccessRecoveryResponse)

{ kind: "unavailable"; }