@blizzard-api/wow 3.0.6 → 4.0.0

package/dist/index-CE4iGLJf2.d.ts

@@ -0,0 +1,128 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/profession/types.d.ts
+/**
+ * The response for a profession index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionIndexResponse extends ResponseBase {
+  professions: Array<NameIdKey>;
+}
+/**
+ * The response for a profession media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a profession.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionResponse extends NameId, ResponseBase {
+  description: string;
+  media: Media;
+  skill_tiers: Array<NameIdKey>;
+  type: Type;
+}
+/**
+ * The response for a profession skill tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionSkillTierResponse extends NameId, ResponseBase {
+  categories: Array<Category>;
+  maximum_skill_level: number;
+  minimum_skill_level: number;
+}
+/**
+ * The response for a recipe media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RecipeMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a recipe.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RecipeResponse extends NameId, ResponseBase {
+  alliance_crafted_item?: NameIdKey;
+  crafted_item?: NameIdKey;
+  crafted_quantity?: CraftedQuantity;
+  description?: string;
+  horde_crafted_item?: NameIdKey;
+  media: Media;
+  modified_crafting_slots?: Array<ModifiedCraftSlot>;
+  rank?: number;
+  reagents?: Array<Reagent>;
+}
+interface Category {
+  name: string;
+  recipes: Array<NullishNameIdKey>;
+}
+interface CraftedQuantity {
+  maximum?: number;
+  minimum?: number;
+  value?: number;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface ModifiedCraftSlot {
+  display_order: number;
+  slot_type: KeyBase & {
+    id: number;
+    name?: string;
+  };
+}
+interface Reagent {
+  quantity: number;
+  reagent: NameIdKey;
+}
+interface Type {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/profession/index.d.ts
+/**
+ * Get a profession by ID.
+ * @param professionId The profession ID.
+ * @returns The profession. See {@link ProfessionResponse}.
+ */
+declare function profession(professionId: number): Resource<ProfessionResponse>;
+/**
+ * Get a profession index.
+ * @returns The profession index. See {@link ProfessionIndexResponse}.
+ */
+declare function professionIndex(): Resource<ProfessionIndexResponse>;
+/**
+ * Get profession media by ID.
+ * @param professionId The profession ID.
+ * @returns The profession media. See {@link ProfessionMediaResponse}.
+ */
+declare function professionMedia(professionId: number): Resource<ProfessionMediaResponse>;
+/**
+ * Get a profession's skill tier by ID.
+ * @param professionId The profession ID.
+ * @param skillTierId The skill tier ID.
+ * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
+ */
+declare function professionSkillTier(professionId: number, skillTierId: number): Resource<ProfessionSkillTierResponse>;
+/**
+ * Get a recipe by ID.
+ * @param recipeId The recipe ID.
+ * @returns The recipe. See {@link RecipeResponse}.
+ */
+declare function recipe(recipeId: number): Resource<RecipeResponse>;
+/**
+ * Get recipe media by ID.
+ * @param recipeId The recipe ID.
+ * @returns The recipe media. See {@link RecipeMediaResponse}.
+ */
+declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
+//#endregion
+export { recipe as a, ProfessionMediaResponse as c, RecipeMediaResponse as d, RecipeResponse as f, professionSkillTier as i, ProfessionResponse as l, professionIndex as n, recipeMedia as o, professionMedia as r, ProfessionIndexResponse as s, profession as t, ProfessionSkillTierResponse as u };
+//# sourceMappingURL=index-CE4iGLJf2.d.ts.map

package/dist/index-CH3CudPP.d.ts

