@pinta365/blizzard_api 0.7.1 → 0.8.0

package/esm/src/wow_forever/game_data.d.ts

@@ -0,0 +1,196 @@
+/**
+ * WoW: Forever versions of Retail game data endpoints whose Forever responses lack fields that Retail always returns:
+ * systems Forever doesn't have (hero talents, hunter pet specializations, guild achievements, sources) and indexes
+ * that are empty before launch, which the API omits instead of returning an empty list.
+ * Each one makes the same request as the Retail endpoint, but returns a type where those fields are optional,
+ * so the Retail types can keep them required.
+ * Verified against the live API (EU) on 2026-11-02, before launch.
+ */
+import type { ApiContext } from "../shared/index.js";
+import type { SearchParameters } from "../wow/search.js";
+import type { AchievementCategories } from "../wow/game_data/achievement.js";
+import type { Heirlooms } from "../wow/game_data/heirloom.js";
+import type { ItemAppearanceSearch, ItemAppearanceSearchResult } from "../wow/game_data/item_appearance.js";
+import type { JournalEncounters, JournalExpansions, JournalInstances } from "../wow/game_data/journal.js";
+import type { Mount } from "../wow/game_data/mount.js";
+import type { Pet, PetAbilities } from "../wow/game_data/pet.js";
+import type { PlayableSpecialization, PlayableSpecializations } from "../wow/game_data/playable_specialization.js";
+import type { ProfessionRecipie } from "../wow/game_data/profession.js";
+import type { Quest } from "../wow/game_data/quest.js";
+import type { ReputationFaction } from "../wow/game_data/reputations.js";
+import type { TalentTree, TalentTrees } from "../wow/game_data/talent.js";
+import type { Title } from "../wow/game_data/title.js";
+/** Makes the keys K of T optional. */
+type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/** Achievement category index as returned for Forever (no guild achievements). */
+export interface ForeverAchievementCategories extends WithOptional<AchievementCategories, "guild_categories"> {
+}
+/** Heirloom index as returned for Forever (omitted while empty). */
+export interface ForeverHeirlooms extends WithOptional<Heirlooms, "heirlooms"> {
+}
+/** Item appearance search result as returned for Forever (no slot). */
+export interface ForeverItemAppearanceSearchResult extends Omit<ItemAppearanceSearchResult, "data"> {
+    data: WithOptional<ItemAppearanceSearchResult["data"], "slot">;
+}
+/** Item appearance search as returned for Forever. */
+export interface ForeverItemAppearanceSearch extends Omit<ItemAppearanceSearch, "results"> {
+    results: ForeverItemAppearanceSearchResult[];
+}
+/** Journal encounter index as returned for Forever (omitted while empty). */
+export interface ForeverJournalEncounters extends WithOptional<JournalEncounters, "encounters"> {
+}
+/** Journal expansion index as returned for Forever (omitted while empty). */
+export interface ForeverJournalExpansions extends WithOptional<JournalExpansions, "tiers"> {
+}
+/** Journal instance index as returned for Forever (omitted while empty). */
+export interface ForeverJournalInstances extends WithOptional<JournalInstances, "instances"> {
+}
+/** Mount as returned for Forever (no source). */
+export interface ForeverMount extends WithOptional<Mount, "source"> {
+}
+/** Battle pet as returned for Forever (no abilities or source). */
+export interface ForeverPet extends Omit<WithOptional<Pet, "abilities" | "source" | "should_exclude_if_uncollected">, "description"> {
+    /** null for pets without a description. */
+    description: Pet["description"] | null;
+}
+/** Pet ability index as returned for Forever (omitted while empty). */
+export interface ForeverPetAbilities extends WithOptional<PetAbilities, "abilities"> {
+}
+/** Playable specialization as returned for Forever (no role, primary stat or gendered description). */
+export interface ForeverPlayableSpecialization extends WithOptional<PlayableSpecialization, "gender_description" | "role" | "primary_stat_type"> {
+}
+/** Playable specialization index as returned for Forever (no hunter pet specializations). */
+export interface ForeverPlayableSpecializations extends WithOptional<PlayableSpecializations, "pet_specializations"> {
+}
+/** Profession recipe as returned for Forever (no rank). */
+export interface ForeverProfessionRecipie extends WithOptional<ProfessionRecipie, "rank"> {
+}
+/** Quest as returned for Forever (requirements can be empty). */
+export interface ForeverQuest extends Omit<Quest, "requirements"> {
+    requirements: Partial<Quest["requirements"]>;
+}
+/** Reputation faction as returned for Forever (no description). */
+export interface ForeverReputationFaction extends WithOptional<ReputationFaction, "description"> {
+}
+/** Talent tree as returned for Forever (no hero talents, restriction lines or class talent nodes). */
+export interface ForeverTalentTree extends WithOptional<TalentTree, "restriction_lines" | "class_talent_nodes" | "hero_talent_trees"> {
+}
+/** Talent tree index as returned for Forever (no hero talents). */
+export interface ForeverTalentTrees extends WithOptional<TalentTrees, "hero_talent_trees"> {
+}
+/** Title as returned for Forever (no source). */
+export interface ForeverTitle extends WithOptional<Title, "source"> {
+}
+/**
+ * Returns an index of achievement categories.
+ *
+ * @returns A promise that resolves to an object representing an index of achievement categories.
+ */
+export declare function achievementCategories(ctx: ApiContext): Promise<ForeverAchievementCategories>;
+/**
+ * Returns an index of heirlooms.
+ *
+ * @returns A promise that resolves to an object representing an index of heirlooms.
+ */
+export declare function heirlooms(ctx: ApiContext): Promise<ForeverHeirlooms>;
+/**
+ * Performs a search of item appearances.
+ *
+ * @param searchParameters - Search parameters, e.g. `{ _page: 1, orderby: "id" }`.
+ * @returns A promise that resolves to an object representing the search results.
+ */
+export declare function searchItemAppearance(ctx: ApiContext, searchParameters: SearchParameters): Promise<ForeverItemAppearanceSearch>;
+/**
+ * Returns an index of journal encounters.
+ *
+ * @returns A promise that resolves to an object representing an index of journal encounters.
+ */
+export declare function journalEncounters(ctx: ApiContext): Promise<ForeverJournalEncounters>;
+/**
+ * Returns an index of journal expansions.
+ *
+ * @returns A promise that resolves to an object representing an index of journal expansions.
+ */
+export declare function journalExpansions(ctx: ApiContext): Promise<ForeverJournalExpansions>;
+/**
+ * Returns an index of journal instances.
+ *
+ * @returns A promise that resolves to an object representing an index of journal instances.
+ */
+export declare function journalInstances(ctx: ApiContext): Promise<ForeverJournalInstances>;
+/**
+ * Returns a mount by ID.
+ *
+ * @param mountId - The ID of the mount.
+ * @returns A promise that resolves to an object representing the mount.
+ */
+export declare function mount(ctx: ApiContext, mountId: number): Promise<ForeverMount>;
+/**
+ * Returns a battle pet by ID.
+ *
+ * @param petId - The ID of the pet.
+ * @returns A promise that resolves to an object representing the battle pet.
+ */
+export declare function pet(ctx: ApiContext, petId: number): Promise<ForeverPet>;
+/**
+ * Returns an index of pet abilities.
+ *
+ * @returns A promise that resolves to an object representing an index of pet abilities.
+ */
+export declare function petAbilities(ctx: ApiContext): Promise<ForeverPetAbilities>;
+/**
+ * Returns a playable specialization by ID.
+ *
+ * @param specId - The ID of the playable specialization.
+ * @returns A promise that resolves to an object representing the playable specialization.
+ */
+export declare function playableSpecialization(ctx: ApiContext, specId: number): Promise<ForeverPlayableSpecialization>;
+/**
+ * Returns an index of playable specializations.
+ *
+ * @returns A promise that resolves to an object representing an index of playable specializations.
+ */
+export declare function playableSpecializations(ctx: ApiContext): Promise<ForeverPlayableSpecializations>;
+/**
+ * Returns a recipe by ID.
+ *
+ * @param recipeId - The ID of the recipe.
+ * @returns A promise that resolves to an object representing the recipe.
+ */
+export declare function professionRecipie(ctx: ApiContext, recipeId: number): Promise<ForeverProfessionRecipie>;
+/**
+ * Returns a quest by ID.
+ *
+ * @param questId - The ID of the quest.
+ * @returns A promise that resolves to an object representing the quest.
+ */
+export declare function quest(ctx: ApiContext, questId: number): Promise<ForeverQuest>;
+/**
+ * Returns a reputation faction by ID.
+ *
+ * @param reputationFactionId - The ID of the reputation faction.
+ * @returns A promise that resolves to an object representing the reputation faction.
+ */
+export declare function reputationFaction(ctx: ApiContext, reputationFactionId: string): Promise<ForeverReputationFaction>;
+/**
+ * Returns a talent tree by specialization ID.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @param specId - The unique identifier for the specialization.
+ * @returns A promise that resolves to an object representing details about a talent tree.
+ */
+export declare function talentTree(ctx: ApiContext, talentTreeId: number, specId: number): Promise<ForeverTalentTree>;
+/**
+ * Returns an index of talent trees.
+ *
+ * @returns A promise that resolves to an object representing an index of talent trees.
+ */
+export declare function talentTrees(ctx: ApiContext): Promise<ForeverTalentTrees>;
+/**
+ * Returns a title by ID.
+ *
+ * @param titleId - The ID of the title.
+ * @returns A promise that resolves to an object representing the title.
+ */
+export declare function title(ctx: ApiContext, titleId: number): Promise<ForeverTitle>;
+export {};

