@yuuvis/client-core 2.9.2 → 2.10.1

package/index.d.ts

@@ -1,7 +1,7 @@
 export { TranslateDirective, TranslateLoader, TranslateModule, TranslatePipe, TranslateService } from '@ngx-translate/core';
 export * from './lib/model/dms-object.interface';
-export * from './lib/model/object-flavor.interface';
 export * from './lib/model/dms-object.model';
+export * from './lib/model/object-flavor.interface';
 export * from './lib/model/range-value.interface';
 export * from './lib/model/yuv-error.model';
 export * from './lib/model/yuv-user.model';
@@ -12,11 +12,13 @@ export * from './lib/service/auth/auth.service';
 export * from './lib/service/backend/api.enum';
 export * from './lib/service/backend/backend.interface';
 export * from './lib/service/backend/backend.service';
-export * from './lib/service/bpm/bpm.service';
 export * from './lib/service/bpm/bpm.interface';
+export * from './lib/service/bpm/bpm.service';
 export * from './lib/service/cache/app-cache.service';
 export * from './lib/service/catalog/catalog.interface';
 export * from './lib/service/catalog/catalog.service';
+export * from './lib/service/client-cache/client-cache.interface';
+export * from './lib/service/client-cache/client-cache.service';
 export * from './lib/service/clipboard/clipboard.interface';
 export * from './lib/service/clipboard/clipboard.service';
 export * from './lib/service/config/config.interface';
@@ -25,31 +27,31 @@ export * from './lib/service/config/core-config';
 export * from './lib/service/config/core-config.tokens';
 export * from './lib/service/connection/connection.service';
 export * from './lib/service/core-init/core-init.service';
-export * from './lib/service/device/device.service';
 export * from './lib/service/device/device.interface';
+export * from './lib/service/device/device.service';
 export * from './lib/service/dms/dms.service';
 export * from './lib/service/dms/dms.service.interface';
 export * from './lib/service/event/event.interface';
 export * from './lib/service/event/event.service';
 export * from './lib/service/event/events';
-export * from './lib/service/idm/idm.interface';
+export * from './lib/service/idm/models';
 export * from './lib/service/idm/idm.service';
-export * from './lib/service/logger/logger.service';
 export * from './lib/service/logger/logger.interface';
+export * from './lib/service/logger/logger.service';
 export * from './lib/service/notification/notification.service';
 export * from './lib/service/object-config/object-config.interface';
 export * from './lib/service/object-config/object-config.service';
+export * from './lib/service/object-form/object-form.interface';
+export * from './lib/service/object-form/object-form.model';
 export * from './lib/service/pending-changes';
 export * from './lib/service/prediction/prediction.interface';
 export * from './lib/service/prediction/prediction.service';
-export * from './lib/service/retention/retention.service';
 export * from './lib/service/retention/retention.interface';
+export * from './lib/service/retention/retention.service';
 export * from './lib/service/search/search.service';
-export * from './lib/service/search/search.utils';
 export * from './lib/service/search/search.service.interface';
+export * from './lib/service/search/search.utils';
 export * from './lib/service/session-storage/session-storage.service';
-export * from './lib/service/object-form/object-form.interface';
-export * from './lib/service/object-form/object-form.model';
 export * from './lib/service/system/system.enum';
 export * from './lib/service/system/system.interface';
 export * from './lib/service/system/system.service';
@@ -57,9 +59,9 @@ export * from './lib/service/toast/toast.interface';
 export * from './lib/service/toast/toast.service';
 export * from './lib/service/upload/upload.interface';
 export * from './lib/service/upload/upload.service';
-export * from './lib/service/user/user.service';
-export * from './lib/service/user/user.providers';
 export * from './lib/service/user/user-storage.service';
+export * from './lib/service/user/user.providers';
+export * from './lib/service/user/user.service';
 export * from './lib/util/utils';
 export * from './lib/util/utils.helper.enum';
 export * from './lib/common/pipes';

package/lib/model/yuv-user.model.d.ts

@@ -1,3 +1,4 @@
+import { IdmUserResponse } from "../service/idm/models";
 /**
  * User account configuration
  */
