@pinta365/blizzard_api 0.3.9 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +0 -0
- package/README.md +145 -37
- package/esm/mod.d.ts +43 -6
- package/esm/mod.js +69 -6
- package/esm/src/client.d.ts +95 -0
- package/esm/src/client.js +52 -0
- package/esm/src/diablo3/community/act.d.ts +29 -0
- package/esm/src/diablo3/community/act.js +23 -0
- package/esm/src/diablo3/community/artisan.d.ts +50 -0
- package/esm/src/diablo3/community/artisan.js +25 -0
- package/esm/src/diablo3/community/follower.d.ts +25 -0
- package/esm/src/diablo3/community/follower.js +12 -0
- package/esm/src/diablo3/community/hero.d.ts +57 -0
- package/esm/src/diablo3/community/hero.js +25 -0
- package/esm/src/diablo3/community/item.d.ts +48 -0
- package/esm/src/diablo3/community/item.js +12 -0
- package/esm/src/diablo3/community/item_type.d.ts +26 -0
- package/esm/src/diablo3/community/item_type.js +23 -0
- package/esm/src/diablo3/community/profile.d.ts +352 -0
- package/esm/src/diablo3/community/profile.js +61 -0
- package/esm/src/diablo3/game_data/d3.d.ts +127 -0
- package/esm/src/diablo3/game_data/d3.js +72 -0
- package/esm/src/diablo3/index.d.ts +8 -0
- package/esm/src/diablo3/index.js +8 -0
- package/esm/src/diablo3/types.d.ts +8 -0
- package/esm/src/diablo3/types.js +1 -0
- package/esm/src/generated/diablo3_api.d.ts +156 -0
- package/esm/src/generated/diablo3_api.js +2 -0
- package/esm/src/generated/hearthstone_api.d.ts +51 -0
- package/esm/src/generated/hearthstone_api.js +2 -0
- package/esm/src/generated/sc2_api.d.ts +139 -0
- package/esm/src/generated/sc2_api.js +2 -0
- package/esm/src/generated/wow_api.d.ts +1482 -0
- package/esm/src/generated/wow_api.js +2 -0
- package/esm/src/generated/wow_classic_api.d.ts +555 -0
- package/esm/src/generated/wow_classic_api.js +2 -0
- package/esm/src/generated/wow_classic_era_api.d.ts +418 -0
- package/esm/src/generated/wow_classic_era_api.js +2 -0
- package/esm/src/hearthstone/game_data/card_backs.d.ts +31 -0
- package/esm/src/hearthstone/game_data/card_backs.js +22 -0
- package/esm/src/hearthstone/game_data/cards.d.ts +55 -0
- package/esm/src/hearthstone/game_data/cards.js +26 -0
- package/esm/src/hearthstone/game_data/decks.d.ts +29 -0
- package/esm/src/hearthstone/game_data/decks.js +13 -0
- package/esm/src/hearthstone/game_data/metadata.d.ts +82 -0
- package/esm/src/hearthstone/game_data/metadata.js +11 -0
- package/esm/src/hearthstone/index.d.ts +4 -0
- package/esm/src/hearthstone/index.js +4 -0
- package/esm/src/hearthstone/search.d.ts +21 -0
- package/esm/src/hearthstone/search.js +28 -0
- package/esm/src/hearthstone/types.d.ts +5 -0
- package/esm/src/hearthstone/types.js +1 -0
- package/esm/src/shared/bind.d.ts +14 -0
- package/esm/src/shared/bind.js +15 -0
- package/esm/src/shared/context.d.ts +163 -0
- package/esm/src/shared/context.js +304 -0
- package/esm/src/shared/errors.d.ts +53 -0
- package/esm/src/shared/errors.js +95 -0
- package/esm/src/shared/index.d.ts +4 -0
- package/esm/src/shared/index.js +2 -0
- package/esm/src/shared/types.d.ts +133 -0
- package/esm/src/shared/types.js +2 -0
- package/esm/src/starcraft2/community/account.d.ts +19 -0
- package/esm/src/starcraft2/community/account.js +15 -0
- package/esm/src/starcraft2/community/ladder.d.ts +29 -0
- package/esm/src/starcraft2/community/ladder.js +27 -0
- package/esm/src/starcraft2/community/legacy.d.ts +206 -0
- package/esm/src/starcraft2/community/legacy.js +83 -0
- package/esm/src/starcraft2/community/profile.d.ts +255 -0
- package/esm/src/starcraft2/community/profile.js +73 -0
- package/esm/src/starcraft2/game_data/league.d.ts +35 -0
- package/esm/src/starcraft2/game_data/league.js +20 -0
- package/esm/src/starcraft2/index.d.ts +5 -0
- package/esm/src/starcraft2/index.js +5 -0
- package/esm/src/starcraft2/types.d.ts +5 -0
- package/esm/src/starcraft2/types.js +1 -0
- package/esm/src/wow/game_data/achievement.d.ts +87 -0
- package/esm/src/wow/game_data/achievement.js +68 -0
- package/esm/src/wow/game_data/auction_house.d.ts +65 -0
- package/esm/src/wow/game_data/auction_house.js +33 -0
- package/esm/src/wow/game_data/azerite_essence.d.ts +50 -0
- package/esm/src/wow/game_data/azerite_essence.js +48 -0
- package/esm/src/wow/game_data/connected_realm.d.ts +62 -0
- package/esm/src/wow/game_data/connected_realm.js +35 -0
- package/esm/src/wow/game_data/covenant.d.ts +115 -0
- package/esm/src/wow/game_data/covenant.js +88 -0
- package/esm/src/wow/game_data/creature.d.ts +98 -0
- package/esm/src/wow/game_data/creature.js +99 -0
- package/esm/src/wow/game_data/guild_crest.d.ts +56 -0
- package/esm/src/wow/game_data/guild_crest.js +38 -0
- package/esm/src/wow/game_data/heirloom.d.ts +82 -0
- package/esm/src/wow/game_data/heirloom.js +25 -0
- package/esm/src/wow/game_data/housing.d.ts +111 -0
- package/esm/src/wow/game_data/housing.js +124 -0
- package/esm/src/wow/game_data/item.d.ts +183 -0
- package/esm/src/wow/game_data/item.js +100 -0
- package/esm/src/wow/game_data/item_appearance.d.ts +102 -0
- package/esm/src/wow/game_data/item_appearance.js +73 -0
- package/esm/src/wow/game_data/journal.d.ts +124 -0
- package/esm/src/wow/game_data/journal.js +98 -0
- package/esm/src/wow/game_data/keystone_affix.d.ts +39 -0
- package/esm/src/wow/game_data/keystone_affix.js +38 -0
- package/esm/src/wow/game_data/media_search.d.ts +9 -0
- package/esm/src/wow/game_data/media_search.js +10 -0
- package/esm/src/wow/game_data/modified_crafting.d.ts +65 -0
- package/esm/src/wow/game_data/modified_crafting.js +62 -0
- package/esm/src/wow/game_data/mount.d.ts +38 -0
- package/esm/src/wow/game_data/mount.js +35 -0
- package/esm/src/wow/game_data/mythic_keystone_dungeon.d.ts +92 -0
- package/esm/src/wow/game_data/mythic_keystone_dungeon.js +87 -0
- package/esm/src/wow/game_data/mythic_keystone_leaderboard.d.ts +70 -0
- package/esm/src/wow/game_data/mythic_keystone_leaderboard.js +28 -0
- package/esm/src/wow/game_data/mythic_raid_leaderboard.d.ts +36 -0
- package/esm/src/wow/game_data/mythic_raid_leaderboard.js +14 -0
- package/esm/src/wow/game_data/neighborhood.d.ts +36 -0
- package/esm/src/wow/game_data/neighborhood.js +38 -0
- package/esm/src/wow/game_data/pet.d.ts +93 -0
- package/esm/src/wow/game_data/pet.js +76 -0
- package/esm/src/wow/game_data/playable_class.d.ts +58 -0
- package/esm/src/wow/game_data/playable_class.js +51 -0
- package/esm/src/wow/game_data/playable_race.d.ts +31 -0
- package/esm/src/wow/game_data/playable_race.js +25 -0
- package/esm/src/wow/game_data/playable_specialization.d.ts +63 -0
- package/esm/src/wow/game_data/playable_specialization.js +38 -0
- package/esm/src/wow/game_data/power_type.d.ts +22 -0
- package/esm/src/wow/game_data/power_type.js +25 -0
- package/esm/src/wow/game_data/profession.d.ts +88 -0
- package/esm/src/wow/game_data/profession.js +78 -0
- package/esm/src/wow/game_data/pvp_season.d.ts +108 -0
- package/esm/src/wow/game_data/pvp_season.js +66 -0
- package/esm/src/wow/game_data/pvp_tier.d.ts +41 -0
- package/esm/src/wow/game_data/pvp_tier.js +38 -0
- package/esm/src/wow/game_data/quest.d.ts +116 -0
- package/esm/src/wow/game_data/quest.js +100 -0
- package/esm/src/wow/game_data/realm.d.ts +43 -0
- package/esm/src/wow/game_data/realm.js +35 -0
- package/esm/src/wow/game_data/region.d.ts +26 -0
- package/esm/src/wow/game_data/region.js +25 -0
- package/esm/src/wow/game_data/reputations.d.ts +57 -0
- package/esm/src/wow/game_data/reputations.js +50 -0
- package/esm/src/wow/game_data/spell.d.ts +34 -0
- package/esm/src/wow/game_data/spell.js +36 -0
- package/esm/src/wow/game_data/talent.d.ts +143 -0
- package/esm/src/wow/game_data/talent.js +89 -0
- package/esm/src/wow/game_data/tech_talent.d.ts +72 -0
- package/esm/src/wow/game_data/tech_talent.js +63 -0
- package/esm/src/wow/game_data/title.d.ts +33 -0
- package/esm/src/wow/game_data/title.js +25 -0
- package/esm/src/wow/game_data/token.d.ts +17 -0
- package/esm/src/wow/game_data/token.js +18 -0
- package/esm/src/wow/game_data/toy.d.ts +25 -0
- package/esm/src/wow/game_data/toy.js +25 -0
- package/esm/src/wow/index.d.ts +59 -0
- package/esm/src/wow/index.js +61 -0
- package/esm/src/wow/profile/account_profile.d.ts +185 -0
- package/esm/src/wow/profile/account_profile.js +132 -0
- package/esm/src/wow/profile/character_achievements.d.ts +88 -0
- package/esm/src/wow/profile/character_achievements.js +28 -0
- package/esm/src/wow/profile/character_appearance.d.ts +79 -0
- package/esm/src/wow/profile/character_appearance.js +14 -0
- package/esm/src/wow/profile/character_collections.d.ts +132 -0
- package/esm/src/wow/profile/character_collections.js +98 -0
- package/esm/src/wow/profile/character_encounters.d.ts +78 -0
- package/esm/src/wow/profile/character_encounters.js +42 -0
- package/esm/src/wow/profile/character_equipment.d.ts +177 -0
- package/esm/src/wow/profile/character_equipment.js +14 -0
- package/esm/src/wow/profile/character_house.d.ts +16 -0
- package/esm/src/wow/profile/character_house.js +17 -0
- package/esm/src/wow/profile/character_hunter_pets.d.ts +22 -0
- package/esm/src/wow/profile/character_hunter_pets.js +14 -0
- package/esm/src/wow/profile/character_media.d.ts +14 -0
- package/esm/src/wow/profile/character_media.js +14 -0
- package/esm/src/wow/profile/character_mythic_keystone_profile.d.ts +70 -0
- package/esm/src/wow/profile/character_mythic_keystone_profile.js +31 -0
- package/esm/src/wow/profile/character_professions.d.ts +29 -0
- package/esm/src/wow/profile/character_professions.js +14 -0
- package/esm/src/wow/profile/character_profile.d.ts +83 -0
- package/esm/src/wow/profile/character_profile.js +39 -0
- package/esm/src/wow/profile/character_pvp.d.ts +53 -0
- package/esm/src/wow/profile/character_pvp.js +29 -0
- package/esm/src/wow/profile/character_quests.d.ts +29 -0
- package/esm/src/wow/profile/character_quests.js +28 -0
- package/esm/src/wow/profile/character_reputations.d.ts +30 -0
- package/esm/src/wow/profile/character_reputations.js +14 -0
- package/esm/src/wow/profile/character_soulbinds.d.ts +31 -0
- package/esm/src/wow/profile/character_soulbinds.js +14 -0
- package/esm/src/wow/profile/character_specializations.d.ts +82 -0
- package/esm/src/wow/profile/character_specializations.js +14 -0
- package/esm/src/wow/profile/character_statistics.d.ts +104 -0
- package/esm/src/wow/profile/character_statistics.js +14 -0
- package/esm/src/wow/profile/character_titles.d.ts +14 -0
- package/esm/src/wow/profile/character_titles.js +14 -0
- package/esm/src/wow/profile/guild.d.ts +150 -0
- package/esm/src/wow/profile/guild.js +56 -0
- package/esm/src/wow/search.d.ts +23 -0
- package/esm/src/wow/search.js +29 -0
- package/esm/src/wow/types.d.ts +58 -0
- package/esm/src/wow/types.js +1 -0
- package/esm/src/wow_classic/auction_house.d.ts +41 -0
- package/esm/src/wow_classic/auction_house.js +31 -0
- package/esm/src/wow_classic/character_specializations.d.ts +45 -0
- package/esm/src/wow_classic/character_specializations.js +18 -0
- package/esm/src/wow_classic/era.d.ts +8 -0
- package/esm/src/wow_classic/era.js +10 -0
- package/esm/src/wow_classic/index.d.ts +15 -0
- package/esm/src/wow_classic/index.js +17 -0
- package/esm/src/wow_classic/profile_overrides.d.ts +125 -0
- package/esm/src/wow_classic/profile_overrides.js +111 -0
- package/esm/src/wow_classic/shared.d.ts +23 -0
- package/esm/src/wow_classic/shared.js +26 -0
- package/esm/src/wow_classic/types.d.ts +3 -0
- package/esm/src/wow_classic/types.js +1 -0
- package/package.json +23 -2
- package/script/mod.d.ts +43 -6
- package/script/mod.js +91 -21
- package/script/src/client.d.ts +95 -0
- package/script/src/client.js +89 -0
- package/script/src/diablo3/community/act.d.ts +29 -0
- package/script/src/diablo3/community/act.js +27 -0
- package/script/src/diablo3/community/artisan.d.ts +50 -0
- package/script/src/diablo3/community/artisan.js +29 -0
- package/script/src/diablo3/community/follower.d.ts +25 -0
- package/script/src/diablo3/community/follower.js +15 -0
- package/script/src/diablo3/community/hero.d.ts +57 -0
- package/script/src/diablo3/community/hero.js +29 -0
- package/script/src/diablo3/community/item.d.ts +48 -0
- package/script/src/diablo3/community/item.js +15 -0
- package/script/src/diablo3/community/item_type.d.ts +26 -0
- package/script/src/diablo3/community/item_type.js +27 -0
- package/script/src/diablo3/community/profile.d.ts +352 -0
- package/script/src/diablo3/community/profile.js +67 -0
- package/script/src/diablo3/game_data/d3.d.ts +127 -0
- package/script/src/diablo3/game_data/d3.js +80 -0
- package/script/src/diablo3/index.d.ts +8 -0
- package/script/src/diablo3/index.js +31 -0
- package/script/src/diablo3/types.d.ts +8 -0
- package/script/src/diablo3/types.js +2 -0
- package/script/src/generated/diablo3_api.d.ts +156 -0
- package/script/src/generated/diablo3_api.js +3 -0
- package/script/src/generated/hearthstone_api.d.ts +51 -0
- package/script/src/generated/hearthstone_api.js +3 -0
- package/script/src/generated/sc2_api.d.ts +139 -0
- package/script/src/generated/sc2_api.js +3 -0
- package/script/src/generated/wow_api.d.ts +1482 -0
- package/script/src/generated/wow_api.js +3 -0
- package/script/src/generated/wow_classic_api.d.ts +555 -0
- package/script/src/generated/wow_classic_api.js +3 -0
- package/script/src/generated/wow_classic_era_api.d.ts +418 -0
- package/script/src/generated/wow_classic_era_api.js +3 -0
- package/script/src/hearthstone/game_data/card_backs.d.ts +31 -0
- package/script/src/hearthstone/game_data/card_backs.js +26 -0
- package/script/src/hearthstone/game_data/cards.d.ts +55 -0
- package/script/src/hearthstone/game_data/cards.js +30 -0
- package/script/src/hearthstone/game_data/decks.d.ts +29 -0
- package/script/src/hearthstone/game_data/decks.js +16 -0
- package/script/src/hearthstone/game_data/metadata.d.ts +82 -0
- package/script/src/hearthstone/game_data/metadata.js +14 -0
- package/script/src/hearthstone/index.d.ts +4 -0
- package/script/src/hearthstone/index.js +13 -0
- package/script/src/hearthstone/search.d.ts +21 -0
- package/script/src/hearthstone/search.js +31 -0
- package/script/src/hearthstone/types.d.ts +5 -0
- package/script/src/hearthstone/types.js +2 -0
- package/script/src/shared/bind.d.ts +14 -0
- package/script/src/shared/bind.js +18 -0
- package/script/src/shared/context.d.ts +163 -0
- package/script/src/shared/context.js +312 -0
- package/script/src/shared/errors.d.ts +53 -0
- package/script/src/shared/errors.js +104 -0
- package/script/src/shared/index.d.ts +4 -0
- package/script/src/shared/index.js +10 -0
- package/script/src/shared/types.d.ts +133 -0
- package/script/src/shared/types.js +3 -0
- package/script/src/starcraft2/community/account.d.ts +19 -0
- package/script/src/starcraft2/community/account.js +18 -0
- package/script/src/starcraft2/community/ladder.d.ts +29 -0
- package/script/src/starcraft2/community/ladder.js +31 -0
- package/script/src/starcraft2/community/legacy.d.ts +206 -0
- package/script/src/starcraft2/community/legacy.js +91 -0
- package/script/src/starcraft2/community/profile.d.ts +255 -0
- package/script/src/starcraft2/community/profile.js +80 -0
- package/script/src/starcraft2/game_data/league.d.ts +35 -0
- package/script/src/starcraft2/game_data/league.js +23 -0
- package/script/src/starcraft2/index.d.ts +5 -0
- package/script/src/starcraft2/index.js +23 -0
- package/script/src/starcraft2/types.d.ts +5 -0
- package/script/src/starcraft2/types.js +2 -0
- package/script/src/wow/game_data/achievement.d.ts +87 -0
- package/script/src/wow/game_data/achievement.js +75 -0
- package/script/src/wow/game_data/auction_house.d.ts +65 -0
- package/script/src/wow/game_data/auction_house.js +37 -0
- package/script/src/wow/game_data/azerite_essence.d.ts +50 -0
- package/script/src/wow/game_data/azerite_essence.js +54 -0
- package/script/src/wow/game_data/connected_realm.d.ts +62 -0
- package/script/src/wow/game_data/connected_realm.js +40 -0
- package/script/src/wow/game_data/covenant.d.ts +115 -0
- package/script/src/wow/game_data/covenant.js +97 -0
- package/script/src/wow/game_data/creature.d.ts +98 -0
- package/script/src/wow/game_data/creature.js +109 -0
- package/script/src/wow/game_data/guild_crest.d.ts +56 -0
- package/script/src/wow/game_data/guild_crest.js +43 -0
- package/script/src/wow/game_data/heirloom.d.ts +82 -0
- package/script/src/wow/game_data/heirloom.js +29 -0
- package/script/src/wow/game_data/housing.d.ts +111 -0
- package/script/src/wow/game_data/housing.js +138 -0
- package/script/src/wow/game_data/item.d.ts +183 -0
- package/script/src/wow/game_data/item.js +110 -0
- package/script/src/wow/game_data/item_appearance.d.ts +102 -0
- package/script/src/wow/game_data/item_appearance.js +81 -0
- package/script/src/wow/game_data/journal.d.ts +124 -0
- package/script/src/wow/game_data/journal.js +108 -0
- package/script/src/wow/game_data/keystone_affix.d.ts +39 -0
- package/script/src/wow/game_data/keystone_affix.js +43 -0
- package/script/src/wow/game_data/media_search.d.ts +9 -0
- package/script/src/wow/game_data/media_search.js +13 -0
- package/script/src/wow/game_data/modified_crafting.d.ts +65 -0
- package/script/src/wow/game_data/modified_crafting.js +69 -0
- package/script/src/wow/game_data/mount.d.ts +38 -0
- package/script/src/wow/game_data/mount.js +40 -0
- package/script/src/wow/game_data/mythic_keystone_dungeon.d.ts +92 -0
- package/script/src/wow/game_data/mythic_keystone_dungeon.js +96 -0
- package/script/src/wow/game_data/mythic_keystone_leaderboard.d.ts +70 -0
- package/script/src/wow/game_data/mythic_keystone_leaderboard.js +32 -0
- package/script/src/wow/game_data/mythic_raid_leaderboard.d.ts +36 -0
- package/script/src/wow/game_data/mythic_raid_leaderboard.js +17 -0
- package/script/src/wow/game_data/neighborhood.d.ts +36 -0
- package/script/src/wow/game_data/neighborhood.js +43 -0
- package/script/src/wow/game_data/pet.d.ts +93 -0
- package/script/src/wow/game_data/pet.js +84 -0
- package/script/src/wow/game_data/playable_class.d.ts +58 -0
- package/script/src/wow/game_data/playable_class.js +57 -0
- package/script/src/wow/game_data/playable_race.d.ts +31 -0
- package/script/src/wow/game_data/playable_race.js +29 -0
- package/script/src/wow/game_data/playable_specialization.d.ts +63 -0
- package/script/src/wow/game_data/playable_specialization.js +43 -0
- package/script/src/wow/game_data/power_type.d.ts +22 -0
- package/script/src/wow/game_data/power_type.js +29 -0
- package/script/src/wow/game_data/profession.d.ts +88 -0
- package/script/src/wow/game_data/profession.js +86 -0
- package/script/src/wow/game_data/pvp_season.d.ts +108 -0
- package/script/src/wow/game_data/pvp_season.js +73 -0
- package/script/src/wow/game_data/pvp_tier.d.ts +41 -0
- package/script/src/wow/game_data/pvp_tier.js +43 -0
- package/script/src/wow/game_data/quest.d.ts +116 -0
- package/script/src/wow/game_data/quest.js +110 -0
- package/script/src/wow/game_data/realm.d.ts +43 -0
- package/script/src/wow/game_data/realm.js +40 -0
- package/script/src/wow/game_data/region.d.ts +26 -0
- package/script/src/wow/game_data/region.js +29 -0
- package/script/src/wow/game_data/reputations.d.ts +57 -0
- package/script/src/wow/game_data/reputations.js +56 -0
- package/script/src/wow/game_data/spell.d.ts +34 -0
- package/script/src/wow/game_data/spell.js +41 -0
- package/script/src/wow/game_data/talent.d.ts +143 -0
- package/script/src/wow/game_data/talent.js +98 -0
- package/script/src/wow/game_data/tech_talent.d.ts +72 -0
- package/script/src/wow/game_data/tech_talent.js +70 -0
- package/script/src/wow/game_data/title.d.ts +33 -0
- package/script/src/wow/game_data/title.js +29 -0
- package/script/src/wow/game_data/token.d.ts +17 -0
- package/script/src/wow/game_data/token.js +21 -0
- package/script/src/wow/game_data/toy.d.ts +25 -0
- package/script/src/wow/game_data/toy.js +29 -0
- package/script/src/wow/index.d.ts +59 -0
- package/script/src/wow/index.js +272 -0
- package/script/src/wow/profile/account_profile.d.ts +185 -0
- package/script/src/wow/profile/account_profile.js +143 -0
- package/script/src/wow/profile/character_achievements.d.ts +88 -0
- package/script/src/wow/profile/character_achievements.js +32 -0
- package/script/src/wow/profile/character_appearance.d.ts +79 -0
- package/script/src/wow/profile/character_appearance.js +17 -0
- package/script/src/wow/profile/character_collections.d.ts +132 -0
- package/script/src/wow/profile/character_collections.js +107 -0
- package/script/src/wow/profile/character_encounters.d.ts +78 -0
- package/script/src/wow/profile/character_encounters.js +47 -0
- package/script/src/wow/profile/character_equipment.d.ts +177 -0
- package/script/src/wow/profile/character_equipment.js +17 -0
- package/script/src/wow/profile/character_house.d.ts +16 -0
- package/script/src/wow/profile/character_house.js +20 -0
- package/script/src/wow/profile/character_hunter_pets.d.ts +22 -0
- package/script/src/wow/profile/character_hunter_pets.js +17 -0
- package/script/src/wow/profile/character_media.d.ts +14 -0
- package/script/src/wow/profile/character_media.js +17 -0
- package/script/src/wow/profile/character_mythic_keystone_profile.d.ts +70 -0
- package/script/src/wow/profile/character_mythic_keystone_profile.js +35 -0
- package/script/src/wow/profile/character_professions.d.ts +29 -0
- package/script/src/wow/profile/character_professions.js +17 -0
- package/script/src/wow/profile/character_profile.d.ts +83 -0
- package/script/src/wow/profile/character_profile.js +43 -0
- package/script/src/wow/profile/character_pvp.d.ts +53 -0
- package/script/src/wow/profile/character_pvp.js +33 -0
- package/script/src/wow/profile/character_quests.d.ts +29 -0
- package/script/src/wow/profile/character_quests.js +32 -0
- package/script/src/wow/profile/character_reputations.d.ts +30 -0
- package/script/src/wow/profile/character_reputations.js +17 -0
- package/script/src/wow/profile/character_soulbinds.d.ts +31 -0
- package/script/src/wow/profile/character_soulbinds.js +17 -0
- package/script/src/wow/profile/character_specializations.d.ts +82 -0
- package/script/src/wow/profile/character_specializations.js +17 -0
- package/script/src/wow/profile/character_statistics.d.ts +104 -0
- package/script/src/wow/profile/character_statistics.js +17 -0
- package/script/src/wow/profile/character_titles.d.ts +14 -0
- package/script/src/wow/profile/character_titles.js +17 -0
- package/script/src/wow/profile/guild.d.ts +150 -0
- package/script/src/wow/profile/guild.js +62 -0
- package/script/src/wow/search.d.ts +23 -0
- package/script/src/wow/search.js +32 -0
- package/script/src/wow/types.d.ts +58 -0
- package/script/src/wow/types.js +2 -0
- package/script/src/wow_classic/auction_house.d.ts +41 -0
- package/script/src/wow_classic/auction_house.js +35 -0
- package/script/src/wow_classic/character_specializations.d.ts +45 -0
- package/script/src/wow_classic/character_specializations.js +21 -0
- package/script/src/wow_classic/era.d.ts +8 -0
- package/script/src/wow_classic/era.js +30 -0
- package/script/src/wow_classic/index.d.ts +15 -0
- package/script/src/wow_classic/index.js +55 -0
- package/script/src/wow_classic/profile_overrides.d.ts +125 -0
- package/script/src/wow_classic/profile_overrides.js +123 -0
- package/script/src/wow_classic/shared.d.ts +23 -0
- package/script/src/wow_classic/shared.js +81 -0
- package/script/src/wow_classic/types.d.ts +3 -0
- package/script/src/wow_classic/types.js +2 -0
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import type { ApiContext } from "../../shared/index.js";
|
|
2
|
+
import type { LinkSelfHref, LocalizedString } from "../../shared/index.js";
|
|
3
|
+
export interface Seasons extends LinkSelfHref {
|
|
4
|
+
season: {
|
|
5
|
+
href: string;
|
|
6
|
+
}[];
|
|
7
|
+
current_season: number;
|
|
8
|
+
service_current_season: number;
|
|
9
|
+
service_season_state: string;
|
|
10
|
+
last_update_time: string;
|
|
11
|
+
generated_by: string;
|
|
12
|
+
}
|
|
13
|
+
export interface Season extends LinkSelfHref {
|
|
14
|
+
leaderboard: {
|
|
15
|
+
team_size?: number;
|
|
16
|
+
ladder: {
|
|
17
|
+
href: string;
|
|
18
|
+
};
|
|
19
|
+
hardcore?: boolean;
|
|
20
|
+
hero_class_string?: LocalizedString;
|
|
21
|
+
}[];
|
|
22
|
+
season_id: number;
|
|
23
|
+
last_update_time: string;
|
|
24
|
+
generated_by: string;
|
|
25
|
+
}
|
|
26
|
+
export interface LeaderboardData {
|
|
27
|
+
id: string;
|
|
28
|
+
string?: string;
|
|
29
|
+
number?: number;
|
|
30
|
+
timestamp?: number;
|
|
31
|
+
}
|
|
32
|
+
export interface LeaderboardBase extends LinkSelfHref {
|
|
33
|
+
row: {
|
|
34
|
+
player: {
|
|
35
|
+
key: string;
|
|
36
|
+
accountId: number;
|
|
37
|
+
data: LeaderboardData[];
|
|
38
|
+
}[];
|
|
39
|
+
order: number;
|
|
40
|
+
data: LeaderboardData[];
|
|
41
|
+
}[];
|
|
42
|
+
key: string;
|
|
43
|
+
title: LocalizedString;
|
|
44
|
+
column: {
|
|
45
|
+
id: string;
|
|
46
|
+
hidden: boolean;
|
|
47
|
+
order?: number;
|
|
48
|
+
label: LocalizedString | null;
|
|
49
|
+
type: string;
|
|
50
|
+
}[];
|
|
51
|
+
last_update_time: string;
|
|
52
|
+
generated_by: string;
|
|
53
|
+
hardcore?: boolean;
|
|
54
|
+
}
|
|
55
|
+
export interface SeasonLeaderboard extends LeaderboardBase {
|
|
56
|
+
achievement_points: boolean;
|
|
57
|
+
season: number;
|
|
58
|
+
}
|
|
59
|
+
export interface EraLeaderboard extends LeaderboardBase {
|
|
60
|
+
greater_rift: boolean;
|
|
61
|
+
greater_rift_solo_class: string;
|
|
62
|
+
era: number;
|
|
63
|
+
}
|
|
64
|
+
export interface Eras extends LinkSelfHref {
|
|
65
|
+
era: {
|
|
66
|
+
href: string;
|
|
67
|
+
}[];
|
|
68
|
+
current_era: number;
|
|
69
|
+
last_update_time: string;
|
|
70
|
+
generated_by: string;
|
|
71
|
+
}
|
|
72
|
+
export interface Era extends LinkSelfHref {
|
|
73
|
+
leaderboard: {
|
|
74
|
+
team_size?: number;
|
|
75
|
+
ladder: {
|
|
76
|
+
href: string;
|
|
77
|
+
};
|
|
78
|
+
hardcore?: boolean;
|
|
79
|
+
hero_class_string?: LocalizedString;
|
|
80
|
+
}[];
|
|
81
|
+
era_id: number;
|
|
82
|
+
era_start_date: number;
|
|
83
|
+
last_update_time: string;
|
|
84
|
+
generated_by: string;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Returns an index of available seasons.
|
|
88
|
+
*
|
|
89
|
+
* @returns A promise that resolves to an object representing an index of available seasons.
|
|
90
|
+
*/
|
|
91
|
+
export declare function seasons(ctx: ApiContext): Promise<Seasons>;
|
|
92
|
+
/**
|
|
93
|
+
* Returns an index of available seasons.
|
|
94
|
+
*
|
|
95
|
+
* @param seasonId - The season for the leaderboard list.
|
|
96
|
+
* @returns A promise that resolves to an object representing the data for a league.
|
|
97
|
+
*/
|
|
98
|
+
export declare function season(ctx: ApiContext, seasonId: number): Promise<Season>;
|
|
99
|
+
/**
|
|
100
|
+
* Returns a the specified leaderboard for the specified season.
|
|
101
|
+
*
|
|
102
|
+
* @param seasonId - The season for the leaderboard.
|
|
103
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
104
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
|
|
105
|
+
*/
|
|
106
|
+
export declare function seasonLeaderboard(ctx: ApiContext, seasonId: number, leaderboard: string): Promise<SeasonLeaderboard>;
|
|
107
|
+
/**
|
|
108
|
+
* Returns an index of available eras.
|
|
109
|
+
*
|
|
110
|
+
* @returns A promise that resolves to an object representing an index of available eras.
|
|
111
|
+
*/
|
|
112
|
+
export declare function eras(ctx: ApiContext): Promise<Eras>;
|
|
113
|
+
/**
|
|
114
|
+
* Returns a leaderboard list for a particular era.
|
|
115
|
+
*
|
|
116
|
+
* @param eraId - The era to retrieve.
|
|
117
|
+
* @returns A promise that resolves to an object representing a leaderboard list for a particular era.
|
|
118
|
+
*/
|
|
119
|
+
export declare function era(ctx: ApiContext, eraId: number): Promise<Era>;
|
|
120
|
+
/**
|
|
121
|
+
* Returns the specified leaderboard for the specified era.
|
|
122
|
+
*
|
|
123
|
+
* @param eraId - The era for the leaderboard.
|
|
124
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
125
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
|
|
126
|
+
*/
|
|
127
|
+
export declare function eraLeaderboard(ctx: ApiContext, eraId: number, leaderboard: string): Promise<EraLeaderboard>;
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns an index of available seasons.
|
|
3
|
+
*
|
|
4
|
+
* @returns A promise that resolves to an object representing an index of available seasons.
|
|
5
|
+
*/
|
|
6
|
+
export async function seasons(ctx) {
|
|
7
|
+
return await ctx.request({
|
|
8
|
+
method: "GET",
|
|
9
|
+
url: "/data/d3/season/",
|
|
10
|
+
});
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Returns an index of available seasons.
|
|
14
|
+
*
|
|
15
|
+
* @param seasonId - The season for the leaderboard list.
|
|
16
|
+
* @returns A promise that resolves to an object representing the data for a league.
|
|
17
|
+
*/
|
|
18
|
+
export async function season(ctx, seasonId) {
|
|
19
|
+
return await ctx.request({
|
|
20
|
+
method: "GET",
|
|
21
|
+
url: `/data/d3/season/${seasonId}`,
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Returns a the specified leaderboard for the specified season.
|
|
26
|
+
*
|
|
27
|
+
* @param seasonId - The season for the leaderboard.
|
|
28
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
29
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
|
|
30
|
+
*/
|
|
31
|
+
export async function seasonLeaderboard(ctx, seasonId, leaderboard) {
|
|
32
|
+
return await ctx.request({
|
|
33
|
+
method: "GET",
|
|
34
|
+
url: `/data/d3/season/${seasonId}/leaderboard/${leaderboard}`,
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Returns an index of available eras.
|
|
39
|
+
*
|
|
40
|
+
* @returns A promise that resolves to an object representing an index of available eras.
|
|
41
|
+
*/
|
|
42
|
+
export async function eras(ctx) {
|
|
43
|
+
return await ctx.request({
|
|
44
|
+
method: "GET",
|
|
45
|
+
url: "/data/d3/era/",
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Returns a leaderboard list for a particular era.
|
|
50
|
+
*
|
|
51
|
+
* @param eraId - The era to retrieve.
|
|
52
|
+
* @returns A promise that resolves to an object representing a leaderboard list for a particular era.
|
|
53
|
+
*/
|
|
54
|
+
export async function era(ctx, eraId) {
|
|
55
|
+
return await ctx.request({
|
|
56
|
+
method: "GET",
|
|
57
|
+
url: `/data/d3/era/${eraId}`,
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Returns the specified leaderboard for the specified era.
|
|
62
|
+
*
|
|
63
|
+
* @param eraId - The era for the leaderboard.
|
|
64
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
65
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
|
|
66
|
+
*/
|
|
67
|
+
export async function eraLeaderboard(ctx, eraId, leaderboard) {
|
|
68
|
+
return await ctx.request({
|
|
69
|
+
method: "GET",
|
|
70
|
+
url: `/data/d3/era/${eraId}/leaderboard/${leaderboard}`,
|
|
71
|
+
});
|
|
72
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { era, eraLeaderboard, eras, season, seasonLeaderboard, seasons } from "./game_data/d3.js";
|
|
2
|
+
export { act, acts } from "./community/act.js";
|
|
3
|
+
export { artisan, artisanRecipe } from "./community/artisan.js";
|
|
4
|
+
export { follower } from "./community/follower.js";
|
|
5
|
+
export { heroClass, heroSkill } from "./community/hero.js";
|
|
6
|
+
export { itemType, itemTypes } from "./community/item_type.js";
|
|
7
|
+
export { item } from "./community/item.js";
|
|
8
|
+
export { account, hero, heroFollowerItems, heroItems } from "./community/profile.js";
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { era, eraLeaderboard, eras, season, seasonLeaderboard, seasons } from "./game_data/d3.js";
|
|
2
|
+
export { act, acts } from "./community/act.js";
|
|
3
|
+
export { artisan, artisanRecipe } from "./community/artisan.js";
|
|
4
|
+
export { follower } from "./community/follower.js";
|
|
5
|
+
export { heroClass, heroSkill } from "./community/hero.js";
|
|
6
|
+
export { itemType, itemTypes } from "./community/item_type.js";
|
|
7
|
+
export { item } from "./community/item.js";
|
|
8
|
+
export { account, hero, heroFollowerItems, heroItems } from "./community/profile.js";
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export type { Act, Acts } from "./community/act.js";
|
|
2
|
+
export type { Artisan, Recipe } from "./community/artisan.js";
|
|
3
|
+
export type { Follower } from "./community/follower.js";
|
|
4
|
+
export type { HeroClass, HeroSkill, HeroSkillDetail, SkillRune } from "./community/hero.js";
|
|
5
|
+
export type { Item } from "./community/item.js";
|
|
6
|
+
export type { ItemType, ItemTypes } from "./community/item_type.js";
|
|
7
|
+
export type { D3Account, D3AccountHero, D3ActProgress, D3Artisan, D3Attributes, D3CraftedBy, D3FallenHero, D3Follower, D3FollowerItems, D3FollowerStats, D3Gem, D3Hero, D3HeroFollowerItems, D3HeroItem, D3HeroItems, D3HeroStats, D3ItemColor, D3ItemRef, D3ItemSet, D3ItemType, D3Kills, D3SeasonalProfile, D3Skill, D3SkillRune, } from "./community/profile.js";
|
|
8
|
+
export type { Era, EraLeaderboard, Eras, LeaderboardBase, LeaderboardData, Season, SeasonLeaderboard, Seasons, } from "./game_data/d3.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import type { Act, Acts } from "../diablo3/community/act.js";
|
|
2
|
+
import type { Artisan, Recipe } from "../diablo3/community/artisan.js";
|
|
3
|
+
import type { D3Account, D3Hero, D3HeroFollowerItems, D3HeroItems } from "../diablo3/community/profile.js";
|
|
4
|
+
import type { Era, EraLeaderboard, Eras, Season, SeasonLeaderboard, Seasons } from "../diablo3/game_data/d3.js";
|
|
5
|
+
import type { Follower } from "../diablo3/community/follower.js";
|
|
6
|
+
import type { HeroClass, HeroSkillDetail } from "../diablo3/community/hero.js";
|
|
7
|
+
import type { Item } from "../diablo3/community/item.js";
|
|
8
|
+
import type { ItemType, ItemTypes } from "../diablo3/community/item_type.js";
|
|
9
|
+
/**
|
|
10
|
+
* Diablo III endpoints.
|
|
11
|
+
*/
|
|
12
|
+
export interface Diablo3Api {
|
|
13
|
+
/**
|
|
14
|
+
* Returns the account profile of a battle tag, including its heroes.
|
|
15
|
+
*
|
|
16
|
+
* @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
|
|
17
|
+
* @returns A promise that resolves to an object representing the account profile.
|
|
18
|
+
*/
|
|
19
|
+
account(battleTag: string): Promise<D3Account>;
|
|
20
|
+
/**
|
|
21
|
+
* Returns a single act by ID.
|
|
22
|
+
*
|
|
23
|
+
* @param seasonId - The season for the leaderboard list.
|
|
24
|
+
* @returns A promise that resolves to an object representing the data for a single act by ID.
|
|
25
|
+
*/
|
|
26
|
+
act(seasonId: number): Promise<Act>;
|
|
27
|
+
/**
|
|
28
|
+
* Returns an index of acts.
|
|
29
|
+
*
|
|
30
|
+
* @returns A promise that resolves to an object representing an index of acts.
|
|
31
|
+
*/
|
|
32
|
+
acts(): Promise<Acts>;
|
|
33
|
+
/**
|
|
34
|
+
* Returns a single artisan by slug.
|
|
35
|
+
*
|
|
36
|
+
* @param artisanSlug - The slug of the artisan to retrieve.
|
|
37
|
+
* @returns A promise that resolves to an object representing the data for a single artisan by slug.
|
|
38
|
+
*/
|
|
39
|
+
artisan(artisanSlug: string): Promise<Artisan>;
|
|
40
|
+
/**
|
|
41
|
+
* Returns a single recipe by slug for the specified artisan.
|
|
42
|
+
*
|
|
43
|
+
* @param artisanSlug - The slug of the artisan to retrieve.
|
|
44
|
+
* @param recipeSlug - The slug of the recipe to retrieve.
|
|
45
|
+
* @returns A promise that resolves to an object representing the data for a single recipe by slug for the specified artisan.
|
|
46
|
+
*/
|
|
47
|
+
artisanRecipe(artisanSlug: string, recipeSlug: string): Promise<Recipe>;
|
|
48
|
+
/**
|
|
49
|
+
* Returns a leaderboard list for a particular era.
|
|
50
|
+
*
|
|
51
|
+
* @param eraId - The era to retrieve.
|
|
52
|
+
* @returns A promise that resolves to an object representing a leaderboard list for a particular era.
|
|
53
|
+
*/
|
|
54
|
+
era(eraId: number): Promise<Era>;
|
|
55
|
+
/**
|
|
56
|
+
* Returns the specified leaderboard for the specified era.
|
|
57
|
+
*
|
|
58
|
+
* @param eraId - The era for the leaderboard.
|
|
59
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
60
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
|
|
61
|
+
*/
|
|
62
|
+
eraLeaderboard(eraId: number, leaderboard: string): Promise<EraLeaderboard>;
|
|
63
|
+
/**
|
|
64
|
+
* Returns an index of available eras.
|
|
65
|
+
*
|
|
66
|
+
* @returns A promise that resolves to an object representing an index of available eras.
|
|
67
|
+
*/
|
|
68
|
+
eras(): Promise<Eras>;
|
|
69
|
+
/**
|
|
70
|
+
* Returns a single follower by slug.
|
|
71
|
+
*
|
|
72
|
+
* @param followerSlug - The slug of the follower to retrieve.
|
|
73
|
+
* @returns A promise that resolves to an object representing the data for a single follower by slug.
|
|
74
|
+
*/
|
|
75
|
+
follower(followerSlug: string): Promise<Follower>;
|
|
76
|
+
/**
|
|
77
|
+
* Returns a hero of a battle tag.
|
|
78
|
+
*
|
|
79
|
+
* @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
|
|
80
|
+
* @param heroId - The unique identifier for the hero.
|
|
81
|
+
* @returns A promise that resolves to an object representing the hero.
|
|
82
|
+
*/
|
|
83
|
+
hero(battleTag: string, heroId: number): Promise<D3Hero>;
|
|
84
|
+
/**
|
|
85
|
+
* Returns a single character class by slug.
|
|
86
|
+
*
|
|
87
|
+
* @param classSlug - The slug of the character class to retrieve.
|
|
88
|
+
* @returns A promise that resolves to an object representing the data for a single follower by slug.
|
|
89
|
+
*/
|
|
90
|
+
heroClass(classSlug: string): Promise<HeroClass>;
|
|
91
|
+
/**
|
|
92
|
+
* Returns the items equipped by a hero's followers.
|
|
93
|
+
*
|
|
94
|
+
* @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
|
|
95
|
+
* @param heroId - The unique identifier for the hero.
|
|
96
|
+
* @returns A promise that resolves to an object representing the hero's follower items.
|
|
97
|
+
*/
|
|
98
|
+
heroFollowerItems(battleTag: string, heroId: number): Promise<D3HeroFollowerItems>;
|
|
99
|
+
/**
|
|
100
|
+
* Returns the equipped items of a hero.
|
|
101
|
+
*
|
|
102
|
+
* @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
|
|
103
|
+
* @param heroId - The unique identifier for the hero.
|
|
104
|
+
* @returns A promise that resolves to an object representing the hero's equipped items.
|
|
105
|
+
*/
|
|
106
|
+
heroItems(battleTag: string, heroId: number): Promise<D3HeroItems>;
|
|
107
|
+
/**
|
|
108
|
+
* Returns a single skill by slug for a specific character class.
|
|
109
|
+
*
|
|
110
|
+
* @param classSlug - The slug of the character class to retrieve.
|
|
111
|
+
* @param skillSlug - The slug of the skill to retrieve.
|
|
112
|
+
* @returns A promise that resolves to an object representing the data for a single skill by slug for a specific character class.
|
|
113
|
+
*/
|
|
114
|
+
heroSkill(classSlug: string, skillSlug: string): Promise<HeroSkillDetail>;
|
|
115
|
+
/**
|
|
116
|
+
* Returns a single item by item slug and ID.
|
|
117
|
+
*
|
|
118
|
+
* @param itemSlugAndId - The slug and ID of the item to retrieve.
|
|
119
|
+
* @returns A promise that resolves to an object representing the data for a single item by item slug and ID.
|
|
120
|
+
*/
|
|
121
|
+
item(itemSlugAndId: string): Promise<Item>;
|
|
122
|
+
/**
|
|
123
|
+
* Returns a single item type by slug.
|
|
124
|
+
*
|
|
125
|
+
* @param itemTypeSlug - The slug of the item type to retrieve.
|
|
126
|
+
* @returns A promise that resolves to an object representing the data for a single item type by slug.
|
|
127
|
+
*/
|
|
128
|
+
itemType(itemTypeSlug: string): Promise<ItemType[]>;
|
|
129
|
+
/**
|
|
130
|
+
* Returns an index of item types.
|
|
131
|
+
*
|
|
132
|
+
* @returns A promise that resolves to an object representing an index of item types.
|
|
133
|
+
*/
|
|
134
|
+
itemTypes(): Promise<ItemTypes[]>;
|
|
135
|
+
/**
|
|
136
|
+
* Returns an index of available seasons.
|
|
137
|
+
*
|
|
138
|
+
* @param seasonId - The season for the leaderboard list.
|
|
139
|
+
* @returns A promise that resolves to an object representing the data for a league.
|
|
140
|
+
*/
|
|
141
|
+
season(seasonId: number): Promise<Season>;
|
|
142
|
+
/**
|
|
143
|
+
* Returns a the specified leaderboard for the specified season.
|
|
144
|
+
*
|
|
145
|
+
* @param seasonId - The season for the leaderboard.
|
|
146
|
+
* @param leaderboard - The leaderboard to retrieve.
|
|
147
|
+
* @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
|
|
148
|
+
*/
|
|
149
|
+
seasonLeaderboard(seasonId: number, leaderboard: string): Promise<SeasonLeaderboard>;
|
|
150
|
+
/**
|
|
151
|
+
* Returns an index of available seasons.
|
|
152
|
+
*
|
|
153
|
+
* @returns A promise that resolves to an object representing an index of available seasons.
|
|
154
|
+
*/
|
|
155
|
+
seasons(): Promise<Seasons>;
|
|
156
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { Card, CardSearch } from "../hearthstone/game_data/cards.js";
|
|
2
|
+
import type { Cardback, CardbackSearch } from "../hearthstone/game_data/card_backs.js";
|
|
3
|
+
import type { Deck, Options } from "../hearthstone/game_data/decks.js";
|
|
4
|
+
import type { MetadataByType, MetaTypes } from "../hearthstone/game_data/metadata.js";
|
|
5
|
+
import type { SearchParameters } from "../hearthstone/search.js";
|
|
6
|
+
/**
|
|
7
|
+
* Hearthstone endpoints.
|
|
8
|
+
*/
|
|
9
|
+
export interface HearthstoneApi {
|
|
10
|
+
/**
|
|
11
|
+
* Returns the card with an ID or slug that matches the one you specify.
|
|
12
|
+
*
|
|
13
|
+
* @param idorslug - The unique identifier for the card by slug.
|
|
14
|
+
* @returns A promise that resolves to an object representing details about a card.
|
|
15
|
+
*/
|
|
16
|
+
fetchCard(idorslug: string, gameMode?: string): Promise<Card>;
|
|
17
|
+
/**
|
|
18
|
+
* Returns the card back with an ID or slug that matches the one you specify.
|
|
19
|
+
*
|
|
20
|
+
* @param idorslug - The unique identifier for the card back by slug.
|
|
21
|
+
* @returns A promise that resolves to an object representing details about a card back.
|
|
22
|
+
*/
|
|
23
|
+
fetchCardback(idorslug: string): Promise<Cardback>;
|
|
24
|
+
/**
|
|
25
|
+
* Returns the card with an ID or slug that matches the one you specify.
|
|
26
|
+
*
|
|
27
|
+
* @param options - find parameters fort the search.
|
|
28
|
+
* @returns A promise that resolves to an object representing details about a card.
|
|
29
|
+
*/
|
|
30
|
+
fetchDeck(options?: Options): Promise<Deck>;
|
|
31
|
+
/**
|
|
32
|
+
* Returns information about the categorization of cards. Metadata includes the card set, set group (for example, Standard or Year of the Dragon), rarity, class, card type, minion type, and keywords.
|
|
33
|
+
*
|
|
34
|
+
* @returns A promise that resolves to an object representing the Metadata.
|
|
35
|
+
*/
|
|
36
|
+
metadata<T extends MetaTypes>(type: T): Promise<MetadataByType[T]>;
|
|
37
|
+
/**
|
|
38
|
+
* Returns an up-to-date list of all card backs matching the search criteria.
|
|
39
|
+
*
|
|
40
|
+
* @param SearchParameters - Object containing search parameters.
|
|
41
|
+
* @returns A promise that resolves to an object representing an up-to-date list of all card backs matching the search criteria.
|
|
42
|
+
*/
|
|
43
|
+
searchCardbacks(searchParameters: SearchParameters): Promise<CardbackSearch>;
|
|
44
|
+
/**
|
|
45
|
+
* Returns an up-to-date list of all cards matching the search criteria.
|
|
46
|
+
*
|
|
47
|
+
* @param SearchParameters - Object containing search parameters.
|
|
48
|
+
* @returns A promise that resolves to an object representing an up-to-date list of all cards matching the search criteria.
|
|
49
|
+
*/
|
|
50
|
+
searchCards(searchParameters: SearchParameters): Promise<CardSearch>;
|
|
51
|
+
}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import type { League } from "../starcraft2/game_data/league.js";
|
|
2
|
+
import type { Sc2GrandmasterLeaderboard, Sc2Season } from "../starcraft2/community/ladder.js";
|
|
3
|
+
import type { Sc2Ladder, Sc2LadderSummary, Sc2PlayerProfile, Sc2ProfileMetadata, Sc2StaticProfile } from "../starcraft2/community/profile.js";
|
|
4
|
+
import type { Sc2LegacyAchievements, Sc2LegacyLadder, Sc2LegacyLadders, Sc2LegacyMatches, Sc2LegacyProfile, Sc2LegacyRewards } from "../starcraft2/community/legacy.js";
|
|
5
|
+
import type { Sc2Player } from "../starcraft2/community/account.js";
|
|
6
|
+
/**
|
|
7
|
+
* StarCraft II endpoints.
|
|
8
|
+
*/
|
|
9
|
+
export interface Sc2Api {
|
|
10
|
+
/**
|
|
11
|
+
* Returns the grandmaster leaderboard for a region.
|
|
12
|
+
*
|
|
13
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
14
|
+
* @returns A promise that resolves to an object representing the grandmaster leaderboard.
|
|
15
|
+
*/
|
|
16
|
+
grandmasterLeaderboard(regionId: number): Promise<Sc2GrandmasterLeaderboard>;
|
|
17
|
+
/**
|
|
18
|
+
* Returns a StarCraft II ladder.
|
|
19
|
+
*
|
|
20
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
21
|
+
* @param realmId - The realm: 1 or 2.
|
|
22
|
+
* @param profileId - The unique identifier for the profile.
|
|
23
|
+
* @param ladderId - The unique identifier for the ladder.
|
|
24
|
+
* @returns A promise that resolves to an object representing the ladder.
|
|
25
|
+
*/
|
|
26
|
+
ladder(regionId: number, realmId: number, profileId: number, ladderId: string): Promise<Sc2Ladder>;
|
|
27
|
+
/**
|
|
28
|
+
* Returns the ladder summary of a StarCraft II profile.
|
|
29
|
+
*
|
|
30
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
31
|
+
* @param realmId - The realm: 1 or 2.
|
|
32
|
+
* @param profileId - The unique identifier for the profile.
|
|
33
|
+
* @returns A promise that resolves to an object representing the ladder summary.
|
|
34
|
+
*/
|
|
35
|
+
ladderSummary(regionId: number, realmId: number, profileId: number): Promise<Sc2LadderSummary>;
|
|
36
|
+
/**
|
|
37
|
+
* Returns data for the specified season, queue, team, and league.
|
|
38
|
+
*
|
|
39
|
+
* Notes from the battle.net docs:
|
|
40
|
+
* queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
|
|
41
|
+
* teamType: there are two available teamTypes: 0=arranged, 1=random.
|
|
42
|
+
* leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
|
|
43
|
+
*
|
|
44
|
+
* @param seasonId - The season ID of the data to retrieve.
|
|
45
|
+
* @param queueId - The queue ID of the data to retrieve.
|
|
46
|
+
* @param teamType - The team type of the data to retrieve.
|
|
47
|
+
* @param leagueId - The league ID of the data to retrieve.
|
|
48
|
+
* @returns A promise that resolves to an object representing the data for a league.
|
|
49
|
+
*/
|
|
50
|
+
leagueData(seasonId: number, queueId: number, teamType: number, leagueId: number): Promise<League>;
|
|
51
|
+
/**
|
|
52
|
+
* Returns the legacy StarCraft II achievements for a region.
|
|
53
|
+
*
|
|
54
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
55
|
+
* @returns A promise that resolves to an object representing the legacy achievements.
|
|
56
|
+
*/
|
|
57
|
+
legacyAchievements(regionId: number): Promise<Sc2LegacyAchievements>;
|
|
58
|
+
/**
|
|
59
|
+
* Returns a legacy StarCraft II ladder.
|
|
60
|
+
*
|
|
61
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
62
|
+
* @param ladderId - The unique identifier for the ladder.
|
|
63
|
+
* @returns A promise that resolves to an object representing the legacy ladder.
|
|
64
|
+
*/
|
|
65
|
+
legacyLadder(regionId: number, ladderId: string): Promise<Sc2LegacyLadder>;
|
|
66
|
+
/**
|
|
67
|
+
* Returns the legacy StarCraft II ladders of a player.
|
|
68
|
+
*
|
|
69
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
70
|
+
* @param realmId - The realm: 1 or 2.
|
|
71
|
+
* @param profileId - The unique identifier for the profile.
|
|
72
|
+
* @returns A promise that resolves to an object representing the legacy ladders.
|
|
73
|
+
*/
|
|
74
|
+
legacyLadders(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyLadders>;
|
|
75
|
+
/**
|
|
76
|
+
* Returns the legacy StarCraft II matches of a player.
|
|
77
|
+
*
|
|
78
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
79
|
+
* @param realmId - The realm: 1 or 2.
|
|
80
|
+
* @param profileId - The unique identifier for the profile.
|
|
81
|
+
* @returns A promise that resolves to an object representing the legacy matches.
|
|
82
|
+
*/
|
|
83
|
+
legacyMatches(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyMatches>;
|
|
84
|
+
/**
|
|
85
|
+
* Returns the legacy StarCraft II profile of a player.
|
|
86
|
+
*
|
|
87
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
88
|
+
* @param realmId - The realm: 1 or 2.
|
|
89
|
+
* @param profileId - The unique identifier for the profile.
|
|
90
|
+
* @returns A promise that resolves to an object representing the legacy profile.
|
|
91
|
+
*/
|
|
92
|
+
legacyProfile(regionId: number, realmId: number, profileId: number): Promise<Sc2LegacyProfile>;
|
|
93
|
+
/**
|
|
94
|
+
* Returns the legacy StarCraft II rewards for a region.
|
|
95
|
+
*
|
|
96
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
97
|
+
* @returns A promise that resolves to an object representing the legacy rewards.
|
|
98
|
+
*/
|
|
99
|
+
legacyRewards(regionId: number): Promise<Sc2LegacyRewards>;
|
|
100
|
+
/**
|
|
101
|
+
* Returns the metadata of a StarCraft II profile.
|
|
102
|
+
*
|
|
103
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
104
|
+
* @param realmId - The realm: 1 or 2.
|
|
105
|
+
* @param profileId - The unique identifier for the profile.
|
|
106
|
+
* @returns A promise that resolves to an object representing the profile metadata.
|
|
107
|
+
*/
|
|
108
|
+
metadataProfile(regionId: number, realmId: number, profileId: number): Promise<Sc2ProfileMetadata>;
|
|
109
|
+
/**
|
|
110
|
+
* Returns the StarCraft II players linked to an account.
|
|
111
|
+
*
|
|
112
|
+
* @param accountId - The unique identifier for the account.
|
|
113
|
+
* @returns A promise that resolves to an array of players linked to the account.
|
|
114
|
+
*/
|
|
115
|
+
player(accountId: number): Promise<Sc2Player[]>;
|
|
116
|
+
/**
|
|
117
|
+
* Returns a StarCraft II profile.
|
|
118
|
+
*
|
|
119
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
120
|
+
* @param realmId - The realm: 1 or 2.
|
|
121
|
+
* @param profileId - The unique identifier for the profile.
|
|
122
|
+
* @returns A promise that resolves to an object representing the profile.
|
|
123
|
+
*/
|
|
124
|
+
profile(regionId: number, realmId: number, profileId: number): Promise<Sc2PlayerProfile>;
|
|
125
|
+
/**
|
|
126
|
+
* Returns the current season for a region.
|
|
127
|
+
*
|
|
128
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
129
|
+
* @returns A promise that resolves to an object representing the season.
|
|
130
|
+
*/
|
|
131
|
+
season(regionId: number): Promise<Sc2Season>;
|
|
132
|
+
/**
|
|
133
|
+
* Returns the static StarCraft II profile data (achievements, criteria, categories and rewards) for a region.
|
|
134
|
+
*
|
|
135
|
+
* @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
|
|
136
|
+
* @returns A promise that resolves to an object representing the static profile data.
|
|
137
|
+
*/
|
|
138
|
+
staticProfile(regionId: number): Promise<Sc2StaticProfile>;
|
|
139
|
+
}
|