oneentry 1.0.171 → 1.0.172

package/dist/pages/pagesApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
+import type { IError, IVectorSearchResponse } from '../base/utils';
 import type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock } from './pagesInterfaces';
 /**
  * Controllers for working with page objects, including catalog pages
@@ -88,7 +88,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity[] | IPageSearchResult[] | IError>} Returns found pages as an array of PageEntity objects, an array of short PageSearchResult cards when the traficLimit config option is enabled, or an empty array [] (if there is no data)
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Quick search for page objects with limited output. The quick search endpoint returns short cards ({ id, title }); with traficLimit enabled they are returned as is, otherwise full page entities are fetched for the found ids.
+     * @description Quick search for page objects with limited output. The quick search endpoint returns short cards ({ id, title }); with traficLimit enabled they are returned as is, otherwise full page entities are fetched for the found ids. The search runs in `langCode`, and a found page that cannot be loaded in that language is left out of the result.
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/searchPage searchPage} documentation.
      */
     searchPage(name: string, url?: string, langCode?: string): Promise<IPagesEntity[] | IPageSearchResult[] | IError>;
@@ -99,12 +99,12 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @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<IPagesResponse | IError>} Returns an object with an array of found pages and total count.
+     * @returns {Promise<IVectorSearchResponse<IPagesResponse> | IError>} Returns an object with an array of found pages and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for pages.
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPagesByVectorSearch getPagesByVectorSearch} documentation.
      */
-    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IPagesResponse | IError>;
+    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IPagesResponse> | IError>;
     /**
      * Add template data to pages
      * @handleName addTemplateToPages

package/dist/pages/pagesApi.js

@@ -220,27 +220,23 @@ class PagesApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity[] | IPageSearchResult[] | IError>} Returns found pages as an array of PageEntity objects, an array of short PageSearchResult cards when the traficLimit config option is enabled, or an empty array [] (if there is no data)
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Quick search for page objects with limited output. The quick search endpoint returns short cards ({ id, title }); with traficLimit enabled they are returned as is, otherwise full page entities are fetched for the found ids.
+     * @description Quick search for page objects with limited output. The quick search endpoint returns short cards ({ id, title }); with traficLimit enabled they are returned as is, otherwise full page entities are fetched for the found ids. The search runs in `langCode`, and a found page that cannot be loaded in that language is left out of the result.
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/searchPage searchPage} documentation.
      */
     async searchPage(name, url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to perform a quick search by page name and language code
         const urlPart = url ? `url=${encodeURIComponent(url)}&` : '';
-        const searchPages = await this._fetchGet(`/quick/search?${urlPart}lang=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}`);
-        // /quick/search?url=catalog&langCode=en_US&name=cat
+        const searchPages = await this._fetchGet(`/quick/search?${urlPart}langCode=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}`);
         // Validate response if validation is enabled
         const data = (await this._validateResponse(searchPages, schema('PageSearchResponseSchema')));
         // Check if there is no traffic limit set in the state
         if (!this.state.traficLimit && Array.isArray(data)) {
-            // Initialize an empty array to store detailed page information
-            const pageList = [];
-            // Use Promise.all to fetch detailed information for each page concurrently
-            await Promise.all(data.map(async (page) => {
-                // Fetch detailed page information by page ID and push it to pageList
-                await this.getPageById(page.id, langCode).then((result) => {
-                    pageList.push(result);
-                });
-            }));
+            // Fetch detailed information for each page concurrently, keeping the search order
+            const fetched = await Promise.all(data.map((page) => this.getPageById(page.id, langCode)));
+            // A page the quick search found but getPageById could not load (404 in this
+            // language, closed route) is left out: an IError has no place in IPagesEntity[]
+            // and broke `page.localizeInfos.title` on the caller's side (CMS-1068)
+            const pageList = fetched.filter((page) => !this._isErrorResponse(page));
             // Add templates to the fetched pages
             const withTemplate = await this.addTemplateToPages(pageList);
             // Normalize the data and return it; ensures consistent structure or handles errors
@@ -257,7 +253,7 @@ class PagesApi extends asyncModules_1.default {
      * @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<IPagesResponse | IError>} Returns an object with an array of found pages and total count.
+     * @returns {Promise<IVectorSearchResponse<IPagesResponse> | IError>} Returns an object with an array of found pages and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for pages.
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPagesByVectorSearch getPagesByVectorSearch} documentation.

package/dist/pages/pagesInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributes, IAttributeValues, IError, ILocalizeInfo, IRating, LangType } from '../base/utils';
+import type { IAttributes, IAttributeValues, IError, ILocalizeInfo, IRating, IVectorSearchResponse, LangType } from '../base/utils';
 import type { BlockType, IBlockEntity } from '../blocks/blocksInterfaces';
 import type { IFormConfig } from '../forms/formsInterfaces';
 import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces';
