@pinta365/blizzard_api 0.3.9 → 0.5.0

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

@@ -0,0 +1,111 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft housing data (decor, fixtures, fixture hooks, rooms) using the Blizzard API.
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, LinkSelfHref, NamedRef } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface Decors extends LinkSelfHref {
+    decor_items: NamedRef[];
+}
+export interface Decor extends LinkSelfHref {
+    id: number;
+    name: string;
+    /** Reference to the in-game item (a single item despite the plural name). */
+    items: NamedRef;
+    /** How many of this decor a new collection starts with. */
+    default_collection_count: number;
+}
+export interface Fixtures extends LinkSelfHref {
+    fixtures: {
+        key: Href;
+        name: string | null;
+        id: number;
+    }[];
+}
+export interface Fixture extends LinkSelfHref {
+    id: number;
+    name: string;
+    /** Fixture hooks (e.g. Door, Window) on this fixture. Absent when the fixture has none. */
+    hooks?: NamedRef[];
+}
+export interface FixtureHooks extends LinkSelfHref {
+    fixture_hooks: NamedRef[];
+}
+export interface FixtureHook extends LinkSelfHref {
+    id: number;
+    /** Hook type (e.g. "Door", "Window"). */
+    type_name: string;
+    /** Parent fixture this hook belongs to. */
+    parent_fixture: NamedRef;
+}
+export interface Rooms extends LinkSelfHref {
+    rooms: NamedRef[];
+}
+export interface Room extends LinkSelfHref {
+    id: number;
+    name: string;
+}
+/**
+ * Returns an index of decor.
+ */
+export declare function decors(ctx: ApiContext): Promise<Decors>;
+/**
+ * Returns a decor by ID.
+ *
+ * @param decorId - The ID of the decor.
+ */
+export declare function decor(ctx: ApiContext, decorId: number): Promise<Decor>;
+/**
+ * Performs a search of decor.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+export declare function searchDecor(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns an index of fixtures.
+ */
+export declare function fixtures(ctx: ApiContext): Promise<Fixtures>;
+/**
+ * Returns a fixture by ID.
+ *
+ * @param fixtureId - The ID of the fixture.
+ */
+export declare function fixture(ctx: ApiContext, fixtureId: number): Promise<Fixture>;
+/**
+ * Performs a search of fixtures.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+export declare function searchFixture(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns an index of fixture hooks.
+ */
+export declare function fixtureHooks(ctx: ApiContext): Promise<FixtureHooks>;
+/**
+ * Returns a fixture hook by ID.
+ *
+ * @param fixtureHookId - The ID of the fixture hook.
+ */
+export declare function fixtureHook(ctx: ApiContext, fixtureHookId: number): Promise<FixtureHook>;
+/**
+ * Performs a search of fixture hooks.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+export declare function searchFixtureHook(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns an index of rooms.
+ */
+export declare function rooms(ctx: ApiContext): Promise<Rooms>;
+/**
+ * Returns a room by ID.
+ *
+ * @param roomId - The ID of the room.
+ */
+export declare function room(ctx: ApiContext, roomId: number): Promise<Room>;
+/**
+ * Performs a search of rooms.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+export declare function searchRoom(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;

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

@@ -0,0 +1,138 @@
+"use strict";
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft housing data (decor, fixtures, fixture hooks, rooms) using the Blizzard API.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decors = decors;
+exports.decor = decor;
+exports.searchDecor = searchDecor;
+exports.fixtures = fixtures;
+exports.fixture = fixture;
+exports.searchFixture = searchFixture;
+exports.fixtureHooks = fixtureHooks;
+exports.fixtureHook = fixtureHook;
+exports.searchFixtureHook = searchFixtureHook;
+exports.rooms = rooms;
+exports.room = room;
+exports.searchRoom = searchRoom;
+const search_js_1 = require("../search.js");
+/**
+ * Returns an index of decor.
+ */
+async function decors(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/decor/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a decor by ID.
+ *
+ * @param decorId - The ID of the decor.
+ */
+async function decor(ctx, decorId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/decor/${decorId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of decor.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+async function searchDecor(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/decor", "static", searchParameters);
+}
+/**
+ * Returns an index of fixtures.
+ */
+async function fixtures(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/fixture/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a fixture by ID.
+ *
+ * @param fixtureId - The ID of the fixture.
+ */
+async function fixture(ctx, fixtureId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/fixture/${fixtureId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of fixtures.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+async function searchFixture(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/fixture", "static", searchParameters);
+}
+/**
+ * Returns an index of fixture hooks.
+ */
+async function fixtureHooks(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/fixture-hook/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a fixture hook by ID.
+ *
+ * @param fixtureHookId - The ID of the fixture hook.
+ */
+async function fixtureHook(ctx, fixtureHookId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/fixture-hook/${fixtureHookId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of fixture hooks.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+async function searchFixtureHook(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/fixture-hook", "static", searchParameters);
+}
+/**
+ * Returns an index of rooms.
+ */
+async function rooms(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/room/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a room by ID.
+ *
+ * @param roomId - The ID of the room.
+ */
+async function room(ctx, roomId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/room/${roomId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of rooms.
+ *
+ * @param searchParameters - Object containing search parameters.
+ */
+async function searchRoom(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/room", "static", searchParameters);
+}

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

@@ -0,0 +1,183 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, TypeName } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface ItemClasses extends LinkSelfHref {
+    item_classes: KeyNameId[];
+}
+export interface ItemClass extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    item_subclasses: KeyNameId[];
+}
+export interface ItemSets extends LinkSelfHref {
+    item_sets: KeyNameId[];
+}
+export interface ItemSet extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    items: KeyNameId[];
+    effects: {
+        display_string: LocalizedString;
+        required_count: number;
+    }[];
+}
+export interface ItemSubclass extends LinkSelfHref {
+    id: number;
+    item_class: NamedRef;
+    display_name: LocalizedString;
+    verbose_name?: string;
+    hide_subclass_in_tooltips?: boolean;
+}
+export interface Item extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    quality: TypeName;
+    level: number;
+    required_level: number;
+    media: KeyId;
+    item_class: KeyNameId;
+    item_subclass: KeyNameId;
+    inventory_type: TypeName;
+    purchase_price: number;
+    sell_price: number;
+    max_count: number;
+    is_equippable: boolean;
+    is_stackable: boolean;
+    preview_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;
+        unique_equipped: string;
+        weapon: {
+            damage: {
+                min_value: number;
+                max_value: number;
+                display_string: LocalizedString;
+                damage_class: TypeName;
+            };
+            additional_damage?: {
+                min_value: number;
+                max_value: number;
+                display_string: LocalizedString;
+                damage_class: TypeName;
+            }[];
+            attack_speed: {
+                value: number;
+                display_string: LocalizedString;
+            };
+            dps: {
+                value: number;
+                display_string: LocalizedString;
+            };
+        };
+        stats: {
+            type: TypeName;
+            value: number;
+            is_negated?: boolean;
+            display: {
+                display_string: LocalizedString;
+                color: {
+                    r: number;
+                    g: number;
+                    b: number;
+                    a: number;
+                };
+            };
+        }[];
+        spells: {
+            spell: KeyNameId;
+            description: LocalizedString;
+        }[];
+        requirements: {
+            level: {
+                value: number;
+                display_string: LocalizedString;
+            };
+        };
+        level?: {
+            value: number;
+            display_string: LocalizedString;
+        };
+        durability: {
+            value: number;
+            display_string: LocalizedString;
+        };
+        sell_price?: {
+            value: number;
+            display_strings: {
+                header: LocalizedString;
+                gold: string;
+                silver: string;
+                copper: string;
+            };
+        };
+    };
+    purchase_quantity: number;
+    appearances?: KeyId[];
+}
+export interface ItemMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns an index of item classes.
+ *
+ * @returns A promise that resolves to an object representing a list of item classes.
+ */
+export declare function itemClasses(ctx: ApiContext): Promise<ItemClasses>;
+/**
+ * Returns an item class by ID.
+ *
+ * @param itemClassId - The unique identifier for the item class by ID.
+ * @returns A promise that resolves to an object representing details about an item class by ID.
+ */
+export declare function itemClass(ctx: ApiContext, itemClassId: number): Promise<ItemClass>;
+/**
+ * Returns an index of item sets.
+ *
+ * @returns A promise that resolves to an object representing a list of item sets.
+ */
+export declare function itemSets(ctx: ApiContext): Promise<ItemSets>;
+/**
+ * Returns an item set by ID.
+ *
+ * @param itemSetId - The unique identifier for the item set by ID.
+ * @returns A promise that resolves to an object representing details about an item set by ID.
+ */
+export declare function itemSet(ctx: ApiContext, itemSetId: number): Promise<ItemSet>;
+/**
+ * Returns an item subclass by ID.
+ *
+ * @param itemClassId - The unique identifier for the item class by ID.
+ * @param itemSubclassId - The unique identifier for the item subclass by ID.
+ * @returns A promise that resolves to an object representing details about an item set by ID.
+ */
+export declare function itemSubclass(ctx: ApiContext, itemClassId: number, itemSubclassId: number): Promise<ItemSubclass>;
+/**
+ * Returns an item by ID.
+ *
+ * @param itemId - The unique identifier for the item by ID.
+ * @returns A promise that resolves to an object representing details about an item by ID.
+ */
+export declare function item(ctx: ApiContext, itemId: number): Promise<Item>;
+/**
+ * Returns media details about a specific item Id
+ *
+ * @param itemId - The unique identifier for the item
+ * @returns A promise that resolves to an object representing media details about an item.
+ */
+export declare function itemMedia(ctx: ApiContext, itemId: number): Promise<ItemMedia>;
+/**
+ * Performs a search of items.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about an item search.
+ */
+export declare function searchItem(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.itemClasses = itemClasses;
+exports.itemClass = itemClass;
+exports.itemSets = itemSets;
+exports.itemSet = itemSet;
+exports.itemSubclass = itemSubclass;
+exports.item = item;
+exports.itemMedia = itemMedia;
+exports.searchItem = searchItem;
+const search_js_1 = require("../search.js");
+/**
+ * Returns an index of item classes.
+ *
+ * @returns A promise that resolves to an object representing a list of item classes.
+ */
+async function itemClasses(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/item-class/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item class by ID.
+ *
+ * @param itemClassId - The unique identifier for the item class by ID.
+ * @returns A promise that resolves to an object representing details about an item class by ID.
+ */
+async function itemClass(ctx, itemClassId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-class/${itemClassId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of item sets.
+ *
+ * @returns A promise that resolves to an object representing a list of item sets.
+ */
+async function itemSets(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/item-set/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item set by ID.
+ *
+ * @param itemSetId - The unique identifier for the item set by ID.
+ * @returns A promise that resolves to an object representing details about an item set by ID.
+ */
+async function itemSet(ctx, itemSetId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-set/${itemSetId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item subclass by ID.
+ *
+ * @param itemClassId - The unique identifier for the item class by ID.
+ * @param itemSubclassId - The unique identifier for the item subclass by ID.
+ * @returns A promise that resolves to an object representing details about an item set by ID.
+ */
+async function itemSubclass(ctx, itemClassId, itemSubclassId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-class/${itemClassId}/item-subclass/${itemSubclassId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item by ID.
+ *
+ * @param itemId - The unique identifier for the item by ID.
+ * @returns A promise that resolves to an object representing details about an item by ID.
+ */
+async function item(ctx, itemId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item/${itemId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media details about a specific item Id
+ *
+ * @param itemId - The unique identifier for the item
+ * @returns A promise that resolves to an object representing media details about an item.
+ */
+async function itemMedia(ctx, itemId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/item/${itemId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of items.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about an item search.
+ */
+async function searchItem(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/item", "static", searchParameters);
+}

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

@@ -0,0 +1,102 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, KeyId, NamedRef } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface AppearanceSlot {
+    type: string;
+    name: string;
+}
+export interface ItemAppearance {
+    "_links": {
+        self: Href;
+    };
+    id: number;
+    slot: AppearanceSlot;
+    item_class: NamedRef;
+    item_subclass: NamedRef;
+    item_display_info_id: number;
+    items: NamedRef[];
+    media: KeyId;
+}
+export interface ItemAppearanceSets {
+    "_links": {
+        self: Href;
+    };
+    appearance_sets: NamedRef[];
+}
+export interface ItemAppearanceSet {
+    "_links": {
+        self: Href;
+    };
+    id: number;
+    set_name: string;
+    appearances: KeyId[];
+}
+export interface ItemAppearanceSlotRef {
+    key: Href;
+}
+export interface ItemAppearanceSlots {
+    "_links": {
+        self: Href;
+    };
+    slots: ItemAppearanceSlotRef[];
+}
+export interface ItemAppearanceSlot {
+    "_links": {
+        self: Href;
+    };
+    appearances: KeyId[];
+}
+export interface ItemAppearanceSearchResult {
+    key: Href;
+    data: {
+        id: number;
+        item_display_info_id: number;
+        slot: {
+            type: string;
+            name: string | Record<string, string>;
+        };
+    };
+}
+export interface ItemAppearanceSearch extends Search {
+    results: ItemAppearanceSearchResult[];
+}
+/**
+ * Returns an item appearance by ID.
+ *
+ * @param appearanceId - The unique identifier for the item appearance by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance.
+ */
+export declare function itemAppearance(ctx: ApiContext, appearanceId: number): Promise<ItemAppearance>;
+/**
+ * Returns a index of item appearance sets.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance sets.
+ */
+export declare function itemAppearanceSets(ctx: ApiContext): Promise<ItemAppearanceSets>;
+/**
+ * Returns an item appearance set by ID.
+ *
+ * @param appearanceSetId - The unique identifier for the item appearance set by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance set.
+ */
+export declare function itemAppearanceSet(ctx: ApiContext, appearanceSetId: number): Promise<ItemAppearanceSet>;
+/**
+ * Returns a index of item appearance slots.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance slots.
+ */
+export declare function itemAppearanceSlots(ctx: ApiContext): Promise<ItemAppearanceSlots>;
+/**
+ * Returns an item appearance slot by slot type.
+ *
+ * @param slotType - The slot type (e.g. "HEAD", "SHOULDER", "BODY").
+ * @returns A promise that resolves to an object representing details about an item appearance slot.
+ */
+export declare function itemAppearanceSlot(ctx: ApiContext, slotType: string): Promise<ItemAppearanceSlot>;
+/**
+ * Performs a search of item appearances.
+ *
+ * @param searchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about an item appearance search.
+ */
+export declare function searchItemAppearance(ctx: ApiContext, searchParameters: SearchParameters): Promise<ItemAppearanceSearch>;