2.4.0

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

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+src/tcgdex.browser.ts
+__tests__
+*.js

.eslintrc.js

@@ -0,0 +1,322 @@
+/**
+ * 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
+	},
+	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]
+	}
+};

.github/workflows/build.yml

@@ -0,0 +1,47 @@
+# 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:
+  push:
+    branches:
+      - master
+  # Run on any pull request
+  pull_request:
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+    - 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
+      with:
+        # Comma-separated list of files to upload
+        files: ./coverage/coverage-final.json

.github/workflows/code-quality.yml

@@ -0,0 +1,27 @@
+# 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:
+  push:
+    branches:
+      - master
+  # Run on any pull request
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        persist-credentials: false
+
+    - name: Setup NodeJS
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16.x'
+
+    - name: Lint
+      run: yarn && yarn lint

.gitignore

@@ -1,6 +1,8 @@
-# Dev Files
-node_modules
-test.ts
-
-# Dist files
-dist
+# Dev Files
+node_modules
+test.ts
+coverage
+
+# Dist files
+dist
+src/version.json

.npmignore

@@ -6,3 +6,4 @@ webpack.config.js
 tsconfig.*
 yarn.lock
 CHANGELOG.md
+coverage

CHANGELOG.md

@@ -1,208 +1,224 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.2.0] - 2021-06-19
-
-### Added
-
-- Added new fields
-
-## [2.1.1] - 2021-05-31
-
-### Fixed
-
-- Package building in the wrong version of ECMAScript
-
-## [2.1.0] - 2021-05-31
-
-### Added
-
-- new `fetch` function that manage all the API endpoints
-
-## [2.0.2-2.0.3] - 2021-05-28
-
-### Fixed
-
-- `rotationMark` should have been named `regulationMark`
-
-## [2.0.1] - 2021-05-28
-
-### Changed
-
-- Hardcoded string values are now strings as they depends on the language
-
-## [2.0.0] - 2021-05-28
-
-### Added
-
-- simple string endpoint typing
-- Typing is exported through the main.d.ts file
-- `cardCount` field in the set interface
-- a `rotationMark` to the card interface
-
-### Changed
-
-- Support new incoming datas
-- Point the SDK to the new V2
-- Renamed `getExpansion(s)` to `getSerie(s)`
-- Typing for the new SDK
-- Functions now use `fetch` instead of `get` in their names
-- URL Normalization is now done by the SDK
-
-### Fixed
-
-- `getSerie(s)` now point to the correct endpoint
-
-### Removed
-
-- TranslationUtil as now translation are managed by the API
-- the interfaces folder as every interfaces are now in `interfaces.d.ts`
-- `this.gbu`
-- Translation files as they are now in the Compiler
-
-## [1.7.0] - 2021-01-31
-
-### Added
-
-- new Rarities
-
-## [1.6.1] - 2021-01-31
-
-### Changed
-
-- tags are now optionnal
-
-## [1.6.0] - 2021-01-08
-
-### Changed
-
-- Errors are now handled to return `undefined`
-
-### Removed
-
-- console.warn when using `getCards`
-
-## [1.5.0] - 2021-01-08
-
-### Added
-
-- getSet can now not transform the API Date to a Javascript Date
-
-## [1.4.2] - 2021-01-08
-
-### Added
-
-- new Tags
-
-### Changed
-
-- rarities to have less strange rarities
--
-
-### Fixed
-
-- CORS blocked
-
-
-## [1.4.1] - 2020-04-24
-
-### Changed
-
-- Changed API url to the new one
-
-## [1.4.0] - 2020-03-25
-
-### Added
-
-- a `defaultLang` static field to customize the default lang
-- a `getLang` function to get the current lang for the SDK
-
-### Fixed
-
-- Warnings for translations
-
-## [1.3.0] - 2020-03-18
-
-### Added
-
-- A cache system
-- some informations about differents tags on a card
-- lvl on the card interface
-
-### Removed
-
-- cardTypes on the card interface
-
-## [1.2.1] - 2020-03-14
-
-### Fixed
-
-- Fix items datas not in the correct interface
-
-## [1.2.0] - 2020-03-14
-
-### Added
-
-- Added The getCards endpoint to fetch the big list of card with an optionnal  filter on the set
-- Added The getExpansions endpoint to fetch the list of expansions
-- Added Some informations about cardTypes
-- Updated DB to add support for items
-
-### Fixed
-
-- Fix translation not getting the correct file
-
-
-## [1.0.8] - 2020-03-11
-
-### Changed
-
-- Changed typing for some interfaces
-
-## [1.0.1-1.0.7] - 2020-03-11
-
-### Changed
-
-- Renamed the class Name from `TCGDex` to `TCGdex`
-- lang argument is now public so it can be changed while the SDK is active
-
-### Added
-
-- some typing for getCard and translationUtil
-
-## [1.0.0] - 2020-03-11
-
-### Added
-
-- the getCard function to use with the fetch a card with it's id
-- the getSet function to use with the fetch a set with it's id
-- the getExpansion function to use with the fetch an expansion with it's id
-- Constructor arg support for multiple langs
-- TranslationUtil to go from the SDK value to a text value
-
-[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.1.1...HEAD
-
-[2.1.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.1
-[2.1.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.0
-[2.0.2-2.0.3]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.3
-[2.0.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.1
-[2.0.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.0
-[1.7.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.7.0
-[1.6.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.6.1
-[1.6.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.6.0
-[1.5.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.5.0
-[1.4.2]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.2
-[1.4.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.1
-[1.4.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.0
-[1.3.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.3.0
-[1.2.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.2.1
-[1.2.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.2.0
-[1.0.8]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.0.8
-[1.0.1-1.0.7]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.0.7
-[1.0.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.0.0
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 2.3.1 - 2021-06-22
+
+### Fixed
+
+- Cleaned dist folder
+
+## 2.3.0-2.3.1 - 2021-06-22
+
+### Added
+
+- Browser specialized build
+- [#9](https://github.com/tcgdex/javascript-sdk/pull/9) Build/Unit/ESLint tests and coverage with Codecov using Github Action
+
+### Changed
+
+- [#10](https://github.com/tcgdex/javascript-sdk/pull/10) Simplified Request/Cache manager
+
+## [2.2.0] - 2021-06-19
+
+### Added
+
+- Added new fields
+
+## [2.1.1] - 2021-05-31
+
+### Fixed
+
+- Package building in the wrong version of ECMAScript
+
+## [2.1.0] - 2021-05-31
+
+### Added
+
+- new `fetch` function that manage all the API endpoints
+
+## [2.0.2-2.0.3] - 2021-05-28
+
+### Fixed
+
+- `rotationMark` should have been named `regulationMark`
+
+## [2.0.1] - 2021-05-28
+
+### Changed
+
+- Hardcoded string values are now strings as they depends on the language
+
+## [2.0.0] - 2021-05-28
+
+### Added
+
+- simple string endpoint typing
+- Typing is exported through the main.d.ts file
+- `cardCount` field in the set interface
+- a `rotationMark` to the card interface
+
+### Changed
+
+- Support new incoming datas
+- Point the SDK to the new V2
+- Renamed `getExpansion(s)` to `getSerie(s)`
+- Typing for the new SDK
+- Functions now use `fetch` instead of `get` in their names
+- URL Normalization is now done by the SDK
+
+### Removed
+
+- TranslationUtil as now translation are managed by the API
+- the interfaces folder as every interfaces are now in `interfaces.d.ts`
+- `this.gbu`
+- Translation files as they are now in the Compiler
+
+## [1.7.0] - 2021-01-31
+
+### Added
+
+- new Rarities
+
+## [1.6.1] - 2021-01-31
+
+### Changed
+
+- tags are now optionnal
+
+## [1.6.0] - 2021-01-08
+
+### Changed
+
+- Errors are now handled to return `undefined`
+
+### Removed
+
+- console.warn when using `getCards`
+
+## [1.5.0] - 2021-01-08
+
+### Added
+
+- getSet can now not transform the API Date to a Javascript Date
+
+## [1.4.2] - 2021-01-08
+
+### Added
+
+- new Tags
+
+### Changed
+
+- rarities to have less strange rarities
+-
+
+### Fixed
+
+- CORS blocked
+
+
+## [1.4.1] - 2020-04-24
+
+### Changed
+
+- Changed API url to the new one
+
+## [1.4.0] - 2020-03-25
+
+### Added
+
+- a `defaultLang` static field to customize the default lang
+- a `getLang` function to get the current lang for the SDK
+
+### Fixed
+
+- Warnings for translations
+
+## [1.3.0] - 2020-03-18
+
+### Added
+
+- A cache system
+- some informations about differents tags on a card
+- lvl on the card interface
+
+### Removed
+
+- cardTypes on the card interface
+
+## [1.2.1] - 2020-03-14
+
+### Fixed
+
+- Fix items datas not in the correct interface
+
+## [1.2.0] - 2020-03-14
+
+### Added
+
+- Added The getCards endpoint to fetch the big list of card with an optionnal  filter on the set
+- Added The getExpansions endpoint to fetch the list of expansions
+- Added Some informations about cardTypes
+- Updated DB to add support for items
+
+### Fixed
+
+- Fix translation not getting the correct file
+
+
+## [1.0.8] - 2020-03-11
+
+### Changed
+
+- Changed typing for some interfaces
+
+## [1.0.1-1.0.7] - 2020-03-11
+
+### Changed
+
+- Renamed the class Name from `TCGDex` to `TCGdex`
+- lang argument is now public so it can be changed while the SDK is active
+
+### Added
+
+- some typing for getCard and translationUtil
+
+## [1.0.0] - 2020-03-11
+
+### Added
+
+- the getCard function to use with the fetch a card with it's id
+- the getSet function to use with the fetch a set with it's id
+- the getExpansion function to use with the fetch an expansion with it's id
+- Constructor arg support for multiple langs
+- TranslationUtil to go from the SDK value to a text value
+
+[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.3.1...HEAD
+
+[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
+[2.1.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.1
+[2.1.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.0
+[2.0.2-2.0.3]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.3
+[2.0.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.1
+[2.0.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.0
+[1.7.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.7.0
+[1.6.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.6.1
+[1.6.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.6.0
+[1.5.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.5.0
+[1.4.2]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.2
+[1.4.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.1
+[1.4.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.4.0
+[1.3.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.3.0
+[1.2.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.2.1
+[1.2.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.2.0
+[1.0.8]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.0.8
+[1.0.1-1.0.7]: https://github.com/tcgdex/javascript-sdk/releases/tag/1.0.7
+[1.0.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v1.0.0

README.md

@@ -1,50 +1,70 @@
-# TCGdex JavaScript/TypeScript SDK
-
-This is the SDK used to communicate with the Open source [TCGdex API](https://www.github.com/tcgdex/cards-database)
-
-Full API/SDK documentation in progress at https://www.tcgdex.net/docs
-
-## Install
-
-```bash
-yarn add @tcgdex/sdk
-# or
-npm install @tcgdex/sdk
-```
-
-## Usage
-
-_Note: a complete documentation is in progress_
-
-```javascript
-import TCGdex from '@tcgdex/sdk'
-
-// initialize the SDK
-const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.d.ts line 1 for supported languages)
-
-// if you need to change the language
-tcgdex.lang = 'fr'
-
-// get a Card using its global ID
-await tcgdex.fetch('cards', 'base1-1')
-
-// fetch a Card using it's local id and set name/ID
-await tcgdex.fetch('sets', 'Base Set', 1)
-
-// fetch a Set's informations using the set's name/ID
-await tcgdex.fetch('sets', 'Sword & Shield')
-
-// Fetch a serie using the serie's name/ID
-await tcgdex.fetch('series', 'Black & White')
-
-// Fetch cards using other endpoints
-/**
- * categories => the the different cards categories
- * hp => fetch the different cards possible HPs
- * illustrators => fetch all the cards illustrators
- * rarities => fetch the cards rarities
- * retreats => fetch the cards using the retreat count
- * types => fetch the cards using the Pokémon type(s)
- **/
-await tcgdex.fetch('categories')
-```
+<p align="center">
+	<a href="http://npmjs.com/@tcgdex/sdk">
+		<img src="https://img.shields.io/npm/v/@tcgdex/sdk?style=flat-square" alt="NOM Version">
+	</a>
+	<a href="http://npmjs.com/@tcgdex/sdk">
+		<img src="https://img.shields.io/npm/dw/@tcgdex/sdk?style=flat-square" alt="NPM Downloads">
+	</a>
+	<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">
+		<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>
+
+</p>
+
+# TCGdex JavaScript/TypeScript SDK
+
+Communicate with the Open Source TCGdex API in Javascript/Typescript using the SDK
+
+Full API/SDK documentation in progress at https://www.tcgdex.net/docs
+
+## Getting Started
+
+Install the SDK using:
+```bash
+yarn add @tcgdex/sdk
+# or
+npm install @tcgdex/sdk
+```
+
+## Usage
+
+_Note: a complete documentation is in progress_
+
+```javascript
+import TCGdex from '@tcgdex/sdk'
+
+// initialize the SDK
+const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.ts line 1 for supported languages)
+
+// if you need to change the language
+tcgdex.lang = 'fr'
+
+// get a Card using its global ID
+await tcgdex.fetch('cards', 'base1-1')
+
+// fetch a Card using it's local id and set name/ID
+await tcgdex.fetch('sets', 'Base Set', 1)
+
+// fetch a Set's informations using the set's name/ID
+await tcgdex.fetch('sets', 'Sword & Shield')
+
+// Fetch a serie using the serie's name/ID
+await tcgdex.fetch('series', 'Black & White')
+
+// Fetch cards using other endpoints
+/**
+ * categories => the the different cards categories
+ * hp => fetch the different cards possible HPs
+ * illustrators => fetch all the cards illustrators
+ * rarities => fetch the cards rarities
+ * retreats => fetch the cards using the retreat count
+ * types => fetch the cards using the Pokémon type(s)
+ **/
+await tcgdex.fetch('categories')
+```

__tests__/basic.test.js

@@ -0,0 +1,66 @@
+const TCGdex = require("../src/tcgdex").default
+const fetch = require('node-fetch')
+
+const fakeFetch = (response, status = 200) => jest.fn(() =>
+	Promise.resolve({
+		status: status,
+		json: () => Promise.resolve(response),
+	})
+);
+
+
+
+test('Basic test', async () => {
+	const tcgdex = new TCGdex('en')
+	TCGdex.fetch = fakeFetch({ok: true})
+	const res = await tcgdex.fetch('cards', 'basic-test')
+	expect(res).toEqual({ok: true})
+	expect(TCGdex.fetch).toHaveBeenCalledTimes(1)
+})
+
+test('Cache test', async () => {
+	const tcgdex = new TCGdex('en')
+	TCGdex.fetch = fakeFetch({ok: 'a'})
+	const res1 = await tcgdex.fetch('cards', 'cache-test')
+	expect(res1).toEqual({ok: 'a'})
+	TCGdex.fetch = fakeFetch({ok: 'b'})
+	const res2 = await tcgdex.fetch('cards', 'cache-test')
+	expect(res2).toEqual({ok: 'a'})
+})
+
+test('endpoint errors', async () => {
+	const tcgdex = new TCGdex('en')
+	TCGdex.fetch = fakeFetch({ok: 'a'})
+	await expect(tcgdex.fetch('non existing endpoint')).rejects.toThrow()
+	await expect(tcgdex.fetch()).rejects.toThrow()
+})
+
+test('404 test', async () => {
+	const tcgdex = new TCGdex('en')
+	TCGdex.fetch = fakeFetch(undefined, 404)
+	expect(
+		await tcgdex.fetch('cards', '404-test')
+	).not.toBeDefined()
+})
+
+test('test real endpoints', async () => {
+	const tcgdex = new TCGdex('en')
+	TCGdex.fetch = fetch
+	const endpoints = [
+		{endpoint: 'fetchCard', params: ['swsh1-1']},
+		{endpoint: 'fetchCard', params: ['1', 'Sword & Shield']},
+		{endpoint: 'fetchCards', params: ['swsh1']},
+		{endpoint: 'fetchCards', params: []},
+		{endpoint: 'fetchSet', params: ['swsh1']},
+		{endpoint: 'fetchSets', params: ['swsh']},
+		{endpoint: 'fetchSets', params: []},
+		{endpoint: 'fetchSeries', params: []},
+		{endpoint: 'fetchSerie', params: ['swsh']},
+	]
+
+	for await (const item of endpoints) {
+		expect(
+			await tcgdex[item.endpoint](...item.params)
+		).toBeDefined()
+	}
+})

babel.config.js

@@ -0,0 +1,7 @@
+// Babel config for Jest
+module.exports = {
+	presets: [
+		['@babel/preset-env', {targets: {node: 'current'}}],
+		'@babel/preset-typescript'
+	],
+};

package.json

@@ -1,44 +1,58 @@
-{
-	"name": "@tcgdex/sdk",
-	"version": "2.3.0-beta.2",
-	"main": "./dist/cjs/tcgdex.node.js",
-	"module": "./dist/modules/tcgdex.node.js",
-	"types": "./dist/types/tcgdex.d.ts",
-	"repository": "https://github.com/tcgdex/javascript-sdk.git",
-	"license": "MIT",
-	"devDependencies": {
-		"@parcel/packager-ts": "2.0.0-beta.2",
-		"@types/node-fetch": "^2.5.10",
-		"awesome-typescript-loader": "^5.2.1",
-		"ts-node": "^10.0.0",
-		"typescript": "^4.1.3",
-		"webpack": "^5.40.0",
-		"webpack-nano": "^1.1.1"
-	},
-	"dependencies": {
-		"node-fetch": "^2.6.1",
-		"unfetch": "^4.2.0"
-	},
-	"scripts": {
-		"build": "yarn build:cjs && yarn build:browser && yarn 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"
-	},
-	"files": [
-		"dist"
-	],
-	"sideEffects": false,
-	"targets": {
-		"browser": {
-			"context": "browser",
-			"engines": {
-				"browsers": "since 2017-06"
-			},
-			"includeNodeModules": true,
-			"optimize": false,
-			"scopeHoist": false
-		}
-	}
-}
+{
+	"name": "@tcgdex/sdk",
+	"version": "2.4.0",
+	"main": "./dist/cjs/tcgdex.node.js",
+	"types": "./dist/types/tcgdex.d.ts",
+	"repository": "https://github.com/tcgdex/javascript-sdk.git",
+	"homepage": "https://github.com/tcgdex/javascript-sdk",
+	"author": "Aviortheking",
+	"keywords": [
+		"tcgdex",
+		"pokemon",
+		"trading",
+		"card",
+		"tcg",
+		"sdk",
+		"api",
+		"typescript",
+		"javascript",
+		"typing"
+	],
+	"license": "MIT",
+	"devDependencies": {
+		"@babel/core": "^7.14.6",
+		"@babel/preset-env": "^7.14.7",
+		"@babel/preset-typescript": "^7.14.5",
+		"@types/node-fetch": "^2.5.10",
+		"@typescript-eslint/eslint-plugin": "^4.28.0",
+		"@typescript-eslint/parser": "^4.28.0",
+		"eslint": "^7.29.0",
+		"jest": "^27.0.5",
+		"ts-loader": "^9.2.3",
+		"ts-node": "^10.0.0",
+		"typescript": "^4.1.3",
+		"webpack": "^5.40.0",
+		"webpack-nano": "^1.1.1"
+	},
+	"engines": {
+		"node": ">=12"
+	},
+	"dependencies": {
+		"isomorphic-unfetch": "^3.1.0",
+		"unfetch": "^4.2.0"
+	},
+	"scripts": {
+		"prebuild": "node scripts/export-version-number.js",
+		"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": "npm run build",
+		"lint": "eslint",
+		"test": "jest --coverage"
+	},
+	"files": [
+		"dist"
+	],
+	"sideEffects": false
+}

scripts/export-version-number.js

@@ -0,0 +1,4 @@
+const { version } = require('../package.json')
+const fs = require('fs')
+
+fs.writeFileSync('./src/version.json', JSON.stringify({version}))

src/Request.ts

@@ -1,51 +1,31 @@
-import TCGdex from './tcgdex'
-
-export default class RequestWrapper {
-	private static cache: Array<Request<any>> = []
-
-	public static getRequest<T>(url: string) {
-		let req = this.cache.find((req) => req.url === url) as Request<T>|undefined
-		if (!req) {
-			req = new Request<T>(url)
-			this.cache.push(req)
-		}
-		return req
-	}
-}
-
-export class Request<T = any> {
-	public static ttl = 1000 * 60 * 60 // 1 hour
-
-	private response?: T
-	private fetched?: Date
-
-	public constructor(
-		public url: string // url is public for quick url test
-	) {}
-
-	public async get(): Promise<T | undefined> {
-		const now = new Date()
-		// if reponse was already fetched and TTL was not passed
-		if (
-			this.fetched &&
-			this.response &&
-			now.getTime() - this.fetched.getTime() < Request.ttl
-		) {
-			return this.response
-		}
-
-		// Fetch Response
-		const unfetch = TCGdex.fetch
-		const resp = await unfetch(this.url, {
-			headers: {
-				'user-agent': `@tcgdex/javascript-sdk/${TCGdex.VERSION}`
-			}
-		})
-		if (resp.status !== 200) {
-			return undefined
-		}
-		this.response = await resp.json()
-		this.fetched = now
-		return this.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,4 +1,4 @@
-export type SupportedLanguages = 'en' | 'fr'
+export type SupportedLanguages = 'en' | 'fr' | 'es' | 'it' | 'pt' | 'de'
 
 export type Languages<T = string> = Partial<Record<SupportedLanguages, T>>
 
@@ -28,14 +28,16 @@ export interface SetResume {
 	logo?: string
 	symbol?: string
 	cardCount: {
+
 		/**
 		 * total of number of cards
 		 */
-		 total: number
-		 /**
+		total: number
+
+		/**
 		  * number of cards officialy (on the bottom of each cards)
 		  */
-		 official: number
+		official: number
 	}
 }
 
@@ -53,6 +55,7 @@ export interface Set extends SetResume {
 	 * card is banned from the set it will still be true
 	 */
 	legal: {
+
 		/**
 		 * Ability to play in standard tournaments
 		 */
@@ -65,26 +68,32 @@ export interface Set extends SetResume {
 	}
 
 	cardCount: {
+
 		/**
 		 * total of number of cards
 		 */
 		total: number
+
 		/**
 		 * number of cards officialy (on the bottom of each cards)
 		 */
 		official: number
+
 		/**
 		 * number of cards having a normal version
 		 */
 		normal: number
+
 		/**
 		 * number of cards having an reverse version
 		 */
 		reverse: number
+
 		/**
 		 * number of cards having an holo version
 		 */
 		holo: number
+
 		/**
 		 * Number of possible cards
 		 */
@@ -159,8 +168,9 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
 
 	/**
 	 * Pokemon Types
+	 * ex for multiple https://www.tcgdex.net/database/ex/ex13/17
 	 */
-	types?: Array<string> // ex for multiple https://www.tcgdex.net/database/ex/ex13/17
+	types?: Array<string>
 
 	/**
 	 * Pokemon Sub Evolution
@@ -257,7 +267,7 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
 
 	retreat?: number
 
-	//Trainer/Energy
+	// Trainer/Energy
 	effect?: string
 
 	// Trainer Only
@@ -277,6 +287,7 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
 	 * Note: all cards are avaialable to play in unlimited tournaments
 	 */
 	legal: {
+
 		/**
 		 * Ability to play in standard tournaments
 		 */

src/tcgdex.node.ts

@@ -1,5 +1,5 @@
 import TCGdex from './tcgdex'
-import fetch from 'node-fetch'
+import fetch from 'isomorphic-unfetch'
 
 TCGdex.fetch = fetch as any
 

src/tcgdex.ts

@@ -1,176 +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
-
-	public static readonly VERSION = "2.2.0"
-
-	/**
-	 * @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 ?? '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) {
-		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((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()
-	}
-}
-
-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'

webpack.config.js

@@ -19,12 +19,15 @@ module.exports = {
 	module: {
 		rules: [{
 			test: /\.ts$/,
-			loader: 'awesome-typescript-loader',
+			loader: 'ts-loader',
 			exclude: /node_modules/,
 			options: {
-				sourceMap: false,
-				declarationDir: false,
-				target: 'ES2016'
+				compilerOptions: {
+					sourceMap: false,
+					declaration: false,
+					declarationDir: null,
+					target: 'ES2016'
+				}
 			}
 		}]
 	}