2.4.2

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

.editorconfig

@@ -5,4 +5,8 @@ indent_style = tab
 indent_size = 4
 charset = utf-8
 trim_trailing_whitespace = true
-insert_final_newline = true
+insert_final_newline = true
+
+[*.yml]
+indent_size = 2
+indent_style = space

.eslintrc.js

@@ -1,322 +1,5 @@
-/**
- * ESLint custom configuration v1.0.0
- * packages needed:
- * eslint
- * for Typescript
- * @typescript-eslint/parser
- * @typescript-eslint/eslint-plugin
- */
-
- module.exports = {
-	env: {
-		browser: true,
-		es6: true,
-		node: true
-	},
+module.exports = {
 	extends: [
-		"eslint:all",
-		"plugin:@typescript-eslint/recommended",
-	],
-	globals: {
-		Atomics: "readonly",
-		SharedArrayBuffer: "readonly"
-	},
-	parser: "@typescript-eslint/parser",
-	parserOptions: {
-		project: "tsconfig.json"
-	},
-	plugins: [
-		"@typescript-eslint"
-	],
-	root: true,
-	rules: {
-		// Tab indent and force switch to have one too
-		indent: [
-			"error",
-			"tab",
-			{SwitchCase: 1}
-		],
-
-		// \n linebreak
-		"linebreak-style": [
-			"error",
-			"unix"
-		],
-
-		// Disable eslint default quote because Typescript replace it
-		quotes: "off",
-		"@typescript-eslint/quotes": [
-			"error",
-			"single",
-			{ avoidEscape: true }
-		],
-
-		// Simply diallow using ';' unless mandatory
-		semi: "off",
-		"@typescript-eslint/semi": [
-			"error",
-			"never",
-			{ "beforeStatementContinuationChars": "always"}
-		],
-
-		// Disallow things that do nothing in the end
-		"no-unused-expressions": "off",
-		"@typescript-eslint/no-unused-expressions": [
-			"error",
-			{ "enforceForJSX": true,}
-		],
-
-		// force overloads to be next to one another
-		"@typescript-eslint/adjacent-overload-signatures": "error",
-
-		// Force to use `Array<thing>
-		"@typescript-eslint/array-type": [
-			"error",
-			{ default: 'generic' }
-		],
-
-		// Warn when no return type is specified
-		"@typescript-eslint/explicit-module-boundary-types": "warn",
-
-		// disallow certain types not safe
-		"@typescript-eslint/ban-types": [
-			"error",
-			{
-				"types": {
-					"{}": false
-				}
-			}
-		],
-		"@typescript-eslint/consistent-type-assertions": "error",
-		"@typescript-eslint/consistent-type-definitions": "error",
-		"@typescript-eslint/explicit-member-accessibility": [
-			"error",
-			{
-				accessibility: "explicit"
-			}
-		],
-		"@typescript-eslint/interface-name-prefix": "off",
-		"@typescript-eslint/member-delimiter-style": [
-			"error",
-			{
-				multiline: {
-					delimiter: "none",
-					requireLast: true
-				},
-				singleline: {
-					delimiter: "comma",
-					requireLast: false
-				}
-			}
-		],
-		"@typescript-eslint/member-ordering": "error",
-		"@typescript-eslint/no-empty-function": "error",
-		"@typescript-eslint/no-empty-interface": "error",
-		"@typescript-eslint/no-explicit-any": "off",
-		"@typescript-eslint/no-misused-new": "error",
-		"@typescript-eslint/no-namespace": "error",
-		"@typescript-eslint/no-parameter-properties": "off",
-		"@typescript-eslint/no-use-before-define": "off",
-		"@typescript-eslint/prefer-for-of": "error",
-		"@typescript-eslint/prefer-function-type": "error",
-		"@typescript-eslint/prefer-namespace-keyword": "error",
-
-		"@typescript-eslint/triple-slash-reference": "error",
-		"@typescript-eslint/type-annotation-spacing": "error",
-		"@typescript-eslint/unified-signatures": "error",
-		"arrow-body-style": "error",
-		"arrow-parens": [
-			"error",
-			"always"
-		],
-
-		camelcase: "error",
-		complexity: "off",
-		"constructor-super": "error",
-		curly: "error",
-		"dot-notation": "error",
-		"eol-last": "error",
-		eqeqeq: [
-			"error",
-			"smart"
-		],
-		"guard-for-in": "warn",
-		"id-blacklist": [
-			"error",
-			"any",
-			"Number",
-			"number",
-			"String",
-			"string",
-			"Boolean",
-			"boolean",
-			"Undefined"
-		],
-		"id-match": "error",
-		"max-classes-per-file": [
-			"error",
-			1
-		],
-		"max-len": [
-			"warn",
-			{
-				code: 200
-			}
-		],
-		"@typescript-eslint/no-inferrable-types": "off",
-		"new-parens": "error",
-		"no-bitwise": "error",
-		"no-caller": "error",
-		"no-cond-assign": "error",
-		"no-debugger": "error",
-		"no-empty": "error",
-		"no-eval": "error",
-		"no-fallthrough": "off",
-		"no-invalid-this": "off",
-		"no-multiple-empty-lines": "error",
-		"no-new-wrappers": "error",
-		"no-shadow": [
-			"error",
-			{
-				hoist: "all"
-			}
-		],
-		"no-throw-literal": "error",
-		"no-trailing-spaces": "error",
-		"no-undef-init": "error",
-		"no-underscore-dangle": "error",
-		"no-unsafe-finally": "error",
-		"no-unused-labels": "error",
-		"no-unused-vars": "off",
-		"no-var": "error",
-		"object-shorthand": "error",
-		"one-var": [
-			"error",
-			"never"
-		],
-		"prefer-const": "error",
-		"quote-props": [
-			"error",
-			"consistent-as-needed"
-		],
-		"radix": "error",
-
-		"space-before-function-paren": "off",
-		"@typescript-eslint/space-before-function-paren": ["error", {
-			asyncArrow: "always",
-			anonymous: "never",
-			named: "never"
-		}],
-		"spaced-comment": "error",
-		"use-isnan": "error",
-		"valid-typeof": "off",
-
-		// some tests from eslint:all
-		"no-tabs": "off",
-		"padded-blocks": [
-			"error",
-			{
-				"blocks": "never",
-				"classes": "always",
-				"switches": "never"
-			}
-		],
-		"sort-imports": "off",
-		"no-console": "off",
-		"function-call-argument-newline": [
-			"error",
-			"consistent"
-		],
-		"dot-location": [
-			"error",
-			"property"
-		],
-		"object-curly-spacing": [
-			"error",
-			"always"
-		],
-		"array-element-newline": [
-			"error",
-			"consistent"
-		],
-		"function-paren-newline": [
-			"error",
-			"consistent"
-		],
-		"no-use-before-define": "off",
-		"@typescript-eslint/no-use-before-define": "error",
-		"capitalized-comments": "off",
-		"multiline-comment-style": "off",
-		"no-extra-parens": "off",
-		"@typescript-eslint/no-extra-parens": [
-			"error",
-			"all",
-			{ "ignoreJSX": "multi-line" }
-		],
-		"func-style": [
-			"error",
-			"declaration",
-			{ "allowArrowFunctions": true }
-		],
-		"no-ternary": "off",
-		"multiline-ternary": "off",
-		"no-magic-numbers": "off",
-		"max-lines-per-function": [
-			"warn",
-			{
-				"skipBlankLines": true,
-				"skipComments": true
-			}
-		],
-		"prefer-promise-reject-errors": "warn",
-		"object-property-newline": [
-			"error",
-			{ "allowAllPropertiesOnSameLine": true }
-		],
-		"no-await-in-loop": "warn",
-		"no-undefined": "off",
-		"id-length": "warn",
-		"class-methods-use-this": "off",
-		"array-bracket-newline": [
-			"error",
-			"consistent"
-		],
-		"no-confusing-arrow": "off",
-		"no-nested-ternary": "off",
-		"no-mixed-operators": "off",
-		"max-statements": [
-			"warn",
-			15
-		],
-		"semi-style": [
-			"error",
-			"first"
-		],
-		"no-useless-constructor": "off",
-		"@typescript-eslint/no-useless-constructor": "error",
-		"lines-between-class-members": "off",
-		"@typescript-eslint/lines-between-class-members": "error",
-		"max-lines": [
-			"warn",
-			{
-				"max": 500,
-				"skipBlankLines": true,
-				"skipComments": true
-			}
-		],
-		"no-plusplus": "off",
-		"id-length": [
-			"warn",
-			{ "exceptions": ["_"] }
-		],
-		"default-param-last": "off",
-		// "@typescript-eslint/default-param-last": "error",
-		// Temporary OFF
-		"@typescript-eslint/default-param-last": "off",
-		"no-continue": "off",
-		"require-atomic-updates": "off",
-		"require-await": "off",
-		"prefer-destructuring": "off",
-		"max-params": ["warn", 5]
-	}
-};
+		"./node_modules/@dzeio/config/eslint/typescript"
+	]
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/build.yml

