@blizzard-api/wow 2.0.2 → 2.1.0-next.0

package/dist/quest/quest.d.ts

@@ -0,0 +1,50 @@
+import { Resource } from '@blizzard-api/core';
+import { QuestResponse, QuestAreaResponse, QuestAreaIndexResponse, QuestCategoryResponse, QuestCategoryIndexResponse, QuestIndexResponse, QuestTypeResponse, QuestTypeIndexResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a quest by ID.
+ * @param questId The quest ID.
+ * @returns The quest. See {@link QuestResponse}.
+ */
+declare function quest(questId: number): Resource<QuestResponse>;
+/**
+ * Get a quest area by ID.
+ * @param questAreaId The quest area ID.
+ * @returns The quest area. See {@link QuestAreaResponse}.
+ */
+declare function questArea(questAreaId: number): Resource<QuestAreaResponse>;
+/**
+ * Get a quest area index.
+ * @returns The quest area index. See {@link QuestAreaIndexResponse}.
+ */
+declare function questAreaIndex(): Resource<QuestAreaIndexResponse>;
+/**
+ * Get a quest category by ID.
+ * @param questCategoryId The quest category ID.
+ * @returns The quest category. See {@link QuestCategoryResponse}.
+ */
+declare function questCategory(questCategoryId: number): Resource<QuestCategoryResponse>;
+/**
+ * Get a quest category index.
+ * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
+ */
+declare function questCategoryIndex(): Resource<QuestCategoryIndexResponse>;
+/**
+ * Get a quest index.
+ * @returns The quest index. See {@link QuestIndexResponse}.
+ */
+declare function questIndex(): Resource<QuestIndexResponse>;
+/**
+ * Get a quest type by ID.
+ * @param questTypeId The quest type ID.
+ * @returns The quest type. See {@link QuestTypeResponse}.
+ */
+declare function questType(questTypeId: number): Resource<QuestTypeResponse>;
+/**
+ * Get a quest type index.
+ * @returns The quest type index. See {@link QuestTypeIndexResponse}.
+ */
+declare function questTypeIndex(): Resource<QuestTypeIndexResponse>;
+
+export { quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex };

package/dist/quest/quest.js

@@ -0,0 +1,4 @@
+export { quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex } from '../chunk-QWKGL6OD.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=quest.js.map
+//# sourceMappingURL=quest.js.map

package/dist/quest/quest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"quest.js"}

package/dist/quest/types.d.ts

@@ -0,0 +1,102 @@
+import { ResponseBase, NameIdKey, Faction } from '../base.js';
+
+/**
+ * The response for a quest area index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestAreaIndexResponse extends ResponseBase {
+    areas: Array<NameIdKey>;
+}
+/**
+ * The response for a quest area.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestAreaResponse extends ResponseBase {
+    area: string;
+    id: number;
+    quests: Array<NameIdKey>;
+}
+/**
+ * The response for a quest category index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestCategoryIndexResponse extends ResponseBase {
+    categories: Array<NameIdKey>;
+}
+/**
+ * The response for a quest category.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestCategoryResponse extends ResponseBase {
+    category: string;
+    id: number;
+    quests: Array<NameIdKey>;
+}
+/**
+ * The response for a quest index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestIndexResponse extends ResponseBase {
+    areas: {
+        href: string;
+    };
+    categories: {
+        href: string;
+    };
+    types: {
+        href: string;
+    };
+}
+/**
+ * The response for a quest.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestResponse extends ResponseBase {
+    area: NameIdKey;
+    description: string;
+    id: number;
+    requirements: Requirements;
+    rewards: Rewards;
+    title: string;
+}
+/**
+ * The response for a quest type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestTypeIndexResponse extends ResponseBase {
+    types: Array<NameIdKey>;
+}
+/**
+ * The response for a quest type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestTypeResponse extends ResponseBase {
+    id: number;
+    quests: Array<NameIdKey>;
+    type: string;
+}
+interface Money {
+    units: Units;
+    value: number;
+}
+interface Reputation {
+    reward: NameIdKey;
+    value: number;
+}
+interface Requirements {
+    faction: Faction;
+    max_character_level: number;
+    min_character_level: number;
+}
+interface Rewards {
+    experience: number;
+    money: Money;
+    reputations: Array<Reputation>;
+}
+interface Units {
+    copper: number;
+    gold: number;
+    silver: number;
+}
+
+export type { QuestAreaIndexResponse, QuestAreaResponse, QuestCategoryIndexResponse, QuestCategoryResponse, QuestIndexResponse, QuestResponse, QuestTypeIndexResponse, QuestTypeResponse };

package/dist/quest/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/quest/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/realm/realm.d.ts

@@ -0,0 +1,23 @@
+import { Resource, SearchResponse } from '@blizzard-api/core';
+import { RealmResponse, RealmIndexResponse, RealmSearchParameters, RealmSearchResponseItem } from './types.js';
+import '../base.js';
+
+/**
+ * Get a realm by slug.
+ * @param realmSlug The realm slug.
+ * @returns The realm. See {@link RealmResponse}.
+ */
+declare function realm(realmSlug: string): Resource<RealmResponse>;
+/**
+ * Get a realm index.
+ * @returns The realm index. See {@link RealmIndexResponse}.
+ */
+declare function realmIndex(): Resource<RealmIndexResponse>;
+/**
+ * Search for realms.
+ * @param options The search parameters. See {@link RealmSearchParameters}.
+ * @returns The search results. See {@link SearchResponse}.
+ */
+declare function realmSearch(options: RealmSearchParameters): Resource<SearchResponse<RealmSearchResponseItem>, RealmSearchParameters>;
+
+export { realm, realmIndex, realmSearch };

