@pinta365/blizzard_api 0.4.0 → 0.6.0

package/esm/src/wow_classic/profile_overrides.js

@@ -0,0 +1,111 @@
+/**
+ * Classic versions of Retail endpoints whose Classic responses lack fields that Retail always returns.
+ * 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-10-01.
+ */
+import { achievementCategories as retailAchievementCategories } from "../wow/game_data/achievement.js";
+import { commodities as retailCommodities } from "../wow/game_data/auction_house.js";
+import { connectedRealm as retailConnectedRealm } from "../wow/game_data/connected_realm.js";
+import { characterAchievementSummary as retailCharacterAchievementSummary } from "../wow/profile/character_achievements.js";
+import { characterAppearanceSummary as retailCharacterAppearanceSummary } from "../wow/profile/character_appearance.js";
+import { characterProfile as retailCharacterProfile } from "../wow/profile/character_profile.js";
+import { characterPvpSummary as retailCharacterPvpSummary } from "../wow/profile/character_pvp.js";
+import { characterSpecializations as retailCharacterSpecializations } from "../wow/profile/character_specializations.js";
+import { characterStatistics as retailCharacterStatistics } from "../wow/profile/character_statistics.js";
+import { guildAchievements as retailGuildAchievements } from "../wow/profile/guild.js";
+/**
+ * Returns a profile summary for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a profile summary for a character.
+ */
+export async function characterProfile(ctx, realmSlug, characterName) {
+    return await retailCharacterProfile(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a summary of a character's appearance settings.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of a character's appearance settings.
+ */
+export async function characterAppearanceSummary(ctx, realmSlug, characterName) {
+    return await retailCharacterAppearanceSummary(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a PvP summary for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a PvP summary for a character.
+ */
+export async function characterPvpSummary(ctx, realmSlug, characterName) {
+    return await retailCharacterPvpSummary(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a summary of the achievements a character has completed.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of the achievements a character has completed.
+ */
+export async function characterAchievementSummary(ctx, realmSlug, characterName) {
+    return await retailCharacterAchievementSummary(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a statistics summary for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a statistics summary for a character.
+ */
+export async function characterStatistics(ctx, realmSlug, characterName) {
+    return await retailCharacterStatistics(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a summary of a character's specializations.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of a character's specializations.
+ */
+export async function characterSpecializations(ctx, realmSlug, characterName) {
+    return await retailCharacterSpecializations(ctx, realmSlug, characterName);
+}
+/**
+ * Returns a single guild's achievements by name.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a guild's achievements.
+ */
+export async function guildAchievements(ctx, realmSlug, nameSlug) {
+    return await retailGuildAchievements(ctx, realmSlug, nameSlug);
+}
+/**
+ * Returns a connected realm by ID.
+ *
+ * @param connectedRealmId - The ID of the connected realm.
+ * @returns A promise that resolves to an object representing details about a connected realm.
+ */
+export async function connectedRealm(ctx, connectedRealmId) {
+    return await retailConnectedRealm(ctx, connectedRealmId);
+}
+/**
+ * Returns an index of achievement categories.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of achievement categories.
+ */
+export async function achievementCategories(ctx) {
+    return await retailAchievementCategories(ctx);
+}
+/**
+ * Returns all active auctions for commodity items for the entire game region.
+ *
+ * @returns A promise that resolves to an object representing the region's commodity auctions.
+ */
+export async function commodities(ctx) {
+    return await retailCommodities(ctx);
+}

package/esm/src/wow_classic/shared.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Endpoints that work for both Classic flavors (progression and Era). They are the Retail endpoint functions;
+ * the client binds them to a context whose namespaces carry the "classic" or "classic1x" variant.
+ * Verified against the live API (EU) on 2026-09-30.
+ */
+export { achievement, achievementCategory, achievementMedia, achievements } from "../wow/game_data/achievement.js";
+export { connectedRealms, searchConnectedRealm } from "../wow/game_data/connected_realm.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 { item, itemClass, itemClasses, itemMedia, itemSubclass, searchItem } from "../wow/game_data/item.js";
+export { searchMedia } from "../wow/game_data/media_search.js";
+export { playableClass, playableClasses, playableClassMedia } from "../wow/game_data/playable_class.js";
+export { playableRace, playableRaces } from "../wow/game_data/playable_race.js";
+export { powerType, powerTypes } from "../wow/game_data/power_type.js";
+export { realm, realms, searchRealm } from "../wow/game_data/realm.js";
+export { region, regions } from "../wow/game_data/region.js";
+export { characterEquipments } from "../wow/profile/character_equipment.js";
+export { characterHunterPets } from "../wow/profile/character_hunter_pets.js";
+export { characterMedia } from "../wow/profile/character_media.js";
+export { characterProfileStatus } from "../wow/profile/character_profile.js";
+export { characterReputations } from "../wow/profile/character_reputations.js";
+export { guild, guildActivity, guildRoster } from "../wow/profile/guild.js";
+export { achievementCategories, characterAppearanceSummary, characterProfile, characterPvpSummary, characterStatistics, connectedRealm, guildAchievements, } from "./profile_overrides.js";

package/esm/src/wow_classic/shared.js

@@ -0,0 +1,26 @@
+/**
+ * Endpoints that work for both Classic flavors (progression and Era). They are the Retail endpoint functions;
+ * the client binds them to a context whose namespaces carry the "classic" or "classic1x" variant.
+ * Verified against the live API (EU) on 2026-09-30.
+ */
+// Game Data APIs
+export { achievement, achievementCategory, achievementMedia, achievements } from "../wow/game_data/achievement.js";
+export { connectedRealms, searchConnectedRealm } from "../wow/game_data/connected_realm.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 { item, itemClass, itemClasses, itemMedia, itemSubclass, searchItem } from "../wow/game_data/item.js";
+export { searchMedia } from "../wow/game_data/media_search.js";
+export { playableClass, playableClasses, playableClassMedia } from "../wow/game_data/playable_class.js";
+export { playableRace, playableRaces } from "../wow/game_data/playable_race.js";
+export { powerType, powerTypes } from "../wow/game_data/power_type.js";
+export { realm, realms, searchRealm } from "../wow/game_data/realm.js";
+export { region, regions } from "../wow/game_data/region.js";
+// Profile APIs
+export { characterEquipments } from "../wow/profile/character_equipment.js";
+export { characterHunterPets } from "../wow/profile/character_hunter_pets.js";
+export { characterMedia } from "../wow/profile/character_media.js";
+export { characterProfileStatus } from "../wow/profile/character_profile.js";
+export { characterReputations } from "../wow/profile/character_reputations.js";
+export { guild, guildActivity, guildRoster } from "../wow/profile/guild.js";
+// Classic-typed versions of Retail endpoints (fields Retail always returns are optional here)
+export { achievementCategories, characterAppearanceSummary, characterProfile, characterPvpSummary, characterStatistics, connectedRealm, guildAchievements, } from "./profile_overrides.js";

package/esm/src/wow_classic/types.d.ts

@@ -0,0 +1,3 @@
+export type { AuctionHouseAuctions, AuctionHouses } from "./auction_house.js";
+export type { ClassicEraCharacterSpecializations, ClassicEraTalent } from "./character_specializations.js";
+export type { ClassicAchievementCategories, ClassicCharacterAchievementSummary, ClassicCharacterAppearanceSummary, ClassicCharacterProfile, ClassicCharacterPvpSummary, ClassicCharacterSpecializations, ClassicCharacterStatistics, ClassicCommodities, ClassicConnectedRealm, ClassicGuildAchievements, } from "./profile_overrides.js";

package/esm/src/wow_classic/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinta365/blizzard_api",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "TS library to interact with the Blizzard Battle.net API. World of Warcraft, World of Warcraft Classic, StarCraft 2, Diablo 3, Hearthstone.",
   "keywords": [
     "blizzard",
@@ -27,10 +27,31 @@
     ".": {
       "import": "./esm/mod.js",
       "require": "./script/mod.js"
+    },
+    "./wow": {
+      "import": "./esm/src/wow/types.js",
+      "require": "./script/src/wow/types.js"
+    },
+    "./wow-classic": {
+      "import": "./esm/src/wow_classic/types.js",
+      "require": "./script/src/wow_classic/types.js"
+    },
+    "./hearthstone": {
+      "import": "./esm/src/hearthstone/types.js",
+      "require": "./script/src/hearthstone/types.js"
+    },
+    "./sc2": {
+      "import": "./esm/src/starcraft2/types.js",
+      "require": "./script/src/starcraft2/types.js"
+    },
+    "./diablo3": {
+      "import": "./esm/src/diablo3/types.js",
+      "require": "./script/src/diablo3/types.js"
     }
   },
+  "scripts": {},
   "devDependencies": {
     "@types/node": "^20.9.0"
   },
-  "_generatedBy": "dnt@0.40.0"
+  "_generatedBy": "dnt@0.43.2"
 }

package/script/mod.d.ts

@@ -1,7 +1,44 @@
-import { authenticate, getAccessToken, getAuthConfig, requestHref, setup } from "./src/shared/index.js";
-import * as wow from "./src/wow/index.js";
-import * as wowClassic from "./src/wow_classic/index.js";
-import * as hearthstone from "./src/hearthstone/index.js";
-import * as sc2 from "./src/starcraft2/index.js";
+import type { AuthConfig, ClientConfig } from "./src/shared/index.js";
+import type { Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi } from "./src/client.js";
 import * as errors from "./src/shared/errors.js";
-export { authenticate, errors, getAccessToken, getAuthConfig, hearthstone, requestHref, sc2, setup, wow, wowClassic };
+export { createClient } from "./src/client.js";
+export type { BlizzardClient, Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi, } from "./src/client.js";
+export type { AuthConfig, AuthorizeUrlOptions, ClientConfig, ExchangeCodeOptions, Locales, Namespaces, Regions, TokenResponse, } from "./src/shared/index.js";
+export { errors };
+/**
+ * Configures the default client used by the module-level API. Prefer createClient() for new code.
+ * @param {Partial<ClientConfig>} userConfig - Configuration properties to update.
+ * @throws {MissingRegionError | MissingClientIdError | MissingClientSecretError} If the resulting configuration is incomplete.
+ */
+export declare function setup(userConfig: Partial<ClientConfig>): void;
+/**
+ * Obtains a client credentials access token for the default client.
+ * @param {boolean} [forceNewToken] - If true, fetches a new token even if the cached one is valid.
+ */
+export declare function authenticate(forceNewToken?: boolean): Promise<string>;
+/**
+ * Returns the default client's current access token, or an empty string if not authenticated.
+ */
+export declare function getAccessToken(): string;
+/**
+ * Returns a copy of the default client's token state.
+ */
+export declare function getAuthConfig(): AuthConfig;
+/**
+ * Makes an authenticated request with the default client to a full href returned in an API response.
+ * @param {string} href - The full href URL.
+ * @param {Record<string, string | number>} [qs] - Optional query string parameters to append.
+ */
+export declare function requestHref(href: string, qs?: Record<string, string | number>): Promise<unknown>;
+/** World of Warcraft endpoints on the default client. */
+export declare const wow: WowApi;
+/** World of Warcraft Classic (progression) endpoints on the default client. */
+export declare const wowClassic: WowClassicApi;
+/** World of Warcraft Classic Era endpoints on the default client. */
+export declare const wowClassicEra: WowClassicEraApi;
+/** Hearthstone endpoints on the default client. */
+export declare const hearthstone: HearthstoneApi;
+/** StarCraft II endpoints on the default client. */
+export declare const sc2: Sc2Api;
+/** Diablo III endpoints on the default client. */
+export declare const diablo3: Diablo3Api;

package/script/mod.js

@@ -15,28 +15,98 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wowClassic = exports.wow = exports.setup = exports.sc2 = exports.requestHref = exports.hearthstone = exports.getAuthConfig = exports.getAccessToken = exports.errors = exports.authenticate = void 0;
+exports.diablo3 = exports.sc2 = exports.hearthstone = exports.wowClassicEra = exports.wowClassic = exports.wow = exports.errors = exports.createClient = void 0;
+exports.setup = setup;
+exports.authenticate = authenticate;
+exports.getAccessToken = getAccessToken;
+exports.getAuthConfig = getAuthConfig;
+exports.requestHref = requestHref;
+/**
+ * TS library for the Blizzard Battle.net API: World of Warcraft, World of Warcraft Classic, Hearthstone,
+ * StarCraft II and Diablo III.
+ *
+ * @example
+ * ```ts
+ * import { createClient } from "@pinta365/blizzard-api";
+ *
+ * const client = createClient({ region: "eu", locale: "en_GB", clientId, clientSecret });
+ * const mount = await client.wow.mount(6);
+ * ```
+ *
+ * @module
+ */
 const index_js_1 = require("./src/shared/index.js");
-Object.defineProperty(exports, "authenticate", { enumerable: true, get: function () { return index_js_1.authenticate; } });
-Object.defineProperty(exports, "getAccessToken", { enumerable: true, get: function () { return index_js_1.getAccessToken; } });
-Object.defineProperty(exports, "getAuthConfig", { enumerable: true, get: function () { return index_js_1.getAuthConfig; } });
-Object.defineProperty(exports, "requestHref", { enumerable: true, get: function () { return index_js_1.requestHref; } });
-Object.defineProperty(exports, "setup", { enumerable: true, get: function () { return index_js_1.setup; } });
-const wow = __importStar(require("./src/wow/index.js"));
-exports.wow = wow;
-const wowClassic = __importStar(require("./src/wow_classic/index.js"));
-exports.wowClassic = wowClassic;
-const hearthstone = __importStar(require("./src/hearthstone/index.js"));
-exports.hearthstone = hearthstone;
-const sc2 = __importStar(require("./src/starcraft2/index.js"));
-exports.sc2 = sc2;
+const client_js_1 = require("./src/client.js");
 const errors = __importStar(require("./src/shared/errors.js"));
 exports.errors = errors;
+var client_js_2 = require("./src/client.js");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_js_2.createClient; } });
+// Default client behind the module-level API (setup() + wow.*, hearthstone.*, ...).
+const defaultContext = new index_js_1.ApiContext();
+const defaultClient = (0, client_js_1.clientFromContext)(defaultContext);
+/**
+ * Configures the default client used by the module-level API. Prefer createClient() for new code.
+ * @param {Partial<ClientConfig>} userConfig - Configuration properties to update.
+ * @throws {MissingRegionError | MissingClientIdError | MissingClientSecretError} If the resulting configuration is incomplete.
+ */
+function setup(userConfig) {
+    defaultContext.configure(userConfig);
+    (0, index_js_1.assertConfig)({ ...defaultContext.config });
+}
+/**
+ * Obtains a client credentials access token for the default client.
+ * @param {boolean} [forceNewToken] - If true, fetches a new token even if the cached one is valid.
+ */
+function authenticate(forceNewToken) {
+    return defaultContext.authenticate(forceNewToken);
+}
+/**
+ * Returns the default client's current access token, or an empty string if not authenticated.
+ */
+function getAccessToken() {
+    return defaultContext.getAuthConfig().accessToken;
+}
+/**
+ * Returns a copy of the default client's token state.
+ */
+function getAuthConfig() {
+    return defaultContext.getAuthConfig();
+}
+/**
+ * Makes an authenticated request with the default client to a full href returned in an API response.
+ * @param {string} href - The full href URL.
+ * @param {Record<string, string | number>} [qs] - Optional query string parameters to append.
+ */
+function requestHref(href, qs) {
+    return defaultContext.requestHref(href, qs);
+}
+/** World of Warcraft endpoints on the default client. */
+exports.wow = defaultClient.wow;
+/** World of Warcraft Classic (progression) endpoints on the default client. */
+exports.wowClassic = defaultClient.wowClassic;
+/** World of Warcraft Classic Era endpoints on the default client. */
+exports.wowClassicEra = defaultClient.wowClassicEra;
+/** Hearthstone endpoints on the default client. */
+exports.hearthstone = defaultClient.hearthstone;
+/** StarCraft II endpoints on the default client. */
+exports.sc2 = defaultClient.sc2;
+/** Diablo III endpoints on the default client. */
+exports.diablo3 = defaultClient.diablo3;

package/script/src/client.d.ts

@@ -0,0 +1,95 @@
+import { ApiContext } from "./shared/context.js";
+import type { AuthConfig, AuthorizeUrlOptions, ClientConfig, ExchangeCodeOptions, TokenResponse } from "./shared/context.js";
+import { type Bound } from "./shared/bind.js";
+import * as wowEndpoints from "./wow/index.js";
+import * as wowClassicEndpoints from "./wow_classic/index.js";
+import * as wowClassicEraEndpoints from "./wow_classic/era.js";
+import * as hearthstoneEndpoints from "./hearthstone/index.js";
+import * as sc2Endpoints from "./starcraft2/index.js";
+import * as diablo3Endpoints from "./diablo3/index.js";
+import type { WowApi } from "./generated/wow_api.js";
+import type { WowClassicApi } from "./generated/wow_classic_api.js";
+import type { WowClassicEraApi } from "./generated/wow_classic_era_api.js";
+import type { HearthstoneApi } from "./generated/hearthstone_api.js";
+import type { Sc2Api } from "./generated/sc2_api.js";
+import type { Diablo3Api } from "./generated/diablo3_api.js";
+export type { Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi };
+type Exact<A, B> = [keyof A] extends [keyof B] ? ([keyof B] extends [keyof A] ? ([A] extends [B] ? true : false) : false) : false;
+type Assert<T extends true> = T;
+export type _GeneratedApisAreCurrent = [
+    Assert<Exact<WowApi, Bound<typeof wowEndpoints>>>,
+    Assert<Exact<WowClassicApi, Bound<typeof wowClassicEndpoints>>>,
+    Assert<Exact<WowClassicEraApi, Bound<typeof wowClassicEraEndpoints>>>,
+    Assert<Exact<HearthstoneApi, Bound<typeof hearthstoneEndpoints>>>,
+    Assert<Exact<Sc2Api, Bound<typeof sc2Endpoints>>>,
+    Assert<Exact<Diablo3Api, Bound<typeof diablo3Endpoints>>>
+];
+/**
+ * A Blizzard API client with its own configuration and token state.
+ */
+export interface BlizzardClient {
+    /** World of Warcraft endpoints. */
+    readonly wow: WowApi;
+    /** World of Warcraft Classic (progression, e.g. Mists of Pandaria Classic) endpoints. */
+    readonly wowClassic: WowClassicApi;
+    /** World of Warcraft Classic Era endpoints (Era, Season of Discovery, Hardcore, Anniversary). */
+    readonly wowClassicEra: WowClassicEraApi;
+    /** Hearthstone endpoints. */
+    readonly hearthstone: HearthstoneApi;
+    /** StarCraft II endpoints. */
+    readonly sc2: Sc2Api;
+    /** Diablo III endpoints. */
+    readonly diablo3: Diablo3Api;
+    /** The client configuration. */
+    readonly config: Readonly<Partial<ClientConfig>>;
+    /**
+     * Obtains a client credentials access token, reusing the cached one while it is valid.
+     * Requests authenticate automatically; calling this is optional.
+     * @param {boolean} [forceNewToken] - If true, fetches a new token even if the cached one is valid.
+     */
+    authenticate(forceNewToken?: boolean): Promise<string>;
+    /** Returns a copy of the client credentials token state. */
+    getAuthConfig(): AuthConfig;
+    /**
+     * Makes an authenticated request to a full href returned in an API response.
+     * @param {string} href - The full href URL.
+     * @param {Record<string, string | number>} [qs] - Optional query string parameters to append.
+     */
+    requestHref(href: string, qs?: Record<string, string | number>): Promise<unknown>;
+    /**
+     * Returns a client that uses the given user access token for user-scoped endpoints (e.g. the WoW account profile).
+     * It shares configuration and the client credentials token with this client, so it is cheap to create per request.
+     * @param {string} userToken - A user access token, e.g. `access_token` from exchangeCode().
+     */
+    forUser(userToken: string): BlizzardClient;
+    /**
+     * Builds the URL to send a user to for the authorization code flow.
+     * @param {AuthorizeUrlOptions} options - Redirect URI, scopes (e.g. ["wow.profile"]) and state.
+     */
+    authorizeUrl(options: AuthorizeUrlOptions): string;
+    /**
+     * Exchanges an authorization code for a user access token.
+     * @param {ExchangeCodeOptions} options - The code and the redirect URI used to obtain it.
+     */
+    exchangeCode(options: ExchangeCodeOptions): Promise<TokenResponse>;
+}
+/**
+ * Wraps a context in a client object.
+ * @param {ApiContext} ctx - The context to wrap.
+ * @returns {BlizzardClient} The client.
+ */
+export declare function clientFromContext(ctx: ApiContext): BlizzardClient;
+/**
+ * Creates a Blizzard API client with its own configuration and token state.
+ *
+ * @example
+ * ```ts
+ * const client = createClient({ region: "eu", locale: "en_GB", clientId, clientSecret });
+ * const mount = await client.wow.mount(6);
+ * ```
+ *
+ * @param {ClientConfig} config - Region, locale and OAuth client credentials.
+ * @returns {BlizzardClient} The client.
+ * @throws {MissingRegionError | MissingClientIdError | MissingClientSecretError} If the configuration is incomplete.
+ */
+export declare function createClient(config: ClientConfig): BlizzardClient;

package/script/src/client.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientFromContext = clientFromContext;
+exports.createClient = createClient;
+//client.ts
+const context_js_1 = require("./shared/context.js");
+const bind_js_1 = require("./shared/bind.js");
+const wowEndpoints = __importStar(require("./wow/index.js"));
+const wowClassicEndpoints = __importStar(require("./wow_classic/index.js"));
+const wowClassicEraEndpoints = __importStar(require("./wow_classic/era.js"));
+const hearthstoneEndpoints = __importStar(require("./hearthstone/index.js"));
+const sc2Endpoints = __importStar(require("./starcraft2/index.js"));
+const diablo3Endpoints = __importStar(require("./diablo3/index.js"));
+/**
+ * Wraps a context in a client object.
+ * @param {ApiContext} ctx - The context to wrap.
+ * @returns {BlizzardClient} The client.
+ */
+function clientFromContext(ctx) {
+    return Object.freeze({
+        wow: (0, bind_js_1.bindAll)(ctx, wowEndpoints),
+        wowClassic: (0, bind_js_1.bindAll)(ctx.withNamespaceVariant("classic"), wowClassicEndpoints),
+        wowClassicEra: (0, bind_js_1.bindAll)(ctx.withNamespaceVariant("classic1x"), wowClassicEraEndpoints),
+        // bind() keeps metadata<T> generic at runtime; the mapped Bound type cannot, so use the generated interface.
+        hearthstone: (0, bind_js_1.bindAll)(ctx, hearthstoneEndpoints),
+        sc2: (0, bind_js_1.bindAll)(ctx, sc2Endpoints),
+        diablo3: (0, bind_js_1.bindAll)(ctx, diablo3Endpoints),
+        get config() {
+            return ctx.config;
+        },
+        authenticate: (forceNewToken) => ctx.authenticate(forceNewToken),
+        getAuthConfig: () => ctx.getAuthConfig(),
+        requestHref: (href, qs) => ctx.requestHref(href, qs),
+        forUser: (userToken) => clientFromContext(ctx.forUser(userToken)),
+        authorizeUrl: (options) => ctx.authorizeUrl(options),
+        exchangeCode: (options) => ctx.exchangeCode(options),
+    });
+}
+/**
+ * Creates a Blizzard API client with its own configuration and token state.
+ *
+ * @example
+ * ```ts
+ * const client = createClient({ region: "eu", locale: "en_GB", clientId, clientSecret });
+ * const mount = await client.wow.mount(6);
+ * ```
+ *
+ * @param {ClientConfig} config - Region, locale and OAuth client credentials.
+ * @returns {BlizzardClient} The client.
+ * @throws {MissingRegionError | MissingClientIdError | MissingClientSecretError} If the configuration is incomplete.
+ */
+function createClient(config) {
+    const copy = { ...config };
+    (0, context_js_1.assertConfig)(copy);
+    return clientFromContext(new context_js_1.ApiContext(copy));
+}

package/script/src/diablo3/community/act.d.ts

@@ -0,0 +1,29 @@
+import type { ApiContext } from "../../shared/index.js";
+interface Quest {
+    id: number;
+    name: string;
+    slug: string;
+}
+export interface Act {
+    slug: string;
+    number: number;
+    name: string;
+    quests: Quest[];
+}
+export interface Acts {
+    acts: Act[];
+}
+/**
+ * Returns an index of acts.
+ *
+ * @returns A promise that resolves to an object representing an index of acts.
+ */
+export declare function acts(ctx: ApiContext): Promise<Acts>;
+/**
+ * Returns a single act by ID.
+ *
+ * @param seasonId - The season for the leaderboard list.
+ * @returns A promise that resolves to an object representing the data for a single act by ID.
+ */
+export declare function act(ctx: ApiContext, seasonId: number): Promise<Act>;
+export {};

package/script/src/diablo3/community/act.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acts = acts;
+exports.act = act;
+/**
+ * Returns an index of acts.
+ *
+ * @returns A promise that resolves to an object representing an index of acts.
+ */
+async function acts(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/d3/data/act/",
+    });
+}
+/**
+ * Returns a single act by ID.
+ *
+ * @param seasonId - The season for the leaderboard list.
+ * @returns A promise that resolves to an object representing the data for a single act by ID.
+ */
+async function act(ctx, seasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/d3/data/act/${seasonId}`,
+    });
+}