@opensourcekd/ng-common-libs 2.0.4 → 2.0.6

package/dist/index.d.ts

@@ -8,6 +8,12 @@ interface EventPayload<T = unknown> {
     data: T;
     timestamp?: number;
 }
+/**
+ * EventBus options interface
+ */
+interface EventBusOptions {
+    id?: string;
+}
 /**
  * EventBus - A centralized event bus for application-wide communication
  * Framework-agnostic implementation using only RxJS
@@ -17,6 +23,9 @@ interface EventPayload<T = unknown> {
  * // Create an instance
  * const eventBus = new EventBus();
  *
+ * // Create an instance with an identifier
+ * const eventBus = new EventBus({ id: 'MFE' });
+ *
  * // Emit an event
  * eventBus.emit('user:login', { userId: '123', username: 'john' });
  *
@@ -24,10 +33,24 @@ interface EventPayload<T = unknown> {
  * eventBus.on('user:login').subscribe(data => {
  *   console.log('User logged in:', data);
  * });
+ *
+ * // Get the identifier
+ * const id = eventBus.getId(); // 'MFE' or undefined
  * ```
  */
 declare class EventBus {
     private eventSubject;
+    private id?;
+    /**
+     * Create a new EventBus instance
+     * @param options - Optional configuration with an id to identify the instance
+     */
+    constructor(options?: EventBusOptions);
+    /**
+     * Get the identifier of this EventBus instance
+     * @returns The id if provided during initialization, undefined otherwise
+     */
+    getId(): string | undefined;
     /**
      * Emit an event with optional data
      * @param eventType - The type/name of the event
@@ -79,9 +102,21 @@ declare const APP_CONFIG: {
  * Centralized configuration for Auth0 integration
  * Framework-agnostic - works with any JavaScript framework
  */
+/**
+ * Auth0 configuration interface
+ */
+interface Auth0ConfigOptions {
+    domain?: string;
+    clientId?: string;
+    redirectUri?: string;
+    logoutUri?: string;
+    audience?: string;
+    scope?: string;
+    connection?: string;
+}
 /**
  * Auth0 client configuration
- * Override these values in your consuming application by setting them before importing AuthService
+ * Override these values in your consuming application using configureAuth0()
  *
  * Note: redirectUri defaults to window.location.origin (base URL without path).
  * Auth0 will redirect back to this URL after authentication.
@@ -95,6 +130,25 @@ declare const AUTH0_CONFIG: {
     scope: string;
     connection: string | undefined;
 };
+/**
+ * Configure Auth0 settings
+ * Call this function early in your application (e.g., in app.config.ts or main.ts)
+ * to override the default Auth0 configuration values.
+ *
+ * @param config - Partial Auth0 configuration to override defaults
+ *
+ * @example
+ * ```typescript
+ * import { configureAuth0, APP_CONFIG } from '@opensourcekd/ng-common-libs';
+ *
+ * configureAuth0({
+ *   domain: APP_CONFIG.auth0Domain,
+ *   clientId: APP_CONFIG.auth0ClientId,
+ *   audience: APP_CONFIG.apiUrl,
+ * });
+ * ```
+ */
+declare function configureAuth0(config: Auth0ConfigOptions): void;
 /**
  * Storage configuration
  * Controls where sensitive data is stored
@@ -110,6 +164,12 @@ declare const STORAGE_KEYS: {
     ACCESS_TOKEN: string;
     USER_INFO: string;
 };
+/**
+ * Reset AUTH0_CONFIG to default values
+ * Useful for testing
+ * @internal
+ */
+declare function resetAuth0Config(): void;
 /**
  * Helper functions for storage operations
  * These work with both localStorage and sessionStorage
@@ -206,6 +266,12 @@ interface Auth0Config {
     scope: string;
     connection?: string;
 }
+/**
+ * AuthService options interface
+ */
+interface AuthServiceOptions {
+    id?: string;
+}
 /**
  * Storage configuration
  */
@@ -243,10 +309,16 @@ interface StorageKeys {
  * };
  * const authService = new AuthService(authConfig, eventBus);
  *
+ * // Or create with an identifier
+ * const authService = new AuthService(authConfig, eventBus, undefined, undefined, { id: 'MFE' });
+ *
  * // Use the service
  * await authService.login();
  * const user = authService.getUser();
  * const token = await authService.getToken();
+ *
+ * // Get the identifier
+ * const id = authService.getId(); // 'MFE' or undefined
  * ```
  */
 declare class AuthService {
@@ -259,14 +331,21 @@ declare class AuthService {
     private storageConfig;
     private storageKeys;
     private eventBus;
+    private id?;
     /**
      * Create a new AuthService instance
      * @param config - Auth0 configuration
      * @param eventBus - EventBus instance for emitting auth events
      * @param storageConfig - Storage configuration (optional, defaults to sessionStorage)
      * @param storageKeys - Storage keys (optional, defaults to standard keys)
+     * @param options - Optional configuration with an id to identify the instance
+     */
+    constructor(config: Auth0Config, eventBus: EventBus, storageConfig?: StorageConfig, storageKeys?: StorageKeys, options?: AuthServiceOptions);
+    /**
+     * Get the identifier of this AuthService instance
+     * @returns The id if provided during initialization, undefined otherwise
      */
-    constructor(config: Auth0Config, eventBus: EventBus, storageConfig?: StorageConfig, storageKeys?: StorageKeys);
+    getId(): string | undefined;
     /**
      * Initialize Auth0 client
      */
@@ -341,6 +420,32 @@ declare class AuthService {
      */
     private emitAuthEvent;
 }
+/**
+ * Create AuthService instance using AUTH0_CONFIG
+ * Helper function for creating AuthService with default configuration from AUTH0_CONFIG
+ *
+ * Note: Make sure to call configureAuth0() before using this helper
+ *
+ * @param eventBus - EventBus instance for auth events
+ * @returns Configured AuthService instance
+ *
+ * @example
+ * ```typescript
+ * import { createAuthService, EventBus, configureAuth0, APP_CONFIG } from '@opensourcekd/ng-common-libs';
+ *
+ * // Configure Auth0 first
+ * configureAuth0({
+ *   domain: APP_CONFIG.auth0Domain,
+ *   clientId: APP_CONFIG.auth0ClientId,
+ *   audience: APP_CONFIG.apiUrl,
+ * });
+ *
+ * // Create instances
+ * const eventBus = new EventBus();
+ * const authService = createAuthService(eventBus);
+ * ```
+ */
+declare function createAuthService(eventBus: EventBus): AuthService;
 
-export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, STORAGE_CONFIG, STORAGE_KEYS, getStorageItem, removeStorageItem, setStorageItem };
-export type { AppState, Auth0Config, AuthorizationParams, CallbackResult, EventPayload, StorageConfig, StorageKeys, UserData, UserInfo };
+export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, createAuthService, getStorageItem, removeStorageItem, resetAuth0Config, setStorageItem };
+export type { AppState, Auth0Config, Auth0ConfigOptions, AuthServiceOptions, AuthorizationParams, CallbackResult, EventBusOptions, EventPayload, StorageConfig, StorageKeys, UserData, UserInfo };

package/dist/index.mjs

@@ -10,6 +10,9 @@ import { filter, map } from 'rxjs/operators';
  * // Create an instance
  * const eventBus = new EventBus();
  *
+ * // Create an instance with an identifier
+ * const eventBus = new EventBus({ id: 'MFE' });
+ *
  * // Emit an event
  * eventBus.emit('user:login', { userId: '123', username: 'john' });
  *
@@ -17,10 +20,28 @@ import { filter, map } from 'rxjs/operators';
  * eventBus.on('user:login').subscribe(data => {
  *   console.log('User logged in:', data);
  * });
+ *
+ * // Get the identifier
+ * const id = eventBus.getId(); // 'MFE' or undefined
  * ```
  */
 class EventBus {
     eventSubject = new Subject();
+    id;
+    /**
+     * Create a new EventBus instance
+     * @param options - Optional configuration with an id to identify the instance
+     */
+    constructor(options) {
+        this.id = options?.id;
+    }
+    /**
+     * Get the identifier of this EventBus instance
+     * @returns The id if provided during initialization, undefined otherwise
+     */
+    getId() {
+        return this.id;
+    }
     /**
      * Emit an event with optional data
      * @param eventType - The type/name of the event
@@ -86,20 +107,47 @@ const APP_CONFIG = {
  */
 /**
  * Auth0 client configuration
- * Override these values in your consuming application by setting them before importing AuthService
+ * Override these values in your consuming application using configureAuth0()
  *
  * Note: redirectUri defaults to window.location.origin (base URL without path).
  * Auth0 will redirect back to this URL after authentication.
  */
 const AUTH0_CONFIG = {
-    domain: '', // Set in consuming app: process.env['NX_AUTH0_DOMAIN'] || 'your-domain.auth0.com'
-    clientId: '', // Set in consuming app: process.env['NX_AUTH0_CLIENT_ID'] || 'your-client-id'
+    domain: '', // Set via configureAuth0() or process.env
+    clientId: '', // Set via configureAuth0() or process.env
     redirectUri: typeof window !== 'undefined' ? window.location.origin : '',
     logoutUri: typeof window !== 'undefined' ? window.location.origin : '',
-    audience: '', // Optional: Set in consuming app if using API authorization
+    audience: '', // Optional: Set via configureAuth0()
     scope: 'openid profile email', // Default scopes
-    connection: undefined, // Optional: Force specific connection (e.g., 'Username-Password-Authentication')
+    connection: undefined, // Optional: Force specific connection
 };
+/**
+ * Configure Auth0 settings
+ * Call this function early in your application (e.g., in app.config.ts or main.ts)
+ * to override the default Auth0 configuration values.
+ *
+ * @param config - Partial Auth0 configuration to override defaults
+ *
+ * @example
+ * ```typescript
+ * import { configureAuth0, APP_CONFIG } from '@opensourcekd/ng-common-libs';
+ *
+ * configureAuth0({
+ *   domain: APP_CONFIG.auth0Domain,
+ *   clientId: APP_CONFIG.auth0ClientId,
+ *   audience: APP_CONFIG.apiUrl,
+ * });
+ * ```
+ */
+function configureAuth0(config) {
+    // Only update properties that are explicitly provided (not undefined)
+    Object.keys(config).forEach((key) => {
+        const configKey = key;
+        if (config[configKey] !== undefined) {
+            AUTH0_CONFIG[configKey] = config[configKey];
+        }
+    });
+}
 /**
  * Storage configuration
  * Controls where sensitive data is stored
@@ -115,6 +163,20 @@ const STORAGE_KEYS = {
     ACCESS_TOKEN: 'auth0_access_token',
     USER_INFO: 'auth0_user_info',
 };
+/**
+ * Reset AUTH0_CONFIG to default values
+ * Useful for testing
+ * @internal
+ */
+function resetAuth0Config() {
+    AUTH0_CONFIG.domain = '';
+    AUTH0_CONFIG.clientId = '';
+    AUTH0_CONFIG.redirectUri = typeof window !== 'undefined' ? window.location.origin : '';
+    AUTH0_CONFIG.logoutUri = typeof window !== 'undefined' ? window.location.origin : '';
+    AUTH0_CONFIG.audience = '';
+    AUTH0_CONFIG.scope = 'openid profile email';
+    AUTH0_CONFIG.connection = undefined;
+}
 /**
  * Helper functions for storage operations
  * These work with both localStorage and sessionStorage
@@ -202,10 +264,16 @@ function removeStorageItem(key, storageType = 'sessionStorage') {
  * };
  * const authService = new AuthService(authConfig, eventBus);
  *
+ * // Or create with an identifier
+ * const authService = new AuthService(authConfig, eventBus, undefined, undefined, { id: 'MFE' });
+ *
  * // Use the service
  * await authService.login();
  * const user = authService.getUser();
  * const token = await authService.getToken();
+ *
+ * // Get the identifier
+ * const id = authService.getId(); // 'MFE' or undefined
  * ```
  */
 class AuthService {
@@ -224,12 +292,14 @@ class AuthService {
     storageConfig;
     storageKeys;
     eventBus;
+    id;
     /**
      * Create a new AuthService instance
      * @param config - Auth0 configuration
      * @param eventBus - EventBus instance for emitting auth events
      * @param storageConfig - Storage configuration (optional, defaults to sessionStorage)
      * @param storageKeys - Storage keys (optional, defaults to standard keys)
+     * @param options - Optional configuration with an id to identify the instance
      */
     constructor(config, eventBus, storageConfig = {
         TOKEN_STORAGE: 'sessionStorage',
@@ -237,16 +307,24 @@ class AuthService {
     }, storageKeys = {
         ACCESS_TOKEN: 'auth0_access_token',
         USER_INFO: 'auth0_user_info'
-    }) {
+    }, options) {
         this.config = config;
         this.eventBus = eventBus;
         this.storageConfig = storageConfig;
         this.storageKeys = storageKeys;
+        this.id = options?.id;
         this.userSubject = new BehaviorSubject(this.getUserInfoFromStorage());
         this.user$ = this.userSubject.asObservable();
         console.log("[AuthService] AuthService instance created (Auth0 client will be initialized on first use)");
         // Lazy initialization - Auth0 client will be initialized in ensureInitialized() on first use
     }
+    /**
+     * Get the identifier of this AuthService instance
+     * @returns The id if provided during initialization, undefined otherwise
+     */
+    getId() {
+        return this.id;
+    }
     /**
      * Initialize Auth0 client
      */
@@ -586,6 +664,43 @@ class AuthService {
         console.log('[AuthService] Auth event emitted:', event.type);
     }
 }
+/**
+ * Create AuthService instance using AUTH0_CONFIG
+ * Helper function for creating AuthService with default configuration from AUTH0_CONFIG
+ *
+ * Note: Make sure to call configureAuth0() before using this helper
+ *
+ * @param eventBus - EventBus instance for auth events
+ * @returns Configured AuthService instance
+ *
+ * @example
+ * ```typescript
+ * import { createAuthService, EventBus, configureAuth0, APP_CONFIG } from '@opensourcekd/ng-common-libs';
+ *
+ * // Configure Auth0 first
+ * configureAuth0({
+ *   domain: APP_CONFIG.auth0Domain,
+ *   clientId: APP_CONFIG.auth0ClientId,
+ *   audience: APP_CONFIG.apiUrl,
+ * });
+ *
+ * // Create instances
+ * const eventBus = new EventBus();
+ * const authService = createAuthService(eventBus);
+ * ```
+ */
+function createAuthService(eventBus) {
+    const auth0Config = {
+        domain: AUTH0_CONFIG.domain,
+        clientId: AUTH0_CONFIG.clientId,
+        redirectUri: AUTH0_CONFIG.redirectUri,
+        logoutUri: AUTH0_CONFIG.logoutUri,
+        audience: AUTH0_CONFIG.audience,
+        scope: AUTH0_CONFIG.scope,
+        connection: AUTH0_CONFIG.connection,
+    };
+    return new AuthService(auth0Config, eventBus, STORAGE_CONFIG, STORAGE_KEYS);
+}
 
-export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, STORAGE_CONFIG, STORAGE_KEYS, getStorageItem$1 as getStorageItem, removeStorageItem$1 as removeStorageItem, setStorageItem$1 as setStorageItem };
+export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, createAuthService, getStorageItem$1 as getStorageItem, removeStorageItem$1 as removeStorageItem, resetAuth0Config, setStorageItem$1 as setStorageItem };
 //# sourceMappingURL=index.mjs.map