oneentry 1.0.126 → 1.0.128

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

@@ -1,27 +1,25 @@
 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.
-     *
+     * @handleName signUp
      * @param {string} marker - The marker identifying the auth provider. Example: "email".
      * @param {ISignUpData} data - The data required for user registration. Example:
         {
@@ -50,122 +48,132 @@ interface IAuthProvider {
           }
         }
      * @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.
+     * @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.
-     *
+     * @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".
-     * @return {void} A promise that resolves to void or an error.
+     * @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.
-     *
+     * @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".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @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.
-     *
+     * @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".
-     *
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @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.
-     *
+     * @handleName auth
      * @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.
+     * @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.
-     *
+     * @handleName refresh
      * @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.
+     * @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.
-     *
+     * @handleName logout
      * @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.
+     * @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.
-     *
+     * @handleName logoutAll
      * @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.
+     * @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.
-     *
+     * @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".
-     * @return {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @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.
-     *
+     * @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.
-     * @return {IAuthProvidersEntity[]} A promise that resolves to an array of auth provider entities or an error.
+     * @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.
-     *
+     * @handleName getAuthProviderByMarker
      * @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.
+     * @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.
-     *
+     * @handleName getActiveSessionsByMarker
      * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @return {any} A promise that resolves to active user sessions data object.
+     * @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:
         {
@@ -176,7 +184,7 @@ interface IAuthProvider {
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ISignUpEntity} Returns a user object.
+     * @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,9 +192,7 @@ 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".
@@ -199,9 +205,7 @@ 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:
     {
@@ -218,9 +222,9 @@ interface IAuthFormData {
       ],
       "formData": [
         {
-          "marker": "last_name",
-          "type": "string",
-          "value": "Name"
+        "marker": "last_name",
+        "type": "string",
+        "value": "Name"
         }
       ],
       "notificationData": {
@@ -229,30 +233,30 @@ interface IAuthFormData {
         "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:
+ * @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": "last_name",
-        "type": "string",
-        "value": "Name"
-      }
-  * @property {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+        "marker": "login",
+        "value": "example@oneentry.cloud"
+      },
       {
-        "email": "example@oneentry.cloud",
-        "phonePush": ["+99999999999"],
-        "phoneSMS": "+99999999999"
+        "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).
  */
@@ -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_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".
- *
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
  */
 interface IOAuthSignUpData {
@@ -292,9 +293,7 @@ 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.
@@ -311,7 +310,7 @@ interface IOAuthSignUpData {
         "value": "Doe"
       }
     ]
- * @property {Object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+ * @property {object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],
@@ -339,9 +338,7 @@ 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} 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,9 +349,7 @@ 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} accessToken - The access token for the user session. Example: "abcdef123456".
@@ -369,9 +364,7 @@ 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" }
@@ -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,9 +409,7 @@ 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:
     [
       {
@@ -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, };

package/dist/base/asyncModules.d.ts

@@ -2,6 +2,7 @@ import type StateModule from './stateModule';
 import SyncModules from './syncModules';
 /**
  * Abstract class AsyncModules extends SyncModules to provide asynchronous HTTP request functionalities.
+ * @description Abstract class AsyncModules extends SyncModules to provide asynchronous HTTP request functionalities.
  */
 export default abstract class AsyncModules extends SyncModules {
     protected state: StateModule;
@@ -10,58 +11,59 @@ export default abstract class AsyncModules extends SyncModules {
     protected _url: string;
     /**
      * Constructor initializes the AsyncModules with a given state.
-     * @param state - Instance of StateModule containing configuration and state data.
+     * @param {StateModule} state - Instance of StateModule containing configuration and state data.
+     * @description Constructor initializes the AsyncModules with a given state.
      */
     protected constructor(state: StateModule);
     /**
      * Performs an HTTP GET request.
-     * @param path - The path to append to the base URL.
-     * @return A promise resolving to the response data.
+     * @param {string} path - The path to append to the base URL.
+     * @returns {Promise<any>} A promise resolving to the response data.
      * @description Define a protected asynchronous method '_fetchGet' that performs a GET request
      */
     protected _fetchGet(path: string): Promise<any>;
     /**
      * Performs an HTTP POST request.
-     * @param path - The path to append to the base URL.
-     * @param data - The data to send in the request body.
-     * @return A promise resolving to the response data.
+     * @param {string} path   - The path to append to the base URL.
+     * @param {any} [data] - The data to send in the request body.
+     * @returns {Promise<any>} A promise resolving to the response data.
      * @description Define a protected asynchronous method '_fetchPost' that performs a POST request
      */
     protected _fetchPost(path: string, data?: any): Promise<any>;
     /**
      * Performs an HTTP PUT request.
-     * @param path - The path to append to the base URL.
-     * @param data - The data to send in the request body.
-     * @return A promise resolving to the response data.
+     * @param {string} path - The path to append to the base URL.
+     * @param {any} body - The data to send in the request body.
+     * @returns {Promise<any>} A promise resolving to the response data.
      * @description Define a protected asynchronous method '_fetchPut' that performs a PUT request
      */
-    protected _fetchPut(path: string, data: any): Promise<any>;
+    protected _fetchPut(path: string, body: any): Promise<any>;
     /**
      * Performs an HTTP DELETE request.
-     * @param path - The path to append to the base URL.
-     * @param data - Optional data to send in the request body.
-     * @return A promise resolving to the response data.
+     * @param {string} path - The path to append to the base URL.
+     * @param {any} body - The body of the request.
+     * @returns {Promise<any>} A promise resolving to the response data.
      * @description Define a protected asynchronous method '_fetchDelete' that performs a DELETE request
      */
-    protected _fetchDelete(path: string, data?: any): Promise<any>;
+    protected _fetchDelete(path: string, body?: any): Promise<any>;
     /**
      * Refreshes the authentication token.
-     * @return A promise resolving to a boolean indicating success or failure.
+     * @returns {Promise<boolean>} A promise resolving to a boolean indicating success or failure.
      * @description Define an asynchronous method 'refreshToken' that attempts to refresh the authentication token
      */
     protected refreshToken(): Promise<boolean>;
     /**
      * Creates options for HTTP requests.
-     * @param method - The HTTP method (GET, POST, PUT, DELETE, etc.).
-     * @param data - Optional data to include in the request body.
-     * @return An object representing the request options.
+     * @param {string} method - The HTTP method (GET, POST, PUT, DELETE, etc.).
+     * @param {any} data - Optional data to include in the request body.
+     * @returns {any} An object representing the request options.
      */
     private makeOptions;
     /**
      * Handles responses from the browser's fetch API.
-     * @param path - The path to append to the base URL.
-     * @param options - The options for the fetch request.
-     * @return A promise resolving to the response data.
+     * @param {string} path - The path to append to the base URL.
+     * @param {any} options - The options for the fetch request.
+     * @returns {any} A promise resolving to the response data.
      * @description Define an asynchronous method 'browserResponse' that takes a path and options as parameters
      */
     private browserResponse;