@@ -0,0 +1,91 @@
+import { BaseSearchParameters, Faction, Factions, KeyBase, Locales, NameIdKey, NullishNameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/mount/types.d.ts
+/**
+ * The response for a mount index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MountIndexResponse extends ResponseBase {
+  mounts: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a mount.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MountResponse extends ResponseBase {
+  creature_displays: Array<CreatureDisplay>;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  name: string;
+  requirements?: {
+    classes?: Array<NameIdKey>;
+    faction?: Faction;
+    races?: Array<NameIdKey>;
+  };
+  should_exclude_if_uncollected?: boolean;
+  source?: Source;
+}
+/**
+ * The search parameters for mounts.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface MountSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+/**
+ * The response for a mount search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface MountSearchResponse extends SearchResponseWithoutResults {
+  results: Array<MountSearchResponseItem>;
+}
+interface CreatureDisplay extends KeyBase {
+  id: number;
+}
+interface MountSearchResponseItem extends KeyBase {
+  data: {
+    creature_displays: Array<{
+      id: number;
+    }>;
+    faction?: {
+      name: Record<Locales, string>;
+      type: Factions;
+    };
+    id: number;
+    name: Record<Locales, string>;
+    source: {
+      name: Record<Locales, string>;
+      type: string;
+    };
+  };
+}
+interface Source {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/mount/index.d.ts
+/**
+ * Get a mount by ID.
+ * @param mountId The mount ID.
+ * @returns The mount. See {@link MountResponse}.
+ */
+declare function mount(mountId: number): Resource<MountResponse>;
+/**
+ * Get a mount index.
+ * @returns The mount index. See {@link MountIndexResponse}.
+ */
+declare function mountIndex(): Resource<MountIndexResponse>;
+/**
+ * Get a mount search.
+ * @param options The search parameters. See {@link MountSearchParameters}.
+ * @returns The search results. See {@link MountSearchResponse}.
+ */
+declare function mountSearch(options: MountSearchParameters): Resource<MountSearchResponse, Omit<MountSearchParameters, 'locale' | 'name'>>;
+//#endregion
+export { MountResponse as a, MountIndexResponse as i, mountIndex as n, MountSearchParameters as o, mountSearch as r, MountSearchResponse as s, mount as t };
+//# sourceMappingURL=index-CH3CudPP.d.ts.map

package/dist/index-CJSqSpru.d.ts

@@ -0,0 +1,145 @@
+import { Character, Color, Faction, Factions, Href, KeyBase, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/guild/types.d.ts
+interface GuildAchievementsResponse extends ResponseBase {
+  achievements: Array<Achievement>;
+  category_progress: Array<CategoryProgress>;
+  guild: Guild;
+  recent_events: Array<RecentEvent>;
+  total_points: number;
+  total_quantity: number;
+}
+interface GuildActivityResponse extends ResponseBase {
+  activities: Array<ActivityElement>;
+  guild: Guild;
+}
+interface GuildResponse extends ResponseBase {
+  achievement_points: number;
+  achievements: Href;
+  activity: Href;
+  created_timestamp: number;
+  crest: Crest;
+  faction: Faction;
+  id: number;
+  member_count: number;
+  name: string;
+  name_search: string;
+  realm: Realm;
+  roster: Href;
+}
+interface GuildRosterResponse extends ResponseBase {
+  guild: Guild;
+  members: Array<Member>;
+}
+interface Achievement {
+  achievement: NameIdKey;
+  completed_timestamp?: number;
+  criteria?: Criteria;
+  id: number;
+}
+interface ActivityElement {
+  activity: {
+    type: string;
+  };
+  character_achievement?: CharacterAchievement;
+  encounter_completed?: EncounterActivity;
+  timestamp: number;
+}
+interface Border {
+  color: RgbWithId;
+  id: number;
+  media: KeyBase & {
+    id: number;
+  };
+}
+interface CategoryProgress {
+  category: NameIdKey;
+  points: number;
+  quantity: number;
+}
+interface CharacterAchievement {
+  achievement: NameIdKey;
+  character: Character;
+}
+interface ChildCriterum {
+  amount: number;
+  id: number;
+  is_completed: boolean;
+}
+interface Crest {
+  background: {
+    color: RgbWithId;
+  };
+  border: Border;
+  emblem: Border;
+}
+interface Criteria {
+  amount?: number;
+  child_criteria?: Array<ChildCriterum>;
+  id: number;
+  is_completed: boolean;
+}
+interface EncounterActivity {
+  encounter: NameIdKey;
+  mode: {
+    name: string;
+    type: ModeType;
+  };
+}
+interface Guild extends NameIdKey {
+  faction: Faction;
+  realm: Realm;
+}
+interface Member {
+  character: RosterMemberCharacter;
+  rank: number;
+}
+type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
+interface Playable extends KeyBase {
+  id: number;
+}
+interface RecentEvent {
+  achievement: NameIdKey;
+  timestamp: number;
+}
+interface RgbWithId {
+  id: number;
+  rgba: Color;
+}
+interface RosterMemberCharacter extends Character {
+  faction: {
+    type: Factions;
+  };
+  level: number;
+  playable_class: Playable;
+  playable_race: Playable;
+}
+//#endregion
+//#region src/guild/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild by its name and realm.
+ */
+declare function guild(realmSlug: string, nameSlug: string): Resource<GuildResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's achievements by name and realm.
+ */
+declare function guildAchievements(realmSlug: string, nameSlug: string): Resource<GuildAchievementsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's activity by name and realm.
+ */
+declare function guildActivity(realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's roster by its name and realm.
+ */
+declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
+//#endregion
+export { GuildAchievementsResponse as a, GuildRosterResponse as c, guildRoster as i, guildAchievements as n, GuildActivityResponse as o, guildActivity as r, GuildResponse as s, guild as t };
+//# sourceMappingURL=index-CJSqSpru.d.ts.map

package/dist/index-CP1gTrDv.d.ts

@@ -0,0 +1,312 @@
+import { BaseSearchParameters, Color, KeyBase, Locales, MediaAsset, NameId, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/item/types.d.ts
+/**
+ * The response for an item class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemClassIndexResponse extends ResponseBase {
+  item_classes: Array<NameIdKey>;
+}
+/**
+ * The response for an item class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemClassResponse extends ResponseBase {
+  class_id: number;
+  item_subclasses: Array<NameIdKey>;
+  name: string;
+}
+/**
+ * The response for an item media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for an item.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemResponse extends NameId, ResponseBase {
+  appearances?: Array<KeyBase & {
+    id: number;
+  }>;
+  description?: string;
+  inventory_type: InventoryTypeName;
+  is_equippable: boolean;
+  is_stackable: boolean;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: number;
+  max_count: number;
+  media: Media;
+  preview_item: PreviewItem;
+  purchase_price: number;
+  purchase_quantity: number;
+  quality: ItemQuality;
+  required_level: number;
+  sell_price: number;
+}
+/**
+ * The parameters for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface ItemSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+/**
+ * The response for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface ItemSearchResponse extends SearchResponseWithoutResults {
+  results: Array<ItemSearchResponseItem>;
+}
+/**
+ * The response for an item set index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSetIndexResponse extends ResponseBase {
+  item_sets: Array<NameIdKey>;
+}
+/**
+ * The response for an item set.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSetResponse extends ResponseBase {
+  effects: Array<Effect>;
+  id: number;
+  items: Array<NameIdKey>;
+  name: string;
+}
+/**
+ * The response for an item subclass.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSubClassResponse extends ResponseBase {
+  class_id: number;
+  display_name: string;
+  hide_subclass_in_tooltips?: boolean;
+  subclass_id: number;
+  verbose_name?: string;
+}
+interface Armor {
+  display: Display;
+  value: number;
+}
+interface Damage {
+  damage_class: {
+    name: string;
+    type: string;
+  };
+  display_string: string;
+  max_value: number;
+  min_value: number;
+}
+interface Display {
+  color: Color;
+  display_string: string;
+}
+interface Durability {
+  display_string: string;
+  value: number;
+}
+interface Effect {
+  display_string: string;
+  required_count: number;
+}
+type InventoryType = 'BACK' | 'CHEST' | 'FEET' | 'FINGER' | 'HAND' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'SHOULDER' | 'THROWN' | 'TRINKET' | 'WAIST' | 'WRIST' | 'RANGED' | 'TWOHWEAPON' | 'WEAPON' | 'WEAPONMAINHAND' | 'WEAPONOFFHAND' | 'BAG' | 'NON_EQUIP' | 'SHIRT' | 'TABARD';
+interface InventoryTypeName {
+  name: string;
+  type: InventoryType;
+}
+interface InventoryTypeNameFromSearch {
+  name: Record<Locales, string>;
+  type: InventoryType;
+}
+interface ItemQuality {
+  name: string;
+  type: ItemQualityType;
+}
+interface ItemQualityFromSearch {
+  name: Record<Locales, string>;
+  type: ItemQualityType;
+}
+type ItemQualityType = 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
+interface ItemSearchResponseItem extends KeyBase {
+  data: {
+    appearances?: Array<{
+      id: number;
+    }>;
+    id: number;
+    inventory_type: InventoryTypeNameFromSearch;
+    is_equippable: boolean;
+    is_stackable: boolean;
+    item_class: {
+      id: number;
+      name: Record<Locales, string>;
+    };
+    item_subclass: {
+      id: number;
+      name: Record<Locales, string>;
+    };
+    level: number;
+    max_count: number;
+    media: {
+      id: number;
+    };
+    name: Record<Locales, string | undefined>;
+    purchase_price: number;
+    purchase_quantity: number;
+    quality: ItemQualityFromSearch;
+    required_level: number;
+    sell_price: number;
+  };
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface PreviewItem {
+  armor?: Armor;
+  binding?: {
+    name: string;
+    type: string;
+  };
+  bonus_list?: Array<number>;
+  container_slots?: Durability;
+  context?: number;
+  crafting_reagent?: string;
+  description?: string;
+  durability?: Durability;
+  inventory_type: InventoryTypeName;
+  is_subclass_hidden?: boolean;
+  item: Media;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level?: Durability;
+  media: Media;
+  name: string;
+  quality: ItemQuality;
+  recipe?: Recipe;
+  requirements?: Requirements;
+  sell_price?: number;
+  shield_block?: Armor;
+  spells?: Array<Spell>;
+  stats?: Array<Stat>;
+  unique_equipped?: string;
+  weapon?: Weapon;
+}
+interface Recipe {
+  item: RecipeItem;
+  reagents: Array<NameIdKey & {
+    quantity: number;
+  }>;
+  reagents_display_string: string;
+}
+interface RecipeItem {
+  armor?: Armor;
+  binding: {
+    name: string;
+    type: string;
+  };
+  durability: Durability;
+  inventory_type: InventoryTypeName;
+  item: Media;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: Durability;
+  media: Media;
+  name: string;
+  quality: ItemQuality;
+  requirements: Requirements;
+  sell_price: {
+    display_strings: RecipeItemDisplayStrings;
+    value: number;
+  };
+  stats: Array<Stat>;
+  weapon?: Weapon;
+}
+interface RecipeItemDisplayStrings {
+  copper: string;
+  gold: string;
+  header: string;
+  silver: string;
+}
+interface Requirements {
+  level: Durability;
+}
+interface Spell {
+  description: string;
+  spell: NameIdKey;
+}
+interface Stat {
+  display: Display;
+  is_negated?: boolean;
+  type: {
+    name: string;
+    type: StatTypeCapitalized;
+  };
+  value: number;
+}
+type StatTypeCapitalized = 'AGILITY' | 'ARCANE_RESISTANCE' | 'CRIT_RATING' | 'FIRE_RESISTANCE' | 'FROST_RESISTANCE' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'NATURE_RESISTANCE' | 'SHADOW_RESISTANCE' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
+interface Weapon {
+  attack_speed: Durability;
+  damage: Damage;
+  dps: Durability;
+}
+//#endregion
+//#region src/item/index.d.ts
+/**
+ * Get an item by ID.
+ * @param itemId The item ID.
+ * @returns The item. See {@link ItemResponse}.
+ */
+declare function item(itemId: number): Resource<ItemResponse>;
+/**
+ * Get an item class by ID.
+ * @param itemClassId The item class ID.
+ * @returns The item class. See {@link ItemClassResponse}.
+ */
+declare function itemClass(itemClassId: number): Resource<ItemClassResponse>;
+/**
+ * Get an item class index.
+ * @returns The item class index. See {@link ItemClassIndexResponse}.
+ */
+declare function itemClassIndex(): Resource<ItemClassIndexResponse>;
+/**
+ * Get item media by ID.
+ * @param itemId The item ID.
+ * @returns The item media. See {@link ItemMediaResponse}.
+ */
+declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
+/**
+ * Search for items.
+ * @param options The search parameters. See {@link ItemSearchParameters}.
+ * @returns The search results. See {@link ItemSearchResponse}.
+ */
+declare function itemSearch(options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
+/**
+ * Get an item set by ID.
+ * @param itemSetId The item set ID.
+ * @returns The item set. See {@link ItemSetResponse}.
+ */
+declare function itemSet(itemSetId: number): Resource<ItemSetResponse>;
+/**
+ * Get an item set index.
+ * @returns The item set index. See {@link ItemSetIndexResponse}.
+ */
+declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
+/**
+ * Get an item subclass by ID.
+ * @param itemClassId The item class ID.
+ * @param itemSubclassId The item subclass ID.
+ * @returns The item subclass. See {@link ItemSubClassResponse}.
+ */
+declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
+//#endregion
+export { ItemSubClassResponse as _, itemSearch as a, itemSubClass as c, ItemMediaResponse as d, ItemResponse as f, ItemSetResponse as g, ItemSetIndexResponse as h, itemMedia as i, ItemClassIndexResponse as l, ItemSearchResponse as m, itemClass as n, itemSet as o, ItemSearchParameters as p, itemClassIndex as r, itemSetIndex as s, item as t, ItemClassResponse as u };
+//# sourceMappingURL=index-CP1gTrDv.d.ts.map