@yuuvis/client-core 2.0.4 → 2.0.5

package/lib/service/audit/audit.service.d.ts

@@ -15,6 +15,8 @@ export declare class AuditService {
     private adminAuditActions;
     /**
      * 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: string, options?: AuditQueryOptions): Observable<AuditQueryResult>;
     /**

package/lib/service/auth/auth.service.d.ts

@@ -31,6 +31,11 @@ export declare class AuthService {
      * Logs out the current user.
      */
     logout(): void;
+    /**
+     * 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(): void;
     /**
      * Get the URL that entered the app. May be a deep link that could then be

package/lib/service/backend/backend.service.d.ts

@@ -4,7 +4,11 @@ import { ConfigService } from '../config/config.service';
 import { HttpDeleteOptions, HttpOptions } from './backend.interface';
 import * as i0 from "@angular/core";
 /**
- * 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.
+ *
  */
 export declare class BackendService {
     #private;

package/lib/service/connection/connection.service.d.ts

@@ -1,7 +1,13 @@
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class ConnectionService {
     private currentState;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuuvis/client-core",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "author": "OPTIMAL SYSTEMS GmbH <npm@optimal-systems.de>",
   "license": "MIT",
   "peerDependencies": {