@opensourcekd/ng-common-libs 2.0.1 → 2.0.3

package/README.md

@@ -1,22 +1,19 @@
 # ng-common-libs
 
-Angular 18 library with Auth0 authentication service and MicroFrontend event bus.
+Pure TypeScript library with Auth0 authentication service and framework-agnostic event bus.
 
 ## 🎯 Simple Architecture
 
-**One import path. Everything you need.**
+**One import path. Everything you need. Framework-agnostic.**
 
 All services, utilities, and types are exported from a single package:
 
 ```typescript
 import { 
   AuthService, 
-  EventBusService, 
-  getAuthService,
-  getEventBusService,
-  getApiUrl,
-  UserInfo,
-  EventBus
+  EventBus, 
+  APP_CONFIG,
+  UserInfo
 } from '@opensourcekd/ng-common-libs';
 ```
 
@@ -24,11 +21,11 @@ import {
 
 ## 🚀 Features
 
-- **AuthService**: Complete Auth0 authentication with token management
-- **EventBusService**: MicroFrontend-ready event bus with replay buffer
+- **AuthService**: Complete Auth0 authentication with token management (Pure TypeScript - no Angular dependency)
+- **EventBus**: Framework-agnostic event bus using RxJS
+- **Works with any framework**: Angular, React, Vue, Svelte, vanilla JS
 - **Module Federation Support**: Singleton pattern works across shell + MFEs
-- **AOT-Safe**: No JIT compiler required, works in production builds
-- **Framework-Agnostic Core**: EventBus can be used in React, Vue, or vanilla JS
+- **Zero Framework Lock-in**: Core services are pure TypeScript classes
 
 ## 📦 Installation
 
@@ -40,46 +37,31 @@ npm install @opensourcekd/ng-common-libs
 
 ## 🔧 Quick Start
 
-### For Module Federation (Shell + MFEs)
-
-**In your shell app AND each MFE's `app.config.ts`:**
+### Pure TypeScript Usage (Framework-Agnostic)
 
 ```typescript
-import { ApplicationConfig } from '@angular/core';
-import { 
-  AuthService, 
-  EventBusService, 
-  getAuthService, 
-  getEventBusService
-} from '@opensourcekd/ng-common-libs';
-
-// No configuration needed - API URL is baked into the library during build
-
-export const appConfig: ApplicationConfig = {
-  providers: [
-    // Factory functions ensure singleton across all MFEs
-    { provide: EventBusService, useFactory: getEventBusService },
-    { provide: AuthService, useFactory: getAuthService },
-  ]
+import { AuthService, EventBus } from '@opensourcekd/ng-common-libs';
+
+// Create instances
+const eventBus = new EventBus();
+const authConfig = {
+  domain: 'your-domain.auth0.com',
+  clientId: 'your-client-id',
+  redirectUri: window.location.origin,
+  logoutUri: window.location.origin,
+  scope: 'openid profile email'
 };
-```
-
-**Why factory functions?**  
-They create a **JavaScript module-level singleton** shared across ALL applications (shell + MFEs). Module Federation ensures the module loads once, so all apps get the same instance.
+const authService = new AuthService(authConfig, eventBus);
 
-### For Standalone Components
-
-Then use normally with `inject()`:
-```typescript
-import { Component, inject } from '@angular/core';
-import { AuthService, EventBusService } from '@opensourcekd/ng-common-libs';
+// Use the service
+await authService.login();
+const user = authService.getUser();
+const token = await authService.getToken();
 
-export class MyComponent {
-  private authService = inject(AuthService);
-  private eventBus = inject(EventBusService);
-  
-  login() { this.authService.login(); }
-}
+// Subscribe to events
+eventBus.on('auth:login_success').subscribe(data => {
+  console.log('User logged in:', data);
+});
 ```
 
 ### API URL Access
@@ -87,10 +69,10 @@ export class MyComponent {
 **No configuration needed** - API URL is automatically available:
 
 ```typescript
-import { getApiUrl } from '@opensourcekd/ng-common-libs';
+import { APP_CONFIG } from '@opensourcekd/ng-common-libs';
 
 // API URL is baked into the library during build from GitHub repository variables
-const apiUrl = getApiUrl();
+const apiUrl = APP_CONFIG.apiUrl;
 const endpoint = `${apiUrl}/users`;
 ```
 
@@ -111,22 +93,29 @@ Everything you need from one import:
 import { 
   // Services
   AuthService,
-  EventBusService,
+  EventBus,
   
-  // Factory Functions
-  getAuthService,
-  getEventBusService,
+  // Configuration
+  APP_CONFIG,
+  AUTH0_CONFIG,
+  STORAGE_CONFIG,
+  STORAGE_KEYS,
   
-  // API Access
-  getApiUrl,
-  
-  // Core Utilities
-  EventBus,
+  // Utilities
+  getStorageItem,
+  setStorageItem,
+  removeStorageItem,
   
   // Types & Interfaces
   UserInfo,
   UserData,
   EventPayload,
+  Auth0Config,
+  StorageConfig,
+  StorageKeys,
+  AppState,
+  AuthorizationParams,
+  CallbackResult,
 } from '@opensourcekd/ng-common-libs';
 ```
 
@@ -141,8 +130,26 @@ npm run build
 
 # Run linter
 npm run lint
+
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+
+# Run tests in watch mode
+npm run test:watch
 ```
 
+## 🧪 Testing
+
+This library maintains high test coverage:
+- **99.26%** statement coverage
+- **83.45%** branch coverage
+- **100%** function coverage
+
+All core utilities and services are thoroughly tested using Jest and Angular testing utilities.
+
 ## 📄 License
 
 MIT