@@ -9,11 +10,8 @@ export declare class YuvUser {
     lastname: string;
     title: string;
     email: string;
-    image: string;
     tenant: string;
-    domain: string;
     authorities: string[];
-    substituteOf: string[];
     enabled: boolean;
     /**
      * User settings
@@ -26,7 +24,7 @@ export declare class YuvUser {
     /**
      * @ignore
      */
-    constructor(json: any, userSettings?: UserSettings);
+    constructor(json: IdmUserResponse, userSettings?: UserSettings);
     /**
      * Gets the users configured client locale
      * @returns locale string

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

@@ -7,8 +7,7 @@ import * as i0 from "@angular/core";
  * 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.
  */
 export declare class BackendService {
     #private;
@@ -31,7 +30,7 @@ export declare class BackendService {
      * @param requestOptions Additional request options
      * @returns The data retrieved from the given endpoint
      */
-    get(uri: string, base?: string, requestOptions?: HttpOptions): Observable<any>;
+    get<T = any>(uri: string, base?: string, requestOptions?: HttpOptions): Observable<T>;
     /**
      * Wrapped HTTP POST method
      * @param uri The target REST URI
@@ -40,7 +39,7 @@ export declare class BackendService {
      * @param requestOptions Additional request options
      * @returns The return value of the target POST endpoint
      */
-    post(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<any>;
+    post<T = any>(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<T>;
     /**
      * Performs a multipart form data POST request.
      * @param uri The target REST URI
@@ -58,7 +57,7 @@ export declare class BackendService {
      * @param requestOptions Additional request options
      * @returns The return value of the target PATCH endpoint
      */
-    patch(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<any>;
+    patch<T = any>(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<T>;
     /**
      * Wrapped HTTP PUT method
      * @param uri The target REST URI
@@ -67,7 +66,7 @@ export declare class BackendService {
      * @param requestOptions Additional request options
      * @returns The return value of the target PUT endpoint
      */
-    put(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<any>;
+    put<T = any>(uri: string, data?: any, base?: string, requestOptions?: HttpOptions): Observable<T>;
     /**
      * Wrapped HTTP DELETE method
      * @param uri The target REST URI
@@ -75,7 +74,7 @@ export declare class BackendService {
      * @param requestOptions Additional request options
      * @returns The return value of the target DELETE endpoint
      */
-    delete(uri: string, base?: string, requestOptions?: HttpDeleteOptions): Observable<any>;
+    delete<T = any>(uri: string, base?: string, requestOptions?: HttpDeleteOptions): Observable<T>;
     /**
      * @ignore
      * Cache for small requests like icons and configs

package/lib/service/cache/app-cache.service.d.ts

@@ -7,10 +7,35 @@ import * as i0 from "@angular/core";
  */
 export declare class AppCacheService {
     #private;
-    setItem(key: string, value: any): Observable<boolean>;
+    /**
+     * 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<T = any>(key: string, value: T): Observable<boolean>;
+    /**
+     * Get item from storage.
+     * @param key The key of the item to retrieve.
+     * @returns An Observable that emits the retrieved value.
+     */
     getItem<T = any>(key: string): Observable<T>;
+    /**
+     * 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: string): Observable<boolean>;
+    /**
+     * 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?: (key: any) => boolean): Observable<boolean>;
+    /**
+     * Get all storage keys.
+     * @returns An Observable that emits an array of all storage keys.
+     */
     getStorageKeys(): Observable<string[]>;
     setStorage(options: any): Observable<any>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AppCacheService, never>;

package/lib/service/client-cache/client-cache.interface.d.ts

@@ -0,0 +1,5 @@
+export interface CacheEntry<T> {
+    expires?: number;
+    id: string;
+    data: T;
+}

package/lib/service/client-cache/client-cache.service.d.ts

@@ -0,0 +1,35 @@
+import { Observable } from 'rxjs';
+import { CacheEntry } from './client-cache.interface';
+import * as i0 from "@angular/core";
+/**
+ * Service for client-side caching of data with expiry handling.
+ * Provides methods to get, update, and invalidate cache entries.
+ */
+export declare class ClientCacheService {
+    #private;
+    /**
+     * 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<T>(id: string, keepIfExpired?: boolean): Observable<T | 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<T>(id: string, data: T, ttl?: number): Observable<CacheEntry<T>>;
+    /**
+     * 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: string): Observable<boolean>;
+    /**
+     * Clear all client cache entries.
+     */
+    clear(): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClientCacheService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ClientCacheService>;
+}

package/lib/service/idm/idm.service.d.ts

@@ -1,14 +1,42 @@
 import { Observable } from 'rxjs';
-import { OrganizationSetEntry } from './idm.interface';
 import { YuvUser } from '../../model/yuv-user.model';
+import { IdmUserCache, OrganizationSetEntry } from './models';
 import * as i0 from "@angular/core";
+/**
+ * Service for managing Identity Management (IDM) operations.
+ * Provides functionality for querying users, roles, and organization entities,
+ * with built-in caching mechanisms to optimize performance.
+ */
 export declare class IdmService {
     #private;
+    userCache: IdmUserCache;
+    constructor();
+    /**
+     * 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: string, targetTypes: string[], size?: number): Observable<OrganizationSetEntry[]>;
+    /**
+     * 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?: string): Observable<{
         name: string;
         description: string;
     }[]>;
+    /**
+     * 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: string): Observable<YuvUser | null>;
     static ɵfac: i0.ɵɵFactoryDeclaration<IdmService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<IdmService>;

package/lib/service/idm/models/idm-cached-user.model.d.ts

@@ -0,0 +1,11 @@
+import { IdmUserResponse } from './idm-user-response.model';
+/**
+ * Represents a cached user entry with expiration timestamp.
+ * Used internally by IdmService to manage user data caching.
+ */
+export interface IdmCachedUser {
+    /** Timestamp when the cache expires (Date.now() + TTL) */
+    expires: number;
+    /** The cached user data from the IDM API */
+    user: IdmUserResponse;
+}

package/lib/service/idm/models/idm-user-cache.model.d.ts

@@ -0,0 +1,9 @@
+import { IdmCachedUser } from './idm-cached-user.model';
+/**
+ * Dictionary/map structure for storing cached user data.
+ * Keys are user IDs and values are cached user entries with expiration.
+ */
+export interface IdmUserCache {
+    /** Map of user IDs to their cached user data */
+    [userId: string]: IdmCachedUser;
+}

package/lib/service/idm/models/idm-user-response.model.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents the user data structure returned from the IDM API.
+ * Contains all essential user information including authentication and authorization details.
+ */
+export interface IdmUserResponse {
+    /** The unique username for login */
+    username: string;
+    /** The unique user identifier */
+    id: string;
+    /** The user's email address */
+    email: string;
+    /** The user's first name */
+    firstname: string;
+    /** The user's last name */
+    lastname: string;
+    /** Whether the user account is enabled/active */
+    enabled: boolean;
+    /** The tenant identifier this user belongs to */
+    tenant: string;
+    /** Array of granted authorities/permissions for the user */
+    authorities: string[];
+    /** The formatted display name for the user */
+    displayName: string;
+}

package/lib/service/idm/models/index.d.ts

@@ -0,0 +1,4 @@
+export * from './organization-set-entry.model';
+export * from './idm-user-cache.model';
+export * from './idm-cached-user.model';
+export * from './idm-user-response.model';

package/lib/service/idm/models/organization-set-entry.model.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Represents an entry in the organization set, which can be either a user or a role.
+ * Used in search results and organization entity queries.
+ */
+export interface OrganizationSetEntry {
+    /** The unique identifier of the user or role */
+    id: string;
+    /** The display title/name for the entry */
+    title: string;
+    /** The type of organization entity */
+    type: 'user' | 'role';
+}

package/lib/service/search/search.service.d.ts

@@ -23,7 +23,7 @@ export declare class SearchService {
      * @param size The number of items to return
      * @returns Observable of a SearchResult
      */
-    searchCmis(statement: string, size?: number): Observable<SearchResult>;
+    searchCmis(statement: string, size?: number, includePermissions?: boolean): Observable<SearchResult>;
     /**
      * Fetch aggragations for a given query.
      * @param q The query

package/package.json

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

package/lib/service/idm/idm.interface.d.ts

@@ -1,5 +0,0 @@
-export interface OrganizationSetEntry {
-    id: string;
-    title: string;
-    type: 'user' | 'role';
-}