package/esm/src/wow_forever/game_data.js

@@ -0,0 +1,166 @@
+/**
+ * WoW: Forever versions of Retail game data endpoints whose Forever responses lack fields that Retail always returns:
+ * systems Forever doesn't have (hero talents, hunter pet specializations, guild achievements, sources) and indexes
+ * that are empty before launch, which the API omits instead of returning an empty list.
+ * Each one makes the same request as the Retail endpoint, but returns a type where those fields are optional,
+ * so the Retail types can keep them required.
+ * Verified against the live API (EU) on 2026-11-02, before launch.
+ */
+import { achievementCategories as retailAchievementCategories } from "../wow/game_data/achievement.js";
+import { heirlooms as retailHeirlooms } from "../wow/game_data/heirloom.js";
+import { searchItemAppearance as retailSearchItemAppearance } from "../wow/game_data/item_appearance.js";
+import { journalEncounters as retailJournalEncounters, journalExpansions as retailJournalExpansions, journalInstances as retailJournalInstances, } from "../wow/game_data/journal.js";
+import { mount as retailMount } from "../wow/game_data/mount.js";
+import { pet as retailPet, petAbilities as retailPetAbilities } from "../wow/game_data/pet.js";
+import { playableSpecialization as retailPlayableSpecialization, playableSpecializations as retailPlayableSpecializations, } from "../wow/game_data/playable_specialization.js";
+import { professionRecipie as retailProfessionRecipie } from "../wow/game_data/profession.js";
+import { quest as retailQuest } from "../wow/game_data/quest.js";
+import { reputationFaction as retailReputationFaction } from "../wow/game_data/reputations.js";
+import { talentTree as retailTalentTree, talentTrees as retailTalentTrees } from "../wow/game_data/talent.js";
+import { title as retailTitle } from "../wow/game_data/title.js";
+/**
+ * Returns an index of achievement categories.
+ *
+ * @returns A promise that resolves to an object representing an index of achievement categories.
+ */
+export async function achievementCategories(ctx) {
+    return await retailAchievementCategories(ctx);
+}
+/**
+ * Returns an index of heirlooms.
+ *
+ * @returns A promise that resolves to an object representing an index of heirlooms.
+ */
+export async function heirlooms(ctx) {
+    return await retailHeirlooms(ctx);
+}
+/**
+ * Performs a search of item appearances.
+ *
+ * @param searchParameters - Search parameters, e.g. `{ _page: 1, orderby: "id" }`.
+ * @returns A promise that resolves to an object representing the search results.
+ */
+export async function searchItemAppearance(ctx, searchParameters) {
+    return await retailSearchItemAppearance(ctx, searchParameters);
+}
+/**
+ * Returns an index of journal encounters.
+ *
+ * @returns A promise that resolves to an object representing an index of journal encounters.
+ */
+export async function journalEncounters(ctx) {
+    return await retailJournalEncounters(ctx);
+}
+/**
+ * Returns an index of journal expansions.
+ *
+ * @returns A promise that resolves to an object representing an index of journal expansions.
+ */
+export async function journalExpansions(ctx) {
+    return await retailJournalExpansions(ctx);
+}
+/**
+ * Returns an index of journal instances.
+ *
+ * @returns A promise that resolves to an object representing an index of journal instances.
+ */
+export async function journalInstances(ctx) {
+    return await retailJournalInstances(ctx);
+}
+/**
+ * Returns a mount by ID.
+ *
+ * @param mountId - The ID of the mount.
+ * @returns A promise that resolves to an object representing the mount.
+ */
+export async function mount(ctx, mountId) {
+    return await retailMount(ctx, mountId);
+}
+/**
+ * Returns a battle pet by ID.
+ *
+ * @param petId - The ID of the pet.
+ * @returns A promise that resolves to an object representing the battle pet.
+ */
+export async function pet(ctx, petId) {
+    return await retailPet(ctx, petId);
+}
+/**
+ * Returns an index of pet abilities.
+ *
+ * @returns A promise that resolves to an object representing an index of pet abilities.
+ */
+export async function petAbilities(ctx) {
+    return await retailPetAbilities(ctx);
+}
+/**
+ * Returns a playable specialization by ID.
+ *
+ * @param specId - The ID of the playable specialization.
+ * @returns A promise that resolves to an object representing the playable specialization.
+ */
+export async function playableSpecialization(ctx, specId) {
+    return await retailPlayableSpecialization(ctx, specId);
+}
+/**
+ * Returns an index of playable specializations.
+ *
+ * @returns A promise that resolves to an object representing an index of playable specializations.
+ */
+export async function playableSpecializations(ctx) {
+    return await retailPlayableSpecializations(ctx);
+}
+/**
+ * Returns a recipe by ID.
+ *
+ * @param recipeId - The ID of the recipe.
+ * @returns A promise that resolves to an object representing the recipe.
+ */
+export async function professionRecipie(ctx, recipeId) {
+    return await retailProfessionRecipie(ctx, recipeId);
+}
+/**
+ * Returns a quest by ID.
+ *
+ * @param questId - The ID of the quest.
+ * @returns A promise that resolves to an object representing the quest.
+ */
+export async function quest(ctx, questId) {
+    return await retailQuest(ctx, questId);
+}
+/**
+ * Returns a reputation faction by ID.
+ *
+ * @param reputationFactionId - The ID of the reputation faction.
+ * @returns A promise that resolves to an object representing the reputation faction.
+ */
+export async function reputationFaction(ctx, reputationFactionId) {
+    return await retailReputationFaction(ctx, reputationFactionId);
+}
+/**
+ * Returns a talent tree by specialization ID.
+ *
+ * @param talentTreeId - The unique identifier for the talent tree.
+ * @param specId - The unique identifier for the specialization.
+ * @returns A promise that resolves to an object representing details about a talent tree.
+ */
+export async function talentTree(ctx, talentTreeId, specId) {
+    return await retailTalentTree(ctx, talentTreeId, specId);
+}
+/**
+ * Returns an index of talent trees.
+ *
+ * @returns A promise that resolves to an object representing an index of talent trees.
+ */
+export async function talentTrees(ctx) {
+    return await retailTalentTrees(ctx);
+}
+/**
+ * Returns a title by ID.
+ *
+ * @param titleId - The ID of the title.
+ * @returns A promise that resolves to an object representing the title.
+ */
+export async function title(ctx, titleId) {
+    return await retailTitle(ctx, titleId);
+}

