@blizzard-api/d3 2.0.1 → 3.0.0

package/dist/index.d.ts

@@ -1,723 +1,12 @@
-import { Href, Resource, ResponseBase } from "@blizzard-api/core";
+import { i as ActResponse, n as actIndex, r as ActIndexResponse, t as act } from "./index-DDdb6KdV.js";
+import { i as RecipeResponse, n as recipe, r as ArtisanResponse, t as artisan } from "./index-B3XcHQEG.js";
+import { i as SkillResponse, n as skill, r as CharacterClassResponse, t as characterClass } from "./index-nKhzpD4F.js";
+import { n as FollowerResponse, t as follower } from "./index-CbNO-aVd.js";
+import { a as seasonIndex, c as EraLeaderboardResponse, d as SeasonLeaderboardResponse, f as SeasonResponse, i as season, l as EraResponse, n as eraIndex, o as seasonLeaderboard, r as eraLeaderboard, s as EraIndexResponse, t as era, u as SeasonIndexResponse } from "./index-Odfm-W__.js";
+import { i as ItemTypeResponse, n as itemTypeIndex, r as ItemTypeIndexResponse, t as itemType } from "./index-Cd9ttc2_.js";
+import { a as RandomAffix, i as Primary, n as Attributes, o as Type, r as ItemResponse, t as item } from "./index-DC4Sl-cR.js";
+import { a as AccountHeroFollowerItemsResponse, c as AccountResponse, i as accountHeroItems, n as accountHero, o as AccountHeroItemsResponse, r as accountHeroFollowerItems, s as AccountHeroResponse, t as account } from "./index-arHhEnWi.js";
 
