@blizzard-api/core 0.0.6 → 0.0.8
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.cjs.map +1 -1
- package/dist/index.d.cts +15 -2
- package/dist/index.d.ts +15 -2
- package/package.json +1 -1
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/endpoint.ts"],"sourcesContent":["//Endpoint\r\nexport
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/endpoint.ts"],"sourcesContent":["//Endpoint\r\nexport * from './endpoint.js';\r\n\r\n//Namespace\r\nexport * from './namespace.js';\r\n\r\n//Resource\r\nexport * from './resource.js';\r\n","export type Origins = 'us' | 'eu' | 'kr' | 'tw';\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 | 'multi';\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} as const satisfies Record<Origins, Array<Locales>>;\r\n\r\ninterface Endpoint<T extends Origins> {\r\n hostname: `https://${T}.api.blizzard.com`;\r\n defaultLocale: (typeof locales)[T][number];\r\n}\r\n\r\ninterface Endpoints {\r\n us: Endpoint<'us'>;\r\n eu: Endpoint<'eu'>;\r\n kr: Endpoint<'kr'>;\r\n tw: Endpoint<'tw'>;\r\n}\r\n\r\nconst endpoints: Endpoints = {\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};\r\n\r\ninterface GetEndpoint<T extends Origins> {\r\n origin: Origins;\r\n locale: (typeof locales)[T][number];\r\n hostname: Endpoint<Origins>['hostname'];\r\n}\r\n\r\nexport function getEndpoint<T extends Origins>(\r\n origin: T,\r\n locale?: (typeof locales)[typeof origin][number],\r\n): GetEndpoint<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;;;ACmCA,IAAM,YAAuB;AAAA,EAC3B,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;AAQO,SAAS,YACd,QACA,QAC4B;AAC5B,QAAM,WAAW,UAAU,MAAM;AAEjC,SAAO;AAAA,IACL;AAAA,IACA,UAAU,SAAS;AAAA,IACnB,QAAQ,UAAU,SAAS;AAAA,EAC7B;AACF;","names":[]}
|
package/dist/index.d.cts
CHANGED
|
@@ -24,10 +24,15 @@ type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' |
|
|
|
24
24
|
* @param _Response The response type of the resource
|
|
25
25
|
* @param ProtectedResource Whether the resource requires a token to be requested
|
|
26
26
|
*/
|
|
27
|
-
type Resource<
|
|
27
|
+
type Resource<Response, ProtectedResource extends boolean = false> = {
|
|
28
28
|
path: string;
|
|
29
29
|
namespace?: BlizzardNamespaces;
|
|
30
30
|
parameters?: Record<string, string | number>;
|
|
31
|
+
/**
|
|
32
|
+
* The response type of the resource
|
|
33
|
+
* @private @internal This is an internal property and should not be used as it will not be populated
|
|
34
|
+
*/
|
|
35
|
+
_responseType?: Response;
|
|
31
36
|
} & (ProtectedResource extends true ? {
|
|
32
37
|
token: string;
|
|
33
38
|
} : unknown);
|
|
@@ -40,5 +45,13 @@ type Resource<_Response, ProtectedResource extends boolean = false> = {
|
|
|
40
45
|
* response.then((data) => console.log(data.id));
|
|
41
46
|
*/
|
|
42
47
|
type ResourceResponse<T = unknown> = Promise<T>;
|
|
48
|
+
/**
|
|
49
|
+
* Extracts the response type from a resource
|
|
50
|
+
* @param Type The resource type
|
|
51
|
+
* @returns The response type
|
|
52
|
+
* @example
|
|
53
|
+
* type extracted = ExtractResourceType<Resource<{ id: number }>>;
|
|
54
|
+
*/
|
|
55
|
+
type ExtractResourceType<Type> = Type extends Resource<infer R> ? R : never;
|
|
43
56
|
|
|
44
|
-
export { type BlizzardNamespaces, type Locales, type Origins, type Resource, type ResourceResponse, getEndpoint };
|
|
57
|
+
export { type BlizzardNamespaces, type ExtractResourceType, type Locales, type Origins, type Resource, type ResourceResponse, getEndpoint };
|
package/dist/index.d.ts
CHANGED
|
@@ -24,10 +24,15 @@ type BlizzardNamespaces = 'profile' | 'static' | 'dynamic' | 'static-classic' |
|
|
|
24
24
|
* @param _Response The response type of the resource
|
|
25
25
|
* @param ProtectedResource Whether the resource requires a token to be requested
|
|
26
26
|
*/
|
|
27
|
-
type Resource<
|
|
27
|
+
type Resource<Response, ProtectedResource extends boolean = false> = {
|
|
28
28
|
path: string;
|
|
29
29
|
namespace?: BlizzardNamespaces;
|
|
30
30
|
parameters?: Record<string, string | number>;
|
|
31
|
+
/**
|
|
32
|
+
* The response type of the resource
|
|
33
|
+
* @private @internal This is an internal property and should not be used as it will not be populated
|
|
34
|
+
*/
|
|
35
|
+
_responseType?: Response;
|
|
31
36
|
} & (ProtectedResource extends true ? {
|
|
32
37
|
token: string;
|
|
33
38
|
} : unknown);
|
|
@@ -40,5 +45,13 @@ type Resource<_Response, ProtectedResource extends boolean = false> = {
|
|
|
40
45
|
* response.then((data) => console.log(data.id));
|
|
41
46
|
*/
|
|
42
47
|
type ResourceResponse<T = unknown> = Promise<T>;
|
|
48
|
+
/**
|
|
49
|
+
* Extracts the response type from a resource
|
|
50
|
+
* @param Type The resource type
|
|
51
|
+
* @returns The response type
|
|
52
|
+
* @example
|
|
53
|
+
* type extracted = ExtractResourceType<Resource<{ id: number }>>;
|
|
54
|
+
*/
|
|
55
|
+
type ExtractResourceType<Type> = Type extends Resource<infer R> ? R : never;
|
|
43
56
|
|
|
44
|
-
export { type BlizzardNamespaces, type Locales, type Origins, type Resource, type ResourceResponse, getEndpoint };
|
|
57
|
+
export { type BlizzardNamespaces, type ExtractResourceType, type Locales, type Origins, type Resource, type ResourceResponse, getEndpoint };
|