@beastmaster23/pokemon-tcg-yajs-sdk/src/definition/set.js

A modern JavaScript SDK for interacting with the Pokemon Trading Card Game API, providing an intuitive interface for accessing Pokemon TCG card data, set information, and market prices.

/**
 * Set class representing a Pokemon TCG set
 * Provides methods to access set information and interact with the Pokemon TCG API
 */

import configuration from '../configure.js';

class Set {
  /**
   * Creates a new Set instance
   * @param {Object} data - The set data from the API
   */
  constructor(data) {
    this.id = data.id;                    // String
    this.name = data.name;                // String
    this.series = data.series;            // String
    this.printedTotal = data.printedTotal;// Number
    this.total = data.total;              // Number
    this.legalities = data.legalities || {};// Dictionary/Object
    this.ptcgoCode = data.ptcgoCode;      // String
    this.releaseDate = data.releaseDate;  // String
    this.updatedAt = data.updatedAt;      // String
    this.images = data.images || {};      // Dictionary/Object
  }

  // Legality Methods
  /**
   * Checks if the set is legal in a specific format
   * @param {string} format - The format to check legality for
   * @returns {boolean} True if the set is legal in the format
   */
  isLegal(format) {
    return this.legalities[format] === "Legal";
  }

  // Image Methods
  /**
   * Gets the URL of the set symbol image
   * @returns {string|null} The set symbol image URL
   */
  getSymbolUrl() {
    return this.images.symbol;
  }

  /**
   * Gets the URL of the set logo image
   * @returns {string|null} The set logo image URL
   */
  getLogoUrl() {
    return this.images.logo;
  }

  // Set Information Methods
  /**
   * Gets the name of the set
   * @returns {string} The set name
   */
  getName() {
    return this.name;
  }

  /**
   * Gets the series of the set
   * @returns {string} The set series
   */
  getSeries() {
    return this.series;
  }

  /**
   * Gets the release date of the set
   * @returns {string} The set release date
   */
  getReleaseDate() {
    return this.releaseDate;
  }

  /**
   * Gets the last update timestamp of the set
   * @returns {string} The set update timestamp
   */
  getUpdatedAt() {
    return this.updatedAt;
  }

  /**
   * Gets the PTCGO code of the set
   * @returns {string} The PTCGO code
   */
  getPtcgoCode() {
    return this.ptcgoCode;
  }

  // Card Count Methods
  /**
   * Gets the total number of printed cards in the set
   * @returns {number} The printed total
   */
  getPrintedTotal() {
    return this.printedTotal;
  }

  /**
   * Gets the total number of cards in the set
   * @returns {number} The total
   */
  getTotal() {
    return this.total;
  }

  // Legality Information Methods
  /**
   * Gets the legality information for all formats
   * @returns {Object} The legality information
   */
  getLegalities() {
    return this.legalities;
  }
}

export default Set;