@pinta365/blizzard_api 0.4.0 → 0.5.0

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

@@ -0,0 +1,115 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, NameId, TypeName } from "../../shared/index.js";
+export interface Covenants extends LinkSelfHref {
+    covenants: KeyNameId[];
+}
+export interface CovenantAbilitySpellTooltip {
+    spell: KeyNameId;
+    description: LocalizedString;
+    cast_time: string;
+    power_cost?: string | number | null;
+    range?: string;
+    cooldown?: string;
+}
+export interface SignatureAbility {
+    id: number;
+    spell_tooltip: CovenantAbilitySpellTooltip;
+}
+export interface ClassAbility {
+    id: number;
+    playable_class: KeyNameId;
+    spell_tooltip: CovenantAbilitySpellTooltip;
+}
+export interface Covenant extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    signature_ability: SignatureAbility;
+    class_abilities: ClassAbility[];
+    renown_rewards: {
+        level: number;
+        reward: NamedRef;
+    }[];
+    soulbinds?: NamedRef[];
+    media: KeyId;
+}
+export interface CovenantMedia extends LinkSelfHref {
+    assets: Asset[];
+}
+export interface CovenantSoulbinds extends LinkSelfHref {
+    soulbinds: KeyNameId[];
+}
+export interface CovenantSoulbind extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    covenant: KeyNameId;
+    creature: KeyNameId;
+    follower: NameId;
+    talent_tree: KeyNameId;
+}
+export interface CovenantConduits extends LinkSelfHref {
+    conduits: KeyNameId[];
+}
+export interface CovenantConduitSpellTooltip {
+    spell: KeyNameId;
+    description: LocalizedString;
+    cast_time: string;
+}
+export interface CovenantConduitRank {
+    id: number;
+    tier: number;
+    spell_tooltip: CovenantConduitSpellTooltip;
+}
+export interface CovenantConduit extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    item: KeyNameId;
+    socket_type: TypeName;
+    ranks: CovenantConduitRank[];
+}
+/**
+ * Returns an index of Covenants.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenants.
+ */
+export declare function covenants(ctx: ApiContext): Promise<Covenants>;
+/**
+ * Returns details about a Covenant
+ *
+ * @param covenantId - The unique identifier for the Covenant
+ * @returns A promise that resolves to an object representing details about a Covenant.
+ */
+export declare function covenant(ctx: ApiContext, covenantId: number): Promise<Covenant>;
+/**
+ * Returns media details about a Covenant
+ *
+ * @param covenantId - The unique identifier for the Covenant.
+ * @returns A promise that resolves to an object representing media details about a Covenant.
+ */
+export declare function azeriteEssenceMedia(ctx: ApiContext, covenantId: number): Promise<CovenantMedia>;
+/**
+ * Returns an index of Covenant Soulbinds.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenant Soulbinds.
+ */
+export declare function covenantSoulbinds(ctx: ApiContext): Promise<CovenantSoulbinds>;
+/**
+ * Returns details about a Covenant Soulbind
+ *
+ * @param soulbindId - The unique identifier for the Covenant Soulbind
+ * @returns A promise that resolves to an object representing details about a Covenant Soulbind.
+ */
+export declare function covenantSoulbind(ctx: ApiContext, soulbindId: number): Promise<CovenantSoulbind>;
+/**
+ * Returns an index of Covenant Conduits.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenant Conduits.
+ */
+export declare function covenantConduits(ctx: ApiContext): Promise<CovenantConduits>;
+/**
+ * Returns details about a Covenant Conduit
+ *
+ * @param conduitId - The unique identifier for the Covenant Conduit
+ * @returns A promise that resolves to an object representing details about a Covenant Conduit.
+ */
+export declare function covenantConduit(ctx: ApiContext, conduitId: number): Promise<CovenantConduit>;

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

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.covenants = covenants;
+exports.covenant = covenant;
+exports.azeriteEssenceMedia = azeriteEssenceMedia;
+exports.covenantSoulbinds = covenantSoulbinds;
+exports.covenantSoulbind = covenantSoulbind;
+exports.covenantConduits = covenantConduits;
+exports.covenantConduit = covenantConduit;
+/**
+ * Returns an index of Covenants.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenants.
+ */
+async function covenants(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/covenant/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a Covenant
+ *
+ * @param covenantId - The unique identifier for the Covenant
+ * @returns A promise that resolves to an object representing details about a Covenant.
+ */
+async function covenant(ctx, covenantId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/covenant/${covenantId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media details about a Covenant
+ *
+ * @param covenantId - The unique identifier for the Covenant.
+ * @returns A promise that resolves to an object representing media details about a Covenant.
+ */
+async function azeriteEssenceMedia(ctx, covenantId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/covenant/${covenantId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of Covenant Soulbinds.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenant Soulbinds.
+ */
+async function covenantSoulbinds(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/covenant/soulbind/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a Covenant Soulbind
+ *
+ * @param soulbindId - The unique identifier for the Covenant Soulbind
+ * @returns A promise that resolves to an object representing details about a Covenant Soulbind.
+ */
+async function covenantSoulbind(ctx, soulbindId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/covenant/soulbind/${soulbindId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of Covenant Conduits.
+ *
+ * @returns A promise that resolves to an object representing a list of all Covenant Conduits.
+ */
+async function covenantConduits(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/covenant/conduit/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a Covenant Conduit
+ *
+ * @param conduitId - The unique identifier for the Covenant Conduit
+ * @returns A promise that resolves to an object representing details about a Covenant Conduit.
+ */
+async function covenantConduit(ctx, conduitId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/covenant/conduit/${conduitId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,98 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface CreatureFamilies extends LinkSelfHref {
+    creature_families: KeyNameId[];
+}
+export interface CreatureFamily extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    specialization?: KeyNameId;
+    media: KeyId;
+}
+export interface CreatureTypes extends LinkSelfHref {
+    creature_types: KeyNameId[];
+}
+export interface CreatureType extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+}
+export interface Creature extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    type: KeyNameId;
+    family?: KeyNameId;
+    creature_displays: KeyId[];
+    is_tameable: boolean;
+}
+export interface CreatureDisplayAssets {
+    key: string;
+    value: string;
+}
+export interface CreatureDisplayMedia extends LinkSelfHref {
+    assets: CreatureDisplayAssets[];
+    id: number;
+}
+export interface CreatureFamilyAssets {
+    key: string;
+    value: string;
+    file_data_id: number;
+}
+export interface CreatureFamilyMedia extends LinkSelfHref {
+    assets: CreatureFamilyAssets[];
+    id: number;
+}
+/**
+ * Returns an index of creature families.
+ *
+ * @returns A promise that resolves to an object representing a list of all creature families.
+ */
+export declare function creatureFamilies(ctx: ApiContext): Promise<CreatureFamilies>;
+/**
+ * Returns details about a creature family
+ *
+ * @param creatureFamilyId - The unique identifier for the creature family
+ * @returns A promise that resolves to an object representing details about a creature family.
+ */
+export declare function creatureFamily(ctx: ApiContext, creatureFamilyId: number): Promise<CreatureFamily>;
+/**
+ * Returns an index of creature types.
+ *
+ * @returns A promise that resolves to an object representing a list of all creature types.
+ */
+export declare function creatureTypes(ctx: ApiContext): Promise<CreatureTypes>;
+/**
+ * Returns details about a creature types
+ *
+ * @param creatureTypeId - The unique identifier for the creature types
+ * @returns A promise that resolves to an object representing details about a creature types.
+ */
+export declare function creatureType(ctx: ApiContext, creatureTypeId: number): Promise<CreatureType>;
+/**
+ * Returns details about a creature
+ *
+ * @param creatureId - The unique identifier for the creature
+ * @returns A promise that resolves to an object representing details about a creature.
+ */
+export declare function creature(ctx: ApiContext, creatureId: number): Promise<Creature>;
+/**
+ * Performs a search of creatures.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a creature search.
+ */
+export declare function searchCreature(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns media details about a specific Creature display
+ *
+ * @param creatureDisplayId - The unique identifier Creature display Id.
+ * @returns A promise that resolves to an object representing media details about a Creature display.
+ */
+export declare function creatureDisplayMedia(ctx: ApiContext, creatureDisplayId: number): Promise<CreatureDisplayMedia>;
+/**
+ * Returns media details about a specific Creature family
+ *
+ * @param creatureFamilyId - The unique identifier Creature family Id.
+ * @returns A promise that resolves to an object representing media details about a Creature family.
+ */
+export declare function creatureFamilyMedia(ctx: ApiContext, creatureFamilyId: number): Promise<CreatureFamilyMedia>;

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

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.creatureFamilies = creatureFamilies;
+exports.creatureFamily = creatureFamily;
+exports.creatureTypes = creatureTypes;
+exports.creatureType = creatureType;
+exports.creature = creature;
+exports.searchCreature = searchCreature;
+exports.creatureDisplayMedia = creatureDisplayMedia;
+exports.creatureFamilyMedia = creatureFamilyMedia;
+const search_js_1 = require("../search.js");
+/**
+ * Returns an index of creature families.
+ *
+ * @returns A promise that resolves to an object representing a list of all creature families.
+ */
+async function creatureFamilies(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/creature-family/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a creature family
+ *
+ * @param creatureFamilyId - The unique identifier for the creature family
+ * @returns A promise that resolves to an object representing details about a creature family.
+ */
+async function creatureFamily(ctx, creatureFamilyId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/creature-family/${creatureFamilyId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of creature types.
+ *
+ * @returns A promise that resolves to an object representing a list of all creature types.
+ */
+async function creatureTypes(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/creature-type/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a creature types
+ *
+ * @param creatureTypeId - The unique identifier for the creature types
+ * @returns A promise that resolves to an object representing details about a creature types.
+ */
+async function creatureType(ctx, creatureTypeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/creature-type/${creatureTypeId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns details about a creature
+ *
+ * @param creatureId - The unique identifier for the creature
+ * @returns A promise that resolves to an object representing details about a creature.
+ */
+async function creature(ctx, creatureId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/creature/${creatureId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of creatures.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a creature search.
+ */
+async function searchCreature(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/creature", "static", searchParameters);
+}
+/**
+ * Returns media details about a specific Creature display
+ *
+ * @param creatureDisplayId - The unique identifier Creature display Id.
+ * @returns A promise that resolves to an object representing media details about a Creature display.
+ */
+async function creatureDisplayMedia(ctx, creatureDisplayId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/creature-display/${creatureDisplayId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media details about a specific Creature family
+ *
+ * @param creatureFamilyId - The unique identifier Creature family Id.
+ * @returns A promise that resolves to an object representing media details about a Creature family.
+ */
+async function creatureFamilyMedia(ctx, creatureFamilyId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/creature-family/${creatureFamilyId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,56 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, LinkSelfHref } from "../../shared/index.js";
+export interface Emblem {
+    id: number;
+    media: KeyId;
+}
+export interface Border {
+    id: number;
+    media: KeyId;
+}
+export interface IdRgba {
+    id: number;
+    rgba: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+}
+export interface GuildCrests extends LinkSelfHref {
+    emblems: Emblem[];
+    borders: Border[];
+    colors: {
+        emblems?: IdRgba[];
+        borders?: IdRgba[];
+        backgrounds?: IdRgba[];
+    };
+}
+export interface GuildCrestBorder extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+export interface GuildCrestEmblem extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns the Guild Crest Components Index
+ *
+ * @returns A promise that resolves to an object representing a list of all Guild Crest Components.
+ */
+export declare function guildCrests(ctx: ApiContext): Promise<GuildCrests>;
+/**
+ * Returns a Guild Crest Border Media
+ *
+ * @param borderId - The unique identifier for the Covenant
+ * @returns A promise that resolves to an object representing details about a Guild Crest Border Media.
+ */
+export declare function guildCrestBorder(ctx: ApiContext, borderId: number): Promise<GuildCrestBorder>;
+/**
+ * Returns a Crest Emblem Media
+ *
+ * @param emblemId - The unique identifier for the Crest Emblem Media
+ * @returns A promise that resolves to an object representing details about a Crest Emblem Media.
+ */
+export declare function guildCrestEmblem(ctx: ApiContext, emblemId: number): Promise<GuildCrestEmblem>;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guildCrests = guildCrests;
+exports.guildCrestBorder = guildCrestBorder;
+exports.guildCrestEmblem = guildCrestEmblem;
+/**
+ * Returns the Guild Crest Components Index
+ *
+ * @returns A promise that resolves to an object representing a list of all Guild Crest Components.
+ */
+async function guildCrests(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/guild-crest/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a Guild Crest Border Media
+ *
+ * @param borderId - The unique identifier for the Covenant
+ * @returns A promise that resolves to an object representing details about a Guild Crest Border Media.
+ */
+async function guildCrestBorder(ctx, borderId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/guild-crest/border/${borderId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns a Crest Emblem Media
+ *
+ * @param emblemId - The unique identifier for the Crest Emblem Media
+ * @returns A promise that resolves to an object representing details about a Crest Emblem Media.
+ */
+async function guildCrestEmblem(ctx, emblemId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/guild-crest/emblem/${emblemId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,82 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Heirlooms extends LinkSelfHref {
+    heirlooms: KeyNameId[];
+}
+export interface ValueDisplayString {
+    value: number;
+    display_string: LocalizedString;
+}
+export interface UpgradeStats {
+    type: TypeName;
+    value: number;
+    is_negated?: boolean;
+    is_equip_bonus?: boolean;
+    display: {
+        display_string: LocalizedString;
+        color: {
+            r: number;
+            g: number;
+            b: number;
+            a: number;
+        };
+    };
+}
+export interface Upgrade {
+    item: {
+        item: KeyId;
+        context: number;
+        bonus_list: number[];
+        quality: TypeName;
+        name: LocalizedString;
+        media: KeyId;
+        item_class: KeyNameId;
+        item_subclass: KeyNameId;
+        inventory_type: TypeName;
+        binding: TypeName;
+        weapon: {
+            damage: {
+                min_value: number;
+                max_value: number;
+                display_string: LocalizedString;
+                damage_class: TypeName;
+            };
+            attack_speed: ValueDisplayString;
+            dps: ValueDisplayString;
+        };
+        stats: UpgradeStats[];
+        upgrades: {
+            value: number;
+            max_value: number;
+            display_string: LocalizedString;
+        };
+        requirements: {
+            level: {
+                display_string: LocalizedString;
+            };
+        };
+        level: ValueDisplayString;
+    };
+    level: number;
+}
+export interface Heirloom extends LinkSelfHref {
+    id: number;
+    item: KeyNameId;
+    source: TypeName;
+    source_description: LocalizedString;
+    upgrades: Upgrade[];
+    media: KeyId;
+}
+/**
+ * Returns the Heirloom Index
+ *
+ * @returns A promise that resolves to an object representing a list of all Heirlooms.
+ */
+export declare function heirlooms(ctx: ApiContext): Promise<Heirlooms>;
+/**
+ * Returns a Heirloom
+ *
+ * @param heirloomId - The unique identifier for the Heirloom
+ * @returns A promise that resolves to an object representing details about a Heirloom.
+ */
+export declare function heirloom(ctx: ApiContext, heirloomId: number): Promise<Heirloom>;

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

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