@yuuvis/client-core 2.9.2 → 2.10.1

package/fesm2022/yuuvis-client-core.mjs

@@ -5,15 +5,15 @@ 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, isObservable, switchMap as switchMap$1 } from 'rxjs';
+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 { StorageMap } from '@ngx-pwa/local-storage';
 import { __decorate, __param, __metadata } from 'tslib';
 import { coerceBooleanProperty } from '@angular/cdk/coercion';
 import { toSignal, takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { DeviceDetectorService } from 'ngx-device-detector';
 import { DOCUMENT, DecimalPipe, PercentPipe, CurrencyPipe, registerLocaleData } from '@angular/common';
-import { MatTabGroup } from '@angular/material/tabs';
 import { FormGroup, FormControl } from '@angular/forms';
+import { MatTabGroup } from '@angular/material/tabs';
 import * as i1$1 from '@angular/platform-browser';
 import localeAr from '@angular/common/locales/ar';
 import localeBn from '@angular/common/locales/bn';
@@ -369,11 +369,9 @@ class YuvUser {
         this.firstname = json.firstname;
         this.lastname = json.lastname;
         this.email = json.email;
-        this.image = json.image;
         this.tenant = json.tenant;
-        this.domain = json.domain;
         this.authorities = json.authorities;
-        this.substituteOf = json.substituteOf;
+        // this.substituteOf = json.substituteOf;
         this.enabled = json.enabled;
         this.title = json.displayName || (this.firstname && this.lastname) ? `${this.lastname}, ${this.firstname} (${this.username})` : this.username;
         this.userSettings = userSettings || { locale: this.DEFAULT_USER_LOCALE };
@@ -974,8 +972,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
  * 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.
- *
+ * to care about prerequisites.
  */
 class BackendService {
     constructor() {
@@ -1221,15 +1218,36 @@ const OperatorLabel = {
  */
 class AppCacheService {
     #storage = inject(StorageMap);
+    /**
+     * Set item in storage.
+     * @param key The key under which the value is stored.
+     * @param value The value to store.
+     * @returns An Observable that emits true when the operation is successful.
+     */
     setItem(key, value) {
         return this.#storage.set(key, value).pipe(map(() => true));
     }
+    /**
+     * Get item from storage.
+     * @param key The key of the item to retrieve.
+     * @returns An Observable that emits the retrieved value.
+     */
     getItem(key) {
         return this.#storage.get(key);
     }
+    /**
+     * Remove item from storage.
+     * @param key The key of the item to remove.
+     * @returns An Observable that emits true when the operation is successful.
+     */
     removeItem(key) {
         return this.#storage.delete(key).pipe(map(() => true));
     }
+    /**
+     * Clear storage, optionally filtered by a function.
+     * @param filter A function to filter which keys to clear.
+     * @returns An Observable that emits true when the operation is successful.
+     */
     clear(filter) {
         return filter
             ? this.getStorageKeys().pipe(switchMap((keys) => {
@@ -1238,6 +1256,10 @@ class AppCacheService {
             }))
             : this.#storage.clear().pipe(map(() => true));
     }
+    /**
+     * Get all storage keys.
+     * @returns An Observable that emits an array of all storage keys.
+     */
     getStorageKeys() {
         return new Observable((observer) => {
             const keys = [];
@@ -1960,19 +1982,23 @@ class SearchService {
      * @param size The number of items to return
      * @returns Observable of a SearchResult
      */
-    searchCmis(statement, size = SearchService.DEFAULT_QUERY_SIZE) {
-        return this.#executeCmisSearch(statement, size);
+    searchCmis(statement, size = SearchService.DEFAULT_QUERY_SIZE, includePermissions = false) {
+        return this.#executeCmisSearch(statement, size, 0, includePermissions);
     }
-    #executeCmisSearch(statement, maxItems, skipCount = 0) {
-        return this.#backend
-            .post('/dms/objects/cmisSearch', {
+    #executeCmisSearch(statement, maxItems, skipCount = 0, includePermissions = false) {
+        const payload = {
             query: {
                 statement,
                 skipCount,
                 maxItems,
                 handleDeletedDocuments: 'DELETED_DOCUMENTS_EXCLUDE'
             }
+        };
+        if (includePermissions) {
+            payload.query.includePermissions = true;
         }
+        return this.#backend
+            .post('/dms/objects/cmisSearch', payload
         // Using API-WEB because it enriches the response with additional information (resolved user names, etc.)
         // ApiBase.core
         )
@@ -2254,7 +2280,7 @@ class EventService {
         this.#customEvents.push(CUSTOM_YUV_EVENT_PREFIX);
         if (!event.data || typeof event.data !== 'object')
             return false;
-        if (!this.#startsWithAllowed(event.data.source) || !this.#startsWithAllowed(event.data.type))
+        if (!(this.#startsWithAllowed(event.data.source) || this.#startsWithAllowed(event.data.type)))
             return false;
         // Accept messages from trusted origins
         this.#customEventsTrustedOrigins.push(window.location.origin);
@@ -3118,6 +3144,67 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
                 }]
         }] });
 
+/**
+ * Service for client-side caching of data with expiry handling.
+ * Provides methods to get, update, and invalidate cache entries.
+ */
+class ClientCacheService {
+    #appCacheService = inject(AppCacheService);
+    #CLIENT_CACHE_PREFIX = 'yuv-client-cache:';
+    /**
+     * Get cached entry by ID.
+     * @param id  The ID of the cache entry.
+     * @param keepIfExpired Whether to return/keep the entry even if it is expired.
+     * @returns The cached data or null if not found/expired.
+     */
+    getFromCache(id, keepIfExpired = false) {
+        return this.#appCacheService.getItem(this.#CLIENT_CACHE_PREFIX + id).pipe(map$1((cachedItem) => {
+            if (cachedItem) {
+                const expired = cachedItem.expires !== undefined && cachedItem.expires <= Date.now();
+                if (!expired || keepIfExpired) {
+                    return cachedItem.data;
+                }
+                else {
+                    this.invalidateCache(id);
+                    return null;
+                }
+            }
+            return null;
+        }));
+    }
+    /**
+     * Update or add cache entry.
+     * @param id The ID of the cache entry.
+     * @param data The data to cache.
+     * @param ttl TimeToLeave - The cache expiry time in milliseconds (how long to keep the cache entry valid).
+     */
+    updateCache(id, data, ttl) {
+        const cacheEntry = { id, expires: ttl ? ttl + Date.now() : undefined, data };
+        return this.#appCacheService.setItem(this.#CLIENT_CACHE_PREFIX + id, cacheEntry).pipe(map$1(() => cacheEntry));
+    }
+    /**
+     * Invalidate cache entry by ID. This will remove the entry from the cache.
+     * @param id The ID of the cache entry to invalidate.
+     */
+    invalidateCache(id) {
+        return this.#appCacheService.removeItem(this.#CLIENT_CACHE_PREFIX + id);
+    }
+    /**
+     * Clear all client cache entries.
+     */
+    clear() {
+        return this.#appCacheService.clear((k) => k.startsWith(this.#CLIENT_CACHE_PREFIX));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.15", ngImport: i0, type: ClientCacheService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.15", ngImport: i0, type: ClientCacheService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImport: i0, type: ClientCacheService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root'
+                }]
+        }] });
+
 class ClipboardService {
     #emptyClipboard = {
         buckets: undefined,
@@ -4124,8 +4211,32 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
                 }]
         }] });
 
