oneentry 1.0.123 → 1.0.125

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -1,65 +1,118 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
- * Represents an interface object of Templates Preview Api.
+ * @interface ITemplatesPreview
  *
- * @interface
  * @property {function} getTemplatesPreview - Get all template objects.
  * @property {function} getTemplatesPreviewById - Get one template object by id.
  * @property {function} getTemplatesPreviewByMarker - Get one template object by marker.
+ *
+ * @description This interface defines methods for retrieving template previews in the system, including fetching all previews, specific previews by ID, and by marker.
  */
 interface ITemplatesPreview {
-    getTemplatePreviews(langCode: string): Promise<Array<ITemplatesPreviewEntity> | IError>;
-    getTemplatePreviewById(id: number, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
+    /**
+     * Retrieves all template preview objects.
+     *
+     * @param {string} langCode - Language code for localization. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity[]} A promise resolving to an array of template preview entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getTemplatePreviews(langCode: string): Promise<ITemplatesPreviewEntity[] | IError>;
+    /**
+     * Retrieves a specific template preview object by its marker.
+     *
+     * @param {string} marker - The marker of the template preview. Example: "template_12345".
+     * @param {string} [langCode] - Language code for localization. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity} A promise resolving to the template preview entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getTemplatePreviewByMarker(marker: string, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
 }
 /**
- * Represents a template preview entity object.
+ * @interface ITemplatesPreviewEntity
  *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {object} proportion - Object contains info by proportion template preview.
- * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
- * @property {number} position - The position of the object.
- * @property {AttributeType} attributeValues - Attribute values from index.
- * @property {string} attributeSetIdentifier - Text identifier used for a set of attributes
+ * @property {number} id - The unique identifier of the position. Example: 3.
+ * @property {string} title - The name of the template preview. Example: "Product Template"..
+ * @property {object} proportions - Object contains info by proportions template preview. Example:
+    {
+      "default": {
+        "horizontal": {
+          "width": 234,
+          "height": 324,
+          "alignmentType": "middleBottom"
+        },
+        "vertical": {
+          "width": 2,
+          "height": 3,
+          "alignmentType": "leftTop"
+        },
+        "square": {
+          "side": 3,
+          "alignmentType": "leftTop"
+        }
+      }
+    }
+ * @property {string} identifier - The textual identifier for the record field. Example: "preview-templates"
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {AttributeType} attributeValues - Attribute values from index. Example: {}
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string | null} [attributeSetIdentifier] - Text identifier used for a set of attributes. Example: "attribute_set_1".
+ * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview. Example:
+    {
+      "width": 234,
+      "height": 324,
+      "alignmentType": "middleBottom"
+    }
+ * @property {IProportion | null} proportions.vertical - Vertical proportion of the template preview. Example:
+    {
+      "width": 2,
+      "height": 3,
+      "alignmentType": "leftTop"
+    }
+ * @property {ISquare} proportions.square - Square proportion of the template preview. Example:
+    {
+      "side": 3,
+      "alignmentType": "leftTop"
+    }
+ * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
     id: number;
-    version: number;
-    identifier: string;
-    attributeValues: AttributeType;
-    attributeSetIdentifier?: string | null;
+    title: string;
     proportions: {
-        horizontal: IProportion | null;
-        vertical: IProportion | null;
-        square: ISquare;
+        default: {
+            horizontal: IProportion | null;
+            vertical: IProportion | null;
+            square: ISquare;
+        };
     };
-    title: string;
+    identifier: string;
+    version: number;
+    attributeValues: AttributeType;
     position: number;
+    isUsed: boolean;
+    attributeSetIdentifier?: string | null;
 }
 /**
- * IProportion
+ * @interface IProportion
  *
- * @property {string | number | null} width -
- * @property {string | number | null} height -
- * @property {string} marker -
- * @property {string} alignmentType -
+ * @property {string | number | null} width - width of the template preview. Example: 100.
+ * @property {string | number | null} height - height of the template preview. Example: 200.
+ * @property {string} alignmentType - alignment type of the template preview. Example: "center".
+ * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
     width: number | null;
     height: number | null;
-    marker: string;
     alignmentType: string;
 }
 /**
- * ISquare
- * @property {string} marker -
- * @property {number | string} side -
- * @property {string} alignmentType -
+ * @interface ISquare
+ *
+ * @property {number | string} side - Side length of the square template preview, can be a number or string. Example: 100.
+ * @property {string} alignmentType - Alignment type of the square template preview. Example: "center".
+ * @description Represents a square proportion object used in template previews.
  */
 interface ISquare {
-    marker: string;
     side: number | string;
     alignmentType: string;
 }

package/dist/users/usersApi.d.ts

@@ -5,6 +5,7 @@ import type { IUserBody, IUserEntity, IUsers } from './usersInterfaces';
 /**
  * Controllers for working with users
  * @handle /api/content/users
+ * @description This module provides various methods to manage users, including creating, retrieving, updating, and deleting user data. It requires proper authorization to access these endpoints.
  */
 export default class UsersApi extends AsyncModules implements IUsers {
     protected state: StateModule;
@@ -13,63 +14,86 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * Getting the data of an authorized user.
      *
-     * @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.
+     * @handleName getUser
      *
-     * @param {string} [langCode] - lang code.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Getting the data of an authorized user. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updating a single user 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.
-     *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
+     * @handleName updateUser
      *
-     * @example
-     * {
-     *   "formIdentifier": "reg",
-     *   "authData": [
-     *     {
-     *       "marker": "password",
-     *       "value": "12345"
-     *     }
-     *   ],
-     *   "formData": {
-     *         "marker": "last_name",
-     *         "type": "string",
-     *         "value": "Username"
-     *   },
-     *   "notificationData": {
-     *     "email": "example@oneentry.cloud",
-     *     "phonePush": ["+99999999999"],
-     *     "phoneSMS": "+99999999999"
-     *   },
-     *   "state": {}
-     * }
+     * @param {IUserBody} body - Request body. Example:
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ],
+          "formData": {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          },
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Updating a single user object. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
-     * Delete a single user object.
+     * Archiving one user object (marked for deletion).
      *
-     * @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.
+     * @handleName archiveUser
      *
+     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Archiving one user object (marked for deletion). This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    deleteUser(): Promise<boolean | IError>;
+    archiveUser(): Promise<boolean | IError>;
     /**
-     * Adds FCM token for sending Push notification.
+     * Delete a single user.
+     *
+     * @handleName deleteUser
      *
+     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @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.
+     */
+    deleteUser(): Promise<boolean | IError>;
+    /**
+     * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
+     *
+     * @handleName addFCMToken
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @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.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
-     * Delete FCM token.
+     * Deletes an FCM (Firebase Cloud Messaging) token.
      *
-     * @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.
+     * @handleName deleteFCMToken
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @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.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }

package/dist/users/usersApi.js

@@ -7,6 +7,7 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users
  * @handle /api/content/users
+ * @description This module provides various methods to manage users, including creating, retrieving, updating, and deleting user data. It requires proper authorization to access these endpoints.
  */
 class UsersApi extends asyncModules_1.default {
     constructor(state) {
@@ -16,9 +17,12 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Getting the data of an authorized user.
      *
-     * @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.
+     * @handleName getUser
      *
-     * @param {string} [langCode] - lang code.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Getting the data of an authorized user. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getUser(langCode = this.state.lang) {
         const result = await this._fetchGet(`/me?langCode=${langCode}`);
@@ -27,32 +31,33 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Updating a single user 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.
-     *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
+     * @handleName updateUser
      *
-     * @example
-     * {
-     *   "formIdentifier": "reg",
-     *   "authData": [
-     *     {
-     *       "marker": "password",
-     *       "value": "12345"
-     *     }
-     *   ],
-     *   "formData": {
-     *         "marker": "last_name",
-     *         "type": "string",
-     *         "value": "Username"
-     *   },
-     *   "notificationData": {
-     *     "email": "example@oneentry.cloud",
-     *     "phonePush": ["+99999999999"],
-     *     "phoneSMS": "+99999999999"
-     *   },
-     *   "state": {}
-     * }
+     * @param {IUserBody} body - Request body. Example:
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ],
+          "formData": {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          },
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Updating a single user object. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async updateUser(body, langCode = this.state.lang) {
         if (!('langCode' in body))
@@ -65,32 +70,54 @@ class UsersApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Delete a single user object.
+     * Archiving one user object (marked for deletion).
      *
-     * @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.
+     * @handleName archiveUser
      *
+     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Archiving one user object (marked for deletion). This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    async deleteUser() {
+    async archiveUser() {
         const result = await this._fetchDelete('/me');
         return result;
     }
     /**
-     * Adds FCM token for sending Push notification.
+     * Delete a single user.
+     *
+     * @handleName deleteUser
      *
+     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @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.
+     */
+    async deleteUser() {
+        const result = await this._fetchDelete('/me/account');
+        return result;
+    }
+    /**
+     * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
+     *
+     * @handleName addFCMToken
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @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.
      */
     async addFCMToken(token) {
         const result = await this._fetchPost(`/me/fcm-token/${token}`);
         return result;
     }
     /**
-     * Delete FCM token.
+     * Deletes an FCM (Firebase Cloud Messaging) token.
      *
-     * @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.
+     * @handleName deleteFCMToken
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @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.
      */
     async deleteFCMToken(token) {
         const result = await this._fetchDelete(`/me/fcm-token/${token}`);

package/dist/users/usersInterfaces.d.ts

@@ -1,35 +1,157 @@
+import type { IFormConfig } from 'forms/formsInterfaces';
 import type { IAuthFormData } from '../auth-provider/authProvidersInterfaces';
 import type { IError } from '../base/utils';
-import type { FormDataType } from '../formsData/formsDataInterfaces';
+import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
- * Represents a interface object of Users Api.
+ * Interface representing user-related operations.
  *
- * @property {function} subscribeByMarker - Getting the data of an authorized user.
- * @property {function} unsubscribeByMarker - Updating a single user object.
- * @property {function} addFCMToken - Adds FCM token for sending Push notification.
- * @property {function} deleteFCMToken - Delete FCM token.
- * @property {function} setAccessToken - Only for custom authorization. An intermediate method for setting up an access token.
+ * @interface IUsers
+ *
+ * @property {function} getUser - Retrieves the data of an authorized user, optionally based on a language code.
+ * @property {function} updateUser - Updates the user's data with the provided information.
+ * @property {function} archiveUser - Archiving one user object (marked for deletion).
+ * @property {function} deleteUser - Deletes the user from the system.
+ * @property {function} addFCMToken - Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
+ * @property {function} deleteFCMToken - Deletes an existing FCM token.
+ * @description This interface defines methods for managing user data and handling Firebase Cloud Messaging tokens.
  */
 interface IUsers {
+    /**
+     * Retrieves the data of an authorized user.
+     *
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @return {IUserEntity} A promise resolving to the user entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Retrieves the data of an authorized user.
+     */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
+    /**
+     * Updates the user's data.
+     *
+     * @param {IUserBody} data - The new data for the user. Example:
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ],
+          "formData": {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          },
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Updates the user's data.
+     */
     updateUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Archiving one user object (marked for deletion).
+     *
+     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Deletes the user from the system.
+     */
+    archiveUser(): Promise<boolean | IError>;
+    /**
+     * Deletes the user from the system.
+     *
+     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Deletes the user from the system.
+     */
+    deleteUser(): Promise<boolean | IError>;
+    /**
+     * Adds an FCM token for sending push notifications.
+     *
+     * @param {string} token - The FCM token to be added. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Adds an FCM token for sending push notifications.
+     */
     addFCMToken(token: string): Promise<boolean | IError>;
+    /**
+     * Deletes an existing FCM token.
+     *
+     * @param {string} token - The FCM token to be deleted. Example: "fcm_token_1234567890abcdefg".
+     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description Deletes an existing FCM token.
+     */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }
 /**
- * IUserEntity
+ * @interface IUserEntity
+ *
+ * @property {number} id - Object identifier. Example: 12345.
+ * @property {string} identifier - Text identifier for record field. Example: "user_12345".
+ * @property {string} authProviderIdentifier - Text identifier of the authentication provider. Example: "auth_provider_12345".
+ * @property {FormDataType[]} formData - Array of data form objects with the following values. Example:
+    [
+      {
+        "marker": "last_name",
+        "type": "string",
+        "value": "Username"
+      }
+    ]
+ * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
+ * @property {any[]} groups - Array of user groups. Example: ["group_1", "group_2"].
+ * @property {any} state - Object containing additional user state information. Example: {"key": "value"}
+ * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
  */
 interface IUserEntity {
     id: number;
     identifier: string;
-    formData: Array<FormDataType>;
-    formIdentifier: string;
     authProviderIdentifier: string;
-    groups: Array<string>;
+    formData: FormDataType[];
+    formIdentifier: string;
+    groups: Array<string | number>;
     state: Record<string, any>;
+    moduleFormConfigs: IFormConfig;
 }
 /**
- * IUserBody
+ * @interface IUserBody
+ *
+ * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
+ * @property {string} [langCode] - Language code for localization. Default: "en_US".
+ * @property {{ marker: string; value: string }[]} [authData] - Array of authentication data objects with markers and values. Example:
+    [
+      {
+        "marker": "password",
+        "value": "12345"
+      }
+    ]
+ * @property {IAuthFormData | IAuthFormData[]} [formData] - Form data object or array of form data objects. Example:
+    [
+      {
+        "marker": "first_name",
+        "type": "string",
+        "value": "John"
+      },
+      {
+        "marker": "last_name",
+        "type": "string",
+        "value": "Doe"
+      }
+    ]
+ * @property {object} [notificationData] - Object containing notification data, including email and phone information. Example:
+    {
+      "email": "example@oneentry.cloud",
+      "phonePush": ["+99999999999"],
+      "phoneSMS": "+99999999999"
+    }
+ * @property {any} [state] - Object containing additional state information. Example: {"key": "value"}
+ * @description Represents the body of a user request, including form identifiers, authentication data, form data, notification data, and state information.
  */
 interface IUserBody {
     formIdentifier: string;
@@ -38,10 +160,10 @@ interface IUserBody {
         marker: string;
         value: string;
     }>;
-    formData?: IAuthFormData | Array<IAuthFormData>;
+    formData?: IAuthFormData | IAuthFormData[];
     notificationData?: {
         email: string;
-        phonePush: Array<string>;
+        phonePush: string[];
         phoneSMS: string;
     };
     state?: Record<string, any>;

package/dist/web-socket/wsApi.d.ts

@@ -11,13 +11,12 @@ export default class WsApi extends AsyncModules implements IWS {
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * Creates an instance of an object Socket.io with a connection.
-     * This method requires mandatory user authorization
+     * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      *
-     * @example
-     * const socket = WS.connect()
+     * @handleName connect
      *
-     * socket.on('my_event', callback)
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      */
     connect(): Socket;
 }

package/dist/web-socket/wsApi.js

@@ -15,13 +15,12 @@ class WsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/ws';
     }
     /**
-     * Creates an instance of an object Socket.io with a connection.
-     * This method requires mandatory user authorization
+     * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      *
-     * @example
-     * const socket = WS.connect()
+     * @handleName connect
      *
-     * socket.on('my_event', callback)
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      */
     connect() {
         if (!this.state.accessToken) {