@yuuvis/client-core 2.10.0 → 2.10.1

package/fesm2022/yuuvis-client-core.mjs

@@ -2280,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);
@@ -4211,6 +4211,11 @@ 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;
     #clientCache;
@@ -4224,6 +4229,14 @@ class IdmService {
         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);
@@ -4245,11 +4258,24 @@ 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) {
         const cachedUser = this.userCache[id];
         const isCacheValid = cachedUser && Date.now() < cachedUser.expires;