@blizzard-api/core 2.0.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +9 -15
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -26,9 +26,6 @@ interface BlizzardApiDefault<T extends Origins> {
|
|
|
26
26
|
/**
|
|
27
27
|
* A Blizzard API configuration object.
|
|
28
28
|
* @template T The region of the Blizzard API.
|
|
29
|
-
* @property origin The region of the Blizzard API.
|
|
30
|
-
* @property locale The locale of the Blizzard API.
|
|
31
|
-
* @property hostname The hostname of the Blizzard API.
|
|
32
29
|
*/
|
|
33
30
|
interface BlizzardApi<T extends Origins> {
|
|
34
31
|
hostname: BlizzardApiDefault<Origins>['hostname'];
|
|
@@ -53,7 +50,7 @@ declare function getBlizzardApi<T extends Origins>(origin: T, locale?: (typeof _
|
|
|
53
50
|
* Blizzard API namespaces.
|
|
54
51
|
* @see https://develop.battle.net/documentation/world-of-warcraft/guides/namespaces
|
|
55
52
|
*/
|
|
56
|
-
type BlizzardNamespaces = 'dynamic' | 'dynamic-classic1x' | 'dynamic-classic' | 'profile' | 'static' | 'static-classic1x' | 'static-classic';
|
|
53
|
+
type BlizzardNamespaces = 'dynamic' | 'dynamic-classic1x' | 'dynamic-classic' | 'profile' | 'profile-classic1x' | 'profile-classic' | 'static' | 'static-classic1x' | 'static-classic';
|
|
57
54
|
|
|
58
55
|
/**
|
|
59
56
|
* Extracts the response type from a resource
|
|
@@ -67,7 +64,6 @@ type ExtractResourceType<Type> = Type extends Resource<infer R, infer _SearchOpt
|
|
|
67
64
|
* Represents a resource that requires a token to be requested
|
|
68
65
|
* @param Response The response type of the resource
|
|
69
66
|
* @param SearchOptions The search options that can be passed to the resource
|
|
70
|
-
*
|
|
71
67
|
*/
|
|
72
68
|
type ProtectedResource<Response, SearchOptions extends object = Record<string, never>> = Resource<Response, SearchOptions, true>;
|
|
73
69
|
/**
|
|
@@ -81,7 +77,7 @@ type Resource<Response, SearchOptions extends object = Record<string, never>, Is
|
|
|
81
77
|
} : unknown) & {
|
|
82
78
|
/**
|
|
83
79
|
* The response type of the resource
|
|
84
|
-
* @
|
|
80
|
+
* @internal
|
|
85
81
|
*/
|
|
86
82
|
_responseType?: Response;
|
|
87
83
|
namespace?: BlizzardNamespaces;
|
|
@@ -100,9 +96,8 @@ type ResourceResponse<T = unknown> = Promise<T>;
|
|
|
100
96
|
|
|
101
97
|
/**
|
|
102
98
|
* Base search parameters
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* @property _page The page number to return.
|
|
99
|
+
* orderby The field to order results by.
|
|
100
|
+
* _page The page number to return.
|
|
106
101
|
* @example
|
|
107
102
|
* const params: BaseSearchParameters = {
|
|
108
103
|
* orderby: 'name',
|
|
@@ -115,12 +110,11 @@ interface BaseSearchParameters {
|
|
|
115
110
|
}
|
|
116
111
|
/**
|
|
117
112
|
* Search response
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* @property results The search results.
|
|
113
|
+
* page The current page number.
|
|
114
|
+
* pageSize The number of results per page.
|
|
115
|
+
* maxPageSize The maximum number of results per page.
|
|
116
|
+
* pageCount The total number of pages.
|
|
117
|
+
* results The search results.
|
|
124
118
|
* @example
|
|
125
119
|
* const response: SearchResponse = {
|
|
126
120
|
* page: 1,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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
|
|
1
|
+
{"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;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA;AAAA,GACZ;AAAA,EACA,EAAI,EAAA;AAAA,IACF,aAAe,EAAA,OAAA;AAAA,IACf,QAAU,EAAA;AAAA;AAEd,CAAA;AAwBO,SAAS,cAAA,CACd,QACA,MAC4B,EAAA;AAC5B,EAAM,MAAA,QAAA,GAAW,UAAU,MAAM,CAAA;AAEjC,EAAO,OAAA;AAAA,IACL,UAAU,QAAS,CAAA,QAAA;AAAA,IACnB,MAAA,EAAQ,UAAU,QAAS,CAAA,aAAA;AAAA,IAC3B;AAAA,GACF;AACF","file":"index.js","sourcesContent":["/**\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 * Possible regions for use within the Blizzard API.\r\n */\r\nexport type Origins = 'cn' | 'eu' | 'kr' | 'tw' | 'us';\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 * 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"]}
|