package/esm/src/wow_forever/guild.d.ts

@@ -0,0 +1,88 @@
+/**
+ * WoW: Forever guild endpoints. Forever guilds are realmless: a guild is identified by its name slug alone
+ * (`/data/wow/guild/{nameSlug}`) and belongs to a ruleset instead of a realm.
+ * Verified against the live API (EU) on 2026-11-05.
+ */
+import type { ApiContext, Href, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../shared/index.js";
+import type { Guild, GuildAchievements, GuildActivity } from "../wow/profile/guild.js";
+import type { ForeverCharacterRef } from "./character.js";
+/** A reference to a Forever guild, as found in the `guild` field of the guild endpoints. */
+export interface ForeverGuildRef {
+    key: Href;
+    name: LocalizedString;
+    id: number;
+    faction: TypeName;
+    slug: string;
+}
+/** Guild as returned for Forever. */
+export interface ForeverGuild extends Omit<Guild, "key" | "realm"> {
+    slug: string;
+    /** The guild's ruleset (Normal, PvP, Roleplay, Roleplay PvP). */
+    ruleset: KeyNameId;
+}
+/**
+ * Guild achievements as returned for Forever. `total_quantity`, `total_points` and `achievements` are absent while
+ * the guild has no achievement progress.
+ */
+export interface ForeverGuildAchievements extends Partial<Pick<GuildAchievements, "total_quantity" | "total_points" | "achievements">>, Pick<GuildAchievements, "category_progress" | "recent_events"> {
+    _links: {
+        self: Href;
+    };
+    guild: ForeverGuildRef;
+}
+/** Guild activity as returned for Forever. */
+export interface ForeverGuildActivity extends Omit<GuildActivity, "guild" | "activities"> {
+    guild: ForeverGuildRef;
+    /** Absent while the guild has no recent activity. */
+    activities?: (Omit<NonNullable<GuildActivity["activities"]>[number], "character_achievement"> & {
+        character_achievement?: {
+            character: ForeverCharacterRef;
+            achievement: KeyNameId;
+        };
+    })[];
+}
+/** A guild member in the Forever guild roster. */
+export interface ForeverGuildRosterMemberCharacter extends ForeverCharacterRef {
+    level: number;
+    playable_class: KeyId;
+    playable_race: KeyId;
+    faction: {
+        type: string;
+    };
+}
+/** Guild roster as returned for Forever. */
+export interface ForeverGuildRoster extends LinkSelfHref {
+    guild: ForeverGuildRef;
+    members: {
+        character: ForeverGuildRosterMemberCharacter;
+        rank: number;
+    }[];
+}
+/**
+ * Returns a single guild by its name slug.
+ *
+ * @param nameSlug - The slug of the guild, e.g. "unbound".
+ * @returns A promise that resolves to an object representing the guild.
+ */
+export declare function guild(ctx: ApiContext, nameSlug: string): Promise<ForeverGuild>;
+/**
+ * Returns a guild's recent activity.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's activity.
+ */
+export declare function guildActivity(ctx: ApiContext, nameSlug: string): Promise<ForeverGuildActivity>;
+/**
+ * Returns a guild's achievements.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's achievements.
+ */
+export declare function guildAchievements(ctx: ApiContext, nameSlug: string): Promise<ForeverGuildAchievements>;
+/**
+ * Returns a guild's roster.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's roster.
+ */
+export declare function guildRoster(ctx: ApiContext, nameSlug: string): Promise<ForeverGuildRoster>;

package/esm/src/wow_forever/guild.js

@@ -0,0 +1,57 @@
+/**
+ * WoW: Forever guild endpoints. Forever guilds are realmless: a guild is identified by its name slug alone
+ * (`/data/wow/guild/{nameSlug}`) and belongs to a ruleset instead of a realm.
+ * Verified against the live API (EU) on 2026-11-05.
+ */
+/**
+ * Returns a single guild by its name slug.
+ *
+ * @param nameSlug - The slug of the guild, e.g. "unbound".
+ * @returns A promise that resolves to an object representing the guild.
+ */
+export async function guild(ctx, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${nameSlug}`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a guild's recent activity.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's activity.
+ */
+export async function guildActivity(ctx, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${nameSlug}/activity`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a guild's achievements.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's achievements.
+ */
+export async function guildAchievements(ctx, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${nameSlug}/achievements`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a guild's roster.
+ *
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing the guild's roster.
+ */
+export async function guildRoster(ctx, nameSlug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/guild/${nameSlug}/roster`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow_forever/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * World of Warcraft: Forever endpoints, namespace variant "forever". These are the Retail endpoint functions that
+ * the Forever API supports; the client binds them to a "forever" context. Forever runs on the Retail game data
+ * (specializations, talents, mounts, pets, toys, ...) with Classic-era content.
+ *
+ * Forever is realmless: players pick a ruleset (Normal, PvP, Roleplay, Roleplay PvP), not a realm, and characters are
+ * looked up by `name` and `surname`. The realm endpoints are left out (the realm index was taken down at launch);
+ * use `rulesets()`. Guilds are looked up by name slug alone. Auction endpoints are not included yet: the ruleset
+ * auctions route exists but returns no data.
+ * Verified against the live API (EU) on 2026-11-05.
+ */
+export { achievement, achievementCategory, achievementMedia, achievements } from "../wow/game_data/achievement.js";
+export { creature, creatureDisplayMedia, creatureFamilies, creatureFamily, creatureFamilyMedia, creatureType, creatureTypes, searchCreature, } from "../wow/game_data/creature.js";
+export { guildCrestBorder, guildCrestEmblem, guildCrests } from "../wow/game_data/guild_crest.js";
+export { heirloom } from "../wow/game_data/heirloom.js";
+export { item, itemClass, itemClasses, itemMedia, itemSet, itemSets, itemSubclass, searchItem, } from "../wow/game_data/item.js";
+export { itemAppearance, itemAppearanceSet, itemAppearanceSets, itemAppearanceSlot, itemAppearanceSlots, } from "../wow/game_data/item_appearance.js";
+export { journalEncounter, journalExpansion, journalInstance, journalInstanceMedia, searchJournalEncounter, } from "../wow/game_data/journal.js";
+export { searchMedia } from "../wow/game_data/media_search.js";
+export { mounts, searchMount } from "../wow/game_data/mount.js";
+export { petAbility, petAbilityMedia, petMedia, pets } from "../wow/game_data/pet.js";
+export { playableClass, playableClasses, playableClassMedia } from "../wow/game_data/playable_class.js";
+export { playableSpecializationMedia } from "../wow/game_data/playable_specialization.js";
+export { playableRace, playableRaces } from "../wow/game_data/playable_race.js";
+export { powerType, powerTypes } from "../wow/game_data/power_type.js";
+export { profession, professionMedia, professionRecipieMedia, professions, professionSkillTier, } from "../wow/game_data/profession.js";
+export { questArea, questAreas, questCategories, questCategory, quests, questType, questTypes, } from "../wow/game_data/quest.js";
+export { region, regions } from "../wow/game_data/region.js";
+export { reputationFactions, reputationTier, reputationTiers } from "../wow/game_data/reputations.js";
+export { searchSpell, spell, spellMedia } from "../wow/game_data/spell.js";
+export { talent, talents, talentTreeNodes } from "../wow/game_data/talent.js";
+export { titles } from "../wow/game_data/title.js";
+export { toy, toys } from "../wow/game_data/toy.js";
+export { achievementCategories, heirlooms, journalEncounters, journalExpansions, journalInstances, mount, pet, petAbilities, playableSpecialization, playableSpecializations, professionRecipie, quest, reputationFaction, searchItemAppearance, talentTree, talentTrees, title, } from "./game_data.js";
+export { ruleset, rulesets } from "./ruleset.js";
+export { characterAchievementStatistics, characterAchievementSummary, characterAppearanceSummary, characterCollectionHeirlooms, characterCollectionMounts, characterCollectionPets, characterCollectionToys, characterCollectionTransmogs, characterCollectionTypes, characterCompletedQuests, characterEncounterDungeons, characterEncounterRaids, characterEncounters, characterEquipments, characterMedia, characterMythicKeystoneProfile, characterProfessions, characterProfile, characterProfileStatus, characterPvpSummary, characterQuests, characterReputations, characterSpecializations, characterStatistics, characterTitles, } from "./character.js";
+export { guild, guildAchievements, guildActivity, guildRoster } from "./guild.js";
+export { accountCollectionsIndex, accountHeirloomsCollection, accountMountsCollection, accountPetsCollection, accountToysCollection, } from "../wow/profile/account_profile.js";
+export { accountProfileSummary, accountTransmogsCollection } from "./account.js";

package/esm/src/wow_forever/index.js

@@ -0,0 +1,45 @@
+/**
+ * World of Warcraft: Forever endpoints, namespace variant "forever". These are the Retail endpoint functions that
+ * the Forever API supports; the client binds them to a "forever" context. Forever runs on the Retail game data
+ * (specializations, talents, mounts, pets, toys, ...) with Classic-era content.
+ *
+ * Forever is realmless: players pick a ruleset (Normal, PvP, Roleplay, Roleplay PvP), not a realm, and characters are
+ * looked up by `name` and `surname`. The realm endpoints are left out (the realm index was taken down at launch);
+ * use `rulesets()`. Guilds are looked up by name slug alone. Auction endpoints are not included yet: the ruleset
+ * auctions route exists but returns no data.
+ * Verified against the live API (EU) on 2026-11-05.
+ */
+// Game Data APIs
+export { achievement, achievementCategory, achievementMedia, achievements } from "../wow/game_data/achievement.js";
+export { creature, creatureDisplayMedia, creatureFamilies, creatureFamily, creatureFamilyMedia, creatureType, creatureTypes, searchCreature, } from "../wow/game_data/creature.js";
+export { guildCrestBorder, guildCrestEmblem, guildCrests } from "../wow/game_data/guild_crest.js";
+export { heirloom } from "../wow/game_data/heirloom.js";
+export { item, itemClass, itemClasses, itemMedia, itemSet, itemSets, itemSubclass, searchItem, } from "../wow/game_data/item.js";
+export { itemAppearance, itemAppearanceSet, itemAppearanceSets, itemAppearanceSlot, itemAppearanceSlots, } from "../wow/game_data/item_appearance.js";
+export { journalEncounter, journalExpansion, journalInstance, journalInstanceMedia, searchJournalEncounter, } from "../wow/game_data/journal.js";
+export { searchMedia } from "../wow/game_data/media_search.js";
+export { mounts, searchMount } from "../wow/game_data/mount.js";
+export { petAbility, petAbilityMedia, petMedia, pets } from "../wow/game_data/pet.js";
+export { playableClass, playableClasses, playableClassMedia } from "../wow/game_data/playable_class.js";
+export { playableSpecializationMedia } from "../wow/game_data/playable_specialization.js";
+export { playableRace, playableRaces } from "../wow/game_data/playable_race.js";
+export { powerType, powerTypes } from "../wow/game_data/power_type.js";
+export { profession, professionMedia, professionRecipieMedia, professions, professionSkillTier, } from "../wow/game_data/profession.js";
+export { questArea, questAreas, questCategories, questCategory, quests, questType, questTypes, } from "../wow/game_data/quest.js";
+export { region, regions } from "../wow/game_data/region.js";
+export { reputationFactions, reputationTier, reputationTiers } from "../wow/game_data/reputations.js";
+export { searchSpell, spell, spellMedia } from "../wow/game_data/spell.js";
+export { talent, talents, talentTreeNodes } from "../wow/game_data/talent.js";
+export { titles } from "../wow/game_data/title.js";
+export { toy, toys } from "../wow/game_data/toy.js";
+// Forever-typed versions of Retail endpoints (fields Retail always returns are optional here)
+export { achievementCategories, heirlooms, journalEncounters, journalExpansions, journalInstances, mount, pet, petAbilities, playableSpecialization, playableSpecializations, professionRecipie, quest, reputationFaction, searchItemAppearance, talentTree, talentTrees, title, } from "./game_data.js";
+// Rulesets (replace realms)
+export { ruleset, rulesets } from "./ruleset.js";
+// Character Profile APIs (realmless: name and surname)
+export { characterAchievementStatistics, characterAchievementSummary, characterAppearanceSummary, characterCollectionHeirlooms, characterCollectionMounts, characterCollectionPets, characterCollectionToys, characterCollectionTransmogs, characterCollectionTypes, characterCompletedQuests, characterEncounterDungeons, characterEncounterRaids, characterEncounters, characterEquipments, characterMedia, characterMythicKeystoneProfile, characterProfessions, characterProfile, characterProfileStatus, characterPvpSummary, characterQuests, characterReputations, characterSpecializations, characterStatistics, characterTitles, } from "./character.js";
+// Guild APIs (realmless: name slug)
+export { guild, guildAchievements, guildActivity, guildRoster } from "./guild.js";
+// Account Profile APIs (user token)
+export { accountCollectionsIndex, accountHeirloomsCollection, accountMountsCollection, accountPetsCollection, accountToysCollection, } from "../wow/profile/account_profile.js";
+export { accountProfileSummary, accountTransmogsCollection } from "./account.js";

package/esm/src/wow_forever/ruleset.d.ts

@@ -0,0 +1,32 @@
+/**
+ * WoW: Forever ruleset endpoints. Forever is realmless: players pick a ruleset (Normal, PvP, Roleplay, Roleplay PvP)
+ * instead of a realm, and each ruleset has its own auction house. The ruleset index replaces the realm index.
+ * Verified against the live API (EU, US, KR, TW) on 2026-11-05.
+ */
+import type { ApiContext, Href, KeyId, LinkSelfHref, LocalizedString, TypeName } from "../shared/index.js";
+/** The index of rulesets in a region. */
+export interface ForeverRulesets extends LinkSelfHref {
+    rulesets: KeyId[];
+}
+/** A Forever ruleset. */
+export interface ForeverRuleset extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    /** The ruleset's auction house. */
+    auctions: Href;
+    /** The ruleset's status, e.g. `UP`. */
+    status: TypeName;
+}
+/**
+ * Returns an index of the rulesets in the region.
+ *
+ * @returns A promise that resolves to an object representing the ruleset index.
+ */
+export declare function rulesets(ctx: ApiContext): Promise<ForeverRulesets>;
+/**
+ * Returns a ruleset by ID.
+ *
+ * @param rulesetId - The ID of the ruleset.
+ * @returns A promise that resolves to an object representing the ruleset.
+ */
+export declare function ruleset(ctx: ApiContext, rulesetId: number): Promise<ForeverRuleset>;

package/esm/src/wow_forever/ruleset.js

@@ -0,0 +1,30 @@
+/**
+ * WoW: Forever ruleset endpoints. Forever is realmless: players pick a ruleset (Normal, PvP, Roleplay, Roleplay PvP)
+ * instead of a realm, and each ruleset has its own auction house. The ruleset index replaces the realm index.
+ * Verified against the live API (EU, US, KR, TW) on 2026-11-05.
+ */
+/**
+ * Returns an index of the rulesets in the region.
+ *
+ * @returns A promise that resolves to an object representing the ruleset index.
+ */
+export async function rulesets(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/ruleset/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a ruleset by ID.
+ *
+ * @param rulesetId - The ID of the ruleset.
+ * @returns A promise that resolves to an object representing the ruleset.
+ */
+export async function ruleset(ctx, rulesetId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/ruleset/${rulesetId}`,
+        namespace: "dynamic",
+    });
+}