@blizzard-api/d3 2.0.2 → 3.0.1

package/dist/index-arHhEnWi.d.ts

@@ -0,0 +1,347 @@
+import { Resource } from "@blizzard-api/core";
+
+//#region src/profile/types.d.ts
+interface AccountHeroFollowerItemsResponse {
+  enchantress: Record<string, FollowerItem>;
+  scoundrel: Record<string, FollowerItem>;
+  templar: Record<string, FollowerItem>;
+}
+interface AccountHeroItemsResponse {
+  accountBound: boolean;
+  armor: number;
+  attacksPerSecond: number;
+  attributes: Attributes;
+  attributesHtml: Attributes;
+  craftedBy?: CraftedBy;
+  damage?: string;
+  displayColor: DisplayColor;
+  dps?: string;
+  elementalType?: string;
+  flavorText: string;
+  gems?: Array<Gem>;
+  icon: string;
+  id: string;
+  isSeasonRequiredToDrop: boolean;
+  itemLevel: number;
+  maxDamage: number;
+  minDamage: number;
+  name: string;
+  openSockets: number;
+  requiredLevel: number;
+  seasonRequiredToDrop: number;
+  set?: Set;
+  slots: string;
+  stackSizeMax: number;
+  tooltipParams: string;
+  type: Record<string, boolean | string>;
+  typeName: string;
+}
+interface AccountHeroResponse {
+  alive: boolean;
+  class: string;
+  followers: Followers;
+  gender: number;
+  hardcore: boolean;
+  highestSoloRiftCompleted: number;
+  id: number;
+  items: Record<string, Item>;
+  kills: Kills;
+  lastUpdated: number;
+  legendaryPowers: Array<Item>;
+  level: number;
+  name: string;
+  paragonLevel: number;
+  progression: HeroProgression;
+  seasonal: boolean;
+  seasonCreated: number;
+  skills: Skills;
+  stats: Record<string, number>;
+}
+interface AccountResponse {
+  battleTag: string;
+  blacksmith: Artisan;
+  blacksmithHardcore: Artisan;
+  blacksmithSeason: Artisan;
+  blacksmithSeasonHardcore: Artisan;
+  guildName: string;
+  heroes: Array<Hero>;
+  highestHardcoreLevel: number;
+  jeweler: Artisan;
+  jewelerHardcore: Artisan;
+  jewelerSeason: Artisan;
+  jewelerSeasonHardcore: Artisan;
+  kills: AccountResponseKills;
+  lastHeroPlayed: number;
+  lastUpdated: number;
+  mystic: Artisan;
+  mysticHardcore: Artisan;
+  mysticSeason: Artisan;
+  mysticSeasonHardcore: Artisan;
+  paragonLevel: number;
+  paragonLevelHardcore: number;
+  paragonLevelSeason: number;
+  paragonLevelSeasonHardcore: number;
+  progression: Progression;
+  seasonalProfiles: Record<`season${number}`, Season>;
+  timePlayed: TimePlayed;
+}
+interface AccountHeroItem {
+  icon: string;
+  id: string;
+  name: string;
+  path: string;
+  slug: string;
+}
+interface AccountResponseKills {
+  elites: number;
+  hardcoreMonsters: number;
+  monsters: number;
+}
+interface Act {
+  completed: boolean;
+  completedQuests: Array<CompletedQuest>;
+}
+interface Active {
+  rune: Rune;
+  skill: Skill;
+}
+interface Artisan {
+  level: number;
+  slug: 'blacksmith' | 'jeweler' | 'mystic';
+}
+interface Attributes {
+  primary: Array<string>;
+  secondary?: Array<string>;
+}
+interface CompletedQuest {
+  name: string;
+  slug: string;
+}
+interface CraftedBy {
+  cost: number;
+  id: string;
+  itemProduced: ItemProduced;
+  name: string;
+  reagents: Array<Reagent>;
+  slug: string;
+}
+type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
+interface Dye {
+  icon: string;
+  id: string;
+  name: string;
+  tooltipParams: string;
+}
+interface Enchantress {
+  items: EnchantressItems;
+  level: number;
+  skills: Array<unknown>;
+  slug: string;
+  stats: Stats;
+}
+interface EnchantressItems {
+  mainHand: Item;
+}
+interface FollowerItem {
+  accountBound: boolean;
+  armor: number;
+  attacksPerSecond: number;
+  attributes?: Attributes;
+  attributesHtml?: Attributes;
+  blockChance?: string;
+  craftedBy?: CraftedBy;
+  damage?: string;
+  displayColor: string;
+  dps?: string;
+  dye?: Dye;
+  flavorText?: string;
+  icon: string;
+  id: string;
+  isSeasonRequiredToDrop: boolean;
+  itemLevel: number;
+  maxDamage: number;
+  minDamage: number;
+  name: string;
+  openSockets: number;
+  requiredLevel: number;
+  seasonRequiredToDrop: number;
+  set?: Set;
+  slots: string;
+  stackSizeMax: number;
+  tooltipParams: string;
+  type: Record<string, boolean | string>;
+  typeName: string;
+}
+interface Followers {
+  enchantress: Enchantress;
+  scoundrel: Scoundrel;
+  templar: Templar;
+}
+interface Gem {
+  attributes: Array<string>;
+  isGem: boolean;
+  isJewel: boolean;
+  item: AccountHeroItem;
+  jewelRank?: number;
+  jewelSecondaryUnlockRank?: number;
+}
+interface Hero {
+  class: string;
+  classSlug: string;
+  dead: boolean;
+  gender: number;
+  hardcore: boolean;
+  id: number;
+  kills: HeroKills;
+  'last-updated': number;
+  level: number;
+  name: string;
+  paragonLevel: number;
+  seasonal: boolean;
+}
+interface HeroKills {
+  elites: number;
+}
+interface HeroProgression {
+  act1: Act;
+  act2: Act;
+  act3: Act;
+  act4: Act;
+  act5: Act;
+}
+interface Item {
+  displayColor?: DisplayColor;
+  dyeColor?: Dye;
+  icon: string;
+  id: string;
+  name: string;
+  tooltipParams: string;
+}
+interface ItemProduced {
+  id: string;
+  path: string;
+}
+interface Kills {
+  elites: number;
+}
+interface Passive {
+  skill: Skill;
+}
+interface Progression {
+  act1: boolean;
+  act2: boolean;
+  act3: boolean;
+  act4: boolean;
+  act5: boolean;
+}
+interface Reagent {
+  item: AccountHeroItem;
+  quantity: number;
+}
+interface Rune {
+  description: string;
+  descriptionHtml: string;
+  level: number;
+  name: string;
+  slug: string;
+  type: string;
+}
+interface Scoundrel {
+  items: Record<string, Item>;
+  level: number;
+  skills: Array<Skill>;
+  slug: string;
+  stats: Stats;
+}
+interface Season {
+  highestHardcoreLevel: number;
+  kills: AccountResponseKills;
+  paragonLevel: number;
+  paragonLevelHardcore: number;
+  seasonId: number;
+  timePlayed: TimePlayed;
+}
+interface Set {
+  description: string;
+  descriptionHtml: string;
+  name: string;
+  slug: string;
+}
+interface Skill {
+  description: string;
+  descriptionHtml: string;
+  flavorText?: string;
+  icon: string;
+  level: number;
+  name: string;
+  slug: string;
+  tooltipUrl: string;
+}
+interface Skills {
+  active: Array<Active>;
+  passive: Array<Passive>;
+}
+interface Stats {
+  experienceBonus: number;
+  goldFind: number;
+  magicFind: number;
+}
+interface Templar {
+  items: TemplarItems;
+  level: number;
+  skills: Array<Skill>;
+  slug: string;
+  stats: Stats;
+}
+interface TemplarItems {
+  bracers: Item;
+  feet: Item;
+  hands: Item;
+  head: Item;
+  mainHand: Item;
+  offHand: Item;
+  shoulders: Item;
+  torso: Item;
+  waist: Item;
+}
+interface TimePlayed {
+  barbarian: number;
+  crusader: number;
+  'demon-hunter': number;
+  monk: number;
+  necromancer: number;
+  'witch-doctor': number;
+  wizard: number;
+}
+//#endregion
+//#region src/profile/index.d.ts
+/**
+ * Returns the account information for the specified battle tag.
+ * @param battleTag The battle tag of the account.
+ * @returns The account resource. See {@link AccountResponse}.
+ */
+declare function account(battleTag: string): Resource<AccountResponse>;
+/**
+ * Returns the hero information for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The hero resource. See {@link AccountHeroResponse}.
+ */
+declare function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
+/**
+ * Returns the follower items for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.
+ */
+declare function accountHeroFollowerItems(battleTag: string, heroId: number): Resource<AccountHeroFollowerItemsResponse>;
+/**
+ * Returns the items for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The hero items resource. See {@link AccountHeroResponse}.
+ */
+declare function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
+//#endregion
+export { AccountHeroFollowerItemsResponse as a, AccountResponse as c, accountHeroItems as i, accountHero as n, AccountHeroItemsResponse as o, accountHeroFollowerItems as r, AccountHeroResponse as s, account as t };
+//# sourceMappingURL=index-arHhEnWi.d.ts.map

