@ale-rainbow/web-sdk 5.1.0

package/lib/services/users/user.service.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @module User
+ */
+import { Service } from "../../services";
+import type { ConnectedUser, User } from "../../models";
+import { RBEvent } from "../../models";
+import type { Subscription } from "rxjs";
+import type { UsersByEmailsResult } from "../../models/user.model";
+/** @internal */
+export declare const USER_SVC = "UserService";
+/**
+ * Users service events
+ * Can listen to it via `UserService.subscribe()` API.
+ * @eventProperty
+ */
+export declare enum UserServiceEvents {
+    /**
+    * @eventProperty
+    */
+    ON_USER_CHANGED = "ON_USER_CHANGED"
+}
+/**
+ * User Service interface
+ */
+export interface UserService {
+    /**
+     * The current connectedUser
+     */
+    connectedUser?: ConnectedUser;
+    /**
+     * Subscribe to updates from the user service, all events are of RBEvent<UserServiceEvents>
+     * @param callback - The callback function that will be called when events are received
+     * @param eventNames - Array of event to listen
+     * @returns Returns RxJS Subscription
+     */
+    subscribe: (callback: (event: RBEvent<UserServiceEvents>) => any, eventNames?: UserServiceEvents | UserServiceEvents[]) => Subscription;
+    /**
+     * Get a user by one of its identifier
+     * The user is first search in service cache then server side.
+     * @param userRef - a user jid or user dbId or user jid tel
+     */
+    getUserById: (userRef: string) => Promise<User | undefined>;
+    /**
+     * Retrieves users matching the given e-mail addresses.
+     *
+     * Each e-mail is looked up against the Rainbow directory. Found users are
+     * returned both as an indexed map (keyed by login e-mail) and as a flat
+     * array. E-mail addresses that did not match any Rainbow user are returned
+     * in the `emails` array so the caller can handle them as guest invitations.
+     *
+     * @param emails - List of e-mail addresses to resolve.
+     * @returns An object containing:
+     *   - `contacts` — a map of `loginEmail → User` for matched users,
+     *   - `contactsArray` — the same matched users as a flat array,
+     *   - `emails` — e-mail addresses that could not be resolved to a user.
+     */
+    getUsersByEmails: (emails: string[]) => Promise<any>;
+    /**
+     * Computes a deterministic color string associated with a user's display name.
+     * The same display name will always produce the same color, making it suitable
+     * for use as a user avatar background color.
+     * @param displayName - The display name of the user
+     * @returns A color string (e.g. a hex or CSS color value)
+     */
+    computeUserColor: (displayName: string) => {
+        colorIndex: number;
+        color: string;
+        colorName: string;
+    };
+    /**
+     * Computes the avatar representation for a user.
+     * If no avatar update timestamp is provided, generates a default avatar image from the user's initials and color.
+     * Otherwise, returns a URL pointing to the server-side avatar image.
+     * @param objId - The unique identifier of the user
+     * @param initials - The user's initials, used to generate a default avatar
+     * @param color - The background color used when generating the default avatar
+     * @param size - The desired avatar size in pixels
+     * @param lastAvatarUpdate - Timestamp of the last avatar update; falsy if no custom avatar exists
+     * @returns An `HTMLImageElement` for a generated default avatar, an object with a `src` URL for a server avatar, or `null` if no initials are available
+     */
+    computeUserAvatar: (objId: string | null, initials: string, color: string, size?: number, lastAvatarUpdate?: any) => HTMLImageElement | {
+        src: string;
+    } | null;
+    /**
+     * Computes the display name and initials for a user from their first and last name.
+     * The display order (first-last or last-first) is determined by the application settings.
+     * @param firstName - The user's first name
+     * @param lastName - The user's last name
+     * @returns An object containing the formatted `displayName` and the two-letter `initials`
+     */
+    computeUserName: (firstName: string, lastName: string) => {
+        displayName: string;
+        initials: string;
+    };
+}
+/**
+ * User Service implementation
+ * @internal
+ */
+export declare class UserServiceRB extends Service implements UserService {
+    private rxSubject;
+    private readonly logger;
+    private readonly userInfoService;
+    private contactService?;
+    /**
+      * Returns the Favorite service singleton
+      */
+    static getInstance(): UserServiceRB;
+    static build(): UserServiceRB;
+    private constructor();
+    get connectedUser(): ConnectedUser;
+    subscribe(handler: (event: RBEvent<UserServiceEvents>) => any, eventNames?: UserServiceEvents | UserServiceEvents[]): Subscription;
+    configure(contactService: any): void;
+    /**
+     * User service events send method
+     * Can listen to it via UserService.subscribe() API
+     * @param name - the name of the event
+     * @param data - the data to be send (an object)
+     */
+    sendEvent(name: UserServiceEvents, data?: any): void;
+    /**
+     * Get a user by one of its identifier
+     * The user is first search in service cache then server side.
+     * @param userRef - a user jid or user dbId or user jid tel
+     */
+    getUserById(userRef: string): Promise<User | undefined>;
+    getUsersByEmails(emails: string[]): Promise<UsersByEmailsResult>;
+    /**
+     * Check if the jid/dbId belongs to the connected user
+     * @param userRef - a user jid or user dbId or user jid tel
+     */
+    isConnectedUser(userRef: string): boolean;
+    computeUserColor(displayName: string): {
+        colorIndex: number;
+        color: string;
+        colorName: string;
+    };
+    computeUserAvatar(objId: string | null, initials: string, color: string, size?: number, lastAvatarUpdate?: any): HTMLImageElement | {
+        src: string;
+    } | null;
+    computeUserName(firstName: string, lastName: string): {
+        displayName: string;
+        initials: string;
+    };
+}
+//# sourceMappingURL=user.service.d.ts.map

