@yuuvis/client-core 2.10.2 → 2.11.0

package/fesm2022/yuuvis-client-core.mjs

@@ -5,7 +5,7 @@ import { HttpErrorResponse, HttpClient, HttpHeaders, HttpRequest, HttpParams, Ht
 import * as i0 from '@angular/core';
 import { inject, Injectable, InjectionToken, NgZone, Inject, signal, Directive, Pipe, makeEnvironmentProviders, importProvidersFrom, provideAppInitializer } from '@angular/core';
 import { tap, finalize, shareReplay, catchError, map, switchMap, first, filter, scan, delay } from 'rxjs/operators';
-import { EMPTY, of, forkJoin, Observable, ReplaySubject, Subject, BehaviorSubject, tap as tap$1, map as map$1, merge, fromEvent, filter as filter$1, debounceTime, throwError, catchError as catchError$1, switchMap as switchMap$1, isObservable } from 'rxjs';
+import { EMPTY, Subject, of, forkJoin, Observable, ReplaySubject, BehaviorSubject, tap as tap$1, map as map$1, merge, fromEvent, filter as filter$1, debounceTime, throwError, catchError as catchError$1, switchMap as switchMap$1, isObservable } from 'rxjs';
 import { StorageMap } from '@ngx-pwa/local-storage';
 import { __decorate, __param, __metadata } from 'tslib';
 import { coerceBooleanProperty } from '@angular/cdk/coercion';
@@ -969,10 +969,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
         }], ctorParameters: () => [{ type: ConfigService }] });
 
 /**
- * Service for http communication with the yuuvis Momentum backend. Apps
- * should use this service to communicate with the backend instead of default
- * httpClient because required headers are managed and apps do not have
- * to care about prerequisites.
+ * Service for HTTP communication with the yuuvis Momentum backend.
+ *
+ * This service wraps Angular's HttpClient and provides:
+ * - Automatic base URI management for different backend services
+ * - Centralized header management (authorization, content-type, etc.)
+ * - Response caching with configurable TTL
+ * - HTTP activity tracking for session management
+ * - Standardized error handling and logging
+ *
+ * **Why Use This Service:**
+ * Applications should use BackendService instead of HttpClient directly because
+ * required headers (authentication, content-type) are automatically managed,
+ * and apps don't have to handle backend URL construction and prerequisites.
+ *
+ * **HTTP Activity Tracking:**
+ * All HTTP requests emit events via `httpCommunicationOccurred$`, which is used by
+ * SessionService and other consumers to detect user activity and keep sessions alive.
+ *
+ * @see {@link SessionService} for session management integration (Task HAR-2975)
  */
 class BackendService {
     constructor() {
@@ -984,12 +999,55 @@ class BackendService {
         this.#headers = new HttpHeaders({
             'Content-Type': 'application/json'
         });
+        /**
+         * Observable that emits every time HTTP communication occurs with the server.
+         *
+         * This observable is used by:
+         * - **SessionService**: To detect user activity and automatically extend sessions (Task 2975)
+         * - **Other consumers**: Potentially for activity tracking, analytics, or loading indicators
+         *
+         * Events are emitted on every successful HTTP GET request. POST, PUT, DELETE, and PATCH
+         * requests may also trigger events depending on the specific method implementation.
+         *
+         * **Usage Example:**
+         * ```typescript
+         * backendService.httpCommunicationOccurred$.subscribe(() => {
+         *   console.log('HTTP activity detected');
+         *   sessionService.extendSession();
+         * });
+         * ```
+         *
+         * @internal The private Subject should not be accessed directly; use the public observable
+         */
+        this.#httpCallOccurred$ = new Subject();
+        this.httpCommunicationOccurred$ = this.#httpCallOccurred$.asObservable();
     }
     #http;
     #logger;
     #cache;
     #temp;
     #headers;
