oneentry 1.0.173 → 1.0.174

package/esm/auth-provider/authProviderApi.d.ts

@@ -20,7 +20,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User registration.
      * @handleName signUp
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {ISignUpData} body - Request body.
      * @example
         {
@@ -48,7 +48,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
             "phoneSMS": "+99999999999"
           }
         }
-     * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
+     * @param {string} body.formIdentifier - Marker of the registration form. Example: "reg".
      * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
      * @example
         [
@@ -68,7 +68,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
           "type": "string",
           "value": "Name"
         }
-     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+     * @param {object} body.notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
      * @example
         {
           "email": "example@oneentry.cloud",
@@ -88,9 +88,9 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Getting a user activation code. The code is returned via the appropriate user notification method.
      * @handleName generateCode
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
      * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Obtaining a code to activate the user.
@@ -100,10 +100,10 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      * @handleName checkCode
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Checking the user activation code
@@ -113,9 +113,9 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User activate.
      * @handleName activateUser
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the user was successfully activated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User activation.
@@ -125,8 +125,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User authorization.
      * @handleName auth
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IAuthPostBody} body - Objects contains auth information.
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {IAuthPostBody} body - Authentication data.
      * @example
         {
           "authData": [
@@ -159,7 +159,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Refresh token.
      * @handleName refresh
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -170,7 +170,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User account logout.
      * @handleName logout
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -182,7 +182,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Logout of user account on all devices.
      * @handleName logoutAll
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -193,13 +193,13 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Change password.
      * @handleName changePassword
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
-     * @param {number} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Marker of the event the code was generated for (the `eventIdentifier` passed to `generateCode`). Example: "reg".
+     * @param {number} type - Operation type: `1` to change the password, `2` to recover it. Example: 1.
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @param {string} newPassword - New password. Example: "newPassword123".
-     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @param {string} [repeatPassword] - New password repeated for confirmation. Optional. Example: "newPassword123".
      * @returns {Promise<boolean | IError>} Returns true if the password was successfully changed, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User password change (only for tariffs with account activation and the Activation feature enabled).
@@ -210,8 +210,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * Get all auth providers objects.
      * @handleName getAuthProviders
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IAuthProvidersEntity[] | IError>} Returns an array of auth provider objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting all objects of authorization providers.
@@ -221,7 +221,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Get one auth provider object by marker.
      * @handleName getAuthProviderByMarker
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IAuthProvidersEntity | IError>} Returns an auth provider object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -232,7 +232,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * Getting active user sessions data.
      * @handleName getActiveSessionsByMarker
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @returns {Promise<IActiveSession[] | IError>} Array of the authenticated user's active sessions for this provider, one per device (`deviceInfo`).
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting the authenticated user's active sessions for the authorization provider. This method requires user authorization.
@@ -242,8 +242,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     /**
      * User registration (authorization) via OAUTH.
      * @handleName oauth
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOauthData} body - Object contains OAuth information for registration.
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {IOauthData} body - OAuth data for registration.
      * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",

package/esm/auth-provider/authProviderApi.js

@@ -21,7 +21,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User registration.
      * @handleName signUp
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {ISignUpData} body - Request body.
      * @example
         {
@@ -49,7 +49,7 @@ export default class AuthProviderApi extends AsyncModules {
             "phoneSMS": "+99999999999"
           }
         }
-     * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
+     * @param {string} body.formIdentifier - Marker of the registration form. Example: "reg".
      * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
      * @example
         [
@@ -69,7 +69,7 @@ export default class AuthProviderApi extends AsyncModules {
           "type": "string",
           "value": "Name"
         }
-     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+     * @param {object} body.notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
      * @example
         {
           "email": "example@oneentry.cloud",
@@ -96,9 +96,9 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Getting a user activation code. The code is returned via the appropriate user notification method.
      * @handleName generateCode
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
      * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Obtaining a code to activate the user.
@@ -115,10 +115,10 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      * @handleName checkCode
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Checking the user activation code
@@ -136,9 +136,9 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User activate.
      * @handleName activateUser
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the user was successfully activated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User activation.
@@ -155,8 +155,8 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User authorization.
      * @handleName auth
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IAuthPostBody} body - Objects contains auth information.
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {IAuthPostBody} body - Authentication data.
      * @example
         {
           "authData": [
@@ -201,7 +201,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Refresh token.
      * @handleName refresh
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -223,7 +223,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User account logout.
      * @handleName logout
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -248,7 +248,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Logout of user account on all devices.
      * @handleName logoutAll
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -269,13 +269,13 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Change password.
      * @handleName changePassword
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
-     * @param {number} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
-     * @param {string} code - Service code. Example: "123456".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Marker of the event the code was generated for (the `eventIdentifier` passed to `generateCode`). Example: "reg".
+     * @param {number} type - Operation type: `1` to change the password, `2` to recover it. Example: 1.
+     * @param {string} code - One-time code the user received. Example: "123456".
      * @param {string} newPassword - New password. Example: "newPassword123".
-     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @param {string} [repeatPassword] - New password repeated for confirmation. Optional. Example: "newPassword123".
      * @returns {Promise<boolean | IError>} Returns true if the password was successfully changed, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User password change (only for tariffs with account activation and the Activation feature enabled).
@@ -297,8 +297,8 @@ export default class AuthProviderApi extends AsyncModules {
      * Get all auth providers objects.
      * @handleName getAuthProviders
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IAuthProvidersEntity[] | IError>} Returns an array of auth provider objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting all objects of authorization providers.
@@ -313,7 +313,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Get one auth provider object by marker.
      * @handleName getAuthProviderByMarker
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IAuthProvidersEntity | IError>} Returns an auth provider object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -327,7 +327,7 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * Getting active user sessions data.
      * @handleName getActiveSessionsByMarker
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} marker - Marker of the auth provider. Example: "email".
      * @returns {Promise<IActiveSession[] | IError>} Array of the authenticated user's active sessions for this provider, one per device (`deviceInfo`).
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting the authenticated user's active sessions for the authorization provider. This method requires user authorization.
@@ -340,8 +340,8 @@ export default class AuthProviderApi extends AsyncModules {
     /**
      * User registration (authorization) via OAUTH.
      * @handleName oauth
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOauthData} body - Object contains OAuth information for registration.
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {IOauthData} body - OAuth data for registration.
      * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",

package/esm/auth-provider/authProvidersInterfaces.d.ts

@@ -133,8 +133,8 @@ interface IAuthProvider {
      * Retrieves all authentication providers.
      * @handleName getAuthProviders
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {IAuthProvidersEntity[]} A promise that resolves to an array of auth provider entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves all authentication providers.
@@ -162,8 +162,8 @@ interface IAuthProvider {
     /**
      * User registration (authorization) via OAUTH.
      * @handleName oauthSignUp
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOauthData} body - Object contains OAuth information for registration.
+     * @param {string} marker - Marker of the auth provider. Example: "email".
+     * @param {IOauthData} body - OAuth data for registration.
      * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
@@ -182,8 +182,8 @@ interface IAuthProvider {
 /**
  * Interface representing the structure of authentication form data.
  * @interface IAuthFormData
- * @property {string} marker - A unique identifier for the form field. Example: "email".
- * @property {string} type - The type of the form field, such as 'string', 'email', etc. Example: "string".
+ * @property {string} marker - Marker of the form field. Example: "email".
+ * @property {string} type - Type of the form field, for example `"string"` or `"email"`. Example: "string".
  * @property {string} value - The value entered in the form field. Example: "example@oneentry.cloud".
  * @description This interface defines the structure of authentication form data used in user registration and authentication processes.
  */
