@opensourcekd/ng-common-libs 1.2.5 → 1.2.6

package/README.md

@@ -11,6 +11,7 @@ This library features a **dual-layer architecture**:
 
 ## 🚀 Features
 
+- **APP_CONFIG**: Framework-agnostic configuration utility for all environment variables (Auth0, API URLs)
 - **EventBusService**: MicroFrontend-ready event bus with replay buffer for cross-app communication
 - **Auth0 Integration**: Complete Auth0 authentication service with token management
 
@@ -26,6 +27,26 @@ npm install @opensourcekd/ng-common-libs
 
 ## 🔧 Usage
 
+### Configuration (Framework-Agnostic)
+
+The library provides a framework-agnostic configuration utility with **statically configured values** from GitHub repository variables:
+
+```typescript
+// Import from /core for framework-agnostic usage
+import { APP_CONFIG } from '@opensourcekd/ng-common-libs/core';
+
+// Access pre-configured values anywhere in your app
+console.log(APP_CONFIG.apiUrl);        // Configured during build from GitHub vars
+console.log(APP_CONFIG.auth0Domain);    // Configured during build from GitHub vars
+console.log(APP_CONFIG.auth0ClientId);  // Configured during build from GitHub vars
+```
+
+**Key Features:**
+- Values are **statically baked** into the library during build time from GitHub repository variables
+- No runtime configuration needed - values are available immediately
+- Can be used across any framework: Angular, React, Vue, Svelte, vanilla JS
+- Perfect for MicroFrontends (MFEs) and shell applications
+
 ### Auth0 Authentication
 
 Complete Auth0 integration with automatic token management and event emission:
@@ -33,12 +54,13 @@ 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';
+import { APP_CONFIG } from '@opensourcekd/ng-common-libs/core';
 
-// Configure Auth0 in your app.config.ts
+// Use pre-configured values from APP_CONFIG
 configureAuth0({
-  domain: 'your-domain.auth0.com',
-  clientId: 'your-client-id',
-  audience: 'https://your-api.com',
+  domain: APP_CONFIG.auth0Domain,
+  clientId: APP_CONFIG.auth0ClientId,
+  audience: APP_CONFIG.apiUrl,
 });
 
 @Component({
@@ -181,6 +203,18 @@ export default {
 
 ## 📝 API Documentation
 
+### Core Configuration (Framework-Agnostic)
+
+- `APP_CONFIG` - Read-only application configuration object with values statically configured during build time:
+  - `auth0Domain: string` - Auth0 tenant domain (from GitHub var `AUTH0_DOMAIN`)
+  - `auth0ClientId: string` - Auth0 client ID (from GitHub var `AUTH0_CLIENT_ID`)
+  - `apiUrl: string` - API base URL (from GitHub var `API_URL`)
+
+### Angular Configuration
+
+- `configureAuth0(config: Partial<AUTH0_CONFIG>): void` - Configure Auth0 settings (domain, clientId, etc.)
+- `AUTH0_CONFIG` - Auth0 configuration object (domain, clientId, redirectUri, etc.)
+
 ### AuthService
 
 - `login(options?: RedirectLoginOptions): Promise<void>` - Initiate Auth0 login