oneentry 1.0.126 → 1.0.127

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

@@ -1,182 +1,190 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IAuthProvider
- *
- * @property {function} signUp - User registration.
- * @property {function} generateCode - Getting a user activation code.
- * @property {function} checkCode - User activation code verification.
- * @property {function} activateUser - User activate.
- * @property {function} auth - User authorization.
- * @property {function} refresh - Refresh token.
- * @property {function} logout - User logout.
- * @property {function} logoutAll - User logout.
- * @property {function} changePassword - Change password.
- * @property {function} getAuthProviders - Get all auth providers objects.
- * @property {function} getAuthProviderByMarker - Get one auth provider object by marker.
- * @property {function} getActiveSessionsByMarker - Get one auth provider object by marker.
- * @property {function} oauthSignUp - User registration (authorization) via OAUTH.
- *
+ * @property {Function} signUp                    - User registration.
+ * @property {Function} generateCode              - Getting a user activation code.
+ * @property {Function} checkCode                 - User activation code verification.
+ * @property {Function} activateUser              - User activate.
+ * @property {Function} auth                      - User authorization.
+ * @property {Function} refresh                   - Refresh token.
+ * @property {Function} logout                    - User logout.
+ * @property {Function} logoutAll                 - User logout.
+ * @property {Function} changePassword            - Change password.
+ * @property {Function} getAuthProviders          - Get all auth providers objects.
+ * @property {Function} getAuthProviderByMarker   - Get one auth provider object by marker.
+ * @property {Function} getActiveSessionsByMarker - Get one auth provider object by marker.
+ * @property {Function} oauthSignUp               - User registration (authorization) via OAUTH.
  * @description This interface defines methods for user authentication and registration through various auth providers.
  */
 interface IAuthProvider {
     /**
      * Registers a new user.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {ISignUpData} data - The data required for user registration. Example:
-        {
-          "formIdentifier": "reg",
-          "authData": [
-            {
-              "marker": "login",
-              "value": "example@oneentry.cloud"
-            },
-            {
-              "marker": "password",
-              "value": "12345"
-            }
-          ],
-          "formData": [
-            {
-              "marker": "last_name",
-              "type": "string",
-              "value": "Name"
-            }
-          ],
-          "notificationData": {
-            "email": "example@oneentry.cloud",
-            "phonePush": ["+99999999999"],
-            "phoneSMS": "+99999999999"
-          }
-        }
-     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @return {ISignUpEntity} A promise that resolves to a sign-up entity or an error.
+     * @handleName signUp
+     * @param   {string}        marker     - The marker identifying the auth provider. Example: "email".
+     * @param   {ISignUpData}   data       - The data required for user registration. Example:
+                                           {
+                                           "formIdentifier": "reg",
+                                           "authData": [
+                                           {
+                                           "marker": "login",
+                                           "value": "example@oneentry.cloud"
+                                           },
+                                           {
+                                           "marker": "password",
+                                           "value": "12345"
+                                           }
+                                           ],
+                                           "formData": [
+                                           {
+                                           "marker": "last_name",
+                                           "type": "string",
+                                           "value": "Name"
+                                           }
+                                           ],
+                                           "notificationData": {
+                                           "email": "example@oneentry.cloud",
+                                           "phonePush": ["+99999999999"],
+                                           "phoneSMS": "+99999999999"
+                                           }
+                                           }
+     * @param   {string}        [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {ISignUpEntity}            A promise that resolves to a sign-up entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method registers a new user.
      */
     signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
     /**
      * Generates an activation code for a user.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The event identifier related to the code generation. Example: "user_registration".
-     * @return {void} A promise that resolves to void or an error.
+     * @handleName generateCode
+     * @param   {string} marker          - The marker identifying the auth provider. Example: "email".
+     * @param   {string} userIdentifier  - The user's identifier. Example: "example@oneentry.cloud".
+     * @param   {string} eventIdentifier - The event identifier related to the code generation. Example: "user_registration".
+     * @returns {void}                   A promise that resolves to void or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method generates an activation code for a user.
      */
     generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
     /**
      * Verifies a user activation code.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The event identifier related to the code verification. Example: "user_registration".
-     * @param {string} code - The activation code to verify. Example: "123456".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @handleName checkCode
+     * @param   {string}  marker          - The marker identifying the auth provider. Example: "email".
+     * @param   {string}  userIdentifier  - The user's identifier. Example: "example@oneentry.cloud".
+     * @param   {string}  eventIdentifier - The event identifier related to the code verification. Example: "user_registration".
+     * @param   {string}  code            - The activation code to verify. Example: "123456".
+     * @returns {boolean}                 A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method verifies a user activation code.
      */
     checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * Activates a user account.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {string} code - The activation code. Example: "123456".
-     *
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @handleName activateUser
+     * @param   {string}  marker         - The marker identifying the auth provider. Example: "email".
+     * @param   {string}  userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
+     * @param   {string}  code           - The activation code. Example: "123456".
+     * @returns {boolean}                A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method activates a user account.
      */
     activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * Authorizes a user.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {IAuthPostBody} data - The data required for user authorization. Example: .
-     * @return {IAuthEntity} A promise that resolves to an auth entity or an error.
+     * @handleName auth
+     * @param   {string}        marker - The marker identifying the auth provider. Example: "email".
+     * @param   {IAuthPostBody} data   - The data required for user authorization. Example: .
+     * @returns {IAuthEntity}          A promise that resolves to an auth entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method authorizes a user.
      */
     auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity | IError>;
     /**
      * Refreshes a user's access token.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} token - The refresh token. Example: "abcdef123456".
-     * @return {IAuthEntity} A promise that resolves to an auth entity or an error.
+     * @handleName refresh
+     * @param   {string}      marker - The marker identifying the auth provider. Example: "email".
+     * @param   {string}      token  - The refresh token. Example: "abcdef123456".
+     * @returns {IAuthEntity}        A promise that resolves to an auth entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method refreshes a user's access token.
      */
     refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
     /**
      * Logs out a user.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} token - The access token. Example: "abcdef123456".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @handleName logout
+     * @param   {string}  marker - The marker identifying the auth provider. Example: "email".
+     * @param   {string}  token  - The access token. Example: "abcdef123456".
+     * @returns {boolean}        A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method logs out a user.
      */
     logout(marker: string, token: string): Promise<boolean | IError>;
     /**
      * Logout of user account on all devices.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @handleName logoutAll
+     * @param   {string}  marker - The marker identifying the auth provider. Example: "email".
+     * @returns {boolean}        A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method logs out a user account on all devices.
      */
     logoutAll(marker: string): Promise<boolean | IError>;
     /**
      * Changes a user's password.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {number} type - The type of password change. 1 for changing password, 2 for recovery. Example: 1.
-     * @param {string} code - The code for password change verification. Example: "123456".
-     * @param {string} newPassword - The new password. Example: "newPassword123".
-     * @param {string} [repeatPassword] - Optional repeat of the new password for confirmation. Example: "newPassword123".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @handleName changePassword
+     * @param   {string}  marker           - The marker identifying the auth provider. Example: "email".
+     * @param   {string}  userIdentifier   - The user's identifier. Example: "example@oneentry.cloud".
+     * @param   {string}  eventIdentifier  - The event identifier. Example: "reg".
+     * @param   {number}  type             - The type of password change. 1 for changing password, 2 for recovery. Example: 1.
+     * @param   {string}  code             - The code for password change verification. Example: "123456".
+     * @param   {string}  newPassword      - The new password. Example: "newPassword123".
+     * @param   {string}  [repeatPassword] - Optional repeat of the new password for confirmation. Example: "newPassword123".
+     * @returns {boolean}                  A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method changes a user's password.
      */
     changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
     /**
      * Retrieves all authentication providers.
-     *
-     * @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.
-     * @return {IAuthProvidersEntity[]} A promise that resolves to an array of auth provider entities or an error.
+     * @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.
+     * @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.
      */
     getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<IAuthProvidersEntity[] | IError>;
     /**
      * Retrieves a specific auth provider by its marker.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @return {IAuthProvidersEntity} A promise that resolves to an auth provider entity or an error.
+     * @handleName getAuthProviderByMarker
+     * @param   {string}               marker     - The marker identifying the auth provider. Example: "email".
+     * @param   {string}               [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {IAuthProvidersEntity}            A promise that resolves to an auth provider entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves a specific auth provider by its marker.
      */
     getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
     /**
      * Retrieves active user sessions data object.
-     *
-     * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @return {any} A promise that resolves to active user sessions data object.
+     * @handleName getActiveSessionsByMarker
+     * @param   {string} marker - The marker identifying the auth provider. Example: "email".
+     * @returns {any}           A promise that resolves to active user sessions data object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves active user sessions data object.
      */
     getActiveSessionsByMarker(marker: string): Promise<any | IError>;
     /**
      * User registration (authorization) via OAUTH.
-     *
      * @handleName oauthSignUp
-     *
-     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
-        {
-          "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
-          "client_secret": "43434343434",
-          "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
-          "grant_type": "authorization_code",
-          "redirect_uri": "http://localhost:3000"
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ISignUpEntity} Returns a user object.
+     * @param   {string}           marker     - The text identifier of the authorization provider. Example: "email".
+     * @param   {IOAuthSignUpData} body       - Object contains OAuth information for registration. Example:
+                                              {
+                                              "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
+                                              "client_secret": "43434343434",
+                                              "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
+                                              "grant_type": "authorization_code",
+                                              "redirect_uri": "http://localhost:3000"
+                                              }
+     * @param   {string}           [langCode] - Language code. Default: "en_US".
+     * @returns {ISignUpEntity}               Returns a user object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User registration (authorization) via OAUTH.
      */
@@ -184,12 +192,10 @@ 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} value - The value entered in the form field. Example: "example@oneentry.cloud".
+ * @property {string} type   - The type of the form field, such as 'string', 'email', etc. 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.
  */
 interface IAuthFormData {
@@ -199,61 +205,59 @@ interface IAuthFormData {
 }
 /**
  * Interface representing the data required for user registration.
- *
  * @interface ISignUpData
- *
- * @property {string} marker - The text identifier of the authorization provider. Example: "email".
- * @property {ISignUpData} body - Request body. Example:
-    {
-      "formIdentifier": "reg",
-      "authData": [
-        {
-          "marker": "login",
-          "value": "example@oneentry.cloud"
-        },
-        {
-          "marker": "password",
-          "value": "12345"
-        }
-      ],
-      "formData": [
-        {
-          "marker": "last_name",
-          "type": "string",
-          "value": "Name"
-        }
-      ],
-      "notificationData": {
-        "email": "example@oneentry.cloud",
-        "phonePush": ["+99999999999"],
-        "phoneSMS": "+99999999999"
-      }
-    }
-  * @property {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
-  * @property {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
-      [
-        {
-          "marker": "login",
-          "value": "example@oneentry.cloud"
-        },
-        {
-          "marker": "password",
-          "value": "12345"
-        }
-      ]
-  * @property {IAuthFormData | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
-      {
-        "marker": "last_name",
-        "type": "string",
-        "value": "Name"
-      }
-  * @property {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
-      {
-        "email": "example@oneentry.cloud",
-        "phonePush": ["+99999999999"],
-        "phoneSMS": "+99999999999"
-      }
- * @property {string} [langCode] - Language code. Default: "en_US".
+ * @property {string}                              marker                - The text identifier of the authorization provider. Example: "email".
+ * @property {ISignUpData}                         body                  - Request body. Example:
+                                                                         {
+                                                                         "formIdentifier": "reg",
+                                                                         "authData": [
+                                                                         {
+                                                                         "marker": "login",
+                                                                         "value": "example@oneentry.cloud"
+                                                                         },
+                                                                         {
+                                                                         "marker": "password",
+                                                                         "value": "12345"
+                                                                         }
+                                                                         ],
+                                                                         "formData": [
+                                                                         {
+                                                                         "marker": "last_name",
+                                                                         "type": "string",
+                                                                         "value": "Name"
+                                                                         }
+                                                                         ],
+                                                                         "notificationData": {
+                                                                         "email": "example@oneentry.cloud",
+                                                                         "phonePush": ["+99999999999"],
+                                                                         "phoneSMS": "+99999999999"
+                                                                         }
+                                                                         }
+ * @property {string}                              body.formIdentifier   - The identifier for the registration form. Example: "reg".
+ * @property {{ marker: string; value: string }[]} body.authData         - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+                                                                         [
+                                                                         {
+                                                                         "marker": "login",
+                                                                         "value": "example@oneentry.cloud"
+                                                                         },
+                                                                         {
+                                                                         "marker": "password",
+                                                                         "value": "12345"
+                                                                         }
+                                                                         ]
+ * @property {IAuthFormData | IAuthFormData[]}     body.formData         - The form data for the registration, which can be a single object or an array of objects. Example:
+                                                                         {
+                                                                         "marker": "last_name",
+                                                                         "type": "string",
+                                                                         "value": "Name"
+                                                                         }
+ * @property {object}                              body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+                                                                         {
+                                                                         "email": "example@oneentry.cloud",
+                                                                         "phonePush": ["+99999999999"],
+                                                                         "phoneSMS": "+99999999999"
+                                                                         }
+ * @property {string}                              [langCode]            - Language code. Default: "en_US".
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
  */
 interface ISignUpData {
@@ -272,15 +276,12 @@ interface ISignUpData {
 }
 /**
  * Interface representing the data required for user registration via OAUTH.
- *
  * @interface IOAuthSignUpData
- *
- * @property {string} client_id - The client ID for the OAuth application. Example: "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com".
+ * @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} redirect_uri - The redirect URI for the OAuth application. Example: "http://localhost:3000".
- *
+ * @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} 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).
  */
 interface IOAuthSignUpData {
@@ -292,32 +293,30 @@ interface IOAuthSignUpData {
 }
 /**
  * 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 {{ marker: string; value: string }[]} formData - An array of objects representing the form data, each containing a marker and its corresponding value. Example:
-    [
-      {
-        "marker": "first_name",
-        "value": "John"
-      },
-      {
-        "marker": "last_name",
-        "value": "Doe"
-      }
-    ]
- * @property {Object} notificationData - An object containing notification data, including 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 {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 {{ marker: string; value: string }[]} formData         - An array of objects representing the form data, each containing a marker and its corresponding value. Example:
+                                                                    [
+                                                                    {
+                                                                    "marker": "first_name",
+                                                                    "value": "John"
+                                                                    },
+                                                                    {
+                                                                    "marker": "last_name",
+                                                                    "value": "Doe"
+                                                                    }
+                                                                    ]
+ * @property {object}                              notificationData - An object containing notification data, including 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".
  * @description This interface defines the structure of a sign-up entity.
  */
 interface ISignUpEntity {
@@ -339,10 +338,8 @@ interface ISignUpEntity {
 }
 /**
  * Interface representing a code entity used for user registration or verification processes.
- *
  * @interface ICodeEntity
- *
- * @property {string} code - The activation code for user registration or verification. Example: "123456".
+ * @property {string} code        - The activation code for user registration or verification. Example: "123456".
  * @property {string} expiredDate - The date when the activation code expires. Example: "2023-10-01T12:00:00Z".
  * @description This interface defines the structure of a code entity used for user registration or verification processes.
  */
@@ -352,13 +349,11 @@ interface ICodeEntity {
 }
 /**
  * Interface representing an authentication entity.
- *
  * @interface IAuthEntity
- *
- * @property {string} userIdentifier - The unique identifier for the user. Example: "user12345".
+ * @property {string} userIdentifier         - The unique identifier for the user. Example: "user12345".
  * @property {string} authProviderIdentifier - The identifier for 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".
+ * @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.
  */
 interface IAuthEntity {
@@ -369,19 +364,17 @@ 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. Example: {"key": "value"}.
- * @property {IAuthProvidersEntityConfig} config - Configuration settings for the auth provider, stored as a key-value pair object. 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}                     id                  - The unique identifier of the auth provider entity. Example: 194.
+ * @property {ILocalizeInfo}              localizeInfos       - Localized information for the auth provider. Example: {"key": "value"}.
+ * @property {IAuthProvidersEntityConfig} config              - Configuration settings for the auth provider, stored as a key-value pair object. 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.
  * @description This interface defines the structure of an authentication provider entity.
  */
 interface IAuthProvidersEntity {
@@ -398,15 +391,13 @@ interface IAuthProvidersEntity {
 }
 /**
  * Interface representing an authentication provider config.
- *
  * @interface IAuthProvidersEntityConfig
- *
- * @property {string} accessTokenTtlSec
- * @property {string} refreshTokenTtlMc
- * @property {string} tokenSecretKey
- * @property {string} deleteNoneActiveUsersAfterDays
- * @property {string} systemCodeTlsSec
- * @property {string} systemCodeLength
+ * @property {string} accessTokenTtlSec              - Access token time to live in seconds.
+ * @property {string} refreshTokenTtlMc              - Refresh token time to live in milliseconds.
+ * @property {string} tokenSecretKey                 - Token secret key.
+ * @property {string} deleteNoneActiveUsersAfterDays - Delete none active users after days.
+ * @property {string} systemCodeTlsSec               - System code time to live in seconds.
+ * @property {string} systemCodeLength               - System code length.
  */
 interface IAuthProvidersEntityConfig {
     accessTokenTtlSec: string;
@@ -418,16 +409,14 @@ interface IAuthProvidersEntityConfig {
 }
 /**
  * Interface representing the body used in authentication requests.
- *
  * @interface IAuthPostBody
- *
  * @property {{ marker: string; value: string | number }[]} authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
-    [
-      {
-        "marker": "login",
-        "value": "user@example.com"
-      }
-    ]
+                                                                     [
+                                                                     {
+                                                                     "marker": "login",
+                                                                     "value": "user@example.com"
+                                                                     }
+                                                                     ]
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IAuthPostBody {
@@ -436,4 +425,19 @@ interface IAuthPostBody {
         value: string | number;
     }>;
 }
-export type { IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOAuthSignUpData, ISignUpData, ISignUpEntity, };
+/**
+ * Interface representing the active session data.
+ * @interface IActiveSession
+ * @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} location - The location of the active session. Example: "ru-RU".
+ * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
+ */
+interface IActiveSession {
+    deviceInfo: {
+        os: string;
+        browser: string;
+        location: string;
+    };
+}
+export type { IActiveSession, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOAuthSignUpData, ISignUpData, ISignUpEntity, };