@blizzard-api/core 4.1.1 → 4.1.3

package/dist/index.d.ts

@@ -2,31 +2,31 @@
 /**
  * The base request path for the D3 API in the Blizzard API.
  */
-declare const d3BasePath = "d3/data";
+export declare const d3BasePath = "d3/data";
 /**
  * The base request path for profile APIs in the D3 API.
  */
-declare const d3ProfileBasePath = "d3/profile";
+export declare const d3ProfileBasePath = "d3/profile";
 /**
  * The base request path for game data APIs in the D3 API.
  */
-declare const d3GameDataBasePath = "data/d3";
+export declare const d3GameDataBasePath = "data/d3";
 /**
  * The base request path for the Blizzard API for world of warcraft.
  */
-declare const wowBasePath = "/data/wow";
+export declare const wowBasePath = "/data/wow";
 /**
  * The base request path for the character API for Classic World of Warcraft.
  */
-declare const wowCharacterBasePath = "profile/wow/character";
+export declare const wowCharacterBasePath = "profile/wow/character";
 /**
  * The base request path for media in the Blizzard API for world of warcraft.
  */
-declare const wowMediaBasePath: "/data/wow/media";
+export declare const wowMediaBasePath: "/data/wow/media";
 /**
  * The base request path for search in the Blizzard API for world of warcraft.
  */
-declare const wowSearchBasePath: "/data/wow/search";
+export declare const wowSearchBasePath: "/data/wow/search";
 /**
  * Base search parameters
  * orderby The field to order results by.
@@ -37,20 +37,20 @@ declare const wowSearchBasePath: "/data/wow/search";
  *  _page: 1,
  * };
  */
