@blizzard-api/d3 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import { Resource } from '@blizzard-api/core';
 
+interface ActIndexResponse {
+    acts: Array<Act$1>;
+}
 interface ActResponse {
     name: string;
     number: number;
     quests: Array<Quest>;
     slug: string;
 }
-interface ActIndexResponse {
-    acts: Array<Act$1>;
-}
 interface Act$1 {
     name: string;
     number: number;
@@ -21,7 +21,16 @@ interface Quest {
     slug: string;
 }
 
+/**
+ * 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>;
 
 interface ArtisanResponse {
@@ -30,15 +39,7 @@ interface ArtisanResponse {
     slug: string;
     training: Training;
 }
-interface Training {
-    tiers: Array<Tier>;
-}
-interface Tier {
-    taughtRecipes: Array<Recipe>;
-    tier: number;
-    trainedRecipes: Array<Recipe>;
-}
-interface Recipe {
+interface RecipeResponse {
     cost: number;
     id: string;
     itemProduced: Item$1;
@@ -57,7 +58,7 @@ interface Reagent$1 {
     item: Item$1;
     quantity: number;
 }
-interface RecipeResponse {
+interface Recipe {
     cost: number;
     id: string;
     itemProduced: Item$1;
@@ -65,8 +66,27 @@ interface RecipeResponse {
     reagents: Array<Reagent$1>;
     slug: string;
 }
+interface Tier {
+    taughtRecipes: Array<Recipe>;
+    tier: number;
+    trainedRecipes: Array<Recipe>;
+}
+interface Training {
+    tiers: Array<Tier>;
+}
 
+/**
+ * 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>;
 
 interface CharacterClassResponse {
@@ -78,9 +98,17 @@ interface CharacterClassResponse {
     skills: Record<'active' | 'passive', Array<Skill$2>>;
     slug: string;
 }
-interface SkillCategory {
+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;
@@ -92,20 +120,23 @@ interface Skill$2 {
     slug: string;
     tooltipUrl: string;
 }
-interface SkillResponse {
-    runes: Array<Rune$1>;
-    skill: Skill$2;
-}
-interface Rune$1 {
-    description: string;
-    descriptionHtml: string;
-    level: number;
+interface SkillCategory {
     name: string;
     slug: string;
-    type: string;
 }
 
+/**
+ * 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>;
 
 interface FollowerResponse {
@@ -125,6 +156,11 @@ interface Skill$1 {
     tooltipUrl: string;
 }
 
+/**
+ * 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>;
 
 /**
@@ -138,6 +174,32 @@ interface ResponseBase {
     };
 }
 
+interface EraIndexResponse extends ResponseBase {
+    current_era: number;
+    era: Array<{
+        href: string;
+    }>;
+    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;
@@ -148,20 +210,6 @@ interface SeasonIndexResponse extends ResponseBase {
     service_current_season: number;
     service_season_state: string;
 }
-interface SeasonResponse extends ResponseBase {
-    generated_by: string;
-    last_update_time: string;
-    leaderboard: Array<Leaderboard>;
-    season_id: number;
-}
-interface Leaderboard {
-    hardcore?: boolean;
-    hero_class_string?: string;
-    ladder: {
-        href: string;
-    };
-    team_size?: number;
-}
 interface SeasonLeaderboardResponse extends ResponseBase {
     achievement_points: boolean;
     column: Array<Column>;
@@ -172,6 +220,12 @@ interface SeasonLeaderboardResponse extends ResponseBase {
     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;
@@ -179,7 +233,26 @@ interface Column {
     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: string;
+    };
+    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;
@@ -191,54 +264,77 @@ interface RowData {
     string?: string;
     timestamp?: number;
 }
-interface Player {
-    accountId: number;
-    data: Array<RowData>;
-    key: string;
-}
-interface EraIndexResponse extends ResponseBase {
-    current_era: number;
-    era: Array<{
-        href: string;
-    }>;
-    generated_by: string;
-    last_update_time: string;
-}
-interface EraResponse extends ResponseBase {
-    era_id: number;
-    era_start_date: number;
-    generated_by: string;
-    last_update_time: string;
-    leaderboard: Array<EraLeaderboard>;
-}
 interface Self {
     href: string;
 }
-interface EraLeaderboard {
-    hardcore?: boolean;
-    hero_class_string?: string;
-    ladder: Self;
-    team_size: number;
-}
-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;
-}
 
-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>;
+/**
+ * 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>;
+
+interface ItemTypeIndexResponse {
+    id: string;
+    name: string;
+    path: string;
+}
+interface ItemTypeResponse {
+    icon: string;
+    id: string;
+    name: string;
+    path: string;
+    slug: string;
+}
+
+/**
+ * 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>>;
 
+interface Attributes$1 {
+    other: Array<unknown>;
+    primary: Array<Primary>;
+    secondary: Array<Primary>;
+}
 interface ItemResponse {
     accountBound: boolean;
     attributes: Attributes$1;
@@ -263,11 +359,6 @@ interface ItemResponse {
     type: Type;
     typeName: string;
 }
-interface Attributes$1 {
-    other: Array<unknown>;
-    primary: Array<Primary>;
-    secondary: Array<Primary>;
-}
 interface Primary {
     text: string;
     textHtml: string;
@@ -280,25 +371,70 @@ interface Type {
     twoHanded: boolean;
 }
 
+/**
+ * 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>;
 
-interface ItemTypeIndexResponse {
-    id: string;
-    name: string;
-    path: string;
+interface AccountHeroFollowerItemsResponse {
+    enchantress: Record<string, FollowerItem>;
+    scoundrel: Record<string, FollowerItem>;
+    templar: Record<string, FollowerItem>;
 }
-interface ItemTypeResponse {
+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;
-    path: string;
-    slug: string;
+    openSockets: number;
+    requiredLevel: number;
+    seasonRequiredToDrop: number;
+    set?: Set;
+    slots: string;
+    stackSizeMax: number;
+    tooltipParams: string;
+    type: Record<string, boolean | string>;
+    typeName: string;
 }
-
-declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
-declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
-
-interface AccountResponse {
+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;
@@ -326,191 +462,76 @@ interface AccountResponse {
     seasonalProfiles: Record<`season${number}`, Season>;
     timePlayed: TimePlayed;
 }
-interface Artisan {
-    level: number;
-    slug: 'blacksmith' | 'jeweler' | 'mystic';
-}
-interface Hero {
-    class: string;
-    classSlug: string;
-    dead: boolean;
-    gender: number;
-    hardcore: boolean;
-    id: number;
-    kills: HeroKills;
-    'last-updated': number;
-    level: number;
+interface AccountHeroItem {
+    icon: string;
+    id: string;
     name: string;
-    paragonLevel: number;
-    seasonal: boolean;
-}
-interface HeroKills {
-    elites: number;
+    path: string;
+    slug: string;
 }
 interface AccountResponseKills {
     elites: number;
     hardcoreMonsters: number;
     monsters: number;
 }
-interface Progression {
-    act1: boolean;
-    act2: boolean;
-    act3: boolean;
-    act4: boolean;
-    act5: boolean;
-}
-interface Season {
-    highestHardcoreLevel: number;
-    kills: AccountResponseKills;
-    paragonLevel: number;
-    paragonLevelHardcore: number;
-    seasonId: number;
-    timePlayed: TimePlayed;
+interface Act {
+    completed: boolean;
+    completedQuests: Array<CompletedQuest>;
 }
-interface TimePlayed {
-    barbarian: number;
-    crusader: number;
-    'demon-hunter': number;
-    monk: number;
-    necromancer: number;
-    'witch-doctor': number;
-    wizard: number;
+interface Active {
+    rune: Rune;
+    skill: Skill;
 }
-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>;
+interface Artisan {
     level: number;
-    name: string;
-    paragonLevel: number;
-    progression: HeroProgression;
-    seasonal: boolean;
-    seasonCreated: number;
-    skills: Skills;
-    stats: Record<string, number>;
+    slug: 'blacksmith' | 'jeweler' | 'mystic';
 }
-interface Followers {
-    enchantress: Enchantress;
-    scoundrel: Scoundrel;
-    templar: Templar;
+interface Attributes {
+    primary: Array<string>;
+    secondary?: Array<string>;
 }
-interface Enchantress {
-    items: EnchantressItems;
-    level: number;
-    skills: Array<unknown>;
+interface CompletedQuest {
+    name: string;
     slug: string;
-    stats: Stats;
 }
-interface EnchantressItems {
-    mainHand: Item;
-}
-interface Item {
-    displayColor?: DisplayColor;
-    dyeColor?: Item;
-    icon: string;
+interface CraftedBy {
+    cost: number;
     id: string;
+    itemProduced: ItemProduced;
     name: string;
-    tooltipParams: string;
-}
-interface Stats {
-    experienceBonus: number;
-    goldFind: number;
-    magicFind: number;
-}
-interface Scoundrel {
-    items: Record<string, Item>;
-    level: number;
-    skills: Array<Skill>;
+    reagents: Array<Reagent>;
     slug: string;
-    stats: Stats;
 }
-interface Skill {
-    description: string;
-    descriptionHtml: string;
-    flavorText?: string;
+type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
+interface Dye {
     icon: string;
-    level: number;
+    id: string;
     name: string;
-    slug: string;
-    tooltipUrl: string;
+    tooltipParams: string;
 }
-interface Templar {
-    items: TemplarItems;
+interface Enchantress {
+    items: EnchantressItems;
     level: number;
-    skills: Array<Skill>;
+    skills: Array<unknown>;
     slug: string;
     stats: Stats;
 }
-interface TemplarItems {
-    bracers: Item;
-    feet: Item;
-    hands: Item;
-    head: Item;
+interface EnchantressItems {
     mainHand: Item;
-    offHand: Item;
-    shoulders: Item;
-    torso: Item;
-    waist: 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 {
-    name: string;
-    slug: string;
-}
-interface Skills {
-    active: Array<Active>;
-    passive: Array<Passive>;
-}
-interface Active {
-    rune: Rune;
-    skill: Skill;
-}
-interface Rune {
-    description: string;
-    descriptionHtml: string;
-    level: number;
-    name: string;
-    slug: string;
-    type: string;
-}
-interface Passive {
-    skill: Skill;
 }
-type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
-interface AccountHeroItemsResponse {
+interface FollowerItem {
     accountBound: boolean;
     armor: number;
     attacksPerSecond: number;
-    attributes: Attributes;
-    attributesHtml: Attributes;
+    attributes?: Attributes;
+    attributesHtml?: Attributes;
+    blockChance?: string;
     craftedBy?: CraftedBy;
     damage?: string;
-    displayColor: DisplayColor;
+    displayColor: string;
     dps?: string;
-    elementalType?: string;
-    flavorText: string;
-    gems?: Array<Gem>;
+    dye?: Dye;
+    flavorText?: string;
     icon: string;
     id: string;
     isSeasonRequiredToDrop: boolean;
@@ -528,40 +549,94 @@ interface AccountHeroItemsResponse {
     type: Record<string, boolean | string>;
     typeName: string;
 }
-interface Attributes {
-    primary: Array<string>;
-    secondary?: Array<string>;
+interface Followers {
+    enchantress: Enchantress;
+    scoundrel: Scoundrel;
+    templar: Templar;
 }
-interface CraftedBy {
-    cost: number;
+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?: Item;
+    icon: string;
     id: string;
-    itemProduced: ItemProduced;
     name: string;
-    reagents: Array<Reagent>;
-    slug: 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 AccountHeroItem {
-    icon: string;
-    id: string;
+interface Rune {
+    description: string;
+    descriptionHtml: string;
+    level: number;
     name: string;
-    path: string;
     slug: string;
+    type: string;
 }
-interface Gem {
-    attributes: Array<string>;
-    isGem: boolean;
-    isJewel: boolean;
-    item: AccountHeroItem;
-    jewelRank?: number;
-    jewelSecondaryUnlockRank?: number;
+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;
@@ -569,52 +644,80 @@ interface Set {
     name: string;
     slug: string;
 }
-interface AccountHeroFollowerItemsResponse {
-    enchantress: Record<string, FollowerItem>;
-    scoundrel: Record<string, FollowerItem>;
-    templar: 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;
+interface Skill {
+    description: string;
+    descriptionHtml: string;
     flavorText?: string;
     icon: string;
-    id: string;
-    isSeasonRequiredToDrop: boolean;
-    itemLevel: number;
-    maxDamage: number;
-    minDamage: number;
+    level: number;
     name: string;
-    openSockets: number;
-    requiredLevel: number;
-    seasonRequiredToDrop: number;
-    set?: Set;
-    slots: string;
-    stackSizeMax: number;
-    tooltipParams: string;
-    type: Record<string, boolean | string>;
-    typeName: string;
+    slug: string;
+    tooltipUrl: string;
 }
-interface Dye {
-    icon: string;
-    id: string;
-    name: string;
-    tooltipParams: 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;
 }
 
+/**
+ * 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>;
-declare function accountHeroItems(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>;
 
 declare const d3: {
     act: typeof act;

package/dist/index.js

@@ -47,53 +47,53 @@ function follower(followerSlug) {
 }
 
 // src/game-data/game-data.ts
-function seasonIndex() {
+function era(id) {
   return {
-    path: `${gameDataBase}/season`
+    path: `${gameDataBase}/era/${id}`
   };
 }
-function season(id) {
+function eraIndex() {
   return {
-    path: `${gameDataBase}/season/${id}`
+    path: `${gameDataBase}/era`
   };
 }
-function seasonLeaderboard(id, leaderboard) {
+function eraLeaderboard(id, leaderboard) {
   return {
-    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`
+    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`
   };
 }
-function eraIndex() {
+function season(id) {
   return {
-    path: `${gameDataBase}/era`
+    path: `${gameDataBase}/season/${id}`
   };
 }
-function era(id) {
+function seasonIndex() {
   return {
-    path: `${gameDataBase}/era/${id}`
+    path: `${gameDataBase}/season`
   };
 }
-function eraLeaderboard(id, leaderboard) {
+function seasonLeaderboard(id, leaderboard) {
   return {
-    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`
+    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`
   };
 }
 
-// src/item/item.ts
-function item(itemSlugAndId) {
+// src/item-type/item-type.ts
+function itemType(itemTypeSlug) {
   return {
-    path: `${base}/item/${itemSlugAndId}`
+    path: `${base}/item-type/${itemTypeSlug}`
   };
 }
-
-// src/item-type/item-type.ts
 function itemTypeIndex() {
   return {
     path: `${base}/item-type`
   };
 }
-function itemType(itemTypeSlug) {
+
+// src/item/item.ts
+function item(itemSlugAndId) {
   return {
-    path: `${base}/item-type/${itemTypeSlug}`
+    path: `${base}/item/${itemSlugAndId}`
   };
 }
 
@@ -108,14 +108,14 @@ function accountHero(battleTag, heroId) {
     path: `${profileBase}/${battleTag}/hero/${heroId}`
   };
 }
-function accountHeroItems(battleTag, heroId) {
+function accountHeroFollowerItems(battleTag, heroId) {
   return {
-    path: `${profileBase}/${battleTag}/hero/${heroId}/items`
+    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`
   };
 }
-function accountHeroFollowerItems(battleTag, heroId) {
+function accountHeroItems(battleTag, heroId) {
   return {
-    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`
+    path: `${profileBase}/${battleTag}/hero/${heroId}/items`
   };
 }
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item/item.ts","../src/item-type/item-type.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,IAAO,GAAA,SAAA,CAAA;AAEb,IAAM,WAAc,GAAA,CAAA,UAAA,CAAA,CAAA;AAGpB,IAAM,YAAe,GAAA,CAAA,OAAA,CAAA,CAAA;;;ACDrB,SAAS,IAAI,KAAsC,EAAA;AACxD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAA,CAAA;AAAA,GAC5B,CAAA;AACF,CAAA;AAEO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,IAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACVO,SAAS,QAAQ,WAAgD,EAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,SAAA,EAAY,WAAW,CAAA,CAAA;AAAA,GACtC,CAAA;AACF,CAAA;AAEO,SAAS,MAAA,CAAO,aAAqB,UAA8C,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAY,SAAA,EAAA,WAAW,WAAW,UAAU,CAAA,CAAA;AAAA,GAC3D,CAAA;AACF,CAAA;;;ACVO,SAAS,eAAe,kBAA8D,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,iBAAA,EAAoB,kBAAkB,CAAA,CAAA;AAAA,GACrD,CAAA;AACF,CAAA;AAEO,SAAS,KAAA,CAAM,oBAA4B,SAA4C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAS,MAAA,EAAA,kBAAkB,UAAU,SAAS,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;ACVO,SAAS,SAAS,YAAkD,EAAA;AACzE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,UAAA,EAAa,YAAY,CAAA,CAAA;AAAA,GACxC,CAAA;AACF,CAAA;;;ACGO,SAAS,WAA6C,GAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,OAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAEO,SAAS,OAAO,EAAsC,EAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,QAAA,EAAW,EAAE,CAAA,CAAA;AAAA,GACpC,CAAA;AACF,CAAA;AAEO,SAAS,iBAAA,CAAkB,IAAY,WAA0D,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAW,QAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC/D,CAAA;AACF,CAAA;AAEO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,IAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAEO,SAAS,IAAI,EAAmC,EAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,KAAA,EAAQ,EAAE,CAAA,CAAA;AAAA,GACjC,CAAA;AACF,CAAA;AAEO,SAAS,cAAA,CAAe,IAAY,WAAuD,EAAA;AAChG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAQ,KAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;;;ACzCO,SAAS,KAAK,aAA+C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,MAAA,EAAS,aAAa,CAAA,CAAA;AAAA,GACrC,CAAA;AACF,CAAA;;;ACJO,SAAS,aAAwD,GAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,UAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;AAEO,SAAS,SAAS,YAAyD,EAAA;AAChF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,WAAA,EAAc,YAAY,CAAA,CAAA;AAAA,GACzC,CAAA;AACF,CAAA;;;ACVO,SAAS,QAAQ,SAA8C,EAAA;AACpE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA;AAAA,GACnC,CAAA;AACF,CAAA;AAEO,SAAS,WAAA,CAAY,WAAmB,MAA+C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAEO,SAAS,gBAAA,CAAiB,WAAmB,MAA+C,EAAA;AACjG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,MAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAEO,SAAS,wBAAA,CACd,WACA,MAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,eAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;;;ACpBA,IAAM,EAAK,GAAA;AAAA;AAAA,EAET,GAAA;AAAA,EACA,QAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,QAAA;AAAA;AAAA,EAEA,cAAA;AAAA,EACA,KAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,IAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,wBAAA;AAAA,EACA,gBAAA;AAAA;AAAA,EAEA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,cAAA;AAAA,EACA,MAAA;AAAA,EACA,WAAA;AAAA,EACA,iBAAA;AACF","file":"index.js","sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\r\n\r\n/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { item } from './item/item';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport { d3 as default, d3 };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"]}
+{"version":3,"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item-type/item-type.ts","../src/item/item.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,IAAO,GAAA,SAAA,CAAA;AAEb,IAAM,WAAc,GAAA,CAAA,UAAA,CAAA,CAAA;AAGpB,IAAM,YAAe,GAAA,CAAA,OAAA,CAAA,CAAA;;;ACIrB,SAAS,IAAI,KAAsC,EAAA;AACxD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAA,CAAA;AAAA,GAC5B,CAAA;AACF,CAAA;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,IAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACdO,SAAS,QAAQ,WAAgD,EAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,SAAA,EAAY,WAAW,CAAA,CAAA;AAAA,GACtC,CAAA;AACF,CAAA;AAQO,SAAS,MAAA,CAAO,aAAqB,UAA8C,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAY,SAAA,EAAA,WAAW,WAAW,UAAU,CAAA,CAAA;AAAA,GAC3D,CAAA;AACF,CAAA;;;AChBO,SAAS,eAAe,kBAA8D,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,iBAAA,EAAoB,kBAAkB,CAAA,CAAA;AAAA,GACrD,CAAA;AACF,CAAA;AAQO,SAAS,KAAA,CAAM,oBAA4B,SAA4C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAS,MAAA,EAAA,kBAAkB,UAAU,SAAS,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;AChBO,SAAS,SAAS,YAAkD,EAAA;AACzE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,UAAA,EAAa,YAAY,CAAA,CAAA;AAAA,GACxC,CAAA;AACF,CAAA;;;ACGO,SAAS,IAAI,EAAmC,EAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,KAAA,EAAQ,EAAE,CAAA,CAAA;AAAA,GACjC,CAAA;AACF,CAAA;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,IAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAQO,SAAS,cAAA,CAAe,IAAY,WAAuD,EAAA;AAChG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAQ,KAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;AAOO,SAAS,OAAO,EAAsC,EAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,QAAA,EAAW,EAAE,CAAA,CAAA;AAAA,GACpC,CAAA;AACF,CAAA;AAMO,SAAS,WAA6C,GAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,OAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAQO,SAAS,iBAAA,CAAkB,IAAY,WAA0D,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAW,QAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC/D,CAAA;AACF,CAAA;;;AClEO,SAAS,SAAS,YAAyD,EAAA;AAChF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,WAAA,EAAc,YAAY,CAAA,CAAA;AAAA,GACzC,CAAA;AACF,CAAA;AAMO,SAAS,aAAwD,GAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,UAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACdO,SAAS,KAAK,aAA+C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,MAAA,EAAS,aAAa,CAAA,CAAA;AAAA,GACrC,CAAA;AACF,CAAA;;;ACJO,SAAS,QAAQ,SAA8C,EAAA;AACpE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA;AAAA,GACnC,CAAA;AACF,CAAA;AAQO,SAAS,WAAA,CAAY,WAAmB,MAA+C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAQO,SAAS,wBAAA,CACd,WACA,MAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,eAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAQO,SAAS,gBAAA,CAAiB,WAAmB,MAA+C,EAAA;AACjG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,MAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;;;AC3CA,IAAM,EAAK,GAAA;AAAA;AAAA,EAET,GAAA;AAAA,EACA,QAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,QAAA;AAAA;AAAA,EAEA,cAAA;AAAA,EACA,KAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,IAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,wBAAA;AAAA,EACA,gBAAA;AAAA;AAAA,EAEA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,cAAA;AAAA,EACA,MAAA;AAAA,EACA,WAAA;AAAA,EACA,iBAAA;AACF","file":"index.js","sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\r\n\r\n/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\n/**\r\n * Returns the act information for the specified act ID.\r\n * @param actId The ID of the act.\r\n * @returns The act resource. See {@link ActResponse}.\r\n */\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the index of acts.\r\n * @returns The act index resource. See {@link ActIndexResponse}.\r\n */\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\n/**\r\n * Returns the artisan information for the specified artisan slug.\r\n * @param artisanSlug The slug of the artisan.\r\n * @returns The artisan resource. See {@link ArtisanResponse}.\r\n */\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the recipe information for the specified artisan and recipe slugs.\r\n * @param artisanSlug The slug of the artisan.\r\n * @param recipeSlug The slug of the recipe.\r\n * @returns The recipe resource. See {@link RecipeResponse}.\r\n */\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\n/**\r\n * Returns the character class information for the specified character class slug.\r\n * @param characterClassSlug The slug of the character class.\r\n * @returns The character class resource. See {@link CharacterClassResponse}.\r\n */\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the skill information for the specified character class and skill slugs.\r\n * @param characterClassSlug The slug of the character class.\r\n * @param skillSlug The slug of the skill.\r\n * @returns The skill resource. See {@link SkillResponse}.\r\n */\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\n/**\r\n * Returns the follower information for the specified follower slug.\r\n * @param followerSlug The slug of the follower.\r\n * @returns The follower resource. See {@link FollowerResponse}.\r\n */\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the era information for the specified era ID.\r\n * @param id The ID of the era.\r\n * @returns The era resource. See {@link EraResponse}.\r\n */\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era index.\r\n * @returns The era index resource. See {@link EraIndexResponse}.\r\n */\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era leaderboard for the specified era ID and leaderboard.\r\n * @param id The ID of the era.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.\r\n */\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified season ID.\r\n * @param id The ID of the season.\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season index.\r\n * @returns The season index resource. See {@link SeasonIndexResponse}.\r\n */\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season leaderboard for the specified season ID and leaderboard.\r\n * @param id The ID of the season.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.\r\n */\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\n/**\r\n * Returns the item type information for the specified item type slug.\r\n * @param itemTypeSlug The slug of the item type, example: \"sword2h\"\r\n * @returns The item type resource. See {@link ItemTypeResponse}.\r\n */\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the item type index.\r\n * @returns The item type index resource. See {@link ItemTypeIndexResponse}.\r\n */\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\n/**\r\n * Returns the item information for the specified item slug and ID.\r\n * @param itemSlugAndId The slug and ID of the item, example: \"corrupted-ashbringer-Unique_Sword_2H_104_x1\".\r\n * @returns The item resource. See {@link ItemResponse}.\r\n */\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\n/**\r\n * Returns the account information for the specified battle tag.\r\n * @param battleTag The battle tag of the account.\r\n * @returns The account resource. See {@link AccountResponse}.\r\n */\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the hero information for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the follower items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.\r\n */\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero items resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { item } from './item/item';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport { d3, d3 as default };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/d3",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Diablo 3 Blizzard API",
@@ -34,10 +34,10 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "2.0.0"
+    "@blizzard-api/core": "2.0.2"
   },
   "devDependencies": {
-    "@blizzard-api/core": "2.0.0"
+    "@blizzard-api/core": "2.0.2"
   },
   "scripts": {
     "build": "tsup",