@pinta365/blizzard_api 0.7.1 → 0.8.0

package/script/src/wow_forever/index.js

@@ -0,0 +1,180 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.profession = exports.powerTypes = exports.powerType = exports.playableRaces = exports.playableRace = exports.playableSpecializationMedia = exports.playableClassMedia = exports.playableClasses = exports.playableClass = exports.pets = exports.petMedia = exports.petAbilityMedia = exports.petAbility = exports.searchMount = exports.mounts = exports.searchMedia = exports.searchJournalEncounter = exports.journalInstanceMedia = exports.journalInstance = exports.journalExpansion = exports.journalEncounter = exports.itemAppearanceSlots = exports.itemAppearanceSlot = exports.itemAppearanceSets = exports.itemAppearanceSet = exports.itemAppearance = exports.searchItem = exports.itemSubclass = exports.itemSets = exports.itemSet = exports.itemMedia = exports.itemClasses = exports.itemClass = exports.item = exports.heirloom = exports.guildCrests = exports.guildCrestEmblem = exports.guildCrestBorder = exports.searchCreature = exports.creatureTypes = exports.creatureType = exports.creatureFamilyMedia = exports.creatureFamily = exports.creatureFamilies = exports.creatureDisplayMedia = exports.creature = exports.achievements = exports.achievementMedia = exports.achievementCategory = exports.achievement = void 0;
+exports.characterCollectionPets = exports.characterCollectionMounts = exports.characterCollectionHeirlooms = exports.characterAppearanceSummary = exports.characterAchievementSummary = exports.characterAchievementStatistics = exports.rulesets = exports.ruleset = exports.title = exports.talentTrees = exports.talentTree = exports.searchItemAppearance = exports.reputationFaction = exports.quest = exports.professionRecipie = exports.playableSpecializations = exports.playableSpecialization = exports.petAbilities = exports.pet = exports.mount = exports.journalInstances = exports.journalExpansions = exports.journalEncounters = exports.heirlooms = exports.achievementCategories = exports.toys = exports.toy = exports.titles = exports.talentTreeNodes = exports.talents = exports.talent = exports.spellMedia = exports.spell = exports.searchSpell = exports.reputationTiers = exports.reputationTier = exports.reputationFactions = exports.regions = exports.region = exports.questTypes = exports.questType = exports.quests = exports.questCategory = exports.questCategories = exports.questAreas = exports.questArea = exports.professionSkillTier = exports.professions = exports.professionRecipieMedia = exports.professionMedia = void 0;
+exports.accountTransmogsCollection = exports.accountProfileSummary = exports.accountToysCollection = exports.accountPetsCollection = exports.accountMountsCollection = exports.accountHeirloomsCollection = exports.accountCollectionsIndex = exports.guildRoster = exports.guildActivity = exports.guildAchievements = exports.guild = exports.characterTitles = exports.characterStatistics = exports.characterSpecializations = exports.characterReputations = exports.characterQuests = exports.characterPvpSummary = exports.characterProfileStatus = exports.characterProfile = exports.characterProfessions = exports.characterMythicKeystoneProfile = exports.characterMedia = exports.characterEquipments = exports.characterEncounters = exports.characterEncounterRaids = exports.characterEncounterDungeons = exports.characterCompletedQuests = exports.characterCollectionTypes = exports.characterCollectionTransmogs = exports.characterCollectionToys = void 0;
+// Game Data APIs
+var achievement_js_1 = require("../wow/game_data/achievement.js");
+Object.defineProperty(exports, "achievement", { enumerable: true, get: function () { return achievement_js_1.achievement; } });
+Object.defineProperty(exports, "achievementCategory", { enumerable: true, get: function () { return achievement_js_1.achievementCategory; } });
+Object.defineProperty(exports, "achievementMedia", { enumerable: true, get: function () { return achievement_js_1.achievementMedia; } });
+Object.defineProperty(exports, "achievements", { enumerable: true, get: function () { return achievement_js_1.achievements; } });
+var creature_js_1 = require("../wow/game_data/creature.js");
+Object.defineProperty(exports, "creature", { enumerable: true, get: function () { return creature_js_1.creature; } });
+Object.defineProperty(exports, "creatureDisplayMedia", { enumerable: true, get: function () { return creature_js_1.creatureDisplayMedia; } });
+Object.defineProperty(exports, "creatureFamilies", { enumerable: true, get: function () { return creature_js_1.creatureFamilies; } });
+Object.defineProperty(exports, "creatureFamily", { enumerable: true, get: function () { return creature_js_1.creatureFamily; } });
+Object.defineProperty(exports, "creatureFamilyMedia", { enumerable: true, get: function () { return creature_js_1.creatureFamilyMedia; } });
+Object.defineProperty(exports, "creatureType", { enumerable: true, get: function () { return creature_js_1.creatureType; } });
+Object.defineProperty(exports, "creatureTypes", { enumerable: true, get: function () { return creature_js_1.creatureTypes; } });
+Object.defineProperty(exports, "searchCreature", { enumerable: true, get: function () { return creature_js_1.searchCreature; } });
+var guild_crest_js_1 = require("../wow/game_data/guild_crest.js");
+Object.defineProperty(exports, "guildCrestBorder", { enumerable: true, get: function () { return guild_crest_js_1.guildCrestBorder; } });
+Object.defineProperty(exports, "guildCrestEmblem", { enumerable: true, get: function () { return guild_crest_js_1.guildCrestEmblem; } });
+Object.defineProperty(exports, "guildCrests", { enumerable: true, get: function () { return guild_crest_js_1.guildCrests; } });
+var heirloom_js_1 = require("../wow/game_data/heirloom.js");
+Object.defineProperty(exports, "heirloom", { enumerable: true, get: function () { return heirloom_js_1.heirloom; } });
+var item_js_1 = require("../wow/game_data/item.js");
+Object.defineProperty(exports, "item", { enumerable: true, get: function () { return item_js_1.item; } });
+Object.defineProperty(exports, "itemClass", { enumerable: true, get: function () { return item_js_1.itemClass; } });
+Object.defineProperty(exports, "itemClasses", { enumerable: true, get: function () { return item_js_1.itemClasses; } });
+Object.defineProperty(exports, "itemMedia", { enumerable: true, get: function () { return item_js_1.itemMedia; } });
+Object.defineProperty(exports, "itemSet", { enumerable: true, get: function () { return item_js_1.itemSet; } });
+Object.defineProperty(exports, "itemSets", { enumerable: true, get: function () { return item_js_1.itemSets; } });
+Object.defineProperty(exports, "itemSubclass", { enumerable: true, get: function () { return item_js_1.itemSubclass; } });
+Object.defineProperty(exports, "searchItem", { enumerable: true, get: function () { return item_js_1.searchItem; } });
+var item_appearance_js_1 = require("../wow/game_data/item_appearance.js");
+Object.defineProperty(exports, "itemAppearance", { enumerable: true, get: function () { return item_appearance_js_1.itemAppearance; } });
+Object.defineProperty(exports, "itemAppearanceSet", { enumerable: true, get: function () { return item_appearance_js_1.itemAppearanceSet; } });
+Object.defineProperty(exports, "itemAppearanceSets", { enumerable: true, get: function () { return item_appearance_js_1.itemAppearanceSets; } });
+Object.defineProperty(exports, "itemAppearanceSlot", { enumerable: true, get: function () { return item_appearance_js_1.itemAppearanceSlot; } });
+Object.defineProperty(exports, "itemAppearanceSlots", { enumerable: true, get: function () { return item_appearance_js_1.itemAppearanceSlots; } });
+var journal_js_1 = require("../wow/game_data/journal.js");
+Object.defineProperty(exports, "journalEncounter", { enumerable: true, get: function () { return journal_js_1.journalEncounter; } });
+Object.defineProperty(exports, "journalExpansion", { enumerable: true, get: function () { return journal_js_1.journalExpansion; } });
+Object.defineProperty(exports, "journalInstance", { enumerable: true, get: function () { return journal_js_1.journalInstance; } });
+Object.defineProperty(exports, "journalInstanceMedia", { enumerable: true, get: function () { return journal_js_1.journalInstanceMedia; } });
+Object.defineProperty(exports, "searchJournalEncounter", { enumerable: true, get: function () { return journal_js_1.searchJournalEncounter; } });
+var media_search_js_1 = require("../wow/game_data/media_search.js");
+Object.defineProperty(exports, "searchMedia", { enumerable: true, get: function () { return media_search_js_1.searchMedia; } });
+var mount_js_1 = require("../wow/game_data/mount.js");
+Object.defineProperty(exports, "mounts", { enumerable: true, get: function () { return mount_js_1.mounts; } });
+Object.defineProperty(exports, "searchMount", { enumerable: true, get: function () { return mount_js_1.searchMount; } });
+var pet_js_1 = require("../wow/game_data/pet.js");
+Object.defineProperty(exports, "petAbility", { enumerable: true, get: function () { return pet_js_1.petAbility; } });
+Object.defineProperty(exports, "petAbilityMedia", { enumerable: true, get: function () { return pet_js_1.petAbilityMedia; } });
+Object.defineProperty(exports, "petMedia", { enumerable: true, get: function () { return pet_js_1.petMedia; } });
+Object.defineProperty(exports, "pets", { enumerable: true, get: function () { return pet_js_1.pets; } });
+var playable_class_js_1 = require("../wow/game_data/playable_class.js");
+Object.defineProperty(exports, "playableClass", { enumerable: true, get: function () { return playable_class_js_1.playableClass; } });
+Object.defineProperty(exports, "playableClasses", { enumerable: true, get: function () { return playable_class_js_1.playableClasses; } });
+Object.defineProperty(exports, "playableClassMedia", { enumerable: true, get: function () { return playable_class_js_1.playableClassMedia; } });
+var playable_specialization_js_1 = require("../wow/game_data/playable_specialization.js");
+Object.defineProperty(exports, "playableSpecializationMedia", { enumerable: true, get: function () { return playable_specialization_js_1.playableSpecializationMedia; } });
+var playable_race_js_1 = require("../wow/game_data/playable_race.js");
+Object.defineProperty(exports, "playableRace", { enumerable: true, get: function () { return playable_race_js_1.playableRace; } });
+Object.defineProperty(exports, "playableRaces", { enumerable: true, get: function () { return playable_race_js_1.playableRaces; } });
+var power_type_js_1 = require("../wow/game_data/power_type.js");
+Object.defineProperty(exports, "powerType", { enumerable: true, get: function () { return power_type_js_1.powerType; } });
+Object.defineProperty(exports, "powerTypes", { enumerable: true, get: function () { return power_type_js_1.powerTypes; } });
+var profession_js_1 = require("../wow/game_data/profession.js");
+Object.defineProperty(exports, "profession", { enumerable: true, get: function () { return profession_js_1.profession; } });
+Object.defineProperty(exports, "professionMedia", { enumerable: true, get: function () { return profession_js_1.professionMedia; } });
+Object.defineProperty(exports, "professionRecipieMedia", { enumerable: true, get: function () { return profession_js_1.professionRecipieMedia; } });
+Object.defineProperty(exports, "professions", { enumerable: true, get: function () { return profession_js_1.professions; } });
+Object.defineProperty(exports, "professionSkillTier", { enumerable: true, get: function () { return profession_js_1.professionSkillTier; } });
+var quest_js_1 = require("../wow/game_data/quest.js");
+Object.defineProperty(exports, "questArea", { enumerable: true, get: function () { return quest_js_1.questArea; } });
+Object.defineProperty(exports, "questAreas", { enumerable: true, get: function () { return quest_js_1.questAreas; } });
+Object.defineProperty(exports, "questCategories", { enumerable: true, get: function () { return quest_js_1.questCategories; } });
+Object.defineProperty(exports, "questCategory", { enumerable: true, get: function () { return quest_js_1.questCategory; } });
+Object.defineProperty(exports, "quests", { enumerable: true, get: function () { return quest_js_1.quests; } });
+Object.defineProperty(exports, "questType", { enumerable: true, get: function () { return quest_js_1.questType; } });
+Object.defineProperty(exports, "questTypes", { enumerable: true, get: function () { return quest_js_1.questTypes; } });
+var region_js_1 = require("../wow/game_data/region.js");
+Object.defineProperty(exports, "region", { enumerable: true, get: function () { return region_js_1.region; } });
+Object.defineProperty(exports, "regions", { enumerable: true, get: function () { return region_js_1.regions; } });
+var reputations_js_1 = require("../wow/game_data/reputations.js");
+Object.defineProperty(exports, "reputationFactions", { enumerable: true, get: function () { return reputations_js_1.reputationFactions; } });
+Object.defineProperty(exports, "reputationTier", { enumerable: true, get: function () { return reputations_js_1.reputationTier; } });
+Object.defineProperty(exports, "reputationTiers", { enumerable: true, get: function () { return reputations_js_1.reputationTiers; } });
+var spell_js_1 = require("../wow/game_data/spell.js");
+Object.defineProperty(exports, "searchSpell", { enumerable: true, get: function () { return spell_js_1.searchSpell; } });
+Object.defineProperty(exports, "spell", { enumerable: true, get: function () { return spell_js_1.spell; } });
+Object.defineProperty(exports, "spellMedia", { enumerable: true, get: function () { return spell_js_1.spellMedia; } });
+var talent_js_1 = require("../wow/game_data/talent.js");
+Object.defineProperty(exports, "talent", { enumerable: true, get: function () { return talent_js_1.talent; } });
+Object.defineProperty(exports, "talents", { enumerable: true, get: function () { return talent_js_1.talents; } });
+Object.defineProperty(exports, "talentTreeNodes", { enumerable: true, get: function () { return talent_js_1.talentTreeNodes; } });
+var title_js_1 = require("../wow/game_data/title.js");
+Object.defineProperty(exports, "titles", { enumerable: true, get: function () { return title_js_1.titles; } });
+var toy_js_1 = require("../wow/game_data/toy.js");
+Object.defineProperty(exports, "toy", { enumerable: true, get: function () { return toy_js_1.toy; } });
+Object.defineProperty(exports, "toys", { enumerable: true, get: function () { return toy_js_1.toys; } });
+// Forever-typed versions of Retail endpoints (fields Retail always returns are optional here)
+var game_data_js_1 = require("./game_data.js");
+Object.defineProperty(exports, "achievementCategories", { enumerable: true, get: function () { return game_data_js_1.achievementCategories; } });
+Object.defineProperty(exports, "heirlooms", { enumerable: true, get: function () { return game_data_js_1.heirlooms; } });
+Object.defineProperty(exports, "journalEncounters", { enumerable: true, get: function () { return game_data_js_1.journalEncounters; } });
+Object.defineProperty(exports, "journalExpansions", { enumerable: true, get: function () { return game_data_js_1.journalExpansions; } });
+Object.defineProperty(exports, "journalInstances", { enumerable: true, get: function () { return game_data_js_1.journalInstances; } });
+Object.defineProperty(exports, "mount", { enumerable: true, get: function () { return game_data_js_1.mount; } });
+Object.defineProperty(exports, "pet", { enumerable: true, get: function () { return game_data_js_1.pet; } });
+Object.defineProperty(exports, "petAbilities", { enumerable: true, get: function () { return game_data_js_1.petAbilities; } });
+Object.defineProperty(exports, "playableSpecialization", { enumerable: true, get: function () { return game_data_js_1.playableSpecialization; } });
+Object.defineProperty(exports, "playableSpecializations", { enumerable: true, get: function () { return game_data_js_1.playableSpecializations; } });
+Object.defineProperty(exports, "professionRecipie", { enumerable: true, get: function () { return game_data_js_1.professionRecipie; } });
+Object.defineProperty(exports, "quest", { enumerable: true, get: function () { return game_data_js_1.quest; } });
+Object.defineProperty(exports, "reputationFaction", { enumerable: true, get: function () { return game_data_js_1.reputationFaction; } });
+Object.defineProperty(exports, "searchItemAppearance", { enumerable: true, get: function () { return game_data_js_1.searchItemAppearance; } });
+Object.defineProperty(exports, "talentTree", { enumerable: true, get: function () { return game_data_js_1.talentTree; } });
+Object.defineProperty(exports, "talentTrees", { enumerable: true, get: function () { return game_data_js_1.talentTrees; } });
+Object.defineProperty(exports, "title", { enumerable: true, get: function () { return game_data_js_1.title; } });
+// Rulesets (replace realms)
+var ruleset_js_1 = require("./ruleset.js");
+Object.defineProperty(exports, "ruleset", { enumerable: true, get: function () { return ruleset_js_1.ruleset; } });
+Object.defineProperty(exports, "rulesets", { enumerable: true, get: function () { return ruleset_js_1.rulesets; } });
+// Character Profile APIs (realmless: name and surname)
+var character_js_1 = require("./character.js");
+Object.defineProperty(exports, "characterAchievementStatistics", { enumerable: true, get: function () { return character_js_1.characterAchievementStatistics; } });
+Object.defineProperty(exports, "characterAchievementSummary", { enumerable: true, get: function () { return character_js_1.characterAchievementSummary; } });
+Object.defineProperty(exports, "characterAppearanceSummary", { enumerable: true, get: function () { return character_js_1.characterAppearanceSummary; } });
+Object.defineProperty(exports, "characterCollectionHeirlooms", { enumerable: true, get: function () { return character_js_1.characterCollectionHeirlooms; } });
+Object.defineProperty(exports, "characterCollectionMounts", { enumerable: true, get: function () { return character_js_1.characterCollectionMounts; } });
+Object.defineProperty(exports, "characterCollectionPets", { enumerable: true, get: function () { return character_js_1.characterCollectionPets; } });
+Object.defineProperty(exports, "characterCollectionToys", { enumerable: true, get: function () { return character_js_1.characterCollectionToys; } });
+Object.defineProperty(exports, "characterCollectionTransmogs", { enumerable: true, get: function () { return character_js_1.characterCollectionTransmogs; } });
+Object.defineProperty(exports, "characterCollectionTypes", { enumerable: true, get: function () { return character_js_1.characterCollectionTypes; } });
+Object.defineProperty(exports, "characterCompletedQuests", { enumerable: true, get: function () { return character_js_1.characterCompletedQuests; } });
+Object.defineProperty(exports, "characterEncounterDungeons", { enumerable: true, get: function () { return character_js_1.characterEncounterDungeons; } });
+Object.defineProperty(exports, "characterEncounterRaids", { enumerable: true, get: function () { return character_js_1.characterEncounterRaids; } });
+Object.defineProperty(exports, "characterEncounters", { enumerable: true, get: function () { return character_js_1.characterEncounters; } });
+Object.defineProperty(exports, "characterEquipments", { enumerable: true, get: function () { return character_js_1.characterEquipments; } });
+Object.defineProperty(exports, "characterMedia", { enumerable: true, get: function () { return character_js_1.characterMedia; } });
+Object.defineProperty(exports, "characterMythicKeystoneProfile", { enumerable: true, get: function () { return character_js_1.characterMythicKeystoneProfile; } });
+Object.defineProperty(exports, "characterProfessions", { enumerable: true, get: function () { return character_js_1.characterProfessions; } });
+Object.defineProperty(exports, "characterProfile", { enumerable: true, get: function () { return character_js_1.characterProfile; } });
+Object.defineProperty(exports, "characterProfileStatus", { enumerable: true, get: function () { return character_js_1.characterProfileStatus; } });
+Object.defineProperty(exports, "characterPvpSummary", { enumerable: true, get: function () { return character_js_1.characterPvpSummary; } });
+Object.defineProperty(exports, "characterQuests", { enumerable: true, get: function () { return character_js_1.characterQuests; } });
+Object.defineProperty(exports, "characterReputations", { enumerable: true, get: function () { return character_js_1.characterReputations; } });
+Object.defineProperty(exports, "characterSpecializations", { enumerable: true, get: function () { return character_js_1.characterSpecializations; } });
+Object.defineProperty(exports, "characterStatistics", { enumerable: true, get: function () { return character_js_1.characterStatistics; } });
+Object.defineProperty(exports, "characterTitles", { enumerable: true, get: function () { return character_js_1.characterTitles; } });
+// Guild APIs (realmless: name slug)
+var guild_js_1 = require("./guild.js");
+Object.defineProperty(exports, "guild", { enumerable: true, get: function () { return guild_js_1.guild; } });
+Object.defineProperty(exports, "guildAchievements", { enumerable: true, get: function () { return guild_js_1.guildAchievements; } });
+Object.defineProperty(exports, "guildActivity", { enumerable: true, get: function () { return guild_js_1.guildActivity; } });
+Object.defineProperty(exports, "guildRoster", { enumerable: true, get: function () { return guild_js_1.guildRoster; } });
+// Account Profile APIs (user token)
+var account_profile_js_1 = require("../wow/profile/account_profile.js");
+Object.defineProperty(exports, "accountCollectionsIndex", { enumerable: true, get: function () { return account_profile_js_1.accountCollectionsIndex; } });
+Object.defineProperty(exports, "accountHeirloomsCollection", { enumerable: true, get: function () { return account_profile_js_1.accountHeirloomsCollection; } });
+Object.defineProperty(exports, "accountMountsCollection", { enumerable: true, get: function () { return account_profile_js_1.accountMountsCollection; } });
+Object.defineProperty(exports, "accountPetsCollection", { enumerable: true, get: function () { return account_profile_js_1.accountPetsCollection; } });
+Object.defineProperty(exports, "accountToysCollection", { enumerable: true, get: function () { return account_profile_js_1.accountToysCollection; } });
+var account_js_1 = require("./account.js");
+Object.defineProperty(exports, "accountProfileSummary", { enumerable: true, get: function () { return account_js_1.accountProfileSummary; } });
+Object.defineProperty(exports, "accountTransmogsCollection", { enumerable: true, get: function () { return account_js_1.accountTransmogsCollection; } });