@@ -195,11 +195,11 @@ interface IAuthFormData {
 /**
  * Interface representing the data required for user registration.
  * @interface ISignUpData
- * @property {string} formIdentifier - The identifier for the registration form. Example: "reg".
+ * @property {string} formIdentifier - Marker of the registration form. Example: "reg".
  * @property {string} [langCode] - Language code. Default: "en_US".
- * @property {Array} authData - An array of authentication data objects, each containing a marker and its corresponding value.
- * @property {IAuthFormData | IAuthFormData[]} formData - The form data for the registration.
- * @property {INotificationData} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @property {Array} authData - Authentication fields, each with a `marker` and a `value`.
+ * @property {IAuthFormData | IAuthFormData[]} formData - Registration form fields.
+ * @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
  */
 interface ISignUpData {
@@ -211,7 +211,7 @@ interface ISignUpData {
 }
 /**
  * @interface INotificationData
- * @property {string} email - User's email used for notifications. Example: "example@oneentry.cloud".
+ * @property {string} email - User email used for notifications. Example: "example@oneentry.cloud".
  * @property {string[]} phonePush - Phone numbers used for push notifications. Example: ["+19999999999"].
  * @property {string} [phoneSMS] - Phone number used for SMS notifications. Example: "+19999999999".
  * @description Notification channels configured for a user.
@@ -227,7 +227,7 @@ interface INotificationData {
  * @property {string} client_id - The client ID for the OAuth application. Example: "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com".
  * @property {string} client_secret - The client secret for the OAuth application. Example: "43434343434".
  * @property {string} code - The authorization code received from the OAuth provider. Example: "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g".
- * @property {string} grant_type - The grant type for the OAuth request. Example: "authorization_code".
+ * @property {string} grant_type - OAuth grant type. Example: "authorization_code".
  * @property {string} redirect_uri - The redirect URI for the OAuth application. Example: "http://localhost:3000".
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
  */
@@ -241,12 +241,12 @@ interface IOauthData {
 /**
  * Interface representing a sign-up entity.
  * @interface ISignUpEntity
- * @property {number} id - The unique identifier of the sign-up entity. Example: 12345.
- * @property {string} updatedDate - The date when the sign-up entity was last updated. Example: "2023-10-01T12:00:00Z".
- * @property {number} version - The version number of the sign-up entity. Example: 1.
- * @property {string} identifier - A unique string that identifies the sign-up entity. Example: "signup_12345".
- * @property {boolean} isActive - Indicates whether the sign-up entity is active. Example: true.
- * @property {IAuthFormData[]} formData - Form data array.
+ * @property {number} id - ID of the user created by sign-up. Example: 12345.
+ * @property {string} updatedDate - Date the user was last updated. Example: "2023-10-01T12:00:00Z".
+ * @property {number} version - Version number of the user; changes with each update. Example: 1.
+ * @property {string} identifier - Marker of the user created by sign-up. Example: "signup_12345".
+ * @property {boolean} isActive - Whether the user account is active. Example: true.
+ * @property {IAuthFormData[]} formData - Form fields.
  * @example
     [
       {
@@ -254,22 +254,22 @@ interface IOauthData {
         "value": "John"
       }
     ]
- * @property {INotificationData} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
  * @example
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],
       "phoneSMS": "+99999999999"
     }
- * @property {string} [locale] - The locale or language code associated with the sign-up entity. Example: "en_US".
- * @property {string} [createdDate] - The date when the sign-up entity was created. Example: "2023-10-01T12:00:00Z".
+ * @property {string} [locale] - Locale of the user created by sign-up. Example: "en_US".
+ * @property {string} [createdDate] - Creation date of the user record. Example: "2023-10-01T12:00:00Z".
  * @property {unknown} [importId] - Import identifier. Example: null.
- * @property {string | null} [deletedAt] - Deletion date or null. Example: null.
- * @property {boolean} [isDeleted] - Whether the entity is deleted. Example: false.
- * @property {Record<string, unknown>} [state] - Additional state information. Example: {}.
- * @property {IRating} [rating] - Rating data.
- * @property {number | null} [attributeSetId] - Identifier of the attribute set attached to the user, or null when none is attached. Example: null.
- * @property {Record<string, unknown>} [attributesSets] - Attribute sets attached to the user, keyed by marker; empty object when none. Example: {}.
+ * @property {string | null} [deletedAt] - Deletion date, or `null`. Example: null.
+ * @property {boolean} [isDeleted] - Whether the user account is deleted. Example: false.
+ * @property {Record<string, unknown>} [state] - Custom key-value data stored with the user. Example: {}.
+ * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
+ * @property {number | null} [attributeSetId] - ID of the attribute set attached to the user, or `null` when none is attached. Example: null.
+ * @property {Record<string, unknown>} [attributesSets] - Attribute sets attached to the user, keyed by marker; an empty object when there are none. Example: {}.
  * @description This interface defines the structure of a sign-up entity.
  */
 interface ISignUpEntity {
@@ -304,8 +304,8 @@ interface ICodeEntity {
 /**
  * Interface representing an authentication entity.
  * @interface IAuthEntity
- * @property {string} userIdentifier - The unique identifier for the user. Example: "user12345".
- * @property {string} authProviderIdentifier - The identifier for the authentication provider. Example: "email".
+ * @property {string} userIdentifier - User identifier (login), for example the email address. Example: "user12345".
+ * @property {string} authProviderIdentifier - Marker of the authentication provider. Example: "email".
  * @property {string} accessToken - The access token for the user session. Example: "abcdef123456".
  * @property {string} refreshToken - The refresh token for renewing the access token. Example: "ghijkl789012".
  * @description This interface defines the structure of an authentication entity.
@@ -319,24 +319,24 @@ interface IAuthEntity {
 /**
  * Interface representing an authentication provider entity.
  * @interface IAuthProvidersEntity
- * @property {number} id - The unique identifier of the auth provider entity. Example: 194.
- * @property {ILocalizeInfo} localizeInfos - Localized information for the auth provider.
+ * @property {number} id - ID of the auth provider. Example: 194.
+ * @property {ILocalizeInfo} localizeInfos - Localized data of the auth provider.
  * @example
     {
       "key": "value"
     }
- * @property {IAuthProvidersEntityConfig} config - Configuration settings for the auth provider, stored as a key-value pair object.
+ * @property {IAuthProvidersEntityConfig} config - Provider configuration as key-value pairs.
  * @example
     {
       "key": "value"
     }
- * @property {number} version - The version number of the auth provider entity. Example: 1.
- * @property {string} identifier - A unique string that identifies the auth provider. Example: "email".
- * @property {string} type - The type of the auth provider (e.g., 'email', 'google', etc.). Example: "email".
- * @property {string | null} formIdentifier - The identifier for the form associated with the auth provider, or null if not applicable. Example: "reg_form".
- * @property {string} userGroupIdentifier - The identifier for the userGroup associated with the auth provider. Example: "guest".
- * @property {boolean} isActive - Indicates whether the auth provider is active. Example: true.
- * @property {boolean} isCheckCode - Indicates whether the auth provider requires code verification. Example: false.
+ * @property {number} version - Version number of the auth provider; changes with each update. Example: 1.
+ * @property {string} identifier - Marker of the auth provider. Example: "email".
+ * @property {string} type - Type of the auth provider, for example `"email"`. Example: "email".
+ * @property {string | null} formIdentifier - Marker of the form linked to the auth provider, or `null` if there is none. Example: "reg_form".
+ * @property {string} userGroupIdentifier - Identifier of the user group linked to the auth provider. Example: "guest".
+ * @property {boolean} isActive - Whether the auth provider is active. Example: true.
+ * @property {boolean} isCheckCode - Whether the auth provider requires a verification code. Example: false.
  * @description This interface defines the structure of an authentication provider entity.
  */
 interface IAuthProvidersEntity {
@@ -355,12 +355,12 @@ interface IAuthProvidersEntity {
  * Interface representing an authentication provider config.
  * @interface IAuthProvidersEntityConfig
  * @property {string} accessTokenTtlSec - Access token time to live in seconds. Example: "3600".
- * @property {string} refreshTokenTtlMc - Refresh token time to live in milliseconds. Example: "86400000".
- * @property {string} deleteNoneActiveUsersAfterDays - Delete none active users after days. Example: "30".
- * @property {string} systemCodeTlsSec - System code time to live in seconds. Example: "86400".
- * @property {string} systemCodeLength - System code length. Example: "6".
+ * @property {string} refreshTokenTtlMc - Lifetime of the refresh token, in milliseconds. Example: "86400000".
+ * @property {string} deleteNoneActiveUsersAfterDays - Number of days after which inactive users are deleted. Example: "30".
+ * @property {string} systemCodeTlsSec - Lifetime of the one-time code, in seconds. Example: "86400".
+ * @property {string} systemCodeLength - Length of the one-time code. Example: "6".
  * @property {string | null} oauthAuthUrl - OAuth authorization URL. Example: null.
- * @property {string | null} systemCodeOnlyNumbers - System code only numbers flag. Example: null.
+ * @property {string | null} systemCodeOnlyNumbers - Whether the one-time code uses digits only; `null` when not set. Example: null.
  */
 interface IAuthProvidersEntityConfig {
     accessTokenTtlSec: string;
@@ -374,7 +374,7 @@ interface IAuthProvidersEntityConfig {
 /**
  * Authentication data object.
  * @interface IAuthData
- * @property {string} marker - The marker identifying the auth field. Example: "login".
+ * @property {string} marker - Marker of the auth form field. Example: "login".
  * @property {string} value - The value of the auth field. Example: "user@example.com".
  */
 interface IAuthData {
@@ -384,7 +384,7 @@ interface IAuthData {
 /**
  * Interface representing the body used in authentication requests.
  * @interface IAuthPostBody
- * @property {IAuthData[]} authData - An array of authentication data objects, each containing a marker and its corresponding value.
+ * @property {IAuthData[]} authData - Authentication fields, each with a `marker` and a `value`.
  * @example
     [
       {
@@ -400,16 +400,16 @@ interface IAuthPostBody {
 /**
  * Interface representing the active session data.
  * @interface IActiveSession
- * @property {object} deviceInfo - Information about the device used in the active session.
+ * @property {object} deviceInfo - Device used in the active session.
  * @example
     {
       "os": "Win32",
       "browser": "Node.js/22",
       "location": "en-US"
     }
- * @property {string} deviceInfo.os - The operating system of the active session. Example: "Win32".
- * @property {string} deviceInfo.browser - The browser used in the active session. Example: "Node.js/22".
- * @property {string} deviceInfo.location - The location of the active session. Example: "en-US".
+ * @property {string} deviceInfo.os - Operating system of the active session. Example: "Win32".
+ * @property {string} deviceInfo.browser - Browser of the active session. Example: "Node.js/22".
+ * @property {string} deviceInfo.location - Location of the active session. Example: "en-US".
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IActiveSession {
@@ -417,8 +417,8 @@ interface IActiveSession {
 }
 /**
  * @interface IDeviceInfo
- * @property {string} os - The operating system of the active session. Example: "Win32".
- * @property {string} browser - The browser used in the active session. Example: "Node.js/22".
+ * @property {string} os - Operating system of the active session. Example: "Win32".
+ * @property {string} browser - Browser of the active session. Example: "Node.js/22".
  * @property {string} location - The locale of the active session. Example: "en-US".
  * @description Information about the device tied to an active authentication session.
  */

package/esm/base/asyncModules.d.ts

@@ -82,7 +82,7 @@ export default abstract class AsyncModules extends SyncModules {
      *
      * With `isShell` disabled browserResponse throws, and the error is thrown on
      * from here too: returning it would break the `@throws` contract every caller
-     * documents, and a `try/catch` around the call would never fire (CMS-1067).
+     * documents, and a `try/catch` around the call would never fire.
      * @param {() => Promise<unknown>} request - Thunk performing the fetch call.
      * @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
      * @throws {IError} When isShell=false and the request fails.
@@ -115,7 +115,7 @@ export default abstract class AsyncModules extends SyncModules {
      * so both the success and the error branches handle empty bodies the same way.
      *
      * A body that is present but is not JSON — a gateway's HTML page in front of a
-     * 502, the platform's own admin page (CMS-957) — used to collapse into `{}`,
+     * 502, the platform's own admin page — used to collapse into `{}`,
      * which carries no `statusCode` and therefore does not read as an error at all:
      * a failed request came back looking like an empty success. It is described
      * instead, keeping the status the server actually sent.
@@ -135,8 +135,8 @@ export default abstract class AsyncModules extends SyncModules {
      * Describes a response whose body is not the JSON the API is supposed to send.
      *
      * The platform has been seen answering `200 OK` with `content-type: text/html`
-     * and the admin page as the body — every content endpoint at once, for minutes
-     * (CMS-957). A successful status carrying someone else's body is indistinguishable
+     * and the admin page as the body — every content endpoint at once, for minutes.
+     * A successful status carrying someone else's body is indistinguishable
      * from a real answer by status alone, and the only symptom used to be
      * `SyntaxError: Unexpected token '<'` from the JSON parser: a message about the
      * SDK's own parsing rather than about what the platform did. Callers read that as
@@ -157,9 +157,9 @@ export default abstract class AsyncModules extends SyncModules {
      * With `isShell` on, a failure is returned rather than thrown — and a dropped
      * connection throws a `TypeError`, whose `message` and `stack` are not
      * enumerable. Returned as it was, it serializes to `{}` and reads exactly
-     * like an empty answer: on the sanbenitocog pilot such a value entered the
+     * like an empty answer: such a value has entered a site's
      * page cache and was served for minutes after the link came back, and
-     * `next build` baked a site of 404s while reporting success (CMS-780).
+     * `next build` baked a site of 404s while reporting success.
      *
      * An object that already carries a `statusCode` is the platform's own error
      * and is passed through untouched. Everything else becomes