@opensourcekd/ng-common-libs 1.2.2 → 1.2.4

package/README.md

@@ -12,6 +12,8 @@ This library features a **dual-layer architecture**:
 ## 🚀 Features
 
 - **Event Bus**: Centralized event communication (framework-agnostic)
+- **EventBusService**: MicroFrontend-ready event bus with replay buffer for cross-app communication
+- **Auth0 Integration**: Complete Auth0 authentication service with token management
 - **Token Manager**: JWT token management and validation (framework-agnostic)
 - **Storage Manager**: Type-safe localStorage/sessionStorage wrapper (framework-agnostic)
 - **Logger**: Configurable logging with multiple levels (framework-agnostic)
@@ -24,6 +26,10 @@ This library features a **dual-layer architecture**:
 npm install @opensourcekd/ng-common-libs
 ```
 
+> **Note:** `mitt` and `@auth0/auth0-spa-js` are bundled with the library. You don't need to install them separately.
+> 
+> **Module Federation**: Just configure `@opensourcekd/ng-common-libs` as shared in your webpack config. The bundled dependencies (`mitt`, `@auth0/auth0-spa-js`) will be included automatically, ensuring they're loaded only once across all micro-frontends.
+
 ## 🔧 Usage
 
 ### For Angular Projects
@@ -89,6 +95,80 @@ export class AuthService {
 }
 ```
 
+### Auth0 Authentication
+
+Complete Auth0 integration with automatic token management and event emission:
+
+```typescript
+import { Component, inject } from '@angular/core';
+import { AuthService, configureAuth0 } from '@opensourcekd/ng-common-libs';
+
+// Configure Auth0 in your app.config.ts
+configureAuth0({
+  domain: 'your-domain.auth0.com',
+  clientId: 'your-client-id',
+  audience: 'https://your-api.com',
+});
+
+@Component({
+  selector: 'app-login',
+  template: `
+    <button (click)="login()">Login with Auth0</button>
+    <button (click)="logout()" *ngIf="user">Logout</button>
+    <div *ngIf="user">Welcome, {{ user.name }}!</div>
+  `
+})
+export class LoginComponent {
+  private authService = inject(AuthService);
+  user = this.authService.getUser();
+
+  async login() {
+    await this.authService.login();
+  }
+
+  async logout() {
+    await this.authService.logout();
+  }
+}
+```
+
+See the [Auth0 Service Usage Guide](./docs/AUTH_SERVICE_USAGE.md) for complete integration instructions.
+
+### EventBusService
+
+Cross-application event communication for MicroFrontend architectures:
+
+```typescript
+import { Component, OnInit, inject } from '@angular/core';
+import { EventBusService } from '@opensourcekd/ng-common-libs';
+
+@Component({
+  selector: 'app-event-example',
+  template: `<button (click)="sendEvent()">Send Event</button>`
+})
+export class EventExampleComponent implements OnInit {
+  private eventBus = inject(EventBusService);
+
+  ngOnInit() {
+    // Subscribe to all events
+    this.eventBus.onePlusNEvents.subscribe(event => {
+      console.log('Event received:', event);
+    });
+  }
+
+  sendEvent() {
+    // Send structured event
+    this.eventBus.sendEvent(JSON.stringify({
+      type: 'user:action',
+      payload: { userId: '123' },
+      timestamp: new Date().toISOString()
+    }));
+  }
+}
+```
+
+See the [EventBus Service Usage Guide](./docs/EVENT_BUS_USAGE.md) for advanced patterns and MicroFrontend examples.
+
 #### Auth Guard
 
 Protect routes with authentication guards:
@@ -366,6 +446,8 @@ export default {
 
 - **[Usage Guide](./docs/USAGE.md)** - Complete usage examples for all utilities
 - **[API Reference](./docs/API.md)** - Detailed API documentation
+- **[Auth0 Service Usage](./docs/AUTH_SERVICE_USAGE.md)** - Complete Auth0 authentication integration guide
+- **[EventBus Service Usage](./docs/EVENT_BUS_USAGE.md)** - Cross-application event communication guide
 - **[Deployment Guide](./docs/DEPLOYMENT.md)** - Publishing, versioning, and consumption
 - **[Microapp Triggering Guide](./docs/MICROAPP_TRIGGERING.md)** - Automatic build triggering for consuming microapps
 - **[Module Federation Guide](./docs/MODULE_FEDERATION.md)** - Runtime sharing with Module Federation