mirror of
https://github.com/tcgdex/javascript-sdk.git
synced 2025-07-14 10:55:11 +00:00
Compare commits
31 Commits
v2.3.0-bet
...
v2.4.4
Author | SHA1 | Date | |
---|---|---|---|
02a8174509
|
|||
ac570459a3
|
|||
093df107d2 | |||
d166e0f5cf | |||
ef102dc433 | |||
324be2a410 | |||
ad4ad553a4 | |||
7c253c98d7 | |||
e172465258
|
|||
9940961e20
|
|||
f25be8b5f5
|
|||
641f7861b8 | |||
3db69e0537 | |||
1c36d6b93e | |||
10083223e2
|
|||
95196ce551
|
|||
81200aede7
|
|||
35642ffd57
|
|||
4435f930ec | |||
46b74170fa
|
|||
de916e09eb
|
|||
96bc9149c9
|
|||
f858bd5c79
|
|||
8a0dac5e27
|
|||
941fd925b8 | |||
3684c61812
|
|||
a2f7018aa4 | |||
7014e0c511
|
|||
b951f6d2d1
|
|||
babd4e5f85
|
|||
efe5957946
|
@ -6,3 +6,7 @@ indent_size = 4
|
|||||||
charset = utf-8
|
charset = utf-8
|
||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.yml]
|
||||||
|
indent_size = 2
|
||||||
|
indent_style = space
|
||||||
|
4
.eslintignore
Normal file
4
.eslintignore
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
dist/
|
||||||
|
src/tcgdex.browser.ts
|
||||||
|
__tests__
|
||||||
|
*.js
|
5
.eslintrc.js
Normal file
5
.eslintrc.js
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
module.exports = {
|
||||||
|
extends: [
|
||||||
|
"./node_modules/@dzeio/config/eslint/typescript"
|
||||||
|
]
|
||||||
|
}
|
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
* text=auto eol=lf
|
44
.github/workflows/build.yml
vendored
Normal file
44
.github/workflows/build.yml
vendored
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
name: Build & Test
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
# Run on any pull request
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
# Follow current releases https://nodejs.org/en/about/releases/
|
||||||
|
node-version: [12.x, 14.x, 16.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
|
||||||
|
- 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
|
26
.github/workflows/code-quality.yml
vendored
Normal file
26
.github/workflows/code-quality.yml
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
name: Code Quality Checks
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
# Run on any pull request
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- 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: npm run lint
|
28
.github/workflows/publish.yml
vendored
Normal file
28
.github/workflows/publish.yml
vendored
Normal file
@ -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 }}
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,6 +1,8 @@
|
|||||||
# Dev Files
|
# Dev Files
|
||||||
node_modules
|
node_modules
|
||||||
test.ts
|
test.ts
|
||||||
|
coverage
|
||||||
|
|
||||||
# Dist files
|
# Dist files
|
||||||
dist
|
dist
|
||||||
|
src/version.json
|
||||||
|
@ -6,3 +6,4 @@ webpack.config.js
|
|||||||
tsconfig.*
|
tsconfig.*
|
||||||
yarn.lock
|
yarn.lock
|
||||||
CHANGELOG.md
|
CHANGELOG.md
|
||||||
|
coverage
|
||||||
|
58
CHANGELOG.md
58
CHANGELOG.md
@ -7,6 +7,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## 2.4.3 - 2021-07-19
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- ESM exports are back
|
||||||
|
|
||||||
|
## 2.4.2 2021-07-11
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Downgraded to ES2015 to have better suport browsers
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Moved browser export from `Webpack` to `esbuild`
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- 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
|
## [2.2.0] - 2021-06-19
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
@ -55,10 +100,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Functions now use `fetch` instead of `get` in their names
|
- Functions now use `fetch` instead of `get` in their names
|
||||||
- URL Normalization is now done by the SDK
|
- URL Normalization is now done by the SDK
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- `getSerie(s)` now point to the correct endpoint
|
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
- TranslationUtil as now translation are managed by the API
|
- TranslationUtil as now translation are managed by the API
|
||||||
@ -186,8 +227,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Constructor arg support for multiple langs
|
- Constructor arg support for multiple langs
|
||||||
- TranslationUtil to go from the SDK value to a text value
|
- TranslationUtil to go from the SDK value to a text value
|
||||||
|
|
||||||
[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.1.1...HEAD
|
[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.4.3...HEAD
|
||||||
|
|
||||||
|
[2.4.3]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.4.3
|
||||||
|
[2.4.2]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.4.2
|
||||||
|
[2.4.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.4.1
|
||||||
|
[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
|
||||||
[2.1.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.1
|
[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.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.2-2.0.3]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.3
|
||||||
|
34
README.md
34
README.md
@ -1,26 +1,54 @@
|
|||||||
|
<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/actions/workflows/build.yml">
|
||||||
|
<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
|
# TCGdex JavaScript/TypeScript SDK
|
||||||
|
|
||||||
This is the SDK used to communicate with the Open source [TCGdex API](https://www.github.com/tcgdex/cards-database)
|
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
|
Full API/SDK documentation in progress at https://www.tcgdex.net/docs
|
||||||
|
|
||||||
## Install
|
## Getting Started
|
||||||
|
|
||||||
|
Install the SDK using:
|
||||||
```bash
|
```bash
|
||||||
yarn add @tcgdex/sdk
|
yarn add @tcgdex/sdk
|
||||||
# or
|
# or
|
||||||
npm install @tcgdex/sdk
|
npm install @tcgdex/sdk
|
||||||
```
|
```
|
||||||
|
|
||||||
|
or in the web browser
|
||||||
|
```html
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/@tcgdex/sdk@2/dist/tcgdex.browser.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
_Note: a complete documentation is in progress_
|
_Note: a complete documentation is in progress_
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
// only if using with NPM/Yarn
|
||||||
import TCGdex from '@tcgdex/sdk'
|
import TCGdex from '@tcgdex/sdk'
|
||||||
|
|
||||||
// initialize the SDK
|
// initialize the SDK
|
||||||
const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.d.ts line 1 for supported languages)
|
const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.ts line 1 for supported languages)
|
||||||
|
|
||||||
// if you need to change the language
|
// if you need to change the language
|
||||||
tcgdex.lang = 'fr'
|
tcgdex.lang = 'fr'
|
||||||
|
66
__tests__/basic.test.js
Normal file
66
__tests__/basic.test.js
Normal file
@ -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()
|
||||||
|
}
|
||||||
|
})
|
7
babel.config.js
Normal file
7
babel.config.js
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
// Babel config for Jest
|
||||||
|
module.exports = {
|
||||||
|
presets: [
|
||||||
|
['@babel/preset-env', {targets: {node: 'current'}}],
|
||||||
|
'@babel/preset-typescript'
|
||||||
|
],
|
||||||
|
};
|
14376
package-lock.json
generated
Normal file
14376
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
63
package.json
63
package.json
@ -1,44 +1,59 @@
|
|||||||
{
|
{
|
||||||
"name": "@tcgdex/sdk",
|
"name": "@tcgdex/sdk",
|
||||||
"version": "2.3.0-beta.1",
|
"version": "2.4.4",
|
||||||
"main": "./dist/cjs/tcgdex.js",
|
"main": "./dist/cjs/tcgdex.node.js",
|
||||||
"module": "./dist/modules/tcgdex.js",
|
"module": "./dist/modules/tcgdex.node.js",
|
||||||
"types": "./dist/types/tcgdex.d.ts",
|
"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",
|
"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",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@parcel/packager-ts": "2.0.0-beta.2",
|
"@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",
|
"@types/node-fetch": "^2.5.10",
|
||||||
"awesome-typescript-loader": "^5.2.1",
|
"@typescript-eslint/eslint-plugin": "^4.28.0",
|
||||||
|
"@typescript-eslint/parser": "^4.28.0",
|
||||||
|
"esbuild": "^0.12.15",
|
||||||
|
"eslint": "^7.29.0",
|
||||||
|
"jest": "^27.0.5",
|
||||||
"ts-node": "^10.0.0",
|
"ts-node": "^10.0.0",
|
||||||
"typescript": "^4.1.3",
|
"typescript": "^4.1.3"
|
||||||
"webpack": "^5.40.0",
|
},
|
||||||
"webpack-nano": "^1.1.1"
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"node-fetch": "^2.6.1",
|
"isomorphic-unfetch": "^3.1.0",
|
||||||
"unfetch": "^4.2.0"
|
"unfetch": "^4.2.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "yarn build:cjs && yarn build:browser && yarn build:es2015",
|
"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:cjs": "tsc --project tsconfig.json",
|
||||||
"build:es2015": "tsc --project tsconfig.es2015.json",
|
"build:es2015": "tsc --project tsconfig.es2015.json",
|
||||||
"build:browser": "wp --config webpack.config.js",
|
"build:browser": "esbuild ./src/tcgdex.browser.ts --bundle --minify --sourcemap --target=es2016,chrome90,firefox78,safari14,ios13,edge90 --outfile=dist/tcgdex.browser.js",
|
||||||
"prepublishOnly": "yarn build"
|
"prepublishOnly": "npm run build",
|
||||||
|
"lint": "eslint",
|
||||||
|
"test": "jest --coverage"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"dist"
|
"dist"
|
||||||
],
|
],
|
||||||
"sideEffects": false,
|
"sideEffects": false
|
||||||
"targets": {
|
|
||||||
"browser": {
|
|
||||||
"context": "browser",
|
|
||||||
"engines": {
|
|
||||||
"browsers": "since 2017-06"
|
|
||||||
},
|
|
||||||
"includeNodeModules": true,
|
|
||||||
"optimize": false,
|
|
||||||
"scopeHoist": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
4
scripts/export-version-number.js
Normal file
4
scripts/export-version-number.js
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
const { version } = require('../package.json')
|
||||||
|
const fs = require('fs')
|
||||||
|
|
||||||
|
fs.writeFileSync('./src/version.json', JSON.stringify({version}))
|
@ -1,51 +1,31 @@
|
|||||||
import TCGdex from './tcgdex'
|
import TCGdex from './tcgdex'
|
||||||
|
import { version } from './version.json'
|
||||||
|
|
||||||
export default class RequestWrapper {
|
export default class Request {
|
||||||
private static cache: Array<Request<any>> = []
|
|
||||||
|
|
||||||
public static getRequest<T>(url: string) {
|
// 1 hour of TTL by default
|
||||||
let req = this.cache.find((req) => req.url === url) as Request<T>|undefined
|
public static ttl = 1000 * 60 * 60
|
||||||
if (!req) {
|
|
||||||
req = new Request<T>(url)
|
|
||||||
this.cache.push(req)
|
|
||||||
}
|
|
||||||
return req
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class Request<T = any> {
|
private static cache: Record<string, {response: any, time: number}> = {}
|
||||||
public static ttl = 1000 * 60 * 60 // 1 hour
|
|
||||||
|
|
||||||
private response?: T
|
public static async fetch<T>(url: string): Promise<T | undefined> {
|
||||||
private fetched?: Date
|
let request = this.cache[url]
|
||||||
|
const now = new Date().getTime()
|
||||||
public constructor(
|
if (!request || now - request.time > this.ttl) {
|
||||||
public url: string // url is public for quick url test
|
const unfetch = TCGdex.fetch
|
||||||
) {}
|
const resp = await unfetch(url, {
|
||||||
|
headers: {
|
||||||
public async get(): Promise<T | undefined> {
|
'user-agent': `@tcgdex/javascript-sdk/${version}`
|
||||||
const now = new Date()
|
}
|
||||||
// if reponse was already fetched and TTL was not passed
|
})
|
||||||
if (
|
if (resp.status !== 200) {
|
||||||
this.fetched &&
|
return undefined
|
||||||
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) {
|
this.cache[url] = { response: await resp.json(), time: now }
|
||||||
return undefined
|
request = this.cache[url]
|
||||||
}
|
}
|
||||||
this.response = await resp.json()
|
return request.response
|
||||||
this.fetched = now
|
|
||||||
return this.response
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,14 @@
|
|||||||
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 type Languages<T = string> = Partial<Record<SupportedLanguages, T>>
|
||||||
|
|
||||||
export interface SerieResume {
|
export interface SerieResume {
|
||||||
id: string
|
id: string
|
||||||
name: string
|
name: string
|
||||||
|
logo?: string
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Serie extends SerieResume {
|
export interface Serie extends SerieResume {
|
||||||
@ -28,14 +32,16 @@ export interface SetResume {
|
|||||||
logo?: string
|
logo?: string
|
||||||
symbol?: string
|
symbol?: string
|
||||||
cardCount: {
|
cardCount: {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* total of number of cards
|
* total of number of cards
|
||||||
*/
|
*/
|
||||||
total: number
|
total: number
|
||||||
/**
|
|
||||||
|
/**
|
||||||
* number of cards officialy (on the bottom of each cards)
|
* number of cards officialy (on the bottom of each cards)
|
||||||
*/
|
*/
|
||||||
official: number
|
official: number
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -53,6 +59,7 @@ export interface Set extends SetResume {
|
|||||||
* card is banned from the set it will still be true
|
* card is banned from the set it will still be true
|
||||||
*/
|
*/
|
||||||
legal: {
|
legal: {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ability to play in standard tournaments
|
* Ability to play in standard tournaments
|
||||||
*/
|
*/
|
||||||
@ -65,26 +72,32 @@ export interface Set extends SetResume {
|
|||||||
}
|
}
|
||||||
|
|
||||||
cardCount: {
|
cardCount: {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* total of number of cards
|
* total of number of cards
|
||||||
*/
|
*/
|
||||||
total: number
|
total: number
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* number of cards officialy (on the bottom of each cards)
|
* number of cards officialy (on the bottom of each cards)
|
||||||
*/
|
*/
|
||||||
official: number
|
official: number
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* number of cards having a normal version
|
* number of cards having a normal version
|
||||||
*/
|
*/
|
||||||
normal: number
|
normal: number
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* number of cards having an reverse version
|
* number of cards having an reverse version
|
||||||
*/
|
*/
|
||||||
reverse: number
|
reverse: number
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* number of cards having an holo version
|
* number of cards having an holo version
|
||||||
*/
|
*/
|
||||||
holo: number
|
holo: number
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Number of possible cards
|
* Number of possible cards
|
||||||
*/
|
*/
|
||||||
@ -159,8 +172,9 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Pokemon Types
|
* 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
|
* Pokemon Sub Evolution
|
||||||
@ -257,7 +271,7 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
|
|||||||
|
|
||||||
retreat?: number
|
retreat?: number
|
||||||
|
|
||||||
//Trainer/Energy
|
// Trainer/Energy
|
||||||
effect?: string
|
effect?: string
|
||||||
|
|
||||||
// Trainer Only
|
// Trainer Only
|
||||||
@ -277,6 +291,7 @@ export interface Card<SetType extends SetResume = SetResume> extends CardResume
|
|||||||
* Note: all cards are avaialable to play in unlimited tournaments
|
* Note: all cards are avaialable to play in unlimited tournaments
|
||||||
*/
|
*/
|
||||||
legal: {
|
legal: {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ability to play in standard tournaments
|
* Ability to play in standard tournaments
|
||||||
*/
|
*/
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
import TCGdex from './tcgdex'
|
import TCGdex from './tcgdex'
|
||||||
import unfetch from 'unfetch'
|
import unfetch from 'unfetch'
|
||||||
|
|
||||||
TCGdex.fetch = unfetch as any
|
TCGdex.fetch = window.fetch ?? unfetch as any
|
||||||
|
|
||||||
export default TCGdex
|
(global ?? window).TCGdex = TCGdex
|
||||||
export * from './tcgdex'
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import TCGdex from './tcgdex'
|
import TCGdex from './tcgdex'
|
||||||
import fetch from 'node-fetch'
|
import fetch from 'isomorphic-unfetch'
|
||||||
|
|
||||||
TCGdex.fetch = fetch as any
|
TCGdex.fetch = fetch as any
|
||||||
|
|
||||||
|
@ -6,19 +6,16 @@ const ENDPOINTS: Array<Endpoint> = ['cards', 'categories', 'hp', 'illustrators',
|
|||||||
const BASE_URL = 'https://api.tcgdex.net/v2'
|
const BASE_URL = 'https://api.tcgdex.net/v2'
|
||||||
export default class TCGdex {
|
export default class TCGdex {
|
||||||
|
|
||||||
|
|
||||||
public static fetch: typeof fetch
|
public static fetch: typeof fetch
|
||||||
|
|
||||||
public static readonly VERSION = "2.2.0"
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @deprecated to change the lang use `this.lang`
|
* @deprecated to change the lang use `this.lang`
|
||||||
*/
|
*/
|
||||||
public static defaultLang: SupportedLanguages = "en"
|
public static defaultLang: SupportedLanguages = 'en'
|
||||||
|
|
||||||
public constructor(public lang?: SupportedLanguages) {}
|
public constructor(public lang?: SupportedLanguages) {}
|
||||||
|
|
||||||
public getLang() {
|
public getLang(): SupportedLanguages {
|
||||||
return this.lang ?? TCGdex.defaultLang ?? 'en'
|
return this.lang ?? TCGdex.defaultLang ?? 'en'
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -50,7 +47,7 @@ export default class TCGdex {
|
|||||||
/**
|
/**
|
||||||
* @deprecated use `this.fetch('sets', set)`
|
* @deprecated use `this.fetch('sets', set)`
|
||||||
*/
|
*/
|
||||||
public async fetchSet(set: string) {
|
public async fetchSet(set: string): Promise<Set | undefined> {
|
||||||
return this.fetch('sets', set)
|
return this.fetch('sets', set)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -87,11 +84,13 @@ export default class TCGdex {
|
|||||||
* @param endpoint_1 {string} the card global ID
|
* @param endpoint_1 {string} the card global ID
|
||||||
*/
|
*/
|
||||||
public async fetch(...type: ['cards', string]): Promise<Card | undefined>
|
public async fetch(...type: ['cards', string]): Promise<Card | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch every cards in the database
|
* Fetch every cards in the database
|
||||||
* @param endpoint_0 'cards'
|
* @param endpoint_0 'cards'
|
||||||
*/
|
*/
|
||||||
public async fetch(type: 'cards'): Promise<Array<CardResume> | undefined>
|
public async fetch(type: 'cards'): Promise<Array<CardResume> | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch a card using its local id and its set
|
* Fetch a card using its local id and its set
|
||||||
* @param endpoint_0 'sets'
|
* @param endpoint_0 'sets'
|
||||||
@ -99,28 +98,33 @@ export default class TCGdex {
|
|||||||
* @param endpoint_2 {string} the card local ID
|
* @param endpoint_2 {string} the card local ID
|
||||||
*/
|
*/
|
||||||
public async fetch(...endpoint: ['sets', string, string]): Promise<Card | undefined>
|
public async fetch(...endpoint: ['sets', string, string]): Promise<Card | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch a set
|
* Fetch a set
|
||||||
* @param endpoint_0 'sets'
|
* @param endpoint_0 'sets'
|
||||||
* @param endpoint_1 {string} the set name or ID
|
* @param endpoint_1 {string} the set name or ID
|
||||||
*/
|
*/
|
||||||
public async fetch(...endpoint: ['sets', string]): Promise<Set | undefined>
|
public async fetch(...endpoint: ['sets', string]): Promise<Set | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch every sets
|
* Fetch every sets
|
||||||
* @param endpoint_0 'sets'
|
* @param endpoint_0 'sets'
|
||||||
*/
|
*/
|
||||||
public async fetch(endpoint: 'sets'): Promise<SetList | undefined>
|
public async fetch(endpoint: 'sets'): Promise<SetList | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch a serie
|
* Fetch a serie
|
||||||
* @param endpoint_0 'series'
|
* @param endpoint_0 'series'
|
||||||
* @param endpoint_1 {string} the serie name or ID
|
* @param endpoint_1 {string} the serie name or ID
|
||||||
*/
|
*/
|
||||||
public async fetch(...endpoint: ['series', string]): Promise<Serie | undefined>
|
public async fetch(...endpoint: ['series', string]): Promise<Serie | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch every series
|
* Fetch every series
|
||||||
* @param endpoint_0 'series'
|
* @param endpoint_0 'series'
|
||||||
*/
|
*/
|
||||||
public async fetch(endpoint: 'series'): Promise<SerieList | undefined>
|
public async fetch(endpoint: 'series'): Promise<SerieList | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch cards depending on a specific filter
|
* Fetch cards depending on a specific filter
|
||||||
* @param endpoint_0 {'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types'}
|
* @param endpoint_0 {'categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types'}
|
||||||
@ -128,6 +132,7 @@ export default class TCGdex {
|
|||||||
* @param endpoint_1 {string} the value set while fetching the index
|
* @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>
|
public async fetch(...endpoint: ['categories' | 'hp' | 'illustrators' | 'rarities' | 'retreats' | 'types', string]): Promise<StringEndpoint | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch cards depending on a specific filter
|
* Fetch cards depending on a specific filter
|
||||||
* @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
|
* @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
|
||||||
@ -135,6 +140,7 @@ export default class TCGdex {
|
|||||||
* @param endpoint_1 {string} Fetch the possible values to use depending on the endpoint
|
* @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: 'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'): Promise<Array<string> | undefined>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch The differents endpoints depending on the first argument
|
* Fetch The differents endpoints depending on the first argument
|
||||||
* @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
|
* @param endpoint_0 {'hp' | 'retreats' | 'categories' | 'illustrators' | 'rarities' | 'types'}
|
||||||
@ -144,7 +150,7 @@ export default class TCGdex {
|
|||||||
*/
|
*/
|
||||||
public async fetch(...endpoint: Array<Endpoint | string>): Promise<any | undefined> {
|
public async fetch(...endpoint: Array<Endpoint | string>): Promise<any | undefined> {
|
||||||
if (endpoint.length === 0) {
|
if (endpoint.length === 0) {
|
||||||
throw new Error(`endpoint to fetch is empty!`)
|
throw new Error('endpoint to fetch is empty!')
|
||||||
}
|
}
|
||||||
// @ts-expect-error with the precedent check, we KNOW that type is not empty
|
// @ts-expect-error with the precedent check, we KNOW that type is not empty
|
||||||
const baseEndpoint = endpoint.shift().toLowerCase() as Endpoint
|
const baseEndpoint = endpoint.shift().toLowerCase() as Endpoint
|
||||||
@ -159,8 +165,8 @@ export default class TCGdex {
|
|||||||
*/
|
*/
|
||||||
private makeRequest<T = any>(...url: Array<string | number>) {
|
private makeRequest<T = any>(...url: Array<string | number>) {
|
||||||
// Normalize path
|
// Normalize path
|
||||||
const path = url.map((v) => encodeURI(
|
const path = url.map((subPath) => encodeURI(
|
||||||
v
|
subPath
|
||||||
// Transform numbers to string
|
// Transform numbers to string
|
||||||
.toString()
|
.toString()
|
||||||
// replace this special character with an escaped one
|
// replace this special character with an escaped one
|
||||||
@ -168,10 +174,12 @@ export default class TCGdex {
|
|||||||
// normalize the string
|
// normalize the string
|
||||||
.normalize('NFC')
|
.normalize('NFC')
|
||||||
// remove some special chars by nothing
|
// remove some special chars by nothing
|
||||||
.replace(/["'\u0300-\u036f]/g, "")
|
// eslint-disable-next-line no-misleading-character-class
|
||||||
|
.replace(/["'\u0300-\u036f]/gu, '')
|
||||||
)).join('/')
|
)).join('/')
|
||||||
return RequestWrapper.getRequest<T>(`${BASE_URL}/${this.getLang()}/${path}`).get()
|
return RequestWrapper.fetch<T>(`${BASE_URL}/${this.getLang()}/${path}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export * from './interfaces'
|
export * from './interfaces'
|
||||||
|
@ -2,10 +2,10 @@
|
|||||||
"extends": "./tsconfig.json",
|
"extends": "./tsconfig.json",
|
||||||
"include": ["./src/tcgdex.node.ts"],
|
"include": ["./src/tcgdex.node.ts"],
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "ES2020", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
|
"target": "ES2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
|
||||||
"module": "ES2015", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
|
"module": "ES2015", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
|
||||||
"declaration": false, /* Generates corresponding '.d.ts' file. */
|
"declaration": false, /* Generates corresponding '.d.ts' file. */
|
||||||
"declarationDir": null,
|
"declarationDir": null,
|
||||||
"outDir": "./dist/modules", /* Redirect output structure to the directory. */
|
"outDir": "./dist/modules", /* Redirect output structure to the directory. */
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,66 +1,15 @@
|
|||||||
{
|
{
|
||||||
|
"extends": "./node_modules/@dzeio/config/tsconfig.base",
|
||||||
"include": ["./src/tcgdex.node.ts"],
|
"include": ["./src/tcgdex.node.ts"],
|
||||||
"compilerOptions": {
|
"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 */
|
"target": "ES2015",
|
||||||
"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,
|
|
||||||
|
|
||||||
"resolveJsonModule": true,
|
"declaration": true,
|
||||||
/* Module Resolution Options */
|
"declarationDir": "./dist/types",
|
||||||
"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. */
|
|
||||||
|
|
||||||
/* Source Map Options */
|
"outDir": "./dist/cjs",
|
||||||
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
"rootDir": "./src",
|
||||||
// "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. */
|
|
||||||
|
|
||||||
/* Experimental Options */
|
|
||||||
"experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
|
||||||
"emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,31 +0,0 @@
|
|||||||
const path = require('path')
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
mode: 'production',
|
|
||||||
entry: './src/tcgdex.browser.ts',
|
|
||||||
output: {
|
|
||||||
path: path.resolve(__dirname, 'dist'),
|
|
||||||
filename: 'tcgdex.browser.js',
|
|
||||||
libraryTarget: 'umd',
|
|
||||||
library: 'TCGdex',
|
|
||||||
umdNamedDefine: true
|
|
||||||
},
|
|
||||||
resolve: {
|
|
||||||
extensions: ['.ts']
|
|
||||||
},
|
|
||||||
optimization: {
|
|
||||||
minimize: true
|
|
||||||
},
|
|
||||||
module: {
|
|
||||||
rules: [{
|
|
||||||
test: /\.ts$/,
|
|
||||||
loader: 'awesome-typescript-loader',
|
|
||||||
exclude: /node_modules/,
|
|
||||||
options: {
|
|
||||||
sourceMap: false,
|
|
||||||
declarationDir: false,
|
|
||||||
target: 'ES2016'
|
|
||||||
}
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
}
|
|
Reference in New Issue
Block a user