keycloak-angular 19.0.2 → 20.0.0

package/lib/provide-keycloak.d.ts

@@ -1,74 +0,0 @@
-/**
- * @license
- * Copyright Mauricio Gemelli Vigolo All Rights Reserved.
- *
- * Use of this source code is governed by a MIT-style license that can be
- * found in the LICENSE file at https://github.com/mauriciovigolo/keycloak-angular/blob/main/LICENSE.md
- */
-import { KeycloakConfig, KeycloakInitOptions } from 'keycloak-js';
-import { EnvironmentProviders, Provider } from '@angular/core';
-import { KeycloakFeature } from './features/keycloak.feature';
-/**
- * Options for configuring Keycloak and additional providers.
- */
-export type ProvideKeycloakOptions = {
-    /**
-     * Keycloak configuration, including the server URL, realm, and client ID.
-     */
-    config: KeycloakConfig;
-    /**
-     * Optional initialization options for the Keycloak instance.
-     * If not provided, Keycloak will not initialize automatically.
-     */
-    initOptions?: KeycloakInitOptions;
-    /**
-     * Optional array of additional Angular providers or environment providers.
-     */
-    providers?: Array<Provider | EnvironmentProviders>;
-    /**
-     * Optional array of Keycloak features to extend the functionality of the Keycloak integration.
-     */
-    features?: Array<KeycloakFeature>;
-};
-/**
- * Configures and provides Keycloak as a dependency in an Angular application.
- *
- * This function initializes a Keycloak instance with the provided configuration and
- * optional initialization options. It integrates Keycloak into Angular dependency
- * injection system, allowing easy consumption throughout the application. Additionally,
- * it supports custom providers and Keycloak Angular features.
- *
- * If `initOptions` is not provided, the Keycloak instance will not be automatically initialized.
- * In such cases, the application must call `keycloak.init()` explicitly.
- *
- * @param options - Configuration object for Keycloak:
- *   - `config`: The Keycloak configuration, including the server URL, realm, and client ID.
- *   - `initOptions` (Optional): Initialization options for the Keycloak instance.
- *   - `providers` (Optional): Additional Angular providers to include.
- *   - `features` (Optional): Keycloak Angular features to configure during initialization.
- *
- * @returns An `EnvironmentProviders` object integrating Keycloak setup and additional providers.
- *
- * @example
- * ```ts
- * import { provideKeycloak } from './keycloak.providers';
- * import { bootstrapApplication } from '@angular/platform-browser';
- * import { AppComponent } from './app/app.component';
- *
- * bootstrapApplication(AppComponent, {
- *   providers: [
- *     provideKeycloak({
- *       config: {
- *         url: 'https://auth-server.example.com',
- *         realm: 'my-realm',
- *         clientId: 'my-client',
- *       },
- *       initOptions: {
- *         onLoad: 'login-required',
- *       },
- *     }),
- *   ],
- * });
- * ```
- */
-export declare function provideKeycloak(options: ProvideKeycloakOptions): EnvironmentProviders;

package/lib/services/auto-refresh-token.service.d.ts

@@ -1,47 +0,0 @@
-import Keycloak from 'keycloak-js';
-import { UserActivityService } from './user-activity.service';
-import * as i0 from "@angular/core";
-/**
- * Configuration options for the `AutoRefreshTokenService`.
- */
-type AutoRefreshTokenOptions = {
-    /**
-     * Maximum allowed inactivity duration in milliseconds before
-     * the session times out. Default is `50000`.
-     */
-    sessionTimeout?: number;
-    /**
-     * Action to take when the session times out due to inactivity.
-     * Options are:
-     * - `'login'`: Redirect to the Keycloak login page.
-     * - `'logout'`: Log the user out of the session.
-     * - `'none'`: Do nothing.
-     * Default is `'logout'`.
-     */
-    onInactivityTimeout?: 'login' | 'logout' | 'none';
-};
-/**
- * Service to automatically manage the Keycloak token refresh process
- * based on user activity and token expiration events. This service
- * integrates with Keycloak for session management and interacts with
- * user activity monitoring to determine the appropriate action when
- * the token expires.
- *
- * The service listens to `KeycloakSignal` for token-related events
- * (e.g., `TokenExpired`) and provides configurable options for
- * session timeout and inactivity handling.
- */
-export declare class AutoRefreshTokenService {
-    private readonly keycloak;
-    private readonly userActivity;
-    private options;
-    private initialized;
-    constructor(keycloak: Keycloak, userActivity: UserActivityService);
-    private get defaultOptions();
-    private executeOnInactivityTimeout;
-    private processTokenExpiredEvent;
-    start(options?: AutoRefreshTokenOptions): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AutoRefreshTokenService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AutoRefreshTokenService>;
-}
-export {};

