oneentry 1.0.124 → 1.0.125

package/dist/users/usersApi.js

@@ -20,11 +20,9 @@ class UsersApi extends asyncModules_1.default {
      * @handleName getUser
      *
      * @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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @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}`);
@@ -35,14 +33,31 @@ class UsersApi extends asyncModules_1.default {
      *
      * @handleName updateUser
      *
-     * @param {object} 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 {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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     *
+     * @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))
@@ -55,17 +70,29 @@ class UsersApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Delete a single user object.
+     * Archiving one user object (marked for deletion).
      *
-     * @handleName deleteUser
+     * @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 archiveUser() {
+        const result = await this._fetchDelete('/me');
+        return result;
+    }
+    /**
+     * 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');
+        const result = await this._fetchDelete('/me/account');
         return result;
     }
     /**
@@ -74,10 +101,8 @@ class UsersApi extends asyncModules_1.default {
      * @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".
-     *
      * @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) {
@@ -90,10 +115,8 @@ class UsersApi extends asyncModules_1.default {
      * @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".
-     *
      * @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) {

package/dist/users/usersInterfaces.d.ts

@@ -1,6 +1,7 @@
+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';
 /**
  * Interface representing user-related operations.
  *
@@ -8,10 +9,10 @@ import type { FormDataType } from '../formsData/formsDataInterfaces';
  *
  * @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 {
@@ -19,31 +20,54 @@ 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 {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>;
     /**
-     * Deletes the user from the system.
+     * 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>;
@@ -53,7 +77,6 @@ interface IUsers {
      * @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>;
@@ -63,7 +86,6 @@ interface IUsers {
      * @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>;
@@ -72,34 +94,63 @@ interface IUsers {
  * @interface IUserEntity
  *
  * @property {number} id - Object identifier. Example: 12345.
- * @property {string} identifier - Text identifier for record field. Example: 'user_12345'.
- * @property {Array<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} authProviderIdentifier - Text identifier of the authentication provider. Example: 'auth_provider_12345'.
- * @property {Array<string | number>} groups - Array of user groups. Example: ['group_1', 'group_2'].
- * @property {Record<string, any>} state - Object containing additional user state information. Example: {"key": "value"}.
- *
+ * @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;
+    formData: FormDataType[];
+    formIdentifier: string;
     groups: Array<string | number>;
     state: Record<string, any>;
+    moduleFormConfigs: IFormConfig;
 }
 /**
  * @interface IUserBody
  *
- * @property {string} formIdentifier - Text identifier of the form. Example: 'form_12345'.
+ * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
  * @property {string} [langCode] - Language code for localization. Default: "en_US".
- * @property {Array<{ marker: string; value: string }>} [authData] - Array of authentication data objects with markers and values. Example: [{"marker": "password", "value": "12345"}].
- * @property {IAuthFormData | Array<IAuthFormData>} [formData] - Form data object or array of form data objects. Example: {"marker": "last_name", "type": "string", "value": "Username"} or [{"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 {Record<string, any>} [state] - Object containing additional state information. Example: {"key": "value"}.
- *
+ * @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 {
@@ -109,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

@@ -16,11 +16,7 @@ export default class WsApi extends AsyncModules implements IWS {
      * @handleName connect
      *
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
-     * @example
-     * const socket = WS.connect()
-     * socket.on('my_event', callback)
+     * @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

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

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

@@ -3,7 +3,6 @@ import type { Socket } from 'socket.io-client';
  * @interface IWS
  *
  * @property {function} connect - WebSocket Connection.
- *
  * @description This interface defines a method for establishing a WebSocket connection.
  */
 interface IWS {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.124",
+  "version": "1.0.125",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,14 +9,14 @@
   ],
   "scripts": {
     "productionBuild": "run-s lint testAll build",
-    "testAll": "run-s admins attributesets authProvider blocks file-uploading forms formsdata generaltypes integrationcollections locales menus orders pages payments payments productstatuses products templates templatespreview users",
+    "testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes integrationcollections locales menus orders pages payments productstatuses products templates templatespreview users",
     "admins": "npx jest src/admins/tests/admins.spec.ts",
     "attributesets": "npx jest src/attribute-sets/tests/attributesets.spec.ts",
     "authProvider": "npx jest src/auth-provider/tests/authProvider.spec.ts",
     "blocks": "npx jest src/blocks/tests/blocks.spec.ts",
-    "file-uploading": "npx jest src/file-uploading/tests/fileuploading.spec.ts",
+    "fileuploading": "npx jest src/file-uploading/tests/fileuploading.spec.ts",
     "forms": "npx jest src/forms/tests/forms.spec.ts",
-    "formsdata": "npx jest src/formsData/tests/formsdata.spec.ts",
+    "formsdata": "npx jest src/forms-data/tests/formsdata.spec.ts",
     "generaltypes": "npx jest src/general-types/tests/generaltypes.spec.ts",
     "integrationcollections": "npx jest src/integration-collections/tests/integrationcollections.spec.ts",
     "locales": "npx jest src/locales/tests/locales.spec.ts",
@@ -38,26 +38,28 @@
   "author": "ONEENTRY PORTAL CO.",
   "license": "ISC",
   "dependencies": {
-    "io": "^1.5.3",
+    "io": "^1.5.7",
     "socket.io-client": "^4.8.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
+    "@jest/globals": "^30.0.5",
     "@types/eslint-config-prettier": "^6.11.3",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.16.0",
-    "@typescript-eslint/eslint-plugin": "^8.35.1",
-    "@typescript-eslint/parser": "^8.35.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.2.1",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
     "eslint": "^8.57.1",
-    "eslint-config-prettier": "^10.1.5",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest": "^29.0.1",
-    "eslint-plugin-prettier": "^5.5.1",
+    "eslint-plugin-jest-extended": "^3.0.0",
+    "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "jest": "^29.7.0",
+    "jest": "^30.0.5",
+    "jest-extended": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.6.2",
-    "ts-jest": "^29.4.0",
-    "typescript": "^5.8.3"
+    "ts-jest": "^29.4.1",
+    "typescript": "^5.9.2"
   }
-}
+}