package/dist/realm/realm.js

@@ -0,0 +1,4 @@
+export { realm, realmIndex, realmSearch } from '../chunk-GQWURIOG.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=realm.js.map
+//# sourceMappingURL=realm.js.map

package/dist/realm/realm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"realm.js"}

package/dist/realm/types.d.ts

@@ -0,0 +1,81 @@
+import { Locales, BaseSearchParameters } from '@blizzard-api/core';
+import { ResponseBase, Realm, NameId, NameIdKey, KeyBase } from '../base.js';
+
+/**
+ * The category of a realm.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
+/**
+ * The response for a realm index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RealmIndexResponse extends ResponseBase {
+    realms: Array<Realm>;
+}
+/**
+ * The response for a realm.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RealmResponse extends NameId, ResponseBase {
+    category: RealmCategory;
+    connected_realm: {
+        href: string;
+    };
+    is_tournament: boolean;
+    locale: WithoutUnderscore<Locales>;
+    region: NameIdKey;
+    slug: string;
+    timezone: RealmTimezone;
+    type: {
+        name: RealmType;
+        type: RealmTypeCapitalized;
+    };
+}
+/**
+ * The search parameters for realms.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface RealmSearchParameters extends BaseSearchParameters {
+    timezone?: RealmTimezone;
+}
+/**
+ * The response for a realm search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface RealmSearchResponseItem extends KeyBase {
+    data: {
+        category: Record<Locales, string | undefined>;
+        id: number;
+        is_tournament: boolean;
+        locale: WithoutUnderscore<Locales>;
+        name: Record<Locales, string | undefined>;
+        region: {
+            id: number;
+            name: Record<Locales, string | undefined>;
+        };
+        slug: string;
+        timezone: RealmTimezone;
+        type: {
+            name: Record<Locales, string | undefined>;
+            type: RealmTypeCapitalized;
+        };
+    };
+}
+/**
+ * The timezone of a realm.
+ */
+type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
+/**
+ * The type of a realm, not capitalized or shortened.
+ */
+type RealmType = 'Normal' | 'Roleplaying';
+/**
+ * The type of a realm, capitalized and shortended).
+ */
+type RealmTypeCapitalized = 'NORMAL' | 'RP';
+type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
+
+export type { RealmCategory, RealmIndexResponse, RealmResponse, RealmSearchParameters, RealmSearchResponseItem, RealmTimezone, RealmType, RealmTypeCapitalized, WithoutUnderscore };

package/dist/realm/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/realm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/region/region.d.ts