package/lib/services/user-activity.service.d.ts

@@ -1,66 +0,0 @@
-/**
- * @license
- * Copyright Mauricio Gemelli Vigolo All Rights Reserved.
- *
- * Use of this source code is governed by a MIT-style license that can be
- * found in the LICENSE file at https://github.com/mauriciovigolo/keycloak-angular/blob/main/LICENSE.md
- */
-import { OnDestroy, NgZone } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * Service to monitor user activity in an Angular application.
- * Tracks user interactions (e.g., mouse movement, touch, key presses, clicks, and scrolls)
- * and updates the last activity timestamp. Consumers can check for user inactivity
- * based on a configurable timeout.
- *
- * The service is supposed to be used in the client context and for safety, it checks during the startup
- * if it is a browser context.
- */
-export declare class UserActivityService implements OnDestroy {
-    private ngZone;
-    /**
-     * Signal to store the timestamp of the last user activity.
-     * The timestamp is represented as the number of milliseconds since epoch.
-     */
-    private lastActivity;
-    /**
-     * Subject to signal the destruction of the service.
-     * Used to clean up RxJS subscriptions.
-     */
-    private destroy$;
-    /**
-     * Computed signal to expose the last user activity as a read-only signal.
-     */
-    readonly lastActivitySignal: import("@angular/core").Signal<number>;
-    constructor(ngZone: NgZone);
-    /**
-     * Starts monitoring user activity events (`mousemove`, `touchstart`, `keydown`, `click`, `scroll`)
-     * and updates the last activity timestamp using RxJS with debounce.
-     * The events are processed outside Angular zone for performance optimization.
-     */
-    startMonitoring(): void;
-    /**
-     * Updates the last activity timestamp to the current time.
-     * This method runs inside Angular's zone to ensure reactivity with Angular signals.
-     */
-    private updateLastActivity;
-    /**
-     * Retrieves the timestamp of the last recorded user activity.
-     * @returns {number} The last activity timestamp in milliseconds since epoch.
-     */
-    get lastActivityTime(): number;
-    /**
-     * Determines whether the user interacted with the application, meaning it is activily using the application, based on
-     * the specified duration.
-     * @param timeout - The inactivity timeout in milliseconds.
-     * @returns {boolean} `true` if the user is inactive, otherwise `false`.
-     */
-    isActive(timeout: number): boolean;
-    /**
-     * Cleans up RxJS subscriptions and resources when the service is destroyed.
-     * This method is automatically called by Angular when the service is removed.
-     */
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<UserActivityService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<UserActivityService>;
-}

package/lib/signals/keycloak-events-signal.d.ts

