oneentry 1.0.173 → 1.0.175

package/esm/users/usersInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAuthData, IAuthFormData, INotificationData } from '../auth-provider/authProvidersInterfaces.js';
+import type { IAuthData, INotificationData } from '../auth-provider/authProvidersInterfaces.js';
 import type { IError, IRating, IVectorSearchResponse } from '../base/utils.js';
 import type { IFormConfig } from '../forms/formsInterfaces.js';
 import type { FormDataType } from '../forms-data/formsDataInterfaces.js';
@@ -64,7 +64,7 @@ interface IUsersApi {
         ]
      * @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.
+     * @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
      * @example
         [
           {
@@ -75,7 +75,7 @@ interface IUsersApi {
         ]
      * @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 {unknown} body.formData[index].value - The value of the field, shaped by its type. Example: "Username".
      * @param {string} body.notificationData - The notification data.
      * @example
         {
@@ -164,7 +164,7 @@ interface IUsersApi {
     /**
      * Remove an item from the cart.
      * @handleName removeCartItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<ICartResponse | IError>} A promise resolving to the updated cart, 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 (or a guest context).
@@ -203,7 +203,7 @@ interface IUsersApi {
     /**
      * Remove an item from the wishlist.
      * @handleName removeWishlistItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<IWishlistResponse | IError>} A promise resolving to the updated wishlist, 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 (or a guest context).
@@ -213,10 +213,10 @@ interface IUsersApi {
     /**
      * Semantic (vector) search for users.
      * @handleName getUsersByVectorSearch
-     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @param {IUsersVectorSearch} body - Vector search parameters. Example: `{ queryText: "john" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} A promise resolving to a users response (items + total), or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method performs a semantic (vector) search for users. It requires user authorization.
@@ -229,8 +229,8 @@ interface IUsersApi {
  * @interface IUsersVectorSearch
  * @property {string} queryText - Natural-language search query. Example: "john".
  * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
- * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
- * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @property {number} [maxHits] - Number of top candidates fetched before pagination. Default: 100. Maximum: 500. Example: 10.
+ * @property {boolean} [debug] - When `true`, each returned item gets a `distance` field. Example: false.
  * @description Body for the users vector/search endpoint.
  */
 interface IUsersVectorSearch {
@@ -241,7 +241,7 @@ interface IUsersVectorSearch {
 }
 /**
  * @interface IUsersResponse
- * @property {IUserEntity[]} items - Array of found user objects.
+ * @property {IUserEntity[]} items - Users that match the query.
  * @property {number} total - Total number of found records. Example: 100.
  * @description This interface defines the structure of a response containing multiple user entities, including the total count and an array of user items.
  */
@@ -251,10 +251,10 @@ interface IUsersResponse {
 }
 /**
  * @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.
+ * @property {number} id - Object ID. Example: 12345.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "user_12345".
+ * @property {string} authProviderIdentifier - Marker of the authentication provider. Example: "auth_provider_12345".
+ * @property {FormDataType[]} formData - Form fields with their values.
  * @example
     [
       {
@@ -263,21 +263,21 @@ interface IUsersResponse {
         "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.
+ * @property {string} formIdentifier - Marker of the form. Example: "form_12345".
+ * @property {string} [total] - Deprecated, do not rely on it. A service counter that leaks into the response of a single user: always `"1"`, it carries no data about the user. The API reference does not describe it, and the field may disappear from the response. Example: "1".
+ * @property {Array<string | number>} groups - User groups.
  * @example
     [
       "group_1",
       "group_2"
     ]
- * @property {object} state - Object containing additional user state information.
+ * @property {object} state - Custom key-value data stored with the user.
  * @example
     {
       "key": "value"
     }
- * @property {Array<IFormConfig>} [moduleFormConfigs] - Optional array of form configuration objects associated with the user.
- * @property {IRating} [rating] - Rating data.
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Form configurations of the module associated with the user.
+ * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
  * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
  */
@@ -287,7 +287,8 @@ interface IUserEntity {
     authProviderIdentifier: string;
     formData: FormDataType[];
     formIdentifier: string;
-    total: string;
+    /** @deprecated Service counter leaking into the response, always `"1"`; the field may disappear. */
+    total?: string;
     groups: Array<string | number>;
     state: Record<string, unknown>;
     moduleFormConfigs?: Array<IFormConfig>;
@@ -296,9 +297,9 @@ 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 {IAuthData[]} [authData] - Array of authentication data objects with markers and values.
+ * @property {string} formIdentifier - Marker of the form. Example: "form_12345".
+ * @property {string} [langCode] - Language code. Default: "en_US".
+ * @property {IAuthData[]} [authData] - Authentication fields, each with a `marker` and a `value`.
  * @example
     [
       {
@@ -306,7 +307,7 @@ interface IUserEntity {
         "value": "12345"
       }
     ]
- * @property {IAuthFormData | IAuthFormData[]} [formData] - Form data object or array of form data objects.
+ * @property {FormDataType | FormDataType[]} [formData] - One form field object or an array of them. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
  * @example
     [
       {
@@ -320,14 +321,14 @@ interface IUserEntity {
         "value": "Doe"
       }
     ]
- * @property {object} [notificationData] - Object containing notification data, including email and phone information.
+ * @property {object} [notificationData] - Notification contacts: email and phone numbers.
  * @example
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],
       "phoneSMS": "+99999999999"
     }
- * @property {object} [state] - Object containing additional state information.
+ * @property {object} [state] - Custom key-value data stored with the user. Applied as a JSON Merge Patch: a key set to `null` is removed, other keys are overwritten, and omitted keys are kept.
  * @example
     {
       "key": "value"
@@ -338,15 +339,15 @@ interface IUserBody {
     formIdentifier: string;
     langCode?: string;
     authData?: IAuthData[];
-    formData?: IAuthFormData | IAuthFormData[];
+    formData?: FormDataType | FormDataType[];
     notificationData?: INotificationData;
     state?: Record<string, unknown>;
 }
 /**
  * @interface ICartItem
- * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} productId - Product ID. Example: 1.
  * @property {number} qty - Quantity of the product in the cart. Example: 2.
- * @property {string} [addedAt] - ISO date when the item was added. Example: "2026-05-30T10:00:00.000Z".
+ * @property {string} [addedAt] - Date and time the item was added, in ISO 8601 format. Example: "2026-05-30T10:00:00.000Z".
  * @description A single cart item.
  */
 interface ICartItem {
@@ -356,7 +357,7 @@ interface ICartItem {
 }
 /**
  * @interface ICartResponse
- * @property {ICartItem[]} items - Cart items.
+ * @property {ICartItem[]} items - Items in the cart.
  * @property {number} total - Total number of items in the cart. Example: 3.
  * @description The user's or guest's cart.
  */
@@ -366,7 +367,7 @@ interface ICartResponse {
 }
 /**
  * @interface ICartSet
- * @property {ICartItem[]} items - New cart items. Example: `[{ productId: 1, qty: 2 }]`.
+ * @property {ICartItem[]} items - New contents of the cart. Example: `[{ productId: 1, qty: 2 }]`.
  * @description Body for replacing the whole cart.
  */
 interface ICartSet {
@@ -374,7 +375,7 @@ interface ICartSet {
 }
 /**
  * @interface ICartAddItem
- * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} productId - Product ID. Example: 1.
  * @property {number} qty - Quantity to add. Example: 2.
  * @description Body for adding a single item to the cart.
  */
@@ -384,8 +385,8 @@ interface ICartAddItem {
 }
 /**
  * @interface IWishlistItem
- * @property {number} productId - Product identifier. Example: 1.
- * @property {string} [addedAt] - ISO date when the item was added. Example: "2026-05-30T10:00:00.000Z".
+ * @property {number} productId - Product ID. Example: 1.
+ * @property {string} [addedAt] - Date and time the item was added, in ISO 8601 format. Example: "2026-05-30T10:00:00.000Z".
  * @description A single wishlist item.
  */
 interface IWishlistItem {
@@ -394,7 +395,7 @@ interface IWishlistItem {
 }
 /**
  * @interface IWishlistResponse
- * @property {IWishlistItem[]} items - Wishlist items.
+ * @property {IWishlistItem[]} items - Items in the wishlist.
  * @property {number} total - Total number of items in the wishlist. Example: 3.
  * @description The user's or guest's wishlist.
  */
@@ -404,7 +405,7 @@ interface IWishlistResponse {
 }
 /**
  * @interface IWishlistSet
- * @property {IWishlistItem[]} items - New wishlist items. Example: `[{ productId: 1 }]`.
+ * @property {IWishlistItem[]} items - New contents of the wishlist. Example: `[{ productId: 1 }]`.
  * @description Body for replacing the whole wishlist.
  */
 interface IWishlistSet {
@@ -412,7 +413,7 @@ interface IWishlistSet {
 }
 /**
  * @interface IWishlistAddItem
- * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} productId - Product ID. Example: 1.
  * @description Body for adding a single item to the wishlist.
  */
 interface IWishlistAddItem {

package/esm/users/usersSchemas.d.ts

@@ -13,7 +13,7 @@ export declare const UserResponseSchema: z.ZodObject<{
     authProviderIdentifier: z.ZodString;
     formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
     formIdentifier: z.ZodString;
-    total: z.ZodString;
+    total: z.ZodOptional<z.ZodString>;
     groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
     state: z.ZodRecord<z.ZodString, z.ZodAny>;
     moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.173",
+  "version": "1.0.175",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "module": "esm/index.js",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
-    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.173"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.175"
   },
   "sideEffects": false,
   "files": [