-interface BaseSearchParameters {
+export interface BaseSearchParameters {
   _page?: number;
   orderby?: Array<string> | string;
 }
 /**
  * The standard structure to represent a World of Warcraft Character.
  */
-interface Character extends NameIdKey {
+export interface Character extends NameIdKey {
   realm: Realm;
 }
 /**
  * A record containing the RGBA values of a color.
  */
-interface Color {
+export interface Color {
   a: number;
   b: number;
   g: number;
@@ -59,45 +59,45 @@ interface Color {
 /**
  * The faction associated with a character or entity in World of Warcraft.
  */
-interface Faction {
+export interface Faction {
   name: string;
   type: Factions;
 }
 /**
  * The playable factions in World of Warcraft.
  */
-type Factions = 'ALLIANCE' | 'HORDE' | 'NEUTRAL';
+export type Factions = 'ALLIANCE' | 'HORDE' | 'NEUTRAL';
 /**
  * The playable factions at max level in World of Warcraft.
  */
-type NonNeutralFactions = 'ALLIANCE' | 'HORDE';
+export type NonNeutralFactions = 'ALLIANCE' | 'HORDE';
 /**
  * The gender associated with a character or entity in World of Warcraft.
  */
-interface Gender {
+export interface Gender {
   name: string;
   type: 'FEMALE' | 'MALE';
 }
 /**
  * The playable gender names/descriptions in World of Warcraft.
  */
-interface GenderName {
+export interface GenderName {
   female: null | string;
   male: null | string;
 }
-interface Href {
+export interface Href {
   href: string;
 }
 /**
  * Base record interface containing key.href property that often appear in Blizzard API responses.
  */
-interface KeyBase {
+export interface KeyBase {
   key: Href;
 }
 /**
  * The media asset associated with a character or entity in World of Warcraft.
  */
-interface MediaAsset {
+export interface MediaAsset {
   file_data_id?: number;
   key: string;
   value: string;
@@ -105,29 +105,33 @@ interface MediaAsset {
 /**
  * Base record interface containing name and id properties that often appear together in Blizzard API responses.
  */
-interface NameId {
+export interface NameId {
   id: number;
   name: string;
 }
+export interface NullishNameId {
+  id: number;
+  name: null | string;
+}
 /**
  * Base record containing both {@link KeyBase} and {@link NameId} interfaces.
  */
-interface NameIdKey extends KeyBase, NameId {}
-interface NullishNameIdKey extends Omit<NameIdKey, 'name'> {
+export interface NameIdKey extends KeyBase, NameId {}
+export interface NullishNameIdKey extends Omit<NameIdKey, 'name'> {
   name: null | string;
 }
 /**
  * The standard structure to represent a World of Warcraft Realm.
  */
-interface Realm extends KeyBase {
+export interface Realm extends KeyBase {
   id: number;
-  name?: string;
+  name?: null | string;
   slug: string;
 }
 /**
  * Base interface for Blizzard API responses.
  */
-interface ResponseBase {
+export interface ResponseBase {
   _links: {
     self: Href;
   };
@@ -182,7 +186,7 @@ interface BlizzardApi<T extends Origins> {
  * console.log(api.locale); // 'en_US'
  * console.log(api.origin); // 'us'
  */
-declare function getBlizzardApi<T extends Origins>(origin: T, locale?: (typeof _regionLocaleMap)[typeof origin][number]): BlizzardApi<typeof origin>;
+export declare function getBlizzardApi<T extends Origins>(origin: T, locale?: (typeof _regionLocaleMap)[typeof origin][number]): BlizzardApi<typeof origin>;
 //#endregion
 //#region src/namespace.d.ts
 /**
@@ -249,5 +253,5 @@ interface SearchResponseWithoutResults {
   resultCountCapped?: boolean;
 }
 //#endregion
-export { BaseSearchParameters, type BlizzardNamespaces, Character, Color, type ExtractResourceType, Faction, Factions, Gender, GenderName, Href, KeyBase, type Locales, MediaAsset, NameId, NameIdKey, NonNeutralFactions, NullishNameIdKey, type Origins, type ProtectedResource, Realm, type Resource, ResponseBase, type SearchResponseWithoutResults, d3BasePath, d3GameDataBasePath, d3ProfileBasePath, getBlizzardApi, wowBasePath, wowCharacterBasePath, wowMediaBasePath, wowSearchBasePath };
+export type { BlizzardNamespaces, ExtractResourceType, Locales, Origins, ProtectedResource, Resource, SearchResponseWithoutResults };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/base.ts","../src/blizzard-api.ts"],"sourcesContent":["/**\n * The base request path for the D3 API in the Blizzard API.\n */\nexport const d3BasePath = 'd3/data';\n\n/**\n * The base request path for profile APIs in the D3 API.\n */\nexport const d3ProfileBasePath = `d3/profile`;\n\n/**\n * The base request path for game data APIs in the D3 API.\n */\n// eslint-disable-next-line unicorn/consistent-compound-words\nexport const d3GameDataBasePath = `data/d3`;\n\n/**\n * The base request path for the Blizzard API for world of warcraft.\n */\nexport const wowBasePath = '/data/wow';\n\n/**\n * The base request path for the character API for Classic World of Warcraft.\n */\nexport const wowCharacterBasePath = 'profile/wow/character';\n\n/**\n * The base request path for media in the Blizzard API for world of warcraft.\n */\nexport const wowMediaBasePath = `${wowBasePath}/media` as const;\n\n/**\n * The base request path for search in the Blizzard API for world of warcraft.\n */\nexport const wowSearchBasePath = `${wowBasePath}/search` as const;\n\n/**\n * Base search parameters\n * orderby The field to order results by.\n * _page The page number to return.\n * @example\n * const params: BaseSearchParameters = {\n *  orderby: 'name',\n *  _page: 1,\n * };\n */\nexport interface BaseSearchParameters {\n  _page?: number;\n  orderby?: Array<string> | string;\n}\n/**\n * The standard structure to represent a World of Warcraft Character.\n */\nexport interface Character extends NameIdKey {\n  realm: Realm;\n}\n\n/**\n * A record containing the RGBA values of a color.\n */\nexport interface Color {\n  a: number;\n  b: number;\n  g: number;\n  r: number;\n}\n\n/**\n * The faction associated with a character or entity in World of Warcraft.\n */\nexport interface Faction {\n  name: string;\n  type: Factions;\n}\n\n/**\n * The playable factions in World of Warcraft.\n */\nexport type Factions = 'ALLIANCE' | 'HORDE' | 'NEUTRAL';\n\n/**\n * The playable factions at max level in World of Warcraft.\n */\nexport type NonNeutralFactions = 'ALLIANCE' | 'HORDE';\n\n/**\n * The gender associated with a character or entity in World of Warcraft.\n */\nexport interface Gender {\n  name: string;\n  type: 'FEMALE' | 'MALE';\n}\n\n/**\n * The playable gender names/descriptions in World of Warcraft.\n */\nexport interface GenderName {\n  female: null | string;\n  male: null | string;\n}\n\nexport interface Href {\n  href: string;\n}\n\n/**\n * Base record interface containing key.href property that often appear in Blizzard API responses.\n */\nexport interface KeyBase {\n  key: Href;\n}\n\n/**\n * The media asset associated with a character or entity in World of Warcraft.\n */\nexport interface MediaAsset {\n  file_data_id?: number;\n  key: string;\n  value: string;\n}\n\n/**\n * Base record interface containing name and id properties that often appear together in Blizzard API responses.\n */\nexport interface NameId {\n  id: number;\n  name: string;\n}\n\n/**\n * Base record containing both {@link KeyBase} and {@link NameId} interfaces.\n */\nexport interface NameIdKey extends KeyBase, NameId {}\n\nexport interface NullishNameIdKey extends Omit<NameIdKey, 'name'> {\n  name: null | string;\n}\n\n/**\n * The standard structure to represent a World of Warcraft Realm.\n */\nexport interface Realm extends KeyBase {\n  id: number;\n  name?: string;\n  slug: string;\n}\n\n/**\n * Base interface for Blizzard API responses.\n */\nexport interface ResponseBase {\n  _links: {\n    self: Href;\n  };\n}\n","import type { Locales, Origins } from './locales';\r\n\r\n/**\r\n * A record of regions and their supported locales.\r\n */\r\nconst _regionLocaleMap = {\r\n  cn: ['zh_CN'],\r\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'it_IT'],\r\n  kr: ['ko_KR', 'en_GB', 'en_US'],\r\n  tw: ['zh_TW', 'en_GB', 'en_US'],\r\n  us: ['en_US', 'es_MX', 'pt_BR'],\r\n} as const satisfies Record<Origins, Array<Locales>>;\r\n\r\n/**\r\n * A record of Blizzard API configurations by region.\r\n */\r\ninterface BlizzardApiByRegion {\r\n  cn: BlizzardApiDefault<'cn'>;\r\n  eu: BlizzardApiDefault<'eu'>;\r\n  kr: BlizzardApiDefault<'kr'>;\r\n  tw: BlizzardApiDefault<'tw'>;\r\n  us: BlizzardApiDefault<'us'>;\r\n}\r\n\r\n/**\r\n * The default Blizzard API configuration for each region.\r\n */\r\ninterface BlizzardApiDefault<T extends Origins> {\r\n  defaultLocale: (typeof _regionLocaleMap)[T][number];\r\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\r\n}\r\n\r\nconst endpoints: BlizzardApiByRegion = {\r\n  cn: {\r\n    defaultLocale: 'zh_CN',\r\n    hostname: 'https://gateway.battlenet.com.cn',\r\n  },\r\n  eu: {\r\n    defaultLocale: 'en_GB',\r\n    hostname: 'https://eu.api.blizzard.com',\r\n  },\r\n  kr: {\r\n    defaultLocale: 'ko_KR',\r\n    hostname: 'https://kr.api.blizzard.com',\r\n  },\r\n  tw: {\r\n    defaultLocale: 'zh_TW',\r\n    hostname: 'https://tw.api.blizzard.com',\r\n  },\r\n  us: {\r\n    defaultLocale: 'en_US',\r\n    hostname: 'https://us.api.blizzard.com',\r\n  },\r\n};\r\n\r\n/**\r\n * A Blizzard API configuration object.\r\n * @template T The region of the Blizzard API.\r\n */\r\ninterface BlizzardApi<T extends Origins> {\r\n  hostname: BlizzardApiDefault<Origins>['hostname'];\r\n  locale: (typeof _regionLocaleMap)[T][number];\r\n  origin: Origins;\r\n}\r\n\r\n/**\r\n * Get the Blizzard API configuration for a given region.\r\n * @template T The region of the Blizzard API.\r\n * @param origin The region of the Blizzard API.\r\n * @param locale The locale of the Blizzard API.\r\n * @returns The Blizzard API configuration for the given region.\r\n * @example\r\n * const api = getBlizzardApi('us', 'en_US');\r\n * console.log(api.hostname); // 'https://us.api.blizzard.com'\r\n * console.log(api.locale); // 'en_US'\r\n * console.log(api.origin); // 'us'\r\n */\r\nexport function getBlizzardApi<T extends Origins>(\r\n  origin: T,\r\n  locale?: (typeof _regionLocaleMap)[typeof origin][number],\r\n): BlizzardApi<typeof origin> {\r\n  const endpoint = endpoints[origin];\r\n\r\n  return {\r\n    hostname: endpoint.hostname,\r\n    locale: locale ?? endpoint.defaultLocale,\r\n    origin,\r\n  };\r\n}\r\n"],"mappings":";;;;AAGA,MAAa,aAAa;;;;AAK1B,MAAa,oBAAoB;;;;AAMjC,MAAa,qBAAqB;;;;AAKlC,MAAa,cAAc;;;;AAK3B,MAAa,uBAAuB;;;;AAKpC,MAAa,mBAAmB,GAAG,YAAY;;;;AAK/C,MAAa,oBAAoB,GAAG,YAAY;;;ACFhD,MAAM,YAAiC;CACrC,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;AACF;;;;;;;;;;;;;AAwBA,SAAgB,eACd,QACA,QAC4B;CAC5B,MAAM,WAAW,UAAU;CAE3B,OAAO;EACL,UAAU,SAAS;EACnB,QAAQ,UAAU,SAAS;EAC3B;CACF;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/base.ts","../src/blizzard-api.ts"],"sourcesContent":["/**\n * The base request path for the D3 API in the Blizzard API.\n */\nexport const d3BasePath = 'd3/data';\n\n/**\n * The base request path for profile APIs in the D3 API.\n */\nexport const d3ProfileBasePath = `d3/profile`;\n\n/**\n * The base request path for game data APIs in the D3 API.\n */\n// eslint-disable-next-line unicorn/consistent-compound-words\nexport const d3GameDataBasePath = `data/d3`;\n\n/**\n * The base request path for the Blizzard API for world of warcraft.\n */\nexport const wowBasePath = '/data/wow';\n\n/**\n * The base request path for the character API for Classic World of Warcraft.\n */\nexport const wowCharacterBasePath = 'profile/wow/character';\n\n/**\n * The base request path for media in the Blizzard API for world of warcraft.\n */\nexport const wowMediaBasePath = `${wowBasePath}/media` as const;\n\n/**\n * The base request path for search in the Blizzard API for world of warcraft.\n */\nexport const wowSearchBasePath = `${wowBasePath}/search` as const;\n\n/**\n * Base search parameters\n * orderby The field to order results by.\n * _page The page number to return.\n * @example\n * const params: BaseSearchParameters = {\n *  orderby: 'name',\n *  _page: 1,\n * };\n */\nexport interface BaseSearchParameters {\n  _page?: number;\n  orderby?: Array<string> | string;\n}\n/**\n * The standard structure to represent a World of Warcraft Character.\n */\nexport interface Character extends NameIdKey {\n  realm: Realm;\n}\n\n/**\n * A record containing the RGBA values of a color.\n */\nexport interface Color {\n  a: number;\n  b: number;\n  g: number;\n  r: number;\n}\n\n/**\n * The faction associated with a character or entity in World of Warcraft.\n */\nexport interface Faction {\n  name: string;\n  type: Factions;\n}\n\n/**\n * The playable factions in World of Warcraft.\n */\nexport type Factions = 'ALLIANCE' | 'HORDE' | 'NEUTRAL';\n\n/**\n * The playable factions at max level in World of Warcraft.\n */\nexport type NonNeutralFactions = 'ALLIANCE' | 'HORDE';\n\n/**\n * The gender associated with a character or entity in World of Warcraft.\n */\nexport interface Gender {\n  name: string;\n  type: 'FEMALE' | 'MALE';\n}\n\n/**\n * The playable gender names/descriptions in World of Warcraft.\n */\nexport interface GenderName {\n  female: null | string;\n  male: null | string;\n}\n\nexport interface Href {\n  href: string;\n}\n\n/**\n * Base record interface containing key.href property that often appear in Blizzard API responses.\n */\nexport interface KeyBase {\n  key: Href;\n}\n\n/**\n * The media asset associated with a character or entity in World of Warcraft.\n */\nexport interface MediaAsset {\n  file_data_id?: number;\n  key: string;\n  value: string;\n}\n\n/**\n * Base record interface containing name and id properties that often appear together in Blizzard API responses.\n */\nexport interface NameId {\n  id: number;\n  name: string;\n}\n\nexport interface NullishNameId {\n  id: number;\n  name: null | string;\n}\n\n/**\n * Base record containing both {@link KeyBase} and {@link NameId} interfaces.\n */\nexport interface NameIdKey extends KeyBase, NameId {}\n\nexport interface NullishNameIdKey extends Omit<NameIdKey, 'name'> {\n  name: null | string;\n}\n\n/**\n * The standard structure to represent a World of Warcraft Realm.\n */\nexport interface Realm extends KeyBase {\n  id: number;\n  name?: null | string;\n  slug: string;\n}\n\n/**\n * Base interface for Blizzard API responses.\n */\nexport interface ResponseBase {\n  _links: {\n    self: Href;\n  };\n}\n","import type { Locales, Origins } from './locales';\n\n/**\n * A record of regions and their supported locales.\n */\nconst _regionLocaleMap = {\n  cn: ['zh_CN'],\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'it_IT'],\n  kr: ['ko_KR', 'en_GB', 'en_US'],\n  tw: ['zh_TW', 'en_GB', 'en_US'],\n  us: ['en_US', 'es_MX', 'pt_BR'],\n} as const satisfies Record<Origins, Array<Locales>>;\n\n/**\n * A record of Blizzard API configurations by region.\n */\ninterface BlizzardApiByRegion {\n  cn: BlizzardApiDefault<'cn'>;\n  eu: BlizzardApiDefault<'eu'>;\n  kr: BlizzardApiDefault<'kr'>;\n  tw: BlizzardApiDefault<'tw'>;\n  us: BlizzardApiDefault<'us'>;\n}\n\n/**\n * The default Blizzard API configuration for each region.\n */\ninterface BlizzardApiDefault<T extends Origins> {\n  defaultLocale: (typeof _regionLocaleMap)[T][number];\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\n}\n\nconst endpoints: BlizzardApiByRegion = {\n  cn: {\n    defaultLocale: 'zh_CN',\n    hostname: 'https://gateway.battlenet.com.cn',\n  },\n  eu: {\n    defaultLocale: 'en_GB',\n    hostname: 'https://eu.api.blizzard.com',\n  },\n  kr: {\n    defaultLocale: 'ko_KR',\n    hostname: 'https://kr.api.blizzard.com',\n  },\n  tw: {\n    defaultLocale: 'zh_TW',\n    hostname: 'https://tw.api.blizzard.com',\n  },\n  us: {\n    defaultLocale: 'en_US',\n    hostname: 'https://us.api.blizzard.com',\n  },\n};\n\n/**\n * A Blizzard API configuration object.\n * @template T The region of the Blizzard API.\n */\ninterface BlizzardApi<T extends Origins> {\n  hostname: BlizzardApiDefault<Origins>['hostname'];\n  locale: (typeof _regionLocaleMap)[T][number];\n  origin: Origins;\n}\n\n/**\n * Get the Blizzard API configuration for a given region.\n * @template T The region of the Blizzard API.\n * @param origin The region of the Blizzard API.\n * @param locale The locale of the Blizzard API.\n * @returns The Blizzard API configuration for the given region.\n * @example\n * const api = getBlizzardApi('us', 'en_US');\n * console.log(api.hostname); // 'https://us.api.blizzard.com'\n * console.log(api.locale); // 'en_US'\n * console.log(api.origin); // 'us'\n */\nexport function getBlizzardApi<T extends Origins>(\n  origin: T,\n  locale?: (typeof _regionLocaleMap)[typeof origin][number],\n): BlizzardApi<typeof origin> {\n  const endpoint = endpoints[origin];\n\n  return {\n    hostname: endpoint.hostname,\n    locale: locale ?? endpoint.defaultLocale,\n    origin,\n  };\n}\n"],"mappings":";;;;AAGA,MAAa,aAAa;;;;AAK1B,MAAa,oBAAoB;;;;AAMjC,MAAa,qBAAqB;;;;AAKlC,MAAa,cAAc;;;;AAK3B,MAAa,uBAAuB;;;;AAKpC,MAAa,mBAAmB,GAAG,YAAY;;;;AAK/C,MAAa,oBAAoB,GAAG,YAAY;;;ACFhD,MAAM,YAAiC;CACrC,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;CACA,IAAI;EACF,eAAe;EACf,UAAU;CACZ;AACF;;;;;;;;;;;;;AAwBA,SAAgB,eACd,QACA,QAC4B;CAC5B,MAAM,WAAW,UAAU;CAE3B,OAAO;EACL,UAAU,SAAS;EACnB,QAAQ,UAAU,SAAS;EAC3B;CACF;AACF"}

package/package.json

@@ -1,18 +1,37 @@
 {
   "name": "@blizzard-api/core",
-  "version": "4.1.1",
+  "version": "4.1.3",
+  "description": "The core helpers used by all @blizzard-api/* packages.",
+  "keywords": [
+    "api",
+    "battle.net",
+    "battlenet",
+    "blizzard",
+    "bnet",
+    "classic",
+    "d3",
+    "diablo",
+    "hearthstone",
+    "hs",
+    "retail",
+    "sc2",
+    "starcraft",
+    "warcraft",
+    "world of warcraft",
+    "wow"
+  ],
   "license": "MIT",
   "author": "Putro",
-  "description": "The core helpers used by all @blizzard-api/* packages.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Pewtro/blizzard-api.git",
     "directory": "packages/core"
   },
+  "files": [
+    "dist"
+  ],
   "type": "module",
-  "engines": {
-    "node": "^22.13.0 || ^24 || ^26"
-  },
+  "sideEffects": false,
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -22,30 +41,11 @@
       "default": "./dist/index.js"
     }
   },
-  "files": [
-    "dist"
-  ],
-  "sideEffects": false,
-  "keywords": [
-    "blizzard",
-    "battlenet",
-    "battle.net",
-    "bnet",
-    "api",
-    "world of warcraft",
-    "warcraft",
-    "wow",
-    "classic",
-    "retail",
-    "starcraft",
-    "sc2",
-    "diablo",
-    "d3",
-    "hs",
-    "hearthstone"
-  ],
   "dependencies": {},
   "devDependencies": {},
+  "engines": {
+    "node": "^22.13.0 || ^24 || ^26"
+  },
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",