Prepare beta version

.circleci/config.yml

@@ -1,4 +1,6 @@
 version: 2.1
+orbs:
+  ship: auth0/ship@0
 jobs:
   build:
     parameters:
@@ -21,12 +23,25 @@ jobs:
           name: Build
           command: npm run build
       - run:
-          name: Run Tests
-          command: npm run test
+          name: Run Tests against browser
+          command: npm run test:browser
+      - run:
+          name: Run Tests against node
+          command: npm run test:node
 workflows:
   build-and-test:
     jobs:
       - build:
           matrix:
             parameters:
-              node-version: ["14.20", "16.20", "18.16"]
+              node-version: ["16.20", "18.16", "20.4"]
+      - ship/node-publish:
+          context:
+            - publish-npm
+            - publish-gh
+          filters:
+            branches:
+              only:
+                - master
+          requires:
+            - build

.gitignore

@@ -13,8 +13,9 @@ lib-cov
 pids
 logs
 results
+test-results
 
 npm-debug.log
 node_modules
 build/*
-!build/jwt-decode.js
+coverage/*

README.md

@@ -1,6 +1,6 @@
 ![Browser library that helps decoding JWT tokens which are Base64Url encoded](https://cdn.auth0.com/website/sdks/banners/jwt-decode-banner.png)
 
-**IMPORTANT:** This library doesn't validate the token, any well formed JWT can be decoded. You should validate the token in your server-side logic by using something like [express-jwt](https://github.com/auth0/express-jwt), [koa-jwt](https://github.com/stiang/koa-jwt), [Owin Bearer JWT](https://github.com/michaelnoonan/Auth0-Owin-JwtBearerAuthentication), etc.
+**IMPORTANT:** This library doesn't validate the token, any well-formed JWT can be decoded. You should validate the token in your server-side logic by using something like [express-jwt](https://github.com/auth0/express-jwt), [koa-jwt](https://github.com/stiang/koa-jwt), [Microsoft.AspNetCore.Authentication.JwtBearer](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer), etc.
 
 ![Release](https://img.shields.io/npm/v/jwt-decode)
 ![Downloads](https://img.shields.io/npm/dw/jwt-decode)
@@ -67,16 +67,17 @@ Not adhering to the format will result in a `InvalidTokenError` with one of the
 - `Invalid token specified: must be a string` => the token passed was not a string, this library only works on strings. 
 - `Invalid token specified: missing part #` => this probably means you are missing a dot (`.`) in the token 
 - `Invalid token specified: invalid base64 for part #` => the part could not be base64 decoded (the message should contain the error the base64 decoder gave)
-- `Invalid token specified: invalid json for part #` => the part was correctly base64 decoded, however the decoded value was not valid json (the message should contain the error the json parser gave)
+- `Invalid token specified: invalid json for part #` => the part was correctly base64 decoded, however, the decoded value was not valid JSON (the message should contain the error the JSON parser gave)
 
 #### Use with typescript
 
-The `jwt_decode` function will return an `unknown` type by default. You can specify what the expected return type should be by passing a type argument to the `jwt_decode` function.
+The return type of the `jwt_decode` function is determined by the `header` property of the object passed as the second argument. If omitted (or set to false), it'll use `JwtPayload`, when true it will use `JwtHeader`. 
+If needed, you can specify what the expected return type should be by passing a type argument to the `jwt_decode` function.
 
-The package also exports types for a `JwtHeader` and `JwtPayload` with some default claims. You can either use them as-is, or extend them to include non standard claims or properties.
+You can extend both `JwtHeader` and `JwtPayload` to include non-standard claims or properties.
 
 ```typescript
-import jwtDecode, { JwtPayload } from "jwt-decode";
+import jwtDecode from "jwt-decode";
 
 const token: string = "eyJhsw5c";
 const decoded = jwtDecode<JwtPayload>(token); // Returns with the JwtPayload type
@@ -91,7 +92,7 @@ const jwt_decode = require('jwt-decode');
 
 #### Include with a script tag
 
-Copy the file `jwt-decode.js` from the `build/` folder to your project somewhere, then include like so:
+Copy the file `jwt-decode.js` from the `build/` folder to your project somewhere, then include it like so:
 
 ```html
 <script src="jwt-decode.js"></script>

jest.config.ts

@@ -0,0 +1,25 @@
+import { type JestConfigWithTsJest } from "ts-jest";
+
+const jestConfig: JestConfigWithTsJest = {
+  rootDir: "./",
+  moduleFileExtensions: ["ts", "js"],
+  testMatch: ["**/test/**/*.test.ts", "**/test/tests.ts"],
+  coverageProvider: "v8",
+  coveragePathIgnorePatterns: ["/node_modules/", "./test"],
+  extensionsToTreatAsEsm: [".ts"],
+  reporters: [
+    "default",
+    ["jest-junit", { outputDirectory: "test-results/jest" }],
+  ],
+  coverageReporters: ["lcov", "text", "text-summary"],
+  setupFiles: [],
+  preset: "ts-jest/presets/default-esm",
+  transform: {
+    "^.+\\.ts?$": [
+      "ts-jest",
+      { useESM: true, tsconfig: "./tsconfig.test.json" },
+    ],
+  },
+};
+
+export default jestConfig;

lib/base64_url_decode.js → lib/base64_url_decode.ts

@@ -1,9 +1,7 @@
-import atob from "./atob";
-
-function b64DecodeUnicode(str) {
+function b64DecodeUnicode(str: string) {
     return decodeURIComponent(
         atob(str).replace(/(.)/g, function(m, p) {
-            var code = p.charCodeAt(0).toString(16).toUpperCase();
+            let code = p.charCodeAt(0).toString(16).toUpperCase();
             if (code.length < 2) {
                 code = "0" + code;
             }
@@ -12,8 +10,8 @@ function b64DecodeUnicode(str) {
     );
 }
 
-export default function(str) {
-    var output = str.replace(/-/g, "+").replace(/_/g, "/");
+export default function(str: string) {
+    let output = str.replace(/-/g, "+").replace(/_/g, "/");
     switch (output.length % 4) {
         case 0:
             break;

index.d.ts → lib/global.ts

@@ -1,5 +1,3 @@
-export class InvalidTokenError extends Error {}
-
 export interface JwtDecodeOptions {
   header?: boolean;
 }
@@ -19,8 +17,3 @@ export interface JwtPayload {
   iat?: number;
   jti?: string;
 }
-
-export default function jwtDecode<T = unknown>(
-  token: string,
-  options?: JwtDecodeOptions
-): T;

lib/index.cjs.js → lib/index.cjs.ts

@@ -1,6 +1,6 @@
 import jwtDecode, { InvalidTokenError } from "./index";
 
-const wrapper = jwtDecode;
+const wrapper = jwtDecode as any;
 wrapper.default = jwtDecode;
 wrapper.InvalidTokenError = InvalidTokenError;
 export default wrapper;