Interface IAuthService

Authentication service interface. Manages user authentication and session state.

interface IAuthService {
    state: ServiceState;
    dispose(): Promise<void>;
    getAuthState(): Promise<AuthState>;
    getCurrentUser(): null | UserJSON;
    initialize(): Promise<void>;
    isAuthenticated(): boolean;
    login(runUrl: string, token: string): Promise<UserJSON>;
    logout(): Promise<void>;
    onAuthStateChanged(callback: (change: AuthStateChange) => void): () => void;
}

Hierarchy (View Summary)

ILifecycle
- IAuthService

Implemented by

AuthService

Index

Properties

Methods

dispose getAuthState getCurrentUser initialize isAuthenticated login logout onAuthStateChanged

Properties

`Readonly`state

state: ServiceState

Current state of the service.

Methods

dispose

dispose(): Promise<void>
Disposes the service and cleans up resources. Should be called during application shutdown.

Returns Promise<void>
Inherited from ILifecycle.dispose
- Defined in src/renderer/services/interfaces/ILifecycle.ts:38

getAuthState

getAuthState(): Promise<AuthState>
Get current authentication state.

Returns Promise<AuthState>
- Defined in src/renderer/services/interfaces/IAuthService.ts:35

getCurrentUser

getCurrentUser(): null | UserJSON
Get current user.

Returns null | UserJSON
- Defined in src/renderer/services/interfaces/IAuthService.ts:55

initialize

initialize(): Promise<void>
Initializes the service. Should be called before any other service methods.

Returns Promise<void>
Inherited from ILifecycle.initialize
- Defined in src/renderer/services/interfaces/ILifecycle.ts:32

isAuthenticated

isAuthenticated(): boolean
Check if user is authenticated.

Returns boolean
- Defined in src/renderer/services/interfaces/IAuthService.ts:50

login(runUrl: string, token: string): Promise<UserJSON>
Login user with provided credentials.
Parameters
- runUrl: string
- token: string
Returns Promise<UserJSON>
- Defined in src/renderer/services/interfaces/IAuthService.ts:40

logout

logout(): Promise<void>
Logout current user.

Returns Promise<void>
- Defined in src/renderer/services/interfaces/IAuthService.ts:45

onAuthStateChanged

onAuthStateChanged(callback: (change: AuthStateChange) => void): () => void
Subscribe to authentication state changes.
Parameters
- callback: (change: AuthStateChange) => void
Returns () => void
- Defined in src/renderer/services/interfaces/IAuthService.ts:60