@codex-ts/core-lib 1.0.16 → 1.0.18

package/lib/keycloak/keycloak-config.interface.d.ts

@@ -1,19 +1,68 @@
+/**
+ * Keycloak initialization options
+ */
+export interface KeycloakInitOptions {
+    /** Authentication flow type */
+    onLoad: 'check-sso' | 'login-required' | 'check-sso-silent';
+    /** URL for silent SSO check */
+    silentCheckSsoRedirectUri?: string;
+    /** Enable/disable iframe check for SSO */
+    checkLoginIframe?: boolean;
+    /** Interval in seconds to check login state */
+    checkLoginIframeInterval?: number;
+    /** URI to redirect to after login */
+    redirectUri?: string;
+    /** OAuth2 flow type */
+    flow?: 'standard' | 'implicit' | 'hybrid';
+}
+/**
+ * Keycloak login options
+ */
+export interface KeycloakLoginOptions {
+    /** URI to redirect to after login */
+    redirectUri?: string;
+    /** Login prompt type */
+    prompt?: 'none' | 'login' | 'consent';
+    /** Maximum authentication age in seconds */
+    maxAge?: number;
+    /** Hint for the username/email field */
+    loginHint?: string;
+    /** Identity provider hint */
+    idpHint?: string;
+    /** OAuth2 scope */
+    scope?: string;
+}
+/**
+ * Keycloak error response from server
+ */
+export interface KeycloakErrorResponse {
+    error: string;
+    error_description: string;
+}
+/**
+ * Main Keycloak configuration
+ */
 export interface KeycloakConfig {
+    /** Keycloak server URL (e.g., http://localhost:8180/auth) */
     authServerUrl: string;
+    /** Realm name */
     realm: string;
+    /** Client ID */
     clientId: string;
+    /** OAuth2 scope */
     scope?: string;
+    /** Enable/disable SSO */
     useSSO?: boolean;
+    /** Enable/disable bearer token interceptor */
     enableBearerInterceptor?: boolean;
+    /** Token validity threshold in seconds */
     tokenValidityInSeconds?: number;
+    /** URLs to exclude from bearer token injection */
     bearerExcludedUrls?: string[];
+    /** URL for silent SSO check */
     silentCheckSsoRedirectUri?: string;
+    /** Login options */
     loginOptions?: KeycloakLoginOptions;
-}
-export interface KeycloakLoginOptions {
-    redirectUri?: string;
-    prompt?: 'none' | 'login' | 'consent';
-    maxAge?: number;
-    loginHint?: string;
-    idpHint?: string;
+    /** Initialization options */
+    initOptions?: Partial<KeycloakInitOptions>;
 }

package/lib/keycloak/keycloak.interceptor.d.ts

@@ -0,0 +1,11 @@
+import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { KeycloakService } from './keycloak.service';
+import * as i0 from "@angular/core";
+export declare class KeycloakAuthInterceptor implements HttpInterceptor {
+    private keycloakService;
+    constructor(keycloakService: KeycloakService);
+    intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakAuthInterceptor, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakAuthInterceptor>;
+}

package/lib/keycloak/keycloak.providers.d.ts

@@ -1,6 +1,31 @@
 import { KeycloakConfig } from './keycloak-config.interface';
 import { KeycloakService } from './keycloak.service';
+import { KeycloakAuthInterceptor } from './keycloak.interceptor';
+export declare function initializeKeycloak(keycloak: KeycloakService): () => Promise<boolean>;
+/**
+ * Provides Keycloak authentication and authorization services
+ * @param config Keycloak configuration
+ * @returns Array of providers for Keycloak integration
+ */
 export declare function provideKeycloak(config: KeycloakConfig): (typeof KeycloakService | import("@angular/core").EnvironmentProviders | {
     provide: import("@angular/core").InjectionToken<KeycloakConfig>;
     useValue: KeycloakConfig;
+    useFactory?: undefined;
+    multi?: undefined;
+    deps?: undefined;
+    useClass?: undefined;
+} | {
+    provide: import("@angular/core").InjectionToken<readonly (() => import("rxjs").Observable<unknown> | Promise<unknown> | void)[]>;
+    useFactory: typeof initializeKeycloak;
+    multi: boolean;
+    deps: (typeof KeycloakService)[];
+    useValue?: undefined;
+    useClass?: undefined;
+} | {
+    provide: import("@angular/core").InjectionToken<readonly import("@angular/common/http").HttpInterceptor[]>;
+    useClass: typeof KeycloakAuthInterceptor;
+    multi: boolean;
+    useValue?: undefined;
+    useFactory?: undefined;
+    deps?: undefined;
 })[];

package/lib/keycloak/keycloak.service.d.ts

@@ -1,4 +1,20 @@
 import * as i0 from "@angular/core";
+/** Keycloak error types */
+export declare enum KeycloakErrorType {
+    SCRIPT_LOAD = "SCRIPT_LOAD_ERROR",
+    INIT = "INIT_ERROR",
+    TOKEN_REFRESH = "TOKEN_REFRESH_ERROR",
+    PROFILE_LOAD = "PROFILE_LOAD_ERROR"
+}
+/** Keycloak error with type and details */
+export declare class KeycloakError extends Error {
+    type: KeycloakErrorType;
+    originalError?: any | undefined;
+    constructor(type: KeycloakErrorType, message: string, originalError?: any | undefined);
+}
+/**
+ * Service for handling Keycloak authentication and authorization
+ */
 export declare class KeycloakService {
     #private;
     private readonly http;
@@ -7,14 +23,50 @@ export declare class KeycloakService {
     private readonly isBrowser;
     readonly isAuthenticated$: import("@angular/core").Signal<boolean>;
     readonly userProfile$: import("@angular/core").Signal<any>;
+    /** Check if URL should be excluded from bearer token */
+    isUrlExcluded(url: string): boolean;
+    /** Validate Keycloak configuration */
+    private validateConfig;
     private loadKeycloakScript;
     private getSilentCheckUrl;
+    /**
+     * Initialize Keycloak authentication
+     * @returns Promise resolving to true if initialization is successful
+     * @throws KeycloakError if initialization fails
+     */
     initialize(): Promise<boolean>;
+    /**
+     * Redirect to Keycloak login page
+     * @param options Additional login options
+     * @returns Promise resolving when login is complete
+     */
     login(options?: any): Promise<void>;
+    /**
+     * Logout the current user
+     * @returns Promise resolving when logout is complete
+     */
     logout(): Promise<void>;
+    /**
+     * Get the current access token
+     * @returns Promise resolving to the access token or null
+     */
     getToken(): Promise<string | null>;
+    /**
+     * Get the current user's roles
+     * @returns Array of role names
+     */
     getRoles(): string[];
+    /**
+     * Check if the current user has a specific role
+     * @param role Role name to check
+     * @returns true if user has the role
+     */
     hasRole(role: string): boolean;
+    /**
+     * Update the access token if it's close to expiring
+     * @param minValidity Minimum validity time in seconds
+     * @returns Promise resolving to true if token was refreshed
+     */
     updateToken(minValidity?: number): Promise<boolean>;
     private loadUserProfile;
     static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakService, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codex-ts/core-lib",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "peerDependencies": {

package/src/lib/assets/keycloak/silent-check-sso.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>Silent SSO Check</title>
-</head>
-<body>
-    <script>
-        parent.postMessage(location.href, location.origin);
-    </script>
-</body>
-</html>