@blizzard-api/core 1.1.0 → 1.1.1

package/dist/index.cjs

@@ -1,62 +1,37 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  getBlizzardApi: () => getBlizzardApi
-});
-module.exports = __toCommonJS(src_exports);
+'use strict';
 
 // src/blizzard-api.ts
 var endpoints = {
-  us: {
-    hostname: "https://us.api.blizzard.com",
-    defaultLocale: "en_US"
+  cn: {
+    defaultLocale: "zh_CN",
+    hostname: "https://gateway.battlenet.com.cn"
   },
   eu: {
-    hostname: "https://eu.api.blizzard.com",
-    defaultLocale: "en_GB"
+    defaultLocale: "en_GB",
+    hostname: "https://eu.api.blizzard.com"
   },
   kr: {
-    hostname: "https://kr.api.blizzard.com",
-    defaultLocale: "ko_KR"
+    defaultLocale: "ko_KR",
+    hostname: "https://kr.api.blizzard.com"
   },
   tw: {
-    hostname: "https://tw.api.blizzard.com",
-    defaultLocale: "zh_TW"
+    defaultLocale: "zh_TW",
+    hostname: "https://tw.api.blizzard.com"
   },
-  cn: {
-    hostname: "https://gateway.battlenet.com.cn",
-    defaultLocale: "zh_CN"
+  us: {
+    defaultLocale: "en_US",
+    hostname: "https://us.api.blizzard.com"
   }
 };
 function getBlizzardApi(origin, locale) {
   const endpoint = endpoints[origin];
   return {
-    origin,
     hostname: endpoint.hostname,
-    locale: locale ?? endpoint.defaultLocale
+    locale: locale ?? endpoint.defaultLocale,
+    origin
   };
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getBlizzardApi
-});
+
+exports.getBlizzardApi = getBlizzardApi;
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/blizzard-api.ts"],"sourcesContent":["//Blizzard API\r\nexport * from './blizzard-api';\r\n\r\n//Namespace\r\nexport * from './namespace';\r\n\r\n//Resource\r\nexport * from './resource';\r\n\r\n//Search\r\nexport * from './search';\r\n","/**\r\n * Possible regions for use within the Blizzard API.\r\n */\r\nexport type Origins = 'us' | 'eu' | 'kr' | 'tw' | 'cn';\r\n/**\r\n * Possible locales for use within the Blizzard API.\r\n */\r\nexport type Locales =\r\n  | 'en_US'\r\n  | 'es_MX'\r\n  | 'pt_BR'\r\n  | 'en_GB'\r\n  | 'es_ES'\r\n  | 'fr_FR'\r\n  | 'ru_RU'\r\n  | 'de_DE'\r\n  | 'pt_PT'\r\n  | 'it_IT'\r\n  | 'ko_KR'\r\n  | 'zh_TW'\r\n  | 'zh_CN'\r\n  | 'multi';\r\n\r\n/**\r\n * A record of regions and their supported locales.\r\n */\r\nconst locales = {\r\n  us: ['en_US', 'es_MX', 'pt_BR', 'multi'],\r\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'pt_PT', 'it_IT', 'multi'],\r\n  kr: ['ko_KR', 'en_GB', 'en_US', 'multi'],\r\n  tw: ['zh_TW', 'en_GB', 'en_US', 'multi'],\r\n  cn: ['zh_CN'],\r\n} as const satisfies Record<Origins, Array<Locales>>;\r\n\r\n/**\r\n * The default Blizzard API configuration for each region.\r\n */\r\ninterface BlizzardApiDefault<T extends Origins> {\r\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\r\n  defaultLocale: (typeof locales)[T][number];\r\n}\r\n\r\n/**\r\n * A record of Blizzard API configurations by region.\r\n */\r\ninterface BlizzardApiByRegion {\r\n  us: BlizzardApiDefault<'us'>;\r\n  eu: BlizzardApiDefault<'eu'>;\r\n  kr: BlizzardApiDefault<'kr'>;\r\n  tw: BlizzardApiDefault<'tw'>;\r\n  cn: BlizzardApiDefault<'cn'>;\r\n}\r\n\r\nconst endpoints: BlizzardApiByRegion = {\r\n  us: {\r\n    hostname: 'https://us.api.blizzard.com',\r\n    defaultLocale: 'en_US',\r\n  },\r\n  eu: {\r\n    hostname: 'https://eu.api.blizzard.com',\r\n    defaultLocale: 'en_GB',\r\n  },\r\n  kr: {\r\n    hostname: 'https://kr.api.blizzard.com',\r\n    defaultLocale: 'ko_KR',\r\n  },\r\n  tw: {\r\n    hostname: 'https://tw.api.blizzard.com',\r\n    defaultLocale: 'zh_TW',\r\n  },\r\n  cn: {\r\n    hostname: 'https://gateway.battlenet.com.cn',\r\n    defaultLocale: 'zh_CN',\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 * @property origin The region of the Blizzard API.\r\n * @property locale The locale of the Blizzard API.\r\n * @property hostname The hostname of the Blizzard API.\r\n */\r\ninterface BlizzardApi<T extends Origins> {\r\n  origin: Origins;\r\n  locale: (typeof locales)[T][number];\r\n  hostname: BlizzardApiDefault<Origins>['hostname'];\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 locales)[typeof origin][number],\r\n): BlizzardApi<typeof origin> {\r\n  const endpoint = endpoints[origin];\r\n\r\n  return {\r\n    origin,\r\n    hostname: endpoint.hostname,\r\n    locale: locale ?? endpoint.defaultLocale,\r\n  };\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqDA,IAAM,YAAiC;AAAA,EACrC,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AACF;AA2BO,SAAS,eACd,QACA,QAC4B;AAC5B,QAAM,WAAW,UAAU,MAAM;AAEjC,SAAO;AAAA,IACL;AAAA,IACA,UAAU,SAAS;AAAA,IACnB,QAAQ,UAAU,SAAS;AAAA,EAC7B;AACF;","names":[]}
+{"version":3,"sources":["../src/blizzard-api.ts"],"names":[],"mappings":";AAqDA,IAAM,YAAiC;AAAA,EACrC,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AACF;AA2BO,SAAS,eACd,QACA,QAC4B;AAC5B,QAAM,WAAW,UAAU,MAAM;AAEjC,SAAO;AAAA,IACL,UAAU,SAAS;AAAA,IACnB,QAAQ,UAAU,SAAS;AAAA,IAC3B;AAAA,EACF;AACF","sourcesContent":["/**\r\n * Possible regions for use within the Blizzard API.\r\n */\r\nexport type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';\r\n/**\r\n * Possible locales for use within the Blizzard API.\r\n */\r\nexport type Locales =\r\n  | 'de_DE'\r\n  | 'en_GB'\r\n  | 'en_US'\r\n  | 'es_ES'\r\n  | 'es_MX'\r\n  | 'fr_FR'\r\n  | 'it_IT'\r\n  | 'ko_KR'\r\n  | 'multi'\r\n  | 'pt_BR'\r\n  | 'pt_PT'\r\n  | 'ru_RU'\r\n  | 'zh_CN'\r\n  | 'zh_TW';\r\n\r\n/**\r\n * A record of regions and their supported locales.\r\n */\r\nconst locales = {\r\n  cn: ['zh_CN'],\r\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'pt_PT', 'it_IT', 'multi'],\r\n  kr: ['ko_KR', 'en_GB', 'en_US', 'multi'],\r\n  tw: ['zh_TW', 'en_GB', 'en_US', 'multi'],\r\n  us: ['en_US', 'es_MX', 'pt_BR', 'multi'],\r\n} as const satisfies Record<Origins, Array<Locales>>;\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 locales)[T][number];\r\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\r\n}\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\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 * @property origin The region of the Blizzard API.\r\n * @property locale The locale of the Blizzard API.\r\n * @property hostname The hostname of the Blizzard API.\r\n */\r\ninterface BlizzardApi<T extends Origins> {\r\n  hostname: BlizzardApiDefault<Origins>['hostname'];\r\n  locale: (typeof locales)[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 locales)[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"]}

package/dist/index.d.cts

@@ -1,27 +1,27 @@
 /**
  * Possible regions for use within the Blizzard API.
  */
-type Origins = 'us' | 'eu' | 'kr' | 'tw' | 'cn';
+type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
 /**
  * Possible locales for use within the Blizzard API.
  */
-type Locales = 'en_US' | 'es_MX' | 'pt_BR' | 'en_GB' | 'es_ES' | 'fr_FR' | 'ru_RU' | 'de_DE' | 'pt_PT' | 'it_IT' | 'ko_KR' | 'zh_TW' | 'zh_CN' | 'multi';
+type Locales = 'de_DE' | 'en_GB' | 'en_US' | 'es_ES' | 'es_MX' | 'fr_FR' | 'it_IT' | 'ko_KR' | 'multi' | 'pt_BR' | 'pt_PT' | 'ru_RU' | 'zh_CN' | 'zh_TW';
 /**
  * A record of regions and their supported locales.
  */
 declare const locales: {
-    readonly us: ["en_US", "es_MX", "pt_BR", "multi"];
+    readonly cn: ["zh_CN"];
     readonly eu: ["en_GB", "es_ES", "fr_FR", "ru_RU", "de_DE", "pt_PT", "it_IT", "multi"];
     readonly kr: ["ko_KR", "en_GB", "en_US", "multi"];
     readonly tw: ["zh_TW", "en_GB", "en_US", "multi"];
-    readonly cn: ["zh_CN"];
+    readonly us: ["en_US", "es_MX", "pt_BR", "multi"];
 };
 /**
  * The default Blizzard API configuration for each region.
  */
 interface BlizzardApiDefault<T extends Origins> {
-    hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;
     defaultLocale: (typeof locales)[T][number];
+    hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;
 }
 /**
  * A Blizzard API configuration object.
@@ -31,9 +31,9 @@ interface BlizzardApiDefault<T extends Origins> {
  * @property hostname The hostname of the Blizzard API.
  */
 interface BlizzardApi<T extends Origins> {
-    origin: Origins;
-    locale: (typeof locales)[T][number];
     hostname: BlizzardApiDefault<Origins>['hostname'];
+    locale: (typeof locales)[T][number];
+    origin: Origins;
 }
 /**
  * Get the Blizzard API configuration for a given region.
@@ -53,7 +53,7 @@ declare function getBlizzardApi<T extends Origins>(origin: T, locale?: (typeof l
  * Blizzard API namespaces.
  * @see https://develop.battle.net/documentation/world-of-warcraft/guides/namespaces
  */
-type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' | 'dynamic-classic' | 'static-classic1x' | 'dynamic-classic1x';
+type BlizzardNamespaces = 'dynamic-classic' | 'dynamic-classic1x' | 'dynamic' | 'profile' | 'static-classic' | 'static-classic1x' | 'static';
 
 /**
  * Represents a resource that can be requested from the Blizzard API
@@ -62,14 +62,14 @@ type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' |
  * @param ProtectedResource Whether the resource requires a token to be requested
  */
 type Resource<Response, SearchOptions extends object = Record<string, never>, ProtectedResource extends boolean = false> = {
-    path: string;
-    namespace?: BlizzardNamespaces;
-    parameters?: SearchOptions;
     /**
      * The response type of the resource
      * @private @internal This is an internal property and should not be used as it will not be populated
      */
     _responseType?: Response;
+    namespace?: BlizzardNamespaces;
+    parameters?: SearchOptions;
+    path: string;
 } & (ProtectedResource extends true ? {
     token: string;
 } : unknown);
@@ -103,8 +103,8 @@ type ExtractResourceType<Type> = Type extends Resource<infer R, infer _SearchOpt
  * };
  */
 interface BaseSearchParameters {
-    orderby?: string | Array<string>;
     _page?: number;
+    orderby?: Array<string> | string;
 }
 /**
  * Search response
@@ -124,10 +124,10 @@ interface BaseSearchParameters {
  * };
  */
 interface SearchResponse<T> {
-    page: number;
-    pageSize: number;
     maxPageSize: number;
+    page: number;
     pageCount: number;
+    pageSize: number;
     resultCountCapped?: boolean;
     results: Array<T>;
 }

