oneentry 1.0.123 → 1.0.124

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

@@ -1,6 +1,6 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents a interface object of User Auth Provider Api.
+ * @interface IAuthProvider
  *
  * @property {function} signUp - User registration.
  * @property {function} generateCode - Getting a user activation code.
@@ -12,21 +12,131 @@ import type { IError, ILocalizeInfo } from '../base/utils';
  * @property {function} changePassword - Change password.
  * @property {function} getAuthProviders - Get all auth providers objects.
  * @property {function} getMarker - Get one auth provider object by marker.
+ *
+ * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @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>;
-    changePassword(marker: string, userIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @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>;
+    /**
+     * 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>;
 }
 /**
- * IAuthFormData
+ * 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;
@@ -34,7 +144,17 @@ interface IAuthFormData {
     value: string;
 }
 /**
- * ISignUpData
+ * 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<{ 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.
  */
 interface ISignUpData {
     formIdentifier: string;
@@ -51,7 +171,20 @@ interface ISignUpData {
     };
 }
 /**
- * ISignUpEntity
+ * 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<{ 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 {
     id: number;
@@ -71,14 +204,30 @@ interface ISignUpEntity {
     locale: string;
 }
 /**
- * ICodeEntity
+ * 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;
 }
 /**
- * IAuthEntity
+ * 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;
@@ -87,7 +236,21 @@ interface IAuthEntity {
     refreshToken: string;
 }
 /**
- * IAuthProvidersEntity
+ * 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: .
+ * @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: .
+ *
+ * @description This interface defines the structure of an authentication provider entity.
  */
 interface IAuthProvidersEntity {
     id: number;
@@ -98,10 +261,25 @@ interface IAuthProvidersEntity {
     isCheckCode: boolean;
     type: string;
     formIdentifier: string | null;
-    config: Record<string, any>;
+    config: IAuthProvidersEntityConfig;
+    userGroupIdentifier: string;
+}
+interface IAuthProvidersEntityConfig {
+    accessTokenTtlSec: string;
+    refreshTokenTtlMc: string;
+    tokenSecretKey: string;
+    deleteNoneActiveUsersAfterDays: string;
+    systemCodeTlsSec: string;
+    systemCodeLength: string;
 }
 /**
- * IAuthPostBody
+ * Interface representing the body used in authentication requests.
+ *
+ * @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" }]
+ *
+ * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IAuthPostBody {
     authData: Array<{

package/dist/base/asyncModules.d.ts

@@ -1,58 +1,62 @@
 import type StateModule from './stateModule';
 import SyncModules from './syncModules';
+/**
+ * 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 state - Instance of StateModule containing configuration and state data.
+     */
     protected constructor(state: StateModule);
     /**
-     * fetchGet
-     *
-     * @param path
-     * @returns
+     * Performs an HTTP GET request.
+     * @param path - The path to append to the base URL.
+     * @return A promise resolving to the response data.
      */
     protected _fetchGet(path: string): Promise<any>;
     /**
-     * fetchPost
-     *
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     protected _fetchPost(path: string, data?: any): Promise<any>;
     /**
-     * fetchPut
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     protected _fetchPut(path: string, data: any): Promise<any>;
     /**
-     * _fetchDelete
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     protected _fetchDelete(path: string, data?: any): Promise<any>;
     /**
-     * refreshToken
-     *
-     * @returns
+     * Refreshes the authentication token.
+     * @return A promise resolving to a boolean indicating success or failure.
      */
     protected refreshToken(): Promise<boolean>;
     /**
-     * makeOptions
-     * @param method
-     * @param data
-     * @returns
+     * Creates options for HTTP requests.
+     * @param method - The HTTP method (GET, POST, etc.).
+     * @param data - Optional data to include in the request body.
+     * @return An object representing the request options.
      */
     private makeOptions;
     /**
-     * browserResponse
-     * @param path
-     * @param options
-     * @returns
+     * 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.
      */
     private browserResponse;
 }

package/dist/base/asyncModules.js

@@ -5,7 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const syncModules_1 = __importDefault(require("./syncModules"));
 // import { IError } from './utils';
+/**
+ * Abstract class AsyncModules extends SyncModules to provide asynchronous HTTP request functionalities.
+ */
 class AsyncModules extends syncModules_1.default {
+    /**
+     * Constructor initializes the AsyncModules with a given state.
+     * @param state - Instance of StateModule containing configuration and state data.
+     */
     constructor(state) {
         var _a;
         super(state);
@@ -15,25 +22,31 @@ class AsyncModules extends syncModules_1.default {
         this._https = (_a = state._https) !== null && _a !== void 0 ? _a : null;
     }
     /**
-     * fetchGet
-     *
-     * @param path
-     * @returns
+     * Performs an HTTP GET request.
+     * @param path - The path to append to the base URL.
+     * @return A promise resolving to the response data.
      */
     async _fetchGet(path) {
         const options = this.makeOptions('GET');
+        // console.log(this._NO_FETCH);
         if (!this._NO_FETCH) {
             return await this.browserResponse(path, options);
         }
         else {
             return new Promise((resolve, reject) => {
                 const req = this._https.get(this._getFullPath(path), options, (res) => {
-                    let data = '';
+                    let responseData = '';
                     res.on('data', (chunk) => {
-                        data += chunk;
+                        responseData += chunk;
                     });
                     res.on('end', () => {
-                        resolve(JSON.parse(data));
+                        try {
+                            resolve(JSON.parse(responseData));
+                            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                        }
+                        catch (error) {
+                            resolve(responseData);
+                        }
                     });
                 });
                 req.on('error', (error) => {
@@ -43,11 +56,10 @@ class AsyncModules extends syncModules_1.default {
         }
     }
     /**
-     * fetchPost
-     *
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     async _fetchPost(path, data) {
         const options = this.makeOptions('POST', data);
@@ -80,10 +92,10 @@ class AsyncModules extends syncModules_1.default {
         }
     }
     /**
-     * fetchPut
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     async _fetchPut(path, data) {
         const options = this.makeOptions('PUT', data);
@@ -98,7 +110,13 @@ class AsyncModules extends syncModules_1.default {
                         responseData += chunk;
                     });
                     res.on('end', () => {
-                        resolve(JSON.parse(responseData));
+                        try {
+                            resolve(JSON.parse(responseData));
+                            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                        }
+                        catch (error) {
+                            resolve(responseData);
+                        }
                     });
                 });
                 req.on('error', (error) => {
@@ -110,10 +128,10 @@ class AsyncModules extends syncModules_1.default {
         }
     }
     /**
-     * _fetchDelete
-     * @param path
-     * @param data
-     * @returns
+     * 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.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async _fetchDelete(path, data) {
@@ -124,12 +142,18 @@ class AsyncModules extends syncModules_1.default {
         else {
             return new Promise((resolve, reject) => {
                 const req = this._https.delete(this._getFullPath(path), options, (res) => {
-                    let data = '';
+                    let responseData = '';
                     res.on('data', (chunk) => {
-                        data += chunk;
+                        responseData += chunk;
                     });
                     res.on('end', () => {
-                        resolve(JSON.parse(data));
+                        try {
+                            resolve(JSON.parse(responseData));
+                            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                        }
+                        catch (error) {
+                            resolve(responseData);
+                        }
                     });
                 });
                 req.on('error', (error) => {
@@ -139,9 +163,8 @@ class AsyncModules extends syncModules_1.default {
         }
     }
     /**
-     * refreshToken
-     *
-     * @returns
+     * Refreshes the authentication token.
+     * @return A promise resolving to a boolean indicating success or failure.
      */
     async refreshToken() {
         const response = await fetch(this.state.url +
@@ -167,10 +190,10 @@ class AsyncModules extends syncModules_1.default {
         }
     }
     /**
-     * makeOptions
-     * @param method
-     * @param data
-     * @returns
+     * Creates options for HTTP requests.
+     * @param method - The HTTP method (GET, POST, etc.).
+     * @param data - Optional data to include in the request body.
+     * @return An object representing the request options.
      */
     makeOptions(method, data) {
         const options = {
@@ -197,17 +220,19 @@ class AsyncModules extends syncModules_1.default {
         return options;
     }
     /**
-     * browserResponse
-     * @param path
-     * @param options
-     * @returns
+     * 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.
      */
     async browserResponse(path, options) {
         try {
             const response = await fetch(this._getFullPath(path), options);
             if (response.ok) {
                 try {
-                    return await response.json();
+                    const text = await response.text();
+                    return text ? JSON.parse(text) : {};
+                    // return await response.json();
                 }
                 catch (e) {
                     return e;