@my-swu/simulator-client

---

@my-swu/simulator-client / DeckJson

Interface: DeckJson

Defined in: packages/ts-sdk/src/resources/card-types.ts:204

my-swu JSON deck export shape accepted by cards.convertDeckJson().

Unknown metadata contents and reserve cards are ignored because they are deckbuilder annotations, not simulator deck input.

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

console.log(deckJson)

Example

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

const exportedDeck: DeckJson = {
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

console.log(exportedDeck.deck?.length)

See

https://simulator-sdk.my-swu.com/guide/card-ids#json-deck-imports

Properties

base?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { base } = deckJson

console.log(base)

optional base?: DeckJsonCard | null

Defined in: packages/ts-sdk/src/resources/card-types.ts:220

Base entry.

---

deck?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { deck: mainDeckEntries } = deckJson

console.log(mainDeckEntries)

optional deck?: DeckJsonCard[]

Defined in: packages/ts-sdk/src/resources/card-types.ts:224

Main-deck card entries.

---

leader?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { leader } = deckJson

console.log(leader)

optional leader?: DeckJsonCard | null

Defined in: packages/ts-sdk/src/resources/card-types.ts:212

Primary leader entry.

---

metadata?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { metadata: deckMetadata } = deckJson

console.log(deckMetadata)

optional metadata?: unknown

Defined in: packages/ts-sdk/src/resources/card-types.ts:208

Optional deck metadata. Ignored by simulator deck conversion.

---

reserve?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { reserve } = deckJson

console.log(reserve)

optional reserve?: DeckJsonCard[]

Defined in: packages/ts-sdk/src/resources/card-types.ts:232

Reserved cards from deckbuilding notes. Ignored by simulator deck conversion.

---

secondleader?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { secondleader } = deckJson

console.log(secondleader)

optional secondleader?: DeckJsonCard | null

Defined in: packages/ts-sdk/src/resources/card-types.ts:216

Optional second leader entry used by Twin Suns exports.

---

sideboard?

Example:

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

const deckJson: DeckJson = {
  metadata: { name: 'Import Test', author: 'tester' },
  leader: { id: 'SOR_001', count: 1 },
  base: { id: 'SOR_025', count: 1 },
  deck: [{ id: 'SOR_010', count: 3 }],
}

const { sideboard } = deckJson

console.log(sideboard)

optional sideboard?: DeckJsonCard[]

Defined in: packages/ts-sdk/src/resources/card-types.ts:228

Sideboard entries.