http-request-manager 18.16.6 → 18.16.8

package/README.md

@@ -16,12 +16,13 @@ This README is the main documentation hub for the library. Detailed service guid
 
 | 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) |
+| **🌐 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_SIGNALS_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/STORE_STATE_MANAGER_README.md) | [`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), [`WebSocketMessageService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/WEBSOCKET_MESSAGE_SERVICE.md), and [`MessageTrackerService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/MESSAGE_TRACKER_README.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) |
 | **🗄️ Database Queries** | MySQL-syntax SQL queries on IndexedDB — the recommended way to query data | [`DexieSqlService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/SQL_DIXIE_README.md) | Uses the same service |
 | **⚡ Utility Functions** | JSON handling, encryption, headers, validation, logging | [`UtilsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_README.md), [`Encryption`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/ENCRYPTION_README.md), [`Logger`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/LOGGER_README.md) | Uses the same utility layer |
+| **🔧 Utility Services** | Headers, path/query, merging, base request classes | [`Utility Services`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_SERVICES_README.md) | Internal and helper services |
 
 ### Key Benefits
 
@@ -286,6 +287,42 @@ export class AppModule { }
 | `times` | `number` | Number of retry attempts | `0` |
 | `delay` | `number` | Delay between retries (seconds) | `3` |
 
+#### WebSocket Options (`WSOptions`)
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `id` | `string` | Channel identifier (used to construct channel names) | `''` |
+| `wsServer` | `string` | WebSocket server URL | `''` |
+| `jwtToken` | `string` | JWT token for authentication | `''` |
+| `permissions` | `string[]` | Permission levels for the connection | `[]` |
+| `channels` | `string[]` | Additional channels to subscribe to | `[]` |
+| `user` | `any` | User information for presence tracking | `undefined` |
+| `retry` | `RetryOptions` | Retry configuration for reconnection | `{ times: 0, delay: 3 }` |
+
+### Injection Tokens
+
+| Token | Type | Purpose | Required |
+|-------|------|---------|----------|
+| `CONFIG_SETTINGS_TOKEN` | `ConfigOptions` | Global library configuration (provided by `forRoot()`) | Yes (via `forRoot()`) |
+| `APP_ID` | `string` | Unique application ID for encryption key generation | Yes (if using encryption) |
+
+### Providing APP_ID
+
+If using encryption features (localStorage encryption, AES/RSA encryption), you must provide a unique `APP_ID`:
+
+```typescript
+import { APP_ID } from '@angular/core';
+
+@NgModule({
+  providers: [
+    { provide: APP_ID, useValue: 'your-unique-app-guid-here' }
+  ]
+})
+export class AppModule { }
+```
+
+> **Important:** The `APP_ID` is used as the encryption key for `SymmetricalEncryptionService`. Use a strong, unique value per application.
+
 ## 📚 Services Overview
 
 ### Angular 14-18: Observable + NgRx Services
@@ -305,7 +342,7 @@ export class AppModule { }
 
 | 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 |
+| [`HTTPManagerSignalsService`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SIGNALS_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 |
@@ -316,6 +353,7 @@ export class AppModule { }
 | 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 |
+| [`Utility Services`](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/UTILS_SERVICES_README.md) | Headers, path/query, merging, base request classes | Internal and helper services |
 
 ### Common Use Cases
 
@@ -355,7 +393,7 @@ All detailed service guides live in `src/docs/`. Use this README as the entry po
 | 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) |
+| HTTP | [HTTP Manager Signals](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SIGNALS_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) |
@@ -481,7 +519,7 @@ For in-depth documentation on each service and component, refer to the following
 | 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 |
+| 📖 [HTTP Manager Signals Service](https://github.com/micheleboni/npm-angular/tree/main/projects/http-request-manager/src/docs/HTTP_SIGNALS_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 |

package/fesm2022/http-request-manager.mjs

@@ -908,54 +908,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.14", ngImpo
                 }]
         }], ctorParameters: () => [] });
 
-class NormalizedRequestOptionsModel {
-    constructor(pathKey = '', query = {}, hasQuery = false) {
-        this.pathKey = pathKey;
-        this.query = query;
-        this.hasQuery = hasQuery;
-    }
-    static adapt(item) {
-        return new NormalizedRequestOptionsModel(item?.pathKey, item?.query, item?.hasQuery);
-    }
-}
-
-class PathTrackerStateModel {
-    constructor(consumedValuesByKey = {}, watchExpiresAt) {
-        this.consumedValuesByKey = consumedValuesByKey;
-        this.watchExpiresAt = watchExpiresAt;
-    }
-    static adapt(item) {
-        return new PathTrackerStateModel(item?.consumedValuesByKey && typeof item.consumedValuesByKey === 'object' ? item.consumedValuesByKey : {}, item?.watchExpiresAt);
-    }
-}
-
-class QueryTrackerStateModel {
-    constructor(paths = {}) {
-        this.paths = paths;
-    }
-    static adapt(item) {
-        const paths = {};
-        if (item?.paths && typeof item.paths === 'object') {
-            Object.keys(item.paths).forEach((key) => {
-                paths[key] = PathTrackerStateModel.adapt(item.paths[key]);
-            });
-        }
-        return new QueryTrackerStateModel(paths);
-    }
-}
-
-class QueryParamsTrackerOptionsModel {
-    constructor(mode, watchParams, watchExpiresAt, watchParamsExpire) {
-        this.mode = mode;
-        this.watchParams = watchParams;
-        this.watchExpiresAt = watchExpiresAt;
-        this.watchParamsExpire = watchParamsExpire;
-    }
-    static adapt(item) {
-        return new QueryParamsTrackerOptionsModel(item?.mode, Array.isArray(item?.watchParams) ? item.watchParams : [], item?.watchExpiresAt, item?.watchParamsExpire);
-    }
-}
-
 class StreamConfigModel {
     constructor(streamType = StreamType.AI_STREAMING, totalHeader = 'X-Total-Count') {
         this.streamType = streamType;
@@ -5156,17 +5108,15 @@ class ApiRequest {
 }
 
 class RequestOptions {
-    constructor(path = [], headers = {}, forceRefresh, ignoreQueryParams, queryParamsExpiresIn, watchParams, watchExpiresAt) {
+    constructor(path = [], headers = {}, forceRefresh, ignoreQueryParams, queryParamsExpiresIn) {
         this.path = path;
         this.headers = headers;
         this.forceRefresh = forceRefresh;
         this.ignoreQueryParams = ignoreQueryParams;
         this.queryParamsExpiresIn = queryParamsExpiresIn;
-        this.watchParams = watchParams;
-        this.watchExpiresAt = watchExpiresAt;
     }
     static adapt(item) {
-        return new RequestOptions(item?.path, item?.headers, item?.forceRefresh, Array.isArray(item?.ignoreQueryParams) ? item.ignoreQueryParams : [], item?.queryParamsExpiresIn, item?.watchParams, item?.watchExpiresAt);
+        return new RequestOptions(item?.path, item?.headers, item?.forceRefresh, Array.isArray(item?.ignoreQueryParams) ? item.ignoreQueryParams : [], item?.queryParamsExpiresIn);
     }
 }
 
@@ -6573,7 +6523,6 @@ class ChannelMessage {
     }
 }
 
-// import { QueryParamsTrackerService } from '../utils/query-params-tracker.service';
 const API_OPTS = new InjectionToken('API_OPTS');
 /**
  * Channel type enum for different communication purposes
@@ -6616,7 +6565,6 @@ class HTTPManagerStateService extends ComponentStore {
         this.localStorageManagerService = inject(LocalStorageManagerService);
         this.utils = inject(UtilsService);
         this.logger = inject(LoggerService);
-        // private queryParamsTrackerService = inject(QueryParamsTrackerService)
         this.error$ = this.httpManagerService.error$;
         this.isPending$ = this.httpManagerService.isPending$.pipe(delay(1));
         this.operationSuccess = new BehaviorSubject(null);
@@ -8179,6 +8127,9 @@ class HTTPManagerStateService extends ComponentStore {
         this._requestCachePaths.set(tableName, this.resolvePath(options?.path).filter(p => typeof p === 'string' || typeof p === 'number').map(String));
         this.localStorageManagerService.store$(tableName).pipe(take(1), tap((storeData) => {
             const currentCache = storeData?.requestCache || {};
+            const currentEntry = currentCache[type] || {};
+            const currentQueryParams = { ...(currentEntry.queryParams || {}) };
+            const currentQueryParamsExpires = currentEntry.queryParamsExpires ?? null;
             this.localStorageManagerService.updateStore({
                 name: tableName,
                 data: {
@@ -8186,11 +8137,13 @@ class HTTPManagerStateService extends ComponentStore {
                     requestCache: {
                         ...currentCache,
                         [type]: {
-                            ...(currentCache[type] || {}),
+                            ...currentEntry,
                             signature,
                             savedAt: Date.now(),
                             path: this.resolvePath(options?.path),
-                            headers: this.filterHeaders(options?.headers)
+                            headers: this.filterHeaders(options?.headers),
+                            queryParams: currentQueryParams,
+                            queryParamsExpires: currentQueryParamsExpires,
                         }
                     }
                 }
@@ -8210,7 +8163,6 @@ class HTTPManagerStateService extends ComponentStore {
                 }
             }
             if (Array.isArray(pathArray) && pathArray.length > 0) {
-                // this.queryParamsTrackerService.clearTrackingForPath(pathArray.join('/'))
                 this._requestCachePaths.delete(tableName);
             }
             if (!storeData)
@@ -8356,11 +8308,11 @@ class HTTPManagerStateService extends ComponentStore {
                 accepted = true;
             }
         });
-        if (accepted) {
-            const newExpiry = this.trackerBuildExpiryEpoch(options?.queryParamsExpiresIn);
-            if (newExpiry !== null) {
-                queryParamsExpires = newExpiry;
-            }
+        const newExpiry = this.trackerBuildExpiryEpoch(options?.queryParamsExpiresIn);
+        if (newExpiry !== null) {
+            queryParamsExpires = newExpiry;
+        }
+        if (accepted || newExpiry !== null) {
             this.localStorageManagerService.store$(tableName).pipe(take(1), tap((latestStoreData) => {
                 const currentCache = latestStoreData?.requestCache || {};
                 const currentEntry = currentCache[type] || {};
@@ -10708,7 +10660,7 @@ class RequestManagerStateDemoComponent {
         const apiOptions = ApiRequest.adapt({ ...currentOptions, path: pathReq });
         return { apiOptions: apiOptions, path: pathReq };
     }
-    parseWatchParams(value) {
+    parseIgnoreParams(value) {
         if (!value || typeof value !== 'string') {
             return [];
         }
@@ -10717,25 +10669,16 @@ class RequestManagerStateDemoComponent {
             .map((item) => item.trim())
             .filter((item) => item.length > 0);
     }
-    normalizeWatchExpiry(value) {
-        if (typeof value === 'undefined' || value === null || value === '') {
-            return undefined;
-        }
-        if (typeof value === 'string' && value.trim().toLowerCase() === 'never') {
-            return undefined;
-        }
-        return value;
-    }
     buildDemoRequestOptions(path, headers) {
         const dbValue = this.database || {};
         const isDbEnabled = !!this.DBState?.checked;
-        const parsedWatchParams = this.parseWatchParams(dbValue?.ignoreQueryParams);
+        const parsedIgnoreQueryParams = this.parseIgnoreParams(dbValue?.ignoreQueryParams);
         return RequestOptions.adapt({
             path,
             headers,
             forceRefresh: false,
-            watchParams: isDbEnabled && parsedWatchParams.length > 0 ? parsedWatchParams : undefined,
-            watchExpiresAt: isDbEnabled ? this.normalizeWatchExpiry(dbValue?.queryParamsExpiresIn) : undefined,
+            ignoreQueryParams: isDbEnabled && parsedIgnoreQueryParams.length > 0 ? parsedIgnoreQueryParams : undefined,
+            queryParamsExpiresIn: isDbEnabled ? dbValue?.queryParamsExpiresIn : undefined,
         });
     }
     onSetStateOptions() {
@@ -13734,5 +13677,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.14", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { ApiRequest, AppService, AsymmetricalEncryptionService, BatchOptions, BatchResult, CONFIG_SETTINGS_TOKEN, ChannelType, ConfigHTTPOptions, ConfigOptions, DataType, DatabaseDataDemoComponent, DatabaseManagerService, DatabaseStorage, DbService, DexieSqlService, ErrorDisplaySettings, ExecutionPlanType, GlobalStoreOptions, HTTPManagerService, HTTPManagerSignalsService, HTTPManagerStateService, HeadersService, HttpRequestManagerModule, HttpRequestServicesDemoComponent, InvalidFileInfoModel, LocalStorageDemoComponent, LocalStorageManagerService, LocalStorageOptions, LocalStorageSignalsDemoComponent, LocalStorageSignalsManagerService, LoggerService, NormalizedRequestOptionsModel, NotificationMessage, OperationResultModel, ParsingResultModel, PathQueryService, PathTrackerStateModel, PublicMessage, QueryParamsTrackerOptionsModel, QueryTrackerStateModel, Random, RandomHSLColor, RandomHexColor, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomPaletteColor, RandomSignature, RandomStr, RandomVisibleColor, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, SqlParseError, SqlValidationError, StateMessage, StateOperationResult, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, StoreStateManagerSignalsService, StoreStateSignalsDemoComponent, StreamConfigModel, StreamEventMetadataModel, StreamEventModel, StreamOutputModel, StreamProgressModel, StreamType, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UploadDemoComponent, UploadValidationErrorModel, UserData, UtilsService, WSOptions, WebSocketMessageService, WithCredentialsInterceptor, calculateBatchProgress, countdown, createChannelName, delayedRetry, isErrorState, isPendingState, isSuccessState, requestPolling, requestStreaming, streamAI, streamAuto, streamEvents, streamJSON, streamNDJSON };
+export { ApiRequest, AppService, AsymmetricalEncryptionService, BatchOptions, BatchResult, CONFIG_SETTINGS_TOKEN, ChannelType, ConfigHTTPOptions, ConfigOptions, DataType, DatabaseDataDemoComponent, DatabaseManagerService, DatabaseStorage, DbService, DexieSqlService, ErrorDisplaySettings, ExecutionPlanType, GlobalStoreOptions, HTTPManagerService, HTTPManagerSignalsService, HTTPManagerStateService, HeadersService, HttpRequestManagerModule, HttpRequestServicesDemoComponent, InvalidFileInfoModel, LocalStorageDemoComponent, LocalStorageManagerService, LocalStorageOptions, LocalStorageSignalsDemoComponent, LocalStorageSignalsManagerService, LoggerService, NotificationMessage, OperationResultModel, ParsingResultModel, PathQueryService, PublicMessage, Random, RandomHSLColor, RandomHexColor, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomPaletteColor, RandomSignature, RandomStr, RandomVisibleColor, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, SqlParseError, SqlValidationError, StateMessage, StateOperationResult, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, StoreStateManagerSignalsService, StoreStateSignalsDemoComponent, StreamConfigModel, StreamEventMetadataModel, StreamEventModel, StreamOutputModel, StreamProgressModel, StreamType, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UploadDemoComponent, UploadValidationErrorModel, UserData, UtilsService, WSOptions, WebSocketMessageService, WithCredentialsInterceptor, calculateBatchProgress, countdown, createChannelName, delayedRetry, isErrorState, isPendingState, isSuccessState, requestPolling, requestStreaming, streamAI, streamAuto, streamEvents, streamJSON, streamNDJSON };
 //# sourceMappingURL=http-request-manager.mjs.map