feat: Add getInitialSessionAuthContext to compute SessionAuth context

lib/ts/nextjs.ts

@@ -20,7 +20,7 @@ import {
     middleware,
     errorHandler as customErrorHandler,
 } from "./framework/custom";
-import { HTTPMethod } from "./types";
+import { HTTPMethod, SSRSessionContextType } from "./types";
 import Session, { SessionContainer, VerifySessionOptions } from "./recipe/session";
 import SessionRecipe from "./recipe/session/recipe";
 import { getToken } from "./recipe/session/cookieAndHeaders";
@@ -230,6 +230,24 @@ export default class NextJS {
         return result;
     }
 
+    static async getInitialSessionAuthContext(session: SessionContainer | undefined): Promise<SSRSessionContextType> {
+        const initialContext: SSRSessionContextType = {
+            isContextFromSSR: true,
+            loading: false,
+            doesSessionExist: false,
+            accessTokenPayload: {},
+            userId: "",
+        };
+
+        if (session) {
+            initialContext.doesSessionExist = true;
+            initialContext.accessTokenPayload = await session.getAccessTokenPayload();
+            initialContext.userId = await session.getUserId();
+        }
+
+        return initialContext;
+    }
+
     static async withSession<NextRequest extends PartialNextRequest, NextResponse extends Response>(
         req: NextRequest,
         handler: (error: Error | undefined, session: SessionContainer | undefined) => Promise<NextResponse>,
@@ -405,5 +423,6 @@ export default class NextJS {
 export let superTokensNextWrapper = NextJS.superTokensNextWrapper;
 export let getAppDirRequestHandler = NextJS.getAppDirRequestHandler;
 export let getSSRSession = NextJS.getSSRSession;
+export let getInitialSessionAuthContext = NextJS.getInitialSessionAuthContext;
 export let withSession = NextJS.withSession;
 export let withPreParsedRequestResponse = NextJS.withPreParsedRequestResponse;

lib/ts/types.ts

@@ -113,3 +113,11 @@ export type User = {
     // the recipeUserId can be converted to string from the RecipeUserId object type.
     toJson: () => any;
 };
+
+export type SSRSessionContextType = {
+    isContextFromSSR: true;
+    loading: false;
+    doesSessionExist: boolean;
+    accessTokenPayload: any;
+    userId: string;
+};

test/nextjs.test.js

@@ -26,6 +26,7 @@ const {
     superTokensNextWrapper,
     withSession,
     getSSRSession,
+    getInitialSessionAuthContext,
     getAppDirRequestHandler,
     withPreParsedRequestResponse,
 } = require("../lib/build/nextjs");
@@ -774,6 +775,38 @@ describe(`Next.js App Router: ${printPath("[test/nextjs.test.js]")}`, function (
         assert.equal(sessionContainer.hasToken, true);
     });
 
+    it("getInitialSessionAuthContext", async function () {
+        const tokens = await getValidTokensAfterSignup({ tokenTransferMethod: "header" });
+
+        const authenticatedRequest = new NextRequest("http://localhost:3000/api/get-user", {
+            headers: {
+                Authorization: `Bearer ${tokens.access}`,
+            },
+        });
+
+        let sessionContainer = await getSSRSession(authenticatedRequest.cookies.getAll(), authenticatedRequest.headers);
+
+        let initialSessionAuthContext = await getInitialSessionAuthContext(sessionContainer.session);
+
+        assert.equal(initialSessionAuthContext.loading, false);
+        assert.equal(initialSessionAuthContext.isContextFromSSR, true);
+        assert.equal(initialSessionAuthContext.doesSessionExist, true);
+        assert.equal(initialSessionAuthContext.userId, process.env.user);
+        assert.notEqual(initialSessionAuthContext.accessTokenPayload, {});
+
+        const unAuthenticatedRequest = new NextRequest("http://localhost:3000/api/get-user");
+
+        sessionContainer = await getSSRSession(unAuthenticatedRequest.cookies.getAll(), unAuthenticatedRequest.headers);
+
+        initialSessionAuthContext = await getInitialSessionAuthContext(sessionContainer.session);
+
+        assert.equal(initialSessionAuthContext.loading, false);
+        assert.equal(initialSessionAuthContext.isContextFromSSR, true);
+        assert.equal(initialSessionAuthContext.doesSessionExist, false);
+        assert.equal(initialSessionAuthContext.userId, "");
+        assert.deepEqual(initialSessionAuthContext.accessTokenPayload, {});
+    });
+
     it("withSession", async function () {
         const tokens = await getValidTokensAfterSignup({ tokenTransferMethod: "header" });