@pinta365/blizzard_api 0.4.0 → 0.6.0

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playableClasses = playableClasses;
+exports.playableClass = playableClass;
+exports.playableClassMedia = playableClassMedia;
+exports.playableClassPvpTalentSlots = playableClassPvpTalentSlots;
+/**
+ * Returns an index of playable classes.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of playable classes.
+ */
+async function playableClasses(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/playable-class/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a playable class by ID.
+ *
+ * @param classId - The unique identifier for the playable class
+ * @returns A promise that resolves to an object representing details about a playable class.
+ */
+async function playableClass(ctx, classId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/playable-class/${classId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a playable class by ID.
+ *
+ * @param playableClassId - The unique identifier for the playable class
+ * @returns A promise that resolves to an object representing media details about a playable class.
+ */
+async function playableClassMedia(ctx, playableClassId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/playable-class/${playableClassId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns the PvP talent slots for a playable class by ID.
+ *
+ * @param classId - The unique identifier for the playable class
+ * @returns A promise that resolves to an object representing PvP talent slots for a playable class.
+ */
+async function playableClassPvpTalentSlots(ctx, classId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/playable-class/${classId}/pvp-talent-slots`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,31 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyNameId, LinkSelfHref, LocalizedString, NamedRef, TypeName } from "../../shared/index.js";
+export interface PlayableRaces extends LinkSelfHref {
+    races: KeyNameId[];
+}
+export interface PlayableRace extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    gender_name: {
+        male: LocalizedString;
+        female: LocalizedString;
+    };
+    faction: TypeName;
+    is_selectable: boolean;
+    is_allied_race: boolean;
+    playable_classes: KeyNameId[];
+    racial_spells: NamedRef[];
+}
+/**
+ * Returns an index of playable races.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of playable races.
+ */
+export declare function playableRaces(ctx: ApiContext): Promise<PlayableRaces>;
+/**
+ * Returns a playable race by ID.
+ *
+ * @param playableRaceId - The unique identifier for the playable race
+ * @returns A promise that resolves to an object representing details about a playable race.
+ */
+export declare function playableRace(ctx: ApiContext, playableRaceId: number): Promise<PlayableRace>;

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

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

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

@@ -0,0 +1,63 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyName, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, TypeName } from "../../shared/index.js";
+export interface PlayableSpecializations extends LinkSelfHref {
+    character_specializations: NamedRef[];
+    pet_specializations: NamedRef[];
+}
+export interface PlayableSpecialization extends LinkSelfHref {
+    id: number;
+    playable_class: KeyNameId;
+    /** Hero talent trees available to this specialization (Retail). */
+    hero_talent_trees?: NamedRef[];
+    name: LocalizedString;
+    gender_description: {
+        male: LocalizedString;
+        female: LocalizedString;
+    };
+    media: KeyId;
+    role: TypeName;
+    pvp_talents?: {
+        talent: KeyNameId;
+        spell_tooltip: {
+            description: LocalizedString;
+            cast_time?: LocalizedString;
+            range?: LocalizedString;
+            cooldown?: LocalizedString;
+            power_cost?: LocalizedString;
+        };
+    }[];
+    spec_talent_tree?: KeyName;
+    /** Talent tiers (Classic). */
+    talent_tiers?: {
+        level: number;
+        talents?: {
+            talent: KeyNameId;
+        }[];
+    }[];
+    power_type: KeyNameId;
+    primary_stat_type: TypeName;
+}
+export interface PlayableSpecializationMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns an index of playable specializations.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of playable specializations.
+ */
+export declare function playableSpecializations(ctx: ApiContext): Promise<PlayableSpecializations>;
+/**
+ * Returns a playable specialization by ID.
+ *
+ * @param specId - The unique identifier for the playable specialization
+ * @returns A promise that resolves to an object representing details about a playable specialization.
+ */
+export declare function playableSpecialization(ctx: ApiContext, specId: number): Promise<PlayableSpecialization>;
+/**
+ * Returns media for a playable specialization by ID.
+ *
+ * @param specId - The unique identifier for the playable specialization
+ * @returns A promise that resolves to an object representing media details about a playable specialization.
+ */
+export declare function playableSpecializationMedia(ctx: ApiContext, specId: number): Promise<PlayableSpecializationMedia>;

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

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

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

@@ -0,0 +1,22 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface PowerTypes extends LinkSelfHref {
+    power_types: KeyNameId[];
+}
+export interface PowerType extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+}
+/**
+ * Returns an index of power types.
+ *
+ * @returns A promise that resolves to an object representing a list of power types.
+ */
+export declare function powerTypes(ctx: ApiContext): Promise<PowerTypes>;
+/**
+ * Returns a power type by ID.
+ *
+ * @param powerTypeId - The unique identifier for the power type.
+ * @returns A promise that resolves to an object representing details about a power type.
+ */
+export declare function powerType(ctx: ApiContext, powerTypeId: number): Promise<PowerType>;

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

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

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

@@ -0,0 +1,88 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Professions extends LinkSelfHref {
+    professions: KeyNameId[];
+}
+export interface Profession extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    type: TypeName;
+    media: KeyId;
+    skill_tiers: KeyNameId[];
+}
+export interface ProfessionMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+export interface ProfessionSkillTier extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    minimum_skill_level: number;
+    maximum_skill_level: number;
+    categories: {
+        name: LocalizedString;
+        recipes: KeyNameId[];
+    }[];
+}
+export interface ProfessionRecipie extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description?: LocalizedString;
+    rank: number;
+    media: KeyId;
+    crafted_item: KeyNameId;
+    reagents: {
+        reagent: KeyNameId;
+        quantity: number;
+    }[];
+    crafted_quantity: {
+        value: number;
+    };
+}
+export interface professionRecipieMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns an index of professions.
+ *
+ * @returns A promise that resolves to an object representing a list of professions.
+ */
+export declare function professions(ctx: ApiContext): Promise<Professions>;
+/**
+ * Returns a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession.
+ * @returns A promise that resolves to an object representing details about a profession.
+ */
+export declare function profession(ctx: ApiContext, professionId: number): Promise<Profession>;
+/**
+ * Returns media for a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession
+ * @returns A promise that resolves to an object representing media details about a profession.
+ */
+export declare function professionMedia(ctx: ApiContext, professionId: number): Promise<ProfessionMedia>;
+/**
+ * Returns a skill tier for a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession
+ * @param skillTierId - The unique identifier for the skill tier
+ * @returns A promise that resolves to an object representing details about a skill tier.
+ */
+export declare function professionSkillTier(ctx: ApiContext, professionId: number, skillTierId: number): Promise<ProfessionSkillTier>;
+/**
+ * Returns a recipe by ID.
+ *
+ * @param recipeId - The unique identifier for the recipe.
+ * @returns A promise that resolves to an object representing details about a recipe.
+ */
+export declare function professionRecipie(ctx: ApiContext, recipeId: number): Promise<ProfessionRecipie>;
+/**
+ * Returns media for a recipe by ID.
+ *
+ * @param recipeId - The unique identifier for the recipe
+ * @returns A promise that resolves to an object representing media details about a recipe.
+ */
+export declare function professionRecipieMedia(ctx: ApiContext, recipeId: number): Promise<professionRecipieMedia>;

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

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.professions = professions;
+exports.profession = profession;
+exports.professionMedia = professionMedia;
+exports.professionSkillTier = professionSkillTier;
+exports.professionRecipie = professionRecipie;
+exports.professionRecipieMedia = professionRecipieMedia;
+/**
+ * Returns an index of professions.
+ *
+ * @returns A promise that resolves to an object representing a list of professions.
+ */
+async function professions(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/profession/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession.
+ * @returns A promise that resolves to an object representing details about a profession.
+ */
+async function profession(ctx, professionId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/profession/${professionId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession
+ * @returns A promise that resolves to an object representing media details about a profession.
+ */
+async function professionMedia(ctx, professionId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/profession/${professionId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns a skill tier for a profession by ID.
+ *
+ * @param professionId - The unique identifier for the profession
+ * @param skillTierId - The unique identifier for the skill tier
+ * @returns A promise that resolves to an object representing details about a skill tier.
+ */
+async function professionSkillTier(ctx, professionId, skillTierId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/profession/${professionId}/skill-tier/${skillTierId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns a recipe by ID.
+ *
+ * @param recipeId - The unique identifier for the recipe.
+ * @returns A promise that resolves to an object representing details about a recipe.
+ */
+async function professionRecipie(ctx, recipeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/recipe/${recipeId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a recipe by ID.
+ *
+ * @param recipeId - The unique identifier for the recipe
+ * @returns A promise that resolves to an object representing media details about a recipe.
+ */
+async function professionRecipieMedia(ctx, recipeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/recipe/${recipeId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,108 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, KeyId, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+export interface PvpSeasons extends LinkSelfHref {
+    seasons: KeyId[];
+    current_season: KeyId;
+}
+export interface PvpSeason extends LinkSelfHref {
+    id: number;
+    leaderboards: {
+        href: string;
+    };
+    rewards: {
+        href: string;
+    };
+    season_name: string | null;
+    season_start_timestamp: number;
+    season_end_timestamp?: number;
+}
+export interface PvpSeasonLeaderboards extends LinkSelfHref {
+    season: KeyId;
+    /** Brackets are addressed by `name`; only some (e.g. 2v2, 3v3) carry an `id`. */
+    leaderboards: {
+        key: Href;
+        name: string;
+        id?: number;
+    }[];
+}
+export interface PvpSeasonLeaderboard extends LinkSelfHref {
+    season: KeyId;
+    name: string;
+    bracket: {
+        id: number;
+        type: string;
+    };
+    entries: {
+        character: {
+            name: string;
+            id: number;
+            realm: {
+                key: {
+                    href: string;
+                };
+                id: number;
+                slug: string;
+            };
+        };
+        faction: {
+            type: string;
+        };
+        rank: number;
+        rating: number;
+        season_match_statistics: {
+            played: number;
+            won: number;
+            lost: number;
+        };
+        tier: KeyId;
+    }[];
+}
+export interface PvpSeasonRewards extends LinkSelfHref {
+    season: KeyId;
+    rewards: {
+        bracket: {
+            id: number;
+            type: string;
+        };
+        achievement: KeyNameId;
+        rating_cutoff: number;
+        faction?: TypeName;
+        specialization?: KeyNameId;
+    }[];
+}
+/**
+ * Returns an index of PvP seasons.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP seasons.
+ */
+export declare function pvpSeasons(ctx: ApiContext): Promise<PvpSeasons>;
+/**
+ * Returns a PvP season by ID.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about a PvP season.
+ */
+export declare function pvpSeason(ctx: ApiContext, pvpSeasonId: number): Promise<PvpSeason>;
+/**
+ * Returns an index of PvP leaderboards for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about the PvP leaderboards.
+ */
+export declare function pvpSeasonLeaderboards(ctx: ApiContext, pvpSeasonId: number): Promise<PvpSeasonLeaderboards>;
+/**
+ * Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @param pvpBracket - The name of the PvP bracket (e.g. "2v2", "3v3", "rbg", "shuffle-overall"), as listed by
+ * pvpSeasonLeaderboards().
+ * @returns A promise that resolves to an object representing details about the PvP bracket.
+ */
+export declare function pvpSeasonLeaderboard(ctx: ApiContext, pvpSeasonId: number, pvpBracket: string): Promise<PvpSeasonLeaderboard>;
+/**
+ * Returns an index of PvP rewards for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about the PvP rewards.
+ */
+export declare function pvpSeasonRewards(ctx: ApiContext, pvpSeasonId: number): Promise<PvpSeasonRewards>;

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

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pvpSeasons = pvpSeasons;
+exports.pvpSeason = pvpSeason;
+exports.pvpSeasonLeaderboards = pvpSeasonLeaderboards;
+exports.pvpSeasonLeaderboard = pvpSeasonLeaderboard;
+exports.pvpSeasonRewards = pvpSeasonRewards;
+/**
+ * Returns an index of PvP seasons.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP seasons.
+ */
+async function pvpSeasons(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/pvp-season/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a PvP season by ID.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about a PvP season.
+ */
+async function pvpSeason(ctx, pvpSeasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-season/${pvpSeasonId}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns an index of PvP leaderboards for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about the PvP leaderboards.
+ */
+async function pvpSeasonLeaderboards(ctx, pvpSeasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @param pvpBracket - The name of the PvP bracket (e.g. "2v2", "3v3", "rbg", "shuffle-overall"), as listed by
+ * pvpSeasonLeaderboards().
+ * @returns A promise that resolves to an object representing details about the PvP bracket.
+ */
+async function pvpSeasonLeaderboard(ctx, pvpSeasonId, pvpBracket) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-season/${pvpSeasonId}/pvp-leaderboard/${pvpBracket}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns an index of PvP rewards for a PvP season.
+ *
+ * @param pvpSeasonId - The unique identifier for the PvP season.
+ * @returns A promise that resolves to an object representing details about the PvP rewards.
+ */
+async function pvpSeasonRewards(ctx, pvpSeasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-season/${pvpSeasonId}/pvp-reward/index`,
+        namespace: "dynamic",
+    });
+}

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

@@ -0,0 +1,41 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface PvpTierMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+export interface PvpTiers extends LinkSelfHref {
+    tiers: KeyNameId[];
+}
+export interface PvpTier extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    min_rating: number;
+    max_rating: number;
+    media: KeyId;
+    bracket: {
+        id: number;
+        type: string;
+    };
+    rating_type: number;
+}
+/**
+ * Returns media for a PvP tier by ID.
+ *
+ * @param pvpTierId - The unique identifier for the PvP tier
+ * @returns A promise that resolves to an object representing media details about a PvP tier.
+ */
+export declare function pvpTierMedia(ctx: ApiContext, pvpTierId: number): Promise<PvpTierMedia>;
+/**
+ * Returns an index of PvP tiers.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP tiers.
+ */
+export declare function pvpTiers(ctx: ApiContext): Promise<PvpTiers>;
+/**
+ * Returns a PvP tier by ID.
+ *
+ * @param pvpTierId - The unique identifier for the PvP tier.
+ * @returns A promise that resolves to an object representing details about a PvP tier.
+ */
+export declare function pvpTier(ctx: ApiContext, pvpTierId: number): Promise<PvpTier>;