[Core] Cleanup types, remove unused types and enable marking a Resour…

…ce as protected

.changeset/eight-clocks-shop.md

@@ -0,0 +1,5 @@
+---
+'@blizzard-api/core': patch
+---
+
+Cleanup types, remove unused types and enable marking a Resource as protected

packages/core/src/endpoint.ts

@@ -35,7 +35,7 @@ interface Endpoints {
   tw: Endpoint<'tw'>;
 }
 
-export const endpoints: Endpoints = {
+const endpoints: Endpoints = {
   us: {
     hostname: 'https://us.api.blizzard.com',
     defaultLocale: 'en_US',
@@ -58,7 +58,7 @@ export const endpoints: Endpoints = {
   },
 };
 
-export interface GetEndpoint<T extends Origins> {
+interface GetEndpoint<T extends Origins> {
   origin: Origins;
   locale: (typeof locales)[T][number];
   hostname: Endpoint<Origins>['hostname'];

packages/core/src/index.ts

@@ -5,8 +5,5 @@ export { getEndpoint } from './endpoint.js';
 //Namespace
 export type { BlizzardNamespaces } from './namespace.js';
 
-//Request
-export type { ClientOptions } from './request.js';
-
 //Resource
-export type { Resource, ResourceResponse, ResourceOptions, ProtectedResourceOptions } from './resource.js';
+export type { Resource, ResourceResponse } from './resource.js';

packages/core/src/resource.ts

@@ -1,12 +1,30 @@
 import type { BlizzardNamespaces } from './namespace';
-import type { ClientOptions } from './request';
 
-export interface Resource<_Response = void> {
+/**
+ * Represents a resource that can be requested from the Blizzard API
+ * @param _Response The response type of the resource
+ * @param ProtectedResource Whether the resource requires a token to be requested
+ */
+export type Resource<_Response, ProtectedResource extends boolean = false> = {
   path: string;
   namespace?: BlizzardNamespaces;
-}
-export type ResourceResponse<T = unknown> = Promise<T>;
+} & (ProtectedResource extends true ? { token: string } : unknown);
 
-export type ResourceOptions<T = unknown> = Partial<ClientOptions> & T;
+/**
+ * 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));
+ */
+export type ResourceResponse<T = unknown> = Promise<T>;
 
-export type ProtectedResourceOptions<T = unknown> = Partial<ClientOptions> & { token: string } & T;
+/**
+ * Extracts the response type from a resource
+ * @param Type The resource type
+ * @returns The response type
+ * @example
+ * type extracted = ExtractResourceType<Resource<{ id: number }>>;
+ */
+export type ExtractResourceType<Type> = Type extends Resource<infer R> ? R : never;