package/script/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/script/src/wow_forever/ruleset.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rulesets = rulesets;
+exports.ruleset = ruleset;
+/**
+ * Returns an index of the rulesets in the region.
+ *
+ * @returns A promise that resolves to an object representing the ruleset index.
+ */
+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.
+ */
+async function ruleset(ctx, rulesetId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/ruleset/${rulesetId}`,
+        namespace: "dynamic",
+    });
+}

package/script/src/wow_forever/types.d.ts

@@ -0,0 +1,5 @@
+export type { ForeverAccountCharacter, ForeverAccountProfileSummary, ForeverAccountTransmogsCollection, } from "./account.js";
+export type { ForeverAchievementCategories, ForeverHeirlooms, ForeverItemAppearanceSearch, ForeverItemAppearanceSearchResult, ForeverJournalEncounters, ForeverJournalExpansions, ForeverJournalInstances, ForeverMount, ForeverPet, ForeverPetAbilities, ForeverPlayableSpecialization, ForeverPlayableSpecializations, ForeverProfessionRecipie, ForeverQuest, ForeverReputationFaction, ForeverTalentTree, ForeverTalentTrees, ForeverTitle, } from "./game_data.js";
+export type { ForeverCharacterAchievementStatistics, ForeverCharacterAchievementSummary, ForeverCharacterAppearanceSummary, ForeverCharacterCollectionHeirlooms, ForeverCharacterCollectionMounts, ForeverCharacterCollectionPets, ForeverCharacterCollectionToys, ForeverCharacterCollectionTransmogs, ForeverCharacterCollectionTypes, ForeverCharacterCompletedQuests, ForeverCharacterEncounterDungeons, ForeverCharacterEncounterRaids, ForeverCharacterEncounters, ForeverCharacterEquipment, ForeverCharacterMedia, ForeverCharacterMythicKeystoneProfile, ForeverCharacterProfessions, ForeverCharacterProfile, ForeverCharacterProfileStatus, ForeverCharacterPvpSummary, ForeverCharacterQuests, ForeverCharacterRef, ForeverCharacterReputations, ForeverCharacterSpecializations, ForeverCharacterStatistics, ForeverCharacterTalent, ForeverCharacterTitles, WithForeverCharacter, } from "./character.js";
+export type { ForeverRuleset, ForeverRulesets } from "./ruleset.js";
+export type { ForeverGuild, ForeverGuildAchievements, ForeverGuildActivity, ForeverGuildRef, ForeverGuildRoster, ForeverGuildRosterMemberCharacter, } from "./guild.js";

package/script/src/wow_forever/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });