oneentry 1.0.123 → 1.0.125

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -1,21 +1,42 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents an interface object of AttributesSets Api.
+ * @interface IAttributesSets
  *
  * @property {function} getAttributesByMarker - Get all attributes with data from the attribute sets.
  * @property {function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
+ *
+ * @description This interface defines methods for retrieving attributes based on markers and language codes.
  */
 interface IAttributesSets {
-    getAttributesByMarker(marker: string, langCode: string): Promise<Array<IAttributesSetsEntity> | IError>;
+    /**
+     * Fetches attributes by a specific marker.
+     *
+     * @param {string} marker - The marker used to identify the attribute set. Example: "productAttributes".
+     * @param {string} [langCode] - The language code for localization purposes. Default: 'en_US'.
+     * @returns {IAttributeSetsEntity[]} A promise that resolves to an array of attribute set entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getAttributesByMarker(marker: string, langCode: string): Promise<IAttributeSetsEntity[] | IError>;
+    /**
+     * Fetches a single attribute by its marker and the set marker.
+     *
+     * @param {string} attributeMarker - The marker identifying the attribute. Example: "color".
+     * @param {string} setMarker - The marker identifying the attribute set. Example: "productAttributes".
+     * @param {string} [langCode] - The language code for localization purposes. Default: "en_US".
+     * @returns {IAttributesSetsEntity} A promise that resolves to an attribute set entity or an error.
+     */
     getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode: string): Promise<IAttributesSetsEntity | IError>;
 }
 /**
- * Represents an interface object of IListTitle.
+ * Interface representing the structure of a list item.
+ *
+ * @interface IListTitle
  *
- * @property {string} title - The title or name associated with the list item.
- * @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context.
- * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable.
+ * @property {string} title - The title or name associated with the list item. Example: "Item Name".
+ * @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context. Example: 42
+ * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable. Example: 1
  * @property {object} extended - An object containing additional properties or metadata related to the list item. This could include any extra details that extend the basic information.
+ * @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
  */
 interface IListTitle {
     title: string;
@@ -26,63 +47,136 @@ interface IListTitle {
         type: string | null;
     };
 }
