IScryfallCard.ts

import { IScryfallCardFace } from "./IScryfallCardFace";
import { IScryfallColor } from "./IScryfallColor";
import { IScryfallObject } from "./IScryfallObject";
import { IScryfallRelatedCard } from "./IScryfallRelatedCard";

export interface IScryfallCardCoreFields {
  /**
   * This card's Arena ID, if any. A large percentage of cards are not available on Arena and do not have this ID.
   */
  arena_id?: number | null;

  /**
   * A unique ID for this card in Scryfall's database.
   */
  id: string;

  /**
   * A language code for this printing.
   */
  lang: string;

  /**
   * This card's Magic Online ID (also known as the Catalog ID), if any. A large
   * percentage of cards are not available on Magic Online and do not have this
   * ID.
   */
  mtgo_id?: number | null;

  /**
   * This card's foil Magic Online ID (also known as the Catalog ID), if any. A
   * large percentage of cards are not available on Magic Online and do not have
   * this ID.
   */
  mtgo_foil_id?: number | null;

  /**
   * This card's multiverse IDs on Gatherer, if any, as an array of integers.
   * Note that Scryfall includes many promo cards, tokens, and other esoteric
   * objects that do not have these identifiers.
   */
  multiverse_ids?: Array<number> | null;

  /**
   * This card's ID on TCGplayer's API, also known as the `productId`.
   */
  tcgplayer_id?: number | null;

  /**
   * This card's ID on TCGplayer's API, for its etched version if that version
   * is a separate product.
   */
  tcgplayer_etched_id?: number | null;

  /**
   * This card's ID on Cardmarket's API, also known as the `idProduct`.
   */
  cardmarket_id?: number | null;

  /**
   * A content type for this object, always `card`.
   */
  object: string;

  /**
   * A unique ID for this card's oracle identity. This value is consistent
   * across reprinted card editions, and unique among different cards with the
   * same name (tokens, Unstable variants, etc).
   */
  oracle_id: string;

  /**
   * A link to where you can begin paginating all re/prints for this card on
   * Scryfall's API.
   */
  prints_search_uri: string;

  /**
   * A link to this card's rulings list on Scryfall's API.
   */
  rulings_uri: string;

  /**
   * A link to this card's permapage on Scryfall's website.
   */
  scryfall_uri: string;

  /**
   * A link to this card object on Scryfall's API.
   */
  uri: string;
}

export interface IScryfallCardGameplayFields {
  /**
   * If this card is closely related to other cards, this property will be an
   * array with Related Card Objects.
   */
  all_parts?: Array<IScryfallRelatedCard> | null;

  /**
   * An array of Card Face objects, if this card is multifaced.
   */
  card_faces?: Array<IScryfallCardFace> | null;

  /**
   * The card's converted mana cost. Note that some funny cards have fractional
   * mana costs.
   */
  cmc: number;

  /**
   * This card's color identity.
   */
  color_identity: Array<IScryfallColor>;

  /**
   * The colors in this card's color indicator, if any. A null value for this
   * field indicates the card does not have one.
   */
  color_indicator?: Array<IScryfallColor> | null;

  /**
   * This card's colors, if the overall card has colors defined by the rules.
   * Otherwise the colors will be on the card_faces objects, see below.
   */
  colors?: Array<IScryfallColor> | null;

  /**
   * This card's overall rank/popularity on EDHREC. Not all cards are ranked.
   */
  edh_rank?: number | null;

  /**
   * This card's hand modifier, if it is Vanguard card. This value will contain
   * a delta, such as `'-1'`.
   */
  hand_modifier?: string | null;

  /**
   * An array of keywords that this card uses, such as `'Flying'` and
   * `'Cumulative upkeep'`.
   */
  keywords: Array<string>;

  /**
   * A code for this card's layout.
   */
  layout: string;

  /**
   * An object describing the legality of this card across play formats.
   * Possible legalities are `legal`, `not_legal`, `restricted`, and `banned`.
   */
  legalities: Record<string, "legal" | "not_legal" | "restricted" | "banned">;

  /**
   * This card's life modifier, if it is Vanguard card. This value will contain
   * a delta, such as `+2`.
   */
  life_modifier?: string | null;

  /**
   * This loyalty if any. Note that some cards have loyalties that are not
   * numeric, such as `X`.
   */
  loyalty?: string | null;

  /**
   * The mana cost for this card. This value will be any empty string "" if the
   * cost is absent. Remember that per the game rules, a missing mana cost and a
   * mana cost of `{0}` are different values. Multi-faced cards will report this
   * value in card faces.
   */
  mana_cost?: string | null;

  /**
   * The name of this card. If this card has multiple faces, this field will
   * contain both names separated by `␣//␣`.
   */
  name: string;

  /**
   * The Oracle text for this card, if any.
   */
  oracle_text?: string | null;

  /**
   * True if this card is oversized.
   */
  oversized: boolean;

  /**
   * This card’s rank/popularity on Penny Dreadful. Not all cards are ranked.
   */
  penny_rank?: number | null;

  /**
   * This card's power, if any. Note that some cards have powers that are not
   * numeric, such as `*`.
   */
  power?: string | null;

  /**
   * Colors of mana that this card could produce.
   */
  produced_mana?: Array<IScryfallColor> | null;

  /**
   * True if this card is on the Reserved List.
   */
  reserved: boolean;

  /**
   * This card's toughness, if any. Note that some cards have toughnesses that
   * are not numeric, such as `*`.
   */
  toughness?: string | null;

  /**
   * The type line of this card.
   */
  type_line: string;
}

