http-request-manager 19.0.0 → 19.2.5

package/README.md

@@ -1,362 +1,647 @@
-# Request Manager Service Documentation
-
-## Summary of the Lib
-The HTTPManagerService is a collection of 4 services for HTTP and Local Storage management.
-
-## Installation
-
-`npm install http-request-manager`
-
-## Services
-
-### HTTP Manager Service: 
-
-Http service simplifies http requests in the following ways
-  - Define a fixed endpoint service
-  - Provide a fixed set of headers or add to the headers on request
-  - Proxy Config Support
-  - Adapter for strict type checking for incoming data
-  - Mapper for data transformation for outgoing data
-  - Polling requests automatically
-  - Retry requests if failure
-  - Stream http requests from endpoint service
-  - Display Error provides a Toast (Snackbar) notification on error
-
-### HTTP State Manager Service
-
-Http service simplifies http request state management in the following ways
-  - Inherits from HTTP Manager Service for config options
-  - Creates a Component Store state (NGRX)
-  - Selectors for data and selecting data records
-  - Create, Update and Delete automatically updates data by endpoint and state on success
-  - Get keeps state of records
-
-### Database Storage Manager (Coming soon)
-  - Inherits from HTTP State Manager Service for config options
-  - Manages HTTP Requests caching data in local DB (IndexedDB) using DixieJS
-  - Requests check first local DB and if data is not stale, request is made and updates DB
-  - Expiry time/date can be set for DB records for caching
-
-### Local/Session Storage
-  - Allows for Local and Storage management for data Persistence
-  - Component Store (NGRX) State for changes on storage
-  - Encryption for data
-  - Expiry time/date can be set for stores
-
-## Using the Services
-
-There are three ways to use the service, depending on your needs:
-
-### Injecting the Service (Single Usage)
-
-  ```ts
-  httpManagerService = inject(HTTPManagerService)
-  ```
-
-- This approach provides a singleton state for the service, as services are provided in root (@Injectable({ providedIn: 'root' })).
-- Any components or services that inject this service will share the same state, meaning they all have access to:
-  - data$ (observable for data)
-  - isPending$ (loading state)
-  - countDown$ (loading state)
-  - error$ (error state)
-  - Methods associated with the service
-  - Since there is only one shared state, it can be reused across components without creating new instances.
-
-  Here is a very simple example
-
-  ```ts
-    //Define your API request details using the `ApiRequest` adapter
-    const apiOptions = ApiRequest.adapt({
-      server: 'myApiUrl/rest/clients' // or ['myApiUrl', 'rest', 'clients']
+<!-- markdownlint-disable MD013 MD060 -->
+
+# HTTP Request Manager - Angular Library
+
+[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Angular](https://img.shields.io/badge/Angular-DD0031?style=flat&logo=angular&logoColor=white)](https://angular.io/)
+[![RxJS](https://img.shields.io/badge/RxJS-B7178C?style=flat&logo=reactivex&logoColor=white)](https://rxjs.dev/)
+
+A comprehensive Angular library providing enterprise-grade HTTP request management, state management, real-time communication, and local data persistence.
+
+This README is the main documentation hub for the library. Detailed service guides live in `src/docs/`, and this page links to the observable/ngrx services for older Angular applications and the signal-based services for newer Angular applications in parallel.
+
+## 🚀 Features
+
+### Core Capabilities
+
+| Feature | Description | Angular 14-18 / Observable + NgRx | Angular 19+ / Signals |
+|---------|-------------|----------------------------------|------------------------|
+| **🌐 HTTP Request Management** | Retry, polling, streaming, file downloads | [`HTTPManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md) | [`HTTPManagerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SINGNALS_MANAGER_README.md) |
+| **🔄 State Management** | CRUD state, persistence, derived state | [`HTTPManagerStateService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_STATE_MANAGER_README.md) and [`StoreStateManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/COMPLETE_API_REFERENCE.md#storestatemanagerservice) | [`StoreStateManagerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/STORE_STATE_SIGNALS_README.md) |
+| **💬 Real-Time Communication** | WebSocket channels, tracking, messaging | [`WebSocketManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WS_MANAGER_README.md) and [`WebSocketMessageService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md) | [`WebSocketSignalsManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_SIGNALS_README.md) and [`MessageTrackerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MESSAGE_TRACKER_SIGNALS_README.md) |
+| **💾 Data Persistence** | Local/session storage and offline caching | [`LocalStorageManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_README.md) and [`DatabaseManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/DATABASE_README.md) | [`LocalStorageSignalsManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_SIGNALS_README.md) |
+| **⚡ Utility Functions** | JSON handling, encryption, headers, validation | [`UtilsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_README.md) | Uses the same utility layer |
+
+### Key Benefits
+
+- ✅ **Type-Safe** - Full TypeScript support with generics
+- ✅ **Offline-First** - Built-in IndexedDB caching
+- ✅ **Real-Time Ready** - Seamless WebSocket integration
+- ✅ **Secure** - AES & RSA encryption support for sensitive data
+- ✅ **Scalable** - ComponentStore-based architecture
+- ✅ **Flexible** - Works with Observables or Signals
+
+### 🚀 Advanced Features
+
+| Feature | Description | Learn More |
+|---------|-------------|------------|
+| **🔐 Enterprise Encryption** | AES symmetric + RSA asymmetric encryption | [`Encryption Utils`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_README.md#encryption) |
+| **📡 Streaming Support** | NDJSON & Server-Sent Events (SSE) | [`HTTP Manager`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md#streaming) |
+| **📄 File Downloads** | Progress tracking for large files | [`HTTP Manager`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md#file-downloads) |
+| **📊 Pagination** | Built-in pagination with page tracking | [`HTTP State Manager`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_STATE_MANAGER_README.md#pagination) |
+| **🔔 Smart Notifications** | Persistent notifications with DB storage | [`WebSocket Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ADVANCED_WEBSOCKET.md#notifications) |
+| **👥 Presence Tracking** | Real-time user presence by channel | [`WebSocket Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ADVANCED_WEBSOCKET.md#presence) |
+| **🔄 Message Replay** | Automatic message history on reconnect | [`WebSocket Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ADVANCED_WEBSOCKET.md#message-replay) |
+| **🏷️ Channel Architecture** | SYS-, PUB-, MES- channel prefixes | [`WebSocket Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ADVANCED_WEBSOCKET.md#channels) |
+| **🔌 Singleton WebSocket** | Single connection across ALL instances | [`WebSocket Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ADVANCED_WEBSOCKET.md#singleton) |
+| **✨ Unified Message Service** | Type-safe WebSocket messaging with auto prefixes | [`WebSocket Message Service`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md) |
+| **🚀 Batch Requests** | Execute multiple HTTP requests with sequential/parallel modes | [`Batch Request Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/BATCH_REQUEST_README.md) |
+
+## 📋 Table of Contents
+
+- [Quick Start](#-quick-start)
+- [Configuration](#️-configuration)
+- [Services Overview](#-services-overview)
+- [Documentation Paths](#-documentation-paths)
+- [Architecture](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ARCHITECTURE.md)
+- [Interceptors](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/INTERCEPTOR_README.md)
+- [Advanced Features](#-advanced-features)
+- [Batch Requests](#batch-requests)
+- [Detailed Documentation](#-detailed-documentation)
+- [Demo Examples](#-demo-examples)
+- [Migration Guide](#-migration-guide)
+
+## 🚀 Quick Start
+
+### Installation & Setup (2 minutes)
+
+#### 1. Import Module
+
+```typescript
+// app.module.ts
+import { HttpRequestManagerModule } from 'http-request-manager';
+
+@NgModule({
+  imports: [
+    HttpRequestManagerModule.forRoot({
+      httpRequestOptions: {
+        server: 'http://localhost:8080',  // Your API base URL
+        retry: { times: 3, delay: 2 },
+        displayError: true
+      }
     })
+  ]
+})
+export class AppModule { }
+```
 
-  onFetchData() {
-
-      this.httpManagerService.getRequest<any>(apiOptions)
-      .pipe(
-        catchError(error => {
-          return throwError(() => this.errorHandling(error, 'GET'))
-        })
-      ).subscribe(data => console.log(data)))
-
-    }
-  ```
-
-### Example
-In this example, we define the endpoint URL as myApiUrl. This will return the data from the observable for your use case.
-
-The endpoint can be:
-
-A direct URL (e.g., https://apple.com/clients).
-A proxy-config file (recommended to avoid CORS issues).
-A string, an array of strings, or numbers—similar to Angular’s Router.navigate() API.
-The HTTP Service Manager automatically sanitizes the endpoint by removing redundant `/` characters and validating the URL.
-
-You can also add query parameters by passing an object:
-
-  ```ts
-    { sortBy: 'asc', filter: ['samples', 'testing'] }
-  ```
-
-This translates to: `https://apple.com/clients?sortBy=asc&filter=samples,testing`
-
-There are a number of other options available in the `ApiRequest` adapter
-
-
-### Extending a Component or Service with the Service (Multiple Instances - preferred method)
-
-This approach creates a new instance of the service for each component or service that extends it, ensuring each instance maintains its own independent state.
-
-### Observables
-- Similar to the first approach, instead of one instance of the state you are creating a new state instance
-- CRUD operations return Observables, similar to HttpClient.
-- This allows for custom error handling and executing additional actions after the request completes.
-- Since HTTP requests are asynchronous, you must subscribe to the Observable to receive data:
-
-  ```ts
-    myService.getData().subscribe(response => {
-      console.log(response);
-    });
-  ```
-
-- Alternatively, you can use the async pipe for automatic subscription and cleanup:
-
-  ```ts
-    {{ myData$ | async }}
-  ```
+#### 2. Provide APP_ID (if using encryption)
 
-### Example
-First we need to extend the Component or Service (recommended approach) with the `HTTPManagerService`
+```typescript
+// app.module.ts
+import { APP_ID } from '@angular/core';
 
-Component Example:
-  ```ts
-  export class RequestManagerDemoComponent extends HTTPManagerService<any> implements OnInit {
+@NgModule({
+  providers: [
+    { provide: APP_ID, useValue: "your-unique-guid-here" }
+  ]
+})
+export class AppModule { }
+```
 
-    constructor() { 
-      super()
-    }
+### Simple Examples
+
+#### Basic HTTP Request
+
+```typescript
+import { Component, inject } from '@angular/core';
+import { HTTPManagerService, ApiRequest } from 'http-request-manager';
+
+@Component({
+  selector: 'app-users',
+  template: `
+    <div *ngIf="isLoading$ | async">Loading...</div>
+    <div *ngIf="error$ | async as error" class="error">
+      Error: {{ error.message }}
+    </div>
+    <div *ngFor="let user of data$ | async">
+      {{ user.name }}
+    </div>
+  `
+})
+export class UsersComponent {
+  httpManager = inject(HTTPManagerService);
+  
+  data$ = this.httpManager.data$;
+  isLoading$ = this.httpManager.isPending$;
+  error$ = this.httpManager.error$;
+
+  ngOnInit() {
+    this.httpManager.getRequest(
+      ApiRequest.adapt({ path: ['users'] })
+    ).subscribe();
   }
-  ```
-
-Service Example:
-  ```ts
-  @Injectable({
-    providedIn: 'root'
-  })
-  export class myAPIService extends HTTPManagerService<any> {
-
-    constructor() { 
-      super()
-    }
+}
+```
 
+#### State Management with CRUD
+
+```typescript
+@Injectable({ providedIn: 'root' })
+export class UsersStore extends HTTPManagerStateService<User> {
+  
+  constructor() {
+    super(
+      ApiRequest.adapt({
+        server: 'http://localhost:8080',
+        path: ['users']
+      }),
+      DataType.ARRAY
+    );
   }
-  ```
-
-In this example, we define the endpoint URL as myApiUrl. This will return the data from the observable for your use case.
 
-The endpoint can be:
+  // Public API
+  loadUsers() { this.fetchRecords(); }
+  addUser(user: User) { this.createRecord(user); }
+  updateUser(user: User) { this.updateRecord(user); }
+  deleteUser(id: number) { this.deleteRecord(id); }
+}
+
+// Component
+@Component({
+  selector: 'app-users',
+  template: `
+    <button (click)="store.loadUsers()">Load</button>
+    <div *ngFor="let user of store.data$ | async">
+      {{ user.name }}
+      <button (click)="store.deleteUser(user.id)">Delete</button>
+    </div>
+  `
+})
+export class UsersComponent {
+  store = inject(UsersStore);
+}
+```
 
-A direct URL (e.g., https://apple.com/clients).
-A proxy-config file (recommended to avoid CORS issues).
-A string, an array of strings, or numbers—similar to Angular’s Router.navigate() API.
-The HTTP Service Manager automatically sanitizes the endpoint by removing redundant `/` characters and validating the URL.
+## ⚙️ Configuration
+
+### Module Initialization (`forRoot`)
+
+Configure the library globally using the `forRoot` method:
+
+```typescript
+import { HttpRequestManagerModule } from 'http-request-manager';
+
+@NgModule({
+  imports: [
+    HttpRequestManagerModule.forRoot({
+      httpRequestOptions: {
+        server: 'https://api.example.com',
+        headers: { 'Authorization': 'Bearer token' },
+        retry: { times: 3, delay: 2 },
+        displayError: true
+      },
+      LocalStorageOptions: {
+        storageName: 'my-app-data',
+        storageSettingsName: 'my-app-settings',
+        options: {
+          encrypted: true,
+          expiresIn: '7d'
+        }
+      }
+    })
+  ]
+})
+export class AppModule { }
+```
 
-You can also add query parameters by passing an object:
-```ts
-  { sortBy: 'asc', filter: ['samples', 'testing'] }
+### Configuration Options
+
+#### HTTP Options (`ConfigHTTPOptions`)
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `server` | `string` | Base URL for API requests | `''` |
+| `path` | `any[]` | Default path segments | `[]` |
+| `headers` | `any` | Default headers | `{}` |
+| `polling` | `number` | Default polling interval (seconds) | `0` |
+| `retry` | `RetryOptions` | Default retry configuration | `{ times: 0, delay: 3 }` |
+| `stream` | `boolean` | Enable streaming by default | `false` |
+| `displayError` | `boolean` | Show toast errors by default | `false` |
+
+#### Local Storage Options (`LocalStorageOptions`)
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `storageName` | `string` | Key for storing data | `'storage'` |
+| `storageSettingsName` | `string` | Key for settings metadata | `'global-storage'` |
+| `options` | `SettingOptions` | Default storage settings | `{ storage: StorageType.GLOBAL, expires: 0, expiresIn: '', encrypted: false }` |
+
+#### Retry Options (`RetryOptions`)
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `times` | `number` | Number of retry attempts | `0` |
+| `delay` | `number` | Delay between retries (seconds) | `3` |
+
+## 📚 Services Overview
+
+### Angular 14-18: Observable + NgRx Services
+
+| Service | Description | Use Case |
+|---------|-------------|----------|
+| [`HTTPManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md) | Observable-based HTTP client with retry, polling, streaming | Simple API calls with loading states |
+| [`HTTPManagerStateService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_STATE_MANAGER_README.md) | ComponentStore + HTTP + WebSocket + IndexedDB | CRUD with auto state sync and real-time updates |
+| [`WebSocketManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WS_MANAGER_README.md) | Singleton WebSocket connection manager | Real-time messaging and notifications |
+| [`WebSocketMessageService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md) | Unified type-safe message sending service | Simplified WebSocket messaging with auto prefixes |
+| [`LocalStorageManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_README.md) | Secure local/session storage with encryption | User preferences and session data |
+| [`DatabaseManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/DATABASE_README.md) | IndexedDB wrapper via Dexie.js | Offline-first data access |
+| [`StoreStateManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/COMPLETE_API_REFERENCE.md#storestatemanagerservice) | Persistent ComponentStore with localStorage sync | Application state persistence |
+
+### Angular 19+: Signal-Based Services
+
+| Service | Description | Use Case |
+|---------|-------------|----------|
+| [`HTTPManagerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SINGNALS_MANAGER_README.md) | Signal-based HTTP client for modern reactive UI | Modern Angular with Signals |
+| [`LocalStorageSignalsManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_SIGNALS_README.md) | Signal-based local/session storage | Reactive persisted UI state |
+| [`StoreStateManagerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/STORE_STATE_SIGNALS_README.md) | Signal-based persistent state service | App state persistence with computed derivations |
+| [`WebSocketSignalsManagerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_SIGNALS_README.md) | Signal-based WebSocket manager | Signal-driven real-time dashboards and messaging |
+| [`MessageTrackerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MESSAGE_TRACKER_SIGNALS_README.md) | Signal-based channel/message tracking | Presence, counters, last-message views |
+
+### Shared Utilities
+
+| Service | Description | Use Case |
+|---------|-------------|----------|
+| [`UtilsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_README.md) | Utilities: encryption, headers, merging, path/query | Helper functions |
+
+### Common Use Cases
+
+| Use Case | Service to Use | Key Features |
+|----------|---------------|--------------|
+| Simple API calls | `HTTPManagerService` | Observables, retry, polling |
+| Modern reactive UI | `HTTPManagerSignalsService` | Angular Signals |
+| CRUD operations | `HTTPManagerStateService` | Auto state updates, pagination |
+| Real-time chat | `HTTPManagerStateService` + WebSocket | PUB- messaging channels |
+| Persistent notifications | `HTTPManagerStateService` + WebSocket | MES- channels with DB storage |
+| State synchronization | `HTTPManagerStateService` + WebSocket | SYS- private channels |
+| **Unified WebSocket messaging** | **`WebSocketMessageService`** | **Type-safe, auto prefixes, validation** |
+| User preferences | `LocalStorageManagerService` | Encryption, expiration |
+| Offline-first | `DatabaseManagerService` | IndexedDB caching, querying |
+| Large local datasets | `DatabaseManagerService` | Bulk operations, indexing |
+| Secure data storage | `LocalStorageManagerService` | AES encryption |
+| File transfers | `HTTPManagerService` | Download progress tracking |
+| Live data streams | `HTTPManagerService` | NDJSON, SSE streaming |
+
+## 📖 Documentation Paths
+
+All detailed service guides live in `src/docs/`. Use this README as the entry point, then choose the track that matches the Angular version in your app.
+
+### Angular 14-18: Observable + NgRx Track
+
+| Category | Documentation |
+|----------|---------------|
+| HTTP | [HTTP Manager](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md) |
+| State | [HTTP State Manager](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_STATE_MANAGER_README.md) and [Store State API Reference](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/COMPLETE_API_REFERENCE.md#storestatemanagerservice) |
+| Real-Time | [WebSocket Manager](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WS_MANAGER_README.md) and [WebSocket Message Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md) |
+| Persistence | [Local Storage](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_README.md) and [Database](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/DATABASE_README.md) |
+
+### Angular 19+: Signal Track
+
+| Category | Documentation |
+|----------|---------------|
+| Overview | [Signal Services Overview](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/SIGNAL_SERVICES_README.md) |
+| HTTP | [HTTP Manager Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SINGNALS_MANAGER_README.md) |
+| State | [Store State Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/STORE_STATE_SIGNALS_README.md) |
+| Real-Time | [WebSocket Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_SIGNALS_README.md) and [Message Tracker Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MESSAGE_TRACKER_SIGNALS_README.md) |
+| Persistence | [Local Storage Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_SIGNALS_README.md) |
+
+## 🏗️ Architecture
+
+For detailed system architecture, data flows, and design patterns, see:
+
+📋 **[Architecture Documentation](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ARCHITECTURE.md)**
+
+### System Overview
+
+```text
+┌─────────────────────────────────────────────────────────────────┐
+│                         Angular Application                     │
+├─────────────────────────────────────────────────────────────────┤
+│  ┌────────────────┐  ┌────────────────┐  ┌──────────────────┐   │
+│  │   Components   │  │   Components   │  │    Components    │   │
+│  │   (Signals)    │  │  (Observables) │  │  (State Store)   │   │
+│  └───────┬────────┘  └───────┬────────┘  └────────┬─────────┘   │
+│          │                   │                     │            │
+│          ▼                   ▼                     ▼            │
+│  ┌──────────────┐    ┌──────────────┐    ┌──────────────────┐   │
+│  │HTTPManager   │    │HTTPManager   │    │HTTPManager       │   │
+│  │SignalsService│    │Service       │    │StateService      │   │
+│  └──────┬───────┘    └──────┬───────┘    └────────┬─────────┘   │
+│         │                   │                      │            │
+│         └───────────────────┴──────────────────────┘            │
+│                             │                                   │
+│                             ▼                                   │
+│                    ┌─────────────────┐                          │
+│                    │  HttpClient     │                          │
+│                    │  (Angular)      │                          │
+│                    └────────┬────────┘                          │
+│                             │                                   │
+├─────────────────────────────┼───────────────────────────────────┤
+│                             │                                   │
+│  ┌──────────────────────────┼──────────────────────┐            │
+│  │        Storage Layer                            │            │
+│  ├──────────────────────────┼──────────────────────┤            │
+│  │  ┌────────────────┐      │      ┌─────────────┐ │            │
+│  │  │LocalStorage    │      │      │IndexedDB    │ │            │
+│  │  │Manager Service │      │      │(Dexie.js)   │ │            │
+│  │  └────────────────┘      │      └─────────────┘ │            │
+│  └──────────────────────────┼──────────────────────┘            │
+│                             │                                   │
+│  ┌──────────────────────────┼──────────────────────┐            │
+│  │        WebSocket Layer                          │            │
+│  ├──────────────────────────┼──────────────────────┤            │
+│  │  ┌─────────────────────────────────────┐        │            │
+│  │  │   WebsocketService                  │        │            │
+│  │  └─────────────────────────────────────┘        │            │
+│  └─────────────────────────────────────────────────┘            │
+└─────────────────────────────────────────────────────────────────┘
 ```
-This translates to: `https://apple.com/clients?sortBy=asc&filter=samples,testing`
 
-Lets define these query params as a variable called `PARAMS` and use them in the following request.
+## 🔧 Interceptors
 
-There are a number of other options available in the `ApiRequest` adapter
+The library provides several HTTP interceptors that are automatically configured:
 
-No we can define a method:
-In this example take note that the clientID has been passed to the method and the param after the apiOptions allows for further customization for the api request being made. In this case we extended the the base path defined in the `ApiRequest` options. We also added the `PARAMS` for query parameters.
+📋 **[Interceptors Documentation](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/INTERCEPTOR_README.md)**
 
-Define your API request options using the 'ApiRequest' adapter
+### Available Interceptors
 
-  ```ts
-    const apiOptions = ApiRequest.adapt({
-      server: ['myApiUrl', 'rest', 'clients']
-    })
+| Interceptor | Purpose | Automatically Applied |
+|-------------|---------|----------------------|
+| **RequestErrorInterceptor** | Handles 400/500 errors with toast notifications | ✅ Yes |
+| **RequestHeadersInterceptor** | Adds Content-Type, Accept-Language, Current-Date | ✅ Yes |
+| **CredentialsInterceptor** | Adds `withCredentials: true` for CORS | ✅ Yes |
+| **ProxyDebuggerInterceptor** | Debug logging for development | ⚙️ Configurable |
 
-    // Dynamically change these params
-    const PARAMS = {
-      sortBy: 'asc',
-      filter: ['samples', 'testing']
-    }
+### Manual Configuration
 
-    onFetchData(clientId) {
-
-      this.httpManagerService.getRequest<any>(apiOptions, [clientId, this.PARAMS])
-      .pipe(
-        catchError(error => {
-          return throwError(() => this.errorHandling(error, 'GET'))
-        })
-      ).subscribe(data => console.log(data)))
+```typescript
+// app.module.ts
+providers: [
+  { provide: HTTP_INTERCEPTORS, useClass: WithCredentialsInterceptor, multi: true },
+  { provide: HTTP_INTERCEPTORS, useClass: RequestHeadersInterceptor, multi: true },
+  { provide: HTTP_INTERCEPTORS, useClass: RequestErrorInterceptor, multi: true }
+]
+```
 
-    }
-  ```
+### Customization
 
+Error handling can be customized with `ErrorSettings`:
 
-### State Observable
-- When executing CRUD operations, their results are automatically pushed into the data$ observable within the service.
-- This means you can bind the data$ observable to a component to automatically update UI elements.
-- Using this approach enables state management across components and allows data refresh actions without needing additional logic.
+```typescript
+import { ErrorSettings } from 'http-request-manager';
 
-### Example
-First we need to extend the Component or Service (recommended approach) with the `HTTPManagerService`
+const customSettings: ErrorSettings = {
+  displayError: true,
+  displayWarning: true,
+  customHandler: (error) => {
+    // Custom error handling logic
+  }
+};
+```
 
-Component Example:
-The structure would be: Component extends `HTTPManagerService`
+## 📚 Detailed Documentation
 
-  ```ts
-  export class RequestManagerDemoComponent extends HTTPManagerService<any> implements OnInit {
+For in-depth documentation on each service and component, refer to the following detailed guides:
 
-    constructor() { 
-      super()
-    }
-  }
-  ```
+### Detailed Docs for Angular 14-18
 
-Service Example:
-The structure would be: Component injects a service call `clientsService` and `clientsService` extends `HTTPManagerService`
+| Documentation | Description |
+|---------------|-------------|
+| 📖 [HTTP Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_MANAGER_README.md) | Observable-based HTTP client with retry, polling, streaming, and error handling |
+| 📖 [HTTP Manager State Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_STATE_MANAGER_README.md) | ComponentStore integration with automatic CRUD state updates and WebSocket sync |
+| 📖 [WebSocket Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WS_MANAGER_README.md) | WebSocket connection management with channel-based messaging and notifications |
+| 📖 [Local Storage Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_README.md) | Secure local/session storage with encryption and expiration |
+| 📖 [Database Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/DATABASE_README.md) | IndexedDB wrapper via Dexie.js with Observable API for offline-first apps |
+| 📖 [Store State Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/COMPLETE_API_REFERENCE.md#storestatemanagerservice) | Persistent ComponentStore synchronized with local/session storage |
+| 📖 [WebSocket Message Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md) | Type-safe WebSocket message sending with channel prefix helpers |
+| 🚀 [Batch Request Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/BATCH_REQUEST_README.md) | Execute multiple HTTP requests with sequential/parallel modes and configurable error handling |
+
+### Detailed Docs for Angular 19+
+
+| Documentation | Description |
+|---------------|-------------|
+| 📖 [Signal Services Overview](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/SIGNAL_SERVICES_README.md) | Overview of the signal-based service set and migration guidance |
+| 📖 [HTTP Manager Signals Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SINGNALS_MANAGER_README.md) | Signal-based HTTP client for modern reactive UI with Angular Signals |
+| 📖 [Local Storage Signals Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOCAL_STORAGE_SIGNALS_README.md) | Signal-based persisted storage patterns |
+| 📖 [Store State Signals Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/STORE_STATE_SIGNALS_README.md) | Signal-based state persistence and computed state |
+| 📖 [WebSocket Signals Manager Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_SIGNALS_README.md) | Signal-driven WebSocket connection and subscription management |
+| 📖 [Message Tracker Signals Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MESSAGE_TRACKER_SIGNALS_README.md) | Signal-based message counting, presence, and channel metadata |
+| 🚀 [Batch Request Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/BATCH_REQUEST_README.md) | Execute multiple HTTP requests with sequential/parallel modes and configurable error handling |
+
+### Shared Services
+
+| Documentation | Description |
+|---------------|-------------|
+| 📖 [Utils Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_README.md) | Utility functions for JSON handling, encryption, headers, and validation |
+
+### Core Components
+
+| Documentation | Description |
+|---------------|-------------|
+| 🏗️ [Architecture](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ARCHITECTURE.md) | System architecture, data flows, and design patterns |
+| 🔧 [Interceptors](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/INTERCEPTOR_README.md) | HTTP interceptors for error handling, headers, authentication, and debugging |
+
+### Additional Resources
+
+- **Request Manager Services** - Detailed API documentation for the request manager services ([`src/lib/services/request-manager-services/README.md`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/lib/services/request-manager-services/README.md))
+- **Encryption Utils** - Encryption utility documentation ([`src/lib/services/utils/encryption/README.md`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/lib/services/utils/encryption/README.md))
+
+## 🎮 Demo Examples
+
+Comprehensive demo components showcase all library features in action:
+
+### Available Demos
+
+Located in [`src/lib/http-request-services-demo/`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/lib/http-request-services-demo/):
+
+| Demo Component | Features Demonstrated |
+|----------------|----------------------|
+| **HttpRequestServicesDemoComponent** | Main demo hub with service selection |
+| **RequestManagerDemoComponent** | HTTP CRUD, file downloads, streaming, polling, retry |
+| **RequestManagerStateDemoComponent** | State management, pagination, WebSocket sync, IndexedDB caching |
+| **RequestManagerWsDemoComponent** | Real-time chat, AI messaging, notifications, presence tracking |
+| **LocalStorageDemoComponent** | Encrypted storage, expiration, reactive signals |
+| **LocalStorageSignalsDemoComponent** | Signal-based localStorage API |
+| **DatabaseDataDemoComponent** | IndexedDB CRUD, querying, bulk operations |
+| **RequestSignalsManagerDemoComponent** | Signal-based HTTP with file downloads |
+| **StoreStateManagerDemoComponent** | Persistent state with localStorage sync |
+
+### Demo Features
+
+**HTTP Service Demos:**
+
+- ✅ Basic CRUD operations
+- ✅ File download with progress tracking
+- ✅ Streaming responses (NDJSON, SSE)
+- ✅ Polling with countdown timers
+- ✅ Retry logic with custom delays
+- ✅ Error handling with toast notifications
+
+**State Management Demos:**
+
+- ✅ ComponentStore integration
+- ✅ Automatic state updates
+- ✅ Pagination controls
+- ✅ WebSocket real-time sync
+- ✅ IndexedDB caching
+- ✅ Database clear/refresh
+
+**WebSocket Demos:**
+
+- ✅ Channel-based messaging (PUB- channels)
+- ✅ Private state sync (SYS- channels)
+- ✅ Persistent notifications (MES- channels)
+- ✅ User presence tracking
+- ✅ Message history & replay
+- ✅ AI chat integration
+- ✅ Multi-room support
+
+**Storage Demos:**
+
+- ✅ Encrypted localStorage
+- ✅ SessionStorage usage
+- ✅ Expiration management
+- ✅ Signal-based API
+- ✅ Reactive updates
+
+### Usage
+
+```html
+<app-http-request-services-demo
+  [server]="'http://localhost:8080'"
+  [wsServer]="'ws://localhost:8080'"
+  [jwtToken]="'your-jwt-token'"
+  [adapter]="myAdapterFunction"
+  [mapper]="myMapperFunction">
+</app-http-request-services-demo>
+```
 
-  ```ts
-  @Injectable({
-    providedIn: 'root'
-  })
-  export class myAPIService extends HTTPManagerService<any> {
+### Sample Models
 
-    constructor() { 
-      super()
-    }
+Demo includes production-ready sample models:
 
-  }
-  ```
+- `User` - User data structures
+- `ClientInfo` - Client details
+- `SessionData` - Session management
+- `AIMessage` - AI chat messages
+- `Notification` - Notification structures
 
-In this example, we define the endpoint URL as myApiUrl.
+## 📖 Migration Guide
 
-Lets define these query params as a variable called `PARAMS` and use them in the following request.
+### From HttpClient to HTTPManagerService
 
-No we can define a method:
-In this example the clientID has been passed to the method. 
-We also added the `PARAMS` for query parameters.
+**Before:**
 
-Define your API request options using the 'ApiRequest' adapter
+```typescript
+http.get('api/users').subscribe(users => {
+  this.users = users;
+  this.loading = false;
+});
+```
 
-  ```ts
-    const apiOptions = ApiRequest.adapt({
-      server: ['myApiUrl', 'rest', 'clients']
-    })
+**After:**
 
-    // Dynamically change these params
-    const PARAMS = {
-      sortBy: 'asc',
-      filter: ['samples', 'testing']
-    }
+```typescript
+httpManager.getRequest(
+  ApiRequest.adapt({ path: ['users'] })
+).subscribe();
 
-    onFetchData(clientId: number) {
-      this.httpManagerService.getRequest<any>(apiOptions, [clientId, this.PARAMS]).subscribe()
-    }
-  ```
+data$ = this.httpManager.data$;
+isLoading$ = this.httpManager.isPending$;
+```
 
-  In the above case we are not using the data returning from the Observable but rather executing the api call, like a refresh if called again
+### From Manual State to HTTPManagerStateService
 
-  To access the data from the observable, you need to bind the observable if your using a component that injects the service that extends the `HTTPManagerService`
+**Before:**
 
-  In the component where the service was injected, we define
+```typescript
+users: User[] = [];
+loading = false;
 
-  ```ts
-    data$ = this.clientsService.data$
-    isPending$ = this.clientsService.isPending$
-    error$ = this.clientsService.error$
-  ```
-  By doing this gives your component the state of the data and other feedback states for the request that now you can use in your template.
+loadUsers() {
+  this.loading = true;
+  this.http.get('api/users').subscribe(users => {
+    this.users = users;
+    this.loading = false;
+  });
+}
 
-```ts
-  {{ data$ | async }}
-  {{ isPending$ | async }}
-  {{ error$ | async }}
+addUser(user: User) {
+  this.http.post('api/users', user).subscribe(newUser => {
+    this.users = [...this.users, newUser];
+  });
+}
 ```
 
+**After:**
 
-### ApiRequest Options
-The following are the available options when configuring an ApiRequest object:
-
-```ts
-apiRequest = ApiRequest.adapt({
-  server: string,
-  path: any[],
-  headers: any,
-  adapter?: any,
-  mapper?: any,
-  polling?: number, // in seconds (undefined | 0 = none)
-  retry: RetryOptions,
-  stream?: boolean
-  displayError: boolean
-});
+```typescript
+@Injectable()
+export class UsersStore extends HTTPManagerStateService<User> {
+  constructor() {
+    super(ApiRequest.adapt({ path: ['users'] }), DataType.ARRAY);
+  }
+  
+  loadUsers() { this.fetchRecords(); }
+  addUser(user: User) { this.createRecord(user); }
+}
+
+// Component
+data$ = this.usersStore.data$;
+isLoading$ = this.usersStore.isPending$;
 ```
 
-| **Property**   | **Description**                                                                   | **Type**                   | **Required** |
-|--------------|--------------------------------------------------------------------------------|---------------------------|------------|
-| `server`     | The base URL or service endpoint for the API request.                         | `string`                   | ✅         |
-| `path`       | Additional paths to append to the base URL for constructing the full API endpoint. | `any[]`                    | ✅         |
-| `headers`    | Custom headers to include in the request, provided as an object.             | `any`                      | ✅         |
-| `adapter`    | A model adapter used to transform incoming data (e.g., `DistrictData.adapt`). | `any`                      | ❌         |
-| `mapper`     | A model adapter used to map outgoing data before sending it to the server (e.g., `DistrictData.mapper`). | `any` | ❌         |
-| `polling`    | Enables periodic polling, where the request will be made every specified number of seconds. | `number` (seconds)         | ❌         |
-| `retry`      | Retry logic using `RetryOptions`, which includes: <br> - `times`: Number of retry attempts. <br> - `delay`: Delay in milliseconds between retries. | `RetryOptions`             | ✅         |
-| `stream`     | A flag to indicate whether the request expects a stream of data from the server. | `boolean`                  | ❌         |
-| `displayError` | A flag to indicate whether to present the error from the request in a snackbar notification. | `boolean`                  | ✅         |
+## 📋 API Reference
 
+### Core Models
 
-### Additional Observables for Request Status
-- countdown$: If polling is active, this property gives feedback on when the next request will take place. It starts from the specified time in seconds and counts down to 0, triggering the next request and restarting the countdown.
-- error$: This returns any HTTP error that occurs during the request.
-- isPending$: This boolean value indicates whether the request is pending (true) or has been completed (false).
-- data$: You can access the data fetched in the request using the data$ observable. This provides the response from the server, which can be used for further processing or displaying in the UI.
+All models follow the `<Name>Interface` + `<Name>Model` pattern with static `adapt()` methods.
 
-## Importing Module forRoot() Configuration
+| Model | Description | Documentation |
+|-------|-------------|---------------|
+| **ApiRequest** | HTTP request configuration | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#apirequest) |
+| **RetryOptions** | Retry behavior settings | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#retryoptions) |
+| **DataType** | Data structure type (ARRAY, OBJECT) | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#datatype) |
+| **DatabaseStorage** | IndexedDB configuration | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#databasestorage) |
+| **SettingOptions** | Storage settings | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#settingoptions) |
+| **WSOptions** | WebSocket configuration | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#wsoptions) |
+| **ConfigOptions** | Global library configuration | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#configoptions) |
+| **StateStorageOptions** | Persistent state configuration | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#statestorageoptions) |
+| **TableSchemaDef** | Database table schema | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#tableschemadef) |
+| **ChannelMessage** | WebSocket message structure | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#channelmessage) |
+| **WSUser** | WebSocket user info | [`Models Guide`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MODELS_README.md#wsuser) |
 
+### Enums
 
-# Available Interceptors
+| Enum | Values | Description |
+|------|--------|-------------|
+| **DataType** | `ARRAY`, `OBJECT` | Response data structure |
+| **StreamType** | `NDJSON`, `SSE` | Streaming response types |
+| **StorageType** | `GLOBAL`, `SESSION` | Storage scope |
+| **CommunicationType** | `subscribe`, `unsubscribe`, `message`, `notification`, etc. | WebSocket message types |
+| **ChannelType** | `SYS`, `PUB`, `MES` | Channel prefixes |
+| **ToastColors** | `SUCCESS`, `WARN`, `ERROR`, `INFO` | Toast notification colors |
 
-There are 3 interceptors that you can import into your project for api requests. 
+### Configuration Tokens
 
-You may add these interceptors in your `AppModule` file as providers and import them into as providers.
+| Token | Type | Purpose |
+|-------|------|---------|
+| **CONFIG_SETTINGS_TOKEN** | `ConfigOptions` | Global library configuration |
+| **APP_ID** | `string` | Application ID for encryption |
 
-```ts
-providers: [
-  { provide: HTTP_INTERCEPTORS, useClass: WithCredentialsInterceptor, multi: true },
-  { provide: HTTP_INTERCEPTORS, useClass: RequestHeadersInterceptor, multi: true },
-  { provide: HTTP_INTERCEPTORS, useClass: RequestErrorInterceptor, multi: true }
-],
-```
-
-Or you can use all intercepts above by importing the `HttpRequestManagerModule` in your `AppModule`
+### Complete API Documentation
 
-- **RequestErrorInterceptor**
+For comprehensive API reference with all methods, parameters, and examples:
+📋 **[Complete API Reference](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/COMPLETE_API_REFERENCE.md)**
 
-This interceptor handles errors of type 400 and 500. This interceptor is applicable when you need to display UI for the user to indicate a server or request error has occurred. The Status and Error Text is displayed in a `toast-message` modal.
+## 🤝 Contributing
 
-- **WithCredentialsInterceptor**
+This library is designed to be enterprise-ready and production-safe. All features include comprehensive error handling, TypeScript support, and extensive configuration options.
 
-  Adds to your request header 
+## 📄 License
 
-  ```json 
-  { credentials: true }
-  ```
+This project is part of the Angular application library suite.
 
-- **RequestHeadersInterceptor**
+---
 
-  Adds to your request - current local `language` (i18n) selection and `current date` to every request
-
-  ```json
-  {
-    'Content-Type': 'application/json',
-    'Accept-Language': this.language || 'en-CA',
-    'Current-Date': this.currentDate
-  }
-  ```
+**Need help?** Check out the detailed documentation for each service, explore the demo examples, or review the architecture documentation for implementation guidance.