oneentry 1.0.124 → 1.0.126

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

@@ -9,9 +9,12 @@ import type { IError, ILocalizeInfo } from '../base/utils';
  * @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} getMarker - Get one auth provider object by marker.
+ * @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.
  */
@@ -20,9 +23,33 @@ 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 {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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -33,7 +60,6 @@ interface IAuthProvider {
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -45,7 +71,6 @@ interface IAuthProvider {
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -66,7 +91,6 @@ interface IAuthProvider {
      *
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -76,7 +100,6 @@ interface IAuthProvider {
      *
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -86,11 +109,18 @@ interface IAuthProvider {
      *
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    logoutAll(marker: string): Promise<boolean | IError>;
     /**
      * Changes a user's password.
      *
@@ -100,7 +130,6 @@ interface IAuthProvider {
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -111,21 +140,47 @@ interface IAuthProvider {
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity> | IError>;
+    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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User registration (authorization) via OAUTH.
+     */
+    oauthSignUp(marker: string, body: IOAuthSignUpData, langCode: string): Promise<IAuthEntity | IError>;
 }
 /**
  * Interface representing the structure of authentication form data.
@@ -135,7 +190,6 @@ interface IAuthProvider {
  * @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".
- *
  * @description This interface defines the structure of authentication form data used in user registration and authentication processes.
  */
 interface IAuthFormData {
@@ -148,13 +202,59 @@ interface IAuthFormData {
  *
  * @interface ISignUpData
  *
- * @property {string} formIdentifier - The identifier for the registration form. Example: "reg".
- * @property {string} [langCode] - Language code. Default "en_US".
- * @property {Array<{ marker: string; value: string }>} 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 | Array<IAuthFormData>} 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} notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example: { "email": "example@oneentry.cloud", "phonePush": ["+99999999999"], "phoneSMS": "+99999999999" }.
- *
- * @description This interface defines the structure of the data required for user registration, including authentication and notification information.
+ * @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 {
     formIdentifier: string;
@@ -163,13 +263,33 @@ interface ISignUpData {
         marker: string;
         value: string;
     }>;
-    formData: IAuthFormData | Array<IAuthFormData>;
+    formData: IAuthFormData | IAuthFormData[];
     notificationData: {
         email: string;
         phonePush: Array<string>;
         phoneSMS: string;
     };
 }
+/**
+ * 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 {
+    client_id: string;
+    client_secret: string;
+    code: string;
+    grant_type: string;
+    redirect_uri: string;
+}
 /**
  * Interface representing a sign-up entity.
  *
@@ -180,10 +300,24 @@ interface ISignUpData {
  * @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 {Array<{ 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 {{ 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 {
@@ -201,7 +335,7 @@ interface ISignUpEntity {
         phonePush: Array<string>;
         phoneSMS: string;
     };
-    locale: string;
+    locale?: string;
 }
 /**
  * Interface representing a code entity used for user registration or verification processes.
@@ -210,7 +344,6 @@ interface ISignUpEntity {
  *
  * @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.
  */
 interface ICodeEntity {
@@ -226,7 +359,6 @@ interface ICodeEntity {
  * @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".
- *
  * @description This interface defines the structure of an authentication entity.
  */
 interface IAuthEntity {
@@ -241,29 +373,41 @@ interface IAuthEntity {
  * @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: .
+ * @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 {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 {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 {Record<string, any>} config - Configuration settings for the auth provider, stored as a key-value pair object. Example: .
- *
+ * @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 {
     id: number;
     localizeInfos: ILocalizeInfo;
+    config: IAuthProvidersEntityConfig;
     version: number;
     identifier: string;
-    isActive: boolean;
-    isCheckCode: boolean;
     type: string;
     formIdentifier: string | null;
-    config: IAuthProvidersEntityConfig;
     userGroupIdentifier: string;
+    isActive: boolean;
+    isCheckCode: boolean;
 }
+/**
+ * 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
+ */
 interface IAuthProvidersEntityConfig {
     accessTokenTtlSec: string;
     refreshTokenTtlMc: string;
@@ -277,8 +421,13 @@ interface IAuthProvidersEntityConfig {
  *
  * @interface IAuthPostBody
  *
- * @property {Array<{ 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" }]
- *
+ * @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"
+      }
+    ]
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IAuthPostBody {
@@ -287,4 +436,4 @@ interface IAuthPostBody {
         value: string | number;
     }>;
 }
-export type { IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, ISignUpData, ISignUpEntity, };
+export type { IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOAuthSignUpData, ISignUpData, ISignUpEntity, };

package/dist/base/asyncModules.d.ts

@@ -17,6 +17,7 @@ export default abstract class AsyncModules extends SyncModules {
      * Performs an HTTP GET request.
      * @param path - The path to append to the base URL.
      * @return 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>;
     /**
@@ -24,6 +25,7 @@ export default abstract class AsyncModules extends SyncModules {
      * @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.
+     * @description Define a protected asynchronous method '_fetchPost' that performs a POST request
      */
     protected _fetchPost(path: string, data?: any): Promise<any>;
     /**
@@ -31,6 +33,7 @@ export default abstract class AsyncModules extends SyncModules {
      * @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.
+     * @description Define a protected asynchronous method '_fetchPut' that performs a PUT request
      */
     protected _fetchPut(path: string, data: any): Promise<any>;
     /**
@@ -38,16 +41,18 @@ export default abstract class AsyncModules extends SyncModules {
      * @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.
+     * @description Define a protected asynchronous method '_fetchDelete' that performs a DELETE request
      */
     protected _fetchDelete(path: string, data?: any): Promise<any>;
     /**
      * Refreshes the authentication token.
      * @return 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, etc.).
+     * @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.
      */
@@ -57,6 +62,7 @@ export default abstract class AsyncModules extends SyncModules {
      * @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.
+     * @description Define an asynchronous method 'browserResponse' that takes a path and options as parameters
      */
     private browserResponse;
 }