@@ -1,118 +0,0 @@
-/**
- * @license
- * Copyright Mauricio Gemelli Vigolo All Rights Reserved.
- *
- * Use of this source code is governed by a MIT-style license that can be
- * found in the LICENSE file at https://github.com/mauriciovigolo/keycloak-angular/blob/main/LICENSE.md
- */
-import Keycloak, { KeycloakError } from 'keycloak-js';
-import { Signal, InjectionToken } from '@angular/core';
-/**
- * Keycloak event types, as described at the keycloak-js documentation:
- * https://www.keycloak.org/docs/latest/securing_apps/index.html#callback-events
- */
-export declare enum KeycloakEventType {
-    /**
-     * Keycloak Angular is not initialized yet. This is the initial state applied to the Keycloak Event Signal.
-     * Note: This event is only emitted in Keycloak Angular, it is not part of the keycloak-js.
-     */
-    KeycloakAngularNotInitialized = "KeycloakAngularNotInitialized",
-    /**
-     * Keycloak Angular is in the process of initializing the providers and Keycloak Instance.
-     * Note: This event is only emitted in Keycloak Angular, it is not part of the keycloak-js.
-     */
-    KeycloakAngularInit = "KeycloakAngularInit",
-    /**
-     * Triggered if there is an error during authentication.
-     */
-    AuthError = "AuthError",
-    /**
-     * Triggered when the user logs out. This event will only be triggered
-     * if the session status iframe is enabled or in Cordova mode.
-     */
-    AuthLogout = "AuthLogout",
-    /**
-     * Triggered if an error occurs while attempting to refresh the token.
-     */
-    AuthRefreshError = "AuthRefreshError",
-    /**
-     * Triggered when the token is successfully refreshed.
-     */
-    AuthRefreshSuccess = "AuthRefreshSuccess",
-    /**
-     * Triggered when a user is successfully authenticated.
-     */
-    AuthSuccess = "AuthSuccess",
-    /**
-     * Triggered when the Keycloak adapter has completed initialization.
-     */
-    Ready = "Ready",
-    /**
-     * Triggered when the access token expires. Depending on the flow, you may
-     * need to use `updateToken` to refresh the token or redirect the user
-     * to the login screen.
-     */
-    TokenExpired = "TokenExpired",
-    /**
-     * Triggered when an authentication action is requested by the application.
-     */
-    ActionUpdate = "ActionUpdate"
-}
-/**
- * Arguments for the `Ready` event, representing the authentication state.
- */
-export type ReadyArgs = boolean;
-/**
- * Arguments for the `ActionUpdate` event, providing information about the status
- * and optional details about the action.
- */
-export type ActionUpdateArgs = {
-    /**
-     * Status of the action, indicating whether it was successful, encountered an error,
-     * or was cancelled.
-     */
-    status: 'success' | 'error' | 'cancelled';
-    /**
-     * Optional name or identifier of the action performed.
-     */
-    action?: string;
-};
-/**
- * Arguments for the `AuthError` event, providing detailed error information.
- */
-export type AuthErrorArgs = KeycloakError;
-type EventArgs = ReadyArgs | ActionUpdateArgs | AuthErrorArgs;
-/**
- * Helper function to typecast unknown arguments into a specific Keycloak event type.
- *
- * @template T - The expected argument type.
- * @param args - The arguments to be cast.
- * @returns The arguments typed as `T`.
- */
-export declare const typeEventArgs: <T extends EventArgs>(args: unknown) => T;
-/**
- * Structure of a Keycloak event, including its type and optional arguments.
- */
-export interface KeycloakEvent {
-    /**
-     * Event type as described at {@link KeycloakEventType}.
-     */
-    type: KeycloakEventType;
-    /**
-     * Arguments from the keycloak-js event function.
-     */
-    args?: unknown;
-}
-/**
- * Creates a signal to manage Keycloak events, initializing the signal with
- * appropriate default values or values from a given Keycloak instance.
- *
- * @param keycloak - An instance of the Keycloak client.
- * @returns A `Signal` that tracks the current Keycloak event state.
- */
-export declare const createKeycloakSignal: (keycloak?: Keycloak) => import("@angular/core").WritableSignal<KeycloakEvent>;
-/**
- * Injection token for the Keycloak events signal, used for dependency injection.
- */
-export declare const KEYCLOAK_EVENT_SIGNAL: InjectionToken<Signal<KeycloakEvent>>;
-export {};

package/public_api.d.ts

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright Mauricio Gemelli Vigolo All Rights Reserved.
- *
- * Use of this source code is governed by a MIT-style license that can be
- * found in the LICENSE file at https://github.com/mauriciovigolo/keycloak-angular/blob/main/LICENSE.md
- */
-export * from './lib/legacy/public_api';
-export * from './lib/directives/has-roles.directive';
-export * from './lib/features/keycloak.feature';
-export * from './lib/features/with-refresh-token.feature';
-export * from './lib/guards/auth.guard';
-export * from './lib/interceptors/custom-bearer-token.interceptor';
-export * from './lib/interceptors/include-bearer-token.interceptor';
-export * from './lib/interceptors/keycloak.interceptor';
-export * from './lib/services/user-activity.service';
-export * from './lib/services/auto-refresh-token.service';
-export * from './lib/signals/keycloak-events-signal';
-export * from './lib/provide-keycloak';