package/lib/services/users/user.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.service.d.ts","sourceRoot":"","sources":["../../../src/services/users/user.service.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,OAAO,EAAiB,OAAO,EAAmB,MAAM,+BAA+B,CAAC;AACxF,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAGnE,gBAAgB;AAChB,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;;;GAIG;AACH,oBAAY,iBAAiB;IACzB;;MAEE;IACF,eAAe,oBAAoB;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;;;OAKG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,YAAY,CAAC;IAExI;;;;OAIG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;;;;;OAaG;IACH,gBAAgB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;KAAE,CAAC;IAErG;;;;;;;;;;OAUG;IACH,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,GAAG,KAAK,gBAAgB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,GAAG,IAAI,CAAC;IAEhK;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC;CACxG;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,OAAQ,YAAW,WAAW;IAC7D,OAAO,CAAC,SAAS,CAAkF;IACnG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8C;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkD;IAClF,OAAO,CAAC,cAAc,CAAC,CAAM;IAE7B;;QAEI;WACU,WAAW,IAAI,aAAa;WAI5B,KAAK,IAAI,aAAa;IAIpC,OAAO;IAEP,IAAW,aAAa,IAAI,aAAa,CAA4C;IAE9E,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,GAAG,YAAY;IAmBlI,SAAS,CAAC,cAAc,EAAE,GAAG;IAEpC;;;;;OAKG;IACI,SAAS,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,GAAE,GAAU;IAI1D;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAIvD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIvE;;;OAGG;IACI,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIzC,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;KAAE;IAIhG,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,GAAG,GAAG,gBAAgB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,GAAG,IAAI;IAI3J,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE;CAG1G"}

package/lib/services/users/usersLists.service.d.ts

