Added a new function that globally fetch every endpoints

Signed-off-by: Florian BOUILLON <florian.bouillon@delta-wings.net>

tcgdex.ts

@@ -1,79 +1,164 @@
 import RequestWrapper from './Request'
-import { Serie, Set, Card, CardResume, SerieList, SetList, SupportedLanguages } from './interfaces'
+import { Serie, Set, Card, CardResume, SerieList, SetList, SupportedLanguages, StringEndpoint } from './interfaces'
+
+type Endpoint = 'cards' | 'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'series' | 'sets' | 'types'
+
+const ENDPOINTS: Array<Endpoint> = ['cards', 'categories', 'hp', 'illustrators', 'rarities', 'retreats', 'series', 'sets', 'types']
+const BASE_URL = 'https://api.tcgdex.net/v2'
 
 export default class TCGdex {
+	/**
+	 * @deprecated to change the lang use `this.lang`
+	 */
 	public static defaultLang: SupportedLanguages = "en"
 
 	public constructor(public lang?: SupportedLanguages) {}
 
 	public getLang() {
-		return this.lang || TCGdex.defaultLang
+		return this.lang ?? TCGdex.defaultLang ?? 'en'
-	}
-
-	private getBaseUrl() {
-		return `https://api.tcgdex.net/v2/${this.getLang()}`
 	}
 
+	/**
+	 * Shortcut to easily fetch a card using both it's global id and it's local ID
+	 * @param id the card global/local ID
+	 * @param set the card set name/ID (optionnal)
+	 * @returns the card object
+	 */
 	public async fetchCard(id: string | number, set?: string): Promise<Card | undefined> {
 		const path = set ? ['sets', set] : ['cards']
-		return this.rwgr<Card>(...path, id).get()
+		// @ts-expect-error the base endpoint is 'sets' or 'cards'
+		return this.fetch(...path, id)
 	}
 
+	/**
+	 * Shortcut to easily fetch cards using an optionnal set name/ID
+	 * @param set the card set name/ID (optionnal)
+	 * @returns a card list
+	 */
 	public async fetchCards(set?: string): Promise<Array<CardResume> | undefined> {
 		if (set) {
-			const setSingle = await this.fetchSet(set)
+			const fSet = await this.fetch('sets', set)
-			if (!setSingle) {
+			return fSet ? fSet.cards : undefined
-				return undefined
 		}
-			return setSingle.cards
+		return this.fetch('cards')
-		}
-		const req = this.rwgr<Array<CardResume>>('cards')
-		const resp = await req.get()
-		if (!resp) {
-			return undefined
-		}
-		return resp
 	}
 
-	public async fetchSet(set: string): Promise<Set | undefined> {
+	/**
-		const req = this.rwgr<Set>('sets', set)
+	 * @deprecated use `this.fetch('sets', set)`
-		const resp = await req.get()
+	 */
-		if (!resp) {
+	public async fetchSet(set: string) {
-			return undefined
+		return this.fetch('sets', set)
-		}
-		return resp
 	}
 
-	public async fetchSerie(expansion: string): Promise<Serie | undefined> {
+	/**
-		const req = this.rwgr<Serie>('series', expansion)
+	 * @deprecated use `this.fetch('series', serie)`
-		return req.get()
+	 */
+	public async fetchSerie(serie: string): Promise<Serie | undefined> {
+		return this.fetch('series', serie)
 	}
 
+	/**
+	 * @deprecated use `this.fetch('series')`
+	 */
 	public async fetchSeries(): Promise<SerieList | undefined> {
-		const req = this.rwgr<SerieList>('series')
+		return this.fetch('series')
-		return req.get()
 	}
 
-	public async fetchSets(expansion?: string): Promise<SetList | undefined> {
+	/**
-		if (expansion) {
+	 * Shortcut to easily fetch sets using an optionnal serie name/ID
-			const expansionSingle = await this.fetchSerie(expansion)
+	 * @param serie the card set name/ID (optionnal)
-			if (!expansionSingle) {
+	 * @returns a card list
-				return undefined
+	 */
+	public async fetchSets(serie?: string): Promise<SetList | undefined> {
+		if (serie) {
+			const fSerie = await this.fetch('series', serie)
+			return fSerie ? fSerie.sets : undefined
 		}
-			return expansionSingle.sets
+		return this.fetch('sets')
-		}
-		const req = this.rwgr<SetList>('sets')
-		const list = await req.get()
-		if (!list) {
-			return undefined
-		}
-		return list
 	}
 
-	private rwgr<T = any>(...url: Array<string | number>) {
+	/**
-		return RequestWrapper.getRequest<T>(`${this.getBaseUrl()}/${url.map((v) => encodeURI(
+	 * Fetch a card using its global id
-			// Normalize URL
+	 * @param endpoint_0 'cards'
-			v.toString().replace('?', '%3F').normalize('NFC').replace(/["'\u0300-\u036f]/g, "")
+	 * @param endpoint_1 {string} the card global ID
-			)).join('/')}`)
+	 */
+	public async fetch(...type: ['cards', string]): Promise<Card | undefined>
+	/**
+	 * Fetch every cards in the database
+	 * @param endpoint_0 'cards'
+	 */
+	public async fetch(type: 'cards'): Promise<Array<CardResume> | undefined>
+	/**
+	 * Fetch a card using its local id and its set
+	 * @param endpoint_0 'sets'
+	 * @param endpoint_1 {string} the set name or ID
+	 * @param endpoint_2 {string} the card local ID
+	 */
+	public async fetch(...endpoint: ['sets', string, string]): Promise<Card | undefined>
+	/**
+	 * Fetch a set
+	 * @param endpoint_0 'sets'
+	 * @param endpoint_1 {string} the set name or ID
+	 */
+	public async fetch(...endpoint: ['sets', string]): Promise<Set | undefined>
+	/**
+	 * Fetch every sets
+	 * @param endpoint_0 'sets'
+	 */
+	public async fetch(endpoint: 'sets'): Promise<SetList | undefined>
+	/**
+	 * Fetch a serie
+	 * @param endpoint_0 'series'
+	 * @param endpoint_1 {string} the serie name or ID
+	 */
+	public async fetch(...endpoint: ['series', string]): Promise<Serie | undefined>
+	/**
+	 * Fetch every series
+	 * @param endpoint_0 'series'
+	 */
+	public async fetch(endpoint: 'series'): Promise<SerieList | undefined>
+	/**
+	 * Fetch cards depending on a specific filter
+	 * @param endpoint_0 {'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types'}
+	 * Possible value 'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types'
+	 * @param endpoint_1 {string} the value set while fetching the index
+	 */
+	public async fetch(...endpoint: ['categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types', string]): Promise<StringEndpoint | undefined>
+	/**
+	 * Fetch cards depending on a specific filter
+	 * @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
+	 * Possible value 'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'
+	 * @param endpoint_1 {string} Fetch the possible values to use depending on the endpoint
+	 */
+	public async fetch(endpoint: 'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'): Promise<Array<string> | undefined>
+	public async fetch(...endpoint: Array<Endpoint | string>): Promise<any | undefined> {
+		if (endpoint.length === 0) {
+			throw new Error(`endpoint to fetch is empty!`)
+		}
+		// @ts-expect-error with the precedent check, we KNOW that type is not empty
+		const baseEndpoint = endpoint.shift().toLowerCase() as Endpoint
+		if (!ENDPOINTS.includes(baseEndpoint)) {
+			throw new Error(`unknown endpoint to fetch! (${baseEndpoint})`)
+		}
+		return this.makeRequest(baseEndpoint, ...endpoint)
+	}
+
+	/**
+	 * Function to make the request and normalize the whole path
+	 */
+	private makeRequest<T = any>(...url: Array<string | number>) {
+		// Normalize path
+		const path = url.map((v) => encodeURI(
+			v
+				// Transform numbers to string
+				.toString()
+				// replace this special character with an escaped one
+				.replace('?', '%3F')
+				// normalize the string
+				.normalize('NFC')
+				// remove some special chars by nothing
+				.replace(/["'\u0300-\u036f]/g, "")
+		)).join('/')
+		return RequestWrapper.getRequest<T>(`${BASE_URL}/${this.getLang()}/${path}`).get()
 	}
 }