@pinta365/blizzard_api 0.3.5

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

@@ -0,0 +1,116 @@
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterStatistics extends LinkSelfHref {
+    health: number;
+    power: number;
+    power_type: KeyNameId;
+    speed: {
+        rating: number;
+        rating_bonus: number;
+    };
+    strength: {
+        base: number;
+        effective: number;
+    };
+    agility: {
+        base: number;
+        effective: number;
+    };
+    intellect: {
+        base: number;
+        effective: number;
+    };
+    stamina: {
+        base: number;
+        effective: number;
+    };
+    melee_crit: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    melee_haste: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    mastery: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    bonus_armor: number;
+    lifesteal: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    versatility: number;
+    versatility_damage_done_bonus: number;
+    versatility_healing_done_bonus: number;
+    versatility_damage_taken_bonus: number;
+    avoidance: {
+        rating: number;
+        rating_bonus: number;
+    };
+    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: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    mana_regen: number;
+    mana_regen_combat: number;
+    armor: {
+        base: number;
+        effective: number;
+    };
+    dodge: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    parry: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    block: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    ranged_crit: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    ranged_haste: {
+        rating: number;
+        rating_bonus: number;
+        value: number;
+    };
+    spell_haste: {
+        rating: number;
+        rating_bonus: number;
+        value: 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(realmSlug: string, characterName: string): Promise<CharacterStatistics>;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterStatistics = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * 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(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/statistics`,
+        namespace: "profile",
+    });
+}
+exports.characterStatistics = characterStatistics;

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

@@ -0,0 +1,13 @@
+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(realmSlug: string, characterName: string): Promise<CharacterTitles>;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterTitles = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * 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(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/titles`,
+        namespace: "profile",
+    });
+}
+exports.characterTitles = characterTitles;

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

@@ -0,0 +1,117 @@
+import type { Character, Href, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Rgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface CrestAsset {
+    id?: number;
+    media?: KeyId;
+    color: {
+        id: number;
+        rgba: Rgba;
+    };
+}
+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: Guild;
+    activities: {
+        character_achievement: {
+            character: Character;
+            achievement: KeyNameId;
+        };
+        activity: {
+            type: string;
+        };
+        timestamp: number;
+    }[];
+}
+export interface Critiera {
+    id: number;
+    amount?: number;
+    is_completed: boolean;
+    child_criteria?: Critiera[];
+}
+export interface GuildAchievements extends LinkSelfHref {
+    guild: Guild;
+    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 GuildRoster extends LinkSelfHref {
+    guild: Guild;
+    members: {
+        character: Character;
+        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(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(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(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(realmSlug: string, nameSlug: string): Promise<GuildRoster>;

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

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guildRoster = exports.guildAchievements = exports.guildActivity = exports.guild = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * 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(realmSlug, nameSlug) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}`,
+        namespace: "profile",
+    });
+}
+exports.guild = 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.
+ */
+async function guildActivity(realmSlug, nameSlug) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/activity`,
+        namespace: "profile",
+    });
+}
+exports.guildActivity = 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.
+ */
+async function guildAchievements(realmSlug, nameSlug) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/achievements`,
+        namespace: "profile",
+    });
+}
+exports.guildAchievements = 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.
+ */
+async function guildRoster(realmSlug, nameSlug) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/roster`,
+        namespace: "profile",
+    });
+}
+exports.guildRoster = guildRoster;

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

@@ -0,0 +1,21 @@
+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;
+    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(url: string, namespace: Namespaces, searchParameters: SearchParameters): Promise<Search>;

package/script/src/wow/search.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.search = void 0;
+const index_js_1 = require("../shared/index.js");
+/**
+ * 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(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 (0, index_js_1.request)({
+        method: "GET",
+        url: `/data/wow/search${url}`,
+        qs,
+        namespace,
+    });
+}
+exports.search = search;