@opensourcekd/ng-common-libs 2.0.0 → 2.0.2

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { EventType } from 'mitt';
 /**
  * Event payload interface
  */
-interface EventPayload<T = any> {
+interface EventPayload<T = unknown> {
     type: string;
     data: T;
     timestamp?: number;
@@ -34,13 +34,13 @@ declare class EventBus {
      * @param eventType - The type/name of the event
      * @param data - Optional data to send with the event
      */
-    emit<T = any>(eventType: string, data?: T): void;
+    emit<T = unknown>(eventType: string, data?: T): void;
     /**
      * Subscribe to a specific event type
      * @param eventType - The type/name of the event to listen for
      * @returns Observable that emits the event data
      */
-    on<T = any>(eventType: string): Observable<T>;
+    on<T = unknown>(eventType: string): Observable<T>;
     /**
      * Subscribe to multiple event types
      * @param eventTypes - Array of event types to listen for
@@ -83,22 +83,12 @@ declare const APP_CONFIG: {
  * 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:
+ * This service uses Angular's dependency injection with providedIn: 'root' to ensure
+ * singleton behavior across all MFEs and shell when shared via Module Federation webpack config.
  *
- * @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 }
- *   ]
- * };
- * ```
+ * Simply inject in components using Angular DI:
  *
- * Then use in components:
+ * @example
  * ```typescript
  * import { Component, inject, OnInit } from '@angular/core';
  * import { EventBusService } from '@opensourcekd/ng-common-libs';
@@ -164,25 +154,6 @@ 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
@@ -205,7 +176,7 @@ interface UserInfo {
     role?: string;
     org?: string;
     organization?: string;
-    [key: string]: any;
+    [key: string]: unknown;
 }
 /**
  * Simplified user data extracted from token
@@ -217,6 +188,32 @@ interface UserData {
     role: string;
     org: string;
 }
+/**
+ * App state for preserving information through auth flow
+ */
+interface AppState {
+    returnTo?: string;
+    [key: string]: unknown;
+}
+/**
+ * Authorization parameters for Auth0
+ */
+interface AuthorizationParams {
+    redirect_uri: string;
+    scope: string;
+    audience?: string;
+    connection?: string;
+    invitation?: string;
+    organization?: string;
+    [key: string]: unknown;
+}
+/**
+ * Callback result from Auth0
+ */
+interface CallbackResult {
+    success: boolean;
+    appState?: AppState;
+}
 /**
  * Authentication service for Auth0 integration
  * Handles login, logout, token management, and user session
@@ -225,20 +222,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:
+ * This service uses Angular's dependency injection with providedIn: 'root' to ensure
+ * singleton behavior across all MFEs and shell when shared via Module Federation webpack config.
+ *
+ * Simply inject in components using Angular DI:
  *
  * @example
  * ```typescript
- * // In app.config.ts (standalone) or app.module.ts (NgModule)
- * import { AuthService, getAuthService, EventBusService, getEventBusService } from '@opensourcekd/ng-common-libs';
+ * import { Component, inject } from '@angular/core';
+ * import { AuthService } from '@opensourcekd/ng-common-libs';
  *
- * export const appConfig: ApplicationConfig = {
- *   providers: [
- *     { provide: EventBusService, useFactory: getEventBusService },
- *     { provide: AuthService, useFactory: getAuthService }
- *   ]
- * };
+ * @Component({
+ *   selector: 'app-example',
+ *   template: '...'
+ * })
+ * export class ExampleComponent {
+ *   private authService = inject(AuthService);
+ * }
  * ```
  *
  * NOTE: All navigation logic using setTimeout is commented out as per requirements.
@@ -258,6 +258,8 @@ declare class AuthService {
     private initializeAuth0;
     /**
      * Ensure Auth0 client is initialized before use
+     * Lazy initialization pattern - client is created on first use
+     * Handles concurrent calls safely by checking promise first
      */
     private ensureInitialized;
     /**
@@ -279,19 +281,9 @@ declare class AuthService {
      * NOTE: Navigation after successful/failed authentication should be handled in the calling component
      * using setTimeout. See commented examples in app.component.ts
      *
-     * @returns Promise<{ success: boolean, appState?: any }> - Success status and preserved appState
-     */
-    handleCallback(): Promise<{
-        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
+     * @returns Promise<CallbackResult> - Success status and preserved appState
      */
-    private decodeAndLogToken;
+    handleCallback(): Promise<CallbackResult>;
     /**
      * Log all user claims for debugging
      * @param user - User info from Auth0
@@ -398,28 +390,6 @@ 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
@@ -511,7 +481,23 @@ declare function removeStorageItem(key: string, storageType?: 'localStorage' | '
  * });
  * ```
  */
-declare function configureAuth0(config: Partial<typeof AUTH0_CONFIG>): void;
+/**
+ * Get the API URL
+ * Returns the API URL that was configured during library build from GitHub repository variables.
+ * No configuration needed - the value is baked into the library during CI/CD build process.
+ *
+ * @returns string - The API URL from APP_CONFIG (set during build time)
+ *
+ * @example
+ * ```typescript
+ * import { getApiUrl } from '@opensourcekd/ng-common-libs';
+ *
+ * // Use in HTTP interceptor or service
+ * const apiUrl = getApiUrl();
+ * const fullUrl = `${apiUrl}/users`;
+ * ```
+ */
+declare function getApiUrl(): string;
 
-export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, configureAuth0, getAuthService, getEventBusService, getStorageItem, removeStorageItem, setStorageItem };
-export type { EventPayload, UserData, UserInfo };
+export { APP_CONFIG, AUTH0_CONFIG, AuthService, EventBus, EventBusService, STORAGE_CONFIG, STORAGE_KEYS, getApiUrl, getStorageItem, removeStorageItem, setStorageItem };
+export type { AppState, AuthorizationParams, CallbackResult, EventPayload, UserData, UserInfo };