Merge pull request #2 from kinde-oss/feat/add-header-decode

feat: add token complete check and option to decode the header part o…

Author: DanielRivers

.gitignore

@@ -22,6 +22,4 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
-coverage
-
-api_
+coverage

.prettierignore

@@ -1,3 +1,4 @@
 generated
 pnpm-lock.yaml
-CHANGELOG.md
+CHANGELOG.md
+.github

eslint.config.js

@@ -0,0 +1,22 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+import jsdoc from "eslint-plugin-jsdoc";
+
+export default [
+  {
+    ignores: ["dist"],
+  },
+  {
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },
+    plugins: {
+      jsdoc,
+    },
+    rules: {
+      "jsdoc/require-description": "warn",
+    },
+  },
+  jsdoc.configs["flat/recommended"],
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

lib/main.test.ts

@@ -1,21 +1,62 @@
 // setToken.test.ts
-import { jwtDecoder } from "./main.ts";
-import { describe, it, expect } from "vitest";
+import { JWTHeader, TokenPart, jwtDecoder, type JWTDecoded } from "./main.ts";
+import { describe, it, expect, expectTypeOf } from "vitest";
 
 describe("jwtDecode", () => {
   it("decode John Balázs", () => {
     const decodedToken = jwtDecoder(
       "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gQmFsw6F6cyIsImlhdCI6MTUxNjIzOTAyMn0.rpQt1WOpF4h5SP9iBBj2NfYvKQLuCI3lHSvxSS3eexs",
     );
+
+    expectTypeOf(decodedToken).toEqualTypeOf<JWTDecoded | null>();
     expect(decodedToken).toEqual({
       sub: "1234567890",
       name: "John Balázs",
       iat: 1516239022,
     });
   });
 
+  it("incomplete token", () => {
+    const decodedToken = jwtDecoder(
+      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gQmFsw6F6cyIsImlhdCI6MTUxNjIzOTAyMn0",
+    );
+
+    expectTypeOf(decodedToken).toEqualTypeOf<JWTDecoded | null>();
+    expect(decodedToken).toEqual(null);
+  });
+
+  it("decode header", () => {
+    const decodedToken = jwtDecoder(
+      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gQmFsw6F6cyIsImlhdCI6MTUxNjIzOTAyMn0.rpQt1WOpF4h5SP9iBBj2NfYvKQLuCI3lHSvxSS3eexs",
+      TokenPart.header,
+    );
+
+    expectTypeOf(decodedToken).toEqualTypeOf<JWTHeader | null>();
+
+    expect(decodedToken).toEqual({
+      alg: "HS256",
+      typ: "JWT",
+    });
+  });
+
   it("return null when nothing defined", () => {
     const decodedToken = jwtDecoder();
     expect(decodedToken).toBeNull();
   });
+
+  it("extended type", () => {
+    const decodedToken = jwtDecoder<
+      JWTDecoded & {
+        roles: string[];
+      }
+    >("");
+
+    expectTypeOf(decodedToken).toEqualTypeOf<
+      | (JWTDecoded & {
+          roles: string[];
+        })
+      | null
+    >();
+    expect(decodedToken).toBeNull();
+  });
 });

lib/main.ts

@@ -1,4 +1,4 @@
-export type JWTDecoded = {
+type JWTDecoded = {
   aud: string[];
   azp: string;
   exp: number;
@@ -9,31 +9,66 @@ export type JWTDecoded = {
   sub: string;
 };
 
+type JWTHeader = {
+  alg: string;
+  typ: string;
+};
+
+enum TokenPart {
+  header = 0,
+  body = 1,
+}
+
+type JwtDecoderResult<
+  T,
+  P extends TokenPart = TokenPart.body,
+> = P extends TokenPart.header ? JWTHeader : T | null;
+
 /**
  * Decode JWT token
- * @param token - JWT token to be decoded
- * @returns - Decoded JWT token
- *
+ * @param {string} token - JWT token to be decoded
+ * @param {TokenPart} [part] - Part of the token to be decoded (header, body, or signature)
+ * @returns {object} - Decoded JWT token as an object
  * @example
- * jwtDecode("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
+ * jwtDecode("[TOKEN]")
  * Returns:
  *  {
  *    sub: "1234567890",
  *    name: "John Doe",
  *    iat: 1516239022
  *  }
+ *
+ * jwtDecode("[TOKEN]", TokenPart.header)
+ * Returns:
+ *  {
+ *    alg: "HS256",
+ *    typ: "JWT"
+ *  }
  */
-export const jwtDecoder = <T = JWTDecoded>(token?: string): T | null => {
+function jwtDecoder<T = JWTDecoded, P extends TokenPart = TokenPart.body>(
+  token?: string,
+  part?: P,
+): JwtDecoderResult<T, P> | null {
   if (!token) {
     return null;
   }
-  const base64Url = token.split(".")[1];
+
+  const tokenSplit = token.split(".");
+  if (tokenSplit.length !== 3) {
+    return null;
+  }
+
+  const base64Url = tokenSplit[part ?? TokenPart.body];
   const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+
   const jsonPayload = decodeURIComponent(
     atob(base64)
       .split("")
       .map((c) => "%" + ("00" + c.charCodeAt(0).toString(16)).slice(-2))
       .join(""),
   );
+
   return JSON.parse(jsonPayload);
-};
+}
+
+export { jwtDecoder, type JWTDecoded, type JWTHeader, TokenPart };

package.json

@@ -15,19 +15,25 @@
     "preview": "vite preview",
     "test": "vitest",
     "test:coverage": "vitest --coverage",
-    "lint": "prettier --check .",
-    "lint:fix": "prettier --write ."
+    "lint": "eslint && prettier --check .",
+    "lint:fix": "eslint --fix && prettier --write ."
   },
   "module": "dist/jwt-decoder.js",
   "main": "dist/jwt-decoder.cjs",
   "types": "dist/main.d.ts",
   "devDependencies": {
+    "@eslint/js": "^9.4.0",
     "@types/node": "^20.12.7",
     "@vitest/coverage-v8": "^1.5.2",
+    "eslint": "9.x",
+    "eslint-plugin-jsdoc": "^48.2.9",
+    "globals": "^15.4.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5",
+    "typescript-eslint": "^7.12.0",
     "vite": "^5.2.10",
     "vite-plugin-dts": "^3.9.0",
     "vitest": "^1.5.2"
-  }
+  },
+  "packageManager": "[email protected]+sha256.2df78e65d433d7693b9d3fbdaf431b2d96bb4f96a2ffecd51a50efe16e50a6a8"
 }