@arsedizioni/ars-utils 21.2.203 → 21.2.205

package/fesm2022/arsedizioni-ars-utils-clipper.common.mjs

@@ -1,8 +1,9 @@
 import * as i0 from '@angular/core';
-import { signal, computed, inject, Injectable, NgModule } from '@angular/core';
+import { signal, computed, inject, DestroyRef, Injectable, NgModule } from '@angular/core';
 import { BroadcastService, SystemUtils } from '@arsedizioni/ars-utils/core';
 import { EMPTY, throwError, of, catchError as catchError$1 } from 'rxjs';
 import { HttpClient, HttpHeaders, HttpRequest } from '@angular/common/http';
+import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { DialogService } from '@arsedizioni/ars-utils/ui';
 import { catchError, finalize, map } from 'rxjs/operators';
 
@@ -2198,8 +2199,10 @@ const PropertiesColors = [{ name: "Verde", value: "#2E8B74" },
 class ClipperService {
     constructor() {
         this.httpClient = inject(HttpClient);
+        this.destroyRef = inject(DestroyRef);
         this.broadcastService = inject(BroadcastService);
         this.dialogService = inject(DialogService);
+        this.broadcastInitialized = false;
         this._serviceUri = '';
         this._flags = ClipperServiceFlags.None;
         this.loggedIn = signal(sessionStorage.getItem("clipper_oauth_token") !== null, ...(ngDevMode ? [{ debugName: "loggedIn" }] : /* istanbul ignore next */ []));
@@ -2209,9 +2212,7 @@ class ClipperService {
         this.referencesSnapshot = signal(undefined, ...(ngDevMode ? [{ debugName: "referencesSnapshot" }] : /* istanbul ignore next */ []));
         this.dashboard = new ClipperDashboard();
         this.bag = signal([], ...(ngDevMode ? [{ debugName: "bag" }] : /* istanbul ignore next */ []));
-        this.bagTotal = computed(() => {
-            return this.bag().length;
-        }, ...(ngDevMode ? [{ debugName: "bagTotal" }] : /* istanbul ignore next */ []));
+        this.bagTotal = computed(() => this.bag().length, ...(ngDevMode ? [{ debugName: "bagTotal" }] : /* istanbul ignore next */ []));
         this.visible = signal(false, ...(ngDevMode ? [{ debugName: "visible" }] : /* istanbul ignore next */ []));
         this._teams = [];
         this.currentTeamId = signal(SystemUtils.emptyUUID(), ...(ngDevMode ? [{ debugName: "currentTeamId" }] : /* istanbul ignore next */ []));
@@ -2249,16 +2250,11 @@ class ClipperService {
     get teams() {
         return this._teams;
     }
-    ngOnDestroy() {
-        if (this.broadcastServiceSubscription) {
-            this.broadcastServiceSubscription.unsubscribe();
-        }
-    }
     /**
-     * Initialize service
-     * @param serviceUri : the service uri
-     * @param appUri : the clipper application uri
-     * @param flags: the service flags. Default is none.
+     * Initialises the service with the API base URI, optional app URI, and feature flags.
+     * @param serviceUri - The base URI of the Clipper REST API.
+     * @param appUri - Optional URI of the Clipper web application (used to build document links).
+     * @param flags - Feature flags that control service behaviour. Defaults to `ClipperServiceFlags.None`.
      */
     initialize(serviceUri, appUri, flags = ClipperServiceFlags.None) {
         // Create unique client and machine  id
@@ -2272,11 +2268,13 @@ class ClipperService {
         this._appUri = appUri;
         this._flags = flags;
         // React to message broadcasting
-        if (!this.broadcastServiceSubscription) {
-            this.broadcastServiceSubscription = this.broadcastService.getMessage()
+        if (!this.broadcastInitialized) {
+            this.broadcastInitialized = true;
+            this.broadcastService.getMessage()
+                .pipe(takeUntilDestroyed(this.destroyRef))
                 .subscribe(message => {
                 if (message.id === ClipperMessages.LOGIN_CHANGED) {
-                    this.login(null, null, true, message.data?.oauth ?? null, message.data?.oauthAccessToken ?? null).subscribe({
+                    this.login(undefined, undefined, true, message.data?.oauth ?? undefined, message.data?.oauthAccessToken ?? undefined).subscribe({
                         next: r => {
                             if (!r.success) {
                                 if ((this.flags & ClipperServiceFlags.DisplayConnectionStateMessages) > 0) {
@@ -2337,15 +2335,15 @@ class ClipperService {
             .subscribe();
     }
     /**
-     * Store context
+     * Persists the current login context to `localStorage`.
      */
     storeContext() {
         localStorage.setItem('clipper_context', JSON.stringify(this._loginInfo));
     }
     /**
-  * Update context
-  * @param result: the new context
-  */
+     * Updates the stored login context with the values from a fresh login result.
+     * @param result - The login result containing the new user context and channel settings.
+     */
     updateContext(result) {
         if (!this._loginInfo) {
             this._loginInfo = { context: undefined };
@@ -2355,11 +2353,11 @@ class ClipperService {
         this.storeContext();
     }
     /**
-    * Perform auto login using current link data
-    * @param onSuccess: function to execute on seccess
-    */
+     * Attempts an automatic login using the credentials currently stored in session storage.
+     * @param onSuccess - Optional callback invoked with the login result value on success.
+     */
     autoLogin(onSuccess) {
-        this.login(null, null, true)
+        this.login(undefined, undefined, true)
             .pipe(finalize(() => this.dialogService.clearBusy()))
             .subscribe({
             next: r => {
@@ -2379,8 +2377,8 @@ class ClipperService {
         });
     }
     /**
-     * Perform auto logout
-     * @param onSuccess: function to execute on success
+     * Performs an automatic logout and clears the stored session.
+     * @param onSuccess - Optional callback invoked after a successful logout.
      */
     autoLogout(onSuccess) {
         this.logout()
@@ -2406,12 +2404,13 @@ class ClipperService {
         });
     }
     /**
-     * Perform login
-     * @param email: the optioanl email if using OAuth2
-     * @parma password: the optional password if using OAuth2
-     * @param remember: remember credentials
-     * @param oauth: the optional open authentication supported
-     * @param oauthAccessToken: the optional OAuth2 access token
+     * Authenticates the user against the Clipper API, supporting both credential-based and
+     * OAuth2 login flows.
+     * @param email - The user's email address (credential login only).
+     * @param password - The user's password (credential login only).
+     * @param remember - When `true`, the session is remembered across browser restarts.
+     * @param oauth - The OAuth2 provider type, when authenticating via SSO.
+     * @param oauthAccessToken - The OAuth2 bearer token. Defaults to the value stored in session storage.
      */
     login(email, password, remember, oauth, oauthAccessToken = sessionStorage.getItem("clipper_oauth_token") ?? undefined) {
         return this.httpClient
@@ -2448,8 +2447,9 @@ class ClipperService {
         }));
     }
     /**
-     * Complete login
-     * @param result : the login result
+     * Finalises the login flow by updating the stored context, setting the logged-in signal,
+     * initialising channels, and broadcasting `LOGIN_COMPLETED`.
+     * @param result - The login result returned by the API.
      */
     completeLogin(result) {
         // Update context info            
@@ -2462,8 +2462,8 @@ class ClipperService {
         this.broadcastService.sendMessage(ClipperMessages.LOGIN_COMPLETED);
     }
     /**
-     * Confirm MFA procedure
-     * @param code: the confirm code
+     * Submits the MFA confirmation code to complete a two-factor login flow.
+     * @param code - The one-time confirmation code provided to the user.
      */
     confirmIdentity(code) {
         return this.httpClient
@@ -2478,8 +2478,8 @@ class ClipperService {
         }));
     }
     /**
-     * Perform logout
-     * @param forget: true to dispose all user informations
+     * Logs the user out and clears the current session.
+     * @param forget - When `true`, all stored user credentials are also removed.
      */
     logout(forget = false) {
         return this.httpClient.post(this._serviceUri + '/logout/?forget=' + forget, {})
@@ -2492,8 +2492,8 @@ class ClipperService {
         }));
     }
     /**
-    * Reset login refresh timer and login state
-    */
+     * Resets the login state, clears the stored login info, and broadcasts `LOGOUT_COMPLETED`.
+     */
     reset() {
         // Clear login info
         this._loginInfo = undefined;
@@ -2505,8 +2505,8 @@ class ClipperService {
         this.broadcastService.sendMessage(ClipperMessages.LOGOUT_COMPLETED);
     }
     /**
-     * Clear login data
-     * @param clearOAuthToken: true to clear oauth token also
+     * Clears all session-storage authentication keys and resets the login state.
+     * @param clearOAuthToken - When `true`, the OAuth bearer token is also removed.
      */
     clear(clearOAuthToken = false) {
         // Clear local storage
@@ -2519,8 +2519,9 @@ class ClipperService {
         this.reset();
     }
     /**
-     * Update channel state
-     * @param value : the new dashboard result with updated channels and dashboard info
+     * Applies a new dashboard result: updates channel settings, dashboard counters, and
+     * re-initialises the available-channels signal.
+     * @param value - The dashboard result containing updated channel and counter data.
      */
     setChannelsState(value) {
         // Update channels
@@ -2538,8 +2539,8 @@ class ClipperService {
         this.initializeChannels();
     }
     /**
-     * Update channels
-     * @param channels: the new channels settings
+     * Replaces the stored channel settings and re-initialises the available-channels signal.
+     * @param channels - The new channel settings to store and activate.
      */
     setChannels(channels) {
         if (this._loginInfo) {
@@ -2549,13 +2550,13 @@ class ClipperService {
         }
     }
     /**
-   * Initialize channels
-   */
+     * Rebuilds the `availableChannels` signal from the current login context.
+     */
     initializeChannels() {
         if (this.loginInfo) {
-            let channels = [];
+            const channels = [];
             this.loginInfo.channels?.forEach(n => {
-                const channelSubscription = this.loginInfo.context.channels.find(x => x.channel === n.channelId);
+                const channelSubscription = this.loginInfo?.context?.channels?.find(x => x.channel === n.channelId);
                 n.isSuspended = channelSubscription?.isSuspended === true;
                 const channel = ClipperChannels.find(x => x.value === n.channelId);
                 if (channel) {
@@ -2569,8 +2570,8 @@ class ClipperService {
         }
     }
     /**
-     * Update channels
-     * @param values : the new channel values
+     * Toggles the active state of available channels based on the supplied selection list.
+     * @param values - The selected channel items; channels absent from this list are deactivated.
      */
     updateChannels(values) {
         this.availableChannels().forEach(channel => {
@@ -2578,12 +2579,11 @@ class ClipperService {
                 channel.active = values?.findIndex(x => x.value === channel.value) !== -1;
             }
         });
-        this.availableChannels.update(values => [...values]);
     }
     /**
-    * Get a new one time password
-    * @param id: the optional repository id
-    */
+     * Requests a new one-time password for the given repository.
+     * @param id - The repository ID for which the OTP should be generated.
+     */
     newOTP(id) {
         return this.httpClient.get(this._serviceUri + '/otp/new/?id=' + id);
     }
@@ -2629,6 +2629,10 @@ class ClipperService {
     sendTo(params) {
         return this.httpClient.post(this._serviceUri + '/documents/send', params);
     }
+    /**
+     * Sends an email notification about a document property update to the specified recipients.
+     * @param params - The notification parameters including recipients and property details.
+     */
     notifyPropertyTo(params) {
         return this.httpClient.post(this._serviceUri + '/documents/properties/notify', params);
     }
@@ -2763,18 +2767,18 @@ class ClipperService {
         });
     }
     /**
-   * Retrieve last 15 days
-   * @param params : the query params
-   */
+     * Retrieves documents updated in the last 15 days for the given search parameters.
+     * @param params - The search parameters to filter results.
+     */
     last15Days(params) {
         return this.httpClient.post(this._serviceUri + '/account/last-15-days', params);
     }
     /**
-    * Update unread items
-    * @param module : the module
-    * @param model : the optional model
-    * @param increment : the increment (can be negative)
-    */
+     * Adjusts the unread-item counter for the given module and broadcasts a dashboard update.
+     * @param module - The Clipper module whose counter should be adjusted.
+     * @param model - Optional document model to further scope the counter update.
+     * @param increment - The signed increment to apply (use negative values to decrement).
+     */
     updateUnreadItems(module, model, increment) {
         increment ??= 0;
         if (increment !== 0) {
@@ -2818,8 +2822,8 @@ class ClipperService {
         });
     }
     /**
-     * Add one or more working document
-     * @param documentIds : the document ids to add
+     * Adds one or more documents to the working documents bag.
+     * @param documentIds - The IDs of the documents to add.
      */
     addToBag(documentIds) {
         return this.httpClient
@@ -2852,8 +2856,8 @@ class ClipperService {
         });
     }
     /**
-     * Remove one working document
-     * @param documentId : the document id
+     * Removes a document from the working documents bag.
+     * @param documentId - The ID of the document to remove.
      */
     removeFromBag(documentId) {
         return this.httpClient
@@ -2894,24 +2898,24 @@ class ClipperService {
     // WORKING SEARCHES
     ///
     /**
-     * Load working searches
-     * @param: module: the module to load searches for
+     * Retrieves the saved searches for the given module.
+     * @param module - The Clipper module whose saved searches to load.
      */
     loadSearches(module) {
         return this.httpClient
             .get(this.serviceUri + '/documents/searches/?module=' + module);
     }
     /**
-     * Save a working search
-     * @param params : the clipper user search
+     * Persists a user search configuration on the server.
+     * @param params - The search configuration to save.
      */
     saveSearch(params) {
         return this.httpClient
             .post(this.serviceUri + '/documents/searches/save', params);
     }
     /**
-     * Remove one working search
-     * @param id : the id to remove
+     * Deletes a saved search by its ID.
+     * @param id - The ID of the saved search to remove.
      */
     deleteSearch(id) {
         return this.httpClient
@@ -2940,43 +2944,43 @@ class ClipperService {
         return this.httpClient.post(this._serviceUri + '/calendar/snapshot', params);
     }
     /**
-     * Delete one or more items
-     * @param ids: ids to delete
+     * Deletes one or more calendar deadlines by ID.
+     * @param ids - The IDs of the deadlines to delete.
      */
     deleteCalendarDeadlines(ids) {
         return this.httpClient.post(this._serviceUri + '/calendar/delete', { ids: ids });
     }
     /**
-     * Copy one or more items
-     * @param params parameters
+     * Copies one or more calendar deadlines using the given parameters.
+     * @param params - The copy operation parameters.
      */
     copyCalendarDeadlines(params) {
         return this.httpClient.post(this._serviceUri + '/calendar/copy', params);
     }
     /**
-     * Close a deadline
-     * @param id : the id to close
+     * Marks the given calendar deadline as closed.
+     * @param id - The ID of the deadline to close.
      */
     closeCalendarDeadline(id) {
         return this.httpClient.post(this._serviceUri + '/calendar/close', { id: id });
     }
     /**
-     * Save an item
-     * @param params parameters
+     * Creates or updates a calendar deadline.
+     * @param params - The deadline data to save.
      */
     saveCalendarDeadline(params) {
         return this.httpClient.post(this._serviceUri + '/calendar/save', params);
     }
     /**
-     * Retrive a n item
-     * @param id : the item id
+     * Retrieves a single calendar deadline by its ID.
+     * @param id - The ID of the deadline to retrieve.
      */
     getCalendarDeadline(id) {
         return this.httpClient.get(this._serviceUri + '/calendar/' + id);
     }
     /**
-     * Export to iCalendar format
-     * @param ids : deadlines to export
+     * Exports the selected deadlines in iCalendar (.ics) format.
+     * @param ids - The IDs of the deadlines to export.
      */
     exportCalendarDeadlines(ids) {
         return this.httpClient.post(this._serviceUri + '/calendar/export', { ids: ids }, {
@@ -2987,9 +2991,9 @@ class ClipperService {
     // ARCHIVE
     ///
     /**
-    * Retrieve all folders
-    * @param params : parameters
-    */
+     * Retrieves all archive folders matching the given search parameters.
+     * @param params - The folder search parameters.
+     */
     getArchiveFolders(params) {
         return this.httpClient
             .post(this._serviceUri + '/archive/folders', params)
@@ -2999,20 +3003,19 @@ class ClipperService {
                 this._teams = r.value.teams;
             }
             return r;
-            return r;
         }));
     }
     /**
-     * Save folder
-     * @param params : parameters
+     * Creates or updates an archive folder.
+     * @param params - The folder data to save.
      */
     saveArchiveFolder(params) {
         return this.httpClient.post(this._serviceUri + '/archive/folders/save', params);
     }
     /**
-     * Export folders
-     * @param id: the folder id or undefined to export all folders
-     * @param teamId: the optional team id. Default undefined (personal)
+     * Exports archive folders as a downloadable file.
+     * @param id - The folder ID to export, or `undefined` to export all folders.
+     * @param teamId - The optional team ID. Defaults to `undefined` (personal workspace).
      */
     exportArchiveFolders(id, teamId) {
         let url = this._serviceUri + '/archive/export/?';
@@ -3033,8 +3036,8 @@ class ClipperService {
         });
     }
     /**
-     * Import folders
-     * @param params : parameters
+     * Uploads and imports archive folders from a file.
+     * @param params - The import parameters including the source file and destination folder.
      */
     importArchiveFolders(params) {
         // Prepare form
@@ -3052,33 +3055,33 @@ class ClipperService {
         return this.httpClient.request(new HttpRequest('POST', this._serviceUri + '/archive/import/', formData, { reportProgress: true }));
     }
     /**
-     * Get files and folders
-     * @param params : parameters
+     * Retrieves archive files and folders matching the given search parameters.
+     * @param params - The archive files search parameters.
      */
     queryArchiveItems(params) {
         return this.httpClient.post(this._serviceUri + '/archive/files', params);
     }
     /**
-     * Delete file and folders
-     * @param params parameters
+     * Deletes one or more archive files or folders.
+     * @param params - The delete operation parameters.
      */
     deleteArchiveItems(params) {
         return this.httpClient.post(this._serviceUri + '/archive/files/delete', params);
     }
     /**
-     * Copy  file and folders to another folder or the same
-     * @param params parameters
+     * Copies archive files or folders to a destination folder.
+     * @param params - The copy operation parameters.
      */
     copyArchiveItems(params) {
         return this.httpClient.post(this._serviceUri + '/archive/files/copy', params);
     }
     /**
-     * Save a file
-     * @param params : parameters
+     * Uploads and saves an archive file using multipart form data.
+     * @param params - The file metadata and binary content to save.
      */
     saveArchiveFile(params) {
         // Prepare form
-        let formData = new FormData();
+        const formData = new FormData();
         if (params.file)
             formData.append(params.file.file.name, params.file.file);
         if (params.id)
@@ -3121,16 +3124,16 @@ class ClipperService {
         return this.httpClient.request(new HttpRequest('POST', this._serviceUri + '/archive/files/save', formData, { reportProgress: true }));
     }
     /**
-     * Get file data
-     * @param id : the item id
+     * Retrieves the metadata for a single archive file.
+     * @param id - The ID of the archive file to retrieve.
      */
     getArchiveFile(id) {
         return this.httpClient.get(this._serviceUri + '/archive/files/' + id);
     }
     /**
-     * Download file
-     * @param id : the binary id to download
-     * @param otp : the optional one time password
+     * Downloads the binary content of an archive file.
+     * @param id - The binary ID of the file to download.
+     * @param otp - An optional one-time password for authenticated downloads.
      */
     downloadArchiveFile(id, otp) {
         return this.httpClient.get(this._serviceUri + '/archive/files/download/?id=' + id + '&otp=' + (otp ?? ''), { responseType: 'blob' });
@@ -3139,22 +3142,22 @@ class ClipperService {
     // ACCOUNT AND SETTINGS
     ///
     /**
-   * Reset a user password
-   * @param params parameters
-   */
+     * Resets the user's password using the provided parameters.
+     * @param params - The new password and confirmation data.
+     */
     resetPassword(params) {
         return this.httpClient.post(this._serviceUri + '/account/password/reset', params);
     }
     /**
-     * Recover password
-     * @param params parameters
+     * Initiates a password recovery flow by sending a reset link to the user's email.
+     * @param params - The password recovery request data.
      */
     recoverPassword(params) {
         return this.httpClient.post(this._serviceUri + '/account/password/recover', params);
     }
     /**
-     * Update settings
-       * @param params parameters
+     * Updates user account settings and applies any channel configuration changes.
+     * @param params - A map of settings key-value pairs to update.
      */
     updateSettings(params) {
         return this.httpClient.post(this._serviceUri + '/account/settings/update', params).pipe(map(r => {
@@ -3167,8 +3170,8 @@ class ClipperService {
         }));
     }
     /**
-     * Update channel state
-     * @param id: the channel id (1, 2, 3, 4)
+     * Saves updated channel activation states to the server and applies the new dashboard result.
+     * @param params - The channel state update parameters.
      */
     updateChannelsState(params) {
         return this.httpClient.post(this._serviceUri + '/account/settings/channels/update', params).pipe(map(r => {
@@ -3188,7 +3191,7 @@ class ClipperService {
         return this.httpClient.get(this._serviceUri + '/account/trial');
     }
     /**
-     * Update trial info
+     * Refreshes the trial status from the server and updates the stored login context.
      */
     updateTrialInfo() {
         if (!this._loginInfo || this._loginInfo?.context?.hasTrial === false)
@@ -3212,15 +3215,15 @@ class ClipperService {
     // LINKS
     ///
     /**
-    * Save a user link
-    * @param item: the user link
-    */
+     * Creates or updates a user link record.
+     * @param item - The user link data to save.
+     */
     saveLink(item) {
         return this.httpClient.post(this._serviceUri + '/account/links/save', item);
     }
     /**
-     * Delete a user link
-     * @param item: the user link
+     * Deletes a user link record.
+     * @param item - The user link to remove.
      */
     deleteLink(item) {
         return this.httpClient.post(this._serviceUri + '/account/links/delete', item);
@@ -3229,14 +3232,15 @@ class ClipperService {
     // TEAMS
     ///
     /**
-    * Rename a team
-    * @param newName : the new name
-    */
+     * Renames the current user's team.
+     * @param newName - The new display name for the team.
+     */
     renameTeam(newName) {
         return this.httpClient.post(this._serviceUri + '/account/teams/update', { title: newName });
     }
     /**
-     * Retrieve teams
+     * Retrieves the list of teams available to the current user.
+     * @param params - The teams search parameters.
      */
     getTeams(params) {
         return this.httpClient.post(this._serviceUri + '/account/teams', params)
@@ -3249,21 +3253,22 @@ class ClipperService {
         }));
     }
     /**
-     * Retrieve team members
+     * Retrieves the members of a team matching the given search parameters.
+     * @param params - The team members search parameters.
      */
     getTeamMembers(params) {
         return this.httpClient.post(this._serviceUri + '/account/teams/members', params);
     }
     /**
-     * Delete members
-     * @param ids: the id list to delete
+     * Removes the specified members from the team.
+     * @param ids - The numeric IDs of the team members to remove.
      */
     deleteTeamMembers(ids) {
         return this.httpClient.post(this._serviceUri + '/account/teams/members/delete', { ids: ids });
     }
     /**
-     * Save member
-     * @param item: the item to save
+     * Creates or updates a team member record.
+     * @param item - The team member data to save.
      */
     saveTeamMember(item) {
         return this.httpClient.post(this._serviceUri + '/account/teams/members/save', item);
@@ -3272,21 +3277,22 @@ class ClipperService {
     // CONTACTS
     ///
     /**
-     * Retrieve contacts
+     * Retrieves contacts matching the given search parameters.
+     * @param params - The contacts search parameters.
      */
     queryContacts(params) {
         return this.httpClient.post(this._serviceUri + '/account/contacts', params);
     }
     /**
-     * Delete contacts
-     * @param ids: the id list to delete
+     * Deletes the specified contacts.
+     * @param ids - The numeric IDs of the contacts to remove.
      */
     deleteContacts(ids) {
         return this.httpClient.post(this._serviceUri + '/account/contacts/delete', { ids: ids });
     }
     /**
-     * Save contact
-     * @param item: the item to save
+     * Creates or updates a contact record.
+     * @param item - The contact data to save.
      */
     saveContact(item) {
         return this.httpClient.post(this._serviceUri + '/account/contacts/save', item);
@@ -3295,28 +3301,29 @@ class ClipperService {
     // PROPERTIES
     ///
     /**
-     * Retrieve properties
+     * Retrieves document properties matching the given search parameters.
+     * @param params - The properties search parameters.
      */
     queryProperties(params) {
         return this.httpClient.post(this._serviceUri + '/account/properties', params);
     }
     /**
-     * Delete properties
-     * @param ids: the id list to delete
+     * Deletes the specified document properties.
+     * @param ids - The numeric IDs of the properties to remove.
      */
     deleteProperties(ids) {
         return this.httpClient.post(this._serviceUri + '/account/properties/delete', { ids: ids });
     }
     /**
-     * Save property
-     * @param item: the item to save
+     * Creates or updates a document property.
+     * @param item - The property data to save.
      */
     saveProperty(item) {
         return this.httpClient.post(this._serviceUri + '/account/properties/save', item);
     }
     /**
-     * Get the property tracking list for a property
-     * @param id: the property id
+     * Retrieves the tracking history for the given document property.
+     * @param id - The numeric ID of the property whose tracking records to retrieve.
      */
     getPropertyTrackings(id) {
         return this.httpClient.get(this._serviceUri + '/account/properties/trackings/' + id);