antaeus.keycloak.react 2.2.2 → 2.3.0

package/README.md

@@ -325,6 +325,24 @@ If your refresh token expires (exceeds `maxRefreshTokenLifetime`):
 />
 ```
 
+### Refresh Tokens After Restart
+
+When a refresh token is available the provider now reuses it on startup, ensuring long-lived sessions survive browser reloads or app restarts. The refresh token grant is attempted automatically before falling back to iframe-based silent renew.
+
+If you need to disable this behavior and revert to iframe-only silent renew, set:
+
+```tsx
+<KeycloakProvider
+  authority="..."
+  clientId="my-app"
+  config={{
+    silentRenew: {
+      useRefreshToken: false,
+    },
+  }}
+/>
+```
+
 ### Startup Token Refresh
 
 When your app loads with an existing session:
@@ -446,4 +464,3 @@ const { fetchJson } = useProtectedFetch({
 ## License
 
 MIT � Saeed Aghdam
-

package/dist/index.d.mts

@@ -113,6 +113,12 @@ interface SilentRenewConfig {
      * @default 'Refreshing session...'
      */
     loadingMessage?: string;
+    /**
+     * Enable using the refresh token grant instead of iframe silent renew when available.
+     * Keeps long-lived sessions alive even after the app is closed.
+     * @default true
+     */
+    useRefreshToken?: boolean;
 }
 /**
  * Event callbacks for authentication lifecycle
@@ -318,6 +324,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  *     silentRenew: {
  *       maxRefreshTokenLifetime: 604800, // Override: 7 days instead of 30
  *       showLoadingIndicator: true,
+ *       useRefreshToken: true, // Explicitly ensure refresh tokens are used when available
  *     }
  *   }}
  *   debug={true}
@@ -361,6 +368,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  *       enabled: true,
  *       refreshStrategy: 'both',
  *       maxRefreshTokenLifetime: 2592000,
+ *       useRefreshToken: true,
  *     },
  *     events: {
  *       onLogin: (user) => console.log('User logged in', user),
@@ -380,6 +388,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  * - ✅ Token lifecycle management (refresh on app startup)
  * - ✅ Session monitoring UI (countdown timer)
  * - ✅ Silent renew (background token refresh)
+ * - ✅ Refresh token grant fallback on app restart
  * - ✅ Error notifications (user-friendly messages)
  * - ✅ 401 retry logic (automatic token refresh on API errors)
  * - ✅ Maximum refresh token lifetime (security control)

package/dist/index.d.ts

@@ -113,6 +113,12 @@ interface SilentRenewConfig {
      * @default 'Refreshing session...'
      */
     loadingMessage?: string;
+    /**
+     * Enable using the refresh token grant instead of iframe silent renew when available.
+     * Keeps long-lived sessions alive even after the app is closed.
+     * @default true
+     */
+    useRefreshToken?: boolean;
 }
 /**
  * Event callbacks for authentication lifecycle
@@ -318,6 +324,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  *     silentRenew: {
  *       maxRefreshTokenLifetime: 604800, // Override: 7 days instead of 30
  *       showLoadingIndicator: true,
+ *       useRefreshToken: true, // Explicitly ensure refresh tokens are used when available
  *     }
  *   }}
  *   debug={true}
@@ -361,6 +368,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  *       enabled: true,
  *       refreshStrategy: 'both',
  *       maxRefreshTokenLifetime: 2592000,
+ *       useRefreshToken: true,
  *     },
  *     events: {
  *       onLogin: (user) => console.log('User logged in', user),
@@ -380,6 +388,7 @@ type KeycloakProviderProps = KeycloakProviderZeroConfigProps | KeycloakProviderF
  * - ✅ Token lifecycle management (refresh on app startup)
  * - ✅ Session monitoring UI (countdown timer)
  * - ✅ Silent renew (background token refresh)
+ * - ✅ Refresh token grant fallback on app restart
  * - ✅ Error notifications (user-friendly messages)
  * - ✅ 401 retry logic (automatic token refresh on API errors)
  * - ✅ Maximum refresh token lifetime (security control)

package/dist/index.js

@@ -30,7 +30,8 @@ var defaultConfig = {
     maxRefreshTokenLifetime: 2592e3,
     // 30 days in seconds
     showLoadingIndicator: false,
-    loadingMessage: "Refreshing session..."
+    loadingMessage: "Refreshing session...",
+    useRefreshToken: true
   },
   advanced: {
     responseType: "code",
@@ -56,6 +57,7 @@ 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,
@@ -73,6 +75,9 @@ var KeycloakConfigBuilder = class {
         response_mode: "query"
       }
     };
+    if (useRefreshToken !== void 0) {
+      oidcSettings.useRefreshToken = useRefreshToken;
+    }
     return oidcSettings;
   }
   /**
@@ -160,6 +165,7 @@ function useTokenLifecycle(options) {
   const [isRefreshing, setIsRefreshing] = react.useState(false);
   const [isRefreshTokenExpired, setIsRefreshTokenExpired] = react.useState(false);
   const hasCheckedOnStartup = react.useRef(false);
+  const supportsRefreshTokens = config.silentRenew?.useRefreshToken !== false;
   const log = react.useCallback(
     (message, ...args) => {
       if (debug) {
@@ -296,24 +302,49 @@ function useTokenLifecycle(options) {
   react.useEffect(() => {
     const strategy = config.silentRenew?.refreshStrategy || "both";
     const shouldCheckOnStartup = strategy === "startup" || strategy === "both";
+    const hasRefreshToken = Boolean(auth.user?.refresh_token);
     if (!shouldCheckOnStartup || hasCheckedOnStartup.current) {
       return;
     }
-    if (!auth.isAuthenticated || auth.isLoading) {
+    if (auth.isLoading) {
       return;
     }
+    if (!auth.isAuthenticated) {
+      if (!supportsRefreshTokens) {
+        return;
+      }
+      if (!auth.user || !hasRefreshToken) {
+        return;
+      }
+    }
     hasCheckedOnStartup.current = true;
-    log("Running startup token check with strategy:", strategy);
+    log(
+      "Running startup token check with strategy:",
+      strategy,
+      "using refresh token:",
+      !auth.isAuthenticated && supportsRefreshTokens
+    );
     checkAndRefreshTokens().catch((error) => {
       log("Startup token check failed:", error);
     });
   }, [
     auth.isAuthenticated,
     auth.isLoading,
+    auth.user,
     config.silentRenew?.refreshStrategy,
+    supportsRefreshTokens,
     checkAndRefreshTokens,
     log
   ]);
+  react.useEffect(() => {
+    if (hasCheckedOnStartup.current) {
+      const hasUser = Boolean(auth.user);
+      const hasRefreshToken = Boolean(auth.user?.refresh_token);
+      if (auth.isLoading || !auth.isAuthenticated && (!supportsRefreshTokens || !hasUser || !hasRefreshToken)) {
+        hasCheckedOnStartup.current = false;
+      }
+    }
+  }, [auth.isAuthenticated, auth.isLoading, auth.user, supportsRefreshTokens]);
   react.useEffect(() => {
     if (auth.user && !auth.isLoading) {
       storeFirstLoginTime();
@@ -837,6 +868,15 @@ function mergeWithPreset(preset, customConfig) {
     }
   };
 }
+var StorageConfigContext = react.createContext({
+  storageType: "session",
+  storage: typeof window !== "undefined" ? window.sessionStorage : {}
+});
+var StorageConfigProvider = ({ storageType, children }) => {
+  const storage = storageType === "local" ? window.localStorage : window.sessionStorage;
+  return /* @__PURE__ */ jsxRuntime.jsx(StorageConfigContext.Provider, { value: { storageType, storage }, children });
+};
+var useStorageConfig = () => react.useContext(StorageConfigContext);
 function isZeroConfig(props) {
   return "authority" in props && "clientId" in props;
 }
@@ -882,6 +922,7 @@ var KeycloakProvider = (props) => {
     log("warn", "User removed from storage - token validation likely failed");
   }, [log]);
   const showSessionMonitor = config.features?.sessionMonitor !== false;
+  const storageType = config.advanced?.storageType || "session";
   return /* @__PURE__ */ jsxRuntime.jsx(
     reactOidcContext.AuthProvider,
     {
@@ -889,10 +930,10 @@ var KeycloakProvider = (props) => {
       onSigninCallback,
       onSignoutCallback,
       onRemoveUser,
-      children: /* @__PURE__ */ jsxRuntime.jsxs(TokenLifecycleManager, { config, debug, children: [
+      children: /* @__PURE__ */ jsxRuntime.jsx(StorageConfigProvider, { storageType, children: /* @__PURE__ */ jsxRuntime.jsxs(TokenLifecycleManager, { config, debug, children: [
         showSessionMonitor && /* @__PURE__ */ jsxRuntime.jsx(SessionMonitor, {}),
         children
-      ] })
+      ] }) })
     }
   );
 };
@@ -1349,6 +1390,7 @@ var DeviceLogin = ({
   style
 }) => {
   const auth = useAuth();
+  const { storage, storageType } = useStorageConfig();
   const [deviceData, setDeviceData] = react.useState(null);
   const [error, setError] = react.useState(null);
   const [loading, setLoading] = react.useState(true);
@@ -1415,10 +1457,10 @@ var DeviceLogin = ({
           });
           const storageKey = `oidc.user:${auth.settings.authority}:${auth.settings.client_id}`;
           const userJson = user.toStorageString();
-          const storage = auth.settings.userStore?.store || window.sessionStorage;
           console.log("[DeviceLogin] Storing user in storage...", {
             storageKey,
-            storageType: storage === window.localStorage ? "localStorage" : "sessionStorage"
+            storageType,
+            storage: storageType === "local" ? "localStorage" : "sessionStorage"
           });
           storage.setItem(storageKey, userJson);
           const stored = storage.getItem(storageKey);
@@ -1426,7 +1468,7 @@ var DeviceLogin = ({
             console.error("[DeviceLogin] Failed to store user in storage!");
             throw new Error("Failed to store user session. Please try again.");
           }
-          console.log("[DeviceLogin] User stored successfully in", storage === window.localStorage ? "localStorage" : "sessionStorage");
+          console.log("[DeviceLogin] User stored successfully in", storageType === "local" ? "localStorage" : "sessionStorage");
           if (onSuccess) {
             await new Promise((resolve) => setTimeout(resolve, 100));
             onSuccess(user);