+    /**
+     * Observable that emits every time HTTP communication occurs with the server.
+     *
+     * This observable is used by:
+     * - **SessionService**: To detect user activity and automatically extend sessions (Task 2975)
+     * - **Other consumers**: Potentially for activity tracking, analytics, or loading indicators
+     *
+     * Events are emitted on every successful HTTP GET request. POST, PUT, DELETE, and PATCH
+     * requests may also trigger events depending on the specific method implementation.
+     *
+     * **Usage Example:**
+     * ```typescript
+     * backendService.httpCommunicationOccurred$.subscribe(() => {
+     *   console.log('HTTP activity detected');
+     *   sessionService.extendSession();
+     * });
+     * ```
+     *
+     * @internal The private Subject should not be accessed directly; use the public observable
+     */
+    #httpCallOccurred$;
     /**
      * OpenIdConnect authorization headers
      */
@@ -1018,7 +1076,7 @@ class BackendService {
      * @returns The data retrieved from the given endpoint
      */
     get(uri, base, requestOptions) {
-        return this.#http.get(this.getApiBase(base) + uri, this.getHttpOptions(requestOptions));
+        return this.#http.get(this.getApiBase(base) + uri, this.getHttpOptions(requestOptions)).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * Wrapped HTTP POST method
@@ -1031,7 +1089,7 @@ class BackendService {
     post(uri, data, base, requestOptions) {
         const baseUri = this.getApiBase(base);
         const payload = data && typeof data === 'object' ? JSON.stringify(data) : data || '';
-        return this.#http.post(`${baseUri}${uri}`, payload, this.getHttpOptions(requestOptions));
+        return this.#http.post(`${baseUri}${uri}`, payload, this.getHttpOptions(requestOptions)).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * Performs a multipart form data POST request.
@@ -1048,7 +1106,7 @@ class BackendService {
         // and the request would fail.
         // As our post method already sets the Content-Type to application/json we can't use it for multipart requests.
         const req = new HttpRequest('POST', `${this.getApiBase(base)}${uri}`, formData, requestOptions);
-        return this.#http.request(req);
+        return this.#http.request(req).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * Wrapped HTTP PATCH method
@@ -1061,7 +1119,7 @@ class BackendService {
     patch(uri, data, base, requestOptions) {
         const baseUri = this.getApiBase(base);
         const payload = data ? JSON.stringify(data) : '';
-        return this.#http.patch(`${baseUri}${uri}`, payload, this.getHttpOptions(requestOptions));
+        return this.#http.patch(`${baseUri}${uri}`, payload, this.getHttpOptions(requestOptions)).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * Wrapped HTTP PUT method
@@ -1072,7 +1130,7 @@ class BackendService {
      * @returns The return value of the target PUT endpoint
      */
     put(uri, data, base, requestOptions) {
-        return this.#http.put(this.getApiBase(base) + uri, data, this.getHttpOptions(requestOptions));
+        return this.#http.put(this.getApiBase(base) + uri, data, this.getHttpOptions(requestOptions)).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * Wrapped HTTP DELETE method
@@ -1082,7 +1140,7 @@ class BackendService {
      * @returns The return value of the target DELETE endpoint
      */
     delete(uri, base, requestOptions) {
-        return this.#http.delete(this.getApiBase(base) + uri, this.getHttpOptions(requestOptions));
+        return this.#http.delete(this.getApiBase(base) + uri, this.getHttpOptions(requestOptions)).pipe(tap(() => this.#httpCallOccurred$.next()));
     }
     /**
      * @ignore
@@ -1159,6 +1217,7 @@ class BackendService {
      * Batch service
      */
     batch(requests) {
+        this.#httpCallOccurred$.next();
         const httpRequests = requests.map((r) => this[(r.method || 'get').toLowerCase()]
             .apply(this, [r.uri, r.body, r.base, r.requestOptions].filter((a) => a))
             .pipe(catchError((err) => of({ _error: err }))));