Interface AuthContextType

Complete authentication context type combining state and actions.

Source

export interface AuthContextType
  extends AuthStateContextValue,
    AuthActionsContextValue {}
interface AuthContextType {
    authState: AuthState;
    isLoading: boolean;
    error: null | string;
    statusMessage: null | string;
    customCredentials: null | ApiCredentials;
    isOnline: boolean;
    wasOffline: boolean;
    login: (credentials: ApiCredentials) => Promise<void>;
    refreshToken: () => Promise<void>;
    logout: () => void;
    cancelAuth: () => Promise<void>;
    setCredentialSource: (source: "default" | "custom") => void;
    updateCustomCredentials: (
        clientId: string,
        clientSecret: string,
        redirectUri: string,
    ) => void;
    enqueueWhenOnline: (taskId: string, fn: () => Promise<void>) => void;
}

Hierarchy (View Summary)

Properties

authState isLoading error statusMessage customCredentials isOnline wasOffline login refreshToken logout cancelAuth setCredentialSource updateCustomCredentials enqueueWhenOnline

Properties

authState

authState: AuthState

Current authentication state.

isLoading

isLoading: boolean

Whether an auth operation is in progress.

error

error: null | string

Current error message, if any.

statusMessage

statusMessage: null | string

Current status message, if any.

customCredentials

customCredentials: null | ApiCredentials

Current custom credentials, if any.

isOnline

isOnline: boolean

Current network connectivity status (updated via Navigator Online API and window online/offline events).

wasOffline

wasOffline: boolean

Whether the app was offline during this session (useful for retry logic after reconnection).

login

login: (credentials: ApiCredentials) => Promise<void>

Log in with credentials.

refreshToken

refreshToken: () => Promise<void>

Refresh the authentication token.

logout

logout: () => void

Log out the user.

cancelAuth

cancelAuth: () => Promise<void>

Cancel an in-progress auth flow.

setCredentialSource

setCredentialSource: (source: "default" | "custom") => void

Set the credential source.

updateCustomCredentials

updateCustomCredentials: (
    clientId: string,
    clientSecret: string,
    redirectUri: string,
) => void

Update custom credentials.

enqueueWhenOnline

enqueueWhenOnline: (taskId: string, fn: () => Promise<void>) => void

Queue a task for execution when online (with deduplication).

Settings

Member Visibility

On This Page

Properties