oneentry 1.0.176 → 1.0.177

package/dist/products/productsApi.js

@@ -91,14 +91,14 @@ class ProductsApi extends asyncModules_1.default {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
-     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Example: "orders_storage".
+     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {string} [userQuery.sortOrder] - Sorting order parameter.
      * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Fetch products with optional filters and pagination.
+     * @description Fetch products with optional filters and pagination. `limit` is an integer from `1` (`0` or `1.5` answer `400`). A `signPrice` naming no orders storage fails the whole request with `404 Specified orders storage for price signature not found`. Products without a translation in `langCode` are left out.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProducts getProducts} documentation.
      */
     async getProducts(body = [], langCode = this.state.lang, userQuery) {
@@ -123,7 +123,7 @@ class ProductsApi extends asyncModules_1.default {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @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
@@ -174,7 +174,7 @@ class ProductsApi extends asyncModules_1.default {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -182,8 +182,11 @@ class ProductsApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByPageId getProductsByPageId} documentation.
      */
     async getProductsByPageId(id, body = [], langCode = this.state.lang, userQuery) {
-        const query = { ...userQuery };
-        const result = await this._fetchPost(`/page/${id}?langCode=${langCode}&` + this._queryParamsToString(query), { filter: body });
+        // Positional arguments win over the same keys in userQuery; one serializer
+        // builds the query, so langCode is encoded and sent once
+        const query = { ...userQuery, langCode };
+        const result = await this._fetchPost(`/page/${this._pathSegment(String(id))}?` +
+            this._queryParamsToString(query), { filter: body });
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductsResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -199,7 +202,7 @@ class ProductsApi extends asyncModules_1.default {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock"
         }
      * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
@@ -212,7 +215,8 @@ class ProductsApi extends asyncModules_1.default {
             ...userQuery,
             langCode,
         };
-        const result = await this._fetchGet(`/page/${url}/prices?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/page/${this._pathSegments(url)}/prices?` +
+            this._queryParamsToString(query));
         return result;
     }
     /**
@@ -252,7 +256,7 @@ class ProductsApi extends asyncModules_1.default {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -260,8 +264,8 @@ class ProductsApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByPageUrl getProductsByPageUrl} documentation.
      */
     async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
-        const query = { ...userQuery };
-        const result = await this._fetchPost(`/page/url/${url}?langCode=${langCode}&` +
+        const query = { ...userQuery, langCode };
+        const result = await this._fetchPost(`/page/url/${this._pathSegments(url)}?` +
             this._queryParamsToString(query), { filter: body });
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductsResponseSchema'));
@@ -279,7 +283,7 @@ class ProductsApi extends asyncModules_1.default {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock",
           "templateMarker": "template_12345"
         }
@@ -294,8 +298,9 @@ class ProductsApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getRelatedProductsById getRelatedProductsById} documentation.
      */
     async getRelatedProductsById(id, langCode = this.state.lang, userQuery) {
-        const query = { ...userQuery };
-        const result = await this._fetchGet(`/${id}/related?langCode=${langCode}&` + this._queryParamsToString(query));
+        const query = { ...userQuery, langCode };
+        const result = await this._fetchGet(`/${this._pathSegment(String(id))}/related?` +
+            this._queryParamsToString(query));
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductsResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -303,18 +308,18 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Comma-separated IDs of the product pages to fetch. Example: "12345,67890".
+     * @param {string} ids - Comma-separated product IDs. Unknown ids are dropped and repeated ones collapsed; a non-numeric one answers `400 Incorrect request`. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsByIdsQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
      * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
-     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
+     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find products by its ids.
@@ -324,9 +329,8 @@ class ProductsApi extends asyncModules_1.default {
         const query = {
             ids,
             langCode,
-            ...userQuery,
         };
-        const result = await this._fetchGet(`/ids?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/ids?` + this._queryParamsToString({ ...userQuery, ...query }));
         return this._normalizeData(result, langCode);
     }
     /**
@@ -334,17 +338,17 @@ class ProductsApi extends asyncModules_1.default {
      * @handleName getProductById
      * @param {number} id - Product ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {boolean} [isNormalized] - When `true`, the product is returned in normalized form.
+     * @param {boolean} [isNormalized] - Deprecated: the API no longer reads it, the answer is the same with `true`, `false` or without it. Kept for compatibility.
      * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Retrieve one product object.
+     * @description Retrieve one product object. A product with no translation in `langCode` answers `404 Product not found` — there is no fallback to another language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductById getProductById} documentation.
      */
     async getProductById(id, langCode = this.state.lang, isNormalized) {
         const query = { langCode };
         if (isNormalized !== undefined)
             query.isNormalized = isNormalized;
-        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/${this._pathSegment(String(id))}?` + this._queryParamsToString(query));
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductEntitySchema'));
         return this._normalizeData(validated, langCode);
@@ -353,14 +357,18 @@ class ProductsApi extends asyncModules_1.default {
      * Getting a product block object by product id.
      * @handleName getProductBlockById
      * @param {number} id - Product ID. Example: 12345.
-     * @returns {Promise<IProductBlock | IError>} - Product block object.
+     * @param {string} [langCode] - Language code. Default: the client's language.
+     * @returns {Promise<IProductBlock[] | IError>} - Array of the product's block objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductBlockById getProductBlockById} documentation.
      */
-    async getProductBlockById(id) {
-        const response = await this._fetchGet(`/${id}/blocks`);
-        return this._normalizeData(response);
+    async getProductBlockById(id, langCode = this.state.lang) {
+        // Without langCode the API answered in its default language while the SDK
+        // unwrapped the client's one, so blocks stayed keyed by locale
+        const response = await this._fetchGet(`/${this._pathSegment(String(id))}/blocks?` +
+            this._queryParamsToString({ langCode }));
+        return this._normalizeData(response, langCode);
     }
     /**
      * Quick search for product page objects with limited output.
@@ -396,18 +404,13 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
@@ -430,49 +433,21 @@ class ProductsApi extends asyncModules_1.default {
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering. The counts do not depend on the language: on a language where the catalog is empty they still count every product (CMS-1201).
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageId getProductsCountByPageId} documentation.
      */
     async getProductsCountByPageId(id, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     body = []) {
-        const result = await this._fetchPost(`/page/${id}/counts`, body);
+        const result = await this._fetchPost(`/page/${this._pathSegment(String(id))}/counts`, body);
         return result;
     }
-    /**
-     * Getting the number of products for the catalog page by page url.
-     * @handleName getProductsCountByPageUrl
-     * @param {string} url - Page URL.
-     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
-     * @example
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          }
-        ]
-     * @returns {Promise<IProductsCount | IError>} Object with product items count.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageUrl getProductsCountByPageUrl} documentation.
-     */
     /**
      * Semantic (vector) search for products.
      * @handleName getProductsByVectorSearch
@@ -495,15 +470,27 @@ class ProductsApi extends asyncModules_1.default {
         return this._normalizeData(result, langCode);
     }
     /**
-     * Get products by page url.
-     * @param {string} url - Page URL.
-     * @param {any[]} body - Request body.
-     * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
+     * Getting the number of products for the catalog page by page url.
+     * @handleName getProductsCountByPageUrl
+     * @param {string} url - Page URL. Example: "catalog".
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
+     * @example
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "eq",
+            "conditionValue": 51
+          }
+        ]
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering. The counts do not depend on the language: on a language where the catalog is empty they still count every product (CMS-1201).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageUrl getProductsCountByPageUrl} documentation.
      */
     async getProductsCountByPageUrl(url, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     body = []) {
-        const result = await this._fetchPost(`/page/url/${url}/counts`, body);
+        const result = await this._fetchPost(`/page/url/${this._pathSegments(url)}/counts`, body);
         return result;
     }
 }

package/dist/products/productsInterfaces.d.ts

@@ -42,7 +42,7 @@ interface IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -60,7 +60,7 @@ interface IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @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.
@@ -80,7 +80,7 @@ interface IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -98,7 +98,7 @@ interface IProductsApi {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock"
         }
      * @returns {IProductsInfo} Array with ProductInformation objects.
@@ -119,7 +119,7 @@ interface IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -138,7 +138,7 @@ interface IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock",
           "templateMarker": "template_12345"
         }
@@ -150,14 +150,14 @@ interface IProductsApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Comma-separated IDs of the product pages to fetch. Example: "12345,67890".
+     * @param {string} ids - Comma-separated product IDs. Unknown ids are dropped and repeated ones collapsed; a non-numeric one answers `400 Incorrect request`. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsByIdsQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
@@ -169,7 +169,7 @@ interface IProductsApi {
      * @handleName getProductById
      * @param {number} id - Product ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {boolean} [isNormalized] - When `true`, the product is returned in normalized form.
+     * @param {boolean} [isNormalized] - Deprecated: the API no longer reads it, the answer is the same with `true`, `false` or without it. Kept for compatibility.
      * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves one product object.
@@ -179,11 +179,12 @@ interface IProductsApi {
      * Getting a product block object by product id.
      * @handleName getProductBlockById
      * @param {number} id - Product ID. Example: 12345.
-     * @returns {IProductBlock}
+     * @param {string} [langCode] - Language code. Default: the client's language.
+     * @returns {IProductBlock[]} Array of the product's block objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets a product block object by product id.
      */
-    getProductBlockById(id: number): Promise<IProductBlock[] | IError>;
+    getProductBlockById(id: number, langCode?: string): Promise<IProductBlock[] | IError>;
     /**
      * Quick search for product page objects with limited output.
      * @handleName searchProduct
@@ -202,23 +203,8 @@ interface IProductsApi {
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {IProductsCount} Object with product items count.
@@ -235,23 +221,8 @@ interface IProductsApi {
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {IProductsCount} Object with product items count.
@@ -263,28 +234,13 @@ interface IProductsApi {
      * Getting the number of products on a catalog page by page URL.
      * @handleName getProductsCountByPageUrl
      * @param {string} url - Page URL. Example: "catalog".
-     * @param {string} body - Filter objects with search conditions. Default: `[]`.
+     * @param {object[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {IProductsCount} Object with product items count.
@@ -311,7 +267,7 @@ interface IProductsApi {
  * @property {number} limit - Maximum number of records to return. Default: 30.
  * @property {string} sortOrder - Sort order: "DESC" or "ASC". Default: "DESC".
  * @property {string} sortKey - Field to sort by: "id", "position", "title", "date", "price" or "status". Default: null.
- * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
+ * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
  * @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.
  */
@@ -342,7 +298,7 @@ interface IProductsRelatedQuery extends IProductsQueryBase {
  * @property {number} [offset] - Number of records to skip. Default: 0.
  * @property {number} [limit] - Maximum number of records to return. Default: 30.
  * @property {string} [sortOrder] - Sort order: "DESC" or "ASC". Default: "DESC".
- * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
+ * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
  * @property {string | null} [statusMarker] - Marker of the product status. Default: null. Example: "in_stock".
  */
 type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
@@ -352,7 +308,7 @@ type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
  * Query parameters for getProductsByIds: only price fixing — `ids` is passed
  * as a dedicated method argument.
  * @typedef {object} IProductsByIdsQuery
- * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
+ * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
  */
 type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
 /**
@@ -389,7 +345,7 @@ interface IFilterParams {
 }
 /**
  * @interface IProductAdditional
- * @property {object} prices - Aggregated price range for the product across all variants.
+ * @property {object} prices - Price range of the **whole catalogue**, the same on every product: it depends neither on the product nor on the request filter (two products priced 51 and 150 both carry `{ min: 51, max: 180 }`). Use it for the bounds of a price slider, not for a product's own "from–to" price.
  * @property {number} prices.min - Minimum price value. Example: 5.
  * @property {number} prices.max - Maximum price value. Example: 150.
  * @description Additional indexed values attached to a product entity.
@@ -399,8 +355,8 @@ interface IProductAdditional {
 }
 /**
  * @interface IProductPriceRange
- * @property {number} min - Minimum price across product variants. Example: 5.
- * @property {number} max - Maximum price across product variants. Example: 150.
+ * @property {number} min - Lowest price in the catalogue. Example: 5.
+ * @property {number} max - Highest price in the catalogue. Example: 150.
  * @description Aggregated price range for a product, computed from all its variants.
  */
 interface IProductPriceRange {
@@ -442,14 +398,20 @@ interface IProductPageRef {
     }
  * @property {string | null} sku - Product SKU from the search index, or `null`. Example: "SKU_12345".
  * @property {boolean} isSync - Whether the product is indexed. Example: true.
- * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker (an object, not an array).
  * @example
-    [
-      {
-        "id": "color",
-        "value": "red"
+    {
+      "product-name": {
+        "type": "string",
+        "value": "Split",
+        "position": 0
+      },
+      "price": {
+        "type": "integer",
+        "value": 150,
+        "position": 1
       }
-    ]
+    }
  * @property {string[]} categories - URLs of the catalog pages the product belongs to.
  * @example
     [
@@ -461,7 +423,7 @@ interface IProductPageRef {
  * @property {Array<IFormConfig>} [moduleFormConfigs] - Form configurations of the module.
  * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
  * @property {boolean} [isPositionLocked] - Whether the sorting position is locked. Example: false.
- * @property {number[]} relatedIds - IDs of related products.
+ * @property {number[]} [relatedIds] - IDs of related products.
  * @example
     [
       12345,
@@ -485,7 +447,7 @@ interface IProductPageRef {
         "categoryPath": "products"
       }
     ]
- * @property {string[]} [blocks] - Markers of the blocks attached to the product.
+ * @property {string[]} [blocks] - Markers of the blocks shown on the product page (not the blocks whose selection includes the product).
  * @example
     [
       "block_12345",
@@ -613,19 +575,20 @@ interface IProductInfo {
  * @property {number} version - Version number of the product block. Example: 1.
  * @property {number} position - Position of the product block in a list or layout. Example: 1.
  * @property {string} identifier - Marker of the product block. Example: "product_block_12345".
- * @property {BlockType} type - Block type. Example: "product".
+ * @property {BlockType} type - Block type. Example: "product_block".
  * @property {object} customSettings - Custom settings of the product block: slider delay, product configuration, similar-product rules and conditions. Example: {}
  * @property {string | null} templateIdentifier - Marker of the template used by the product block, or `null`. Example: "template_12345".
  * @property {boolean} isVisible - Whether the product block is visible. Example: true.
  * @property {boolean} isSync - Whether the product block is synchronized. Example: false.
- * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker (an object, not an array); `{}` when the block has no attributes.
  * @example
-    [
-      {
-        "id": "color",
-        "value": "red"
+    {
+      "block-text": {
+        "type": "string",
+        "value": "Similar products",
+        "position": 0
       }
-    ]
+    }
  * @description This interface defines the structure of a product block entity, including its identifiers, attributes, and custom settings.
  */
 /**
@@ -725,4 +688,4 @@ interface IVectorSearchProducts {
     maxHits?: number;
     debug?: boolean;
 }
-export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductSearchResult, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts, };
+export type { IAggregatedProductGroup, IFilterParams, IProductAdditional, IProductBlock, IProductBlockProductConfig, IProductBlockSettings, IProductBlockSimilarRule, IProductInfo, IProductPageRef, IProductPriceRange, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductSearchResult, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts, };

package/dist/search/searchApi.d.ts

@@ -22,7 +22,7 @@ export default class SearchApi extends AsyncModules implements ISearchApi {
      * Public search across titles and attribute values of visible records.
      * @handleName globalSearch
      * @param {string} query - Search query. Example: "winter".
-     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
+     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted or empty.
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
      * @param {number} [offset] - Offset for drilldown mode. Pass it only together with exactly one accessible type in `types`.
      * @param {number} [limit] - Page size for drilldown mode. Pass it only together with exactly one accessible type in `types`; otherwise the API responds with `400 Drilldown mode (limit/offset) requires exactly one accessible type in types`. Without it, every group is returned in full.

package/dist/search/searchApi.js

@@ -60,7 +60,7 @@ class SearchApi extends asyncModules_1.default {
      * Public search across titles and attribute values of visible records.
      * @handleName globalSearch
      * @param {string} query - Search query. Example: "winter".
-     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
+     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted or empty.
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
      * @param {number} [offset] - Offset for drilldown mode. Pass it only together with exactly one accessible type in `types`.
      * @param {number} [limit] - Page size for drilldown mode. Pass it only together with exactly one accessible type in `types`; otherwise the API responds with `400 Drilldown mode (limit/offset) requires exactly one accessible type in types`. Without it, every group is returned in full.
@@ -76,7 +76,8 @@ class SearchApi extends asyncModules_1.default {
         // without it a word of a second locale answers an empty group (CMS-912).
         const params = {
             q: query,
-            types,
+            // An empty array would go out as `types=` and the API answers no groups
+            types: types && types.length > 0 ? types : undefined,
             visibility,
             offset,
             limit,
@@ -84,7 +85,7 @@ class SearchApi extends asyncModules_1.default {
         };
         const data = await this._fetchGet(`?` + this._queryParamsToString(params));
         const validated = await this._validateResponse(data, schema('GlobalSearchResponseSchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
 }
 exports.default = SearchApi;