package/dist/index-nKhzpD4F.d.ts

@@ -0,0 +1,56 @@
+import { Resource } from "@blizzard-api/core";
+
+//#region src/character-class-and-skill/types.d.ts
+interface CharacterClassResponse {
+  femaleName: string;
+  icon: string;
+  maleName: string;
+  name: string;
+  skillCategories: Array<SkillCategory>;
+  skills: Record<'active' | 'passive', Array<Skill>>;
+  slug: string;
+}
+interface SkillResponse {
+  runes: Array<Rune>;
+  skill: Skill;
+}
+interface Rune {
+  description: string;
+  descriptionHtml: string;
+  level: number;
+  name: string;
+  slug: string;
+  type: string;
+}
+interface Skill {
+  description: string;
+  descriptionHtml: string;
+  flavorText?: string;
+  icon: string;
+  level: number;
+  name: string;
+  slug: string;
+  tooltipUrl: string;
+}
+interface SkillCategory {
+  name: string;
+  slug: string;
+}
+//#endregion
+//#region src/character-class-and-skill/index.d.ts
+/**
+ * Returns the character class information for the specified character class slug.
+ * @param characterClassSlug The slug of the character class.
+ * @returns The character class resource. See {@link CharacterClassResponse}.
+ */
+declare function characterClass(characterClassSlug: string): Resource<CharacterClassResponse>;
+/**
+ * Returns the skill information for the specified character class and skill slugs.
+ * @param characterClassSlug The slug of the character class.
+ * @param skillSlug The slug of the skill.
+ * @returns The skill resource. See {@link SkillResponse}.
+ */
+declare function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse>;
+//#endregion
+export { SkillResponse as i, skill as n, CharacterClassResponse as r, characterClass as t };
+//# sourceMappingURL=index-nKhzpD4F.d.ts.map