Add comments

Author: bcbogdan

lib/ts/recipe/session/framework/nextjs.ts

@@ -2,8 +2,10 @@ import jose from "jose";
 
 import SuperTokens from "../../../superTokens";
 
+import { isCookiesStore } from "./types";
+
+import type { CookiesStore, CookiesObject, GetServerSidePropsReturnValue } from "./types";
 import type { AccessTokenPayload, LoadedSessionContext } from "../types";
-import { CookiesStore, CookiesObject, GetServerSidePropsReturnValue, isCookiesStore } from "./types";
 
 const COOKIE_ACCESS_TOKEN_NAME = "sAccessToken";
 const HEADER_ACCESS_TOKEN_NAME = "st-access-token";
@@ -16,10 +18,21 @@ type SSRSessionState =
     | "tokens-do-not-match"
     | "tokens-match";
 
+/**
+ * Function signature for usage with Next.js App Router
+ * @param cookies - The cookies store exposed by next/headers (await cookies())
+ * @param redirect - The redirect function exposed by next/navigation
+ * @returns The session context value or directly redirect the user to either the login page or the refresh API
+ **/
 export async function getSSRSession(
     cookies: CookiesStore,
     redirect: (url: string) => never
 ): Promise<LoadedSessionContext>;
+/**
+ * Function signature for usage with getServerSideProps/Next.js Pages Router
+ * @param cookies - The cookie object that can be extracted from context.req.headers.cookie
+ * @returns A props object with the session context value or a redirect object
+ **/
 export async function getSSRSession(cookies: CookiesObject): Promise<GetServerSidePropsReturnValue>;
 export async function getSSRSession(
     cookies: CookiesObject | CookiesStore,