+/**
+ * AttributeType
+ *
+ * @type IAdminQuery
+ * @type {AttributeType}
+ * @description This type defines the possible values for attribute types used in the system.
+ */
 type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' | 'float' | 'dateTime' | 'date' | 'time' | 'file' | 'image' | 'groupOfImages' | 'radioButton' | 'list' | 'button';
 /**
- * Represents a template entity object.
+ * Interface representing an attribute set entity.
  *
- * @interface
- * @property {AttributeType} type - Attribute type.
- * @property {string} marker - Textual identifier of the attribute (marker).
- * @property {number} position - Position number for sorting.
- * @property {Record<string, any>} validators - Set of validators for validation.
- * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
- * @property {Array<Record<string, any>>} listTitles - Array of values (with extended data) for list and radioButton attributes.
- * @property {Array<Record<string, any>>} settings -  Additional attribute settings (optional).
+ * @interface IAttributesSetsEntity
  *
+ * @property {AttributeType} type - Attribute type. Example: "string", "text", "integer", "etc".
+ * @property {any} [value] - Value of the attribute, which can be of any type.
+ * @property {string} marker - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
+ * @property {number} position - Position number for sorting. Example: 1
+ * @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes. Example:
+    [
+      {
+        "title": "red",
+        "value": 1,
+        "position": 1,
+        "extendedValue": null,
+        "extendedValueType": null
+      },
+      {
+        "title": "yellow",
+        "value": 2,
+        "position": 2,
+        "extendedValue": null,
+        "extendedValueType": null
+      }
+    ]
+ * @property {Record<string, any>} [validators] - Set of validators for validation. Example:
+    {
+      "requiredValidator": {
+        "strict": true
+      },
+      "defaultValueValidator": {
+        "fieldDefaultValue": 11
+      }
+    }
+ * @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization. Example:
+    {
+      "title": "My attribute"
+    }
+ * @property {Record<string, any>} [additionalFields] - Additional fields for the attribute (optional).
+ * @property {Record<string, any>} [settings] -  Additional attribute settings (optional).
+ * @description This interface defines the structure of an attribute set entity, including its type, marker, position, validators, localization information, list titles, additional fields, and settings.
  */
 interface IAttributesSetsEntity {
     type: AttributeType;
+    value?: any;
     marker: string;
     position: number;
-    validators: object;
-    localizeInfos: Record<string, any>;
-    listTitles: Array<IListTitle> | Record<string, any>;
+    listTitles?: IListTitle[] | Record<string, any>;
+    validators?: Record<string, any>;
+    localizeInfos: ILocalizeInfo;
     additionalFields?: Record<string, any>;
     settings?: Record<string, any>;
 }
 /**
- * Represents an interface object of IAttributeSetsEntity.
+ * Interface representing an attribute set entity.
+ *
+ * @interface IAttributeSetsEntity
  *
- * @property {number} id - The unique identifier of the attribute set entity.
- * @property {string} identifier - A string that uniquely identifies the attribute set.
- * @property {boolean} isVisible - Indicates whether the attribute set is visible or not.
- * @property {any} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data.
- * @property {string} title - The title or name of the attribute set.
- * @property {any} type - The type of the attribute set, which could be a specific classification or category.
- * @property {number} typeId - The numerical identifier representing the type of the attribute set.
- * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Consider using Date for better date handling.
- * @property {number} version - The version number of the attribute set, used for tracking changes or updates.
+ * @property {number} id - The unique identifier of the attribute set entity. Example: 123.
+ * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
+ * @property {number} version - The version number of the attribute set, used for tracking changes or updates. Example: 1.
+ * @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
+ * @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
+ * @property {string} title - The title or name of the attribute set. Example: "Product Attributes".
+ * @property {any} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data. Example:
+    {
+      "attribute1": {
+        "id": 1,
+        "type": "string",
+        "isPrice": false,
+        "original": true,
+        "identifier": "string",
+        "localizeInfos": {
+          "en_US": { "title": "String" }
+        }
+      }
+    }
+ * @property {boolean} isVisible - Indicates whether the attribute set is visible or not. Example: true.
+ * @property {any} properties - Additional properties associated with the attribute set, which can be of any type. Example:
+    {
+      "color": "red",
+      "size": "M"
+    }
+ * @property {any} type - The type of the attribute set, which could be a specific classification or category. Example: "product", "user", "etc".
+ * @property {number} position - The position number for sorting the attribute set. Example: 1.
+ * @description This interface defines the structure of an attribute set entity.
  */
 interface IAttributeSetsEntity {
     id: number;
+    updatedDate: string;
+    version: number;
     identifier: string;
-    isVisible: boolean;
-    position: number;
-    schema: any;
+    typeId: number;
     title: string;
+    schema: any;
+    isVisible: boolean;
+    properties: any;
     type: any;
-    typeId: number;
-    updatedDate: string;
-    version: number;
+    position: number;
 }
 /**
- * Represents an interface object of IAttributesSetsResponce.
+ * Interface defining the structure of a response object for attribute sets.
+ *
+ * @interface IAttributesSetsResponse
  *
- * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity
- * @property {number} total - total items
+ * @property {number} total - Total items. Example: 100.
+ * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities. Example:
+  [
+    {
+      "id": 1,
+      "identifier": "set1"
+    },
+    {
+      "id": 2,
+      "identifier": "set2"
+    }
+  ]
+ * @description This interface defines the structure of a response object for attribute sets.
  */
 interface IAttributesSetsResponse {
-    items: IAttributeSetsEntity[];
     total: number;
+    items: IAttributeSetsEntity[];
 }
 export type { AttributeType, IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse, IListTitle, };

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