package/dist/index.d.ts

@@ -1,27 +1,27 @@
 /**
  * Possible regions for use within the Blizzard API.
  */
-type Origins = 'us' | 'eu' | 'kr' | 'tw' | 'cn';
+type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
 /**
  * Possible locales for use within the Blizzard API.
  */
-type Locales = 'en_US' | 'es_MX' | 'pt_BR' | 'en_GB' | 'es_ES' | 'fr_FR' | 'ru_RU' | 'de_DE' | 'pt_PT' | 'it_IT' | 'ko_KR' | 'zh_TW' | 'zh_CN' | 'multi';
+type Locales = 'de_DE' | 'en_GB' | 'en_US' | 'es_ES' | 'es_MX' | 'fr_FR' | 'it_IT' | 'ko_KR' | 'multi' | 'pt_BR' | 'pt_PT' | 'ru_RU' | 'zh_CN' | 'zh_TW';
 /**
  * A record of regions and their supported locales.
  */
 declare const locales: {
-    readonly us: ["en_US", "es_MX", "pt_BR", "multi"];
+    readonly cn: ["zh_CN"];
     readonly eu: ["en_GB", "es_ES", "fr_FR", "ru_RU", "de_DE", "pt_PT", "it_IT", "multi"];
     readonly kr: ["ko_KR", "en_GB", "en_US", "multi"];
     readonly tw: ["zh_TW", "en_GB", "en_US", "multi"];
-    readonly cn: ["zh_CN"];
+    readonly us: ["en_US", "es_MX", "pt_BR", "multi"];
 };
 /**
  * The default Blizzard API configuration for each region.
  */
 interface BlizzardApiDefault<T extends Origins> {
-    hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;
     defaultLocale: (typeof locales)[T][number];
+    hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;
 }
 /**
  * A Blizzard API configuration object.
@@ -31,9 +31,9 @@ interface BlizzardApiDefault<T extends Origins> {
  * @property hostname The hostname of the Blizzard API.
  */
 interface BlizzardApi<T extends Origins> {
-    origin: Origins;
-    locale: (typeof locales)[T][number];
     hostname: BlizzardApiDefault<Origins>['hostname'];
+    locale: (typeof locales)[T][number];
+    origin: Origins;
 }
 /**
  * Get the Blizzard API configuration for a given region.
@@ -53,7 +53,7 @@ declare function getBlizzardApi<T extends Origins>(origin: T, locale?: (typeof l
  * Blizzard API namespaces.
  * @see https://develop.battle.net/documentation/world-of-warcraft/guides/namespaces
  */