+/**
+ * Service for managing Identity Management (IDM) operations.
+ * Provides functionality for querying users, roles, and organization entities,
+ * with built-in caching mechanisms to optimize performance.
+ */
 class IdmService {
-    #backend = inject(BackendService);
+    #backend;
+    #clientCache;
+    #IDM_USER_CACHE_KEY;
+    #IDM_USER_CACHE_TTL; // 1 hour in milliseconds
+    constructor() {
+        this.#backend = inject(BackendService);
+        this.#clientCache = inject(ClientCacheService);
+        this.#IDM_USER_CACHE_KEY = 'yuv-idm-user-cache';
+        this.#IDM_USER_CACHE_TTL = 60 * 60 * 1000; // 1 hour in milliseconds
+        this.userCache = {};
+        this.#loadIdmCache();
+    }
+    /**
+     * Queries organization entities (users and/or roles) based on search term.
+     *
+     * @param term - The search term to filter entities
+     * @param targetTypes - Array of entity types to search for ('user', 'role')
+     * @param size - Optional maximum number of results to return
+     * @returns Observable array of organization set entries matching the search criteria
+     */
     queryOrganizationEntity(term, targetTypes, size) {
         const searchParams = new URLSearchParams();
         searchParams.set('search', term);
@@ -4147,13 +4258,46 @@ class IdmService {
                 : [])
         ]));
     }
+    /**
+     * Retrieves available roles, optionally filtered by a search term.
+     *
+     * @param role - Optional search term to filter roles by name
+     * @returns Observable array of role objects containing name and description
+     */
     getRoles(role) {
         const searchParams = new URLSearchParams();
         role && searchParams.set('search', role);
         return this.#backend.get(`/idm/roles?${searchParams.toString()}`).pipe(catchError$1(() => of([])));
     }