@@ -84,11 +84,11 @@ interface IPagesApi {
      * @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 {IPagesResponse} A promise that resolves to a pages response (items + total) or an error.
+     * @returns {IVectorSearchResponse<IPagesResponse>} A promise that resolves to a pages 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 pages.
      */
-    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IPagesResponse | IError>;
+    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IPagesResponse> | IError>;
 }
 /**
  * Body for semantic (vector) page search.

package/dist/products/productsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
-import type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductSearchResult, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts } from './productsInterfaces';
+import type { IError, IVectorSearchResponse } from '../base/utils';
+import type { IFilterParams, IProductBlock, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductSearchResult, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
@@ -77,12 +77,12 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "sortKey": "id",
           "signPrice": "orders"
         }
-     * @returns {Promise<IAggregatedProductGroup[] | IError>} Array with AggregatedProductGroup objects.
+     * @returns {Promise<IProductsResponse | IError>} Products without a category: `{ items, total }`, the same container as getProducts.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product page objects with pagination (and aggregation) that do not have a category.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsEmptyPage getProductsEmptyPage} documentation.
      */
-    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
@@ -213,6 +213,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
+     * @param {string} [userQuery.relationMode] - How relations are computed: "global" (default) or "local", which also requires the product `id` itself to satisfy the template condition. Example: "local".
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all related product page objects.
@@ -350,12 +351,12 @@ export default class ProductsApi extends AsyncModules implements 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 {Promise<IProductsResponse | IError>} Returns an object with an array of found products and total count.
+     * @returns {Promise<IVectorSearchResponse<IProductsResponse> | IError>} Returns an object with an array of found products and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for products.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByVectorSearch getProductsByVectorSearch} documentation.
      */
-    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>;
     /**
      * Get products by page url.
      * @param {string} url - Page url.

package/dist/products/productsApi.js

@@ -125,7 +125,7 @@ class ProductsApi extends asyncModules_1.default {
           "sortKey": "id",
           "signPrice": "orders"
         }
-     * @returns {Promise<IAggregatedProductGroup[] | IError>} Array with AggregatedProductGroup objects.
+     * @returns {Promise<IProductsResponse | IError>} Products without a category: `{ items, total }`, the same container as getProducts.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product page objects with pagination (and aggregation) that do not have a category.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsEmptyPage getProductsEmptyPage} documentation.
@@ -133,7 +133,9 @@ class ProductsApi extends asyncModules_1.default {
     async getProductsEmptyPage(body = {}, langCode = this.state.lang, userQuery) {
         const query = { ...userQuery, langCode };
         const result = await this._fetchPost(`/empty-page?` + this._queryParamsToString(query), body);
-        return this._normalizeData(result);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('ProductsResponseSchema'));
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Search for all products with pagination for the selected category.
@@ -285,6 +287,7 @@ class ProductsApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
+     * @param {string} [userQuery.relationMode] - How relations are computed: "global" (default) or "local", which also requires the product `id` itself to satisfy the template condition. Example: "local".
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all related product page objects.
@@ -477,7 +480,7 @@ class ProductsApi extends asyncModules_1.default {
      * @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<IProductsResponse | IError>} Returns an object with an array of found products and total count.
+     * @returns {Promise<IVectorSearchResponse<IProductsResponse> | IError>} Returns an object with an array of found products and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for products.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByVectorSearch getProductsByVectorSearch} documentation.

package/dist/products/productsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError, ILocalizeInfo, IRating } from '../base/utils';
+import type { IAttributeValues, IError, ILocalizeInfo, IRating, IVectorSearchResponse } from '../base/utils';
 import type { BlockType } from '../blocks/blocksInterfaces';
 import type { IFormConfig } from '../forms/formsInterfaces';
 /**
@@ -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
@@ -366,7 +368,7 @@ 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 {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".
  * @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"].
@@ -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/dist/user-activity/userActivityApi.js

@@ -31,13 +31,10 @@ class UserActivityApi extends asyncModules_1.default {
      * @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));
     }
 }
 exports.default = UserActivityApi;

package/dist/users/usersApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
+import type { IError, IVectorSearchResponse } from '../base/utils';
 import type { ICartAddItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IUsersResponse, IUsersVectorSearch, IWishlistAddItem, IWishlistResponse, IWishlistSet } from './usersInterfaces';
 /**
  * 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/dist/users/usersApi.js

@@ -332,7 +332,7 @@ class UsersApi extends asyncModules_1.default {
      * @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/dist/users/usersInterfaces.d.ts

@@ -1,5 +1,5 @@
 import type { IAuthData, IAuthFormData, INotificationData } from '../auth-provider/authProvidersInterfaces';
-import type { IError, IRating } from '../base/utils';
+import type { IError, IRating, IVectorSearchResponse } from '../base/utils';
 import type { IFormConfig } from '../forms/formsInterfaces';
 import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
@@ -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/esm/admins/adminsApi.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 { IFilterParams } from '../products/productsInterfaces.js';
 import type { IAdminEntity, IAdmins, IAdminsResponse, IAdminsVectorSearch } from './adminsInterfaces.js';
 /**
@@ -57,10 +57,10 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
      * @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<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @returns {Promise<IVectorSearchResponse<IAdminsResponse> | IError>} Returns an object with an array of found admins and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for admins.
      * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.
      */
