@pinta365/blizzard_api 0.4.0 → 0.6.0

package/script/src/wow/game_data/talent.d.ts

@@ -0,0 +1,143 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyName, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface TalentTrees extends LinkSelfHref {
+    spec_talent_trees: KeyName[];
+    class_talent_trees: KeyName[];
+    hero_talent_trees: KeyNameId[];
+}
+export interface SpellTooltip {
+    spell: KeyNameId;
+    description: string;
+    cast_time: string;
+    power_cost?: string;
+    range?: string;
+    cooldown?: string;
+}
+export interface Tooltip {
+    talent: KeyNameId;
+    spell_tooltip: SpellTooltip;
+}
+export interface Rank {
+    rank: number;
+    tooltip?: Tooltip;
+    choice_of_tooltips?: Tooltip[];
+    default_points?: number;
+}
+export interface NodeType {
+    id: number;
+    type: string;
+}
+export interface TalentNode {
+    id: number;
+    locked_by?: number[];
+    unlocks?: number[];
+    node_type: NodeType;
+    ranks: Rank[];
+    display_row: number;
+    display_col: number;
+    raw_position_x: number;
+    raw_position_y: number;
+}
+export interface HeroTalentTree {
+    id: number;
+    name: string;
+    media: KeyId;
+    playable_class?: KeyNameId;
+    playable_specializations?: KeyNameId[];
+    hero_talent_nodes: TalentNode[];
+}
+export interface TalentTree extends LinkSelfHref {
+    id: number;
+    playable_class: KeyNameId;
+    playable_specialization: KeyNameId;
+    name: LocalizedString;
+    media: {
+        key: {
+            href: string;
+        };
+    };
+    restriction_lines: {
+        required_points: number;
+        restricted_row: number;
+        is_for_class: boolean;
+    }[];
+    class_talent_nodes: TalentNode[];
+    spec_talent_nodes: TalentNode[];
+    hero_talent_trees: HeroTalentTree[];
+}
+export interface TalentTreeNodes extends LinkSelfHref {
+    id: number;
+    spec_talent_trees?: KeyName[];
+    talent_nodes?: TalentNode[];
+}
+export interface Talents extends LinkSelfHref {
+    talents: KeyNameId[];
+}
+export interface Talent extends LinkSelfHref {
+    id: number;
+    rank_descriptions: {
+        rank: number;
+        description: LocalizedString | null;
+    }[];
+    spell: KeyNameId;
+    playable_class: KeyId;
+    playable_specialization?: KeyNameId;
+}
+export interface PvpTalents extends LinkSelfHref {
+    pvp_talents: KeyNameId[];
+}
+export interface PvpTalent extends LinkSelfHref {
+    id: number;
+    spell: KeyNameId;
+    playable_specialization: KeyNameId;
+    description: LocalizedString;
+    unlock_player_level: number;
+    compatible_slots: number[];
+}
+/**
+ * Returns an index of talent trees.
+ *
+ * @returns A promise that resolves to an object representing a list of talent trees.
+ */
+export declare function talentTrees(ctx: ApiContext): Promise<TalentTrees>;
+/**
+ * Returns a talent tree by specialization ID.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @param specId - The unique identifier for the specialization.
+ * @returns A promise that resolves to an object representing details about a talent tree.
+ */
+export declare function talentTree(ctx: ApiContext, talentTreeId: number, specId: number): Promise<TalentTree>;
+/**
+ * Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @returns A promise that resolves to an object representing details about the talent tree nodes.
+ */
+export declare function talentTreeNodes(ctx: ApiContext, talentTreeId: number): Promise<TalentTreeNodes>;
+/**
+ * Returns an index of talents.
+ *
+ * @returns A promise that resolves to an object representing a list of talents.
+ */
+export declare function talents(ctx: ApiContext): Promise<Talents>;
+/**
+ * Returns a talent by ID.
+ *
+ * @param talentId - The unique identifier for the talent.
+ * @returns A promise that resolves to an object representing details about the talent.
+ */
+export declare function talent(ctx: ApiContext, talentId: number): Promise<Talent>;
+/**
+ * Returns an index of PvP talents.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP talents.
+ */
+export declare function pvpTalents(ctx: ApiContext): Promise<PvpTalents>;
+/**
+ * Returns a PvP talent by ID.
+ *
+ * @param pvpTalentId - The unique identifier for the PvP talent.
+ * @returns A promise that resolves to an object representing details about the PvP talent.
+ */
+export declare function pvpTalent(ctx: ApiContext, pvpTalentId: number): Promise<PvpTalent>;