@@ -0,0 +1,17 @@
+import { Resource } from '@blizzard-api/core';
+import { RegionResponse, RegionIndexResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a region by ID.
+ * @param regionId The region ID.
+ * @returns The region. See {@link RegionResponse}.
+ */
+declare function region(regionId: number): Resource<RegionResponse>;
+/**
+ * Get a region index.
+ * @returns The region index. See {@link RegionIndexResponse}.
+ */
+declare function regionIndex(): Resource<RegionIndexResponse>;
+
+export { region, regionIndex };

package/dist/region/region.js

@@ -0,0 +1,4 @@
+export { region, regionIndex } from '../chunk-U4WVCUZN.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=region.js.map
+//# sourceMappingURL=region.js.map

package/dist/region/region.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"region.js"}

package/dist/region/types.d.ts

@@ -0,0 +1,21 @@
+import { ResponseBase, NameId } from '../base.js';
+
+/**
+ * The response for a region index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RegionIndexResponse extends ResponseBase {
+    regions: Array<{
+        href: string;
+    }>;
+}
+/**
+ * The response for a region.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RegionResponse extends NameId, ResponseBase {
+    patch_string: string;
+    tag: string;
+}
+
+export type { RegionIndexResponse, RegionResponse };

package/dist/region/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/region/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/reputations/reputations.d.ts

@@ -0,0 +1,28 @@
+import { Resource } from '@blizzard-api/core';
+import { ReputationFactionResponse, ReputationFactionIndexResponse, ReputationTiersResponse, ReputationTiersIndexResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a reputation faction by ID.
+ * @param reputationFactionId The reputation faction ID.
+ * @returns The reputation faction. See {@link ReputationFactionResponse}.
+ */
+declare function reputationFaction(reputationFactionId: number): Resource<ReputationFactionResponse>;
+/**
+ * Get a reputation faction index.
+ * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
+ */
+declare function reputationFactionIndex(): Resource<ReputationFactionIndexResponse>;
+/**
+ * Get a reputation tier by ID.
+ * @param reputationTiersId The reputation tier ID.
+ * @returns The reputation tier. See {@link ReputationTiersResponse}.
+ */
+declare function reputationTiers(reputationTiersId: number): Resource<ReputationTiersResponse>;
+/**
+ * Get a reputation tier index.
+ * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
+ */
+declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
+
+export { reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex };

package/dist/reputations/reputations.js

@@ -0,0 +1,4 @@
+export { reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex } from '../chunk-MSX4CUNQ.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=reputations.js.map
+//# sourceMappingURL=reputations.js.map

package/dist/reputations/reputations.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"reputations.js"}

package/dist/reputations/types.d.ts

@@ -0,0 +1,51 @@
+import { ResponseBase, NameIdKey, KeyBase } from '../base.js';
+
+/**
+ * The response for a reputation faction index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationFactionIndexResponse extends ResponseBase {
+    factions: Array<NameIdKey>;
+    root_factions: Array<NameIdKey>;
+}
+/**
+ * The response for a reputation faction.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationFactionResponse extends ResponseBase {
+    description: string;
+    id: number;
+    name: string;
+    reputation_tiers: ReputationTiers;
+}
+/**
+ * The response for a reputation tier index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationTiersIndexResponse extends ResponseBase {
+    reputation_tiers: Array<ReputationTier>;
+}
+/**
+ * The response for a reputation tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationTiersResponse extends ResponseBase {
+    faction?: NameIdKey;
+    id: number;
+    tiers: Array<Tier>;
+}
+interface ReputationTier extends KeyBase {
+    id: number;
+    name?: string;
+}
+interface ReputationTiers extends KeyBase {
+    id: number;
+}
+interface Tier {
+    id: number;
+    max_value: number;
+    min_value: number;
+    name: string;
+}
+
+export type { ReputationFactionIndexResponse, ReputationFactionResponse, ReputationTiersIndexResponse, ReputationTiersResponse };

package/dist/reputations/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/reputations/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/spell/spell.d.ts

@@ -0,0 +1,24 @@
+import { Resource, SearchResponse } from '@blizzard-api/core';
+import { SpellResponse, SpellMediaResponse, SpellSearchParameters, SpellSearchResponseItem } from './types.js';
+import '../base.js';
+
+/**
+ * Get a spell by ID.
+ * @param spellId The spell ID.
+ * @returns The spell. See {@link SpellResponse}.
+ */
+declare function spell(spellId: number): Resource<SpellResponse>;
+/**
+ * Get spell media by ID.
+ * @param spellId The spell ID.
+ * @returns The spell media. See {@link SpellMediaResponse}.
+ */
+declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
+/**
+ * Get a spell search.
+ * @param options The spell search options. See {@link SpellSearchParameters}.
+ * @returns The spell search. See {@link SearchResponse}.
+ */
+declare function spellSearch(options: SpellSearchParameters): Resource<SearchResponse<SpellSearchResponseItem>, Omit<SpellSearchParameters, 'locale' | 'name'>>;
+
+export { spell, spellMedia, spellSearch };

