oneentry 1.0.126 → 1.0.128

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

@@ -1,41 +1,43 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
+ * Interface for retrieving attributes based on markers and language codes.
  * @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.
- *
+ * @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 {
     /**
      * Fetches attributes by a specific marker.
-     *
+     * @handleName getAttributesByMarker
      * @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.
+     * @description This method fetches attributes by a specific marker.
      */
     getAttributesByMarker(marker: string, langCode: string): Promise<IAttributeSetsEntity[] | IError>;
     /**
      * Fetches a single attribute by its marker and the set marker.
-     *
+     * @handleName getSingleAttributeByMarkerSet
      * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method fetches a single attribute by its marker and the set marker.
      */
     getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode: string): Promise<IAttributesSetsEntity | IError>;
 }
 /**
- * Interface representing the structure of a list item.
- *
+ * Represents the structure of a list item.
  * @interface IListTitle
- *
  * @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 {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.
+ * @property {string | null} extended.value - The extended value, which can be a string or null. Example: "extra_value".
+ * @property {string | null} extended.type - The type of the extended value, which can be a string or null. Example: "color".
  * @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
  */
 interface IListTitle {
@@ -48,54 +50,50 @@ interface IListTitle {
     };
 }
 /**
- * AttributeType
- *
- * @type IAdminQuery
+ * Defines the possible values for attribute types used in the system.
  * @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';
 /**
- * Interface representing an attribute set entity.
- *
+ * Represents an attribute set entity.
  * @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 {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
-      }
-    ]
+   [
+     {
+       "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
-      }
-    }
+   {
+     "requiredValidator": {
+       "strict": true
+     },
+     "defaultValueValidator": {
+       "fieldDefaultValue": 11
+     }
+   }
  * @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization. Example:
-    {
-      "title": "My attribute"
-    }
+   {
+     "title": "My attribute"
+   }
  * @property {Record<string, any>} [additionalFields] - Additional fields for the attribute (optional).
- * @property {Record<string, any>} [settings] -  Additional attribute settings (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 {
@@ -110,36 +108,34 @@ interface IAttributesSetsEntity {
     settings?: Record<string, any>;
 }
 /**
- * Interface representing an attribute set entity.
- *
+ * Represents an attribute set entity.
  * @interface IAttributeSetsEntity
- *
  * @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 {object} 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 {object} properties - Additional properties associated with the attribute set, which can be of any type. Example:
+   {
+     "color": "red",
+     "size": "M"
+   }
+ * @property {string} 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.
  */
@@ -150,29 +146,27 @@ interface IAttributeSetsEntity {
     identifier: string;
     typeId: number;
     title: string;
-    schema: any;
+    schema: object;
     isVisible: boolean;
-    properties: any;
-    type: any;
+    properties: object;
+    type: string;
     position: number;
 }
 /**
- * Interface defining the structure of a response object for attribute sets.
- *
+ * Represents the response structure for attribute sets.
  * @interface IAttributesSetsResponse
- *
  * @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"
-    }
-  ]
+   [
+     {
+       "id": 1,
+       "identifier": "set1"
+     },
+     {
+       "id": 2,
+       "identifier": "set2"
+     }
+   ]
  * @description This interface defines the structure of a response object for attribute sets.
  */
 interface IAttributesSetsResponse {

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

@@ -1,45 +1,44 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, IOAuthSignUpData, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
+import type { IActiveSession, 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
+ * @augments 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.
-     *
      * @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": "login",
+            "value": "example@oneentry.cloud"
             },
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ],
           "formData": [
             {
-              "marker": "last_name",
-              "type": "string",
-              "value": "Name"
+            "marker": "last_name",
+            "type": "string",
+            "value": "Name"
             }
           ],
           "notificationData": {
@@ -48,92 +47,84 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
             "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:
+     * @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": "last_name",
-            "type": "string",
-            "value": "Name"
-          }
-      * @param {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+          },
           {
-            "email": "example@oneentry.cloud",
-            "phonePush": ["+99999999999"],
-            "phoneSMS": "+99999999999"
+            "marker": "password",
+            "value": "12345"
           }
+        ]
+     * @param {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.
+     * @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 (❗️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.
-     *
      * @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). 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.
+     * @returns {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).
-     *
      * @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} 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.
+     * @returns {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.
-     *
      * @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.
+     * @returns {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.
-     *
      * @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": "login",
+            "value": "example@oneentry.cloud"
             },
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ]
         }
@@ -145,53 +136,44 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
           }
         ]
      * @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.
+     * @param {string} body.authData[index].value  - The value for the authentication data. Example: "user@example.com".
+     * @returns {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, body: IAuthPostBody): Promise<IAuthEntity | IError>;
     /**
      * 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.
+     * @returns {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 account logout.
-     *
      * @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.
+     * @returns {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>;
     /**
      * Logout of user account on all devices.
-     *
      * @handleName logoutAll
-     *
      * @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.
+     * @returns {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.
-     *
      * @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".
@@ -199,52 +181,44 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * @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.
+     * @returns {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, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
     /**
      * Get all auth providers objects.
-     *
      * @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.
+     * @returns {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.
+     * @returns {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.
      */
     getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
     /**
      * 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.
+     * @returns {IActiveSession[]} 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>;
+    getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | 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:
         {
@@ -255,7 +229,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ISignUpEntity} Returns a user object.
+     * @returns {ISignUpEntity} Returns a user object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User registration (authorization) via OAUTH.
      */