bump: 2.5.1

Signed-off-by: Florian BOUILLON <f.bouillon@aptatio.com>

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         # Follow current releases https://nodejs.org/en/about/releases/
-        node-version: [12.x, 14.x, 16.x, 17.x, 18.x]
+        node-version: [14.x, 16.x, 18.x, 19.x]
 
     steps:
     - name: Checkout

CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 2.5.1 - 2023-07-18
+
+### Fixed
+
+- ModuleJS exports not working as intended
+
+## 2.5.0 - 2023-06-28
+
+### Added
+
+- Support for both ModuleJS and CommonJS
+
+## 2.4.9 - 2022-09-26
+
+### Fixed
+
+- package not loading on browser
+
+## 2.4.8 - 2022-09-26
+
+### Fixed
+
+- fix version number not correctly exposting
+
+## 2.4.7 - 2022-09-26
+
+### Fixed
+
+- Compatibility with Angular
+
 ## 2.4.6 - 2022-01-28
 
 ### Fixed

README.md

@@ -63,19 +63,43 @@ _Note: a complete documentation is available at [TCGdex.dev](https://www.tcgdex.
 
 **Example: Fetch a Card**
 
+_in Browser_
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@tcgdex/sdk@2.4.9/dist/tcgdex.browser.js"></script>
+<script>
+	// Instantiate the SDK
+	const tcgdex = new TCGdex('en');
+
+	// go into an async context
+	;(async () => {
+		// Card will be Furret from the Darkness Ablaze Set
+		const card = await tcgdex.fetch('cards', 'swsh3-136');
+	})();
+</script>
+```
+
+_in NodeJS (in an async context)_
+
 ```typescript
-// Import the SDK in Typescript
-import TCGdex from '@tcgdex/sdk';
+// Import the SDK in Typescript or moduleJS
+import TCGdex from '@tcgdex/sdk'
+
+// import the SDK in commonJS
+const TCGdex = require('@tcgdex/sdk').default
 
 // Instantiate the SDK
-// note: you can use one of the following lanugages
 const tcgdex = new TCGdex('en');
 
-// Card will be Furret from the Darkness Ablaze Set
-const card = await tcgdex.fetch('cards', 'swsh3-136');
+// go into an async context
+(async () => {
+	// Card will be Furret from the Darkness Ablaze Set
+	const card = await tcgdex.fetch('cards', 'swsh3-136');
+
+	// You can also get the same result using
+	const card = await tcgdex.fetch('sets', 'Darkness Ablaze', 136);
+})();
 
-// You can also get the same result using
-const card = await tcgdex.fetch('sets', 'Darkness Ablaze', 136);
 ```
 
 **Other Examples**

package.json

@@ -1,9 +1,22 @@
 {
 	"name": "@tcgdex/sdk",
-	"version": "2.4.7",
-	"main": "./dist/cjs/tcgdex.node.js",
-	"module": "./dist/modules/tcgdex.node.js",
-	"types": "./dist/types/tcgdex.d.ts",
+	"version": "2.5.1",
+	"main": "./dist/tcgdex.node.js",
+	"module": "./dist/tcgdex.node.mjs",
+	"types": "./dist/tcgdex.node.d.ts",
+	"browser": "./dist/tcgdex.browser.global.js",
+	"exports": {
+		".": {
+			"require": {
+				"types": "./dist/tcgdex.node.d.ts",
+				"default": "./dist/tcgdex.node.js"
+			},
+			"import": {
+				"types": "./dist/tcgdex.node.d.mts",
+				"default": "./dist/tcgdex.node.mjs"
+			}
+		}
+	},
 	"description": "Communicate with the Open Source TCGdex API in Javascript/Typescript using the SDK",
 	"repository": "https://github.com/tcgdex/javascript-sdk.git",
 	"homepage": "https://github.com/tcgdex/javascript-sdk",
@@ -18,35 +31,34 @@
 		"api",
 		"typescript",
 		"javascript",
-		"typing"
+		"typing",
+		"browser",
+		"node"
 	],
 	"license": "MIT",
 	"devDependencies": {
-		"@babel/core": "^7.14.6",
-		"@babel/preset-env": "^7.14.7",
-		"@babel/preset-typescript": "^7.14.5",
-		"@dzeio/config": "^1.0.0",
-		"@types/node-fetch": "^2.5.10",
-		"@typescript-eslint/eslint-plugin": "^5.7.0",
-		"@typescript-eslint/parser": "^5.7.0",
-		"esbuild": "^0.14.5",
-		"eslint": "^8.4.1",
-		"jest": "^27.0.5",
-		"typescript": "^4.1.3"
+		"@babel/core": "^7",
+		"@babel/preset-env": "^7",
+		"@babel/preset-typescript": "^7",
+		"@dzeio/config": "^1",
+		"@types/node-fetch": "^2",
+		"@typescript-eslint/eslint-plugin": "^5",
+		"@typescript-eslint/parser": "^5",
+		"eslint": "^8",
+		"jest": "^29",
+		"tsup": "^7",
+		"typescript": "^5"
 	},
 	"engines": {
 		"node": ">=12"
 	},
 	"dependencies": {
-		"isomorphic-unfetch": "^3.1.0",
-		"unfetch": "^4.2.0"
+		"isomorphic-unfetch": "^3",
+		"unfetch": "^4"
 	},
 	"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": "esbuild ./src/tcgdex.browser.ts --bundle --minify --sourcemap --target=es2016,chrome90,firefox78,safari14,ios13,edge90 --outfile=dist/tcgdex.browser.js",
+		"build": "tsup ./src/tcgdex.node.ts --format cjs,esm --dts --clean && tsup ./src/tcgdex.browser.ts --format iife --global-name TCGdex --sourcemap",
 		"prepublishOnly": "npm run build",
 		"lint": "eslint",
 		"test": "jest --coverage"

scripts/export-version-number.js

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

src/tcgdex.browser.ts

@@ -1,6 +1,6 @@
-import TCGdex from './tcgdex'
 import unfetch from 'unfetch'
+import TCGdex from './tcgdex'
 
 TCGdex.fetch = window.fetch ?? unfetch as any
 
-(global ?? window).TCGdex = TCGdex
+export default TCGdex

tsconfig.es2015.json

@@ -1,11 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"include": ["./src/tcgdex.node.ts"],
-	"compilerOptions": {
-		"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'. */
-		"declaration": false,                      /* Generates corresponding '.d.ts' file. */
-		"declarationDir": null,
-		"outDir": "./dist/modules",                   /* Redirect output structure to the directory. */
-	}
-}

tsconfig.json

@@ -2,14 +2,7 @@
 	"extends": "./node_modules/@dzeio/config/tsconfig.base",
 	"include": ["./src/tcgdex.node.ts"],
 	"compilerOptions": {
-
 		"target": "ES2015",
-
-		"declaration": true,
-		"declarationDir": "./dist/types",
-
-		"outDir": "./dist/cjs",
 		"rootDir": "./src",
-
 	}
 }