@opensourcekd/ng-common-libs 1.2.6 → 1.2.8

package/dist/angular/index.d.ts

@@ -8,8 +8,24 @@ import { EventType } from 'mitt';
  * This service is designed for MicroFrontend architectures where different apps need to communicate
  * The ReplaySubject keeps last 100 events in memory for late subscribers
  *
+ * **IMPORTANT for Module Federation / MicroFrontends:**
+ * This service uses a module-level singleton to ensure ONE instance across all MFEs and shell.
+ * Before using `inject(EventBusService)` in components, you must provide it at application level:
+ *
  * @example
  * ```typescript
+ * // In app.config.ts (standalone) or app.module.ts (NgModule)
+ * import { EventBusService, getEventBusService } from '@opensourcekd/ng-common-libs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     { provide: EventBusService, useFactory: getEventBusService }
+ *   ]
+ * };
+ * ```
+ *
+ * Then use in components:
+ * ```typescript
  * import { Component, inject, OnInit } from '@angular/core';
  * import { EventBusService } from '@opensourcekd/ng-common-libs';
  *
@@ -74,6 +90,25 @@ declare class EventBusService {
      */
     sendEvent(s: string): void;
 }
+/**
+ * Factory function to get the singleton EventBusService instance
+ * Use this in your application providers to ensure singleton behavior across MFEs
+ *
+ * @example
+ * ```typescript
+ * // In app.config.ts or app.module.ts
+ * import { EventBusService, getEventBusService } from '@opensourcekd/ng-common-libs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     { provide: EventBusService, useFactory: getEventBusService }
+ *   ]
+ * };
+ * ```
+ *
+ * @returns The singleton EventBusService instance
+ */
+declare function getEventBusService(): EventBusService;
 
 /**
  * User information from ID token
@@ -115,6 +150,23 @@ interface UserData {
  *
  * Configuration is centralized in config/auth.config.ts for easy management
  *
+ * **IMPORTANT for Module Federation / MicroFrontends:**
+ * This service uses a module-level singleton to ensure ONE instance across all MFEs and shell.
+ * Before using `inject(AuthService)` in components, you must provide it at application level:
+ *
+ * @example
+ * ```typescript
+ * // In app.config.ts (standalone) or app.module.ts (NgModule)
+ * import { AuthService, getAuthService, EventBusService, getEventBusService } from '@opensourcekd/ng-common-libs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     { provide: EventBusService, useFactory: getEventBusService },
+ *     { provide: AuthService, useFactory: getAuthService }
+ *   ]
+ * };
+ * ```
+ *
  * NOTE: All navigation logic using setTimeout is commented out as per requirements.
  * To enable navigation after auth operations, uncomment the marked sections in consuming components.
  */
@@ -272,6 +324,28 @@ declare class AuthService {
      */
     private emitAuthEvent;
 }
+/**
+ * Factory function to get the singleton AuthService instance
+ * Use this in your application providers to ensure singleton behavior across MFEs
+ *
+ * Lazy initialization ensures Auth0 can be configured before service creation
+ *
+ * @example
+ * ```typescript
+ * // In app.config.ts or app.module.ts
+ * import { AuthService, getAuthService, EventBusService, getEventBusService } from '@opensourcekd/ng-common-libs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     { provide: EventBusService, useFactory: getEventBusService },
+ *     { provide: AuthService, useFactory: getAuthService }
+ *   ]
+ * };
+ * ```
+ *
+ * @returns The singleton AuthService instance
+ */
+declare function getAuthService(): AuthService;
 
 /**
  * Auth0 Configuration
@@ -283,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;
@@ -333,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, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, getStorageItem, removeStorageItem, setStorageItem };
+export { AUTH0_CONFIG, AuthService, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, getAuthService, getEventBusService, getStorageItem, removeStorageItem, setStorageItem };
 export type { UserData, UserInfo };