@usehercules/auth 1.0.41 → 1.0.43
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/convex-react/index.mjs +16 -7
- package/dist/convex-react/index.mjs.map +1 -1
- package/dist/react/index.d.mts +1 -0
- package/dist/react/index.d.mts.map +1 -1
- package/dist/react/index.mjs +11 -3
- package/dist/react/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/convex-react/ConvexProviderWithHercules.test.tsx +196 -0
- package/src/convex-react/ConvexProviderWithHercules.tsx +21 -9
- package/src/react/use-auth.test.tsx +28 -0
- package/src/react/use-auth.ts +8 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { useCallback, useMemo } from "react";
|
|
1
|
+
import { useCallback, useMemo, useRef } from "react";
|
|
2
2
|
import { useAuth } from "react-oidc-context";
|
|
3
3
|
import { jsx } from "react/jsx-runtime";
|
|
4
4
|
import { ConvexProviderWithAuth } from "convex/react";
|
|
@@ -22,12 +22,21 @@ function ConvexProviderWithHerculesAuth({ children, client }) {
|
|
|
22
22
|
function useUseAuthFromHercules() {
|
|
23
23
|
const { isAuthenticated, user, isLoading, signinSilent } = useAuth();
|
|
24
24
|
const idToken = user?.id_token;
|
|
25
|
-
const
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
25
|
+
const inFlightRefresh = useRef(null);
|
|
26
|
+
const fetchAccessToken = useCallback(async ({ forceRefreshToken }) => {
|
|
27
|
+
if (!forceRefreshToken) return idToken ?? null;
|
|
28
|
+
if (inFlightRefresh.current) return inFlightRefresh.current;
|
|
29
|
+
const refresh = (async () => {
|
|
30
|
+
try {
|
|
31
|
+
return (await signinSilent())?.id_token ?? null;
|
|
32
|
+
} catch {
|
|
33
|
+
return null;
|
|
34
|
+
} finally {
|
|
35
|
+
inFlightRefresh.current = null;
|
|
36
|
+
}
|
|
37
|
+
})();
|
|
38
|
+
inFlightRefresh.current = refresh;
|
|
39
|
+
return refresh;
|
|
31
40
|
}, [idToken, signinSilent]);
|
|
32
41
|
return useMemo(() => ({
|
|
33
42
|
isLoading,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/convex-react/ConvexProviderWithHercules.tsx"],"sourcesContent":["\"use client\";\n\nimport type { ReactNode } from \"react\";\nimport { ConvexProviderWithAuth, type ConvexReactClient } from \"convex/react\";\nimport { useCallback, useMemo } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\nimport type { HerculesAuthProvider } from \"../react/HerculesAuthProvider\";\n\n/**\n * A wrapper React component which provides a {@link ConvexReactClient}\n * authenticated with Hercules Auth.\n *\n * It must be wrapped by a configured `{@link HerculesAuthProvider}`.\n *\n * @public\n */\nexport function ConvexProviderWithHerculesAuth({\n children,\n client,\n}: {\n children: ReactNode;\n client: ConvexReactClient;\n}) {\n return (\n <ConvexProviderWithAuth client={client} useAuth={useUseAuthFromHercules}>\n {children}\n </ConvexProviderWithAuth>\n );\n}\n\nfunction useUseAuthFromHercules() {\n const { isAuthenticated, user, isLoading, signinSilent } = useAuth();\n const idToken = user?.id_token;\n const fetchAccessToken = useCallback(\n async ({ forceRefreshToken
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/convex-react/ConvexProviderWithHercules.tsx"],"sourcesContent":["\"use client\";\n\nimport type { ReactNode } from \"react\";\nimport { ConvexProviderWithAuth, type ConvexReactClient } from \"convex/react\";\nimport { useCallback, useMemo, useRef } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\nimport type { HerculesAuthProvider } from \"../react/HerculesAuthProvider\";\n\n/**\n * A wrapper React component which provides a {@link ConvexReactClient}\n * authenticated with Hercules Auth.\n *\n * It must be wrapped by a configured `{@link HerculesAuthProvider}`.\n *\n * @public\n */\nexport function ConvexProviderWithHerculesAuth({\n children,\n client,\n}: {\n children: ReactNode;\n client: ConvexReactClient;\n}) {\n return (\n <ConvexProviderWithAuth client={client} useAuth={useUseAuthFromHercules}>\n {children}\n </ConvexProviderWithAuth>\n );\n}\n\nfunction useUseAuthFromHercules() {\n const { isAuthenticated, user, isLoading, signinSilent } = useAuth();\n const idToken = user?.id_token;\n\n const inFlightRefresh = useRef<Promise<string | null> | null>(null);\n\n const fetchAccessToken = useCallback(\n async ({ forceRefreshToken }: { forceRefreshToken: boolean }) => {\n if (!forceRefreshToken) {\n return idToken ?? null;\n }\n if (inFlightRefresh.current) {\n return inFlightRefresh.current;\n }\n const refresh = (async () => {\n try {\n const refreshed = await signinSilent();\n return refreshed?.id_token ?? null;\n } catch {\n return null;\n } finally {\n inFlightRefresh.current = null;\n }\n })();\n inFlightRefresh.current = refresh;\n return refresh;\n },\n [idToken, signinSilent],\n );\n return useMemo(\n () => ({\n isLoading,\n isAuthenticated,\n fetchAccessToken,\n }),\n [isLoading, isAuthenticated, fetchAccessToken],\n );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,SAAgB,+BAA+B,EAC7C,UACA,UAIC;AACD,QACE,oBAAC;EAA+B;EAAQ,SAAS;EAC9C;GACsB;;AAI7B,SAAS,yBAAyB;CAChC,MAAM,EAAE,iBAAiB,MAAM,WAAW,iBAAiB,SAAS;CACpE,MAAM,UAAU,MAAM;CAEtB,MAAM,kBAAkB,OAAsC,KAAK;CAEnE,MAAM,mBAAmB,YACvB,OAAO,EAAE,wBAAwD;AAC/D,MAAI,CAAC,kBACH,QAAO,WAAW;AAEpB,MAAI,gBAAgB,QAClB,QAAO,gBAAgB;EAEzB,MAAM,WAAW,YAAY;AAC3B,OAAI;AAEF,YADkB,MAAM,cAAc,GACpB,YAAY;WACxB;AACN,WAAO;aACC;AACR,oBAAgB,UAAU;;MAE1B;AACJ,kBAAgB,UAAU;AAC1B,SAAO;IAET,CAAC,SAAS,aAAa,CACxB;AACD,QAAO,eACE;EACL;EACA;EACA;EACD,GACD;EAAC;EAAW;EAAiB;EAAiB,CAC/C"}
|
package/dist/react/index.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts","../../src/react/use-auth.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAiBY,kBAAA;UAWK,sBAAA;;;iBAkBA;;;;AA7BL,UAiDK,qBAAA,CAjDa;EAWb,MAAA,EAwCP,kBAxC6B;EAsCtB,KAAA,EAAA,MAAA,GAAA,IAAA;EAqDD,SAAA,EAAA,OAAe;;;eApChB;ACrEf;AACE,iBDwGc,eAAA,CCxGd,OAAA,CAAA,EDyGS,sBCzGT,CAAA,ED0GC,qBC1GD;;;KADU,yBAAA,GAA4B,KACtC;wBAGsB,QAAQ;;;;UAkBtB,2BAAA;EDnBE,WAAA,ECoBG,WDpBe;AAW9B;AAsCA,cC1BM,2BD4BI,EC5BuB,MAAA,CAAA,OD2ClB,CC3CkB,2BD2CX,GAAA,IAAA,CAAA;AAoCN,iBC5EA,uBAAA,CAAA,CD6EL,EC7E4B,2BD8EpC;iBChEa,oBAAA;;;;;;GAMb,4BAAyB,kBAAA,CAAA,GAAA,CAAA;;;iBCrDZ,OAAA,CAAA;;;;;;;SAAO,mBAAA,CAAA,YAAA;EFOX,QAAA,CAAA,EAAA,MAAA;EAWK,aAAA,CAAA,EAAA,MAAA,GAAsB,IAAA,GAAA,SAkBtB;EAoBA,YAAA,CAAA,EAAA,MAAA,GAAqB,SAAA;EAqDtB,aAAA,CAAA,EAAA,MAAe;;;YE7GR,eAAA,CAAA,aAAA;EDIX,UAAA,CAAA,EAAA,MAAA;EACV,KAAA,CAAA,EAAA,OAAA;EADsC,SAAA,CAAA,EAAA,MAAA;CAIR;;;UEXf,gBAAA,SAAyB;iBACzB;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts","../../src/react/use-auth.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAiBY,kBAAA;UAWK,sBAAA;;;iBAkBA;;;;AA7BL,UAiDK,qBAAA,CAjDa;EAWb,MAAA,EAwCP,kBAxC6B;EAsCtB,KAAA,EAAA,MAAA,GAAA,IAAA;EAqDD,SAAA,EAAA,OAAe;;;eApChB;ACrEf;AACE,iBDwGc,eAAA,CCxGd,OAAA,CAAA,EDyGS,sBCzGT,CAAA,ED0GC,qBC1GD;;;KADU,yBAAA,GAA4B,KACtC;wBAGsB,QAAQ;;;;UAkBtB,2BAAA;EDnBE,WAAA,ECoBG,WDpBe;AAW9B;AAsCA,cC1BM,2BD4BI,EC5BuB,MAAA,CAAA,OD2ClB,CC3CkB,2BD2CX,GAAA,IAAA,CAAA;AAoCN,iBC5EA,uBAAA,CAAA,CD6EL,EC7E4B,2BD8EpC;iBChEa,oBAAA;;;;;;GAMb,4BAAyB,kBAAA,CAAA,GAAA,CAAA;;;iBCrDZ,OAAA,CAAA;;;;;;;SAAO,mBAAA,CAAA,YAAA;EFOX,QAAA,CAAA,EAAA,MAAA;EAWK,aAAA,CAAA,EAAA,MAAA,GAAsB,IAAA,GAAA,SAkBtB;EAoBA,YAAA,CAAA,EAAA,MAAA,GAAqB,SAAA;EAqDtB,aAAA,CAAA,EAAA,MAAe;;;YE7GR,eAAA,CAAA,aAAA;EDIX,UAAA,CAAA,EAAA,MAAA;EACV,KAAA,CAAA,EAAA,OAAA;EADsC,SAAA,CAAA,EAAA,MAAA;CAIR;;;UEXf,gBAAA,SAAyB;iBACzB;gBACD;;iBAGA,OAAA,CAAA,GAAW"}
|
package/dist/react/index.mjs
CHANGED
|
@@ -233,7 +233,7 @@ function useUser() {
|
|
|
233
233
|
function useAuth() {
|
|
234
234
|
const { userManager } = useHerculesAuthProvider();
|
|
235
235
|
const auth = useAuth$1();
|
|
236
|
-
const { signoutRedirect, removeUser } = auth;
|
|
236
|
+
const { signoutRedirect, removeUser, signinRedirect } = auth;
|
|
237
237
|
const signout = useCallback(async () => {
|
|
238
238
|
if (await userManager.metadataService.getEndSessionEndpoint() != null) await signoutRedirect();
|
|
239
239
|
else await removeUser();
|
|
@@ -242,12 +242,20 @@ function useAuth() {
|
|
|
242
242
|
signoutRedirect,
|
|
243
243
|
removeUser
|
|
244
244
|
]);
|
|
245
|
+
const signin = useCallback(async () => {
|
|
246
|
+
await signinRedirect();
|
|
247
|
+
}, [signinRedirect]);
|
|
245
248
|
return useMemo(() => {
|
|
246
249
|
return {
|
|
247
250
|
...auth,
|
|
248
|
-
signout
|
|
251
|
+
signout,
|
|
252
|
+
signin
|
|
249
253
|
};
|
|
250
|
-
}, [
|
|
254
|
+
}, [
|
|
255
|
+
auth,
|
|
256
|
+
signout,
|
|
257
|
+
signin
|
|
258
|
+
]);
|
|
251
259
|
}
|
|
252
260
|
|
|
253
261
|
//#endregion
|
package/dist/react/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["useAuth","hasAuthParams","DEFAULT_AUTH_CONFIG: Partial<HerculesAuthProviderProps>","ReactAuthProvider","useAuth","useOidcAuth"],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts","../../src/react/use-auth.ts"],"sourcesContent":["\"use client\";\n\nimport { useEffect, useState, useRef, useCallback } from \"react\";\nimport { useAuth, hasAuthParams } from \"react-oidc-context\";\nimport { ConvexError } from \"convex/values\";\nimport * as z from \"zod\";\n\nconst DEFAULT_TIMEOUT_MS = 20000; // 20 second timeout\n\nconst convexErrorSchema = z.object({\n message: z.string(),\n});\n\n/**\n * Authentication callback status states\n * @public\n */\nexport type AuthCallbackStatus =\n | \"processing-oauth\" // OIDC is processing the callback\n | \"waiting-backend\" // OIDC authenticated, waiting for backend\n | \"syncing\" // Syncing user with backend (e.g., creating user record)\n | \"success\" // All done\n | \"error\"; // Something went wrong\n\n/**\n * Options for the useAuthCallback hook\n * @public\n */\nexport interface UseAuthCallbackOptions {\n /**\n * Timeout in milliseconds before the callback is considered failed.\n * @default 20000\n */\n timeoutMs?: number;\n\n /**\n * Whether the backend (e.g., Convex) is authenticated.\n * The hook will wait for this to be true before calling onSync.\n */\n isBackendAuthenticated?: boolean;\n\n /**\n * Called when the backend is authenticated and ready to sync.\n * Use this to create/update the user in your backend.\n * Return a promise that resolves when sync is complete.\n */\n onSync?: () => Promise<void>;\n\n /**\n * Called when authentication is successful and sync is complete.\n * Use this to redirect the user.\n */\n onSuccess?: () => void;\n\n /**\n * Called when OIDC is not authenticated and there are no auth params.\n * This typically means the user navigated directly to the callback page.\n * Use this to redirect them away.\n */\n onNoAuthParams?: () => void;\n}\n\n/**\n * Return type for the useAuthCallback hook\n * @public\n */\nexport interface UseAuthCallbackResult {\n /** Current status of the auth callback flow */\n status: AuthCallbackStatus;\n\n /** Error message if status is \"error\" */\n error: string | null;\n\n /** Whether the auth callback is still in progress */\n isLoading: boolean;\n\n /** Whether the auth callback completed successfully */\n isSuccess: boolean;\n\n /** Whether there was an error */\n isError: boolean;\n\n /** Retry the authentication flow by redirecting to the auth provider */\n retry: () => Promise<void>;\n}\n\n/**\n * A hook for handling OAuth/OIDC callback flows.\n *\n * This hook manages the complete authentication callback lifecycle:\n * 1. Processing the OAuth callback from the identity provider\n * 2. Waiting for backend authentication (e.g., Convex)\n * 3. Syncing user data with your backend\n * 4. Handling success and error states\n *\n * @example\n * ```tsx\n * function AuthCallback() {\n * const navigate = useNavigate();\n * const { isAuthenticated } = useConvexAuth();\n * const updateUser = useMutation(api.users.updateCurrentUser);\n *\n * const { status, error, retry } = useAuthCallback({\n * isBackendAuthenticated: isAuthenticated,\n * onSync: () => updateUser(),\n * onSuccess: () => navigate(\"/\", { replace: true }),\n * onNoAuthParams: () => navigate(\"/\", { replace: true }),\n * });\n *\n * if (status === \"error\") {\n * return <ErrorState message={error} onRetry={retry} />;\n * }\n *\n * return <LoadingSpinner />;\n * }\n * ```\n *\n * @public\n */\nexport function useAuthCallback(\n options: UseAuthCallbackOptions = {},\n): UseAuthCallbackResult {\n const {\n timeoutMs = DEFAULT_TIMEOUT_MS,\n isBackendAuthenticated = true,\n onSync,\n onSuccess,\n onNoAuthParams,\n } = options;\n\n const {\n isLoading: isAuthLoading,\n isAuthenticated: isOidcAuthenticated,\n error: oidcError,\n signinRedirect,\n } = useAuth();\n\n const [status, setStatus] = useState<AuthCallbackStatus>(\"processing-oauth\");\n const [error, setError] = useState<string | null>(null);\n\n // Track mount state to prevent state updates after unmount\n const mountedRef = useRef(true);\n // Track if we had auth params on mount (won't change during lifecycle)\n const hadAuthParams = useRef(hasAuthParams());\n // Track if we've already started sync to prevent double execution\n const syncStarted = useRef(false);\n\n // Reset on mount, cleanup on unmount\n useEffect(() => {\n mountedRef.current = true;\n syncStarted.current = false;\n return () => {\n mountedRef.current = false;\n };\n }, []);\n\n // Timeout protection with state awareness\n useEffect(() => {\n if (status === \"success\" || status === \"error\") return;\n\n const timeout = setTimeout(() => {\n if (mountedRef.current) {\n setStatus(\"error\");\n setError(\"Authentication timed out. Please try again.\");\n }\n }, timeoutMs);\n\n return () => clearTimeout(timeout);\n }, [status, timeoutMs]);\n\n // Track OIDC authentication progression\n useEffect(() => {\n // Don't update if we're already past processing or in an error state\n if (status !== \"processing-oauth\" && status !== \"waiting-backend\") return;\n\n // Handle OIDC errors\n if (oidcError) {\n setStatus(\"error\");\n setError(oidcError.message || \"Authentication failed\");\n return;\n }\n\n // No auth params and not authenticated - navigated here directly\n if (!hadAuthParams.current && !isAuthLoading && !isOidcAuthenticated) {\n onNoAuthParams?.();\n return;\n }\n\n // OIDC is done loading and authenticated - move to waiting for backend\n if (\n !isAuthLoading &&\n isOidcAuthenticated &&\n status === \"processing-oauth\"\n ) {\n setStatus(\"waiting-backend\");\n return;\n }\n\n // OIDC finished but not authenticated (and we had auth params)\n // Wait a bit before declaring failure to avoid race conditions\n if (\n hadAuthParams.current &&\n !isAuthLoading &&\n !isOidcAuthenticated &&\n !oidcError &&\n status === \"processing-oauth\"\n ) {\n // Use a small delay to avoid race condition during OIDC state transitions\n const failureTimeout = setTimeout(() => {\n if (mountedRef.current && !isOidcAuthenticated) {\n setStatus(\"error\");\n setError(\"Authentication was cancelled or failed. Please try again.\");\n }\n }, 500);\n\n return () => clearTimeout(failureTimeout);\n }\n\n return;\n }, [isAuthLoading, isOidcAuthenticated, oidcError, status, onNoAuthParams]);\n\n // Sync with backend once backend is authenticated\n useEffect(() => {\n if (status !== \"waiting-backend\" || !isBackendAuthenticated) return;\n if (syncStarted.current) return;\n\n syncStarted.current = true;\n\n async function performSync() {\n if (!mountedRef.current) return;\n\n setStatus(\"syncing\");\n\n try {\n if (onSync) {\n await onSync();\n }\n\n if (mountedRef.current) {\n setStatus(\"success\");\n }\n } catch (err) {\n console.error(\"Auth callback sync failed:\", err);\n\n if (!mountedRef.current) return;\n\n if (err instanceof ConvexError) {\n // try to extract the error message from the convex error\n const parseResult = convexErrorSchema.safeParse(err.data);\n if (parseResult.success) {\n setStatus(\"error\");\n setError(parseResult.data.message);\n return;\n }\n }\n\n // Check if it's an authentication error\n const errorMessage =\n err instanceof Error\n ? err.message\n : \"Failed to complete authentication. Please try again.\";\n\n setStatus(\"error\");\n setError(errorMessage);\n }\n }\n\n performSync();\n }, [status, isBackendAuthenticated, onSync]);\n\n // Handle successful completion\n useEffect(() => {\n if (status === \"success\") {\n onSuccess?.();\n }\n }, [status, onSuccess]);\n\n // Retry handler\n const retry = useCallback(async () => {\n try {\n await signinRedirect();\n } catch (err) {\n console.error(\"Failed to restart auth:\", err);\n }\n }, [signinRedirect]);\n\n return {\n status,\n error,\n isLoading: status !== \"success\" && status !== \"error\",\n isSuccess: status === \"success\",\n isError: status === \"error\",\n retry,\n };\n}\n","\"use client\";\n\nimport { useState } from \"react\";\nimport {\n AuthProvider as ReactAuthProvider,\n type AuthProviderUserManagerProps,\n} from \"react-oidc-context\";\nimport {\n UserManager,\n WebStorageStateStore,\n type UserManagerSettings,\n} from \"oidc-client-ts\";\nimport { createContext, useContext } from \"react\";\n\nexport type HerculesAuthProviderProps = Omit<\n AuthProviderUserManagerProps,\n \"userManager\"\n> & {\n userManagerSettings?: Partial<UserManagerSettings>;\n authority: string;\n client_id: string;\n};\n\nfunction onSigninCallback() {\n window.history.replaceState({}, document.title, window.location.pathname);\n}\n\nfunction onSignoutCallback() {\n window.location.pathname = \"\";\n}\n\nconst DEFAULT_AUTH_CONFIG: Partial<HerculesAuthProviderProps> = {\n onSignoutCallback,\n onSigninCallback,\n};\n\ninterface HerculesAuthProviderContext {\n userManager: UserManager;\n}\n\nconst HerculesAuthProviderContext =\n createContext<HerculesAuthProviderContext | null>(null);\n\nexport function useHerculesAuthProvider() {\n const context = useContext(HerculesAuthProviderContext);\n if (!context) {\n throw new Error(\"HerculesAuthProviderContext not found\");\n }\n return context;\n}\n\n/**\n * A wrapper React component which provides a {@link ReactAuthProvider}\n * configured with Hercules Auth.\n *\n * @public\n */\nexport function HerculesAuthProvider({\n children,\n userManagerSettings,\n authority,\n client_id,\n ...props\n}: HerculesAuthProviderProps) {\n const [userManager] = useState(\n () =>\n new UserManager({\n ...userManagerSettings,\n authority: userManagerSettings?.authority ?? authority,\n client_id: userManagerSettings?.client_id ?? client_id,\n prompt: userManagerSettings?.prompt ?? \"select_account\",\n response_type: userManagerSettings?.response_type ?? \"code\",\n scope:\n userManagerSettings?.scope ?? \"openid profile email offline_access\",\n redirect_uri:\n userManagerSettings?.redirect_uri ??\n `${window.location.origin}/auth/callback`,\n post_logout_redirect_uri:\n userManagerSettings?.post_logout_redirect_uri ??\n window.location.origin,\n userStore:\n userManagerSettings?.userStore ??\n new WebStorageStateStore({ store: window.localStorage }),\n }),\n );\n\n return (\n <HerculesAuthProviderContext.Provider value={{ userManager }}>\n <ReactAuthProvider\n userManager={userManager}\n {...DEFAULT_AUTH_CONFIG}\n {...props}\n >\n {children}\n </ReactAuthProvider>\n </HerculesAuthProviderContext.Provider>\n );\n}\n","\"use client\";\n\nimport { useMemo } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\n\n/**\n * A hook that returns the current user if authenticated\n *\n * @public\n */\nexport function useUser() {\n const { user, isLoading, error, isAuthenticated } = useAuth();\n\n return useMemo(() => {\n const id = user?.profile.sub;\n const name = user?.profile.name;\n const email = user?.profile.email;\n const avatar = user?.profile.picture;\n return {\n ...(user ?? {}),\n id,\n name,\n email,\n avatar,\n isAuthenticated,\n isLoading,\n error,\n };\n }, [user, isAuthenticated, isLoading, error]);\n}\n","import {\n useAuth as useOidcAuth,\n type AuthContextProps as OidcAuthContextProps,\n} from \"react-oidc-context\";\nimport { useHerculesAuthProvider } from \"./HerculesAuthProvider\";\nimport { useCallback, useMemo } from \"react\";\n\nexport interface AuthContextProps extends OidcAuthContextProps {\n signout: () => Promise<void>;\n}\n\nexport function useAuth(): AuthContextProps {\n const { userManager } = useHerculesAuthProvider();\n const auth = useOidcAuth();\n\n const { signoutRedirect, removeUser } = auth;\n const signout = useCallback(async () => {\n const endpoint = await userManager.metadataService.getEndSessionEndpoint();\n if (endpoint != null) {\n await signoutRedirect();\n } else {\n await removeUser();\n }\n }, [userManager, signoutRedirect, removeUser]);\n\n return useMemo(() => {\n return {\n ...auth,\n signout,\n } satisfies AuthContextProps;\n }, [auth, signout]);\n}\n"],"mappings":";;;;;;;;AAOA,MAAM,qBAAqB;AAE3B,MAAM,oBAAoB,EAAE,OAAO,EACjC,SAAS,EAAE,QAAQ,EACpB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GF,SAAgB,gBACd,UAAkC,EAAE,EACb;CACvB,MAAM,EACJ,YAAY,oBACZ,yBAAyB,MACzB,QACA,WACA,mBACE;CAEJ,MAAM,EACJ,WAAW,eACX,iBAAiB,qBACjB,OAAO,WACP,mBACEA,WAAS;CAEb,MAAM,CAAC,QAAQ,aAAa,SAA6B,mBAAmB;CAC5E,MAAM,CAAC,OAAO,YAAY,SAAwB,KAAK;CAGvD,MAAM,aAAa,OAAO,KAAK;CAE/B,MAAM,gBAAgB,OAAOC,iBAAe,CAAC;CAE7C,MAAM,cAAc,OAAO,MAAM;AAGjC,iBAAgB;AACd,aAAW,UAAU;AACrB,cAAY,UAAU;AACtB,eAAa;AACX,cAAW,UAAU;;IAEtB,EAAE,CAAC;AAGN,iBAAgB;AACd,MAAI,WAAW,aAAa,WAAW,QAAS;EAEhD,MAAM,UAAU,iBAAiB;AAC/B,OAAI,WAAW,SAAS;AACtB,cAAU,QAAQ;AAClB,aAAS,8CAA8C;;KAExD,UAAU;AAEb,eAAa,aAAa,QAAQ;IACjC,CAAC,QAAQ,UAAU,CAAC;AAGvB,iBAAgB;AAEd,MAAI,WAAW,sBAAsB,WAAW,kBAAmB;AAGnE,MAAI,WAAW;AACb,aAAU,QAAQ;AAClB,YAAS,UAAU,WAAW,wBAAwB;AACtD;;AAIF,MAAI,CAAC,cAAc,WAAW,CAAC,iBAAiB,CAAC,qBAAqB;AACpE,qBAAkB;AAClB;;AAIF,MACE,CAAC,iBACD,uBACA,WAAW,oBACX;AACA,aAAU,kBAAkB;AAC5B;;AAKF,MACE,cAAc,WACd,CAAC,iBACD,CAAC,uBACD,CAAC,aACD,WAAW,oBACX;GAEA,MAAM,iBAAiB,iBAAiB;AACtC,QAAI,WAAW,WAAW,CAAC,qBAAqB;AAC9C,eAAU,QAAQ;AAClB,cAAS,4DAA4D;;MAEtE,IAAI;AAEP,gBAAa,aAAa,eAAe;;IAI1C;EAAC;EAAe;EAAqB;EAAW;EAAQ;EAAe,CAAC;AAG3E,iBAAgB;AACd,MAAI,WAAW,qBAAqB,CAAC,uBAAwB;AAC7D,MAAI,YAAY,QAAS;AAEzB,cAAY,UAAU;EAEtB,eAAe,cAAc;AAC3B,OAAI,CAAC,WAAW,QAAS;AAEzB,aAAU,UAAU;AAEpB,OAAI;AACF,QAAI,OACF,OAAM,QAAQ;AAGhB,QAAI,WAAW,QACb,WAAU,UAAU;YAEf,KAAK;AACZ,YAAQ,MAAM,8BAA8B,IAAI;AAEhD,QAAI,CAAC,WAAW,QAAS;AAEzB,QAAI,eAAe,aAAa;KAE9B,MAAM,cAAc,kBAAkB,UAAU,IAAI,KAAK;AACzD,SAAI,YAAY,SAAS;AACvB,gBAAU,QAAQ;AAClB,eAAS,YAAY,KAAK,QAAQ;AAClC;;;IAKJ,MAAM,eACJ,eAAe,QACX,IAAI,UACJ;AAEN,cAAU,QAAQ;AAClB,aAAS,aAAa;;;AAI1B,eAAa;IACZ;EAAC;EAAQ;EAAwB;EAAO,CAAC;AAG5C,iBAAgB;AACd,MAAI,WAAW,UACb,cAAa;IAEd,CAAC,QAAQ,UAAU,CAAC;CAGvB,MAAM,QAAQ,YAAY,YAAY;AACpC,MAAI;AACF,SAAM,gBAAgB;WACf,KAAK;AACZ,WAAQ,MAAM,2BAA2B,IAAI;;IAE9C,CAAC,eAAe,CAAC;AAEpB,QAAO;EACL;EACA;EACA,WAAW,WAAW,aAAa,WAAW;EAC9C,WAAW,WAAW;EACtB,SAAS,WAAW;EACpB;EACD;;;;;AC9QH,SAAS,mBAAmB;AAC1B,QAAO,QAAQ,aAAa,EAAE,EAAE,SAAS,OAAO,OAAO,SAAS,SAAS;;AAG3E,SAAS,oBAAoB;AAC3B,QAAO,SAAS,WAAW;;AAG7B,MAAMC,sBAA0D;CAC9D;CACA;CACD;AAMD,MAAM,8BACJ,cAAkD,KAAK;AAEzD,SAAgB,0BAA0B;CACxC,MAAM,UAAU,WAAW,4BAA4B;AACvD,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,QAAO;;;;;;;;AAST,SAAgB,qBAAqB,EACnC,UACA,qBACA,WACA,WACA,GAAG,SACyB;CAC5B,MAAM,CAAC,eAAe,eAElB,IAAI,YAAY;EACd,GAAG;EACH,WAAW,qBAAqB,aAAa;EAC7C,WAAW,qBAAqB,aAAa;EAC7C,QAAQ,qBAAqB,UAAU;EACvC,eAAe,qBAAqB,iBAAiB;EACrD,OACE,qBAAqB,SAAS;EAChC,cACE,qBAAqB,gBACrB,GAAG,OAAO,SAAS,OAAO;EAC5B,0BACE,qBAAqB,4BACrB,OAAO,SAAS;EAClB,WACE,qBAAqB,aACrB,IAAI,qBAAqB,EAAE,OAAO,OAAO,cAAc,CAAC;EAC3D,CAAC,CACL;AAED,QACE,oBAAC,4BAA4B;EAAS,OAAO,EAAE,aAAa;YAC1D,oBAACC;GACc;GACb,GAAI;GACJ,GAAI;GAEH;IACiB;GACiB;;;;;;;;;;ACrF3C,SAAgB,UAAU;CACxB,MAAM,EAAE,MAAM,WAAW,OAAO,oBAAoBC,WAAS;AAE7D,QAAO,cAAc;EACnB,MAAM,KAAK,MAAM,QAAQ;EACzB,MAAM,OAAO,MAAM,QAAQ;EAC3B,MAAM,QAAQ,MAAM,QAAQ;EAC5B,MAAM,SAAS,MAAM,QAAQ;AAC7B,SAAO;GACL,GAAI,QAAQ,EAAE;GACd;GACA;GACA;GACA;GACA;GACA;GACA;GACD;IACA;EAAC;EAAM;EAAiB;EAAW;EAAM,CAAC;;;;;ACjB/C,SAAgB,UAA4B;CAC1C,MAAM,EAAE,gBAAgB,yBAAyB;CACjD,MAAM,OAAOC,WAAa;CAE1B,MAAM,EAAE,iBAAiB,eAAe;CACxC,MAAM,UAAU,YAAY,YAAY;AAEtC,MADiB,MAAM,YAAY,gBAAgB,uBAAuB,IAC1D,KACd,OAAM,iBAAiB;MAEvB,OAAM,YAAY;IAEnB;EAAC;EAAa;EAAiB;EAAW,CAAC;AAE9C,QAAO,cAAc;AACnB,SAAO;GACL,GAAG;GACH;GACD;IACA,CAAC,MAAM,QAAQ,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["useAuth","hasAuthParams","DEFAULT_AUTH_CONFIG: Partial<HerculesAuthProviderProps>","ReactAuthProvider","useAuth","useOidcAuth"],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts","../../src/react/use-auth.ts"],"sourcesContent":["\"use client\";\n\nimport { useEffect, useState, useRef, useCallback } from \"react\";\nimport { useAuth, hasAuthParams } from \"react-oidc-context\";\nimport { ConvexError } from \"convex/values\";\nimport * as z from \"zod\";\n\nconst DEFAULT_TIMEOUT_MS = 20000; // 20 second timeout\n\nconst convexErrorSchema = z.object({\n message: z.string(),\n});\n\n/**\n * Authentication callback status states\n * @public\n */\nexport type AuthCallbackStatus =\n | \"processing-oauth\" // OIDC is processing the callback\n | \"waiting-backend\" // OIDC authenticated, waiting for backend\n | \"syncing\" // Syncing user with backend (e.g., creating user record)\n | \"success\" // All done\n | \"error\"; // Something went wrong\n\n/**\n * Options for the useAuthCallback hook\n * @public\n */\nexport interface UseAuthCallbackOptions {\n /**\n * Timeout in milliseconds before the callback is considered failed.\n * @default 20000\n */\n timeoutMs?: number;\n\n /**\n * Whether the backend (e.g., Convex) is authenticated.\n * The hook will wait for this to be true before calling onSync.\n */\n isBackendAuthenticated?: boolean;\n\n /**\n * Called when the backend is authenticated and ready to sync.\n * Use this to create/update the user in your backend.\n * Return a promise that resolves when sync is complete.\n */\n onSync?: () => Promise<void>;\n\n /**\n * Called when authentication is successful and sync is complete.\n * Use this to redirect the user.\n */\n onSuccess?: () => void;\n\n /**\n * Called when OIDC is not authenticated and there are no auth params.\n * This typically means the user navigated directly to the callback page.\n * Use this to redirect them away.\n */\n onNoAuthParams?: () => void;\n}\n\n/**\n * Return type for the useAuthCallback hook\n * @public\n */\nexport interface UseAuthCallbackResult {\n /** Current status of the auth callback flow */\n status: AuthCallbackStatus;\n\n /** Error message if status is \"error\" */\n error: string | null;\n\n /** Whether the auth callback is still in progress */\n isLoading: boolean;\n\n /** Whether the auth callback completed successfully */\n isSuccess: boolean;\n\n /** Whether there was an error */\n isError: boolean;\n\n /** Retry the authentication flow by redirecting to the auth provider */\n retry: () => Promise<void>;\n}\n\n/**\n * A hook for handling OAuth/OIDC callback flows.\n *\n * This hook manages the complete authentication callback lifecycle:\n * 1. Processing the OAuth callback from the identity provider\n * 2. Waiting for backend authentication (e.g., Convex)\n * 3. Syncing user data with your backend\n * 4. Handling success and error states\n *\n * @example\n * ```tsx\n * function AuthCallback() {\n * const navigate = useNavigate();\n * const { isAuthenticated } = useConvexAuth();\n * const updateUser = useMutation(api.users.updateCurrentUser);\n *\n * const { status, error, retry } = useAuthCallback({\n * isBackendAuthenticated: isAuthenticated,\n * onSync: () => updateUser(),\n * onSuccess: () => navigate(\"/\", { replace: true }),\n * onNoAuthParams: () => navigate(\"/\", { replace: true }),\n * });\n *\n * if (status === \"error\") {\n * return <ErrorState message={error} onRetry={retry} />;\n * }\n *\n * return <LoadingSpinner />;\n * }\n * ```\n *\n * @public\n */\nexport function useAuthCallback(\n options: UseAuthCallbackOptions = {},\n): UseAuthCallbackResult {\n const {\n timeoutMs = DEFAULT_TIMEOUT_MS,\n isBackendAuthenticated = true,\n onSync,\n onSuccess,\n onNoAuthParams,\n } = options;\n\n const {\n isLoading: isAuthLoading,\n isAuthenticated: isOidcAuthenticated,\n error: oidcError,\n signinRedirect,\n } = useAuth();\n\n const [status, setStatus] = useState<AuthCallbackStatus>(\"processing-oauth\");\n const [error, setError] = useState<string | null>(null);\n\n // Track mount state to prevent state updates after unmount\n const mountedRef = useRef(true);\n // Track if we had auth params on mount (won't change during lifecycle)\n const hadAuthParams = useRef(hasAuthParams());\n // Track if we've already started sync to prevent double execution\n const syncStarted = useRef(false);\n\n // Reset on mount, cleanup on unmount\n useEffect(() => {\n mountedRef.current = true;\n syncStarted.current = false;\n return () => {\n mountedRef.current = false;\n };\n }, []);\n\n // Timeout protection with state awareness\n useEffect(() => {\n if (status === \"success\" || status === \"error\") return;\n\n const timeout = setTimeout(() => {\n if (mountedRef.current) {\n setStatus(\"error\");\n setError(\"Authentication timed out. Please try again.\");\n }\n }, timeoutMs);\n\n return () => clearTimeout(timeout);\n }, [status, timeoutMs]);\n\n // Track OIDC authentication progression\n useEffect(() => {\n // Don't update if we're already past processing or in an error state\n if (status !== \"processing-oauth\" && status !== \"waiting-backend\") return;\n\n // Handle OIDC errors\n if (oidcError) {\n setStatus(\"error\");\n setError(oidcError.message || \"Authentication failed\");\n return;\n }\n\n // No auth params and not authenticated - navigated here directly\n if (!hadAuthParams.current && !isAuthLoading && !isOidcAuthenticated) {\n onNoAuthParams?.();\n return;\n }\n\n // OIDC is done loading and authenticated - move to waiting for backend\n if (\n !isAuthLoading &&\n isOidcAuthenticated &&\n status === \"processing-oauth\"\n ) {\n setStatus(\"waiting-backend\");\n return;\n }\n\n // OIDC finished but not authenticated (and we had auth params)\n // Wait a bit before declaring failure to avoid race conditions\n if (\n hadAuthParams.current &&\n !isAuthLoading &&\n !isOidcAuthenticated &&\n !oidcError &&\n status === \"processing-oauth\"\n ) {\n // Use a small delay to avoid race condition during OIDC state transitions\n const failureTimeout = setTimeout(() => {\n if (mountedRef.current && !isOidcAuthenticated) {\n setStatus(\"error\");\n setError(\"Authentication was cancelled or failed. Please try again.\");\n }\n }, 500);\n\n return () => clearTimeout(failureTimeout);\n }\n\n return;\n }, [isAuthLoading, isOidcAuthenticated, oidcError, status, onNoAuthParams]);\n\n // Sync with backend once backend is authenticated\n useEffect(() => {\n if (status !== \"waiting-backend\" || !isBackendAuthenticated) return;\n if (syncStarted.current) return;\n\n syncStarted.current = true;\n\n async function performSync() {\n if (!mountedRef.current) return;\n\n setStatus(\"syncing\");\n\n try {\n if (onSync) {\n await onSync();\n }\n\n if (mountedRef.current) {\n setStatus(\"success\");\n }\n } catch (err) {\n console.error(\"Auth callback sync failed:\", err);\n\n if (!mountedRef.current) return;\n\n if (err instanceof ConvexError) {\n // try to extract the error message from the convex error\n const parseResult = convexErrorSchema.safeParse(err.data);\n if (parseResult.success) {\n setStatus(\"error\");\n setError(parseResult.data.message);\n return;\n }\n }\n\n // Check if it's an authentication error\n const errorMessage =\n err instanceof Error\n ? err.message\n : \"Failed to complete authentication. Please try again.\";\n\n setStatus(\"error\");\n setError(errorMessage);\n }\n }\n\n performSync();\n }, [status, isBackendAuthenticated, onSync]);\n\n // Handle successful completion\n useEffect(() => {\n if (status === \"success\") {\n onSuccess?.();\n }\n }, [status, onSuccess]);\n\n // Retry handler\n const retry = useCallback(async () => {\n try {\n await signinRedirect();\n } catch (err) {\n console.error(\"Failed to restart auth:\", err);\n }\n }, [signinRedirect]);\n\n return {\n status,\n error,\n isLoading: status !== \"success\" && status !== \"error\",\n isSuccess: status === \"success\",\n isError: status === \"error\",\n retry,\n };\n}\n","\"use client\";\n\nimport { useState } from \"react\";\nimport {\n AuthProvider as ReactAuthProvider,\n type AuthProviderUserManagerProps,\n} from \"react-oidc-context\";\nimport {\n UserManager,\n WebStorageStateStore,\n type UserManagerSettings,\n} from \"oidc-client-ts\";\nimport { createContext, useContext } from \"react\";\n\nexport type HerculesAuthProviderProps = Omit<\n AuthProviderUserManagerProps,\n \"userManager\"\n> & {\n userManagerSettings?: Partial<UserManagerSettings>;\n authority: string;\n client_id: string;\n};\n\nfunction onSigninCallback() {\n window.history.replaceState({}, document.title, window.location.pathname);\n}\n\nfunction onSignoutCallback() {\n window.location.pathname = \"\";\n}\n\nconst DEFAULT_AUTH_CONFIG: Partial<HerculesAuthProviderProps> = {\n onSignoutCallback,\n onSigninCallback,\n};\n\ninterface HerculesAuthProviderContext {\n userManager: UserManager;\n}\n\nconst HerculesAuthProviderContext =\n createContext<HerculesAuthProviderContext | null>(null);\n\nexport function useHerculesAuthProvider() {\n const context = useContext(HerculesAuthProviderContext);\n if (!context) {\n throw new Error(\"HerculesAuthProviderContext not found\");\n }\n return context;\n}\n\n/**\n * A wrapper React component which provides a {@link ReactAuthProvider}\n * configured with Hercules Auth.\n *\n * @public\n */\nexport function HerculesAuthProvider({\n children,\n userManagerSettings,\n authority,\n client_id,\n ...props\n}: HerculesAuthProviderProps) {\n const [userManager] = useState(\n () =>\n new UserManager({\n ...userManagerSettings,\n authority: userManagerSettings?.authority ?? authority,\n client_id: userManagerSettings?.client_id ?? client_id,\n prompt: userManagerSettings?.prompt ?? \"select_account\",\n response_type: userManagerSettings?.response_type ?? \"code\",\n scope:\n userManagerSettings?.scope ?? \"openid profile email offline_access\",\n redirect_uri:\n userManagerSettings?.redirect_uri ??\n `${window.location.origin}/auth/callback`,\n post_logout_redirect_uri:\n userManagerSettings?.post_logout_redirect_uri ??\n window.location.origin,\n userStore:\n userManagerSettings?.userStore ??\n new WebStorageStateStore({ store: window.localStorage }),\n }),\n );\n\n return (\n <HerculesAuthProviderContext.Provider value={{ userManager }}>\n <ReactAuthProvider\n userManager={userManager}\n {...DEFAULT_AUTH_CONFIG}\n {...props}\n >\n {children}\n </ReactAuthProvider>\n </HerculesAuthProviderContext.Provider>\n );\n}\n","\"use client\";\n\nimport { useMemo } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\n\n/**\n * A hook that returns the current user if authenticated\n *\n * @public\n */\nexport function useUser() {\n const { user, isLoading, error, isAuthenticated } = useAuth();\n\n return useMemo(() => {\n const id = user?.profile.sub;\n const name = user?.profile.name;\n const email = user?.profile.email;\n const avatar = user?.profile.picture;\n return {\n ...(user ?? {}),\n id,\n name,\n email,\n avatar,\n isAuthenticated,\n isLoading,\n error,\n };\n }, [user, isAuthenticated, isLoading, error]);\n}\n","import {\n useAuth as useOidcAuth,\n type AuthContextProps as OidcAuthContextProps,\n} from \"react-oidc-context\";\nimport { useHerculesAuthProvider } from \"./HerculesAuthProvider\";\nimport { useCallback, useMemo } from \"react\";\n\nexport interface AuthContextProps extends OidcAuthContextProps {\n signout: () => Promise<void>;\n signin: () => Promise<void>;\n}\n\nexport function useAuth(): AuthContextProps {\n const { userManager } = useHerculesAuthProvider();\n const auth = useOidcAuth();\n\n const { signoutRedirect, removeUser, signinRedirect } = auth;\n const signout = useCallback(async () => {\n const endpoint = await userManager.metadataService.getEndSessionEndpoint();\n if (endpoint != null) {\n await signoutRedirect();\n } else {\n await removeUser();\n }\n }, [userManager, signoutRedirect, removeUser]);\n\n const signin = useCallback(async () => {\n await signinRedirect();\n }, [signinRedirect]);\n\n return useMemo(() => {\n return {\n ...auth,\n signout,\n signin,\n } satisfies AuthContextProps;\n }, [auth, signout, signin]);\n}\n"],"mappings":";;;;;;;;AAOA,MAAM,qBAAqB;AAE3B,MAAM,oBAAoB,EAAE,OAAO,EACjC,SAAS,EAAE,QAAQ,EACpB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GF,SAAgB,gBACd,UAAkC,EAAE,EACb;CACvB,MAAM,EACJ,YAAY,oBACZ,yBAAyB,MACzB,QACA,WACA,mBACE;CAEJ,MAAM,EACJ,WAAW,eACX,iBAAiB,qBACjB,OAAO,WACP,mBACEA,WAAS;CAEb,MAAM,CAAC,QAAQ,aAAa,SAA6B,mBAAmB;CAC5E,MAAM,CAAC,OAAO,YAAY,SAAwB,KAAK;CAGvD,MAAM,aAAa,OAAO,KAAK;CAE/B,MAAM,gBAAgB,OAAOC,iBAAe,CAAC;CAE7C,MAAM,cAAc,OAAO,MAAM;AAGjC,iBAAgB;AACd,aAAW,UAAU;AACrB,cAAY,UAAU;AACtB,eAAa;AACX,cAAW,UAAU;;IAEtB,EAAE,CAAC;AAGN,iBAAgB;AACd,MAAI,WAAW,aAAa,WAAW,QAAS;EAEhD,MAAM,UAAU,iBAAiB;AAC/B,OAAI,WAAW,SAAS;AACtB,cAAU,QAAQ;AAClB,aAAS,8CAA8C;;KAExD,UAAU;AAEb,eAAa,aAAa,QAAQ;IACjC,CAAC,QAAQ,UAAU,CAAC;AAGvB,iBAAgB;AAEd,MAAI,WAAW,sBAAsB,WAAW,kBAAmB;AAGnE,MAAI,WAAW;AACb,aAAU,QAAQ;AAClB,YAAS,UAAU,WAAW,wBAAwB;AACtD;;AAIF,MAAI,CAAC,cAAc,WAAW,CAAC,iBAAiB,CAAC,qBAAqB;AACpE,qBAAkB;AAClB;;AAIF,MACE,CAAC,iBACD,uBACA,WAAW,oBACX;AACA,aAAU,kBAAkB;AAC5B;;AAKF,MACE,cAAc,WACd,CAAC,iBACD,CAAC,uBACD,CAAC,aACD,WAAW,oBACX;GAEA,MAAM,iBAAiB,iBAAiB;AACtC,QAAI,WAAW,WAAW,CAAC,qBAAqB;AAC9C,eAAU,QAAQ;AAClB,cAAS,4DAA4D;;MAEtE,IAAI;AAEP,gBAAa,aAAa,eAAe;;IAI1C;EAAC;EAAe;EAAqB;EAAW;EAAQ;EAAe,CAAC;AAG3E,iBAAgB;AACd,MAAI,WAAW,qBAAqB,CAAC,uBAAwB;AAC7D,MAAI,YAAY,QAAS;AAEzB,cAAY,UAAU;EAEtB,eAAe,cAAc;AAC3B,OAAI,CAAC,WAAW,QAAS;AAEzB,aAAU,UAAU;AAEpB,OAAI;AACF,QAAI,OACF,OAAM,QAAQ;AAGhB,QAAI,WAAW,QACb,WAAU,UAAU;YAEf,KAAK;AACZ,YAAQ,MAAM,8BAA8B,IAAI;AAEhD,QAAI,CAAC,WAAW,QAAS;AAEzB,QAAI,eAAe,aAAa;KAE9B,MAAM,cAAc,kBAAkB,UAAU,IAAI,KAAK;AACzD,SAAI,YAAY,SAAS;AACvB,gBAAU,QAAQ;AAClB,eAAS,YAAY,KAAK,QAAQ;AAClC;;;IAKJ,MAAM,eACJ,eAAe,QACX,IAAI,UACJ;AAEN,cAAU,QAAQ;AAClB,aAAS,aAAa;;;AAI1B,eAAa;IACZ;EAAC;EAAQ;EAAwB;EAAO,CAAC;AAG5C,iBAAgB;AACd,MAAI,WAAW,UACb,cAAa;IAEd,CAAC,QAAQ,UAAU,CAAC;CAGvB,MAAM,QAAQ,YAAY,YAAY;AACpC,MAAI;AACF,SAAM,gBAAgB;WACf,KAAK;AACZ,WAAQ,MAAM,2BAA2B,IAAI;;IAE9C,CAAC,eAAe,CAAC;AAEpB,QAAO;EACL;EACA;EACA,WAAW,WAAW,aAAa,WAAW;EAC9C,WAAW,WAAW;EACtB,SAAS,WAAW;EACpB;EACD;;;;;AC9QH,SAAS,mBAAmB;AAC1B,QAAO,QAAQ,aAAa,EAAE,EAAE,SAAS,OAAO,OAAO,SAAS,SAAS;;AAG3E,SAAS,oBAAoB;AAC3B,QAAO,SAAS,WAAW;;AAG7B,MAAMC,sBAA0D;CAC9D;CACA;CACD;AAMD,MAAM,8BACJ,cAAkD,KAAK;AAEzD,SAAgB,0BAA0B;CACxC,MAAM,UAAU,WAAW,4BAA4B;AACvD,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,QAAO;;;;;;;;AAST,SAAgB,qBAAqB,EACnC,UACA,qBACA,WACA,WACA,GAAG,SACyB;CAC5B,MAAM,CAAC,eAAe,eAElB,IAAI,YAAY;EACd,GAAG;EACH,WAAW,qBAAqB,aAAa;EAC7C,WAAW,qBAAqB,aAAa;EAC7C,QAAQ,qBAAqB,UAAU;EACvC,eAAe,qBAAqB,iBAAiB;EACrD,OACE,qBAAqB,SAAS;EAChC,cACE,qBAAqB,gBACrB,GAAG,OAAO,SAAS,OAAO;EAC5B,0BACE,qBAAqB,4BACrB,OAAO,SAAS;EAClB,WACE,qBAAqB,aACrB,IAAI,qBAAqB,EAAE,OAAO,OAAO,cAAc,CAAC;EAC3D,CAAC,CACL;AAED,QACE,oBAAC,4BAA4B;EAAS,OAAO,EAAE,aAAa;YAC1D,oBAACC;GACc;GACb,GAAI;GACJ,GAAI;GAEH;IACiB;GACiB;;;;;;;;;;ACrF3C,SAAgB,UAAU;CACxB,MAAM,EAAE,MAAM,WAAW,OAAO,oBAAoBC,WAAS;AAE7D,QAAO,cAAc;EACnB,MAAM,KAAK,MAAM,QAAQ;EACzB,MAAM,OAAO,MAAM,QAAQ;EAC3B,MAAM,QAAQ,MAAM,QAAQ;EAC5B,MAAM,SAAS,MAAM,QAAQ;AAC7B,SAAO;GACL,GAAI,QAAQ,EAAE;GACd;GACA;GACA;GACA;GACA;GACA;GACA;GACD;IACA;EAAC;EAAM;EAAiB;EAAW;EAAM,CAAC;;;;;AChB/C,SAAgB,UAA4B;CAC1C,MAAM,EAAE,gBAAgB,yBAAyB;CACjD,MAAM,OAAOC,WAAa;CAE1B,MAAM,EAAE,iBAAiB,YAAY,mBAAmB;CACxD,MAAM,UAAU,YAAY,YAAY;AAEtC,MADiB,MAAM,YAAY,gBAAgB,uBAAuB,IAC1D,KACd,OAAM,iBAAiB;MAEvB,OAAM,YAAY;IAEnB;EAAC;EAAa;EAAiB;EAAW,CAAC;CAE9C,MAAM,SAAS,YAAY,YAAY;AACrC,QAAM,gBAAgB;IACrB,CAAC,eAAe,CAAC;AAEpB,QAAO,cAAc;AACnB,SAAO;GACL,GAAG;GACH;GACA;GACD;IACA;EAAC;EAAM;EAAS;EAAO,CAAC"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
import { describe, it, expect, vi, beforeEach } from "vitest";
|
|
2
|
+
import type { ReactNode } from "react";
|
|
3
|
+
import { renderHook, act, configure } from "@testing-library/react";
|
|
4
|
+
import { ConvexProviderWithHerculesAuth } from "./ConvexProviderWithHercules.js";
|
|
5
|
+
|
|
6
|
+
configure({ reactStrictMode: true });
|
|
7
|
+
|
|
8
|
+
const mockSigninSilent = vi.fn();
|
|
9
|
+
|
|
10
|
+
let mockAuthState: Record<string, unknown> = {};
|
|
11
|
+
|
|
12
|
+
vi.mock("react-oidc-context", () => ({
|
|
13
|
+
useAuth: () => mockAuthState,
|
|
14
|
+
}));
|
|
15
|
+
|
|
16
|
+
type CapturedUseAuth = () => {
|
|
17
|
+
isLoading: boolean;
|
|
18
|
+
isAuthenticated: boolean;
|
|
19
|
+
fetchAccessToken: (args: {
|
|
20
|
+
forceRefreshToken: boolean;
|
|
21
|
+
}) => Promise<string | null>;
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
let capturedUseAuth: CapturedUseAuth | null = null;
|
|
25
|
+
|
|
26
|
+
vi.mock("convex/react", () => ({
|
|
27
|
+
ConvexProviderWithAuth: ({
|
|
28
|
+
children,
|
|
29
|
+
useAuth,
|
|
30
|
+
}: {
|
|
31
|
+
children: ReactNode;
|
|
32
|
+
useAuth: CapturedUseAuth;
|
|
33
|
+
}) => {
|
|
34
|
+
capturedUseAuth = useAuth;
|
|
35
|
+
return children;
|
|
36
|
+
},
|
|
37
|
+
}));
|
|
38
|
+
|
|
39
|
+
function setAuthState(overrides: Record<string, unknown>) {
|
|
40
|
+
mockAuthState = {
|
|
41
|
+
isLoading: false,
|
|
42
|
+
isAuthenticated: true,
|
|
43
|
+
user: { id_token: "cached-token" },
|
|
44
|
+
signinSilent: mockSigninSilent,
|
|
45
|
+
...overrides,
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
beforeEach(() => {
|
|
50
|
+
setAuthState({});
|
|
51
|
+
mockSigninSilent.mockReset();
|
|
52
|
+
capturedUseAuth = null;
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
function renderUseAuth() {
|
|
56
|
+
renderHook(() => null, {
|
|
57
|
+
wrapper: ({ children }) => (
|
|
58
|
+
<ConvexProviderWithHerculesAuth client={{} as never}>
|
|
59
|
+
{children}
|
|
60
|
+
</ConvexProviderWithHerculesAuth>
|
|
61
|
+
),
|
|
62
|
+
});
|
|
63
|
+
if (!capturedUseAuth) {
|
|
64
|
+
throw new Error("useAuth not captured");
|
|
65
|
+
}
|
|
66
|
+
const captured = capturedUseAuth;
|
|
67
|
+
return renderHook(() => captured());
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
describe("ConvexProviderWithHerculesAuth fetchAccessToken", () => {
|
|
71
|
+
it("returns the cached id token when forceRefreshToken is false", async () => {
|
|
72
|
+
const { result } = renderUseAuth();
|
|
73
|
+
|
|
74
|
+
const token = await result.current.fetchAccessToken({
|
|
75
|
+
forceRefreshToken: false,
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
expect(token).toBe("cached-token");
|
|
79
|
+
expect(mockSigninSilent).not.toHaveBeenCalled();
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it("calls signinSilent and returns the refreshed token when forceRefreshToken is true", async () => {
|
|
83
|
+
mockSigninSilent.mockResolvedValue({ id_token: "fresh-token" });
|
|
84
|
+
|
|
85
|
+
const { result } = renderUseAuth();
|
|
86
|
+
|
|
87
|
+
let token: string | null = null;
|
|
88
|
+
await act(async () => {
|
|
89
|
+
token = await result.current.fetchAccessToken({
|
|
90
|
+
forceRefreshToken: true,
|
|
91
|
+
});
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
expect(token).toBe("fresh-token");
|
|
95
|
+
expect(mockSigninSilent).toHaveBeenCalledOnce();
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it("returns null when signinSilent throws", async () => {
|
|
99
|
+
mockSigninSilent.mockRejectedValue(new Error("refresh failed"));
|
|
100
|
+
|
|
101
|
+
const { result } = renderUseAuth();
|
|
102
|
+
|
|
103
|
+
let token: string | null = "unset";
|
|
104
|
+
await act(async () => {
|
|
105
|
+
token = await result.current.fetchAccessToken({
|
|
106
|
+
forceRefreshToken: true,
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
expect(token).toBeNull();
|
|
111
|
+
expect(mockSigninSilent).toHaveBeenCalledOnce();
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
it("returns null when signinSilent resolves without a user", async () => {
|
|
115
|
+
mockSigninSilent.mockResolvedValue(null);
|
|
116
|
+
|
|
117
|
+
const { result } = renderUseAuth();
|
|
118
|
+
|
|
119
|
+
let token: string | null = "unset";
|
|
120
|
+
await act(async () => {
|
|
121
|
+
token = await result.current.fetchAccessToken({
|
|
122
|
+
forceRefreshToken: true,
|
|
123
|
+
});
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
expect(token).toBeNull();
|
|
127
|
+
expect(mockSigninSilent).toHaveBeenCalledOnce();
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
it("dedupes concurrent forceRefreshToken calls into a single signinSilent", async () => {
|
|
131
|
+
let resolveSilent: ((value: { id_token: string }) => void) | null = null;
|
|
132
|
+
mockSigninSilent.mockImplementation(
|
|
133
|
+
() =>
|
|
134
|
+
new Promise<{ id_token: string }>((resolve) => {
|
|
135
|
+
resolveSilent = resolve;
|
|
136
|
+
}),
|
|
137
|
+
);
|
|
138
|
+
|
|
139
|
+
const { result } = renderUseAuth();
|
|
140
|
+
|
|
141
|
+
let firstToken: string | null = null;
|
|
142
|
+
let secondToken: string | null = null;
|
|
143
|
+
let thirdToken: string | null = null;
|
|
144
|
+
|
|
145
|
+
await act(async () => {
|
|
146
|
+
const first = result.current.fetchAccessToken({
|
|
147
|
+
forceRefreshToken: true,
|
|
148
|
+
});
|
|
149
|
+
const second = result.current.fetchAccessToken({
|
|
150
|
+
forceRefreshToken: true,
|
|
151
|
+
});
|
|
152
|
+
const third = result.current.fetchAccessToken({
|
|
153
|
+
forceRefreshToken: true,
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
resolveSilent?.({ id_token: "fresh-token" });
|
|
157
|
+
|
|
158
|
+
[firstToken, secondToken, thirdToken] = await Promise.all([
|
|
159
|
+
first,
|
|
160
|
+
second,
|
|
161
|
+
third,
|
|
162
|
+
]);
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
expect(firstToken).toBe("fresh-token");
|
|
166
|
+
expect(secondToken).toBe("fresh-token");
|
|
167
|
+
expect(thirdToken).toBe("fresh-token");
|
|
168
|
+
expect(mockSigninSilent).toHaveBeenCalledOnce();
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
it("allows a new refresh after the in-flight refresh settles", async () => {
|
|
172
|
+
mockSigninSilent
|
|
173
|
+
.mockResolvedValueOnce({ id_token: "first-fresh" })
|
|
174
|
+
.mockResolvedValueOnce({ id_token: "second-fresh" });
|
|
175
|
+
|
|
176
|
+
const { result } = renderUseAuth();
|
|
177
|
+
|
|
178
|
+
let firstToken: string | null = null;
|
|
179
|
+
let secondToken: string | null = null;
|
|
180
|
+
|
|
181
|
+
await act(async () => {
|
|
182
|
+
firstToken = await result.current.fetchAccessToken({
|
|
183
|
+
forceRefreshToken: true,
|
|
184
|
+
});
|
|
185
|
+
});
|
|
186
|
+
await act(async () => {
|
|
187
|
+
secondToken = await result.current.fetchAccessToken({
|
|
188
|
+
forceRefreshToken: true,
|
|
189
|
+
});
|
|
190
|
+
});
|
|
191
|
+
|
|
192
|
+
expect(firstToken).toBe("first-fresh");
|
|
193
|
+
expect(secondToken).toBe("second-fresh");
|
|
194
|
+
expect(mockSigninSilent).toHaveBeenCalledTimes(2);
|
|
195
|
+
});
|
|
196
|
+
});
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { ReactNode } from "react";
|
|
4
4
|
import { ConvexProviderWithAuth, type ConvexReactClient } from "convex/react";
|
|
5
|
-
import { useCallback, useMemo } from "react";
|
|
5
|
+
import { useCallback, useMemo, useRef } from "react";
|
|
6
6
|
import { useAuth } from "react-oidc-context";
|
|
7
7
|
import type { HerculesAuthProvider } from "../react/HerculesAuthProvider";
|
|
8
8
|
|
|
@@ -31,17 +31,29 @@ export function ConvexProviderWithHerculesAuth({
|
|
|
31
31
|
function useUseAuthFromHercules() {
|
|
32
32
|
const { isAuthenticated, user, isLoading, signinSilent } = useAuth();
|
|
33
33
|
const idToken = user?.id_token;
|
|
34
|
+
|
|
35
|
+
const inFlightRefresh = useRef<Promise<string | null> | null>(null);
|
|
36
|
+
|
|
34
37
|
const fetchAccessToken = useCallback(
|
|
35
|
-
async ({ forceRefreshToken
|
|
36
|
-
|
|
37
|
-
// if (forceRefreshToken) {
|
|
38
|
-
// const user = await signinSilent();
|
|
39
|
-
// return user?.id_token ?? null;
|
|
40
|
-
// }
|
|
38
|
+
async ({ forceRefreshToken }: { forceRefreshToken: boolean }) => {
|
|
39
|
+
if (!forceRefreshToken) {
|
|
41
40
|
return idToken ?? null;
|
|
42
|
-
} catch {
|
|
43
|
-
return null;
|
|
44
41
|
}
|
|
42
|
+
if (inFlightRefresh.current) {
|
|
43
|
+
return inFlightRefresh.current;
|
|
44
|
+
}
|
|
45
|
+
const refresh = (async () => {
|
|
46
|
+
try {
|
|
47
|
+
const refreshed = await signinSilent();
|
|
48
|
+
return refreshed?.id_token ?? null;
|
|
49
|
+
} catch {
|
|
50
|
+
return null;
|
|
51
|
+
} finally {
|
|
52
|
+
inFlightRefresh.current = null;
|
|
53
|
+
}
|
|
54
|
+
})();
|
|
55
|
+
inFlightRefresh.current = refresh;
|
|
56
|
+
return refresh;
|
|
45
57
|
},
|
|
46
58
|
[idToken, signinSilent],
|
|
47
59
|
);
|
|
@@ -7,6 +7,7 @@ configure({ reactStrictMode: true });
|
|
|
7
7
|
// ---- Mocks ----
|
|
8
8
|
|
|
9
9
|
const mockSignoutRedirect = vi.fn();
|
|
10
|
+
const mockSigninRedirect = vi.fn();
|
|
10
11
|
const mockRemoveUser = vi.fn();
|
|
11
12
|
const mockGetEndSessionEndpoint = vi.fn();
|
|
12
13
|
|
|
@@ -33,6 +34,7 @@ function setAuthState(overrides: Record<string, unknown>) {
|
|
|
33
34
|
isLoading: false,
|
|
34
35
|
isAuthenticated: true,
|
|
35
36
|
signoutRedirect: mockSignoutRedirect,
|
|
37
|
+
signinRedirect: mockSigninRedirect,
|
|
36
38
|
removeUser: mockRemoveUser,
|
|
37
39
|
...overrides,
|
|
38
40
|
};
|
|
@@ -43,6 +45,7 @@ function setAuthState(overrides: Record<string, unknown>) {
|
|
|
43
45
|
beforeEach(() => {
|
|
44
46
|
setAuthState({});
|
|
45
47
|
mockSignoutRedirect.mockReset();
|
|
48
|
+
mockSigninRedirect.mockReset();
|
|
46
49
|
mockRemoveUser.mockReset();
|
|
47
50
|
mockGetEndSessionEndpoint.mockReset();
|
|
48
51
|
});
|
|
@@ -54,6 +57,7 @@ describe("useAuth", () => {
|
|
|
54
57
|
expect(result.current.isAuthenticated).toBe(true);
|
|
55
58
|
expect(result.current.isLoading).toBe(false);
|
|
56
59
|
expect(typeof result.current.signout).toBe("function");
|
|
60
|
+
expect(typeof result.current.signin).toBe("function");
|
|
57
61
|
});
|
|
58
62
|
|
|
59
63
|
it("spreads all properties from the oidc auth context", () => {
|
|
@@ -111,6 +115,20 @@ describe("useAuth", () => {
|
|
|
111
115
|
});
|
|
112
116
|
});
|
|
113
117
|
|
|
118
|
+
describe("signin", () => {
|
|
119
|
+
it("calls signinRedirect", async () => {
|
|
120
|
+
mockSigninRedirect.mockResolvedValue(undefined);
|
|
121
|
+
|
|
122
|
+
const { result } = renderHook(() => useAuth());
|
|
123
|
+
|
|
124
|
+
await act(async () => {
|
|
125
|
+
await result.current.signin();
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
expect(mockSigninRedirect).toHaveBeenCalledOnce();
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
|
|
114
132
|
describe("memoization", () => {
|
|
115
133
|
it("returns a stable signout reference across rerenders with same deps", () => {
|
|
116
134
|
const { result, rerender } = renderHook(() => useAuth());
|
|
@@ -121,5 +139,15 @@ describe("useAuth", () => {
|
|
|
121
139
|
|
|
122
140
|
expect(firstSignout).toBe(secondSignout);
|
|
123
141
|
});
|
|
142
|
+
|
|
143
|
+
it("returns a stable signin reference across rerenders with same deps", () => {
|
|
144
|
+
const { result, rerender } = renderHook(() => useAuth());
|
|
145
|
+
|
|
146
|
+
const firstSignin = result.current.signin;
|
|
147
|
+
rerender();
|
|
148
|
+
const secondSignin = result.current.signin;
|
|
149
|
+
|
|
150
|
+
expect(firstSignin).toBe(secondSignin);
|
|
151
|
+
});
|
|
124
152
|
});
|
|
125
153
|
});
|
package/src/react/use-auth.ts
CHANGED
|
@@ -7,13 +7,14 @@ import { useCallback, useMemo } from "react";
|
|
|
7
7
|
|
|
8
8
|
export interface AuthContextProps extends OidcAuthContextProps {
|
|
9
9
|
signout: () => Promise<void>;
|
|
10
|
+
signin: () => Promise<void>;
|
|
10
11
|
}
|
|
11
12
|
|
|
12
13
|
export function useAuth(): AuthContextProps {
|
|
13
14
|
const { userManager } = useHerculesAuthProvider();
|
|
14
15
|
const auth = useOidcAuth();
|
|
15
16
|
|
|
16
|
-
const { signoutRedirect, removeUser } = auth;
|
|
17
|
+
const { signoutRedirect, removeUser, signinRedirect } = auth;
|
|
17
18
|
const signout = useCallback(async () => {
|
|
18
19
|
const endpoint = await userManager.metadataService.getEndSessionEndpoint();
|
|
19
20
|
if (endpoint != null) {
|
|
@@ -23,10 +24,15 @@ export function useAuth(): AuthContextProps {
|
|
|
23
24
|
}
|
|
24
25
|
}, [userManager, signoutRedirect, removeUser]);
|
|
25
26
|
|
|
27
|
+
const signin = useCallback(async () => {
|
|
28
|
+
await signinRedirect();
|
|
29
|
+
}, [signinRedirect]);
|
|
30
|
+
|
|
26
31
|
return useMemo(() => {
|
|
27
32
|
return {
|
|
28
33
|
...auth,
|
|
29
34
|
signout,
|
|
35
|
+
signin,
|
|
30
36
|
} satisfies AuthContextProps;
|
|
31
|
-
}, [auth, signout]);
|
|
37
|
+
}, [auth, signout, signin]);
|
|
32
38
|
}
|