oneentry 1.0.126 → 1.0.127

package/dist/users/usersInterfaces.d.ts

@@ -4,109 +4,106 @@ import type { IError } from '../base/utils';
 import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
  * Interface representing user-related operations.
- *
  * @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.
+ * @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.
+     * @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 Retrieves the data of an authorized user.
+     * @description This method 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.
+     * @handleName updateUser
+     * @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".
+     * @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 Updates the user's data.
+     * @description This method 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.
+     * @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 Deletes the user from the system.
+     * @description This method archives a user object (marks it for deletion).
      */
     archiveUser(): Promise<boolean | IError>;
     /**
      * Deletes the user from the system.
-     *
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @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 Deletes the user from the system.
+     * @description This method 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.
+     * @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 Adds an FCM token for sending push notifications.
+     * @description This method 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.
+     * @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 Deletes an existing FCM token.
+     * @description This method deletes an existing FCM token.
      */
     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 {any[]} groups - Array of user groups. Example: ["group_1", "group_2"].
- * @property {any} state - Object containing additional user state information. Example: {"key": "value"}
+ * @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 {
@@ -121,36 +118,35 @@ interface IUserEntity {
 }
 /**
  * @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"}
+ * @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 {

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

@@ -9,13 +9,15 @@ import type { IWS } from './wsInterfaces';
 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. This method requires user authorization.
-     *
      * @handleName connect
-     *
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Socket} Returns a Socket instance.
      * @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

@@ -10,20 +10,23 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  * @handle /api/content/ws
  */
 class WsApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/ws';
     }
     /**
      * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
-     *
      * @handleName connect
-     *
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      */
     connect() {
         if (!this.state.accessToken) {
+            // eslint-disable-next-line no-undef, no-console
             console.error('User is unauthorized');
         }
         const socket = (0, socket_io_client_1.io)(this.state.url, {

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

@@ -1,11 +1,16 @@
 import type { Socket } from 'socket.io-client';
 /**
  * @interface IWS
- *
- * @property {function} connect - WebSocket Connection.
+ * @property {Function} connect - WebSocket Connection.
  * @description This interface defines a method for establishing a WebSocket connection.
  */
 interface IWS {
+    /**
+     * WebSocket Connection.
+     * @handleName connect
+     * @returns {Socket} Returns a Socket instance.
+     * @description This method establishes a WebSocket connection.
+     */
     connect(): Socket;
 }
 export type { IWS };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.126",
+  "version": "1.0.127",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,11 +9,12 @@
   ],
   "scripts": {
     "productionBuild": "run-s lint testAll build",
-    "testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes integrationcollections locales menus orders pages payments productstatuses products templates templatespreview users",
+    "testAll": "run-s admins attributesets authProvider blocks events 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",
+    "events": "npx jest src/events/tests/events.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/forms-data/tests/formsdata.spec.ts",
@@ -29,7 +30,8 @@
     "templates": "npx jest src/templates/tests/templates.spec.ts",
     "templatespreview": "npx jest src/templates-preview/tests/templatespreview.spec.ts",
     "users": "npx jest src/users/tests/users.spec.ts",
-    "lint": "npx eslint",
+    "lint": "npx eslint .",
+    "lintFix": "npx eslint . --fix",
     "build": "npx tsc"
   },
   "bin": {
@@ -42,24 +44,26 @@
     "socket.io-client": "^4.8.1"
   },
   "devDependencies": {
-    "@jest/globals": "^30.0.5",
+    "@jest/globals": "^30.2.0",
     "@types/eslint-config-prettier": "^6.11.3",
     "@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",
+    "@types/node": "^24.6.2",
+    "@typescript-eslint/eslint-plugin": "^8.45.0",
+    "@typescript-eslint/parser": "^8.45.0",
+    "eslint": "^9.37.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest": "^29.0.1",
-    "eslint-plugin-jest-extended": "^3.0.0",
+    "eslint-plugin-jest-extended": "^3.0.1",
+    "eslint-plugin-jsdoc": "^60.8.2",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "jest": "^30.0.5",
+    "jest": "^30.2.0",
     "jest-extended": "^6.0.0",
+    "jsdoc": "^4.0.4",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.6.2",
-    "ts-jest": "^29.4.1",
-    "typescript": "^5.9.2"
+    "ts-jest": "^29.4.4",
+    "typescript": "^5.9.3"
   }
 }