@usehercules/auth 1.0.30 → 1.0.32
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.
|
@@ -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"],"sourcesContent":[],"mappings":";;;;;;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts"],"sourcesContent":[],"mappings":";;;;;;;KAiBY,kBAAA;UAWK,sBAAA;;;iBAkBA;;;AA7BjB;AAWiB,UAsCA,qBAAA,CAtCsB;EAsCtB,MAAA,EAEP,kBAF4B;EAqDtB,KAAA,EAAA,MAAA,GAAA,IAAe;;;;EC1GnB,KAAA,EAAA,GAAA,GDsEG,OCtEH,CAAA,IAAA,CAAA;;AAA4B,iBD0GxB,eAAA,CC1GwB,OAAA,CAAA,ED2G7B,sBC3G6B,CAAA,ED4GrC,qBC5GqC;;;KAA5B,yBAAA,GAA4B,KACtC;wBAGsB,QAAQ;;;;ADApB,iBCwBI,oBAAA,CDxBc;EAAA,QAAA;EAAA,mBAAA;EAAA,SAAA;EAAA,SAAA;EAAA,GAAA;AAAA,CAAA,EC8B3B,yBD9B2B,CAAA,EC8BF,kBAAA,CAAA,GAAA,CAAA,OD9BE;;;iBEPd,OAAA,CAAA;;;;;;;EFOJ,KAAA,EEPW,mBAAA,CAAA,YAAA,GFOO,SAAA;EAWb,QAAA,CAAA,EAAA,MAAA;EAsCA,aAAA,CAAA,EAAA,MAAA,GAAqB,IAAA,GAAA,SAE5B;EAmDM,YAAA,CAAA,EAAA,MAAe,GAAA,SACpB;;;;EC3GC,OAAA,CAAA,ECHW,eAAA,CAAA,aAAA,GDGc,SAAA;EACnC,UAAA,CAAA,EAAA,MAAA;EADsC,KAAA,CAAA,EAAA,OAAA;EAIR,SAAA,CAAA,EAAA,MAAA;CAAR"}
|
package/dist/react/index.mjs
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
2
2
|
import { AuthProvider, hasAuthParams, hasAuthParams as hasAuthParams$1, useAuth, useAuth as useAuth$1 } from "react-oidc-context";
|
|
3
|
+
import { ConvexError } from "convex/values";
|
|
4
|
+
import * as z from "zod";
|
|
3
5
|
import { UserManager, WebStorageStateStore } from "oidc-client-ts";
|
|
4
6
|
import { jsx } from "react/jsx-runtime";
|
|
5
7
|
|
|
6
8
|
//#region src/react/auth-callback-hook.tsx
|
|
7
9
|
const DEFAULT_TIMEOUT_MS = 2e4;
|
|
10
|
+
const convexErrorSchema = z.object({ message: z.string() });
|
|
8
11
|
/**
|
|
9
12
|
* A hook for handling OAuth/OIDC callback flows.
|
|
10
13
|
*
|
|
@@ -105,7 +108,15 @@ function useAuthCallback(options = {}) {
|
|
|
105
108
|
} catch (err) {
|
|
106
109
|
console.error("Auth callback sync failed:", err);
|
|
107
110
|
if (!mountedRef.current) return;
|
|
108
|
-
|
|
111
|
+
if (err instanceof ConvexError) {
|
|
112
|
+
const parseResult = convexErrorSchema.safeParse(err.data);
|
|
113
|
+
if (parseResult.success) {
|
|
114
|
+
setStatus("error");
|
|
115
|
+
setError(parseResult.data.message);
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
const errorMessage = err instanceof Error ? err.message : "Failed to complete authentication. Please try again.";
|
|
109
120
|
setStatus("error");
|
|
110
121
|
setError(errorMessage);
|
|
111
122
|
}
|
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"],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.ts"],"sourcesContent":["\"use client\";\n\nimport { useEffect, useState, useRef, useCallback } from \"react\";\nimport { useAuth, hasAuthParams } from \"react-oidc-context\";\n\nconst DEFAULT_TIMEOUT_MS = 20000; // 20 second timeout\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 // Cleanup on unmount\n useEffect(() => {\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 // Check if it's an authentication error\n const errorMessage =\n err instanceof Error && err.message.includes(\"UNAUTHENTICATED\")\n ? \"Your session expired. Please sign in again.\"\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\";\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\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 <ReactAuthProvider\n userManager={userManager}\n {...DEFAULT_AUTH_CONFIG}\n {...props}\n >\n {children}\n </ReactAuthProvider>\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"],"mappings":";;;;;;AAKA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4G3B,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,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;IAGzB,MAAM,eACJ,eAAe,SAAS,IAAI,QAAQ,SAAS,kBAAkB,GAC3D,gDACA;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;;;;;AC7PH,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;;;;;;;AAQD,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,oBAACC;EACc;EACb,GAAI;EACJ,GAAI;EAEH;GACiB;;;;;;;;;;ACnExB,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"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["useAuth","hasAuthParams","DEFAULT_AUTH_CONFIG: Partial<HerculesAuthProviderProps>","ReactAuthProvider","useAuth"],"sources":["../../src/react/auth-callback-hook.tsx","../../src/react/HerculesAuthProvider.tsx","../../src/react/use-user.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 // Cleanup on unmount\n useEffect(() => {\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\";\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\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 <ReactAuthProvider\n userManager={userManager}\n {...DEFAULT_AUTH_CONFIG}\n {...props}\n >\n {children}\n </ReactAuthProvider>\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"],"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,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;;;;;AC7QH,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;;;;;;;AAQD,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,oBAACC;EACc;EACb,GAAI;EACJ,GAAI;EAEH;GACiB;;;;;;;;;;ACnExB,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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@usehercules/auth",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.32",
|
|
4
4
|
"description": "Authentication utilities for Hercules applications using OIDC",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -28,7 +28,8 @@
|
|
|
28
28
|
"dependencies": {
|
|
29
29
|
"convex": "^1.29.3",
|
|
30
30
|
"oidc-client-ts": "^3.4.1",
|
|
31
|
-
"react-oidc-context": "^3.3.0"
|
|
31
|
+
"react-oidc-context": "^3.3.0",
|
|
32
|
+
"zod": "^4.1.12"
|
|
32
33
|
},
|
|
33
34
|
"peerDependencies": {
|
|
34
35
|
"react": "^18.0.0 || ^19.0.0"
|
|
@@ -2,9 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
import { useEffect, useState, useRef, useCallback } from "react";
|
|
4
4
|
import { useAuth, hasAuthParams } from "react-oidc-context";
|
|
5
|
+
import { ConvexError } from "convex/values";
|
|
6
|
+
import * as z from "zod";
|
|
5
7
|
|
|
6
8
|
const DEFAULT_TIMEOUT_MS = 20000; // 20 second timeout
|
|
7
9
|
|
|
10
|
+
const convexErrorSchema = z.object({
|
|
11
|
+
message: z.string(),
|
|
12
|
+
});
|
|
13
|
+
|
|
8
14
|
/**
|
|
9
15
|
* Authentication callback status states
|
|
10
16
|
* @public
|
|
@@ -236,10 +242,20 @@ export function useAuthCallback(
|
|
|
236
242
|
|
|
237
243
|
if (!mountedRef.current) return;
|
|
238
244
|
|
|
245
|
+
if (err instanceof ConvexError) {
|
|
246
|
+
// try to extract the error message from the convex error
|
|
247
|
+
const parseResult = convexErrorSchema.safeParse(err.data);
|
|
248
|
+
if (parseResult.success) {
|
|
249
|
+
setStatus("error");
|
|
250
|
+
setError(parseResult.data.message);
|
|
251
|
+
return;
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
|
|
239
255
|
// Check if it's an authentication error
|
|
240
256
|
const errorMessage =
|
|
241
|
-
err instanceof Error
|
|
242
|
-
?
|
|
257
|
+
err instanceof Error
|
|
258
|
+
? err.message
|
|
243
259
|
: "Failed to complete authentication. Please try again.";
|
|
244
260
|
|
|
245
261
|
setStatus("error");
|