package/script/src/wow/game_data/talent.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.talentTrees = talentTrees;
+exports.talentTree = talentTree;
+exports.talentTreeNodes = talentTreeNodes;
+exports.talents = talents;
+exports.talent = talent;
+exports.pvpTalents = pvpTalents;
+exports.pvpTalent = pvpTalent;
+/**
+ * Returns an index of talent trees.
+ *
+ * @returns A promise that resolves to an object representing a list of talent trees.
+ */
+async function talentTrees(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/talent-tree/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a talent tree by specialization ID.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @param specId - The unique identifier for the specialization.
+ * @returns A promise that resolves to an object representing details about a talent tree.
+ */
+async function talentTree(ctx, talentTreeId, specId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/talent-tree/${talentTreeId}/playable-specialization/${specId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @returns A promise that resolves to an object representing details about the talent tree nodes.
+ */
+async function talentTreeNodes(ctx, talentTreeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/talent-tree/${talentTreeId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of talents.
+ *
+ * @returns A promise that resolves to an object representing a list of talents.
+ */
+async function talents(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/talent/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a talent by ID.
+ *
+ * @param talentId - The unique identifier for the talent.
+ * @returns A promise that resolves to an object representing details about the talent.
+ */
+async function talent(ctx, talentId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/talent/${talentId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of PvP talents.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP talents.
+ */
+async function pvpTalents(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/pvp-talent/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a PvP talent by ID.
+ *
+ * @param pvpTalentId - The unique identifier for the PvP talent.
+ * @returns A promise that resolves to an object representing details about the PvP talent.
+ */
+async function pvpTalent(ctx, pvpTalentId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-talent/${pvpTalentId}`,
+        namespace: "static",
+    });
+}

package/script/src/wow/game_data/tech_talent.d.ts

@@ -0,0 +1,72 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface TechTalentTreeRef {
+    key: {
+        href: string;
+    };
+    name?: LocalizedString;
+    id: number;
+}
+export interface TechTalentTrees extends LinkSelfHref {
+    talent_trees: TechTalentTreeRef[];
+}
+export interface TechTalentTree extends LinkSelfHref {
+    id: number;
+    max_tiers: number;
+    playable_class: KeyNameId;
+    talents: KeyNameId[];
+}
+export interface TechTalents extends LinkSelfHref {
+    talents: KeyNameId[];
+}
+export interface TechTalent extends LinkSelfHref {
+    id: number;
+    talent_tree: KeyId;
+    name: LocalizedString;
+    description?: LocalizedString;
+    spell_tooltip?: {
+        spell: KeyNameId;
+        description: LocalizedString;
+        cast_time: LocalizedString;
+    };
+    tier: number;
+    display_order: number;
+    prerequisite_talent?: KeyNameId;
+    media: KeyId;
+}
+export interface TechTalentMedia extends LinkSelfHref {
+    assets: Asset[];
+}
+/**
+ * Returns an index of tech talent trees.
+ *
+ * @returns A promise that resolves to an object representing a list of tech talents trees
+ */
+export declare function techTalentTrees(ctx: ApiContext): Promise<TechTalentTrees>;
+/**
+ * Returns a tech talent tree by ID.
+ *
+ * @param techTalentTreeId - The unique identifier for the tech talent tree.
+ * @returns A promise that resolves to an object representing details about the tech talent tree.
+ */
+export declare function techTalentTree(ctx: ApiContext, techTalentTreeId: number): Promise<TechTalentTree>;
+/**
+ * Returns an index of tech talents.
+ *
+ * @returns A promise that resolves to an object representing a list of tech talents trees
+ */
+export declare function techTalents(ctx: ApiContext): Promise<TechTalents>;
+/**
+ * Returns a tech talent by ID.
+ *
+ * @param techTalentId - The unique identifier for the tech talent tree.
+ * @returns A promise that resolves to an object representing details about the tech talent tree.
+ */
+export declare function techTalent(ctx: ApiContext, techTalentId: number): Promise<TechTalent>;
+/**
+ * Returns media for a tech talent by ID.
+ *
+ * @param techTalentId - The unique identifier for the tech talent.
+ * @returns A promise that resolves to an object representing details about a tech talent.
+ */
+export declare function techTalentMedia(ctx: ApiContext, techTalentId: number): Promise<TechTalentMedia>;

package/script/src/wow/game_data/tech_talent.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.techTalentTrees = techTalentTrees;
+exports.techTalentTree = techTalentTree;
+exports.techTalents = techTalents;
+exports.techTalent = techTalent;
+exports.techTalentMedia = techTalentMedia;
+/**
+ * Returns an index of tech talent trees.
+ *
+ * @returns A promise that resolves to an object representing a list of tech talents trees
+ */
+async function techTalentTrees(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/tech-talent-tree/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a tech talent tree by ID.
+ *
+ * @param techTalentTreeId - The unique identifier for the tech talent tree.
+ * @returns A promise that resolves to an object representing details about the tech talent tree.
+ */
+async function techTalentTree(ctx, techTalentTreeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/tech-talent-tree/${techTalentTreeId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of tech talents.
+ *
+ * @returns A promise that resolves to an object representing a list of tech talents trees
+ */
+async function techTalents(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/tech-talent/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a tech talent by ID.
+ *
+ * @param techTalentId - The unique identifier for the tech talent tree.
+ * @returns A promise that resolves to an object representing details about the tech talent tree.
+ */
+async function techTalent(ctx, techTalentId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/tech-talent/${techTalentId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a tech talent by ID.
+ *
+ * @param techTalentId - The unique identifier for the tech talent.
+ * @returns A promise that resolves to an object representing details about a tech talent.
+ */
+async function techTalentMedia(ctx, techTalentId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/tech-talent/${techTalentId}`,
+        namespace: "static",
+    });
+}

package/script/src/wow/game_data/title.d.ts

@@ -0,0 +1,33 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyNameId, LinkSelfHref, LocalizedString, NamedRef } from "../../shared/index.js";
+export interface Titles extends LinkSelfHref {
+    titles: KeyNameId[];
+}
+export interface Title extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    gender_name: {
+        male: LocalizedString;
+        female: LocalizedString;
+    };
+    source: {
+        type: {
+            type: string;
+            name: string;
+        };
+        achievements: NamedRef[];
+    };
+}
+/**
+ * Returns an index of titles.
+ *
+ * @returns A promise that resolves to an object representing a list of titles.
+ */
+export declare function titles(ctx: ApiContext): Promise<Titles>;
+/**
+ * Returns a title by ID.
+ *
+ * @param titleId - The unique identifier for the title.
+ * @returns A promise that resolves to an object representing details about a title.
+ */
+export declare function title(ctx: ApiContext, titleId: number): Promise<Title>;

package/script/src/wow/game_data/title.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.titles = titles;
+exports.title = title;
+/**
+ * Returns an index of titles.
+ *
+ * @returns A promise that resolves to an object representing a list of titles.
+ */
+async function titles(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/title/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a title by ID.
+ *
+ * @param titleId - The unique identifier for the title.
+ * @returns A promise that resolves to an object representing details about a title.
+ */
+async function title(ctx, titleId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/title/${titleId}`,
+        namespace: "static",
+    });
+}

package/script/src/wow/game_data/token.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft Token prices from the Blizzard API.
+ *
+ * @author Pinta <https://github.com/Pinta365>
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref } from "../../shared/index.js";
+export interface WowToken extends LinkSelfHref {
+    last_updated_timestamp: number;
+    price: number;
+}
+/**
+ * Fetches and returns last known price and last updated timestamp for a wow token.
+ *
+ * @returns A promise that resolves to an object representing price and last updated timestamp.
+ */
+export declare function token(ctx: ApiContext): Promise<WowToken>;

package/script/src/wow/game_data/token.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft Token prices from the Blizzard API.
+ *
+ * @author Pinta <https://github.com/Pinta365>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.token = token;
+/**
+ * Fetches and returns last known price and last updated timestamp for a wow token.
+ *
+ * @returns A promise that resolves to an object representing price and last updated timestamp.
+ */
+async function token(ctx) {
+    const tokenData = await ctx.request({
+        method: "GET",
+        url: "/data/wow/token/index",
+        namespace: "dynamic",
+    });
+    return tokenData;
+}

package/script/src/wow/game_data/toy.d.ts

@@ -0,0 +1,25 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+export interface Toys extends LinkSelfHref {
+    toys: KeyNameId[];
+}
+export interface Toy extends LinkSelfHref {
+    id: number;
+    item: KeyNameId;
+    source: TypeName;
+    should_exclude_if_uncollected: boolean;
+    media: KeyId;
+}
+/**
+ * Returns an index of toys.
+ *
+ * @returns A promise that resolves to an object representing a list of toys.
+ */
+export declare function toys(ctx: ApiContext): Promise<Toys>;
+/**
+ * Returns a toy by id.
+ *
+ * @param toyId - The unique identifier for the toy.
+ * @returns A promise that resolves to an object representing details about a toy.
+ */
+export declare function toy(ctx: ApiContext, toyId: number): Promise<Toy>;

package/script/src/wow/game_data/toy.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toys = toys;
+exports.toy = toy;
+/**
+ * Returns an index of toys.
+ *
+ * @returns A promise that resolves to an object representing a list of toys.
+ */
+async function toys(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/toy/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a toy by id.
+ *
+ * @param toyId - The unique identifier for the toy.
+ * @returns A promise that resolves to an object representing details about a toy.
+ */
+async function toy(ctx, toyId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/toy/${toyId}`,
+        namespace: "static",
+    });
+}

package/script/src/wow/index.d.ts

@@ -0,0 +1,59 @@
+export type { SearchParameters } from "./search.js";
+export { achievement, achievementCategories, achievementCategory, achievementMedia, achievements, } from "./game_data/achievement.js";
+export { auctions, commodities } from "./game_data/auction_house.js";
+export { azeriteEssence, azeriteEssenceMedia, azeriteEssences, searchAzeriteEssence, } from "./game_data/azerite_essence.js";
+export { connectedRealm, connectedRealms, searchConnectedRealm } from "./game_data/connected_realm.js";
+export { covenant, covenantConduit, covenantConduits, covenants, covenantSoulbind, covenantSoulbinds, } from "./game_data/covenant.js";
+export { creature, creatureDisplayMedia, creatureFamilies, creatureFamily, creatureFamilyMedia, creatureType, creatureTypes, searchCreature, } from "./game_data/creature.js";
+export { guildCrestBorder, guildCrestEmblem, guildCrests } from "./game_data/guild_crest.js";
+export { heirloom, heirlooms } from "./game_data/heirloom.js";
+export { decor, decors, fixture, fixtureHook, fixtureHooks, fixtures, room, rooms, searchDecor, searchFixture, searchFixtureHook, searchRoom, } from "./game_data/housing.js";
+export { item, itemClass, itemClasses, itemMedia, itemSet, itemSets, itemSubclass, searchItem, } from "./game_data/item.js";
+export { itemAppearance, itemAppearanceSet, itemAppearanceSets, itemAppearanceSlot, itemAppearanceSlots, searchItemAppearance, } from "./game_data/item_appearance.js";
+export { searchMedia } from "./game_data/media_search.js";
+export { journalEncounter, journalEncounters, journalExpansion, journalExpansions, journalInstance, journalInstanceMedia, journalInstances, searchJournalEncounter, } from "./game_data/journal.js";
+export { modifiedCraftingCategories, modifiedCraftingCategory, modifiedCraftingParents, modifiedCraftingSlotType, modifiedCraftingSlotTypes, } from "./game_data/modified_crafting.js";
+export { mount, mounts, searchMount } from "./game_data/mount.js";
+export { keystoneAffix, keystoneAffixes, keystoneAffixMedia } from "./game_data/keystone_affix.js";
+export { mythicKeystoneDungeon, mythicKeystoneDungeons, mythicKeystoneIndex, mythicKeystonePeriod, mythicKeystonePeriods, mythicKeystoneSeason, mythicKeystoneSeasons, } from "./game_data/mythic_keystone_dungeon.js";
+export { mythicKeystoneLeaderboard, mythicKeystoneLeaderboards } from "./game_data/mythic_keystone_leaderboard.js";
+export { mythicRaidLeaderboard } from "./game_data/mythic_raid_leaderboard.js";
+export { neighborhood, neighborhoodMap, neighborhoodMaps } from "./game_data/neighborhood.js";
+export { pet, petAbilities, petAbility, petAbilityMedia, petMedia, pets } from "./game_data/pet.js";
+export { playableClass, playableClasses, playableClassMedia, playableClassPvpTalentSlots, } from "./game_data/playable_class.js";
+export { playableSpecialization, playableSpecializationMedia, playableSpecializations, } from "./game_data/playable_specialization.js";
+export { playableRace, playableRaces } from "./game_data/playable_race.js";
+export { powerType, powerTypes } from "./game_data/power_type.js";
+export { profession, professionMedia, professionRecipie, professionRecipieMedia, professions, professionSkillTier, } from "./game_data/profession.js";
+export { pvpSeason, pvpSeasonLeaderboard, pvpSeasonLeaderboards, pvpSeasonRewards, pvpSeasons, } from "./game_data/pvp_season.js";
+export { pvpTier, pvpTierMedia, pvpTiers } from "./game_data/pvp_tier.js";
+export { quest, questArea, questAreas, questCategories, questCategory, quests, questType, questTypes, } from "./game_data/quest.js";
+export { realm, realms, searchRealm } from "./game_data/realm.js";
+export { region, regions } from "./game_data/region.js";
+export { reputationFaction, reputationFactions, reputationTier, reputationTiers } from "./game_data/reputations.js";
+export { searchSpell, spell, spellMedia } from "./game_data/spell.js";
+export { title, titles } from "./game_data/title.js";
+export { toy, toys } from "./game_data/toy.js";
+export { pvpTalent, pvpTalents, talent, talents, talentTree, talentTreeNodes, talentTrees, } from "./game_data/talent.js";
+export { techTalent, techTalentMedia, techTalents, techTalentTree, techTalentTrees } from "./game_data/tech_talent.js";
+export { token } from "./game_data/token.js";
+export { characterAchievementStatistics, characterAchievementSummary } from "./profile/character_achievements.js";
+export { accountCollectionsIndex, accountDecorCollection, accountHeirloomsCollection, accountMountsCollection, accountPetsCollection, accountProfileSummary, accountToysCollection, accountTransmogsCollection, protectedCharacterProfile, } from "./profile/account_profile.js";
+export { characterAppearanceSummary } from "./profile/character_appearance.js";
+export { characterCollectionDecor, characterCollectionHeirlooms, characterCollectionMounts, characterCollectionPets, characterCollectionToys, characterCollectionTransmogs, characterCollectionTypes, } from "./profile/character_collections.js";
+export { characterHouse } from "./profile/character_house.js";
+export { characterEncounterDungeons, characterEncounterRaids, characterEncounters, } from "./profile/character_encounters.js";
+export { characterEquipments } from "./profile/character_equipment.js";
+export { characterHunterPets } from "./profile/character_hunter_pets.js";
+export { characterMedia } from "./profile/character_media.js";
+export { characterMythicKeystoneProfile, characterMythicKeystoneSeasonDetails, } from "./profile/character_mythic_keystone_profile.js";
+export { characterProfessions } from "./profile/character_professions.js";
+export { characterProfile, characterProfileStatus } from "./profile/character_profile.js";
+export { characterPvpBracketStatistics, characterPvpSummary } from "./profile/character_pvp.js";
+export { characterCompletedQuests, characterQuests } from "./profile/character_quests.js";
+export { characterReputations } from "./profile/character_reputations.js";
+export { characterSoulbinds } from "./profile/character_soulbinds.js";
+export { characterSpecializations } from "./profile/character_specializations.js";
+export { characterStatistics } from "./profile/character_statistics.js";
+export { characterTitles } from "./profile/character_titles.js";
+export { guild, guildAchievements, guildActivity, guildRoster } from "./profile/guild.js";