Version Packages (#38)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
articulate · Sep 6, 2023 · c1805dd · c1805dd
1 parent e0ab92a
commit c1805dd
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/.changeset/curly-bottles-sing.md b/.changeset/curly-bottles-sing.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # @articulate/authentic
 
+## 3.0.0
+
+### Major Changes
+
+- e0ab92a: Typescript refactor and replace `jsonwebtoken` and `jwks-rsa` in favor of `jose`
+
+  The biggest change on this version is the replacement of [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) and [jwks-rsa](https://github.com/auth0/node-jwks-rsa) in favor of [jose](https://github.com/panva/jose). jose exports the same features the other two libraries offer, without adding the extra dependencies previously required (it has zero dependencies!). This change significantly decreases `@authentic` final bundle size, allowing it to also be used in Lambdas.
+
+  Also, this new version doesn't export `authentic` as a default export anymore, apps using this new version will to import/require `{ authentic } from "@articulate/authentic"` instead.
+
+  Before upgrading make sure your app uses the new expected `jwks` and `verify` options (which differ from the old ones).
+
+  ### Dual Export of ESM and CJS Bundles
+
+  Starting with this new version, Authentic started exporting both an ECMAScript Module (ESM) bundle and a CommonJS (CJS) bundle. This means that applications utilizing either of these architectures can now choose the bundle that best suits their specific use case.
+
 ## 2.0.5
 
 ### Patch Changes

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@articulate/authentic",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "Proper validation of JWT's against JWK's",
   "repository": "git@github.com:articulate/authentic.git",
   "license": "MIT",