@pinta365/blizzard_api 0.7.1 → 0.8.0

package/README.md

@@ -18,6 +18,7 @@ Available as:
 | **World of Warcraft:** Profile APIs         | ✅     | Account profile endpoints need a user token          |
 | **World of Warcraft Classic:** Game Data    | ✅     | Progression (`wowClassic`) and Era (`wowClassicEra`) |
 | **World of Warcraft Classic:** Profile APIs | ✅     | Progression (`wowClassic`) and Era (`wowClassicEra`) |
+| **World of Warcraft: Forever**              | ✅     | `wowForever`; auctions once Blizzard serves them     |
 | **Diablo III:** Community APIs              | ✅     | Including account and hero profiles                  |
 | **Diablo III:** Game Data APIs              | ✅     |                                                      |
 | **Hearthstone:** Game Data APIs             | ✅     |                                                      |
@@ -81,11 +82,39 @@ const { createClient } = require("@pinta365/blizzard_api");
 | `client.wow`           | World of Warcraft (Retail)                                    |
 | `client.wowClassic`    | WoW Classic progression (currently Mists of Pandaria Classic) |
 | `client.wowClassicEra` | WoW Classic Era, Season of Discovery, Hardcore, Anniversary   |
+| `client.wowForever`    | WoW: Forever (game data, characters and account profile)      |
 | `client.hearthstone`   | Hearthstone                                                   |
 | `client.sc2`           | StarCraft II                                                  |
 | `client.diablo3`       | Diablo III                                                    |
 
-The two Classic properties only include the endpoints Blizzard supports for that flavor.
+The Classic and Forever properties only include the endpoints Blizzard supports for that flavor.
+
+### WoW: Forever
+
+Blizzard hasn't documented the Forever API yet; `wowForever` covers what answers so far: game data, rulesets, character
+profiles, guilds and the account profile. Auction endpoints follow once Blizzard serves them.
+
+Forever is realmless. Players pick a ruleset (Normal, PvP, Roleplay, Roleplay PvP) instead of a realm, so use
+`rulesets()` and `ruleset(id)` instead of the realm endpoints. Characters have a two-part name, unique per region, and
+are looked up by `name` and `surname`:
+
+```ts
+const profile = await client.wowForever.characterProfile("Anduin", "Wrynn");
+const gear = await client.wowForever.characterEquipments("Anduin", "Wrynn");
+```
+
+Characters only show up from level 10, after they log out; before that the API returns 404. Guilds are realmless too, so
+they are looked up by their slug alone: `client.wowForever.guildRoster("my-guild")`.
+
+Static game data uses `static-forever-{region}`, which serves the current game version. To pin a specific version, set
+`foreverStaticVersion`:
+
+```ts
+const client = createClient({ region: "eu", clientId, clientSecret, foreverStaticVersion: "1.60.1_70399" });
+const races = await client.wowForever.playableRaces();
+```
+
+The version is in the `namespace` of the `self` link of any static response.
 
 ## Response types
 
