@blizzard-api/core 1.2.0 → 2.0.0

package/package.json

@@ -1,25 +1,21 @@
 {
   "name": "@blizzard-api/core",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "license": "MIT",
   "author": "Putro",
   "description": "The core helpers used by all @blizzard-api/* packages.",
-  "repository": "https://github.com/Pewtro/blizzard/tree/main/packages/core",
+  "repository": "https://github.com/Pewtro/blizzard-api/tree/main/packages/core",
   "type": "module",
   "engines": {
-    "node": "^18.18 || ^20.9 || ^21.1 || ^22"
+    "node": "^18.18 || >=20.9"
   },
-  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     "import": {
+      "@blizzard-api/core-local": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    },
-    "require": {
-      "types": "./dist/index.d.cts",
-      "default": "./dist/index.cjs"
     }
   },
   "files": [

package/dist/index.cjs

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

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/blizzard-api.ts"],"names":[],"mappings":";;;AAqDA,IAAM,SAAiC,GAAA;AAAA,EACrC,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA,kCAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA,6BAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA,6BAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA,6BAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA,6BAAA;AAAA,GACZ;AACF,CAAA,CAAA;AA2BO,SAAS,cAAA,CACd,QACA,MAC4B,EAAA;AAC5B,EAAM,MAAA,QAAA,GAAW,UAAU,MAAM,CAAA,CAAA;AAEjC,EAAO,OAAA;AAAA,IACL,UAAU,QAAS,CAAA,QAAA;AAAA,IACnB,MAAA,EAAQ,UAAU,QAAS,CAAA,aAAA;AAAA,IAC3B,MAAA;AAAA,GACF,CAAA;AACF","file":"index.cjs","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 _regionLocaleMap = {\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 _regionLocaleMap)[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 _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"]}

package/dist/index.d.cts

@@ -1,142 +0,0 @@
-/**
- * Possible regions for use within the Blizzard API.
- */
-type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
-/**
- * Possible locales for use within the Blizzard API.
- */
-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 _regionLocaleMap: {
-    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 us: ["en_US", "es_MX", "pt_BR", "multi"];
-};
-/**
- * The default Blizzard API configuration for each region.
- */
-interface BlizzardApiDefault<T extends Origins> {
-    defaultLocale: (typeof _regionLocaleMap)[T][number];
-    hostname: T extends 'cn' ? 'https://gateway.battlenet.com.cn' : `https://${T}.api.blizzard.com`;
-}
-/**
- * A Blizzard API configuration object.
- * @template T The region of the Blizzard API.
- * @property origin The region of the Blizzard API.
- * @property locale The locale of the Blizzard API.
- * @property hostname The hostname of the Blizzard API.
- */
-interface BlizzardApi<T extends Origins> {
-    hostname: BlizzardApiDefault<Origins>['hostname'];
-    locale: (typeof _regionLocaleMap)[T][number];
-    origin: Origins;
-}
-/**
- * Get the Blizzard API configuration for a given region.
- * @template T The region of the Blizzard API.
- * @param origin The region of the Blizzard API.
- * @param locale The locale of the Blizzard API.
- * @returns The Blizzard API configuration for the given region.
- * @example
- * const api = getBlizzardApi('us', 'en_US');
- * console.log(api.hostname); // 'https://us.api.blizzard.com'
- * 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>;
-
-/**
- * Blizzard API namespaces.
- * @see https://develop.battle.net/documentation/world-of-warcraft/guides/namespaces
- */
-type BlizzardNamespaces = 'dynamic' | 'dynamic-classic' | 'dynamic-classic1x' | 'profile' | 'static' | 'static-classic' | 'static-classic1x';
-
-/**
- * Represents a resource that can be requested from the Blizzard API
- * @param _Response The response type of the resource
- * @param SearchOptions The search options that can be passed to the resource
- * @param ProtectedResource Whether the resource requires a token to be requested
- */
-type Resource<Response, SearchOptions extends object = Record<string, never>, ProtectedResource extends boolean = false> = {
-    /**
-     * 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);
-/**
- * Represents a resource that requires a token to be requested
- * @param Response The response type of the resource
- * @param SearchOptions The search options that can be passed to the resource
- *
- */
-type ProtectedResource<Response, SearchOptions extends object = Record<string, never>> = Resource<Response, SearchOptions, true>;
-/**
- * Represents the response of a resource
- * @param T The response type of the resource
- * @example
- * type response = ResourceResponse<{ id: number }>;
- * const response: response = Promise.resolve({ id: 1 });
- * response.then((data) => console.log(data.id));
- */
-type ResourceResponse<T = unknown> = Promise<T>;
-/**
- * Extracts the response type from a resource
- * @param Type The resource type
- * @returns The response type
- * @example
- * type extracted = ExtractResourceType<Resource<{ id: number }>>;
- */
-type ExtractResourceType<Type> = Type extends Resource<infer R, infer _SearchOptions, infer _Protected> ? R : never;
-
-/**
- * Base search parameters
- * @interface BaseSearchParameters
- * @property orderby The field to order results by.
- * @property _page The page number to return.
- * @example
- * const params: BaseSearchParameters = {
- *  orderby: 'name',
- *  _page: 1,
- * };
- */
-interface BaseSearchParameters {
-    _page?: number;
-    orderby?: Array<string> | string;
-}
-/**
- * Search response
- * @interface SearchResponse
- * @property page The current page number.
- * @property pageSize The number of results per page.
- * @property maxPageSize The maximum number of results per page.
- * @property pageCount The total number of pages.
- * @property results The search results.
- * @example
- * const response: SearchResponse = {
- *  page: 1,
- *  pageSize: 20,
- *  maxPageSize: 100,
- *  pageCount: 10,
- *  results: [],
- * };
- */
-interface SearchResponse<T> {
-    maxPageSize: number;
-    page: number;
-    pageCount: number;
-    pageSize: number;
-    resultCountCapped?: boolean;
-    results: Array<T>;
-}
-
-export { type BaseSearchParameters, type BlizzardNamespaces, type ExtractResourceType, type Locales, type Origins, type ProtectedResource, type Resource, type ResourceResponse, type SearchResponse, getBlizzardApi };