@gw2api/types/data/item.ts

TypeScript types for all datastructures used by the Guild Wars 2 API

import type { SchemaAfter, SchemaVersion } from "../schema";

export type Item<Schema extends SchemaVersion = undefined> =
  Schema extends undefined ? ItemBase :
  Schema extends SchemaAfter<'2020-11-17T00:30:00.000Z'> | 'latest' ? Item_2020_11_17 :
  ItemBase;

type Item_2020_11_17 = Omit<ItemBase, 'details'> & {
  details?: Omit<NonNullable<ItemBase['details']>, 'secondary_suffix_item_id'> & {
    secondary_suffix_item_id?: number;
  }
};

type ItemBase = {
  chat_link: string;
  default_skin?: number;
  description?: string;
  details?: {
    apply_count?: number;
    attribute_adjustment?: number;
    bonuses?: string[];
    charges?: number;
    color_id?: number;
    damage_type?: 'Choking' | 'Physical' | 'Ice' | 'Fire' | 'Lightning';
    defense?: number;
    description?: string;
    duration_ms?: number;
    extra_recipe_ids?: number[];
    flags?: string[];
    guild_upgrade_id?: number;
    icon?: string;
    infix_upgrade?: {
      attributes: {
        attribute: Attribute;
        modifier: number;
      }[];
      buff?: {
        description?: string;
        skill_id: number;
      };
      id: number;
    };
    infusion_slots?: {
      flags?: string[];
      item_id?: number;
    }[];
    infusion_upgrade_flags?: string[];
    max_power?: number;
    min_power?: number;
    minipet_id?: number;
    name?: string;
    no_sell_or_sort?: boolean;
    recipe_id?: number;
    secondary_suffix_item_id?: string;
    size?: number;
    skins?: number[];
    stat_choices?: number[];
    suffix?: string;
    suffix_item_id?: number;
    type?: 'Axe' | 'SmallBundle' | 'Hammer' | 'Generic' | 'Staff' | 'Coat' | 'Leggings' | 'Boots' | 'Helm' | 'Shoulders' | 'Gloves' | 'HelmAquatic' | 'LargeBundle' | 'Immediate' | 'Transmutation' | 'Utility' | 'Booze' | 'Food' | 'Default' | 'Unlock' | 'GiftBox' | 'Amulet' | 'Accessory' | 'Ring' | 'Trident' | 'Scepter' | 'Focus' | 'ShortBow' | 'Warhorn' | 'Torch' | 'LongBow' | 'Pistol' | 'Rifle' | 'Speargun' | 'Dagger' | 'Sword' | 'Mace' | 'Shield' | 'Greatsword' | 'Harpoon' | 'ContainerKey' | 'Salvage' | 'Halloween' | 'ContractNpc' | 'OpenUI' | 'UpgradeRemoval' | 'RentableContractNpc' | 'Foraging' | 'Logging' | 'Mining' | 'Gem' | 'Sigil' | 'Rune' | 'AppearanceChange' | 'UnlimitedConsumable' | 'Toy' | 'ToyTwoHanded' | 'TeleportToFriend' | 'Currency' | 'RandomUnlock' | 'MountRandomUnlock' | 'Bait' | 'Lure';
    unlock_type?: 'CraftingRecipe' | 'Content' | 'BagSlot' | 'BankTab' | 'Dye' | 'CollectibleCapacity' | 'Outfit' | 'GliderSkin' | 'SharedSlot' | 'Champion' | 'Minipet' | 'Ms' | 'GearLoadoutTab' | 'BuildLibrarySlot' | 'BuildLoadoutTab' | 'JadeBotSkin';
    vendor_ids?: number[];
    weight_class?: 'Clothing' | 'Light' | 'Medium' | 'Heavy';
  };
  flags: string[];
  game_types: string[];
  icon?: string;
  id: number;
  level: number;
  name: string;
  rarity: 'Basic' | 'Fine' | 'Masterwork' | 'Exotic' | 'Rare' | 'Legendary' | 'Junk' | 'Ascended';
  restrictions: string[];
  type: 'Weapon' | 'Consumable' | 'Back' | 'Armor' | 'Trophy' | 'Container' | 'Gizmo' | 'Bag' | 'CraftingMaterial' | 'Trinket' | 'Tool' | 'MiniPet' | 'UpgradeComponent' | 'Gathering' | 'Key' | 'JadeTechModule' | 'PowerCore';
  upgrades_from?: {
    item_id: number;
    upgrade: 'Infusion' | 'Attunement';
  }[];
  upgrades_into?: {
    item_id: number;
    upgrade: 'Infusion' | 'Attunement';
  }[];
  vendor_value: number;
};

export type Attribute = 'Power' | 'Precision' | 'Toughness' | 'Vitality' | 'ConditionDamage' | 'CritDamage' | 'Healing' | 'BoonDuration' | 'ConditionDuration' | 'AgonyResistance';

export interface ItemStack {
  /** Item id */
  id: number;

  /** Amount of items */
  count: number;

  /** Charges remaining */
  charges?: number;

  /** Skin id of the item (only if not default) */
  skin?: number;

  /** Dyes applied */
  dyes?: Array<number | null>;

  /** Item ids of Runes/Sigils */
  upgrades?: number[];

  /** The slot occupied by the upgrade at the corresponding position in `upgrades` */
  upgrade_slot_indices?: number[];

  /** Item ids of infusions */
  infusions?: number[];

  /** Binding status */
  binding?: 'Account' | 'Character';

  /** Character name if `binding` is `Character` */
  bound_to?: string;

  /** Stats applied to the item */
  stats?: {
    /** Itemstats Id */
    id: number;

    /** Stats */
    attributes?: Partial<Record<Attribute, number>>
  }
}