@@ -1,142 +1,263 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
+import type { IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, IOAuthSignUpData, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
 /**
  * Controllers for working with auth services.
+ *
  * @handle /api/content/users-auth-providers
+ * @class AuthProviderApi
+ * @extends AsyncModules
+ * @implements {IAuthProvider}
+ *
+ * @description This class provides methods for user registration, authentication, and management of authentication providers.
  */
 export default class AuthProviderApi extends AsyncModules implements IAuthProvider {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * User registration
-     *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {ISignUpData} [body] - Request body
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * const body = {
-     *   "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"
-     *   }
-     * }
+     * User registration.
+     *
+     * @handleName signUp
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {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"
+          }
+        }
+      * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
+      * @param {{ 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"
+            }
+          ]
+      * @param {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"
+          }
+      * @param {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+          {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          }
+     * @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 (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
      */
     signUp(marker: string, body: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
     /**
-     * Getting a user activation code. The code is returned via the appropriate user notification method
+     * Getting a user activation code. The code is returned via the appropriate user notification method.
+     *
+     * @handleName generateCode
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [eventIdentifier] - Text identifier of the event object for which the code is generated
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @return {void} Returns void if the code is successfully generated, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Obtaining a code to activate the user.
      */
     generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [eventIdentifier] - Text identifier of the event object for which the code is generated
-     * @param {string} [code] - Service code
+     * @handleName checkCode
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} code - Service code. Example: "123456".
+     * @return {boolean} Returns true if the code is correct, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Checking the user activation code
      */
     checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * User activate.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} userIdentifier - The text identifier of the user's object (user login)
-     * @param {string} code - Service code
+     * @handleName activateUser
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} code - Service code. Example: "123456".
+     * @return {boolean} Returns true if the user was successfully activated, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User activation.
      */
     activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
     /**
-     * User authorization
-     *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {IAuthPostBody} data - Array of objects contains auth information
-     *
-     * @example
-     * const data = {
-     *   authData: [
-     *     {
-     *       marker: "login",
-     *       value: "test"
-     *     },
-     *     {
-     *       marker: "password",
-     *       value: "12345"
-     *     }
-     *   ]
-     * }
+     * User authorization.
+     *
+     * @handleName auth
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} body - Objects contains auth information. Example:
+        {
+          "authData": [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ]
+        }
+     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+        [
+          {
+            "marker": "login",
+            "value": "user@example.com"
+          }
+        ]
+     * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
+     * @param {string} body.authData[index].value - The value for the authentication data. Example: "user@example.com".
+     *
+     * @return {IAuthEntity} Returns an auth entity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User authorization.
      */
-    auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity | IError>;
+    auth(marker: string, body: IAuthPostBody): Promise<IAuthEntity | IError>;
     /**
-     * Refresh token
+     * Refresh token.
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [token] - Refresh token
+     * @handleName refresh
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @return {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User token refresh.
      */
     refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
     /**
-     * User logout.
+     * User account logout.
      *
-     * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} token - Refresh token
+     * @handleName logout
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     logout(marker: string, token: string): Promise<boolean | IError>;
     /**
-     * Change password
+     * Logout of user account on all devices.
+     *
+     * @handleName logoutAll
      *
-     * @param {string} [marker] - The text identifier of the authorization provider. Example - email
-     * @param {string} [userIdentifier] - The text identifier of the user's object (user login)
-     * @param {string} [type] - Operation type (1 - for changing password, 2 - for recovery)
-     * @param {string} [code] - Service code
-     * @param {string} [newPassword] - New password
-     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     */
+    logoutAll(marker: string): Promise<boolean | IError>;
+    /**
+     * Change password.
      *
-     * @example
-     * await AuthProvider.changePassword('email', userIdentifier, type, code, newPassword, repeatPassword);
+     * @handleName changePassword
      *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
+     * @param {string} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
+     * @param {string} code - Service code. Example: "123456".
+     * @param {string} newPassword - New password. Example: "newPassword123".
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @return {boolean} Returns true if the password was successfully changed, or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User password change (only for tariffs with account activation and the Activation feature enabled).
      */
-    changePassword(marker: string, userIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
+    changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
     /**
-     * Get all auth providers objects
+     * Get all auth providers objects.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getAuthProviders
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @return {IAuthProvidersEntity[]} Returns an array of auth provider objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting all objects of authorization providers.
+     */
+    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<IAuthProvidersEntity[] | IError>;
+    /**
+     * Get one auth provider object by marker.
+     *
+     * @handleName getAuthProviderByMarker
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting a single authorization provider object by marker.
      */
-    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity> | IError>;
+    getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
     /**
-     * Get one auth provider object by marker
+     * Getting active user sessions data.
+     *
+     * @handleName getActiveSessions
+     *
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Getting a single authorization provider object by marker.
+     */
+    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 {string} [langCode] - Optional parameter language code. Default "en_US"
+     * @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.
      */
-    getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
+    oauthSignUp(marker: string, body: IOAuthSignUpData, langCode?: string): Promise<IAuthEntity | IError>;
 }