oneentry 1.0.176 → 1.0.178

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,20 @@ 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.
+     * @param {string} [signPrice] - Marker of an orders storage to fix the price for. When set, the product comes with a `signedPrice` holding the price for a limited time; an unknown marker fails the request with `404 Specified orders storage for price signature not found`.
      * @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) {
+    async getProductById(id, langCode = this.state.lang, isNormalized, signPrice) {
         const query = { langCode };
         if (isNormalized !== undefined)
             query.isNormalized = isNormalized;
-        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString(query));
+        if (signPrice !== undefined)
+            query.signPrice = signPrice;
+        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,27 +360,35 @@ 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.
      * @handleName searchProduct
      * @param {string} name - Text to search for in product titles (`localizeInfos.title`) in the requested language. Example: "laminat".
      * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [url] - URL of a catalog page to search within that category. Default: the whole catalog.
+     * @param {boolean} [correct] - Correct typos by the project's search dictionary first. The API defaults to `true`; pass `false` to search the query as is.
      * @returns {Promise<IProductsEntity[] | IProductSearchResult[] | IError>} Array with ProductEntity objects, or an array with short ProductSearchResult cards when the traficLimit config option is enabled
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for product page objects with limited output. The quick search endpoint returns short cards ({ id, title, pageId }); with traficLimit enabled they are returned as is, otherwise full product entities are fetched for the found ids.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/searchProduct searchProduct} documentation.
      */
-    async searchProduct(name, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/quick/search?langCode=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}`);
+    async searchProduct(name, langCode = this.state.lang, url, correct) {
+        const extra = (url ? `&url=${encodeURIComponent(url)}` : '') +
+            (correct !== undefined ? `&correct=${correct}` : '');
+        const result = await this._fetchGet(`/quick/search?langCode=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}${extra}`);
         // Validate response if validation is enabled
         const searchProducts = (await this._validateResponse(result, schema('ProductSearchResponseSchema')));
         if (!this.state.traficLimit && Array.isArray(searchProducts)) {
@@ -396,29 +411,25 @@ 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: `[]`.
+     * @param {string} [langCode] - Language code. Default: "en_US". Must be one of the project's active languages — an inactive one answers `400 langCode must be one of the active languages`. The count reflects the products visible in that language.
      * @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.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
+     * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters. The request carries `langCode`; it must be an active language of the project, otherwise the API answers `400`.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCount getProductsCount} documentation.
      */
     async getProductsCount(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    body = []) {
-        const result = await this._fetchPost(`/all/counts`, body);
+    body = [], langCode = this.state.lang) {
+        const result = await this._fetchPost(`/all/counts?` + this._queryParamsToString({ langCode }), body);
         return result;
     }
     /**
@@ -426,53 +437,27 @@ class ProductsApi extends asyncModules_1.default {
      * @handleName getProductsCountByPageId
      * @param {number | string} id - Page ID. Example: 12345.
      * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
+     * @param {string} [langCode] - Language code. Default: "en_US". Must be one of the project's active languages — an inactive one answers `400 langCode must be one of the active languages`. The count reflects the products visible in that language.
      * @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.
      * @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 request carries `langCode`; it must be an active language of the project (an inactive one answers `400`), and the count reflects the products visible in that language.
      * @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);
+    body = [], langCode = this.state.lang) {
+        const result = await this._fetchPost(`/page/${this._pathSegment(String(id))}/counts?` +
+            this._queryParamsToString({ langCode }), 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 +480,29 @@ 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: `[]`.
+     * @param {string} [langCode] - Language code. Default: "en_US". Must be one of the project's active languages — an inactive one answers `400 langCode must be one of the active languages`. The count reflects the products visible in that language.
+     * @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 request carries `langCode`; it must be an active language of the project (an inactive one answers `400`), and the count reflects the products visible in that language.
+     * @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);
+    body = [], langCode = this.state.lang) {
+        const result = await this._fetchPost(`/page/url/${this._pathSegments(url)}/counts?` +
+            this._queryParamsToString({ langCode }), body);
         return result;
     }
 }