v1.0.8

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

README.md

@@ -1,8 +1,44 @@
-current endpoints
+# TCGdex Javacript SDK
 
-```js
+## Install
-	console.log(await tcgdex.getCard("1", "hgss1"))
-	console.log(await tcgdex.getSet("hgss1"))
-	console.log(await tcgdex.getExpansion("hgss"))
 
+### Yarn/npm
+
+```bash
+yarn add @tcgdex/sdk
+```
+or with npm
+```bash
+npm install @tcgdex/sdk
+```
+
+## Usage
+
+_Note: a complete documentation is in progress_
+
+```javascript
+import TCGdex from '@tcgdex/sdk'
+import TranslationUtil from '@tcgdex/sdk/TranslationUtil'
+import Tag from '@tcgdex/sdk/interfaces/Tag'
+
+// init the class
+const tcgdex = new TCGdex("en") // Lang code (Optionnal) (See TranslationUtil.ts line 3)
+
+// change lang
+tcgdex.lang = "fr"
+
+// get Card object wih global id
+await tcgdex.getCard("base1-1")
+
+// get Card object with local id and set
+await tcgdex.getCard(1, "base1")
+
+// get Set informations
+await tcgdex.getSet("base1")
+
+// get Expansion
+await tcgdex.getExpansion("base")
+
+// Translate information from code to the lang
+TranslationUtil.translate("tag", Tag.STAGE2, "en")
 ```

TranslationUtil.ts

@@ -1,8 +1,18 @@
 import LangList, { Langs } from "./interfaces/LangList";
+import AbilityType from "./interfaces/AbilityType";
+import Category from "./interfaces/Category";
+import Rarity from "./interfaces/Rarity";
+import Tag from "./interfaces/Tag";
+import Type from "./interfaces/Type";
 
 type possibilities = "abilityType" | "category" | "rarity" | "tag" | "type"
 
 export default class TranslationUtil {
+	public static translate(master: "abilityType",a: AbilityType, lang: Langs): string|undefined;
+	public static translate(master: "category",a: Category, lang: Langs): string|undefined;
+	public static translate(master: "rarity",a: Rarity, lang: Langs): string|undefined;
+	public static translate(master: "tag",a: Tag, lang: Langs): string|undefined;
+	public static translate(master: "type",a: Type, lang: Langs): string|undefined;
 	public static translate(master: possibilities,a: number, lang: Langs): string|undefined {
 		const trans = require(`./${master}`).default as translations
 		const tmp = trans[lang]

interfaces/AbilityType.ts

@@ -3,6 +3,12 @@ export interface AbilityTypeSimple {
 	name: string
 }
 
+export type AbilityTypeSingle = {
+	id: AbilityType
+	name: string
+	cards: string
+}
+
 enum AbilityType {
 	POKEBODY,
 	POKEPOWER,

interfaces/Illustrator.ts

@@ -1,4 +1,5 @@
 import { CardSimple } from "./Card";
+import { List } from "./General";
 
 export type IllustratorSingle = {
 	id: number,
@@ -11,10 +12,7 @@ export interface IllustratorSimple {
 	name: string
 }
 
-export interface IllustratorsList {
+export type IllustratorsList = List<IllustratorSimple>
-	count: number
-	list: Array<IllustratorSimple>
-}
 
 interface Illustrator {
 	id: number

interfaces/Rarity.ts

@@ -1,3 +1,6 @@
+import { List } from "./General"
+import { CardSimple } from "./Card"
+
 export enum Rarity {
 	Common,
 	Uncommon,
@@ -30,3 +33,11 @@ export interface RaritySimple {
 	id: Rarity
 	name: string
 }
+
+export type RaritySingle = {
+	id: Rarity
+	name: string
+	cards: Array<CardSimple>
+}
+
+export type RarityList = List<RaritySimple>

interfaces/Retreat.ts

@@ -1,4 +1,5 @@
 import { CardSimple } from "./Card";
+import { List } from "./General";
 
 export type RetreatSimple = number
 
@@ -7,7 +8,4 @@ export interface RetreatSingle {
 	cards: Array<CardSimple>
 }
 
-export interface RetreatList {
+export type RetreatList = List<RetreatSimple>
-	count: number,
-	list: Array<RetreatSimple>
-}

interfaces/Tag.ts

@@ -1,3 +1,6 @@
+import { List } from "./General"
+import { CardSimple } from "./Card"
+
 enum Tag {
 	BASIC,
 	BASICENERGY,
@@ -29,3 +32,11 @@ export interface TagSimple {
 	id: Tag
 	name: string
 }
+
+export type TagSingle = {
+	id: Tag
+	name: string
+	cards: Array<CardSimple>
+}
+
+export type TagList = List<TagSimple>

interfaces/Type.ts

@@ -1,3 +1,6 @@
+import { List } from "./General"
+import { CardSimple } from "./Card"
+
 enum Type {
 	COLORLESS,
 	DARKNESS,
@@ -17,4 +20,12 @@ export interface TypeSimple {
 	name: string
 }
 
+export type TypeSingle = {
+	id: Type
+	name: string
+	cards: Array<CardSimple>
+}
+
+export type TypeList = List<TypeSimple>
+
 export default Type

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tcgdex/sdk",
-	"version": "1.0.5",
+	"version": "1.0.8",
 	"main": "./tcgdex.js",
 	"types": "./types/tcgdex.d.ts",
 	"repository": "https://git.delta-wings.net/tcgdex/javascript-sdk.git",

tcgdex.ts

@@ -4,8 +4,8 @@ import { SetSingle, SetRequest } from './interfaces/Set'
 import { CardSingle } from './interfaces/Card'
 import { ExpansionSingle } from './interfaces/Expansion'
 
-export default class TCGDex {
+export default class TCGdex {
-	private lang: Langs = "en"
+	public lang: Langs = "en"
 
 	public constructor(lang?: Langs) {
 		if (lang) this.lang = lang
@@ -19,7 +19,9 @@ export default class TCGDex {
 		return this.getBaseUrl()
 	}
 
-	public async getCard(id: string, set?: string): Promise<CardSingle> {
+	public async getCard(id: string|number, set: string): Promise<CardSingle>;
+	public async getCard(id: string): Promise<CardSingle>;
+	public async getCard(id: string|number, set?: string): Promise<CardSingle> {
 		try {
 			const txt = set ? `sets/${set}` : "cards"
 			const resp = await fetch(`${this.gbu()}/${txt}/${id}`)