oneentry 1.0.142 → 1.0.143

package/dist/users/usersApi.d.ts

@@ -0,0 +1,143 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IUserBody, IUserEntity, IUsersApi } 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 IUsersApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for UsersApi class.
+     * @param {StateModule} state - The state module containing necessary information for API calls.
+     * @description Initializes the UsersApi class with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Getting the data of an authorized user.
+     * @handleName getUser
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserEntity | IError>} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getUser(langCode?: string): Promise<IUserEntity | IError>;
+    /**
+     * Updating a single user object.
+     * @handleName updateUser
+     * @param {IUserBody} body - Request body.
+     * @example
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "email_reg",
+              "value": "your-email@oneentery.cloud"
+            },
+            {
+              "marker": "password_reg",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Username"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.authData - Contains authentication credentials for the user. Example:
+     * @example
+        [
+          {
+            "marker": "email_reg",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password_reg",
+            "value": "password"
+          }
+        ]
+     * @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
+     * @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
+     * @param {string} body.formData - Contains additional data for the user.
+     * @example
+        [
+          {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
+     * @param {string} body.formData[].type - The type of the field. Example: "string".
+     * @param {string} body.formData[].value - The value of the field. Example: "Username".
+     * @param {string} body.notificationData - The notification data.
+     * @example
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} body.notificationData.email - The email address of the user. Example: "example@oneentry.cloud".
+     * @param {string} body.notificationData.phonePush - An array of phone numbers for push notifications. Example: ["+99999999999"].
+     * @param {string} body.notificationData.phoneSMS - The phone number for SMS notifications. Example: "+99999999999".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<boolean | IError>} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     */
+    updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Archiving one user object (marked for deletion).
+     * @handleName archiveUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    archiveUser(): Promise<boolean | IError>;
+    /**
+     * Delete a single user.
+     * @handleName deleteUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider 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 - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    addFCMToken(token: string): Promise<boolean | IError>;
+    /**
+     * Deletes an FCM (Firebase Cloud Messaging) token.
+     * @handleName deleteFCMToken
+     * @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".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    deleteFCMToken(token: string): Promise<boolean | IError>;
+}

package/dist/users/usersApi.js

@@ -0,0 +1,171 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const usersSchemas_1 = require("./usersSchemas");
+/**
+ * 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 for UsersApi class.
+     * @param {StateModule} state - The state module containing necessary information for API calls.
+     * @description Initializes the UsersApi class with the provided state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/users';
+    }
+    /**
+     * Getting the data of an authorized user.
+     * @handleName getUser
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserEntity | IError>} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async getUser(langCode = this.state.lang) {
+        const result = await this._fetchGet(`/me?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, usersSchemas_1.UserResponseSchema);
+        return this._normalizeData(validated);
+    }
+    /**
+     * Updating a single user object.
+     * @handleName updateUser
+     * @param {IUserBody} body - Request body.
+     * @example
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "email_reg",
+              "value": "your-email@oneentery.cloud"
+            },
+            {
+              "marker": "password_reg",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Username"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.authData - Contains authentication credentials for the user. Example:
+     * @example
+        [
+          {
+            "marker": "email_reg",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password_reg",
+            "value": "password"
+          }
+        ]
+     * @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
+     * @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
+     * @param {string} body.formData - Contains additional data for the user.
+     * @example
+        [
+          {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
+     * @param {string} body.formData[].type - The type of the field. Example: "string".
+     * @param {string} body.formData[].value - The value of the field. Example: "Username".
+     * @param {string} body.notificationData - The notification data.
+     * @example
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} body.notificationData.email - The email address of the user. Example: "example@oneentry.cloud".
+     * @param {string} body.notificationData.phonePush - An array of phone numbers for push notifications. Example: ["+99999999999"].
+     * @param {string} body.notificationData.phoneSMS - The phone number for SMS notifications. Example: "+99999999999".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<boolean | IError>} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     */
+    async updateUser(body, langCode = this.state.lang) {
+        if (!('langCode' in body))
+            body['langCode'] = langCode;
+        const result = await this._fetchPut('/me', this._normalizePostBody(body, langCode));
+        const validated = this._validateResponse(result, usersSchemas_1.UpdateUserResponseSchema);
+        return validated;
+    }
+    /**
+     * Archiving one user object (marked for deletion).
+     * @handleName archiveUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async archiveUser() {
+        const result = await this._fetchDelete('/me');
+        return result;
+    }
+    /**
+     * Delete a single user.
+     * @handleName deleteUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider 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 - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async addFCMToken(token) {
+        const result = await this._fetchPost(`/me/fcm-token/${token}`);
+        return result;
+    }
+    /**
+     * Deletes an FCM (Firebase Cloud Messaging) token.
+     * @handleName deleteFCMToken
+     * @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".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async deleteFCMToken(token) {
+        const result = await this._fetchDelete(`/me/fcm-token/${token}`);
+        return result;
+    }
+}
+exports.default = UsersApi;

package/dist/users/usersInterfaces.d.ts

@@ -0,0 +1,229 @@
+import type { IAuthData, IAuthFormData } from '../auth-provider/authProvidersInterfaces';
+import type { IError } from '../base/utils';
+import type { IFormConfig } from '../forms/formsInterfaces';
+import type { FormDataType } from '../forms-data/formsDataInterfaces';
+/**
+ * Interface representing user-related operations.
+ * @interface IUsersApi
+ * @description This interface defines methods for managing user data and handling Firebase Cloud Messaging tokens.
+ */
+interface IUsersApi {
+    /**
+     * Retrieves the data of an authorized user.
+     * @handleName getUser
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {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 This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getUser(langCode?: string): Promise<IUserEntity | IError>;
+    /**
+     * Updating a single user object.
+     * @handleName updateUser
+     * @param {IUserBody} body - Request body.
+     * @example
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "email_reg",
+              "value": "your-email@oneentery.cloud"
+            },
+            {
+              "marker": "password_reg",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Username"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.authData - Contains authentication credentials for the user. Example:
+     * @example
+        [
+          {
+            "marker": "email_reg",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password_reg",
+            "value": "password"
+          }
+        ]
+     * @param {string} body.authData[index].marker - Identifies the field being used. Example: "email_reg".
+     * @param {string} body.authData[index].value - Contains the value of the field. Example: "example@oneentry.cloud".
+     * @param {string} body.formData - Contains additional data for the user.
+     * @example
+        [
+          {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          }
+        ]
+     * @param {string} body.formData[index].marker - The marker of the field. Example: "last_name".
+     * @param {string} body.formData[index].type - The type of the field. Example: "string".
+     * @param {string} body.formData[index].value - The value of the field. Example: "Username".
+     * @param {string} body.notificationData - The notification data.
+     * @example
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} body.notificationData.email - The email address of the user. Example: "example@oneentry.cloud".
+     * @param {string} body.notificationData.phonePush - An array of phone numbers for push notifications. Example: ["+99999999999"].
+     * @param {string} body.notificationData.phoneSMS - The phone number for SMS notifications. Example: "+99999999999".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {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 This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     */
+    updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Archiving one user object (marked for deletion).
+     * @handleName archiveUser
+     * @returns {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 This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    archiveUser(): Promise<boolean | IError>;
+    /**
+     * Deletes the user from the system.
+     * @handleName deleteUser
+     * @returns {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 This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    deleteUser(): Promise<boolean | IError>;
+    /**
+     * Adds an FCM token for sending push notifications.
+     * @handleName addFCMToken
+     * @param {string} token - The FCM token to be added. Example: "fcm_token_1234567890abcdefg".
+     * @returns {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 This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    addFCMToken(token: string): Promise<boolean | IError>;
+    /**
+     * Deletes an existing FCM token.
+     * @handleName deleteFCMToken
+     * @param {string} token - The FCM token to be deleted. Example: "fcm_token_1234567890abcdefg".
+     * @returns {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 This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    deleteFCMToken(token: string): Promise<boolean | IError>;
+}
+/**
+ * @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 {string} total - Total value. Example: "0".
+ * @property {Array<string | number>} groups - Array of user groups.
+ * @example
+    [
+      "group_1",
+      "group_2"
+    ]
+ * @property {object} state - Object containing additional user state information.
+ * @example
+    {
+      "key": "value"
+    }
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Optional array of form configuration objects associated with the user.
+ * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
+ */
+interface IUserEntity {
+    id: number;
+    identifier: string;
+    authProviderIdentifier: string;
+    formData: FormDataType[];
+    formIdentifier: string;
+    total: string;
+    groups: Array<string | number>;
+    state: Record<string, any>;
+    moduleFormConfigs?: Array<IFormConfig>;
+}
+/**
+ * @interface IUserBody
+ * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
+ * @property {string} [langCode] - Language code for localization. Default: "en_US".
+ * @property {IAuthData[]} [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 {object} [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;
+    langCode?: string;
+    authData?: IAuthData[];
+    formData?: IAuthFormData | IAuthFormData[];
+    notificationData?: {
+        email: string;
+        phonePush: string[];
+        phoneSMS?: string;
+    };
+    state?: Record<string, any>;
+}
+export type { IUserBody, IUserEntity, IUsersApi };

package/dist/users/usersInterfaces.js

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

package/dist/users/usersSchemas.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Validation schemas for Users module
+ * @description Zod schemas for validating users-related API responses
+ */
+import { z } from 'zod';
+/**
+ * User response schema (extends base UserEntitySchema)
+ * formData can be array or object (inherited from UserEntitySchema)
+ */
+export declare const UserResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    phoneMask: z.ZodOptional<z.ZodString>;
+    phoneCode: z.ZodOptional<z.ZodString>;
+    phoneNumber: z.ZodOptional<z.ZodString>;
+    statusMarker: z.ZodOptional<z.ZodString>;
+    formData: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    authProviderIdentifier: z.ZodOptional<z.ZodString>;
+    formIdentifier: z.ZodOptional<z.ZodString>;
+    groups: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    state: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    updatedAt: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Update user response schema (returns true on success)
+ */
+export declare const UpdateUserResponseSchema: z.ZodBoolean;
+/**
+ * Delete user response schema
+ */
+export declare const DeleteUserResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;

package/dist/users/usersSchemas.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteUserResponseSchema = exports.UpdateUserResponseSchema = exports.UserResponseSchema = void 0;
+/**
+ * Validation schemas for Users module
+ * @description Zod schemas for validating users-related API responses
+ */
+const zod_1 = require("zod");
+const validation_1 = require("../base/validation");
+/**
+ * User response schema (extends base UserEntitySchema)
+ * formData can be array or object (inherited from UserEntitySchema)
+ */
+exports.UserResponseSchema = validation_1.UserEntitySchema.extend({
+    createdAt: zod_1.z.string().optional(),
+    updatedAt: zod_1.z.string().optional(),
+});
+/**
+ * Update user response schema (returns true on success)
+ */
+exports.UpdateUserResponseSchema = zod_1.z.boolean();
+/**
+ * Delete user response schema
+ */
+exports.DeleteUserResponseSchema = zod_1.z.object({
+    success: zod_1.z.boolean(),
+    message: zod_1.z.string().optional(),
+});

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

@@ -0,0 +1,25 @@
+import type { Socket } from 'socket.io-client';
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IWS } from './wsInterfaces';
+/**
+ * Controllers for working with users
+ * @handle /api/content/ws
+ */
+export default class WsApi extends AsyncModules implements IWS {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule
+     */
+    constructor(state: StateModule);
+    /**
+     * Creates an instance of an object Socket.io with a connection.
+     * @handleName connect
+     * @returns {Socket} Returns a Socket instance.
+     * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    connect(): Socket;
+}