oneentry 1.0.123 → 1.0.124

package/dist/users/usersInterfaces.d.ts

@@ -2,22 +2,84 @@ import type { IAuthFormData } from '../auth-provider/authProvidersInterfaces';
 import type { IError } from '../base/utils';
 import type { FormDataType } from '../formsData/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} 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>;
+    /**
+     * 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 {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"}.
+ *
+ * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
  */
 interface IUserEntity {
     id: number;
@@ -25,11 +87,20 @@ interface IUserEntity {
     formData: Array<FormDataType>;
     formIdentifier: string;
     authProviderIdentifier: string;
-    groups: Array<string>;
+    groups: Array<string | number>;
     state: Record<string, any>;
 }
 /**
- * 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 {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"}.
+ *
+ * @description Represents the body of a user request, including form identifiers, authentication data, form data, notification data, and state information.
  */
 interface IUserBody {
     formIdentifier: string;

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

@@ -11,12 +11,15 @@ 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.
      *
+     * @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)
      */
     connect(): Socket;

package/dist/web-socket/wsApi.js

@@ -15,12 +15,15 @@ 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.
      *
+     * @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)
      */
     connect() {

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

@@ -1,8 +1,10 @@
 import type { Socket } from 'socket.io-client';
 /**
- * Represents a interface object of WebSocket IO.
+ * @interface IWS
  *
  * @property {function} connect - WebSocket Connection.
+ *
+ * @description This interface defines a method for establishing a WebSocket connection.
  */
 interface IWS {
     connect(): Socket;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.123",
+  "version": "1.0.124",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,12 +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 payments productstatuses products templates templatespreview users",
+    "testAll": "run-s admins attributesets authProvider blocks file-uploading forms formsdata generaltypes integrationcollections locales menus orders pages payments 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",
-    "fileuploading": "npx jest src/file-uploading/tests/fileuploading.spec.ts",
+    "file-uploading": "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",
     "generaltypes": "npx jest src/general-types/tests/generaltypes.spec.ts",
@@ -45,19 +45,19 @@
     "@jest/globals": "^29.7.0",
     "@types/eslint-config-prettier": "^6.11.3",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.15.29",
-    "@typescript-eslint/eslint-plugin": "^8.33.1",
-    "@typescript-eslint/parser": "^8.33.1",
+    "@types/node": "^22.16.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.1",
+    "@typescript-eslint/parser": "^8.35.1",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jest": "^28.12.0",
-    "eslint-plugin-prettier": "^5.4.1",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-prettier": "^5.5.1",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "jest": "^29.7.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.5.3",
-    "ts-jest": "^29.3.4",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.0",
     "typescript": "^5.8.3"
   }
 }