@pinta365/blizzard_api 0.3.9 → 0.5.0

package/script/src/wow/profile/character_quests.d.ts

@@ -0,0 +1,29 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterQuests extends LinkSelfHref {
+    character: Character;
+    in_progress: KeyNameId[];
+    completed: {
+        href: string;
+    };
+}
+export interface CharacterCompletedQuests extends LinkSelfHref {
+    character: Character;
+    quests: KeyNameId[];
+}
+/**
+ * Returns a character's active quests as well as a link to the character's completed quests.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's active quests as well as a link to the character's completed quests.
+ */
+export declare function characterQuests(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterQuests>;
+/**
+ * Returns a list of quests that a character has completed.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a list of quests that a character has completed.
+ */
+export declare function characterCompletedQuests(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterCompletedQuests>;

package/script/src/wow/profile/character_quests.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterQuests = characterQuests;
+exports.characterCompletedQuests = characterCompletedQuests;
+/**
+ * Returns a character's active quests as well as a link to the character's completed quests.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's active quests as well as a link to the character's completed quests.
+ */
+async function characterQuests(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/quests`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a list of quests that a character has completed.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a list of quests that a character has completed.
+ */
+async function characterCompletedQuests(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/quests/completed`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_reputations.d.ts

@@ -0,0 +1,30 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface CharacterReputations extends LinkSelfHref {
+    character: Character;
+    reputations: {
+        faction: KeyNameId;
+        standing: {
+            raw: number;
+            value: number;
+            max: number;
+            tier?: number;
+            renown_level?: number;
+            name: LocalizedString;
+        };
+        /** Paragon progress, for factions at maximum standing that have a paragon track. */
+        paragon?: {
+            raw: number;
+            value: number;
+            max: number;
+        };
+    }[];
+}
+/**
+ * Returns a summary of a character's reputations.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's reputations.
+ */
+export declare function characterReputations(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterReputations>;

package/script/src/wow/profile/character_reputations.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterReputations = characterReputations;
+/**
+ * Returns a summary of a character's reputations.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's reputations.
+ */
+async function characterReputations(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/reputations`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_soulbinds.d.ts

@@ -0,0 +1,31 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+export interface CharacterSoulbinds extends LinkSelfHref {
+    character: Character;
+    chosen_covenant: KeyNameId;
+    renown_level: number;
+    soulbinds: {
+        soulbind: KeyNameId;
+        traits?: {
+            trait?: KeyNameId;
+            conduit_socket?: {
+                type: TypeName;
+                socket: {
+                    conduit: KeyNameId;
+                    rank: number;
+                };
+            };
+            tier: number;
+            display_order: number;
+        }[];
+        is_active?: boolean;
+    }[];
+}
+/**
+ * Returns a character's soulbinds.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's soulbinds.
+ */
+export declare function characterSoulbinds(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterSoulbinds>;

package/script/src/wow/profile/character_soulbinds.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterSoulbinds = characterSoulbinds;
+/**
+ * Returns a character's soulbinds.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a character's soulbinds.
+ */
+async function characterSoulbinds(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/soulbinds`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_specializations.d.ts

@@ -0,0 +1,82 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyId, KeyName, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, NameId } from "../../shared/index.js";
+export interface Detail {
+    talent: KeyId & {
+        name?: string;
+    };
+    spell_tooltip: {
+        spell: KeyId & {
+            name?: string;
+        };
+        description?: LocalizedString | null;
+        cast_time?: LocalizedString;
+        power_cost?: LocalizedString;
+        cooldown?: LocalizedString;
+        range?: LocalizedString;
+    };
+}
+export interface CharacterSpecializationTalent {
+    id: number;
+    rank: number;
+    tooltip?: Detail;
+    default_points?: number;
+}
+export interface ClassicSpecializationTalent {
+    talent: {
+        name: string;
+        id: number;
+    };
+    spell_tooltip: {
+        spell: {
+            name: string;
+            id: number;
+        };
+        description: string;
+        cast_time: string;
+        cooldown?: string;
+        power_cost?: string | null;
+        range?: string;
+    };
+}
+export interface CharacterSpecializations extends LinkSelfHref {
+    specializations: {
+        specialization: KeyNameId;
+        specialization_name?: string;
+        glyphs?: KeyNameId[];
+        talents?: ClassicSpecializationTalent[];
+        pvp_talent_slots?: {
+            selected: Detail;
+            slot_number: number;
+        }[];
+        loadouts?: {
+            is_active: boolean;
+            talent_loadout_code: string;
+            selected_class_talents: CharacterSpecializationTalent[];
+            selected_spec_talents: CharacterSpecializationTalent[];
+            selected_hero_talents?: CharacterSpecializationTalent[];
+            selected_class_talent_tree?: KeyName;
+            selected_spec_talent_tree?: KeyName;
+            selected_hero_talent_tree?: KeyNameId;
+        }[];
+    }[];
+    specialization_groups?: {
+        is_active: boolean;
+        glyphs?: NameId[];
+        specializations?: {
+            specialization?: KeyNameId;
+            specialization_name: string;
+            talents: ClassicSpecializationTalent[];
+        }[];
+    }[];
+    active_specialization: KeyNameId;
+    active_hero_talent_tree?: NamedRef;
+    character: Character;
+}
+/**
+ * Returns a summary of a character's specializations.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of a character's specializations.
+ */
+export declare function characterSpecializations(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterSpecializations>;

package/script/src/wow/profile/character_specializations.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterSpecializations = characterSpecializations;
+/**
+ * Returns a summary of a character's specializations.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of a character's specializations.
+ */
+async function characterSpecializations(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/specializations`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_statistics.d.ts

@@ -0,0 +1,104 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface StatRating {
+    rating_bonus: number;
+    value: number;
+    rating_normalized: number;
+}
+export interface StatRatingBonus {
+    rating_bonus: number;
+    rating_normalized: number;
+}
+export interface CharacterStatistics extends LinkSelfHref {
+    health: number;
+    power: number;
+    power_type: KeyNameId;
+    speed: StatRatingBonus;
+    strength: {
+        base: number;
+        effective: number;
+    };
+    agility: {
+        base: number;
+        effective: number;
+    };
+    intellect: {
+        base: number;
+        effective: number;
+    };
+    stamina: {
+        base: number;
+        effective: number;
+    };
+    melee_crit: StatRating;
+    melee_haste: StatRating;
+    mastery: StatRating;
+    bonus_armor: number;
+    lifesteal: StatRating;
+    versatility: number;
+    versatility_damage_done_bonus: number;
+    versatility_healing_done_bonus: number;
+    versatility_damage_taken_bonus: number;
+    avoidance: StatRatingBonus;
+    attack_power: number;
+    main_hand_damage_min: number;
+    main_hand_damage_max: number;
+    main_hand_speed: number;
+    main_hand_dps: number;
+    off_hand_damage_min: number;
+    off_hand_damage_max: number;
+    off_hand_speed: number;
+    off_hand_dps: number;
+    spell_power: number;
+    spell_penetration: number;
+    spell_crit: StatRating;
+    mana_regen: number;
+    mana_regen_combat: number;
+    armor: {
+        base: number;
+        effective: number;
+    };
+    dodge: StatRating;
+    parry: StatRating;
+    block: StatRating;
+    ranged_crit: StatRating;
+    ranged_haste: StatRating;
+    spell_haste: StatRating;
+    spirit?: {
+        base: number;
+        effective: number;
+    };
+    defense?: {
+        base: number;
+        effective: number;
+    };
+    arcane_resistance?: {
+        base: number;
+        effective: number;
+    };
+    fire_resistance?: {
+        base: number;
+        effective: number;
+    };
+    holy_resistance?: {
+        base: number;
+        effective: number;
+    };
+    nature_resistance?: {
+        base: number;
+        effective: number;
+    };
+    shadow_resistance?: {
+        base: number;
+        effective: number;
+    };
+    character: Character;
+}
+/**
+ * Returns a statistics summary for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a statistics summary for a character.
+ */
+export declare function characterStatistics(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterStatistics>;

package/script/src/wow/profile/character_statistics.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterStatistics = characterStatistics;
+/**
+ * Returns a statistics summary for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a statistics summary for a character.
+ */
+async function characterStatistics(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/statistics`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_titles.d.ts

@@ -0,0 +1,14 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterTitles extends LinkSelfHref {
+    character: Character;
+    titles: KeyNameId[];
+}
+/**
+ * Returns a summary of titles a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of titles a character has obtained.
+ */
+export declare function characterTitles(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterTitles>;

package/script/src/wow/profile/character_titles.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterTitles = characterTitles;
+/**
+ * Returns a summary of titles a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of titles a character has obtained.
+ */
+async function characterTitles(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/titles`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/guild.d.ts

@@ -0,0 +1,150 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, Href, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface GuildCrestRgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface CrestAsset {
+    id?: number;
+    media?: KeyId;
+    color: {
+        id: number;
+        rgba?: GuildCrestRgba;
+    };
+}
+export interface GuildReference {
+    key: Href;
+    name: string;
+    id: number;
+    realm: {
+        key: Href;
+        name: LocalizedString;
+        id: number;
+        slug: string;
+    };
+    faction: TypeName;
+}
+export interface Guild extends LinkSelfHref {
+    key?: Href;
+    id: number;
+    name: string;
+    faction: TypeName;
+    achievement_points?: number;
+    member_count?: number;
+    realm: {
+        key: Href;
+        name: LocalizedString;
+        id: number;
+        slug: string;
+    };
+    crest?: {
+        emblem: CrestAsset;
+        border: CrestAsset;
+        background: CrestAsset;
+    };
+    roster?: Href;
+    achievements?: Href;
+    created_timestamp?: number;
+    activity?: Href;
+    name_search: string;
+}
+export interface GuildActivity extends LinkSelfHref {
+    guild: GuildReference;
+    activities?: {
+        character_achievement?: {
+            character: Character;
+            achievement: KeyNameId;
+        };
+        encounter_completed?: {
+            encounter: KeyNameId;
+            mode: TypeName;
+        };
+        activity: {
+            type: string;
+        };
+        timestamp: number;
+    }[];
+}
+export interface Critiera {
+    id: number;
+    amount?: number;
+    is_completed: boolean;
+    child_criteria?: Critiera[];
+}
+export interface GuildAchievements extends LinkSelfHref {
+    guild: GuildReference;
+    total_quantity: number;
+    total_points: number;
+    achievements: {
+        id: number;
+        achievement: KeyNameId;
+        criteria?: Critiera;
+        completed_timestamp?: number;
+    }[];
+    category_progress?: {
+        category: KeyNameId;
+        quantity: number;
+        points: number;
+    }[];
+    recent_events?: {
+        achievement: KeyNameId;
+        timestamp: number;
+    }[];
+}
+export interface GuildRosterMemberCharacter {
+    key: Href;
+    name: string;
+    id: number;
+    realm: {
+        key: Href;
+        id: number;
+        slug: string;
+    };
+    level: number;
+    playable_class: KeyId;
+    playable_race: KeyId;
+    faction: {
+        type: string;
+    };
+}
+export interface GuildRoster extends LinkSelfHref {
+    guild: GuildReference;
+    members: {
+        character: GuildRosterMemberCharacter;
+        rank: number;
+    }[];
+}
+/**
+ * Returns a single guild by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild by its name and realm.
+ */
+export declare function guild(ctx: ApiContext, realmSlug: string, nameSlug: string): Promise<Guild>;
+/**
+ * Returns a single guild's activity by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+ */
+export declare function guildActivity(ctx: ApiContext, realmSlug: string, nameSlug: string): Promise<GuildActivity>;
+/**
+ * Returns a single guild's achievements by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's achievements by its name and realm.
+ */
+export declare function guildAchievements(ctx: ApiContext, realmSlug: string, nameSlug: string): Promise<GuildAchievements>;
+/**
+ * Returns a single guild's roster by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+ */
+export declare function guildRoster(ctx: ApiContext, realmSlug: string, nameSlug: string): Promise<GuildRoster>;

package/script/src/wow/profile/guild.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guild = guild;
+exports.guildActivity = guildActivity;
+exports.guildAchievements = guildAchievements;
+exports.guildRoster = guildRoster;
+/**
+ * Returns a single guild by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild by its name and realm.
+ */
+async function guild(ctx, realmSlug, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's activity by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+ */
+async function guildActivity(ctx, realmSlug, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/activity`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's achievements by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's achievements by its name and realm.
+ */
+async function guildAchievements(ctx, realmSlug, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/achievements`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's roster by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+ */
+async function guildRoster(ctx, realmSlug, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/roster`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,23 @@
+import type { ApiContext } from "../shared/index.js";
+import type { Namespaces } from "../shared/index.js";
+export interface SearchParameters {
+    searchFields?: Record<string | symbol, string | number>;
+    orderBy?: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface Search {
+    page: number;
+    pageSize: number;
+    maxPageSize: number;
+    pageCount: number;
+    resultCountCapped?: boolean;
+    results: unknown[];
+}
+/**
+ * Performs a search.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about the search.
+ */
+export declare function search(ctx: ApiContext, url: string, namespace: Namespaces, searchParameters: SearchParameters): Promise<Search>;

package/script/src/wow/search.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.search = search;
+/**
+ * Performs a search.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about the search.
+ */
+async function search(ctx, url, namespace, searchParameters) {
+    const searchFields = searchParameters.searchFields
+        ? Object.fromEntries(Object.entries(searchParameters.searchFields).map(([key, value]) => [key, value.toString()]))
+        : undefined;
+    const qs = {
+        ...searchFields,
+    };
+    if (searchParameters.orderBy) {
+        qs.orderby = searchParameters.orderBy;
+    }
+    if (searchParameters.page !== undefined) {
+        qs._page = searchParameters.page;
+    }
+    if (searchParameters.pageSize !== undefined) {
+        qs._pageSize = searchParameters.pageSize;
+    }
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/search${url}`,
+        qs,
+        namespace,
+    });
+}