@yuuvis/client-core 2.0.3 → 2.0.5

package/fesm2022/yuuvis-client-core.mjs

@@ -894,7 +894,11 @@ class Logger {
 }
 
 /**
- * Service for providing an yuuvis Backend
+ * 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 preqrequisits.
+ *
  */
 class BackendService {
     constructor() {
@@ -2314,6 +2318,8 @@ class AuditService {
     #userService;
     /**
      * Get audit entries of a dms object
+     * @param id The id of the object to get the audit entries for
+     * @param options Options
      */
     getAuditEntries(id, options = {}) {
         const auditActions = this.getAuditActions(!!options.allActions, options?.skipActions);
@@ -2727,7 +2733,11 @@ class AuthService {
         this.#authSource.next(this.#authenticated);
         this.#eventService.trigger(YuvEventType.LOGOUT);
     }
-    // called on core init
+    /**
+     * Persists the initial request URI. This is nessesary to be able to
+     * redirect the user to the requested page after authentication.
+     * This is done on app initialization (core-init).
+     */
     setInitialRequestUri() {
         const ignore = ['/', '/index.html'];
         let uri = `${location.pathname}${location.search}`.replace(Utils.getBaseHref(), '');
@@ -2939,7 +2949,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.12", ngImpo
         }] });
 
 /**
- * This service is used for connecting and initializing in the client
+ * Service to monitor the online/offline state of the application.
+ * It listens to the browser's online and offline events and provides an observable
+ * to track the current connection state.
+ *
+ * An observable `connection$` is provided which emits the current connection state
+ * whenever the online or offline state changes. The initial state is determined by
+ * the `window.navigator.onLine` property.
  */
 class ConnectionService {
     /**