@blizzard-api/classic-wow 3.0.4 → 4.0.0

package/dist/index-C7VwaWu6.d.ts

@@ -0,0 +1,66 @@
+import { BlizzardNamespaces, Character, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-statistics/types.d.ts
+interface CharacterStatisticsSummaryResponse extends ResponseBase {
+  agility: BaseEffectiveStat;
+  arcane_resistance?: BaseEffectiveStat;
+  armor: BaseEffectiveStat;
+  attack_power: number;
+  block: RatingWithValue;
+  bonus_armor?: number;
+  character: Character;
+  defense?: BaseEffectiveStat;
+  dodge: RatingWithValue;
+  fire_resistance?: BaseEffectiveStat;
+  health: number;
+  holy_resistance?: BaseEffectiveStat;
+  intellect: BaseEffectiveStat;
+  main_hand_damage_max: number;
+  main_hand_damage_min: number;
+  main_hand_dps: number;
+  main_hand_speed: number;
+  mana_regen: number;
+  mana_regen_combat: number;
+  mastery?: RatingWithValue;
+  melee_crit: RatingWithValue;
+  melee_haste?: RatingWithValue;
+  nature_resistance?: BaseEffectiveStat;
+  off_hand_damage_max: number;
+  off_hand_damage_min: number;
+  off_hand_dps: number;
+  off_hand_speed: number;
+  parry: RatingWithValue;
+  power: number;
+  power_type: NameIdKey;
+  ranged_crit: RatingWithValue;
+  ranged_haste?: RatingWithValue;
+  shadow_resistance?: BaseEffectiveStat;
+  spell_crit: RatingWithValue;
+  spell_haste?: RatingWithValue;
+  spell_penetration: number;
+  spell_power: number;
+  spirit: BaseEffectiveStat;
+  stamina: BaseEffectiveStat;
+  strength: BaseEffectiveStat;
+}
+interface BaseEffectiveStat {
+  base: number;
+  effective: number;
+}
+interface RatingWithValue {
+  rating_bonus: number;
+  rating_normalized: number;
+  value: number;
+}
+//#endregion
+//#region src/character-statistics/index.d.ts
+/**
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a statistics summary for a character.
+ */
+declare function characterStatisticsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
+//#endregion
+export { CharacterStatisticsSummaryResponse as n, characterStatisticsSummary as t };
+//# sourceMappingURL=index-C7VwaWu6.d.ts.map

package/dist/index-Ce02MoQO.d.ts

@@ -0,0 +1,37 @@
+import { BaseSearchParameters, BlizzardNamespaces, KeyBase, MediaAsset, Resource, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/media-search/types.d.ts
+/**
+ * The search parameters for media.
+ * @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 MediaSearchParameters extends BaseSearchParameters {
+  tags?: string;
+}
+/**
+ * The response for a media 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 MediaSearchResponse extends SearchResponseWithoutResults {
+  results: Array<MediaSearchResponseItem>;
+}
+interface MediaSearchResponseItem extends KeyBase {
+  data: {
+    assets?: Array<MediaAsset>;
+    id?: number;
+  };
+}
+//#endregion
+//#region src/media-search/index.d.ts
+/**
+ * Search for media.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param options The search parameters. See {@link MediaSearchParameters}.
+ * @returns The search results. See {@link MediaSearchResponse}.
+ */
+declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
+//#endregion
+export { MediaSearchParameters as n, MediaSearchResponse as r, mediaSearch as t };
+//# sourceMappingURL=index-Ce02MoQO.d.ts.map

package/dist/index-DDSvssGG.d.ts

@@ -0,0 +1,59 @@
+import { BlizzardNamespaces, GenderName, Href, KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/playable-class/types.d.ts
+/**
+ * The response for a playable class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableClassIndexResponse extends ResponseBase {
+  classes: Array<NameIdKey>;
+}
+/**
+ * The response for playable class media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableClassMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a playable class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft-classic/game-data-apis}
+ */
+interface PlayableClassResponse extends NameId, ResponseBase {
+  additional_power_types?: Array<NameIdKey>;
+  gender_name: GenderName;
+  media: Media;
+  playable_races: Array<NameIdKey>;
+  power_type: NameIdKey;
+  pvp_talent_slots: Href;
+  specializations?: Array<NameIdKey>;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/playable-class/index.d.ts
+/**
+ * Get a playable class by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param playableClassId The playable class ID.
+ * @returns The playable class. See {@link PlayableClassResponse}.
+ */
+declare function playableClass(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableClassId: number): Resource<PlayableClassResponse>;
+/**
+ * Get a playable class index.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @returns The playable class index. See {@link PlayableClassIndexResponse}.
+ */
+declare function playableClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PlayableClassIndexResponse>;
+/**
+ * Get playable class media by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param playableClassId The playable class ID.
+ * @returns The playable class media. See {@link PlayableClassMediaResponse}.
+ */
+declare function playableClassMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableClassId: number): Resource<PlayableClassMediaResponse>;
+//#endregion
+export { PlayableClassMediaResponse as a, PlayableClassIndexResponse as i, playableClassIndex as n, PlayableClassResponse as o, playableClassMedia as r, playableClass as t };
+//# sourceMappingURL=index-DDSvssGG.d.ts.map

package/dist/index-DSc_fuNb.d.ts

@@ -0,0 +1,46 @@
+import { BlizzardNamespaces, Href, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/auction-house/types.d.ts
+interface AuctionHouseIndexResponse extends ResponseBase {
+  auctions: Array<NameIdKey>;
+}
+interface AuctionsResponse extends NameId, ResponseBase {
+  auctions: Array<Auction>;
+  connected_realm: Href;
+}
+interface Auction {
+  bid: number;
+  buyout: number;
+  id: number;
+  item: {
+    id: number;
+    rand?: number;
+    seed?: number;
+  };
+  quantity: number;
+  time_left: 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
+}
+//#endregion
+//#region src/auction-house/index.d.ts
+/**
+ * Returns an index of auction houses for a connected realm.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param connectedRealmId The ID of the connected realm.
+ * @returns The auction house index. See {@link AuctionHouseIndexResponse}.
+ */
+declare function auctionHouseIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number): Resource<AuctionHouseIndexResponse>;
+/**
+ * Returns all active auctions for a specific auction house on a connected realm.
+ *
+ * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+ *
+ * Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param connectedRealmId The ID of the connected realm.
+ * @param auctionHouseId The ID of the auction house.
+ * @returns The auction house data. See {@link AuctionsResponse}.
+ */
+declare function auctions(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number, auctionHouseId: number): Resource<AuctionsResponse>;
+//#endregion
+export { AuctionsResponse as i, auctions as n, AuctionHouseIndexResponse as r, auctionHouseIndex as t };
+//# sourceMappingURL=index-DSc_fuNb.d.ts.map

package/dist/index-DUgdQv4k.d.ts

@@ -0,0 +1,36 @@
+import { BlizzardNamespaces, Href, NameId, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/region/types.d.ts
+/**
+ * The response for a region index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RegionIndexResponse extends ResponseBase {
+  regions: Array<Href>;
+}
+/**
+ * The response for a region.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RegionResponse extends NameId, ResponseBase {
+  patch_string: string;
+  tag: string;
+}
+//#endregion
+//#region src/region/index.d.ts
+/**
+ * Get a region by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param regionId The region ID.
+ * @returns The region. See {@link RegionResponse}.
+ */
+declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, regionId: number): Resource<RegionResponse>;
+/**
+ * Get a region index.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @returns The region index. See {@link RegionIndexResponse}.
+ */
+declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RegionIndexResponse>;
+//#endregion
+export { RegionResponse as i, regionIndex as n, RegionIndexResponse as r, region as t };
+//# sourceMappingURL=index-DUgdQv4k.d.ts.map

package/dist/index-DajMx-uR.d.ts

@@ -0,0 +1,143 @@
+import { BlizzardNamespaces, Character, Color, Faction, Factions, Href, KeyBase, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/guild/types.d.ts
+interface GuildAchievementsClassicEraResponse extends ResponseBase {
+  guild: Guild;
+}
+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;
+  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 Guild extends NameIdKey {
+  faction: Faction;
+  realm: Realm;
+}
+interface Member {
+  character: RosterMemberCharacter;
+  rank: number;
+}
+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 namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @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(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildResponse>;
+/**
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @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<T extends Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>>(namespace: T, realmSlug: string, nameSlug: string): Resource<T extends 'profile-classic1x' ? GuildAchievementsClassicEraResponse : GuildAchievementsResponse>;
+/**
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @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(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
+/**
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @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(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
+//#endregion
+export { GuildAchievementsClassicEraResponse as a, GuildResponse as c, guildRoster as i, GuildRosterResponse as l, guildAchievements as n, GuildAchievementsResponse as o, guildActivity as r, GuildActivityResponse as s, guild as t };
+//# sourceMappingURL=index-DajMx-uR.d.ts.map

package/dist/index-Djpr-_AW.d.ts

@@ -0,0 +1,65 @@
+import { BlizzardNamespaces, Color, KeyBase, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/guild-crest/types.d.ts
+/**
+ * The response for a guild crest border or emblem.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestBorderEmblemResponse extends ResponseBase {
+  assets: Array<GuildCrestAsset>;
+  id: number;
+}
+/**
+ * The response for the guild crest components index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestComponentsIndexResponse extends ResponseBase {
+  borders: Array<Border>;
+  colors: Colors;
+  emblems: Array<Border>;
+}
+interface Background {
+  id: number;
+  rgba: Color;
+}
+interface Border {
+  id: number;
+  media: Media;
+}
+interface Colors {
+  backgrounds?: Array<Background>;
+  borders?: Array<Background>;
+  emblems?: Array<Background>;
+}
+interface GuildCrestAsset {
+  key: string;
+  value: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/guild-crest/index.d.ts
+/**
+ * Returns media for a guild crest border by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param borderId The guild crest border ID.
+ * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestBorder(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, borderId: number): Resource<GuildCrestBorderEmblemResponse>;
+/**
+ * Returns an index of guild crest media.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+ */
+declare function guildCrestComponentsIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<GuildCrestComponentsIndexResponse>;
+/**
+ * Returns media for a guild crest emblem by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param emblemId The guild crest emblem ID.
+ * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
+//#endregion
+export { GuildCrestComponentsIndexResponse as a, GuildCrestBorderEmblemResponse as i, guildCrestComponentsIndex as n, guildCrestEmblem as r, guildCrestBorder as t };
+//# sourceMappingURL=index-Djpr-_AW.d.ts.map

package/dist/index-DmVmLB_p.d.ts

@@ -0,0 +1,51 @@
+import { BlizzardNamespaces, Character, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-specialization/types.d.ts
+interface CharacterSpecializationsSummaryResponse extends ResponseBase {
+  active_specialization?: NameIdKey;
+  character: Character;
+  specialization_groups: Array<SpecializationGroup>;
+  specializations?: Array<ClassicProgressionSpecialization>;
+}
+interface ClassicProgressionSpecialization {
+  specialization: NameIdKey;
+  specialization_name: string;
+  talents?: Array<TalentElement>;
+}
+interface SpecializationGroup {
+  glyphs?: Array<NameId>;
+  is_active: boolean;
+  specializations?: Array<SpecializationGroupItem>;
+}
+interface SpecializationGroupItem {
+  specialization_name: string;
+  spent_points: number;
+  talents: Array<TalentElement>;
+}
+interface SpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  power_cost?: null | string;
+  range?: string;
+  spell: NameId;
+}
+interface TalentElement {
+  spell_tooltip: SpellTooltip;
+  talent: NameId | {
+    id: number;
+  };
+  talent_rank?: number;
+}
+//#endregion
+//#region src/character-specialization/index.d.ts
+/**
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's specializations.
+ */
+declare function characterSpecializationsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
+//#endregion
+export { CharacterSpecializationsSummaryResponse as n, characterSpecializationsSummary as t };
+//# sourceMappingURL=index-DmVmLB_p.d.ts.map

package/dist/index-i0vuifJx.d.ts

@@ -0,0 +1,33 @@
+import { BlizzardNamespaces, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/power-type/types.d.ts
+/**
+ * The response for a power type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PowerTypeIndexResponse extends ResponseBase {
+  power_types: Array<NameIdKey>;
+}
+/**
+ * The response for a power type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PowerTypeResponse extends NameId, ResponseBase {}
+//#endregion
+//#region src/power-type/index.d.ts
+/**
+ * Get a power type by ID.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @param powerTypeId The power type ID.
+ * @returns The power type. See {@link PowerTypeResponse}.
+ */
+declare function powerType(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, powerTypeId: number): Resource<PowerTypeResponse>;
+/**
+ * Get a power type index.
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+ * @returns The power type index. See {@link PowerTypeIndexResponse}.
+ */
+declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PowerTypeIndexResponse>;
+//#endregion
+export { PowerTypeResponse as i, powerTypeIndex as n, PowerTypeIndexResponse as r, powerType as t };
+//# sourceMappingURL=index-i0vuifJx.d.ts.map