@yuuvis/client-core 2.10.0 → 2.10.2

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

@@ -2,15 +2,41 @@ import { Observable } from 'rxjs';
 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

@@ -1,6 +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

@@ -1,4 +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

@@ -1,11 +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/organization-set-entry.model.d.ts

@@ -1,5 +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/package.json

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