@@ -0,0 +1,239 @@
+/**
+ * @module UsersLists
+ */
+import type { Subscription } from "rxjs";
+import { BehaviorSubject } from "rxjs";
+import { RBEvent } from "../../models/event.model";
+import type { UsersList, UsersListProfile } from "../../models/usersList.model";
+import { UsersListRB } from "../../models/usersList.model";
+import type { Contact } from "../../models/contact.model";
+import { Service } from "../../services/service";
+/** @internal */
+export declare const USERSLISTS_SVC = "UsersListsService";
+/**
+ * @eventProperty
+ * UsersLists service events send to other services
+ * Can listen to it via `UsersListsService.subscribe()` API
+ */
+export declare enum UsersListsServiceEvents {
+    /**
+     * @eventProperty
+     * This `RBEvent` is sent when a new users list has been created.
+     *
+     * **Event Data**
+     * - **data**: The new created users list (as UsersList model)
+     */
+    ON_USERS_LIST_CREATED = "ON_USERS_LIST_CREATED",
+    /**
+     * @eventProperty
+     * This `RBEvent` is sent when the list information (name, description or favorite status) has been modified.
+     *
+     * **Event Data**
+     * - **data**: The updated users list (as UsersList object)
+     */
+    ON_USERS_LIST_PROFILE_UPDATED = "ON_USERS_LIST_PROFILE_UPDATED",
+    /**
+     * @eventProperty
+     * This `RBEvent` is sent when a users list has been deleted.
+     *
+     * **Event Data**
+     * - **data**: The id (as string) of the users list that has been deleted.
+     */
+    ON_USERS_LIST_DELETED = "ON_USERS_LIST_DELETED",
+    /**
+     * @eventProperty
+     * This `RBEvent` is sent when a user has been added to the list.
+     *
+     * **Event Data**
+     * - **user**: The user (as User object) added to the list
+     * - **list**: The users list (as UsersList object) to which the user has been added.
+     */
+    ON_USER_ADDED_TO_LIST = "ON_USER_ADDED_TO_LIST",
+    /**
+     * @eventProperty
+     * This `RBEvent` is sent when a user has been removed from the list.
+     *
+     * **Event Data**
+     * - **userId**: The id (as string) of the user removed from the list.
+     * - **list**: The users list (as UsersList object) to which the user has been added.
+     */
+    ON_USER_REMOVED_FROM_LIST = "ON_USER_REMOVED_FROM_LIST"
+}
+export interface UsersListsService {
+    /**
+     * Subscribe to the users lists updates, all events are of RBEvent<UsersListsServiceEvents>
+     * @param callback - The callback function that will be called when events are received
+     * @param eventNames - (optional) array of event to listen
+     * @returns Returns RxJS Subscription
+     */
+    subscribe: (callback: (event: RBEvent<UsersListsServiceEvents>) => any, eventNames?: UsersListsServiceEvents | UsersListsServiceEvents[]) => Subscription;
+    /**
+     * Get all users lists with all their properties.
+     */
+    getUsersLists: () => UsersList[];
+    /**
+     * Get the data associated with the specified users list.
+     * @param id - The id of the users list
+     */
+    getUsersListById: (id: string) => UsersList;
+    /**
+     * Create a new list of users
+     * Only the name of the users list is mandatory.
+     * The other information (description and favorite status) are optional and can be set afterwards using the 'updateUsersListInfo' method.
+     * A ON_USERS_LIST_CREATED event is sent afterwards at the completion of the operation to notify about the users list creation.
+     * @param profile name - Name of the users list<br/>
+     * description - (optional) A description of the users list. If not specified, set by default to "".<br/>
+     * favorite - (optional) Flag indicating if the users list is marked as "favorite". If not specified, set by default to false.
+     */
+    createUsersList: (profile: UsersListProfile) => Promise<any>;
+    /**
+     * Delete a users list specified either by its reference or by its unique identifier.
+     * A ON_USERS_LIST_DELETED event is sent afterwards at the completion of the operation to notify about the users list deletion.
+     * @param listRef - Reference or identifier of the users list to delete
+     */
+    deleteUsersList: (listRef: string | UsersList) => Promise<any>;
+}
+/**
+ * @internal
+ */
+export declare class UsersListsServiceRB extends Service implements UsersListsService {
+    private portalURL;
+    private xmppManagementHandler;
+    private startInProgress;
+    private authService;
+    private xmppService;
+    private contactService;
+    private errorHelperService;
+    private logger;
+    private rxSubject;
+    serviceReady: BehaviorSubject<boolean>;
+    startupFailed: BehaviorSubject<boolean>;
+    private usersLists;
+    /**
+     * Returns the UsersListRB service singleton
+     */
+    static getInstance(): UsersListsServiceRB;
+    static build(): UsersListsServiceRB;
+    private constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    reconnect(): void;
+    private attachHandlers;
+    private removeHandlers;
+    /**
+     * Subscribe to the users lists updates, all events are of RBEvent<UsersListsServiceEvents>
+     * @param callback - The callback function that will be called when events are received
+     * @param eventNames - (optional) array of event to listen
+     * @returns Returns RxJS Subscription
+     */
+    subscribe(callback: (event: RBEvent<UsersListsServiceEvents>) => any, eventNames?: UsersListsServiceEvents | UsersListsServiceEvents[]): Subscription;
+    /**
+     * UsersList service events send to other services via sendEvent()
+     * Can listen to it via UsersListsServiceRB.subscribe() API
+     * @param name - the name of the event
+     * @param data - the data to be send (an object)
+     */
+    private sendEvent;
+    /**
+     * Management of XMPP management message
+     * @param stanza - The received stanza.
+     */
+    private onUsersListMessageReceived;
+    /**
+     * Get all users lists from the server
+     */
+    private getUsersListsFromServer;
+    /**
+     * Add a users list in cache ('usersLists' data)
+     * @param listId - The id of the list to add in cache
+     * @returns The data associated with the new users list
+     */
+    addListToCache(listId: string): Promise<UsersListRB>;
+    /**
+     * Update a users list from cache ('usersLists' data)
+     * The modification may come from the client who performed the action, or from another connected client (from the same connected user).
+     * @param listId - The id of the list to remove from cache
+     * @param name - Name of the users list
+     * @param description - A description of the users list.
+     * @param isFavorite - Flag indicating if the users list is marked as "favorite".
+     * @returns The data associated with the updated users list
+     */
+    private updateListFomCache;
+    /**
+     * Remove a users list from cache ('usersLists' data)
+     * @param listId - The id of the list to remove from cache
+     */
+    private removeListFomCache;
+    /**
+     * Add a user to the members of a users list in cache ('usersLists' data)
+     * @param userId - The dbId of the user to add to users list
+     * @param listId - The id of the users list to which the user must be added
+     */
+    private addUserToCache;
+    /**
+     * Remove a user from the members of a users list in cache  ('usersLists' data)
+     * @param userId - The dbId of the user to remove from the list
+     * @param listId - The id of the users list in which the user must be removed
+     */
+    private removeUserFromCache;
+    /**
+     * Log main infos for all retrieved users lists: list + members names
+     * @param lists - The users lists internal cache
+     */
+    private logUsersLists;
+    /**
+     * Create a new list of users
+     * Only the name of the users list is mandatory.
+     * The other information (description and favorite status) are optional and can be set afterwards using the 'updateUsersListInfo' method.
+     * A ON_USERS_LIST_CREATED event is sent afterwards at the completion of the operation to notify about the users list creation.
+     * @param profile - Profile (general information) of the users list
+     */
+    createUsersList(profile: UsersListProfile): Promise<any>;
+    /**
+     * Delete a users list specified either by its reference or by its unique identifier.
+     * A ON_USERS_LIST_DELETED event is sent afterwards at the completion of the operation to notify about the users list deletion.
+     * @param listRef  - Reference or identifier of the users list to delete
+     */
+    deleteUsersList(listRef: string | UsersList): Promise<any>;
+    /**
+     * Update the general information associated with the users list
+     * Only the general information, i.e. the name, the description and the favorite status can be updated using this method.
+     * Users are added to or removed from the list using methods 'addUserToList' and 'removeUserFromList' respectively.
+     * A ON_USERS_LIST_PROFILE_UPDATED event is sent afterwards at the completion of the operation to notify about the users list update.
+     * @param list - The users list with the general information to be updated
+     */
+    updateUsersListInfo(list: UsersList): Promise<any>;
+    /**
+     * Add a user in a users list.
+     * A ON_USER_ADDED_TO_LIST event is sent afterwards at the completion of the operation to notify about adding the user to the list.
+     * @param user - The user to add to users list
+     * @param list - The users list to which the user is to be added
+     */
+    addUserToList(user: Contact, list: UsersList): Promise<void>;
+    /**
+     * Remove a user from a users list.
+     * A ON_USER_REMOVED_FROM_LIST event is sent afterwards at the completion of the operation to notify about removing a user from the list.
+     * @param user - Reference of the user to remove from the list
+     * @param list - The users list from which the user is to be removed
+     */
+    removeUserFromList(user: Contact, list: UsersList): Promise<any>;
+    /**
+     * Get all users lists data with their data
+     */
+    getUsersLists(): UsersList[];
+    /**
+     * @public
+     * Get the data associated with a specifid users list.
+     * @param id - The unique identifier of the users list
+     * @returns The data associated with a users list
+     */
+    getUsersListById(id: string): UsersList;
+    /**
+     * @public
+     * Get the data associated with a specifid users list.
+     * @param criteria - The criteria to find from usersList.name
+     * @returns The data associated with the found users list
+     */
+    searchUsersListByName(criteria: string): UsersListRB[];
+}
+//# sourceMappingURL=usersLists.service.d.ts.map

