feat: add activeStorage, getDecodedToken and getUserOrganisations

Author: DanielRivers

lib/utils/base64UrlEncode.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Encodes the provided ArrayBuffer string to base-64 format.
  * @param str String to encode
  * @returns encoded string
  */

lib/utils/token/getDecodedToken.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, beforeEach } from "vitest";
+import { getDecodedToken } from "./getDecodedToken";
+import { MemoryStorage, StorageKeys } from "../../sessionManager";
+import { setActiveStorage } from ".";
+import { createMockAccessToken } from "./testUtils";
+
+describe("getDecodedToken", () => {
+  it("error when no active storage is set", () => {
+    expect(() => getDecodedToken("idToken")).rejects.toThrowError(
+      "Session manager is not initialized",
+    );
+  });
+});
+
+describe("getDecodedToken", () => {
+  beforeEach(() => {
+    setActiveStorage(new MemoryStorage());
+  });
+  it("error when no active storage is set", async () => {
+    const idToken = await getDecodedToken("idToken");
+    expect(idToken).toBe(null);
+  });
+});
+
+describe("getDecodedToken idToken", () => {
+  beforeEach(() => {
+    const storage = new MemoryStorage();
+    setActiveStorage(storage);
+    storage.setSessionItem(StorageKeys.idToken, createMockAccessToken());
+  });
+  it("error when no active storage is set", async () => {
+    const idToken = await getDecodedToken("idToken");
+    if (idToken === null) {
+      throw new Error("idToken is null");
+    }
+    expect(idToken.org_code).toBe("org_123456789");
+  });
+});
+
+describe("getDecodedToken accessToken", () => {
+  beforeEach(() => {
+    const storage = new MemoryStorage();
+    setActiveStorage(storage);
+    storage.setSessionItem(StorageKeys.accessToken, createMockAccessToken());
+  });
+  it("error when no active storage is set", async () => {
+    const accessToken = await getDecodedToken("accessToken");
+    if (accessToken === null) {
+      throw new Error("idToken is null");
+    }
+    expect(accessToken.org_code).toBe("org_123456789");
+  });
+});

lib/utils/token/getDecodedToken.ts

@@ -0,0 +1,31 @@
+import { jwtDecoder, JWTDecoded } from "@kinde/jwt-decoder";
+import { getActiveStorage } from ".";
+import { StorageKeys } from "../../sessionManager";
+/**
+ *
+ * @param tokenType Type of token to decode
+ * @returns { Promise<JWTDecoded | null> }
+ */
+export const getDecodedToken = async <
+  T = JWTDecoded & {
+    permissions: string[];
+    org_code: string;
+  },
+>(
+  tokenType: "accessToken" | "idToken" = "accessToken",
+): Promise<T | null> => {
+  const activeStorage = getActiveStorage();
+  if (!activeStorage) {
+    throw new Error("Session manager is not initialized");
+  }
+
+  const token = (await activeStorage.getSessionItem(
+    tokenType === "accessToken" ? StorageKeys.accessToken : StorageKeys.idToken,
+  )) as string;
+  console.log("token", token);
+  if (!token) {
+    return null;
+  }
+
+  return jwtDecoder<T>(token);
+};

lib/utils/token/getUserOrganistaions.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, beforeEach } from "vitest";
+import { MemoryStorage, StorageKeys } from "../../sessionManager";
+import { setActiveStorage } from ".";
+import { createMockAccessToken } from "./testUtils";
+import { getUserOrganizations } from "./getUserOrganistaions";
+
+describe("getDecodedToken idToken", () => {
+  beforeEach(() => {
+    const storage = new MemoryStorage();
+    setActiveStorage(storage);
+    storage.setSessionItem(
+      StorageKeys.idToken,
+      createMockAccessToken({ org_codes: ["org_123456789"] }),
+    );
+  });
+  it("error when no active storage is set", async () => {
+    const idToken = await getUserOrganizations();
+
+    expect(idToken).toStrictEqual(["org_123456789"]);
+  });
+});
+
+describe("getDecodedToken idToken", () => {
+  beforeEach(() => {
+    const storage = new MemoryStorage();
+    setActiveStorage(storage);
+    storage.setSessionItem(
+      StorageKeys.idToken,
+      createMockAccessToken({ org_codes: ["org_123456789", "org_1234567"] }),
+    );
+  });
+  it("error when no active storage is set", async () => {
+    const idToken = await getUserOrganizations();
+
+    expect(idToken).toStrictEqual(["org_123456789", "org_1234567"]);
+  });
+});
+
+describe("getDecodedToken idToken", () => {
+  beforeEach(() => {
+    const storage = new MemoryStorage();
+    setActiveStorage(storage);
+    storage.setSessionItem(
+      StorageKeys.idToken,
+      createMockAccessToken({ org_codes: null }),
+    );
+  });
+  it("error when no active storage is set", async () => {
+    const idToken = await getUserOrganizations();
+
+    expect(idToken).toStrictEqual(null);
+  });
+});