+    /**
+     * Retrieves user information by user ID with automatic caching.
+     * Uses a 1-hour TTL cache to minimize backend requests.
+     *
+     * @param id - The unique identifier of the user
+     * @returns Observable of YuvUser object or null if user is not found
+     */
     getUserById(id) {
-        return this.#backend.get(`/idm/users/${id}`).pipe(map$1((res) => (res ? new YuvUser(res) : null)), catchError$1(() => of(null)));
+        const cachedUser = this.userCache[id];
+        const isCacheValid = cachedUser && Date.now() < cachedUser.expires;
+        if (isCacheValid) {
+            return of(new YuvUser(cachedUser.user));
+        }
+        else {
+            return this.#backend.get(`/idm/users/${id}`).pipe(switchMap$1((user) => {
+                this.userCache[id] = {
+                    expires: Date.now() + this.#IDM_USER_CACHE_TTL,
+                    user
+                };
+                return this.#clientCache.updateCache(this.#IDM_USER_CACHE_KEY, this.userCache).pipe(map$1(() => user));
+            }), map$1((user) => (user ? new YuvUser(user) : null)), catchError$1(() => of(null)));
+        }
+    }
+    #loadIdmCache() {
+        return this.#clientCache.getFromCache(this.#IDM_USER_CACHE_KEY).subscribe({
+            next: (cache) => {
+                this.userCache = cache || {};
+            }
+        });
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.15", ngImport: i0, type: IdmService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.15", ngImport: i0, type: IdmService, providedIn: 'root' }); }
@@ -4163,7 +4307,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
             args: [{
                     providedIn: 'root'
                 }]
-        }] });
+        }], ctorParameters: () => [] });
 
 const YuvToastStyles = `
 .yuv-toast-container {
@@ -4478,6 +4622,27 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
                 }]
         }], ctorParameters: () => [] });
 
+class ObjectFormControlWrapper extends FormGroup {
+}
+/**
+ * @ignore
+ * Extension of the default angular form group,
+ */
+class ObjectFormGroup extends FormGroup {
+}
+/**
+ * @ignore
+ * Extension of the default angular form control,
+ */
+class ObjectFormControl extends FormControl {
+    set _eoFormElement(v) {
+        this.__eoFormElement = v;
+    }
+    get _eoFormElement() {
+        return this.__eoFormElement;
+    }
+}
+
 /**
  * EditingObserver service is used to track changes made inside the application, that should prevent
  * doing something or going somewhere before the changes are persisted or ignored. For example when
@@ -5105,27 +5270,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
                 }]
         }], ctorParameters: () => [] });
 
-class ObjectFormControlWrapper extends FormGroup {
-}
-/**
- * @ignore
- * Extension of the default angular form group,
- */
-class ObjectFormGroup extends FormGroup {
-}
-/**
- * @ignore
- * Extension of the default angular form control,
- */
-class ObjectFormControl extends FormControl {
-    set _eoFormElement(v) {
-        this.__eoFormElement = v;
-    }
-    get _eoFormElement() {
-        return this.__eoFormElement;
-    }
-}
-
 /**
  * Service providing user related remote storage. This service is used load and
  * store user related data from any device.
@@ -5581,5 +5725,5 @@ const provideRequirements = (requirements) => {
  * Generated bundle index. Do not edit.
  */
 
-export { AFO_STATE, AVAILABLE_BACKEND_APPS, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthService, BackendService, BaseObjectTypeField, BpmService, CLIENT_APP_REQUIREMENTS, CORE_CONFIG, CUSTOM_CONFIG, CUSTOM_YUV_EVENT_PREFIX, CatalogService, Classification, ClassificationPrefix, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, TabGuardDirective, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, init_moduleFnc, provideAvailabilityManagement, provideRequirements, provideUser, provideYuvClientCore };
+export { AFO_STATE, AVAILABLE_BACKEND_APPS, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthService, BackendService, BaseObjectTypeField, BpmService, CLIENT_APP_REQUIREMENTS, CORE_CONFIG, CUSTOM_CONFIG, CUSTOM_YUV_EVENT_PREFIX, CatalogService, Classification, ClassificationPrefix, ClientCacheService, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, TabGuardDirective, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, init_moduleFnc, provideAvailabilityManagement, provideRequirements, provideUser, provideYuvClientCore };
 //# sourceMappingURL=yuuvis-client-core.mjs.map