package/lib/services/users/usersLists.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usersLists.service.d.ts","sourceRoot":"","sources":["../../../src/services/users/usersLists.service.ts"],"names":[],"mappings":"AAEA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,eAAe,EAAmB,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAOzE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAIhE,gBAAgB;AAChB,eAAO,MAAM,cAAc,sBAAsB,CAAC;AAElD;;;;GAIG;AACH,oBAAY,uBAAuB;IAE/B;;;;;;OAMG;IACH,qBAAqB,0BAA0B;IAE/C;;;;;;OAMG;IACH,6BAA6B,kCAAkC;IAE/D;;;;;;OAMG;IACH,qBAAqB,0BAA0B;IAE/C;;;;;;;OAOG;IACH,qBAAqB,0BAA0B;IAE/C;;;;;;;OAOG;IACH,yBAAyB,8BAA8B;CAC1D;AAED,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,uBAAuB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,KAAK,YAAY,CAAC;IAE1J;;OAEG;IACH,aAAa,EAAE,MAAM,SAAS,EAAE,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,SAAS,CAAC;IAE5C;;;;;;;;OAQG;IACH,eAAe,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAE7D;;;;OAIG;IACH,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAClE;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,OAAQ,YAAW,iBAAiB;IACzE,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,eAAe,CAAkB;IAGzC,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,MAAM,CAA8C;IAG5D,OAAO,CAAC,SAAS,CAAoC;IAG9C,YAAY,2BAAuC;IAKnD,aAAa,2BAAuC;IAI3D,OAAO,CAAC,UAAU,CAAmB;IAErC;;OAEG;WACW,WAAW,IAAI,mBAAmB;WAIlC,KAAK,IAAI,mBAAmB;IAI1C,OAAO;IAOM,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoCtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,SAAS,IAAI,IAAI;IAMxB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,cAAc;IAStB;;;;;OAKG;IACI,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,uBAAuB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,GAAG,YAAY;IAkB5J;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAQjB;;;OAGG;YACW,0BAA0B;IAmFxC;;OAEG;YACW,uBAAuB;IA2CrC;;;;OAIG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAmEjE;;;;;;;;OAQG;YACW,kBAAkB;IAoBhC;;;OAGG;YACW,kBAAkB;IAWhC;;;;OAIG;YACW,cAAc;IAyB5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;OAGG;IACH,OAAO,CAAC,aAAa;IA6BrB;;;;;;OAMG;IACU,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IA6BrE;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BvE;;;;;;OAMG;IACU,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IA4B/D;;;;;OAKG;IACU,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmCzE;;;;;OAKG;IACU,kBAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IA8B7E;;OAEG;IACI,aAAa,IAAI,SAAS,EAAE;IAInC;;;;;OAKG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAM9C;;;;;OAKG;IACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;CAkBhE"}

