@blizzard-api/d3 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,642 @@
+import { Resource } from '@blizzard-api/core';
+
+interface ActResponse {
+    slug: string;
+    number: number;
+    name: string;
+    quests: Array<Quest>;
+}
+interface ActIndexResponse {
+    acts: Array<Act$1>;
+}
+interface Act$1 {
+    slug: string;
+    number: number;
+    name: string;
+    quests: Array<Quest>;
+}
+interface Quest {
+    id: number;
+    name: string;
+    slug: string;
+}
+
+declare function act(actId: number): Resource<ActResponse>;
+declare function actIndex(): Resource<ActIndexResponse>;
+
+interface ArtisanResponse {
+    slug: string;
+    name: string;
+    portrait: string;
+    training: Training;
+}
+interface Training {
+    tiers: Array<Tier>;
+}
+interface Tier {
+    tier: number;
+    trainedRecipes: Array<Recipe>;
+    taughtRecipes: Array<Recipe>;
+}
+interface Recipe {
+    id: string;
+    slug: string;
+    name: string;
+    cost: number;
+    reagents: Array<Reagent$1>;
+    itemProduced: Item$1;
+}
+interface Item$1 {
+    id: string;
+    slug: string;
+    name: string;
+    icon: string;
+    path: string;
+}
+interface Reagent$1 {
+    quantity: number;
+    item: Item$1;
+}
+interface RecipeResponse {
+    id: string;
+    slug: string;
+    name: string;
+    cost: number;
+    reagents: Array<Reagent$1>;
+    itemProduced: Item$1;
+}
+
+declare function artisan(artisanSlug: string): Resource<ArtisanResponse>;
+declare function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse>;
+
+interface CharacterClassResponse {
+    slug: string;
+    name: string;
+    maleName: string;
+    femaleName: string;
+    icon: string;
+    skillCategories: Array<SkillCategory>;
+    skills: Record<'active' | 'passive', Array<Skill$2>>;
+}
+interface SkillCategory {
+    slug: string;
+    name: string;
+}
+interface Skill$2 {
+    slug: string;
+    name: string;
+    icon: string;
+    level: number;
+    tooltipUrl: string;
+    description: string;
+    descriptionHtml: string;
+    flavorText?: string;
+}
+interface SkillResponse {
+    skill: Skill$2;
+    runes: Array<Rune$1>;
+}
+interface Rune$1 {
+    slug: string;
+    type: string;
+    name: string;
+    level: number;
+    description: string;
+    descriptionHtml: string;
+}
+
+declare function characterClass(characterClassSlug: string): Resource<CharacterClassResponse>;
+declare function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse>;
+
+interface FollowerResponse {
+    slug: string;
+    name: string;
+    realName: string;
+    portrait: string;
+    skills: Array<Skill$1>;
+}
+interface Skill$1 {
+    slug: string;
+    name: string;
+    icon: string;
+    level: number;
+    tooltipUrl: string;
+    description: string;
+    descriptionHtml: string;
+}
+
+declare function follower(followerSlug: string): Resource<FollowerResponse>;
+
+/**
+ * Base interface for Blizzard API responses.
+ */
+interface ResponseBase {
+    _links: {
+        self: {
+            href: string;
+        };
+    };
+}
+
+interface SeasonIndexResponse extends ResponseBase {
+    season: Array<{
+        href: string;
+    }>;
+    current_season: number;
+    service_current_season: number;
+    service_season_state: string;
+    last_update_time: string;
+    generated_by: string;
+}
+interface SeasonResponse extends ResponseBase {
+    leaderboard: Array<Leaderboard>;
+    season_id: number;
+    last_update_time: string;
+    generated_by: string;
+}
+interface Leaderboard {
+    ladder: {
+        href: string;
+    };
+    team_size?: number;
+    hardcore?: boolean;
+    hero_class_string?: string;
+}
+interface SeasonLeaderboardResponse extends ResponseBase {
+    row: Array<Row>;
+    key: string;
+    title: string;
+    column: Array<Column>;
+    last_update_time: string;
+    generated_by: string;
+    achievement_points: boolean;
+    season: number;
+}
+interface Column {
+    id: LeaderboardId;
+    hidden: boolean;
+    order?: number;
+    label: null | string;
+    type: 'DATETIME' | 'NUMBER' | 'STRING';
+}
+type LeaderboardId = 'AchievementPoints' | 'BattleTag' | 'ClanName' | 'CompletedTime' | 'GameAccount' | 'HeroBattleTag' | 'HeroClanTag' | 'HeroClass' | 'HeroGender' | 'HeroId' | 'HeroLevel' | 'HeroVisualItems' | 'ParagonLevel' | 'Rank' | 'RiftLevel' | 'RiftTime';
+interface Row {
+    player: Array<Player>;
+    order: number;
+    data: Array<RowData>;
+}
+interface RowData {
+    id: LeaderboardId;
+    number?: number;
+    timestamp?: number;
+    string?: string;
+}
+interface Player {
+    key: string;
+    accountId: number;
+    data: Array<RowData>;
+}
+interface EraIndexResponse extends ResponseBase {
+    era: Array<{
+        href: string;
+    }>;
+    current_era: number;
+    last_update_time: string;
+    generated_by: string;
+}
+interface EraResponse extends ResponseBase {
+    leaderboard: Array<EraLeaderboard>;
+    era_id: number;
+    era_start_date: number;
+    last_update_time: string;
+    generated_by: string;
+}
+interface Self {
+    href: string;
+}
+interface EraLeaderboard {
+    team_size: number;
+    ladder: Self;
+    hardcore?: boolean;
+    hero_class_string?: string;
+}
+interface EraLeaderboardResponse extends ResponseBase {
+    row: Array<Row>;
+    key: string;
+    title: string;
+    column: Array<Column>;
+    last_update_time: string;
+    generated_by: string;
+    greater_rift: boolean;
+    greater_rift_solo_class: string;
+    era: number;
+}
+
+declare function seasonIndex(): Resource<SeasonIndexResponse>;
+declare function season(id: number): Resource<SeasonResponse>;
+declare function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse>;
+declare function eraIndex(): Resource<EraIndexResponse>;
+declare function era(id: number): Resource<EraResponse>;
+declare function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse>;
+
+interface ItemResponse {
+    id: string;
+    slug: string;
+    name: string;
+    icon: string;
+    tooltipParams: string;
+    requiredLevel: number;
+    stackSizeMax: number;
+    accountBound: boolean;
+    flavorText: string;
+    flavorTextHtml: string;
+    typeName: string;
+    type: Type;
+    damage: string;
+    dps: string;
+    damageHtml: string;
+    color: string;
+    isSeasonRequiredToDrop: boolean;
+    seasonRequiredToDrop: number;
+    slots: Array<string>;
+    attributes: Attributes$1;
+    randomAffixes: Array<RandomAffix>;
+    setItems: Array<unknown>;
+}
+interface Attributes$1 {
+    primary: Array<Primary>;
+    secondary: Array<Primary>;
+    other: Array<unknown>;
+}
+interface Primary {
+    textHtml: string;
+    text: string;
+}
+interface RandomAffix {
+    oneOf: Array<Primary>;
+}
+interface Type {
+    twoHanded: boolean;
+    id: string;
+}
+
+declare function item(itemSlugAndId: string): Resource<ItemResponse>;
+
+interface ItemTypeIndexResponse {
+    id: string;
+    name: string;
+    path: string;
+}
+interface ItemTypeResponse {
+    id: string;
+    slug: string;
+    name: string;
+    icon: string;
+    path: string;
+}
+
+declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
+declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
+
+interface AccountResponse {
+    battleTag: string;
+    paragonLevel: number;
+    paragonLevelHardcore: number;
+    paragonLevelSeason: number;
+    paragonLevelSeasonHardcore: number;
+    guildName: string;
+    heroes: Array<Hero>;
+    lastHeroPlayed: number;
+    lastUpdated: number;
+    kills: AccountResponseKills;
+    highestHardcoreLevel: number;
+    timePlayed: TimePlayed;
+    progression: Progression;
+    seasonalProfiles: Record<`season${number}`, Season>;
+    blacksmithSeason: Artisan;
+    blacksmithHardcore: Artisan;
+    jewelerSeason: Artisan;
+    mysticSeason: Artisan;
+    jewelerHardcore: Artisan;
+    mysticHardcore: Artisan;
+    blacksmithSeasonHardcore: Artisan;
+    jewelerSeasonHardcore: Artisan;
+    mysticSeasonHardcore: Artisan;
+    blacksmith: Artisan;
+    jeweler: Artisan;
+    mystic: Artisan;
+}
+interface Artisan {
+    slug: 'blacksmith' | 'jeweler' | 'mystic';
+    level: number;
+}
+interface Hero {
+    id: number;
+    name: string;
+    class: string;
+    classSlug: string;
+    gender: number;
+    level: number;
+    kills: HeroKills;
+    paragonLevel: number;
+    hardcore: boolean;
+    seasonal: boolean;
+    dead: boolean;
+    'last-updated': number;
+}
+interface HeroKills {
+    elites: number;
+}
+interface AccountResponseKills {
+    monsters: number;
+    elites: number;
+    hardcoreMonsters: number;
+}
+interface Progression {
+    act1: boolean;
+    act3: boolean;
+    act2: boolean;
+    act5: boolean;
+    act4: boolean;
+}
+interface Season {
+    seasonId: number;
+    paragonLevel: number;
+    paragonLevelHardcore: number;
+    kills: AccountResponseKills;
+    timePlayed: TimePlayed;
+    highestHardcoreLevel: number;
+}
+interface TimePlayed {
+    'demon-hunter': number;
+    barbarian: number;
+    'witch-doctor': number;
+    necromancer: number;
+    wizard: number;
+    monk: number;
+    crusader: number;
+}
+interface AccountHeroResponse {
+    id: number;
+    name: string;
+    class: string;
+    gender: number;
+    level: number;
+    paragonLevel: number;
+    kills: Kills;
+    hardcore: boolean;
+    seasonal: boolean;
+    seasonCreated: number;
+    skills: Skills;
+    items: Record<string, Item>;
+    followers: Followers;
+    legendaryPowers: Array<Item>;
+    progression: HeroProgression;
+    alive: boolean;
+    lastUpdated: number;
+    highestSoloRiftCompleted: number;
+    stats: Record<string, number>;
+}
+interface Followers {
+    templar: Templar;
+    scoundrel: Scoundrel;
+    enchantress: Enchantress;
+}
+interface Enchantress {
+    slug: string;
+    level: number;
+    items: EnchantressItems;
+    stats: Stats;
+    skills: Array<unknown>;
+}
+interface EnchantressItems {
+    mainHand: Item;
+}
+interface Item {
+    id: string;
+    name: string;
+    icon: string;
+    displayColor?: DisplayColor;
+    tooltipParams: string;
+    dyeColor?: Item;
+}
+interface Stats {
+    goldFind: number;
+    magicFind: number;
+    experienceBonus: number;
+}
+interface Scoundrel {
+    slug: string;
+    level: number;
+    items: Record<string, Item>;
+    stats: Stats;
+    skills: Array<Skill>;
+}
+interface Skill {
+    slug: string;
+    name: string;
+    icon: string;
+    level: number;
+    tooltipUrl: string;
+    description: string;
+    descriptionHtml: string;
+    flavorText?: string;
+}
+interface Templar {
+    slug: string;
+    level: number;
+    items: TemplarItems;
+    stats: Stats;
+    skills: Array<Skill>;
+}
+interface TemplarItems {
+    head: Item;
+    torso: Item;
+    shoulders: Item;
+    waist: Item;
+    hands: Item;
+    bracers: Item;
+    feet: Item;
+    mainHand: Item;
+    offHand: Item;
+}
+interface Kills {
+    elites: number;
+}
+interface HeroProgression {
+    act1: Act;
+    act2: Act;
+    act3: Act;
+    act4: Act;
+    act5: Act;
+}
+interface Act {
+    completed: boolean;
+    completedQuests: Array<CompletedQuest>;
+}
+interface CompletedQuest {
+    slug: string;
+    name: string;
+}
+interface Skills {
+    active: Array<Active>;
+    passive: Array<Passive>;
+}
+interface Active {
+    skill: Skill;
+    rune: Rune;
+}
+interface Rune {
+    slug: string;
+    type: string;
+    name: string;
+    level: number;
+    description: string;
+    descriptionHtml: string;
+}
+interface Passive {
+    skill: Skill;
+}
+type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
+interface AccountHeroItemsResponse {
+    id: string;
+    name: string;
+    icon: string;
+    displayColor: DisplayColor;
+    tooltipParams: string;
+    requiredLevel: number;
+    itemLevel: number;
+    stackSizeMax: number;
+    accountBound: boolean;
+    flavorText: string;
+    typeName: string;
+    type: Record<string, boolean | string>;
+    armor: number;
+    attacksPerSecond: number;
+    minDamage: number;
+    maxDamage: number;
+    elementalType?: string;
+    slots: string;
+    attributes: Attributes;
+    attributesHtml: Attributes;
+    openSockets: number;
+    seasonRequiredToDrop: number;
+    isSeasonRequiredToDrop: boolean;
+    set?: Set;
+    gems?: Array<Gem>;
+    craftedBy?: CraftedBy;
+    damage?: string;
+    dps?: string;
+}
+interface Attributes {
+    primary: Array<string>;
+    secondary?: Array<string>;
+}
+interface CraftedBy {
+    id: string;
+    slug: string;
+    name: string;
+    cost: number;
+    reagents: Array<Reagent>;
+    itemProduced: ItemProduced;
+}
+interface ItemProduced {
+    id: string;
+    path: string;
+}
+interface Reagent {
+    quantity: number;
+    item: AccountHeroItem;
+}
+interface AccountHeroItem {
+    id: string;
+    slug: string;
+    name: string;
+    icon: string;
+    path: string;
+}
+interface Gem {
+    item: AccountHeroItem;
+    attributes: Array<string>;
+    isGem: boolean;
+    isJewel: boolean;
+    jewelRank?: number;
+    jewelSecondaryUnlockRank?: number;
+}
+interface Set {
+    name: string;
+    slug: string;
+    description: string;
+    descriptionHtml: string;
+}
+interface AccountHeroFollowerItemsResponse {
+    templar: Record<string, FollowerItem>;
+    scoundrel: Record<string, FollowerItem>;
+    enchantress: Record<string, FollowerItem>;
+}
+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 Dye {
+    id: string;
+    name: string;
+    icon: string;
+    tooltipParams: string;
+}
+
+declare function account(battleTag: string): Resource<AccountResponse>;
+declare function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
+declare function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
+declare function accountHeroFollowerItems(battleTag: string, heroId: number): Resource<AccountHeroFollowerItemsResponse>;
+
+declare const d3: {
+    act: typeof act;
+    actIndex: typeof actIndex;
+    artisan: typeof artisan;
+    recipe: typeof recipe;
+    follower: typeof follower;
+    characterClass: typeof characterClass;
+    skill: typeof skill;
+    itemType: typeof itemType;
+    itemTypeIndex: typeof itemTypeIndex;
+    item: typeof item;
+    account: typeof account;
+    accountHero: typeof accountHero;
+    accountHeroItems: typeof accountHeroItems;
+    accountHeroFollowerItems: typeof accountHeroFollowerItems;
+    seasonIndex: typeof seasonIndex;
+    season: typeof season;
+    seasonLeaderboard: typeof seasonLeaderboard;
+    eraIndex: typeof eraIndex;
+    era: typeof era;
+    eraLeaderboard: typeof eraLeaderboard;
+};
+
+export { type AccountHeroFollowerItemsResponse, type AccountHeroItemsResponse, type AccountHeroResponse, type AccountResponse, type ActIndexResponse, type ActResponse, type ArtisanResponse, type Attributes$1 as Attributes, type CharacterClassResponse, type EraIndexResponse, type EraLeaderboardResponse, type EraResponse, type FollowerResponse, type ItemResponse, type ItemTypeIndexResponse, type ItemTypeResponse, type Primary, type RandomAffix, type RecipeResponse, type SeasonIndexResponse, type SeasonLeaderboardResponse, type SeasonResponse, type SkillResponse, type Type, account, accountHero, accountHeroFollowerItems, accountHeroItems, act, actIndex, artisan, characterClass, d3, era, eraIndex, eraLeaderboard, follower, item, itemType, itemTypeIndex, recipe, season, seasonIndex, seasonLeaderboard, skill };