oneentry 1.0.127 → 1.0.128

package/dist/users/usersInterfaces.d.ts

@@ -5,11 +5,11 @@ 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} 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.
  */
@@ -17,8 +17,8 @@ interface IUsers {
     /**
      * 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.
+     * @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 retrieves the data of an authorized user.
      */
@@ -26,29 +26,29 @@ interface IUsers {
     /**
      * Updates the user's data.
      * @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.
+     * @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 This method updates the user's data.
      */
@@ -72,8 +72,8 @@ interface IUsers {
     /**
      * 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.
+     * @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.
      */
@@ -81,8 +81,8 @@ interface IUsers {
     /**
      * 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.
+     * @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.
      */
@@ -90,20 +90,20 @@ interface IUsers {
 }
 /**
  * @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 {
@@ -118,35 +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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.127",
+  "version": "1.0.128",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",