-type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' | 'dynamic-classic' | 'static-classic1x' | 'dynamic-classic1x';
+type BlizzardNamespaces = 'dynamic-classic' | 'dynamic-classic1x' | 'dynamic' | 'profile' | 'static-classic' | 'static-classic1x' | 'static';
 
 /**
  * Represents a resource that can be requested from the Blizzard API
@@ -62,14 +62,14 @@ type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' |
  * @param ProtectedResource Whether the resource requires a token to be requested
  */
 type Resource<Response, SearchOptions extends object = Record<string, never>, ProtectedResource extends boolean = false> = {
-    path: string;
-    namespace?: BlizzardNamespaces;
-    parameters?: SearchOptions;
     /**
      * The response type of the resource
      * @private @internal This is an internal property and should not be used as it will not be populated
      */
     _responseType?: Response;
+    namespace?: BlizzardNamespaces;
+    parameters?: SearchOptions;
+    path: string;
 } & (ProtectedResource extends true ? {
     token: string;
 } : unknown);
@@ -103,8 +103,8 @@ type ExtractResourceType<Type> = Type extends Resource<infer R, infer _SearchOpt
  * };
  */
 interface BaseSearchParameters {
-    orderby?: string | Array<string>;
     _page?: number;
+    orderby?: Array<string> | string;
 }
 /**
  * Search response
@@ -124,10 +124,10 @@ interface BaseSearchParameters {
  * };
  */
 interface SearchResponse<T> {
-    page: number;
-    pageSize: number;
     maxPageSize: number;
+    page: number;
     pageCount: number;
+    pageSize: number;
     resultCountCapped?: boolean;
     results: Array<T>;
 }