-//#region src/act/types.d.ts
-interface ActIndexResponse {
-  acts: Array<Act$1>;
-}
-interface ActResponse {
-  name: string;
-  number: number;
-  quests: Array<Quest>;
-  slug: string;
-}
-interface Act$1 {
-  name: string;
-  number: number;
-  quests: Array<Quest>;
-  slug: string;
-}
-interface Quest {
-  id: number;
-  name: string;
-  slug: string;
-}
-//#endregion
-//#region src/act/act.d.ts
-/**
- * Returns the act information for the specified act ID.
- * @param actId The ID of the act.
- * @returns The act resource. See {@link ActResponse}.
- */
-declare function act(actId: number): Resource<ActResponse>;
-/**
- * Returns the index of acts.
- * @returns The act index resource. See {@link ActIndexResponse}.
- */
-declare function actIndex(): Resource<ActIndexResponse>;
-//#endregion
-//#region src/artisan-and-recipe/types.d.ts
-interface ArtisanResponse {
-  name: string;
-  portrait: string;
-  slug: string;
-  training: Training;
-}
-interface RecipeResponse {
-  cost: number;
-  id: string;
-  itemProduced: Item$1;
-  name: string;
-  reagents: Array<Reagent$1>;
-  slug: string;
-}
-interface Item$1 {
-  icon: string;
-  id: string;
-  name: string;
-  path: string;
-  slug: string;
-}
-interface Reagent$1 {
-  item: Item$1;
-  quantity: number;
-}
-interface Recipe {
-  cost: number;
-  id: string;
-  itemProduced: Item$1;
-  name: string;
-  reagents: Array<Reagent$1>;
-  slug: string;
-}
-interface Tier {
-  taughtRecipes: Array<Recipe>;
-  tier: number;
-  trainedRecipes: Array<Recipe>;
-}
-interface Training {
-  tiers: Array<Tier>;
-}
-//#endregion
-//#region src/artisan-and-recipe/artisan-and-recipe.d.ts
-/**
- * Returns the artisan information for the specified artisan slug.
- * @param artisanSlug The slug of the artisan.
- * @returns The artisan resource. See {@link ArtisanResponse}.
- */
-declare function artisan(artisanSlug: string): Resource<ArtisanResponse>;
-/**
- * Returns the recipe information for the specified artisan and recipe slugs.
- * @param artisanSlug The slug of the artisan.
- * @param recipeSlug The slug of the recipe.
- * @returns The recipe resource. See {@link RecipeResponse}.
- */
-declare function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse>;
-//#endregion
-//#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$2>>;
-  slug: string;
-}
-interface SkillResponse {
-  runes: Array<Rune$1>;
-  skill: Skill$2;
-}
-interface Rune$1 {
-  description: string;
-  descriptionHtml: string;
-  level: number;
-  name: string;
-  slug: string;
-  type: string;
-}
-interface Skill$2 {
-  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/character-class-and-skill.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
-//#region src/follower/types.d.ts
-interface FollowerResponse {
-  name: string;
-  portrait: string;
-  realName: string;
-  skills: Array<Skill$1>;
-  slug: string;
-}
-interface Skill$1 {
-  description: string;
-  descriptionHtml: string;
-  icon: string;
-  level: number;
-  name: string;
-  slug: string;
-  tooltipUrl: string;
-}
-//#endregion
-//#region src/follower/follower.d.ts
-/**
- * Returns the follower information for the specified follower slug.
- * @param followerSlug The slug of the follower.
- * @returns The follower resource. See {@link FollowerResponse}.
- */
-declare function follower(followerSlug: string): Resource<FollowerResponse>;
-//#endregion
-//#region src/game-data/types.d.ts
-interface EraIndexResponse extends ResponseBase {
-  current_era: number;
-  era: Array<Href>;
-  generated_by: string;
-  last_update_time: string;
-}
-interface EraLeaderboardResponse extends ResponseBase {
-  column: Array<Column>;
-  era: number;
-  generated_by: string;
-  greater_rift: boolean;
-  greater_rift_solo_class: string;
-  key: string;
-  last_update_time: string;
-  row: Array<Row>;
-  title: string;
-}
-interface EraResponse extends ResponseBase {
-  era_id: number;
-  era_start_date: number;
-  generated_by: string;
-  last_update_time: string;
-  leaderboard: Array<EraLeaderboard>;
-}
-interface SeasonIndexResponse extends ResponseBase {
-  current_season: number;
-  generated_by: string;
-  last_update_time: string;
-  season: Array<Href>;
-  service_current_season: number;
-  service_season_state: string;
-}
-interface SeasonLeaderboardResponse extends ResponseBase {
-  achievement_points: boolean;
-  column: Array<Column>;
-  generated_by: string;
-  key: string;
-  last_update_time: string;
-  row: Array<Row>;
-  season: number;
-  title: string;
-}
-interface SeasonResponse extends ResponseBase {
-  generated_by: string;
-  last_update_time: string;
-  leaderboard: Array<Leaderboard>;
-  season_id: number;
-}
-interface Column {
-  hidden: boolean;
-  id: LeaderboardId;
-  label: null | string;
-  order?: number;
-  type: 'DATETIME' | 'NUMBER' | 'STRING';
-}
-interface EraLeaderboard {
-  hardcore?: boolean;
-  hero_class_string?: string;
-  ladder: Self;
-  team_size: number;
-}
-interface Leaderboard {
-  hardcore?: boolean;
-  hero_class_string?: string;
-  ladder: Href;
-  team_size?: number;
-}
-type LeaderboardId = 'AchievementPoints' | 'BattleTag' | 'ClanName' | 'CompletedTime' | 'GameAccount' | 'HeroBattleTag' | 'HeroClanTag' | 'HeroClass' | 'HeroGender' | 'HeroId' | 'HeroLevel' | 'HeroVisualItems' | 'ParagonLevel' | 'Rank' | 'RiftLevel' | 'RiftTime';
-interface Player {
-  accountId: number;
-  data: Array<RowData>;
-  key: string;
-}
-interface Row {
-  data: Array<RowData>;
-  order: number;
-  player: Array<Player>;
-}
-interface RowData {
-  id: LeaderboardId;
-  number?: number;
-  string?: string;
-  timestamp?: number;
-}
-interface Self {
-  href: string;
-}
-//#endregion
-//#region src/game-data/game-data.d.ts
-/**
- * Returns the era information for the specified era ID.
- * @param id The ID of the era.
- * @returns The era resource. See {@link EraResponse}.
- */
-declare function era(id: number): Resource<EraResponse>;
-/**
- * Returns the era index.
- * @returns The era index resource. See {@link EraIndexResponse}.
- */
-declare function eraIndex(): Resource<EraIndexResponse>;
-/**
- * Returns the era leaderboard for the specified era ID and leaderboard.
- * @param id The ID of the era.
- * @param leaderboard The name of the leaderboard.
- * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.
- */
-declare function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse>;
-/**
- * Returns the season information for the specified season ID.
- * @param id The ID of the season.
- * @returns The season resource. See {@link SeasonResponse}.
- */
-declare function season(id: number): Resource<SeasonResponse>;
-/**
- * Returns the season index.
- * @returns The season index resource. See {@link SeasonIndexResponse}.
- */
-declare function seasonIndex(): Resource<SeasonIndexResponse>;
-/**
- * Returns the season leaderboard for the specified season ID and leaderboard.
- * @param id The ID of the season.
- * @param leaderboard The name of the leaderboard.
- * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.
- */
-declare function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse>;
-//#endregion
-//#region src/item-type/types.d.ts
-interface ItemTypeIndexResponse {
-  id: string;
-  name: string;
-  path: string;
-}
-interface ItemTypeResponse {
-  icon: string;
-  id: string;
-  name: string;
-  path: string;
-  slug: string;
-}
-//#endregion
-//#region src/item-type/item-type.d.ts
-/**
- * Returns the item type information for the specified item type slug.
- * @param itemTypeSlug The slug of the item type, example: "sword2h"
- * @returns The item type resource. See {@link ItemTypeResponse}.
- */
-declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
-/**
- * Returns the item type index.
- * @returns The item type index resource. See {@link ItemTypeIndexResponse}.
- */
-declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
-//#endregion
-//#region src/item/types.d.ts
-interface Attributes {
-  other: Array<unknown>;
-  primary: Array<Primary>;
-  secondary: Array<Primary>;
-}
-interface ItemResponse {
-  accountBound: boolean;
-  attributes: Attributes;
-  color: string;
-  damage: string;
-  damageHtml: string;
-  dps: string;
-  flavorText: string;
-  flavorTextHtml: string;
-  icon: string;
-  id: string;
-  isSeasonRequiredToDrop: boolean;
-  name: string;
-  randomAffixes: Array<RandomAffix>;
-  requiredLevel: number;
-  seasonRequiredToDrop: number;
-  setItems: Array<unknown>;
-  slots: Array<string>;
-  slug: string;
-  stackSizeMax: number;
-  tooltipParams: string;
-  type: Type;
-  typeName: string;
-}
-interface Primary {
-  text: string;
-  textHtml: string;
-}
-interface RandomAffix {
-  oneOf: Array<Primary>;
-}
-interface Type {
-  id: string;
-  twoHanded: boolean;
-}
-//#endregion
-//#region src/item/item.d.ts
-/**
- * Returns the item information for the specified item slug and ID.
- * @param itemSlugAndId The slug and ID of the item, example: "corrupted-ashbringer-Unique_Sword_2H_104_x1".
- * @returns The item resource. See {@link ItemResponse}.
- */
-declare function item(itemSlugAndId: string): Resource<ItemResponse>;
-//#endregion
-//#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$1;
-  attributesHtml: Attributes$1;
-  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$1 {
-  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$1;
-  attributesHtml?: Attributes$1;
-  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/profile.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
 //#region src/index.d.ts
 declare const d3: {
   act: typeof act;