package/dist/spell/spell.js

@@ -0,0 +1,4 @@
+export { spell, spellMedia, spellSearch } from '../chunk-VPH2NQRQ.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=spell.js.map
+//# sourceMappingURL=spell.js.map

package/dist/spell/spell.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"spell.js"}

package/dist/spell/types.d.ts

@@ -0,0 +1,47 @@
+import { BaseSearchParameters, Locales } from '@blizzard-api/core';
+import { ResponseBase, MediaAsset, NameId, KeyBase } from '../base.js';
+
+/**
+ * The response for a spell media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SpellMediaResponse extends ResponseBase {
+    assets: Array<MediaAsset>;
+    id: number;
+}
+/**
+ * The response for a spell.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SpellResponse extends NameId, ResponseBase {
+    description: null | string;
+    media: Media;
+}
+/**
+ * The search parameters for spells.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface SpellSearchParameters extends BaseSearchParameters {
+    locale: Locales;
+    name: string;
+}
+/**
+ * The response for a spell search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface SpellSearchResponseItem extends KeyBase {
+    data: {
+        id: number;
+        media: {
+            id: number;
+        };
+        name: Record<Locales, string | undefined>;
+    };
+}
+interface Media extends KeyBase {
+    id: number;
+}
+
+export type { SpellMediaResponse, SpellResponse, SpellSearchParameters, SpellSearchResponseItem };

package/dist/spell/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/spell/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/talent/talent.d.ts

@@ -0,0 +1,46 @@
+import { Resource } from '@blizzard-api/core';
+import { PvpTalentResponse, PvpTalentIndexResponse, TalentResponse, TalentIndexResponse, TalentTreeResponse, TalentTreeIndexResponse, TalentTreeNodesResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a PvP talent by ID.
+ * @param pvpTalentId The PvP talent ID.
+ * @returns The PvP talent. See {@link PvpTalentResponse}.
+ */
+declare function pvpTalent(pvpTalentId: number): Resource<PvpTalentResponse>;
+/**
+ * Get a PvP talent index.
+ * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
+ */
+declare function pvpTalentIndex(): Resource<PvpTalentIndexResponse>;
+/**
+ * Get a talent by ID.
+ * @param talentId The talent ID.
+ * @returns The talent. See {@link TalentResponse}.
+ */
+declare function talent(talentId: number): Resource<TalentResponse>;
+/**
+ * Get a talent index.
+ * @returns The talent index. See {@link TalentIndexResponse}.
+ */
+declare function talentIndex(): Resource<TalentIndexResponse>;
+/**
+ * Get a talent tree by ID.
+ * @param talentTreeId The talent tree ID.
+ * @param specId The playable specialization ID.
+ * @returns The talent tree. See {@link TalentTreeResponse}.
+ */
+declare function talentTree(talentTreeId: number, specId: number): Resource<TalentTreeResponse>;
+/**
+ * Get a talent tree index.
+ * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
+ */
+declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
+/**
+ * Get talent tree nodes by talent tree ID.
+ * @param talentTreeId The talent tree ID.
+ * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
+ */
+declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
+
+export { pvpTalent, pvpTalentIndex, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes };

package/dist/talent/talent.js

@@ -0,0 +1,4 @@
+export { pvpTalent, pvpTalentIndex, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes } from '../chunk-HCIV2L64.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=talent.js.map
+//# sourceMappingURL=talent.js.map

package/dist/talent/talent.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"talent.js"}