oneentry 1.0.171 → 1.0.173

package/esm/products/productsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError, ILocalizeInfo, IRating } from '../base/utils.js';
+import type { IAttributeValues, IError, ILocalizeInfo, IRating, IVectorSearchResponse } from '../base/utils.js';
 import type { BlockType } from '../blocks/blocksInterfaces.js';
 import type { IFormConfig } from '../forms/formsInterfaces.js';
 /**
@@ -62,11 +62,11 @@ interface IProductsApi {
           "sortKey": "id",
           "signPrice": "orders"
         }
-     * @returns {IProductsResponse} Array with ProductEntity objects.
+     * @returns {Promise<IProductsResponse | IError>} Products without a category: `{ items, total }`, the same container as getProducts.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method searches for all product page objects with pagination that do not have a category.
      */
-    getProductsEmptyPage(body?: object, langCode?: string, userQuery?: IProductsQueryBase): Promise<IAggregatedProductGroup[] | IError>;
+    getProductsEmptyPage(body?: object, langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
@@ -299,18 +299,18 @@ interface IProductsApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {IProductsResponse} A promise that resolves to a products response (items + total) or an error.
+     * @returns {IVectorSearchResponse<IProductsResponse>} A promise that resolves to a products response (items + total + indexReady) 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 products.
      */
-    getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IProductsResponse | IError>;
+    getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IProductsResponse> | IError>;
 }
 /**
  * @interface IProductsQueryBase
  * @property {number} offset - Parameter for pagination. Default: 0.
  * @property {number} limit - Parameter for pagination. Default: 30.
  * @property {string} sortOrder - Sort order "DESC" | "ASC". Default: "DESC".
- * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.
+ * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price", "status". Default: null.
  * @property {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
  * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
  * @description Base query parameters shared by the product listing endpoints (getProducts, getProductsEmptyPage, getProductsByPageId, getProductsByPageUrl): pagination, sorting and price fixing.
@@ -319,7 +319,7 @@ interface IProductsQueryBase {
     offset?: number;
     limit?: number;
     sortOrder?: 'DESC' | 'ASC' | null;
-    sortKey?: 'id' | 'position' | 'title' | 'date' | 'price' | null;
+    sortKey?: 'id' | 'position' | 'title' | 'date' | 'price' | 'status' | null;
     signPrice?: string;
 }
 /**
@@ -327,11 +327,13 @@ interface IProductsQueryBase {
  * @augments IProductsQueryBase
  * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
  * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
- * @description Query parameters for getRelatedProductsById: the base query plus product page status and template markers.
+ * @property {string} [relationMode] - How relations are computed: "global" (the default) runs the template's chain of conditions as is; "local" additionally requires the attribute value of the product `id` to satisfy the template condition (same operator, same stored operand) before the products of that step are kept. Example: "local".
+ * @description Query parameters for getRelatedProductsById: the base query plus product page status and template markers and the relation mode.
  */
 interface IProductsRelatedQuery extends IProductsQueryBase {
     statusMarker?: string | null;
     templateMarker?: string | null;
+    relationMode?: 'global' | 'local';
 }
 /**
  * Query parameters for getProductsPriceByPageUrl: the base query without
@@ -365,9 +367,9 @@ type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
 type IProductsQuery = IProductsQueryBase;
 /**
  * @interface IFilterParams
- * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
- * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "equals".
- * @property {number | string | null} conditionValue - The value that is being searched for, default null. Example: "new".
+ * @property {string} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered. Example: "color". Optional: a filter entry may select by `statusMarker` (or `pageUrls`, `title`) alone, e.g. `{ statusMarker: "in_stock" }`.
+ * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "eq".
+ * @property {number | string | null} [conditionValue] - The value that is being searched for, default null. Example: "new". Needed together with `attributeMarker`.
  * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
@@ -376,9 +378,9 @@ type IProductsQuery = IProductsQueryBase;
  * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
  */
 interface IFilterParams {
-    attributeMarker: string;
+    attributeMarker?: string;
     conditionMarker?: 'in' /** 'in' - Contains */ | 'nin' /** 'nin' - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | 'pat' /** 'pat' - Matches pattern */ | 'same' /** 'same' - Matches the value exactly */ | 'same_part' /** 'same_part' - Matches a part of the value exactly */ | null;
-    conditionValue: number | string | null;
+    conditionValue?: number | string | null;
     pageUrl?: string | null;
     pageUrls?: string[] | null;
     statusMarker?: string;
@@ -694,6 +696,9 @@ interface IProductBlock {
 }
 /**
  * @interface IAggregatedProductGroup
+ * @deprecated No method returns this shape: getProductsEmptyPage was declared with it,
+ * but the endpoint answers `{ items, total }` — see IProductsResponse (CMS-1065).
+ * Kept so that existing imports still compile.
  * @property {string} attrValue - Attribute value.
  * @property {IProductsEntity[]} items - Array of product entities.
  * @property {string[]} productIds - Array of product ids.

package/esm/system/systemApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { ISystemApi } from './systemInterfaces.js';
+import type { IApiStatEntry, ISystemApi } from './systemInterfaces.js';
 /**
  * Controllers for working with system components
  * @handle /api/content/system
@@ -37,10 +37,10 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }

package/esm/system/systemApi.js

@@ -41,9 +41,9 @@ export default class SystemApi extends AsyncModules {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
     async getApiStat() {

package/esm/system/systemInterfaces.d.ts

@@ -19,11 +19,17 @@ interface ISystemApi {
      */
     test500(): Promise<unknown | IError>;
     /**
-     * getApiStat
+     * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {unknown} Returns a Promise that resolves with any data.
-     * @description This method getApiStat.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
+     * @description Getting the number of requests to API, per day.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }
-export type { ISystemApi };
+/**
+ * One day of API request statistics: a single key — the date `YYYY-MM-DD` — holding the number of requests.
+ * @typedef {Record<string, number>} IApiStatEntry
+ * @description Element of the array returned by getApiStat. Example: `{ "2026-10-26": 13671 }`.
+ */
+type IApiStatEntry = Record<string, number>;
+export type { IApiStatEntry, ISystemApi };

package/esm/templates/templatesApi.d.ts

@@ -22,7 +22,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -33,7 +33,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -44,7 +44,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/esm/templates/templatesApi.js

@@ -22,7 +22,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -48,7 +48,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -64,7 +64,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/esm/templates/templatesInterfaces.d.ts

@@ -9,7 +9,7 @@ interface ITemplatesApi {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Record<BlockType, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Record<BlockType, ITemplateEntity[]>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all template objects grouped by types.
      */
@@ -19,7 +19,7 @@ interface ITemplatesApi {
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets template objects by type.
      */
@@ -29,7 +29,7 @@ interface ITemplatesApi {
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns an `ITemplateEntity` object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets one template object by id.
      */

package/esm/user-activity/userActivityApi.js

@@ -26,12 +26,9 @@ export default class UserActivityApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-activity/trackUserActivity trackUserActivity} documentation.
      */
     async trackUserActivity(body) {
-        try {
-            await this._fetchPost(`/track`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        // The endpoint answers 204: success is the absence of an error. Through
+        // _fetchBoolean a 400 comes back as IError instead of `true`, and with
+        // isShell=false it is thrown as documented (CMS-1064)
+        return this._fetchBoolean(() => this._fetchPost(`/track`, body));
     }
 }

package/esm/users/usersApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
-import type { IError } from '../base/utils.js';
+import type { IError, IVectorSearchResponse } from '../base/utils.js';
 import type { ICartAddItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IUsersResponse, IUsersVectorSearch, IWishlistAddItem, IWishlistResponse, IWishlistSet } from './usersInterfaces.js';
 /**
  * Controllers for working with users
@@ -239,11 +239,11 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IUsersResponse | IError>} Returns an object with an array of found users and total count.
+     * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for users. It requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUsersByVectorSearch getUsersByVectorSearch} documentation.
      */
-    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
+    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IUsersResponse> | IError>;
 }

package/esm/users/usersApi.js

@@ -294,7 +294,7 @@ export default class UsersApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IUsersResponse | IError>} Returns an object with an array of found users and total count.
+     * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for users. It requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.

package/esm/users/usersInterfaces.d.ts

@@ -1,5 +1,5 @@
 import type { IAuthData, IAuthFormData, INotificationData } from '../auth-provider/authProvidersInterfaces.js';
-import type { IError, IRating } from '../base/utils.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';
 /**
@@ -217,12 +217,12 @@ interface IUsersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IUsersResponse | IError>} A promise resolving to a users response (items + total), or an error.
+     * @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.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
-    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
+    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IUsersResponse> | IError>;
 }
 /**
  * Body for semantic (vector) user search.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.171",
+  "version": "1.0.173",
   "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.171"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.173"
   },
   "sideEffects": false,
   "files": [