-    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IAdminsResponse> | IError>;
 }

package/esm/admins/adminsApi.js

@@ -66,7 +66,7 @@ export default class AdminsApi 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<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @returns {Promise<IVectorSearchResponse<IAdminsResponse> | IError>} Returns an object with an array of found admins and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for admins.
      * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.

package/esm/admins/adminsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError } from '../base/utils.js';
+import type { IAttributeValues, IError, IVectorSearchResponse } from '../base/utils.js';
 import type { IFormConfig } from '../forms/formsInterfaces.js';
 import type { IFilterParams } from '../products/productsInterfaces.js';
 /**
@@ -40,10 +40,10 @@ interface IAdmins {
      * @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 {IAdminsResponse} Returns an object with an array of found admins and total count.
+     * @returns {IVectorSearchResponse<IAdminsResponse>} Returns an object with an array of found admins, total count and indexReady.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IAdminsResponse> | IError>;
 }
 /**
  * Body for semantic (vector) admin search.

package/esm/base/asyncModules.d.ts

@@ -79,8 +79,13 @@ export default abstract class AsyncModules extends SyncModules {
      * (the default) browserResponse returns the API error instead of throwing
      * it, so relying on the catch alone would report every failed call — a 404
      * from cancelSubscription, a 403 from recoverSubscriptions — as a success.
+     *
+     * With `isShell` disabled browserResponse throws, and the error is thrown on
+     * from here too: returning it would break the `@throws` contract every caller
+     * documents, and a `try/catch` around the call would never fire (CMS-1067).
      * @param {() => Promise<unknown>} request - Thunk performing the fetch call.
-     * @returns {Promise<boolean | IError>} `true` on success, IError on failure.
+     * @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
+     * @throws {IError} When isShell=false and the request fails.
      */
     protected _fetchBoolean(request: () => Promise<unknown>): Promise<boolean | IError>;
     /**

package/esm/base/asyncModules.js

@@ -130,8 +130,13 @@ export default class AsyncModules extends SyncModules {
      * (the default) browserResponse returns the API error instead of throwing
      * it, so relying on the catch alone would report every failed call — a 404
      * from cancelSubscription, a 403 from recoverSubscriptions — as a success.
+     *
+     * With `isShell` disabled browserResponse throws, and the error is thrown on
+     * from here too: returning it would break the `@throws` contract every caller
+     * documents, and a `try/catch` around the call would never fire (CMS-1067).
      * @param {() => Promise<unknown>} request - Thunk performing the fetch call.
-     * @returns {Promise<boolean | IError>} `true` on success, IError on failure.
+     * @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
+     * @throws {IError} When isShell=false and the request fails.
      */
     async _fetchBoolean(request) {
         try {
@@ -142,6 +147,9 @@ export default class AsyncModules extends SyncModules {
             return true;
         }
         catch (e) {
+            if (!this.state.isShell) {
+                throw e;
+            }
             return e;
         }
     }

package/esm/base/utils.d.ts

@@ -439,6 +439,16 @@ interface IHttpOptions {
     headers: IHttpHeaders;
     body?: string | FormData | Blob;
 }
+/**
+ * Response of a semantic (vector) search: the module's own list container plus `indexReady`.
+ * @typedef {object} IVectorSearchResponse
+ * @template T
+ * @property {boolean} indexReady - `false` when no vectors are built yet for this entity and language: the query was not embedded, and empty `items` do not mean "nothing matched". `true` — an honest search result.
+ * @description Every `…/vector/search` endpoint answers with `indexReady` next to its list (CMS-1074).
+ */
+type IVectorSearchResponse<T> = T & {
+    indexReady: boolean;
+};
 /**
  * LangType
  */
@@ -447,4 +457,4 @@ type LangType = string | Array<string>;
  * LocalizeType
  */
 type LocalizeType = ILocalizeInfo;
-export type { IAttributeFile, IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IFileAttributeValue, IHttpHeaders, IHttpOptions, IListAttributeValue, ILocalizeInfo, INumberAttributeValue, IRating, IStringAttributeValue, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, ITypedAttributeValue, LangType, LocalizeType, TimeIntervalPair, };
+export type { IAttributeFile, IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IFileAttributeValue, IHttpHeaders, IHttpOptions, IListAttributeValue, ILocalizeInfo, INumberAttributeValue, IRating, IStringAttributeValue, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, ITypedAttributeValue, IVectorSearchResponse, LangType, LocalizeType, TimeIntervalPair, };

package/esm/blocks/blocksApi.d.ts

@@ -21,7 +21,7 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get blocks by parameters.
      * @handleName getBlocks
-     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none". When omitted, blocks of all types are returned. Example: 'product'.
+     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "frequently_ordered_block" | "trending_block" | "recently_viewed_block" | "repeat_purchase_block" | "slider_block" | "personal_recommendations_block" | "cart_complement_block" | "cart_similar_block" | "wishlist_similar_block" | "form" | "common_page" | "common_block" | "order" | "service" | "external_page" | "discount" (see BlockType). When omitted, blocks of all types are returned. Example: 'product'.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.

package/esm/blocks/blocksApi.js

@@ -22,7 +22,7 @@ export default class BlocksApi extends AsyncModules {
     /**
      * Get blocks by parameters.
      * @handleName getBlocks
-     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none". When omitted, blocks of all types are returned. Example: 'product'.
+     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "frequently_ordered_block" | "trending_block" | "recently_viewed_block" | "repeat_purchase_block" | "slider_block" | "personal_recommendations_block" | "cart_complement_block" | "cart_similar_block" | "wishlist_similar_block" | "form" | "common_page" | "common_block" | "order" | "service" | "external_page" | "discount" (see BlockType). When omitted, blocks of all types are returned. Example: 'product'.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.

package/esm/blocks/blocksInterfaces.d.ts

@@ -309,9 +309,11 @@ interface ISearchBlock {
 /**
  * BlockType
  * @type {BlockType}
- * @description This type defines the possible values for block types used in the system.
+ * @description This type defines the possible values for block types used in the system: the types `GET /api/content/general-types` returns.
+ * `'none'` was dropped — the platform has no such type and a filter by it answers `400 type must be a valid enum value` (CMS-1062).
+ * `'service'` is the platform's own name for the type, but the `type` filter of getBlocks and getTemplateByType currently refuses it with the same `400`; that is a platform defect (CMS-1073).
  */
-type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount' | 'none';
+type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount';
 /**
  * Lookup body for block product endpoints by explicit productIds.
  * @interface IBlockProductsLookup

package/esm/discounts/discountsApi.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 { IBonusBalanceEntity, IBonusHistoryResponse, IBonusTransactionType, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse, IDiscountsVectorSearch, IDiscountType } from './discountsInterfaces.js';
 /**
  * Controllers for working with events
@@ -85,10 +85,10 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @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<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.
      */
-    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IDiscountsResponse> | IError>;
 }

package/esm/discounts/discountsApi.js

@@ -119,7 +119,7 @@ export default class DiscountsApi 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<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.

package/esm/discounts/discountsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils.js';
+import type { IAttributeValues, IError, ILocalizeInfo, IVectorSearchResponse } from '../base/utils.js';
 /**
  * Discount type.
  */
@@ -66,10 +66,10 @@ interface IDiscountsApi {
      * @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<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IDiscountsResponse> | IError>;
 }
 /**
  * Body for semantic (vector) discount search.

package/esm/events/eventsApi.d.ts

@@ -53,7 +53,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
      * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method 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/events/eventsApi.js

@@ -1,4 +1,3 @@
-/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import AsyncModules from '../base/asyncModules.js';
 /**
@@ -66,7 +65,7 @@ export default class EventsApi extends AsyncModules {
      * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
      * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method 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/file-uploading/fileUploadingApi.d.ts

@@ -62,7 +62,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/delete delete} documentation.
      */