export interface IScryfallCardPrintFields {
  /**
   * The name of the illustrator of this card. Newly spoiled cards may not have
   * this field yet.
   */
  artist?: string | null;

  /**
   * The lit Unfinity attractions lights on this card, if any.
   */
  attraction_lights?: Array<number> | null;

  /**
   * Whether this card is found in boosters.
   */
  booster: boolean;

  /**
   * This card's border color: `black`, `white`, `borderless`, `silver`, or
   * `gold`.
   */
  border_color: "black" | "white" | "borderless" | "silver" | "gold" | string;

  /**
   * The Scryfall ID for the card back design present on this card.
   */
  card_back_id: string;

  /**
   * This card's collector number. Note that collector numbers can contain
   * non-numeric characters, such as letters or `★`.
   */
  collector_number: string;

  /**
   * True if you should consider avoiding use of this print downstream.
   */
  content_warning?: boolean | null;

  /**
   * True if this card was only released in a video game.
   */
  digital: boolean;

  /**
   * An array of computer-readable flags that indicate if this card can come in
   * `foil`, `nonfoil`, `etched`, or `glossy` finishes.
   */
  finishes: Array<"foil" | "nonfoil" | "etched" | "glossy" | string>;

  /**
   * The just-for-fun name printed on the card (such as for Godzilla series
   * cards).
   */
  flavor_name?: string | null;

  /**
   * The flavor text, if any.
   */
  flavor_text?: string | null;

  /**
   * This card's frame effects, if any.
   */
  frame_effects?: Array<string> | null;

  /**
   * This card's frame layout.
   */
  frame: string;

  /**
   * True if this card's artwork is larger than normal.
   */
  full_art: boolean;

  /**
   * A list of games that this card print is available in, `paper`, `arena`,
   * and/or `mtgo`.
   */
  games: Array<"paper" | "arena" | "mtgo" | string>;

  /**
   * True if this card's imagery is high resolution.
   */
  highres_image: boolean;

  /**
   * A unique identifier for the card artwork that remains consistent across
   * reprints. Newly spoiled cards may not have this field yet.
   */
  illustration_id?: string | null;

  /**
   * A computer-readable indicator for the state of this card's image, one of `missing`, `placeholder`, `lowres`, or `highres_scan`.
   */
  image_status: "missing" | "placeholder" | "lowres" | "highres_scan" | string;

  /**
   * An object listing available imagery for this card.
   */
  image_uris?: Record<string, string> | null;

  /**
   * An object containing daily price information for this card, including
   * `usd`, `usd_foil`, `usd_etched`, `eur`, and `tix` prices, as strings.
   */
  prices: Record<string, string | null>;

  /**
   * The localized name printed on this card, if any.
   */
  printed_name?: string | null;

  /**
   * The localized text printed on this card, if any.
   */
  printed_text?: string | null;

  /**
   * The localized type line printed on this card, if any.
   */
  printed_type_line?: string | null;

  /**
   * True if this card is a promotional print.
   */
  promo: boolean;

  /**
   * An array of strings describing what categories of promo cards this card
   * falls into.
   */
  promo_types?: Array<string>;

  /**
   * An object providing URIs to this card's listing on major marketplaces.
   */
  purchase_uris: Record<string, string>;

  /**
   * This card's rarity. One of `common`, `uncommon`, `rare`, `special`,
   * `mythic`, or `bonus`.
   */
  rarity: "common" | "uncommon" | "rare" | "special" | "mythic" | "bonus";

  /**
   * An object providing URIs to this card's listing on other Magic: The
   * Gathering online resources.
   */
  related_uris: Record<string, string>;

  /**
   * The date this card was first released.
   */
  released_at: string;

  /**
   * True if this card is a reprint.
   */
  reprint: boolean;

  /**
   * A link to this card's set on Scryfall's website.
   */
  scryfall_set_url?: string;

  /**
   * This card's full set name.
   */
  set_name: string;

  /**
   * A link to where you can begin paginating this card's set on the Scryfall API.
   */
  set_search_uri: string;

  /**
   * The type of set this printing is in.
   */
  set_type: string;

  /**
   * A link to this card's set object on Scryfall's API.
   */
  set_uri: string;

  /**
   * This card's set code.
   */
  set: string;

  /**
   * This card's Set object UUID.
   */
  set_id: string;

  /**
   * True if this card is a Story Spotlight.
   */
  story_spotlight: boolean;

  /**
   * True if the card is printed without text.
   */
  textless: boolean;

  /**
   * Whether this card is a variation of another printing.
   */
  variation: boolean;

  /**
   * The printing ID of the printing this card is a variation of.
   */
  variation_of?: string | null;

  /**
   * The security stamp on this card, if any. One of `oval`, `triangle`, `acorn`, 'circle', `arena`, or 'heart'.
   */
  security_stamp?:
    | "oval"
    | "triangle"
    | "acorn"
    | "circle"
    | "arena"
    | "heart"
    | string
    | null;

  /**
   * This card's watermark, if any.
   */
  watermark?: string | null;

  preview?: {
    /**
     * The date this card was previewed.
     */
    previewed_at?: string | null;

    /**
     * A link to the preview for this card.
     */
    source_uri?: string | null;

    /**
     * The name of the source that previewed this card.
     */
    source?: string | null;
  } | null;
}

/**
 * Card objects represent individual Magic: The Gathering cards that players
 * could obtain and add to their collection (with a few minor exceptions).
 */
export interface IScryfallCard
  extends IScryfallObject,
    IScryfallCardCoreFields,
    IScryfallCardGameplayFields,
    IScryfallCardPrintFields {
  object: "card";
}