@@ -96,9 +125,10 @@ import type { Mount } from "@pinta365/blizzard-api/wow";
 import type { Card } from "@pinta365/blizzard-api/hearthstone";
 ```
 
-Entry points: `/wow`, `/wow-classic`, `/hearthstone`, `/sc2` and `/diablo3`. The Classic clients mostly return the same
-types as Retail (import those from `/wow`). `/wow-classic` holds the Classic-only ones, such as
-`ClassicCharacterProfile`, where fields that only Retail returns are optional.
+Entry points: `/wow`, `/wow-classic`, `/wow-forever`, `/hearthstone`, `/sc2` and `/diablo3`. The Classic and Forever
+clients mostly return the same types as Retail (import those from `/wow`). `/wow-classic` and `/wow-forever` hold the
+flavor-only ones, such as `ClassicCharacterProfile` or `ForeverCharacterProfile`, where fields that only Retail returns
+are optional.
 
 ## Following links
 
@@ -162,6 +192,12 @@ const sword = await blizzardAPI.wow.item(33791);
 
 ## Upgrading
 
+### From 0.7 to 0.8
+
+- New `wowForever` client for WoW: Forever (see [WoW: Forever](#wow-forever)).
+- Retail `Item.preview_item.stats`, `requirements` and `durability` are optional: the API omits them for items without
+  them, such as companion pets, so you may need to handle `undefined`.
+
 ### From 0.6 to 0.7
 
 - More response fields that only some characters, players or brackets have are now optional, so you may need to handle

package/esm/mod.d.ts

@@ -1,8 +1,8 @@
 import type { AuthConfig, ClientConfig } from "./src/shared/index.js";
-import type { Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi } from "./src/client.js";
+import type { Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi, WowForeverApi } from "./src/client.js";
 import * as errors from "./src/shared/errors.js";
 export { createClient } from "./src/client.js";
-export type { BlizzardClient, Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi, } from "./src/client.js";
+export type { BlizzardClient, Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi, WowForeverApi, } from "./src/client.js";
 export type { AuthConfig, AuthorizeUrlOptions, ClientConfig, ExchangeCodeOptions, Locales, Namespaces, Regions, TokenResponse, } from "./src/shared/index.js";
 export { errors };
 /**
@@ -36,6 +36,8 @@ export declare const wow: WowApi;
 export declare const wowClassic: WowClassicApi;
 /** World of Warcraft Classic Era endpoints on the default client. */
 export declare const wowClassicEra: WowClassicEraApi;
+/** World of Warcraft: Forever endpoints on the default client. */
+export declare const wowForever: WowForeverApi;
 /** Hearthstone endpoints on the default client. */
 export declare const hearthstone: HearthstoneApi;
 /** StarCraft II endpoints on the default client. */

package/esm/mod.js

@@ -62,6 +62,8 @@ export const wow = defaultClient.wow;
 export const wowClassic = defaultClient.wowClassic;
 /** World of Warcraft Classic Era endpoints on the default client. */
 export const wowClassicEra = defaultClient.wowClassicEra;
+/** World of Warcraft: Forever endpoints on the default client. */
+export const wowForever = defaultClient.wowForever;
 /** Hearthstone endpoints on the default client. */
 export const hearthstone = defaultClient.hearthstone;
 /** StarCraft II endpoints on the default client. */

package/esm/src/client.d.ts

@@ -4,22 +4,25 @@ 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 wowForeverEndpoints from "./wow_forever/index.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 { WowForeverApi } from "./generated/wow_forever_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 };
+export type { Diablo3Api, HearthstoneApi, Sc2Api, WowApi, WowClassicApi, WowClassicEraApi, WowForeverApi };
 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<WowForeverApi, Bound<typeof wowForeverEndpoints>>>,
     Assert<Exact<HearthstoneApi, Bound<typeof hearthstoneEndpoints>>>,
     Assert<Exact<Sc2Api, Bound<typeof sc2Endpoints>>>,
     Assert<Exact<Diablo3Api, Bound<typeof diablo3Endpoints>>>
@@ -34,6 +37,11 @@ export interface BlizzardClient {
     readonly wowClassic: WowClassicApi;
     /** World of Warcraft Classic Era endpoints (Era, Season of Discovery, Hardcore, Anniversary). */
     readonly wowClassicEra: WowClassicEraApi;
+    /**
+     * World of Warcraft: Forever endpoints (game data and account profile). Before launch, set
+     * `foreverStaticVersion` in the client config for static game data.
+     */
+    readonly wowForever: WowForeverApi;
     /** Hearthstone endpoints. */
     readonly hearthstone: HearthstoneApi;
     /** StarCraft II endpoints. */

package/esm/src/client.js

@@ -4,6 +4,7 @@ import { bindAll } 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 wowForeverEndpoints from "./wow_forever/index.js";
 import * as hearthstoneEndpoints from "./hearthstone/index.js";
 import * as sc2Endpoints from "./starcraft2/index.js";
 import * as diablo3Endpoints from "./diablo3/index.js";
@@ -17,6 +18,7 @@ export function clientFromContext(ctx) {
         wow: bindAll(ctx, wowEndpoints),
         wowClassic: bindAll(ctx.withNamespaceVariant("classic"), wowClassicEndpoints),
         wowClassicEra: bindAll(ctx.withNamespaceVariant("classic1x"), wowClassicEraEndpoints),
+        wowForever: bindAll(ctx.withNamespaceVariant("forever", (config) => config.foreverStaticVersion), wowForeverEndpoints),
         // bind() keeps metadata<T> generic at runtime; the mapped Bound type cannot, so use the generated interface.
         hearthstone: bindAll(ctx, hearthstoneEndpoints),
         sc2: bindAll(ctx, sc2Endpoints),