@@ -1,6 +1,3 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Build & Test
 
 on:
@@ -18,30 +15,30 @@ jobs:
 
     strategy:
       matrix:
+        # Follow current releases https://nodejs.org/en/about/releases/
         node-version: [12.x, 14.x, 16.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v2
+
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: yarn
-    - run: yarn build
-  test:
-    runs-on: ubuntu-latest
 
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js 12.x
-      uses: actions/setup-node@v1
-      with:
-        node-version: 12.x
-    - run: yarn && yarn build
-    - run: yarn test
-    # You may pin to the exact commit or the version.
-    # uses: codecov/codecov-action@6004246f47ab62d32be025ce173b241cd84ac58e
-    - uses: codecov/codecov-action@v1.0.13
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build
+      run: npm run build
+
+    - name: Test
+      run: npm run test
+
+    - name: Upload Coverage
+      if: matrix.node-version == '16.x'
+      uses: codecov/codecov-action@v1.0.13
       with:
         # Comma-separated list of files to upload
         files: ./coverage/coverage-final.json

.github/workflows/code-quality.yml

@@ -1,6 +1,3 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Code Quality Checks
 
 on:
@@ -14,14 +11,16 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-      with:
-        persist-credentials: false
+    - name: Checkout
+      uses: actions/checkout@v2
 
     - name: Setup NodeJS
       uses: actions/setup-node@v2
       with:
         node-version: '16.x'
 
+    - name: Install dependencies
+      run: npm ci
+
     - name: Lint
-      run: yarn && yarn lint
+      run: npm run lint

.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: publish
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 2.4.1 - 2021-07-11
+
+## Deprecated
+
+- Deprecated `Languages` Type
+
+## 2.4.0 - 2021-06-29
+
+## Added
+
+- Support for new languages
+
 ## 2.3.1 - 2021-06-22
 
 ### Fixed
@@ -201,6 +213,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.3.1...HEAD
 
+[2.4.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.4.0
 [2.3.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.3.1
 [2.3.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.3.0
 [2.2.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.2.0

README.md

@@ -8,13 +8,15 @@
 	<a href="https://app.codecov.io/gh/tcgdex/javascript-sdk/">
 		<img src="https://img.shields.io/codecov/c/github/tcgdex/javascript-sdk?style=flat-square&token=FR4BI94N4Q" alt="npm version">
 	</a>
-	<a href="https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md">
+		<a href="https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md">
 		<img src="https://img.shields.io/github/license/tcgdex/javascript-sdk?style=flat-square" alt="the TCGdex JAvascript SDK is released under the MIT license." />
 	</a>
 	<a href="https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md">
 		<img src="https://img.shields.io/github/workflow/status/tcgdex/javascript-sdk/Build%20&%20Test?style=flat-square" alt="the TCGdex JAvascript SDK is released under the MIT license." />
 	</a>
-
+	<a href="https://discord.gg/NehYTAhsZE">
+		<img src="https://img.shields.io/discord/857231041261076491?color=%235865F2&label=Discord&style=flat-square" alt="Discord Link">
+	</a>
 </p>
 
 # TCGdex JavaScript/TypeScript SDK

package.json

@@ -1,8 +1,9 @@
 {
 	"name": "@tcgdex/sdk",
-	"version": "2.3.1",
+	"version": "2.4.2",
 	"main": "./dist/cjs/tcgdex.node.js",
 	"types": "./dist/types/tcgdex.d.ts",
+	"description": "Communicate with the Open Source TCGdex API in Javascript/Typescript using the SDK",
 	"repository": "https://github.com/tcgdex/javascript-sdk.git",
 	"homepage": "https://github.com/tcgdex/javascript-sdk",
 	"author": "Aviortheking",
@@ -23,6 +24,7 @@
 		"@babel/core": "^7.14.6",
 		"@babel/preset-env": "^7.14.7",
 		"@babel/preset-typescript": "^7.14.5",
+		"@dzeio/config": "^1.0.0",
 		"@types/node-fetch": "^2.5.10",
 		"@typescript-eslint/eslint-plugin": "^4.28.0",
 		"@typescript-eslint/parser": "^4.28.0",
@@ -43,11 +45,11 @@
 	},
 	"scripts": {
 		"prebuild": "node scripts/export-version-number.js",
-		"build": "yarn prebuild && yarn build:cjs && yarn build:browser && yarn build:es2015",
+		"build": "npm run prebuild && npm run build:cjs && npm run build:browser && npm run build:es2015",
 		"build:cjs": "tsc --project tsconfig.json",
 		"build:es2015": "tsc --project tsconfig.es2015.json",
 		"build:browser": "wp --config webpack.config.js",
-		"prepublishOnly": "yarn build",
+		"prepublishOnly": "npm run build",
 		"lint": "eslint",
 		"test": "jest --coverage"
 	},

src/Request.ts

@@ -1,31 +1,31 @@
-import TCGdex from './tcgdex'
-import { version } from './version.json'
-
-export default class Request {
-
-	// 1 hour of TTL by default
-	public static ttl = 1000 * 60 * 60
-
-	private static cache: Record<string, {response: any, time: number}> = {}
-
-	public static async fetch<T>(url: string): Promise<T | undefined> {
-		let request = this.cache[url]
-		const now = new Date().getTime()
-		if (!request || now - request.time > this.ttl) {
-			const unfetch = TCGdex.fetch
-			const resp = await unfetch(url, {
-				headers: {
-					'user-agent': `@tcgdex/javascript-sdk/${version}`
-				}
-			})
-			if (resp.status !== 200) {
-				return undefined
-			}
-
-			this.cache[url] = { response: await resp.json(), time: now }
-			request = this.cache[url]
-		}
-		return request.response
-	}
-
-}
+import TCGdex from './tcgdex'
+import { version } from './version.json'
+
+export default class Request {
+
+	// 1 hour of TTL by default
+	public static ttl = 1000 * 60 * 60
+
+	private static cache: Record<string, {response: any, time: number}> = {}
+
+	public static async fetch<T>(url: string): Promise<T | undefined> {
+		let request = this.cache[url]
+		const now = new Date().getTime()
+		if (!request || now - request.time > this.ttl) {
+			const unfetch = TCGdex.fetch
+			const resp = await unfetch(url, {
+				headers: {
+					'user-agent': `@tcgdex/javascript-sdk/${version}`
+				}
+			})
+			if (resp.status !== 200) {
+				return undefined
+			}
+
+			this.cache[url] = { response: await resp.json(), time: now }
+			request = this.cache[url]
+		}
+		return request.response
+	}
+
+}

src/interfaces.ts

@@ -1,5 +1,8 @@
-export type SupportedLanguages = 'en' | 'fr'
+export type SupportedLanguages = 'en' | 'fr' | 'es' | 'it' | 'pt' | 'de'
 
+/**
+ * @deprecated This is not used anymore in the API V2
+ */
 export type Languages<T = string> = Partial<Record<SupportedLanguages, T>>
 
 export interface SerieResume {

src/tcgdex.ts

@@ -1,185 +1,185 @@
-import RequestWrapper from './Request'
-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 {
-
-	public static fetch: typeof fetch
-
-	/**
-	 * @deprecated to change the lang use `this.lang`
-	 */
-	public static defaultLang: SupportedLanguages = 'en'
-
-	public constructor(public lang?: SupportedLanguages) {}
-
-	public getLang(): SupportedLanguages {
-		return this.lang ?? TCGdex.defaultLang ?? 'en'
-	}
-
-	/**
-	 * 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']
-		// @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 fSet = await this.fetch('sets', set)
-			return fSet ? fSet.cards : undefined
-		}
-		return this.fetch('cards')
-	}
-
-	/**
-	 * @deprecated use `this.fetch('sets', set)`
-	 */
-	public async fetchSet(set: string): Promise<Set | undefined> {
-		return this.fetch('sets', set)
-	}
-
-	/**
-	 * @deprecated use `this.fetch('series', serie)`
-	 */
-	public async fetchSerie(serie: string): Promise<Serie | undefined> {
-		return this.fetch('series', serie)
-	}
-
-	/**
-	 * @deprecated use `this.fetch('series')`
-	 */
-	public async fetchSeries(): Promise<SerieList | undefined> {
-		return this.fetch('series')
-	}
-
-	/**
-	 * Shortcut to easily fetch sets using an optionnal serie name/ID
-	 * @param serie the card set name/ID (optionnal)
-	 * @returns a card list
-	 */
-	public async fetchSets(serie?: string): Promise<SetList | undefined> {
-		if (serie) {
-			const fSerie = await this.fetch('series', serie)
-			return fSerie ? fSerie.sets : undefined
-		}
-		return this.fetch('sets')
-	}
-
-	/**
-	 * Fetch a card using its global id
-	 * @param endpoint_0 'cards'
-	 * @param endpoint_1 {string} the card global ID
-	 */
-	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>
-
-	/**
-	 * Fetch The differents endpoints depending on the first argument
-	 * @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
-	 * Possible value 'cards' | 'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'series' | 'sets' | 'types'
-	 * @param endpoint_1 {string} (Optionnal) some details to go from the index file to the item file (mostly the ID/name)
-	 * @param endpoint_2 {string} (Optionnal) only for sets the card local ID to fetch the card through the set
-	 */
-	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((subPath) => encodeURI(
-			subPath
-				// 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
-				// eslint-disable-next-line no-misleading-character-class
-				.replace(/["'\u0300-\u036f]/gu, '')
-		)).join('/')
-		return RequestWrapper.fetch<T>(`${BASE_URL}/${this.getLang()}/${path}`)
-	}
-
-}
-
-export * from './interfaces'
+import RequestWrapper from './Request'
+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 {
+
+	public static fetch: typeof fetch
+
+	/**
+	 * @deprecated to change the lang use `this.lang`
+	 */
+	public static defaultLang: SupportedLanguages = 'en'
+
+	public constructor(public lang?: SupportedLanguages) {}
+
+	public getLang(): SupportedLanguages {
+		return this.lang ?? TCGdex.defaultLang ?? 'en'
+	}
+
+	/**
+	 * 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']
+		// @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 fSet = await this.fetch('sets', set)
+			return fSet ? fSet.cards : undefined
+		}
+		return this.fetch('cards')
+	}
+
+	/**
+	 * @deprecated use `this.fetch('sets', set)`
+	 */
+	public async fetchSet(set: string): Promise<Set | undefined> {
+		return this.fetch('sets', set)
+	}
+
+	/**
+	 * @deprecated use `this.fetch('series', serie)`
+	 */
+	public async fetchSerie(serie: string): Promise<Serie | undefined> {
+		return this.fetch('series', serie)
+	}
+
+	/**
+	 * @deprecated use `this.fetch('series')`
+	 */
+	public async fetchSeries(): Promise<SerieList | undefined> {
+		return this.fetch('series')
+	}
+
+	/**
+	 * Shortcut to easily fetch sets using an optionnal serie name/ID
+	 * @param serie the card set name/ID (optionnal)
+	 * @returns a card list
+	 */
+	public async fetchSets(serie?: string): Promise<SetList | undefined> {
+		if (serie) {
+			const fSerie = await this.fetch('series', serie)
+			return fSerie ? fSerie.sets : undefined
+		}
+		return this.fetch('sets')
+	}
+
+	/**
+	 * Fetch a card using its global id
+	 * @param endpoint_0 'cards'
+	 * @param endpoint_1 {string} the card global ID
+	 */
+	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>
+
+	/**
+	 * Fetch The differents endpoints depending on the first argument
+	 * @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
+	 * Possible value 'cards' | 'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'series' | 'sets' | 'types'
+	 * @param endpoint_1 {string} (Optionnal) some details to go from the index file to the item file (mostly the ID/name)
+	 * @param endpoint_2 {string} (Optionnal) only for sets the card local ID to fetch the card through the set
+	 */
+	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((subPath) => encodeURI(
+			subPath
+				// 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
+				// eslint-disable-next-line no-misleading-character-class
+				.replace(/["'\u0300-\u036f]/gu, '')
+		)).join('/')
+		return RequestWrapper.fetch<T>(`${BASE_URL}/${this.getLang()}/${path}`)
+	}
+
+}
+
+export * from './interfaces'

tsconfig.es2015.json

@@ -7,5 +7,5 @@
 		"declaration": false,                      /* Generates corresponding '.d.ts' file. */
 		"declarationDir": null,
 		"outDir": "./dist/modules",                   /* Redirect output structure to the directory. */
-		}
+	}
 }

tsconfig.json

@@ -1,66 +1,15 @@
 {
+	"extends": "./node_modules/@dzeio/config/tsconfig.base",
 	"include": ["./src/tcgdex.node.ts"],
 	"compilerOptions": {
-		/* Basic Options */
-		// "incremental": true,                   /* Enable incremental compilation */
-		"target": "ES2020",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-		"module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-		// "lib": [],                             /* Specify library files to be included in the compilation. */
-		// "allowJs": true,                       /* Allow javascript files to be compiled. */
-		// "checkJs": true,                       /* Report errors in .js files. */
-		// "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-		"declaration": true,                      /* Generates corresponding '.d.ts' file. */
-		"declarationDir": "./dist/types",         /* Folder where the declarations are*/
-		// "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-		// "sourceMap": true,                     /* Generates corresponding '.map' file. */
-		// "outFile": "./",                       /* Concatenate and emit output to single file. */
-		"outDir": "./dist/cjs",                   /* Redirect output structure to the directory. */
-		"rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-		// "composite": true,                     /* Enable project compilation */
-		// "tsBuildInfoFile": "",                 /* Specify file to store incremental compilation information */
-		// "removeComments": true,                /* Do not emit comments to output. */
-		// "noEmit": true,                        /* Do not emit outputs. */
-		// "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-		// "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-		// "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-		/* Strict Type-Checking Options */
-		"strict": true,                           /* Enable all strict type-checking options. */
-		"noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-		"strictNullChecks": true,                 /* Enable strict null checks. */
-		"strictFunctionTypes": true,              /* Enable strict checking of function types. */
-		"strictBindCallApply": true,              /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-		"strictPropertyInitialization": true,     /* Enable strict checking of property initialization in classes. */
-		"noImplicitThis": true,                   /* Raise error on 'this' expressions with an implied 'any' type. */
-		"alwaysStrict": true,                     /* Parse in strict mode and emit "use strict" for each source file. */
 
-		/* Additional Checks */
-		"noUnusedLocals": true,                   /* Report errors on unused locals. */
-		"noUnusedParameters": true,               /* Report errors on unused parameters. */
-		"noImplicitReturns": true,                /* Report error when not all code paths in function return a value. */
-		"noFallthroughCasesInSwitch": true,       /* Report errors for fallthrough cases in switch statement. */
-		"forceConsistentCasingInFileNames": true,
+		"target": "ES2015",
 
-		"resolveJsonModule": true,
-		/* Module Resolution Options */
-		"moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-		// "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-		// "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-		// "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-		// "typeRoots": [],                       /* List of folders to include type definitions from. */
-		// "types": [],                           /* Type declaration files to be included in compilation. */
-		// "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-		"esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-		// "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-		// "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+		"declaration": true,
+		"declarationDir": "./dist/types",
 
-		/* Source Map Options */
-		// "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-		// "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-		// "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-		// "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+		"outDir": "./dist/cjs",
+		"rootDir": "./src",
 
-		/* Experimental Options */
-		"experimentalDecorators": true,           /* Enables experimental support for ES7 decorators. */
-		"emitDecoratorMetadata": true             /* Enables experimental support for emitting type metadata for decorators. */
 	}
 }