@opensourcekd/ng-common-libs 1.2.5 → 1.2.7

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { Observable, ReplaySubject } from 'rxjs';
-import { HttpClient } from '@angular/common/http';
 import { EventType } from 'mitt';
 
 /**
@@ -55,6 +54,27 @@ declare class EventBus {
     onAll(): Observable<EventPayload>;
 }
 
+/**
+ * Framework-agnostic Configuration
+ * Centralized configuration for all consuming applications
+ *
+ * This configuration can be used across different frameworks (Angular, React, Vue, etc.)
+ * and by various Micro-Frontends (MFEs) and shell applications.
+ *
+ * Values are statically configured during build time from GitHub repository variables.
+ */
+/**
+ * Application configuration object
+ * Contains all environment-specific variables
+ *
+ * These values are replaced during build time with actual values from GitHub repository variables.
+ */
+declare const APP_CONFIG: {
+    auth0Domain: string;
+    auth0ClientId: string;
+    apiUrl: string;
+};
+
 /**
  * EventBusService - Angular service for cross-application event communication
  * Uses mitt library for efficient event handling and RxJS ReplaySubject for observable stream
@@ -173,15 +193,13 @@ interface UserData {
  * To enable navigation after auth operations, uncomment the marked sections in consuming components.
  */
 declare class AuthService {
-    private http;
     private eventBus;
-    id: string;
     private readonly STANDARD_JWT_CLAIMS;
     private auth0Client;
     private initializationPromise;
     private userSubject;
     user$: Observable<UserInfo | null>;
-    constructor(http: HttpClient, eventBus: EventBusService);
+    constructor(eventBus: EventBusService);
     /**
      * Initialize Auth0 client
      */
@@ -215,6 +233,13 @@ declare class AuthService {
         success: boolean;
         appState?: any;
     }>;
+    /**
+     * Decode and log the access token to console
+     * NOTE: This logs sensitive token information to console for debugging purposes.
+     * In production environments, consider disabling this or filtering console logs.
+     * @param token - The JWT access token
+     */
+    private decodeAndLogToken;
     /**
      * Log all user claims for debugging
      * @param user - User info from Auth0
@@ -332,6 +357,10 @@ declare class AuthService {
 /**
  * Auth0 client configuration
  * Override these values in your consuming application by setting them before importing AuthService
+ *
+ * Note: redirectUri defaults to window.location.origin (base URL without path).
+ * Auth0 will redirect back to this URL after authentication.
+ * You can override this to a specific callback URL (e.g., '/auth-callback') using configureAuth0().
  */
 declare const AUTH0_CONFIG: {
     domain: string;
@@ -382,21 +411,33 @@ declare function setStorageItem(key: string, value: string, storageType?: 'local
  */
 declare function removeStorageItem(key: string, storageType?: 'localStorage' | 'sessionStorage'): void;
 /**
- * Configure Auth0 settings
- * Call this function in your consuming application before using AuthService
+ * Configure Auth0 settings (OPTIONAL)
+ * Call this function in your consuming application to override default Auth0 configuration.
+ * Only the values you provide will be overridden; all other defaults remain unchanged.
+ *
+ * Note: This function is optional. If not called, default values will be used.
+ *
+ * @param config - Partial Auth0 configuration object with values to override
  *
  * @example
  * ```typescript
  * import { configureAuth0 } from '@opensourcekd/ng-common-libs';
  *
+ * // Only override specific values - others keep their defaults
  * configureAuth0({
  *   domain: 'your-domain.auth0.com',
  *   clientId: 'your-client-id',
  *   audience: 'https://your-api.com'
+ *   // redirectUri, logoutUri, scope, etc. will use defaults
+ * });
+ *
+ * // Or override just redirectUri to use a specific callback page
+ * configureAuth0({
+ *   redirectUri: window.location.origin + '/auth-callback'
  * });
  * ```
  */
 declare function configureAuth0(config: Partial<typeof AUTH0_CONFIG>): void;
 
-export { AUTH0_CONFIG, AuthService, EventBus, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, getStorageItem, removeStorageItem, setStorageItem };
+export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, getStorageItem, removeStorageItem, setStorageItem };
 export type { EventPayload, UserData, UserInfo };