@pinta365/blizzard_api 0.4.0 → 0.5.0

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pvpTierMedia = pvpTierMedia;
+exports.pvpTiers = pvpTiers;
+exports.pvpTier = pvpTier;
+/**
+ * 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.
+ */
+async function pvpTierMedia(ctx, pvpTierId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/pvp-tier/${pvpTierId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of PvP tiers.
+ *
+ * @returns A promise that resolves to an object representing a list of PvP tiers.
+ */
+async function pvpTiers(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/pvp-tier/index",
+        namespace: "static",
+    });
+}
+/**
+ * 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.
+ */
+async function pvpTier(ctx, pvpTierId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pvp-tier/${pvpTierId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,116 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Quests extends LinkSelfHref {
+    categories: {
+        href: string;
+    };
+    areas: {
+        href: string;
+    };
+    types: {
+        href: string;
+    };
+}
+export interface Quest extends LinkSelfHref {
+    id: number;
+    title: LocalizedString;
+    category?: KeyNameId;
+    area?: KeyNameId;
+    description: LocalizedString;
+    requirements: {
+        min_character_level: number;
+        max_character_level: number;
+        faction?: TypeName;
+    };
+    rewards: {
+        experience: number;
+        reputations: {
+            reward: KeyNameId;
+            value: number;
+        }[];
+        money?: {
+            value: number;
+            units: {
+                gold: number;
+                silver: number;
+                copper: number;
+            };
+        };
+    };
+}
+export interface QuestCategories extends LinkSelfHref {
+    categories: KeyNameId[];
+}
+export interface QuestCategory extends LinkSelfHref {
+    id: number;
+    category: LocalizedString;
+    quests: KeyNameId[];
+}
+export interface QuestAreas extends LinkSelfHref {
+    areas: KeyNameId[];
+}
+export interface QuestArea extends LinkSelfHref {
+    id: number;
+    area: LocalizedString;
+    quests: KeyNameId[];
+}
+export interface QuestTypes extends LinkSelfHref {
+    types: KeyNameId[];
+}
+export interface QuestType extends LinkSelfHref {
+    id: number;
+    type: LocalizedString;
+    quests: KeyNameId[];
+}
+/**
+ * Returns the parent index for quests.
+ *
+ * @returns A promise that resolves to an object representing a list of quests.
+ */
+export declare function quests(ctx: ApiContext): Promise<Quests>;
+/**
+ * Returns a quest by ID.
+ *
+ * @param questId - The unique identifier for the quest.
+ * @returns A promise that resolves to an object representing details about a quest.
+ */
+export declare function quest(ctx: ApiContext, questId: number): Promise<Quest>;
+/**
+ * Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
+ *
+ * @returns A promise that resolves to an object representing a list of quest categories.
+ */
+export declare function questCategories(ctx: ApiContext): Promise<QuestCategories>;
+/**
+ * Returns a quest category by ID.
+ *
+ * @param questCategoryId - The unique identifier for the quest category.
+ * @returns A promise that resolves to an object representing details about a quest category.
+ */
+export declare function questCategory(ctx: ApiContext, questCategoryId: number): Promise<QuestCategory>;
+/**
+ * Returns an index of quest areas.
+ *
+ * @returns A promise that resolves to an object representing a list of quest areas.
+ */
+export declare function questAreas(ctx: ApiContext): Promise<QuestAreas>;
+/**
+ * Returns a quest area by ID.
+ *
+ * @param questAreaId - The unique identifier for the quest area.
+ * @returns A promise that resolves to an object representing details about a quest area.
+ */
+export declare function questArea(ctx: ApiContext, questAreaId: number): Promise<QuestArea>;
+/**
+ * Returns an index of quest types (such as PvP quests, raid quests, or account quests).
+ *
+ * @returns A promise that resolves to an object representing a list of quest types.
+ */
+export declare function questTypes(ctx: ApiContext): Promise<QuestTypes>;
+/**
+ * Returns a quest type by ID.
+ *
+ * @param questTypeId - The unique identifier for the quest type.
+ * @returns A promise that resolves to an object representing details about a quest type.
+ */
+export declare function questType(ctx: ApiContext, questTypeId: number): Promise<QuestType>;

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quests = quests;
+exports.quest = quest;
+exports.questCategories = questCategories;
+exports.questCategory = questCategory;
+exports.questAreas = questAreas;
+exports.questArea = questArea;
+exports.questTypes = questTypes;
+exports.questType = questType;
+/**
+ * Returns the parent index for quests.
+ *
+ * @returns A promise that resolves to an object representing a list of quests.
+ */
+async function quests(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/quest/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a quest by ID.
+ *
+ * @param questId - The unique identifier for the quest.
+ * @returns A promise that resolves to an object representing details about a quest.
+ */
+async function quest(ctx, questId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/quest/${questId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
+ *
+ * @returns A promise that resolves to an object representing a list of quest categories.
+ */
+async function questCategories(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/quest/category/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a quest category by ID.
+ *
+ * @param questCategoryId - The unique identifier for the quest category.
+ * @returns A promise that resolves to an object representing details about a quest category.
+ */
+async function questCategory(ctx, questCategoryId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/quest/category/${questCategoryId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of quest areas.
+ *
+ * @returns A promise that resolves to an object representing a list of quest areas.
+ */
+async function questAreas(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/quest/area/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a quest area by ID.
+ *
+ * @param questAreaId - The unique identifier for the quest area.
+ * @returns A promise that resolves to an object representing details about a quest area.
+ */
+async function questArea(ctx, questAreaId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/quest/area/${questAreaId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of quest types (such as PvP quests, raid quests, or account quests).
+ *
+ * @returns A promise that resolves to an object representing a list of quest types.
+ */
+async function questTypes(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/quest/type/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a quest type by ID.
+ *
+ * @param questTypeId - The unique identifier for the quest type.
+ * @returns A promise that resolves to an object representing details about a quest type.
+ */
+async function questType(ctx, questTypeId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/quest/type/${questTypeId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,43 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface RealmList extends KeyNameId {
+    slug: string;
+}
+export interface Realms extends LinkSelfHref {
+    realms: RealmList[];
+}
+export interface Realm extends LinkSelfHref {
+    id: number;
+    region: KeyNameId;
+    connected_realm: {
+        href: string;
+    };
+    name: LocalizedString;
+    category: LocalizedString;
+    locale: string;
+    timezone: string;
+    type: TypeName;
+    is_tournament: boolean;
+    slug: string;
+}
+/**
+ * Returns an index of realms.
+ *
+ * @returns A promise that resolves to an object representing a list of realms.
+ */
+export declare function realms(ctx: ApiContext): Promise<Realms>;
+/**
+ * Returns a single realm by slug or ID.
+ *
+ * @param realmSlugOrId - The unique identifier for the realm.
+ * @returns A promise that resolves to an object representing details about a realm.
+ */
+export declare function realm(ctx: ApiContext, realmSlugOrId: string | number): Promise<Realm>;
+/**
+ * Performs a search of realms.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a realm search.
+ */
+export declare function searchRealm(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.realms = realms;
+exports.realm = realm;
+exports.searchRealm = searchRealm;
+const search_js_1 = require("../search.js");
+/**
+ * Returns an index of realms.
+ *
+ * @returns A promise that resolves to an object representing a list of realms.
+ */
+async function realms(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/realm/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a single realm by slug or ID.
+ *
+ * @param realmSlugOrId - The unique identifier for the realm.
+ * @returns A promise that resolves to an object representing details about a realm.
+ */
+async function realm(ctx, realmSlugOrId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/realm/${realmSlugOrId}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Performs a search of realms.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a realm search.
+ */
+async function searchRealm(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/realm", "dynamic", searchParameters);
+}

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

@@ -0,0 +1,26 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface Regions extends LinkSelfHref {
+    regions: {
+        href: string;
+    }[];
+}
+export interface Region extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    patch_string: string;
+    tag: string;
+}
+/**
+ * Returns an index of regions.
+ *
+ * @returns A promise that resolves to an object representing a list of regions.
+ */
+export declare function regions(ctx: ApiContext): Promise<Regions>;
+/**
+ * Returns a region by ID.
+ *
+ * @param regionId - The unique identifier for the region.
+ * @returns A promise that resolves to an object representing details about a region.
+ */
+export declare function region(ctx: ApiContext, regionId: number): Promise<Region>;

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

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

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

@@ -0,0 +1,57 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface ReputationFactions extends LinkSelfHref {
+    factions: KeyNameId[];
+    root_factions: KeyNameId[];
+}
+export interface ReputationFaction extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    reputation_tiers: KeyId;
+}
+export interface ReputationTiers extends LinkSelfHref {
+    reputation_tiers: {
+        key: {
+            href: string;
+        };
+        name?: LocalizedString;
+        id: number;
+    }[];
+}
+export interface ReputationTier extends LinkSelfHref {
+    id: number;
+    tiers: {
+        name: LocalizedString;
+        min_value: number;
+        max_value: number;
+        id: number;
+    }[];
+    faction?: KeyNameId;
+}
+/**
+ * Returns an index of reputation factions.
+ *
+ * @returns A promise that resolves to an object representing a list of reputation factions.
+ */
+export declare function reputationFactions(ctx: ApiContext): Promise<ReputationFactions>;
+/**
+ * Returns a single reputation faction by ID.
+ *
+ * @param reputationFactionId - The unique identifier for the reputation faction.
+ * @returns A promise that resolves to an object representing details about a reputation faction.
+ */
+export declare function reputationFaction(ctx: ApiContext, reputationFactionId: string): Promise<ReputationFaction>;
+/**
+ * Returns an index of reputation tiers.
+ *
+ * @returns A promise that resolves to an object representing a list of reputation tiers.
+ */
+export declare function reputationTiers(ctx: ApiContext): Promise<ReputationTiers>;
+/**
+ * Returns a single set of reputation tiers by ID.
+ *
+ * @param reputationTiersId - The unique identifier for the reputation tier.
+ * @returns A promise that resolves to an object representing details about a reputation tier.
+ */
+export declare function reputationTier(ctx: ApiContext, reputationTiersId: string): Promise<ReputationTier>;

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reputationFactions = reputationFactions;
+exports.reputationFaction = reputationFaction;
+exports.reputationTiers = reputationTiers;
+exports.reputationTier = reputationTier;
+/**
+ * Returns an index of reputation factions.
+ *
+ * @returns A promise that resolves to an object representing a list of reputation factions.
+ */
+async function reputationFactions(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/reputation-faction/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a single reputation faction by ID.
+ *
+ * @param reputationFactionId - The unique identifier for the reputation faction.
+ * @returns A promise that resolves to an object representing details about a reputation faction.
+ */
+async function reputationFaction(ctx, reputationFactionId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/reputation-faction/${reputationFactionId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of reputation tiers.
+ *
+ * @returns A promise that resolves to an object representing a list of reputation tiers.
+ */
+async function reputationTiers(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/reputation-tiers/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a single set of reputation tiers by ID.
+ *
+ * @param reputationTiersId - The unique identifier for the reputation tier.
+ * @returns A promise that resolves to an object representing details about a reputation tier.
+ */
+async function reputationTier(ctx, reputationTiersId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/reputation-tiers/${reputationTiersId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,34 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface Spell extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    media: KeyId;
+}
+export interface SpellMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns a spell by ID.
+ *
+ * @param spellId - The unique identifier for the spell.
+ * @returns A promise that resolves to an object representing details about a spell.
+ */
+export declare function spell(ctx: ApiContext, spellId: number): Promise<Spell>;
+/**
+ * Returns media for a spell by ID.
+ *
+ * @param spellId - The unique identifier for the spell.
+ * @returns A promise that resolves to an object representing details about a spell.
+ */
+export declare function spellMedia(ctx: ApiContext, spellId: number): Promise<SpellMedia>;
+/**
+ * Performs a search of spells.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a spell search.
+ */
+export declare function searchSpell(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spell = spell;
+exports.spellMedia = spellMedia;
+exports.searchSpell = searchSpell;
+const search_js_1 = require("../search.js");
+/**
+ * Returns a spell by ID.
+ *
+ * @param spellId - The unique identifier for the spell.
+ * @returns A promise that resolves to an object representing details about a spell.
+ */
+async function spell(ctx, spellId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/spell/${spellId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a spell by ID.
+ *
+ * @param spellId - The unique identifier for the spell.
+ * @returns A promise that resolves to an object representing details about a spell.
+ */
+async function spellMedia(ctx, spellId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/spell/${spellId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of spells.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a spell search.
+ */
+async function searchSpell(ctx, searchParameters) {
+    return await (0, search_js_1.search)(ctx, "/spell", "static", searchParameters);
+}