@opensourcekd/ng-common-libs 1.2.7 → 2.0.0

package/dist/index.d.ts

@@ -82,8 +82,24 @@ declare const APP_CONFIG: {
  * 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';
  *
@@ -148,6 +164,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
@@ -189,6 +224,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.
  */
@@ -346,6 +398,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
@@ -439,5 +513,5 @@ declare function removeStorageItem(key: string, storageType?: 'localStorage' | '
  */
 declare function configureAuth0(config: Partial<typeof AUTH0_CONFIG>): void;
 
-export { APP_CONFIG, 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, getAuthService, getEventBusService, getStorageItem, removeStorageItem, setStorageItem };
 export type { EventPayload, UserData, UserInfo };