codeforlife 2.7.0 → 2.7.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.7.2](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v2.7.1...v2.7.2) (2025-08-15)
+
+
+### Bug Fixes
+
+* comment ([1364251](https://github.com/ocadotechnology/codeforlife-package-javascript/commit/13642516aea7a89d7c3e24e7813391686587447f))
+
+## [2.7.1](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v2.7.0...v2.7.1) (2025-08-15)
+
+
+### Bug Fixes
+
+* optionally set useSessionMetadata ([22c5253](https://github.com/ocadotechnology/codeforlife-package-javascript/commit/22c525341badef6f13fe9adc1489d033792d2340))
+
 # [2.7.0](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v2.6.17...v2.7.0) (2025-08-15)
 
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "codeforlife",
   "description": "Common frontend code",
   "private": false,
-  "version": "2.7.0",
+  "version": "2.7.2",
   "type": "module",
   "scripts": {
     "cli": "VITE_CONFIG=./vite.config.ts ../scripts/frontend $@"

package/src/api/endpoints/session.ts

@@ -2,7 +2,6 @@ import { type EndpointBuilder, type Api } from "@reduxjs/toolkit/query/react"
 
 import { login, logout } from "../../slices/session"
 
-export type ExchangeOAuth2CodeResult = null
 export type ExchangeOAuth2CodeArg = {
   code: string
   code_verifier: string

package/src/hooks/auth.tsx

@@ -15,10 +15,7 @@ import {
   type OAuth2RequestCodeUrlSearchParams,
   type OAuth2ReceiveCodeUrlSearchParams,
 } from "../utils/auth"
-import {
-  type ExchangeOAuth2CodeResult,
-  type ExchangeOAuth2CodeArg,
-} from "../api/endpoints/session"
+import { type ExchangeOAuth2CodeArg } from "../api/endpoints/session"
 import { useSearchParams, useLocation, useNavigate } from "./router"
 import { SESSION_METADATA_COOKIE_NAME } from "../settings"
 import { selectIsLoggedIn } from "../slices/session"
@@ -34,14 +31,25 @@ export interface SessionMetadata {
   otp_bypass_token_exists: boolean
 }
 
-export function useSessionMetadata(): SessionMetadata | undefined {
+export function useSessionMetadata<T = SessionMetadata>(
+  cookieName = SESSION_METADATA_COOKIE_NAME,
+): T | undefined {
   return useSelector(selectIsLoggedIn)
-    ? (JSON.parse(
-        Cookies.get(SESSION_METADATA_COOKIE_NAME)!,
-      ) as SessionMetadata)
+    ? (JSON.parse(Cookies.get(cookieName)!) as T)
     : undefined
 }
 
+/**
+ * A utility function to predefine a useSessionMetadata hook.
+ * @param cookieName The name of the session metadata cookie.
+ * @returns An object containing the session metadata.
+ */
+useSessionMetadata.predefine = <SessionMetadata,>(
+  cookieName = SESSION_METADATA_COOKIE_NAME,
+) => {
+  return () => useSessionMetadata<SessionMetadata>(cookieName)
+}
+
 export type UseSessionChildrenFunction<Required extends boolean> = (
   metadata: Required extends true
     ? SessionMetadata
@@ -198,7 +206,7 @@ export function useOAuth2CodeChallenge(
   return [_codeChallenge, resetCodeChallenge]
 }
 
-export interface UseOAuth2KwArgs<ResultType = ExchangeOAuth2CodeResult> {
+interface BaseUseOAuth2KwArgs<SessionMetadata> {
   provider: string
   authUri: string
   clientId: string
@@ -207,15 +215,24 @@ export interface UseOAuth2KwArgs<ResultType = ExchangeOAuth2CodeResult> {
   responseType?: "code"
   accessType?: "offline"
   prompt?: string
-  useLoginMutation: TypedUseMutation<ResultType, ExchangeOAuth2CodeArg, any>
-  onCreateSession: (result: ResultType) => void
+  useLoginMutation: TypedUseMutation<
+    SessionMetadata,
+    ExchangeOAuth2CodeArg,
+    any
+  >
+  onCreateSession: (result: SessionMetadata) => void
   onRetrieveSession: (metadata: SessionMetadata) => void
 }
 
+interface UseOAuth2KwArgs<SessionMetadata>
+  extends BaseUseOAuth2KwArgs<SessionMetadata> {
+  useSessionMetadata: () => SessionMetadata | undefined
+}
+
 export type OAuth2 = [string, OAuth2RequestCodeUrlSearchParams] | []
 
 // https://datatracker.ietf.org/doc/html/rfc7636
-export function useOAuth2<ResultType = ExchangeOAuth2CodeResult>({
+function _useOAuth2<SessionMetadata>({
   provider,
   authUri,
   clientId,
@@ -224,10 +241,11 @@ export function useOAuth2<ResultType = ExchangeOAuth2CodeResult>({
   responseType = "code",
   accessType = "offline",
   prompt,
+  useSessionMetadata,
   useLoginMutation,
   onCreateSession,
   onRetrieveSession,
-}: UseOAuth2KwArgs<ResultType>): OAuth2 {
+}: UseOAuth2KwArgs<SessionMetadata>): OAuth2 {
   const [state, resetState] = useOAuth2State(provider)
   const [
     {
@@ -280,7 +298,7 @@ export function useOAuth2<ResultType = ExchangeOAuth2CodeResult>({
       // ...and the page's state contains the stored state...
       locationState.state === state &&
       // ...and the login endpoint was not called with the current values or has
-      // not returned and error...
+      // not returned an error...
       (loginArgs.code !== locationState.code ||
         loginArgs.code_verifier !== codeVerifier ||
         loginArgs.redirect_uri !== redirectUri ||
@@ -362,3 +380,16 @@ export function useOAuth2<ResultType = ExchangeOAuth2CodeResult>({
 
   return []
 }
+
+export const useOAuth2: {
+  <SessionMetadata>(kwargs: UseOAuth2KwArgs<SessionMetadata>): OAuth2
+  (kwargs: BaseUseOAuth2KwArgs<SessionMetadata>): OAuth2
+} = <_SessionMetadata,>(
+  kwargs:
+    | UseOAuth2KwArgs<_SessionMetadata>
+    | BaseUseOAuth2KwArgs<SessionMetadata>,
+): OAuth2 => {
+  return "useSessionMetadata" in kwargs
+    ? _useOAuth2(kwargs)
+    : _useOAuth2({ ...kwargs, useSessionMetadata })
+}