package/lib/services/utilities/browserDatabase.service.d.ts

@@ -0,0 +1,69 @@
+import { Service } from "../service";
+export declare const BROWSER_DB_SVC = "BrowserDatabaseService";
+export interface DbStoreType {
+}
+interface UpgradeHandler {
+    version: number;
+    upgrade: (db: IDBDatabase, transaction: IDBTransaction, oldVersion: number) => void | Promise<void>;
+    rollback?: (db: IDBDatabase, transaction: IDBTransaction, targetVersion: number) => void | Promise<void>;
+    description?: string;
+}
+export interface DatabaseConfig {
+    /**
+     * Name of the database
+     */
+    name: string;
+    /**
+     * Version of the database
+     */
+    version: number;
+    /**
+     * Upgrades that will be applied to the database (like migrations)
+     */
+    upgrades: UpgradeHandler[];
+    onVersionChange?: (event: IDBVersionChangeEvent) => void;
+    onBlocked?: (event: Event) => void;
+}
+declare class DatabaseTransaction {
+    private transaction;
+    private _completed;
+    constructor(transaction: IDBTransaction);
+    private checkActive;
+    get<K extends keyof DbStoreType, T extends DbStoreType[K]>(storeName: K, key: IDBValidKey): Promise<T | undefined>;
+    put<K extends keyof DbStoreType>(storeName: K, value: DbStoreType[K], key?: IDBValidKey): Promise<IDBValidKey>;
+    delete(storeName: keyof DbStoreType, key: IDBValidKey): Promise<void>;
+    getAll<StoreName extends keyof DbStoreType, T extends DbStoreType[StoreName]>(storeName: StoreName): Promise<T[]>;
+    waitForCompletion(): Promise<void>;
+    abort(): void;
+}
+export declare class IndexedDBDatabase {
+    private config;
+    private loggerService;
+    private db;
+    constructor(config: DatabaseConfig);
+    /**
+     * Open an IndexDB database
+     *
+     * @returns
+     */
+    open(): Promise<void>;
+    isOpen(): boolean;
+    createTransaction(mode: IDBTransactionMode, storeNames: (keyof DbStoreType)[]): DatabaseTransaction;
+    runTransaction<T>(mode: IDBTransactionMode, storeNames: (keyof DbStoreType)[], operation: (tx: DatabaseTransaction) => Promise<T>): Promise<T>;
+    close(): void;
+}
+export declare class BrowserDatabaseService extends Service {
+    static getInstance(): BrowserDatabaseService;
+    static build(): BrowserDatabaseService;
+    private instances;
+    /**
+     * Create a new {@link IndexedDBDatabase} instance
+     *
+     * @param config - Database config object
+     * @returns database instance
+     */
+    createDbInstance(config: DatabaseConfig): IndexedDBDatabase;
+    deleteDatabase(name: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=browserDatabase.service.d.ts.map

package/lib/services/utilities/browserDatabase.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserDatabase.service.d.ts","sourceRoot":"","sources":["../../../src/services/utilities/browserDatabase.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,eAAO,MAAM,cAAc,2BAA2B,CAAC;AAEvD,MAAM,WAAW,WAAW;CAAG;AAE/B,UAAU,cAAc;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpG,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzG,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACzD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACtC;AASD,cAAM,mBAAmB;IAGT,OAAO,CAAC,WAAW;IAF/B,OAAO,CAAC,UAAU,CAAS;gBAEP,WAAW,EAAE,cAAc;IAE/C,OAAO,CAAC,WAAW;IAMb,GAAG,CAAC,CAAC,SAAS,MAAM,WAAW,EAAE,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EAC3D,SAAS,EAAE,CAAC,EACZ,GAAG,EAAE,WAAW,GACjB,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAMnB,GAAG,CAAC,CAAC,SAAS,MAAM,WAAW,EACjC,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,GAAG,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,WAAW,CAAC;IAMjB,MAAM,CAAC,SAAS,EAAE,MAAM,WAAW,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrE,MAAM,CAAC,SAAS,SAAS,MAAM,WAAW,EAAE,CAAC,SAAS,WAAW,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAKjH,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAaxC,KAAK,IAAI,IAAI;CAGhB;AAED,qBAAa,iBAAiB;IAId,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,aAAa,CAA8C;IACnE,OAAO,CAAC,EAAE,CAA0B;gBAEhB,MAAM,EAAE,cAAc;IAE1C;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgEpB,MAAM,IAAI,OAAO;IAQxB,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE,GAAG,mBAAmB;IAQ7F,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAepJ,KAAK,IAAI,IAAI;CAShB;AAED,qBAAa,sBAAuB,SAAQ,OAAO;WACjC,WAAW;WACX,KAAK;IAEnB,OAAO,CAAC,SAAS,CAAwC;IAEzD;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB;IAYrD,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAepD"}

package/lib/services/utilities/errorHelper.service.d.ts

@@ -0,0 +1,24 @@
+import { Service } from "../../services/service";
+export declare const ERROR_HELPER_SVC = "ErrorHelperService";
+export declare class ErrorHelperInfo {
+    message: string;
+    error: any;
+}
+export declare class ErrorHelperService extends Service {
+    static ERROR_CODE_LABELS: Record<string, string>;
+    static PORTAL_ERROR_CODE_LABELS: Record<string, Record<string, string>>;
+    private i18n;
+    static getInstance(): ErrorHelperService;
+    static build(): ErrorHelperService;
+    protected constructor();
+    getErrorInfo(error: any, context?: string, params?: any): Promise<ErrorHelperInfo>;
+    private getTranslatedErrorMessage;
+    getLocalizedError(errorCode: string, params: any, portal: string): string;
+    private getErrorText;
+    private getTextWithoutIds;
+    private getFeature;
+    private getStatusText;
+    private getBadRequestFieldErrors;
+    getErrorCodeLabel(errorCode: string, portal?: string): string;
+}
+//# sourceMappingURL=errorHelper.service.d.ts.map

package/lib/services/utilities/errorHelper.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorHelper.service.d.ts","sourceRoot":"","sources":["../../../src/services/utilities/errorHelper.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAEhE,eAAO,MAAM,gBAAgB,uBAAuB,CAAC;AAErD,qBAAa,eAAe;IACjB,OAAO,EAAE,MAAM,CAAM;IACrB,KAAK,EAAE,GAAG,CAAQ;CAC5B;AAED,qBAAa,kBAAmB,SAAQ,OAAO;IAC3C,OAAc,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAoNrD;IAEF,OAAc,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAsJ5E;IAEF,OAAO,CAAC,IAAI,CAA0C;WAExC,WAAW;WAIX,KAAK;IAInB,SAAS;IAII,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,GAAE,MAAa,EAAE,MAAM,GAAE,GAAU;IA2DhF,OAAO,CAAC,yBAAyB;IAsB1B,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAUhF,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,wBAAwB;IAwCzB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;CAOvE"}

package/lib/services/utilities/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./errorHelper.service";
+export * from "./utilities.service";
+export * from "./browserDatabase.service";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/utilities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/utilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC"}

package/lib/services/utilities/utilities.service.d.ts

@@ -0,0 +1,74 @@
+import { Service } from "../../services/service";
+/** @internal */
+export declare const UTILITIES_SVC = "UtilitiesService";
+export declare class UtilitiesService extends Service {
+    /**
+     * @internal
+     * */
+    static getInstance(): UtilitiesService;
+    /**
+     * @internal
+     * */
+    static build(): UtilitiesService;
+    private rtlDirCheck;
+    private usableRandomChars;
+    private constructor();
+    /**
+     * @internal
+     * */
+    asyncForEach<T>(array: T[], callback: (item: T, index: number, array: T[]) => Promise<void>): Promise<void>;
+    /**
+     * @internal
+     * */
+    isRTL(str: string): boolean;
+    /**
+     * @internal
+     * */
+    randomString(length?: number): string;
+    /**
+     * @internal
+     * */
+    getUUID(): string;
+    /**
+     * @internal
+     * */
+    addUrlParameter(url: string, urlParameter: any): string;
+    /**
+     * @internal
+     * */
+    isNumeric(str: any): boolean;
+    /**
+     * @internal
+     * */
+    asyncTimeout(ms: number): Promise<unknown>;
+    /**
+     * @internal
+     * */
+    selectRandomly(possibilities: any[]): any;
+    /**
+     * @internal
+     * */
+    arrayMove(arr: any[], oldIndex: number, newIndex: number): void;
+    /**
+     * @internal
+     * */
+    removeSpecialChars(initialStr: string): string;
+    getBase64Image(url: string): Promise<string>;
+    /**
+     * Method checks for validity of an API Url for security reasons
+     * @param environmentApiUrl - url to check
+     * @returns true if environment is valid, false otherwise
+     */
+    checkEnvironmentApiUrl(environmentApiUrl: string): Promise<boolean>;
+}
+export declare function asyncForEach(array: any[], callback: any): Promise<void>;
+export declare function roundTo(value: number, decimals?: number): number;
+/**
+ * Computes the MD5 hash of a given value encoded in Latin-1.
+ * The input is first parsed using Latin-1 encoding before hashing,
+ * and the result is returned as a hexadecimal string.
+ * @param date - The value to hash (typically a string or date-like value)
+ * @returns The MD5 hash as a lowercase hexadecimal string
+ */
+export declare function MD5(date: any): string;
+//# sourceMappingURL=utilities.service.d.ts.map

package/lib/services/utilities/utilities.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.service.d.ts","sourceRoot":"","sources":["../../../src/services/utilities/utilities.service.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAGhE,gBAAgB;AAChB,eAAO,MAAM,aAAa,qBAAqB,CAAC;AAEhD,qBAAa,gBAAiB,SAAQ,OAAO;IACzC;;SAEK;WACS,WAAW;IAIzB;;SAEK;WACS,KAAK;IAInB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO;IAOP;;SAEK;IACQ,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxH;;SAEK;IACE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIlC;;SAEK;IACE,YAAY,CAAC,MAAM,GAAE,MAAW,GAAG,MAAM;IAWhD;;SAEK;IACE,OAAO,IAAI,MAAM;IAIxB;;SAEK;IACE,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,KAAA;IAShD;;SAEK;IACE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO;IAOnC;;SAEK;IACE,YAAY,CAAC,EAAE,EAAE,MAAM;IAI9B;;SAEK;IACE,cAAc,CAAC,aAAa,EAAE,GAAG,EAAE;IAK1C;;SAEK;IACE,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAgB/D;;SAEK;IACE,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAIxC,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBzD;;;;OAIG;IACU,sBAAsB,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAgBnF;AAED,wBAAsB,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,iBAI7D;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,CAErC"}