@pinta365/blizzard_api 0.6.3 → 0.7.0

package/README.md

@@ -162,6 +162,13 @@ const sword = await blizzardAPI.wow.item(33791);
 
 ## Upgrading
 
+### 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
+  `undefined`. Among them: `active_spec`, `guild_crest`, `current_mythic_rating`, `PvpSeasons.current_season`,
+  `PvpSeasonLeaderboard.entries` (omitted for empty brackets), StarCraft II `clanName`/`clanTag`, and the Diablo III
+  hero `followers`, `legendaryPowers` and `seasonCreated`.
+
 ### From 0.5 to 0.6
 
 - A locale is always sent: when `locale` is not set, the region's main locale is used (`us`: `en_US`, `eu`: `en_GB`,

package/esm/src/diablo3/community/profile.d.ts

@@ -132,9 +132,9 @@ export interface D3FollowerItems {
     special?: D3HeroItem;
 }
 export interface D3HeroFollowerItems {
-    templar: D3FollowerItems;
-    scoundrel: D3FollowerItems;
-    enchantress: D3FollowerItems;
+    templar?: D3FollowerItems;
+    scoundrel?: D3FollowerItems;
+    enchantress?: D3FollowerItems;
 }
 export interface D3Skill {
     slug: string;
@@ -211,23 +211,27 @@ export interface D3Hero {
     };
     hardcore: boolean;
     seasonal: boolean;
-    seasonCreated: number;
+    /** Absent for non-seasonal heroes. */
+    seasonCreated?: number;
     skills: {
         active: {
             skill: D3Skill;
-            rune: D3SkillRune;
+            /** Absent when the skill has no rune selected. */
+            rune?: D3SkillRune;
         }[];
         passive: {
             skill: D3Skill;
         }[];
     };
     items: D3HeroItems;
-    followers: {
-        templar: D3Follower;
-        scoundrel: D3Follower;
-        enchantress: D3Follower;
+    /** Absent for some heroes. */
+    followers?: {
+        templar?: D3Follower;
+        scoundrel?: D3Follower;
+        enchantress?: D3Follower;
     };
-    legendaryPowers: D3ItemRef[];
+    /** Absent for some heroes. */
+    legendaryPowers?: D3ItemRef[];
     progression: {
         act1: D3ActProgress;
         act2: D3ActProgress;
@@ -292,7 +296,8 @@ export interface D3Account {
     paragonLevelHardcore: number;
     paragonLevelSeason: number;
     paragonLevelSeasonHardcore: number;
-    guildName: string;
+    /** Absent when the account is not in a guild. */
+    guildName?: string;
     heroes: D3AccountHero[];
     lastHeroPlayed: number;
     lastUpdated: number;

package/esm/src/starcraft2/community/legacy.d.ts

@@ -16,8 +16,8 @@ export interface Sc2LegacyCharacter {
     realm: number;
     region: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     profilePath: string;
 }
 export interface Sc2LegacyCareer {
@@ -66,8 +66,8 @@ export interface Sc2LegacyProfile {
     id: string;
     realm: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     profilePath: string;
     portrait: Sc2LegacyIcon;
     career: Sc2LegacyCareer;

package/esm/src/starcraft2/community/profile.d.ts

@@ -65,8 +65,8 @@ export interface Sc2ProfileSummary {
     id: string;
     realm: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     portrait: string;
     decalTerran: string;
     decalProtoss: string;
@@ -199,6 +199,8 @@ export interface Sc2LadderSummary {
 export interface Sc2Ladder {
     ladderTeams: Sc2LadderTeam[];
     allLadderMemberships: Sc2LadderMembership[];
+    /** Absent for ladders without divisions (e.g. Grandmaster). */
+    localizedDivision?: string;
     league: string;
     currentLadderMembership: {
         ladderId: string;
@@ -207,6 +209,8 @@ export interface Sc2Ladder {
     ranksAndPools: {
         rank: number;
         mmr: number;
+        /** Absent for ladders without a bonus pool (e.g. Grandmaster). */
+        bonusPool?: number;
     }[];
 }
 /**

package/esm/src/wow/game_data/pvp_season.d.ts

@@ -2,7 +2,8 @@ import type { ApiContext } from "../../shared/index.js";
 import type { Href, KeyId, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
 export interface PvpSeasons extends LinkSelfHref {
     seasons: KeyId[];
-    current_season: KeyId;
+    /** Absent when there is no active PvP season (between seasons). */
+    current_season?: KeyId;
 }
 export interface PvpSeason extends LinkSelfHref {
     id: number;
@@ -32,7 +33,10 @@ export interface PvpSeasonLeaderboard extends LinkSelfHref {
         id: number;
         type: string;
     };
-    entries: {
+    /**
+     * Omitted when the bracket has no entries (e.g. an empty Classic bracket).
+     */
+    entries?: {
         character: {
             name: string;
             id: number;

package/esm/src/wow/profile/character_appearance.d.ts

@@ -4,10 +4,12 @@ export interface CharacterAppearanceSummary extends LinkSelfHref {
     character: Character;
     playable_race: KeyNameId;
     playable_class: KeyNameId;
-    active_spec: KeyNameId;
+    /** Absent for characters below level 10, which have no specialization. */
+    active_spec?: KeyNameId;
     gender: TypeName;
     faction: TypeName;
-    guild_crest: {
+    /** Absent when the character is not in a guild. */
+    guild_crest?: {
         emblem: {
             id: number;
             media: KeyId;
@@ -59,7 +61,8 @@ export interface CharacterAppearanceSummary extends LinkSelfHref {
     }[];
     customizations: {
         option: {
-            name: LocalizedString;
+            /** Absent for some options that have no localized name. */
+            name?: LocalizedString;
             id: number;
         };
         choice: {

package/esm/src/wow/profile/character_collections.d.ts

@@ -53,7 +53,8 @@ export interface CollectedHeirloom {
     };
 }
 export interface CharacterCollectionHeirlooms extends LinkSelfHref {
-    heirlooms: CollectedHeirloom[];
+    /** Absent when the character has collected no heirlooms. */
+    heirlooms?: CollectedHeirloom[];
 }
 export interface DecorItem {
     decor: NamedRef;

package/esm/src/wow/profile/character_equipment.d.ts

@@ -51,6 +51,11 @@ export interface characterEquipments extends LinkSelfHref {
         enchantments?: {
             display_string?: LocalizedString;
             source_item?: KeyNameId;
+            /** The spell an on-use enchantment casts (seen on Classic, e.g. Synapse Springs). */
+            spell?: {
+                spell: KeyNameId;
+                description: LocalizedString;
+            };
             enchantment_id: number;
             enchantment_slot: {
                 id: number;
@@ -118,6 +123,11 @@ export interface characterEquipments extends LinkSelfHref {
                 min_reputation_level: number;
                 display_string: LocalizedString;
             };
+            skill?: {
+                profession: KeyNameId;
+                level: number;
+                display_string: LocalizedString;
+            };
         };
         set?: {
             item_set: KeyNameId;

package/esm/src/wow/profile/character_mythic_keystone_profile.d.ts

@@ -41,13 +41,15 @@ export interface CharacterMythicKeystoneProfile extends LinkSelfHref {
     };
     seasons: KeyId[];
     character: Character;
-    current_mythic_rating: MythicRating;
+    /** Absent until the character has earned a rating in the current season. */
+    current_mythic_rating?: MythicRating;
 }
 export interface CharacterMythicKeystoneSeasonDetails extends LinkSelfHref {
     season: KeyId;
     best_runs: MythicKeystoneBestRun[];
     character: Character;
-    mythic_rating: MythicRating;
+    /** Absent for seasons in which the character earned no rating. */
+    mythic_rating?: MythicRating;
 }
 /**
  * Returns the Mythic Keystone profile index for a character.

package/esm/src/wow/profile/character_profile.d.ts

@@ -12,7 +12,8 @@ export interface CharacterProfile extends LinkSelfHref {
     faction: TypeName;
     race: KeyNameId;
     character_class: KeyNameId;
-    active_spec: KeyNameId;
+    /** Absent for characters below level 10, which have no specialization. */
+    active_spec?: KeyNameId;
     realm: CharacterRealm;
     guild?: {
         key: Href;
@@ -42,6 +43,8 @@ export interface CharacterProfile extends LinkSelfHref {
     quests: Href;
     achievements_statistics: Href;
     professions: Href;
+    /** Only present for hunters. */
+    hunter_pets?: Href;
     covenant_progress?: {
         chosen_covenant: KeyNameId;
         renown_level: number;

package/esm/src/wow/profile/character_soulbinds.d.ts

@@ -10,7 +10,7 @@ export interface CharacterSoulbinds extends LinkSelfHref {
             trait?: KeyNameId;
             conduit_socket?: {
                 type: TypeName;
-                socket: {
+                socket?: {
                     conduit: KeyNameId;
                     rank: number;
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinta365/blizzard_api",
-  "version": "0.6.3",
+  "version": "0.7.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",

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

@@ -132,9 +132,9 @@ export interface D3FollowerItems {
     special?: D3HeroItem;
 }
 export interface D3HeroFollowerItems {
-    templar: D3FollowerItems;
-    scoundrel: D3FollowerItems;
-    enchantress: D3FollowerItems;
+    templar?: D3FollowerItems;
+    scoundrel?: D3FollowerItems;
+    enchantress?: D3FollowerItems;
 }
 export interface D3Skill {
     slug: string;
@@ -211,23 +211,27 @@ export interface D3Hero {
     };
     hardcore: boolean;
     seasonal: boolean;
-    seasonCreated: number;
+    /** Absent for non-seasonal heroes. */
+    seasonCreated?: number;
     skills: {
         active: {
             skill: D3Skill;
-            rune: D3SkillRune;
+            /** Absent when the skill has no rune selected. */
+            rune?: D3SkillRune;
         }[];
         passive: {
             skill: D3Skill;
         }[];
     };
     items: D3HeroItems;
-    followers: {
-        templar: D3Follower;
-        scoundrel: D3Follower;
-        enchantress: D3Follower;
+    /** Absent for some heroes. */
+    followers?: {
+        templar?: D3Follower;
+        scoundrel?: D3Follower;
+        enchantress?: D3Follower;
     };
-    legendaryPowers: D3ItemRef[];
+    /** Absent for some heroes. */
+    legendaryPowers?: D3ItemRef[];
     progression: {
         act1: D3ActProgress;
         act2: D3ActProgress;
@@ -292,7 +296,8 @@ export interface D3Account {
     paragonLevelHardcore: number;
     paragonLevelSeason: number;
     paragonLevelSeasonHardcore: number;
-    guildName: string;
+    /** Absent when the account is not in a guild. */
+    guildName?: string;
     heroes: D3AccountHero[];
     lastHeroPlayed: number;
     lastUpdated: number;

package/script/src/starcraft2/community/legacy.d.ts

@@ -16,8 +16,8 @@ export interface Sc2LegacyCharacter {
     realm: number;
     region: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     profilePath: string;
 }
 export interface Sc2LegacyCareer {
@@ -66,8 +66,8 @@ export interface Sc2LegacyProfile {
     id: string;
     realm: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     profilePath: string;
     portrait: Sc2LegacyIcon;
     career: Sc2LegacyCareer;

package/script/src/starcraft2/community/profile.d.ts

@@ -65,8 +65,8 @@ export interface Sc2ProfileSummary {
     id: string;
     realm: number;
     displayName: string;
-    clanName: string;
-    clanTag: string;
+    clanName?: string;
+    clanTag?: string;
     portrait: string;
     decalTerran: string;
     decalProtoss: string;
@@ -199,6 +199,8 @@ export interface Sc2LadderSummary {
 export interface Sc2Ladder {
     ladderTeams: Sc2LadderTeam[];
     allLadderMemberships: Sc2LadderMembership[];
+    /** Absent for ladders without divisions (e.g. Grandmaster). */
+    localizedDivision?: string;
     league: string;
     currentLadderMembership: {
         ladderId: string;
@@ -207,6 +209,8 @@ export interface Sc2Ladder {
     ranksAndPools: {
         rank: number;
         mmr: number;
+        /** Absent for ladders without a bonus pool (e.g. Grandmaster). */
+        bonusPool?: number;
     }[];
 }
 /**

package/script/src/wow/game_data/pvp_season.d.ts

@@ -2,7 +2,8 @@ import type { ApiContext } from "../../shared/index.js";
 import type { Href, KeyId, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
 export interface PvpSeasons extends LinkSelfHref {
     seasons: KeyId[];
-    current_season: KeyId;
+    /** Absent when there is no active PvP season (between seasons). */
+    current_season?: KeyId;
 }
 export interface PvpSeason extends LinkSelfHref {
     id: number;
@@ -32,7 +33,10 @@ export interface PvpSeasonLeaderboard extends LinkSelfHref {
         id: number;
         type: string;
     };
-    entries: {
+    /**
+     * Omitted when the bracket has no entries (e.g. an empty Classic bracket).
+     */
+    entries?: {
         character: {
             name: string;
             id: number;

package/script/src/wow/profile/character_appearance.d.ts

@@ -4,10 +4,12 @@ export interface CharacterAppearanceSummary extends LinkSelfHref {
     character: Character;
     playable_race: KeyNameId;
     playable_class: KeyNameId;
-    active_spec: KeyNameId;
+    /** Absent for characters below level 10, which have no specialization. */
+    active_spec?: KeyNameId;
     gender: TypeName;
     faction: TypeName;
-    guild_crest: {
+    /** Absent when the character is not in a guild. */
+    guild_crest?: {
         emblem: {
             id: number;
             media: KeyId;
@@ -59,7 +61,8 @@ export interface CharacterAppearanceSummary extends LinkSelfHref {
     }[];
     customizations: {
         option: {
-            name: LocalizedString;
+            /** Absent for some options that have no localized name. */
+            name?: LocalizedString;
             id: number;
         };
         choice: {

package/script/src/wow/profile/character_collections.d.ts

@@ -53,7 +53,8 @@ export interface CollectedHeirloom {
     };
 }
 export interface CharacterCollectionHeirlooms extends LinkSelfHref {
-    heirlooms: CollectedHeirloom[];
+    /** Absent when the character has collected no heirlooms. */
+    heirlooms?: CollectedHeirloom[];
 }
 export interface DecorItem {
     decor: NamedRef;

package/script/src/wow/profile/character_equipment.d.ts

@@ -51,6 +51,11 @@ export interface characterEquipments extends LinkSelfHref {
         enchantments?: {
             display_string?: LocalizedString;
             source_item?: KeyNameId;
+            /** The spell an on-use enchantment casts (seen on Classic, e.g. Synapse Springs). */
+            spell?: {
+                spell: KeyNameId;
+                description: LocalizedString;
+            };
             enchantment_id: number;
             enchantment_slot: {
                 id: number;
@@ -118,6 +123,11 @@ export interface characterEquipments extends LinkSelfHref {
                 min_reputation_level: number;
                 display_string: LocalizedString;
             };
+            skill?: {
+                profession: KeyNameId;
+                level: number;
+                display_string: LocalizedString;
+            };
         };
         set?: {
             item_set: KeyNameId;

package/script/src/wow/profile/character_mythic_keystone_profile.d.ts

@@ -41,13 +41,15 @@ export interface CharacterMythicKeystoneProfile extends LinkSelfHref {
     };
     seasons: KeyId[];
     character: Character;
-    current_mythic_rating: MythicRating;
+    /** Absent until the character has earned a rating in the current season. */
+    current_mythic_rating?: MythicRating;
 }
 export interface CharacterMythicKeystoneSeasonDetails extends LinkSelfHref {
     season: KeyId;
     best_runs: MythicKeystoneBestRun[];
     character: Character;
-    mythic_rating: MythicRating;
+    /** Absent for seasons in which the character earned no rating. */
+    mythic_rating?: MythicRating;
 }
 /**
  * Returns the Mythic Keystone profile index for a character.

package/script/src/wow/profile/character_profile.d.ts

@@ -12,7 +12,8 @@ export interface CharacterProfile extends LinkSelfHref {
     faction: TypeName;
     race: KeyNameId;
     character_class: KeyNameId;
-    active_spec: KeyNameId;
+    /** Absent for characters below level 10, which have no specialization. */
+    active_spec?: KeyNameId;
     realm: CharacterRealm;
     guild?: {
         key: Href;
@@ -42,6 +43,8 @@ export interface CharacterProfile extends LinkSelfHref {
     quests: Href;
     achievements_statistics: Href;
     professions: Href;
+    /** Only present for hunters. */
+    hunter_pets?: Href;
     covenant_progress?: {
         chosen_covenant: KeyNameId;
         renown_level: number;

package/script/src/wow/profile/character_soulbinds.d.ts

@@ -10,7 +10,7 @@ export interface CharacterSoulbinds extends LinkSelfHref {
             trait?: KeyNameId;
             conduit_socket?: {
                 type: TypeName;
-                socket: {
+                socket?: {
                     conduit: KeyNameId;
                     rank: number;
                 };