package/dist/index.js

@@ -1,35 +1,35 @@
 // src/blizzard-api.ts
 var endpoints = {
-  us: {
-    hostname: "https://us.api.blizzard.com",
-    defaultLocale: "en_US"
+  cn: {
+    defaultLocale: "zh_CN",
+    hostname: "https://gateway.battlenet.com.cn"
   },
   eu: {
-    hostname: "https://eu.api.blizzard.com",
-    defaultLocale: "en_GB"
+    defaultLocale: "en_GB",
+    hostname: "https://eu.api.blizzard.com"
   },
   kr: {
-    hostname: "https://kr.api.blizzard.com",
-    defaultLocale: "ko_KR"
+    defaultLocale: "ko_KR",
+    hostname: "https://kr.api.blizzard.com"
   },
   tw: {
-    hostname: "https://tw.api.blizzard.com",
-    defaultLocale: "zh_TW"
+    defaultLocale: "zh_TW",
+    hostname: "https://tw.api.blizzard.com"
   },
-  cn: {
-    hostname: "https://gateway.battlenet.com.cn",
-    defaultLocale: "zh_CN"
+  us: {
+    defaultLocale: "en_US",
+    hostname: "https://us.api.blizzard.com"
   }
 };
 function getBlizzardApi(origin, locale) {
   const endpoint = endpoints[origin];
   return {
-    origin,
     hostname: endpoint.hostname,
-    locale: locale ?? endpoint.defaultLocale
+    locale: locale ?? endpoint.defaultLocale,
+    origin
   };
 }
-export {
-  getBlizzardApi
-};
+
+export { getBlizzardApi };
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/blizzard-api.ts"],"sourcesContent":["/**\r\n * Possible regions for use within the Blizzard API.\r\n */\r\nexport type Origins = 'us' | 'eu' | 'kr' | 'tw' | 'cn';\r\n/**\r\n * Possible locales for use within the Blizzard API.\r\n */\r\nexport type Locales =\r\n  | 'en_US'\r\n  | 'es_MX'\r\n  | 'pt_BR'\r\n  | 'en_GB'\r\n  | 'es_ES'\r\n  | 'fr_FR'\r\n  | 'ru_RU'\r\n  | 'de_DE'\r\n  | 'pt_PT'\r\n  | 'it_IT'\r\n  | 'ko_KR'\r\n  | 'zh_TW'\r\n  | 'zh_CN'\r\n  | 'multi';\r\n\r\n/**\r\n * A record of regions and their supported locales.\r\n */\r\nconst locales = {\r\n  us: ['en_US', 'es_MX', 'pt_BR', 'multi'],\r\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'pt_PT', 'it_IT', 'multi'],\r\n  kr: ['ko_KR', 'en_GB', 'en_US', 'multi'],\r\n  tw: ['zh_TW', 'en_GB', 'en_US', 'multi'],\r\n  cn: ['zh_CN'],\r\n} as const satisfies Record<Origins, Array<Locales>>;\r\n\r\n/**\r\n * The default Blizzard API configuration for each region.\r\n */\r\ninterface BlizzardApiDefault<T extends Origins> {\r\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\r\n  defaultLocale: (typeof locales)[T][number];\r\n}\r\n\r\n/**\r\n * A record of Blizzard API configurations by region.\r\n */\r\ninterface BlizzardApiByRegion {\r\n  us: BlizzardApiDefault<'us'>;\r\n  eu: BlizzardApiDefault<'eu'>;\r\n  kr: BlizzardApiDefault<'kr'>;\r\n  tw: BlizzardApiDefault<'tw'>;\r\n  cn: BlizzardApiDefault<'cn'>;\r\n}\r\n\r\nconst endpoints: BlizzardApiByRegion = {\r\n  us: {\r\n    hostname: 'https://us.api.blizzard.com',\r\n    defaultLocale: 'en_US',\r\n  },\r\n  eu: {\r\n    hostname: 'https://eu.api.blizzard.com',\r\n    defaultLocale: 'en_GB',\r\n  },\r\n  kr: {\r\n    hostname: 'https://kr.api.blizzard.com',\r\n    defaultLocale: 'ko_KR',\r\n  },\r\n  tw: {\r\n    hostname: 'https://tw.api.blizzard.com',\r\n    defaultLocale: 'zh_TW',\r\n  },\r\n  cn: {\r\n    hostname: 'https://gateway.battlenet.com.cn',\r\n    defaultLocale: 'zh_CN',\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 * @property origin The region of the Blizzard API.\r\n * @property locale The locale of the Blizzard API.\r\n * @property hostname The hostname of the Blizzard API.\r\n */\r\ninterface BlizzardApi<T extends Origins> {\r\n  origin: Origins;\r\n  locale: (typeof locales)[T][number];\r\n  hostname: BlizzardApiDefault<Origins>['hostname'];\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 locales)[typeof origin][number],\r\n): BlizzardApi<typeof origin> {\r\n  const endpoint = endpoints[origin];\r\n\r\n  return {\r\n    origin,\r\n    hostname: endpoint.hostname,\r\n    locale: locale ?? endpoint.defaultLocale,\r\n  };\r\n}\r\n"],"mappings":";AAqDA,IAAM,YAAiC;AAAA,EACrC,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AAAA,EACA,IAAI;AAAA,IACF,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AACF;AA2BO,SAAS,eACd,QACA,QAC4B;AAC5B,QAAM,WAAW,UAAU,MAAM;AAEjC,SAAO;AAAA,IACL;AAAA,IACA,UAAU,SAAS;AAAA,IACnB,QAAQ,UAAU,SAAS;AAAA,EAC7B;AACF;","names":[]}
+{"version":3,"sources":["../src/blizzard-api.ts"],"names":[],"mappings":";AAqDA,IAAM,YAAiC;AAAA,EACrC,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AAAA,EACA,IAAI;AAAA,IACF,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AACF;AA2BO,SAAS,eACd,QACA,QAC4B;AAC5B,QAAM,WAAW,UAAU,MAAM;AAEjC,SAAO;AAAA,IACL,UAAU,SAAS;AAAA,IACnB,QAAQ,UAAU,SAAS;AAAA,IAC3B;AAAA,EACF;AACF","sourcesContent":["/**\r\n * Possible regions for use within the Blizzard API.\r\n */\r\nexport type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';\r\n/**\r\n * Possible locales for use within the Blizzard API.\r\n */\r\nexport type Locales =\r\n  | 'de_DE'\r\n  | 'en_GB'\r\n  | 'en_US'\r\n  | 'es_ES'\r\n  | 'es_MX'\r\n  | 'fr_FR'\r\n  | 'it_IT'\r\n  | 'ko_KR'\r\n  | 'multi'\r\n  | 'pt_BR'\r\n  | 'pt_PT'\r\n  | 'ru_RU'\r\n  | 'zh_CN'\r\n  | 'zh_TW';\r\n\r\n/**\r\n * A record of regions and their supported locales.\r\n */\r\nconst locales = {\r\n  cn: ['zh_CN'],\r\n  eu: ['en_GB', 'es_ES', 'fr_FR', 'ru_RU', 'de_DE', 'pt_PT', 'it_IT', 'multi'],\r\n  kr: ['ko_KR', 'en_GB', 'en_US', 'multi'],\r\n  tw: ['zh_TW', 'en_GB', 'en_US', 'multi'],\r\n  us: ['en_US', 'es_MX', 'pt_BR', 'multi'],\r\n} as const satisfies Record<Origins, Array<Locales>>;\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 locales)[T][number];\r\n  hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;\r\n}\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\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 * @property origin The region of the Blizzard API.\r\n * @property locale The locale of the Blizzard API.\r\n * @property hostname The hostname of the Blizzard API.\r\n */\r\ninterface BlizzardApi<T extends Origins> {\r\n  hostname: BlizzardApiDefault<Origins>['hostname'];\r\n  locale: (typeof locales)[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 locales)[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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/core",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "author": "Putro",
   "description": "The core helpers used by all @blizzard-api/* packages.",
@@ -9,7 +9,9 @@
   "engines": {
     "node": "^18.18 || ^20.9 || ^21.1 || ^22"
   },
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     "import": {
       "types": "./dist/index.d.ts",