formreader-session-timeout 0.2.3 → 0.2.5

package/dist/index.d.ts

@@ -17,6 +17,8 @@ interface SessionConfig {
     refreshEndpoint: string;
     /** Endpoint to call for logout */
     logoutEndpoint: string;
+    /** Whether to track idle time */
+    trackIdleTime?: boolean;
     /** Whether to show idle warning dialog */
     showIdleWarning: boolean;
     /** Time before idle timeout to show warning (milliseconds) */
@@ -27,6 +29,8 @@ interface SessionConfig {
     onIdle?: () => void;
     /** Callback when session has expired */
     onSessionExpired?: () => void;
+    /** Callback when user logs out */
+    onLogout?: () => void;
     /** Callback on refresh success */
     onRefreshSuccess?: () => void;
     /** Callback on refresh failure */
@@ -41,10 +45,24 @@ interface SessionConfig {
             data: any;
         }>;
     };
-    /** Custom function to format the refresh request payload. Allows you to define exactly what data is sent to your API. */
-    refreshPayloadFormatter?: (token: string) => Record<string, any>;
-    /** Custom function to format the logout request payload. Allows you to define exactly what data is sent to your API. */
-    logoutPayloadFormatter?: (token: string) => Record<string, any>;
+    /** Custom function to format the refresh request payload */
+    refreshPayloadFormatter?: (token: string, refreshToken: string) => Record<string, any>;
+    /** Custom function to format the logout request payload */
+    logoutPayloadFormatter?: (token: string, refreshToken?: string) => Record<string, any>;
+    /** Which field in login response contains access token (default: 'access') */
+    accessTokenField?: string;
+    /** Which field in login response contains refresh token (default: 'refresh') */
+    refreshTokenField?: string;
+    /** Which field in refresh response contains new access token (default: 'access') */
+    refreshAccessTokenField?: string;
+    /** Which field in refresh response contains new refresh token (default: 'refresh') */
+    refreshRefreshTokenField?: string;
+    /** Whether to store refresh token separately (default: true) */
+    storeRefreshToken?: boolean;
+    /** Whether to validate token on page reload/initialization (default: true) */
+    validateOnInit?: boolean;
+    /** Custom token validation endpoint for server-side validation */
+    tokenValidationEndpoint?: string;
 }
 interface JWTPayload {
     exp: number;
@@ -77,6 +95,7 @@ declare const DEFAULT_SESSION_CONFIG: SessionConfig;
 /**
  * Session Manager Service
  * Manages token refresh, idle tracking, and session lifecycle
+ * Supports configurable token response field mapping
  */
 
 declare class SessionManager {
@@ -90,15 +109,16 @@ declare class SessionManager {
     private requestDeduplication;
     constructor(config: Partial<SessionConfig>);
     /**
-     * Initialize session management
+     * Initialize session management with optional login response
+     * Extracts and stores tokens from login response using configured field names
      */
-    init(): void;
+    init(loginResponse?: any): void;
     /**
      * Setup token refresh before expiry
      */
     private setupTokenRefresh;
     /**
-     * Setup idle activity tracking
+     * Setup idle tracking with activity listeners
      */
     private setupIdleTracking;
     /**
@@ -106,27 +126,30 @@ declare class SessionManager {
      */
     private setupMaxSessionDuration;
     /**
-     * Refresh token
+     * Refresh token using stored refresh token
      */
     refreshToken(): Promise<boolean>;
     /**
-     * Logout and cleanup
+     * Manual logout
      */
     logout(): Promise<void>;
     /**
-     * Extend session (reset idle timer)
+     * Check if session is active and token is valid
      */
-    extendSession(): void;
+    isActive(): boolean;
     /**
-     * Get current state
+     * Validate current session without initializing
      */
-    getState(): SessionState;
+    validateSession(): {
+        isValid: boolean;
+        reason?: string;
+    };
     /**
-     * Get current config
+     * Get current state
      */
-    getConfig(): SessionConfig;
+    getState(): SessionState;
     /**
-     * Update config
+     * Update config at runtime
      */
     updateConfig(newConfig: Partial<SessionConfig>): void;
     /**
@@ -171,48 +194,75 @@ declare function isTokenExpired(token: string, bufferMs?: number): boolean;
  */
 declare function getTimeUntilExpiry(token: string): number;
 /**
- * Extract token from storage
+ * Extract token from storage (access token)
  */
 declare function getStoredToken(): string | null;
+/**
+ * Extract refresh token from storage
+ */
+declare function getStoredRefreshToken(): string | null;
 /**
  * Store token in appropriate storage
  */
 declare function storeToken(token: string, persistent?: boolean): void;
 /**
- * Clear stored token
+ * Store refresh token in appropriate storage
+ */
+declare function storeRefreshToken(token: string, persistent?: boolean): void;
+/**
+ * Clear all tokens from storage
  */
 declare function clearToken(): void;
 /**
- * Validate token structure and expiry
+ * Validate token structure
  */
-declare function validateToken(token: string): {
-    valid: boolean;
-    error?: string;
-};
+declare function validateToken(token: string): boolean;
+
+/**
+ * Authentication utilities for session validation
+ */
+/**
+ * Check if user is authenticated with valid token
+ * This is the function to use in your App.tsx for page reload validation
+ */
+declare function isAuthenticated(): boolean;
+/**
+ * Initialize session with token validation on page reload
+ * Returns a promise that resolves to authentication status
+ */
+declare function initializeAuth(config?: any): Promise<boolean>;
+/**
+ * Trigger auth change event for cross-tab synchronization
+ */
+declare function triggerAuthChange(): void;
 
 /**
  * useSessionTimeout Hook
- * React hook for session timeout management in components
+ * React hook for managing session timeout
  */
 
-interface UseSessionTimeoutOptions {
-    config?: Partial<SessionConfig>;
-    enabled?: boolean;
-    onSessionExpiring?: () => void;
-    onSessionExpired?: () => void;
-    onIdle?: () => void;
-    onRefreshSuccess?: () => void;
+interface UseSessionTimeoutOptions extends Partial<SessionConfig> {
+    /**
+     * Optional login response from your authentication endpoint
+     * Used to extract tokens from response if provided
+     */
+    loginResponse?: any;
+    /**
+     * Whether to automatically initialize on mount
+     */
+    autoInit?: boolean;
 }
 declare function useSessionTimeout(options?: UseSessionTimeoutOptions): {
-    sessionState: SessionState;
-    timeUntilExpiry: any;
+    isActive: boolean;
+    isIdle: boolean;
+    isRefreshing: boolean;
+    refreshAttempts: number;
+    timeUntilTimeout: number;
     timeUntilIdle: number;
-    idleWarningVisible: boolean;
-    extendSession: () => void;
+    error: Error;
     refreshToken: () => Promise<boolean>;
     logout: () => Promise<void>;
-    updateConfig: (newConfig: Partial<SessionConfig>) => void;
-    manager: SessionManager;
+    dismissIdleWarning: () => void;
 };
 
 /**
@@ -221,4 +271,4 @@ declare function useSessionTimeout(options?: UseSessionTimeoutOptions): {
  */
 declare function SessionStatus(): react_jsx_runtime.JSX.Element;
 
-export { DEFAULT_SESSION_CONFIG, JWTPayload, RefreshTokenResponse, SessionConfig, SessionManager, SessionState, SessionStatus, TokenInfo, UseSessionTimeoutOptions, clearToken, getSessionManager, getStoredToken, getTimeUntilExpiry, getTokenInfo, isTokenExpired, resetSessionManager, storeToken, useSessionTimeout, validateToken };
+export { DEFAULT_SESSION_CONFIG, JWTPayload, RefreshTokenResponse, SessionConfig, SessionManager, SessionState, SessionStatus, TokenInfo, UseSessionTimeoutOptions, clearToken, getSessionManager, getStoredRefreshToken, getStoredToken, getTimeUntilExpiry, getTokenInfo, initializeAuth, isAuthenticated, isTokenExpired, resetSessionManager, storeRefreshToken, storeToken, triggerAuthChange, useSessionTimeout, validateToken };