oneentry 1.0.140 → 1.0.141

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

@@ -0,0 +1,425 @@
+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} oauth - 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
+        {
+          "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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @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 {IOauthData} 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.
+     */
+    oauth(marker: string, body: IOauthData, langCode?: string): Promise<IAuthEntity | IError>;
+}
+/**
+ * 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".
+ * @description This interface defines the structure of authentication form data used in user registration and authentication processes.
+ */
+interface IAuthFormData {
+    marker: string;
+    type: string;
+    value: string;
+}
+/**
+ * Interface representing the data required for user registration.
+ * @interface ISignUpData
+ * @property {string} formIdentifier - The identifier for 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 {object} notificationData - An object containing notification data, including 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 {
+    formIdentifier: string;
+    langCode?: string;
+    authData: Array<{
+        marker: string;
+        value: string;
+    }>;
+    formData: IAuthFormData | IAuthFormData[];
+    notificationData: {
+        email: string;
+        phonePush: Array<string>;
+        phoneSMS: string;
+    };
+}
+/**
+ * Interface representing the data required for user registration via OAUTH.
+ * @interface IOauthData
+ * @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 IOauthData {
+    client_id: string;
+    client_secret: string;
+    code: string;
+    grant_type: string;
+    redirect_uri: string;
+}
+/**
+ * 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 {Array<object>} 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 {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    isActive: boolean;
+    formData: Array<{
+        marker: string;
+        value: string;
+    }>;
+    notificationData: {
+        email: string;
+        phonePush: Array<string>;
+        phoneSMS: string;
+    };
+    locale?: string;
+}
+/**
+ * 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.
+ */
+interface ICodeEntity {
+    code: string;
+    expiredDate: string;
+}
+/**
+ * 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".
+ * @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 {
+    userIdentifier: string;
+    authProviderIdentifier: string;
+    accessToken: string;
+    refreshToken: string;
+}
+/**
+ * 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.
+ * @description This interface defines the structure of an authentication provider entity.
+ */
+interface IAuthProvidersEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    config: IAuthProvidersEntityConfig;
+    version: number;
+    identifier: string;
+    type: string;
+    formIdentifier: string | null;
+    userGroupIdentifier: string;
+    isActive: boolean;
+    isCheckCode: boolean;
+}
+/**
+ * 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 | null} oauthAuthUrl - OAuth authorization URL. Example: null.
+ * @property {string | null} systemCodeOnlyNumbers - System code only numbers flag. Example: null.
+ */
+interface IAuthProvidersEntityConfig {
+    accessTokenTtlSec: string;
+    refreshTokenTtlMc: string;
+    deleteNoneActiveUsersAfterDays: string;
+    systemCodeTlsSec: string;
+    systemCodeLength: string;
+    oauthAuthUrl: string | null;
+    systemCodeOnlyNumbers: string | null;
+}
+/**
+ * Authentication data object.
+ * @interface IAuthData
+ * @property {string} marker - The marker identifying the auth field. Example: "login".
+ * @property {string} value - The value of the auth field. Example: "user@example.com".
+ */
+interface IAuthData {
+    marker: string;
+    value: string;
+}
+/**
+ * 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.
+ * @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 {
+    authData: IAuthData[];
+}
+/**
+ * Interface representing the active session data.
+ * @interface IActiveSession
+ * @property {object} deviceInfo - Information about the device used in the active session.
+ * @example
+    {
+      "os": "Win32",
+      "browser": "Node.js/22",
+      "location": "ru-RU"
+    }
+ * @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: "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, IAuthData, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOauthData, ISignUpData, ISignUpEntity, };

package/dist/auth-provider/authProvidersInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/base/asyncModules.d.ts

@@ -0,0 +1,80 @@
+import type { z } from 'zod';
+import type StateModule from './stateModule';
+import SyncModules from './syncModules';
+import type { IError } from './utils';
+/**
+ * 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;
+    protected _NO_FETCH: boolean;
+    protected _https: any;
+    protected _url: string;
+    /**
+     * Constructor initializes the AsyncModules with a given state.
+     * @param {StateModule} state - Instance of StateModule containing configuration and state data.
+     * @description Constructor initializes the AsyncModules with a given state.
+     */
+    protected constructor(state: StateModule);
+    /**
+     * Validates API response against a Zod schema (optional)
+     * @param {unknown} data - The data to validate
+     * @param {z.ZodSchema<T>} [schema] - Optional Zod schema for validation
+     * @returns {T | IError} Validated data or error object
+     * @description Validates response data if validation is enabled in config
+     */
+    protected _validateResponse<T>(data: unknown, schema?: z.ZodSchema<T>): T | IError;
+    /**
+     * Performs an HTTP GET request.
+     * @param {string} path - The path to append to the base URL.
+     * @returns {Promise<T>} A promise resolving to the response data.
+     * @description Define a protected asynchronous method '_fetchGet' that performs a GET request
+     */
+    protected _fetchGet<T = unknown>(path: string): Promise<T>;
+    /**
+     * Performs an HTTP POST request.
+     * @param {string} path   - The path to append to the base URL.
+     * @param {unknown} [data] - The data to send in the request body.
+     * @returns {Promise<T>} A promise resolving to the response data.
+     * @description Define a protected asynchronous method '_fetchPost' that performs a POST request
+     */
+    protected _fetchPost<T = unknown>(path: string, data?: unknown): Promise<T>;
+    /**
+     * Performs an HTTP PUT request.
+     * @param {string} path - The path to append to the base URL.
+     * @param {unknown} body - The data to send in the request body.
+     * @returns {Promise<T>} A promise resolving to the response data.
+     * @description Define a protected asynchronous method '_fetchPut' that performs a PUT request
+     */
+    protected _fetchPut<T = unknown>(path: string, body: unknown): Promise<T>;
+    /**
+     * Performs an HTTP DELETE request.
+     * @param {string} path - The path to append to the base URL.
+     * @param {unknown} body - The body of the request.
+     * @returns {Promise<T>} A promise resolving to the response data.
+     * @description Define a protected asynchronous method '_fetchDelete' that performs a DELETE request
+     */
+    protected _fetchDelete<T = unknown>(path: string, body?: unknown): Promise<T>;
+    /**
+     * Refreshes the authentication token.
+     * @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 {string} method - The HTTP method (GET, POST, PUT, DELETE, etc.).
+     * @param {unknown} data - Optional data to include in the request body.
+     * @returns {IHttpOptions} An object representing the request options.
+     */
+    private makeOptions;
+    /**
+     * Handles responses from the browser's fetch API.
+     * @param {string} path - The path to append to the base URL.
+     * @param {IHttpOptions} options - The options for the fetch request.
+     * @returns {Promise<T>} A promise resolving to the response data.
+     * @description Define an asynchronous method 'browserResponse' that takes a path and options as parameters
+     */
+    private browserResponse;
+}