lib/utils/token/getUserOrganistaions.ts

@@ -0,0 +1,15 @@
+import { getDecodedToken } from "./getDecodedToken";
+
+/**
+ * Gets all the code of the organizations the user belongs to.
+ * @returns { Promise<string[] | null> }
+ */
+export const getUserOrganizations = async (): Promise<string[] | null> => {
+  return (
+    (
+      await getDecodedToken<{
+        org_codes: string[];
+      }>("idToken")
+    )?.org_codes || null
+  );
+};

lib/utils/token/index.ts

@@ -0,0 +1,14 @@
+import { SessionManager } from "../../sessionManager"; // Replace 'path/to/SessionManager' with the actual path to the SessionManager module
+
+const storage = {
+  value: null as SessionManager | null,
+};
+
+export const setActiveStorage = (store: SessionManager) => {
+  storage.value = store;
+  console.log("store", store);
+};
+
+export const getActiveStorage = () => {
+  return storage.value;
+};

lib/utils/token/testUtils/index.ts

@@ -0,0 +1,39 @@
+import { createHmac } from "crypto";
+
+export const createMockAccessToken = (values = {}) => {
+  const header = {
+    alg: "HS256", // Algorithm (HMAC with SHA-256)
+    typ: "JWT", // Type
+  };
+  const payload = {
+    aud: [],
+    azp: "b9da18c441b44d81bab3e8232de2e18d",
+    billing: {
+      has_payment_details: false,
+    },
+    exp: 1168335720000,
+    iat: 1168335720000,
+    iss: "https://kinde.com",
+    jti: "27daa125-2fb2-4e14-9270-742cd56e764b",
+    org_code: "org_123456789",
+    permissions: ["read:users", "read:competitions"],
+    scp: ["openid", "profile", "email", "offline"],
+    sub: "kp_cfcb1ae5b9254ad99521214014c54f43",
+    ...values,
+  };
+  const secretKey = "asecretkey";
+
+  // Encode header and payload as Base64URL
+  const encodedHeader = Buffer.from(JSON.stringify(header)).toString(
+    "base64url",
+  );
+  const encodedPayload = Buffer.from(JSON.stringify(payload)).toString(
+    "base64url",
+  );
+  // Create signature
+  const signature = createHmac("sha256", secretKey)
+    .update(`${encodedHeader}.${encodedPayload}`)
+    .digest("base64url");
+
+  return `${encodedHeader}.${encodedPayload}.${signature}`;
+};

package.json

@@ -31,8 +31,8 @@
     "@eslint/js": "^9.9.1",
     "@types/chrome": "^0.0.270",
     "@types/node": "^22.5.1",
-    "@vitest/coverage-v8": "^2.0.5",
     "@vitejs/plugin-react": "^4.3.1",
+    "@vitest/coverage-v8": "^2.0.5",
     "eslint": "^9.9.1",
     "globals": "^15.9.0",
     "prettier": "^3.3.3",
@@ -45,5 +45,8 @@
   "optionalDependencies": {
     "expo-secure-store": "*"
   },
-  "packageManager": "[email protected]+sha256.2df78e65d433d7693b9d3fbdaf431b2d96bb4f96a2ffecd51a50efe16e50a6a8"
+  "packageManager": "[email protected]+sha256.2df78e65d433d7693b9d3fbdaf431b2d96bb4f96a2ffecd51a50efe16e50a6a8",
+  "dependencies": {
+    "@kinde/jwt-decoder": "^0.2.0"
+  }
 }