antaeus.keycloak.react 2.6.4 → 2.7.1

package/dist/index.mjs

@@ -34,6 +34,12 @@ var defaultConfig = {
     showLoadingIndicator: false,
     loadingMessage: "Refreshing session...",
     useRefreshToken: true,
+    allowIframeFallback: false,
+    transientRetry: {
+      maxAttempts: 3,
+      initialDelayMs: 1e3,
+      maxDelayMs: 3e4
+    },
     refreshOnResume: true
   },
   advanced: {
@@ -60,7 +66,6 @@ var KeycloakConfigBuilder = class {
     const config = this.mergeWithDefaults(userConfig);
     const storageType = config.advanced.storageType || "session";
     const storage = storageType === "local" ? window.localStorage : window.sessionStorage;
-    const { useRefreshToken } = config.silentRenew;
     const oidcSettings = {
       authority: config.authority,
       client_id: config.clientId,
@@ -78,9 +83,6 @@ var KeycloakConfigBuilder = class {
         response_mode: "query"
       }
     };
-    if (useRefreshToken !== void 0) {
-      oidcSettings.useRefreshToken = useRefreshToken;
-    }
     return oidcSettings;
   }
   /**
@@ -155,6 +157,9 @@ var useAuth = useAuth$1;
 
 // src/hooks/useTokenLifecycle.ts
 var STORAGE_KEY_PREFIX = "keycloak_first_login_";
+var DEFAULT_MAX_TRANSIENT_RETRIES = 3;
+var DEFAULT_RETRY_INITIAL_DELAY_MS = 1e3;
+var DEFAULT_RETRY_MAX_DELAY_MS = 3e4;
 var isNavigatorOffline = () => typeof navigator !== "undefined" && "onLine" in navigator && navigator.onLine === false;
 var isTransientNetworkError = (error) => {
   const message = error.message?.toLowerCase?.() ?? "";
@@ -190,13 +195,34 @@ function useTokenLifecycle(options) {
   const [isRefreshing, setIsRefreshing] = useState(false);
   const [isRefreshTokenExpired, setIsRefreshTokenExpired] = useState(false);
   const isRefreshingRef = useRef(false);
+  const isMountedRef = useRef(true);
   const hasCheckedOnStartup = useRef(false);
-  const supportsRefreshTokens = config.silentRenew?.useRefreshToken !== false;
+  const allowIframeFallback = config.silentRenew?.allowIframeFallback === true;
   const [pendingRetry, setPendingRetry] = useState(null);
   const deferredRefreshReasonRef = useRef(null);
+  const transientRetryAttemptsRef = useRef(0);
   const enqueueRetry = useCallback((reason) => {
     setPendingRetry((current) => current === reason ? current : reason);
   }, []);
+  const transientRetry = config.silentRenew?.transientRetry;
+  const maxTransientRetries = Math.max(
+    0,
+    transientRetry?.maxAttempts ?? DEFAULT_MAX_TRANSIENT_RETRIES
+  );
+  const retryInitialDelayMs = Math.max(
+    0,
+    transientRetry?.initialDelayMs ?? DEFAULT_RETRY_INITIAL_DELAY_MS
+  );
+  const retryMaxDelayMs = Math.max(
+    retryInitialDelayMs,
+    transientRetry?.maxDelayMs ?? DEFAULT_RETRY_MAX_DELAY_MS
+  );
+  useEffect(() => {
+    isMountedRef.current = true;
+    return () => {
+      isMountedRef.current = false;
+    };
+  }, []);
   const log = useCallback(
     (message, ...args) => {
       if (debug) {
@@ -266,6 +292,7 @@ function useTokenLifecycle(options) {
       log("Starting token refresh");
       await auth.signinSilent();
       log("Token refresh successful");
+      transientRetryAttemptsRef.current = 0;
       onRefreshSuccess?.();
     } catch (error) {
       const err = error instanceof Error ? error : new Error(String(error));
@@ -288,7 +315,15 @@ function useTokenLifecycle(options) {
         deferredRefreshReasonRef.current = reason;
         if (reason === "offline") {
           log("Token refresh deferred because device is offline");
+          transientRetryAttemptsRef.current = 0;
         } else {
+          if (transientRetryAttemptsRef.current >= maxTransientRetries) {
+            deferredRefreshReasonRef.current = null;
+            log("Token refresh retry limit reached:", err.message);
+            onRefreshError?.(err);
+            return;
+          }
+          transientRetryAttemptsRef.current += 1;
           log(
             "Token refresh failed due to transient network issue, will retry automatically:",
             err.message
@@ -314,7 +349,8 @@ function useTokenLifecycle(options) {
     onRefreshTokenExpired,
     enqueueRetry,
     getStorageKey,
-    log
+    log,
+    maxTransientRetries
   ]);
   const shouldRefreshOnResume = useCallback((reason) => {
     const silentRenewEnabled = config.silentRenew?.enabled !== false;
@@ -331,7 +367,7 @@ function useTokenLifecycle(options) {
     if (!auth.user) {
       return false;
     }
-    if (supportsRefreshTokens && !hasRefreshToken) {
+    if (!hasRefreshToken && !allowIframeFallback) {
       log("Skipping resume token check because no refresh token is available:", reason);
       return false;
     }
@@ -345,7 +381,7 @@ function useTokenLifecycle(options) {
     config.silentRenew?.enabled,
     config.silentRenew?.refreshOnResume,
     config.silentRenew?.refreshStrategy,
-    supportsRefreshTokens,
+    allowIframeFallback,
     log
   ]);
   const checkAndRefreshTokens = useCallback(async () => {
@@ -418,10 +454,10 @@ function useTokenLifecycle(options) {
     }
     let cancelled = false;
     const executeRetry = () => {
-      if (cancelled) {
+      if (!isMountedRef.current) {
         return;
       }
-      if (isRefreshing) {
+      if (isRefreshingRef.current) {
         log("Skipping scheduled token refresh retry because a refresh is already in progress");
         return;
       }
@@ -445,19 +481,23 @@ function useTokenLifecycle(options) {
         window.removeEventListener("online", handleOnline);
       };
     }
+    const retryDelay = Math.min(
+      retryInitialDelayMs * 2 ** Math.max(0, transientRetryAttemptsRef.current - 1),
+      retryMaxDelayMs
+    );
     const timeoutId = window.setTimeout(() => {
       if (cancelled) {
         return;
       }
       log("Retrying token refresh after transient network failure delay");
       setPendingRetry(null);
-      executeRetry();
-    }, 5e3);
+      window.setTimeout(executeRetry, 0);
+    }, retryDelay);
     return () => {
       cancelled = true;
       window.clearTimeout(timeoutId);
     };
-  }, [pendingRetry, refreshToken, isRefreshing, log]);
+  }, [pendingRetry, refreshToken, log, retryInitialDelayMs, retryMaxDelayMs]);
   useEffect(() => {
     const strategy = config.silentRenew?.refreshStrategy || "both";
     const shouldCheckOnStartup = strategy === "startup" || strategy === "both";
@@ -469,10 +509,7 @@ function useTokenLifecycle(options) {
       return;
     }
     if (!auth.isAuthenticated) {
-      if (!supportsRefreshTokens) {
-        return;
-      }
-      if (!auth.user || !hasRefreshToken) {
+      if (!auth.user || !hasRefreshToken && !allowIframeFallback) {
         return;
       }
     }
@@ -481,7 +518,7 @@ function useTokenLifecycle(options) {
       "Running startup token check with strategy:",
       strategy,
       "using refresh token:",
-      !auth.isAuthenticated && supportsRefreshTokens
+      !auth.isAuthenticated && hasRefreshToken
     );
     checkAndRefreshTokens().catch((error) => {
       log("Startup token check failed:", error);
@@ -491,7 +528,7 @@ function useTokenLifecycle(options) {
     auth.isLoading,
     auth.user,
     config.silentRenew?.refreshStrategy,
-    supportsRefreshTokens,
+    allowIframeFallback,
     checkAndRefreshTokens,
     log
   ]);
@@ -531,11 +568,11 @@ function useTokenLifecycle(options) {
     if (hasCheckedOnStartup.current) {
       const hasUser = Boolean(auth.user);
       const hasRefreshToken = Boolean(auth.user?.refresh_token);
-      if (!auth.isAuthenticated && (!supportsRefreshTokens || !hasUser || !hasRefreshToken)) {
+      if (!auth.isAuthenticated && (!hasUser || !hasRefreshToken && !allowIframeFallback)) {
         hasCheckedOnStartup.current = false;
       }
     }
-  }, [auth.isAuthenticated, auth.user, supportsRefreshTokens]);
+  }, [auth.isAuthenticated, auth.user, allowIframeFallback]);
   useEffect(() => {
     if (auth.user && !auth.isLoading) {
       storeFirstLoginTime();
@@ -1992,6 +2029,59 @@ function useProtectedFetch(options = {}) {
   };
 }
 
+// src/utils/storedOidcSession.ts
+var getOidcUserStorageKey = (authority, clientId) => {
+  if (!authority || !clientId) {
+    return null;
+  }
+  return `oidc.user:${authority}:${clientId}`;
+};
+var getStoredOidcUser = ({
+  authority,
+  clientId,
+  storage
+}) => {
+  const storageKey = getOidcUserStorageKey(authority, clientId);
+  if (!storageKey || !storage) {
+    return null;
+  }
+  try {
+    const storedUser = storage.getItem(storageKey);
+    if (!storedUser) {
+      return null;
+    }
+    return JSON.parse(storedUser);
+  } catch {
+    return null;
+  }
+};
+var hasStoredOidcRefreshToken = (args) => {
+  const storedUser = getStoredOidcUser(args);
+  return typeof storedUser?.refresh_token === "string" && storedUser.refresh_token.length > 0;
+};
+var getStoredOidcSession = (args) => {
+  const storageKey = getOidcUserStorageKey(args.authority, args.clientId);
+  const storedUser = getStoredOidcUser(args);
+  return {
+    storageKey,
+    storedUser,
+    hasStoredUser: storedUser !== null,
+    hasRefreshToken: typeof storedUser?.refresh_token === "string" && storedUser.refresh_token.length > 0
+  };
+};
+
+// src/hooks/useStoredOidcSession.ts
+var useStoredOidcSession = () => {
+  const auth = useAuth();
+  const { storage } = useStorageConfig();
+  const authority = auth.settings.authority;
+  const clientId = auth.settings.client_id;
+  return useMemo(
+    () => getStoredOidcSession({ authority, clientId, storage }),
+    [authority, clientId, storage]
+  );
+};
+
 // node_modules/@microsoft/signalr/dist/esm/Errors.js
 var HttpError = class extends Error {
   /** Constructs a new instance of {@link @microsoft/signalr.HttpError}.
@@ -5030,6 +5120,6 @@ function useSignalRConnection(hubUrl, options = {}) {
   };
 }
 
-export { CONFIG_PRESETS, DeviceLogin, KeycloakConfigBuilder, KeycloakProvider, KeycloakStatusProvider, LoginButton, LogoutButton, ProtectedRoute, SessionMonitor, TokenBridge, TokenBridgeSync, TokenLifecycleManager, UserProfile, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useSignalRConnection, useTokenLifecycle };
+export { CONFIG_PRESETS, DeviceLogin, KeycloakConfigBuilder, KeycloakProvider, KeycloakStatusProvider, LoginButton, LogoutButton, ProtectedRoute, SessionMonitor, TokenBridge, TokenBridgeSync, TokenLifecycleManager, UserProfile, createTokenBridge, defaultConfig, defaultTokenBridge, fetchUserInfo, getConfigFromEnv, getConfigPreset, getOidcUserStorageKey, getStoredOidcSession, getStoredOidcUser, hasStoredOidcRefreshToken, mergeWithPreset, pollForToken, requestDeviceCode, useAuth, useKeycloakStatus, useProtectedFetch, useRoles, useScopes, useSignalRConnection, useStoredOidcSession, useTokenLifecycle };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map