oneentry 1.0.159 → 1.0.161

package/esm/blocks/blocksApi.js

@@ -0,0 +1,394 @@
+/* eslint-disable jsdoc/reject-any-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./blocksSchemas.js'));
+/**
+ * Controllers for working with blocks.
+ * @handle /api/content/blocks
+ * @class BlocksApi
+ * @augments AsyncModules
+ * @implements {IBlocks}
+ * @description This class provides methods to interact with blocks.
+ */
+export default class BlocksApi extends AsyncModules {
+    /**
+     * Constructor for BlocksApi class.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/blocks';
+    }
+    /**
+     * 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 {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<IBlocksResponse | IError>} Returns BlocksEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getBlocks getBlocks} documentation.
+     */
+    async getBlocks(type, langCode = this.state.lang, offset = 0, limit = 30) {
+        // type is omitted from the query when not provided — the API rejects an
+        // empty type value, so it must not be sent at all.
+        const query = this._queryParamsToString({ langCode, type, offset, limit });
+        const response = await this._fetchPost(`?${query}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(response, schema('BlocksResponseSchema'));
+        if (!this.state.traficLimit) {
+            const normalizeResponse = this._normalizeData(validated);
+            // On API error responses (e.g. 403 without list permission, 422) the
+            // normalized value is an IError without `items` — skip enrichment and
+            // return it as-is
+            if (Array.isArray(normalizeResponse.items)) {
+                await Promise.all(normalizeResponse.items.map((block) => this._enrichBlock(block, langCode, offset, limit, true)));
+            }
+            return normalizeResponse;
+        }
+        return this._normalizeData(validated);
+    }
+    /**
+     * Get block by marker.
+     * @handleName getBlockByMarker
+     * @param {string} marker - Marker of Block. Example: "product_block".
+     * @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<IBlockEntity | IError>} - Returns a BlockEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method retrieves a block by its marker and includes additional information such as similar products or products associated with the block.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getBlockByMarker getBlockByMarker} documentation.
+     */
+    async getBlockByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
+        const response = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(response, schema('BlockEntitySchema'));
+        const normalizeResponse = this._normalizeData(validated);
+        await this._enrichBlock(normalizeResponse, langCode, offset, limit, !this.state.traficLimit);
+        return normalizeResponse;
+    }
+    /**
+     * Enrich a single block in place.
+     *
+     * Lifts product display settings from `customSettings.productConfig` to
+     * numeric top-level fields, strips internal-only fields, and — when
+     * `loadProducts` is true — fetches the related products for
+     * `similar_products_block` / `product_block` blocks. Shared by `getBlocks`
+     * (array) and `getBlockByMarker` (single block). Mutates `block` in place.
+     * @param {any} block - Normalized block to enrich (mutated in place).
+     * @param {string} langCode - Language code passed to product sub-requests.
+     * @param {number} offset - Pagination offset for product sub-requests.
+     * @param {number} limit - Pagination limit for product sub-requests.
+     * @param {boolean} loadProducts - Whether to fetch related products.
+     * @returns {Promise<void>} Resolves when enrichment (incl. sub-requests) is done.
+     */
+    async _enrichBlock(block, langCode, offset, limit, loadProducts) {
+        const customSettings = block.customSettings;
+        // Если у блока есть настройки отображения товаров (productConfig) —
+        // переносим их на верхний уровень блока в числовом формате (в API значения
+        // хранятся строками, поэтому приводим через «+»).
+        if (customSettings &&
+            Object.prototype.hasOwnProperty.call(customSettings, 'productConfig')) {
+            if (customSettings.productConfig.countElementsPerRow)
+                block.countElementsPerRow =
+                    +customSettings.productConfig.countElementsPerRow;
+            if (customSettings.productConfig.quantity)
+                block.quantity = +customSettings.productConfig.quantity;
+        }
+        // Убираем служебные/внутренние поля из итогового объекта блока.
+        delete block.customSettings;
+        delete block.attributesSetIdentifier;
+        delete block.productPageUrls;
+        // В режиме экономии трафика товары не подгружаем.
+        if (!loadProducts)
+            return;
+        // Подгружаем связанные товары по идентификатору блока. При ошибке запроса
+        // подставляем пустой массив, чтобы один упавший подзапрос не ронял весь
+        // ответ (в getBlocks — не ломал обработку остальных блоков).
+        if (block.type === 'similar_products_block') {
+            try {
+                block.similarProducts = await this.getSimilarProducts(block.identifier, langCode, offset, limit);
+            }
+            catch {
+                block.similarProducts = [];
+            }
+        }
+        else if (block.type === 'product_block') {
+            try {
+                block.products = await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit);
+            }
+            catch {
+                block.products = [];
+            }
+        }
+    }
+    /**
+     * Get similar products by block marker.
+     * @handleName getSimilarProducts
+     * @param {string} marker - Block identifier. Example: "similar_products_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [productId] - Optional product id to find similar products for.
+     * @returns {Promise<IProductsResponse | IError>} Returns the total count and an array of product items in object by specified block marker.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getSimilarProducts getSimilarProducts} documentation.
+     */
+    async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice, productId) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+            signPrice,
+            productId,
+        };
+        const result = await this._fetchGet(`/${marker}/similar-products?` + this._queryParamsToString(query));
+        return this._normalizeData(result);
+    }
+    /**
+     * Get products by block marker.
+     * @handleName getProductsByBlockMarker
+     * @param {string} marker - Block identifier. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getProductsByBlockMarker getProductsByBlockMarker} documentation.
+     */
+    async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+            signPrice,
+        };
+        const result = await this._fetchGet(`/${marker}/products?` + this._queryParamsToString(query));
+        // On API error responses there is no `items` array — return the (normalized)
+        // error as-is instead of producing `undefined` from `result.items`.
+        if (!Array.isArray(result === null || result === void 0 ? void 0 : result.items)) {
+            return this._normalizeData(result);
+        }
+        return this._normalizeData(result.items);
+    }
+    /**
+     * Get frequently ordered products by block marker and product id.
+     * @handleName getFrequentlyOrderedProducts
+     * @param {number} productId - Product id. Example: 1.
+     * @param {string} marker - Block marker. Example: "frequently_ordered_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns a products response with items and total.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getFrequentlyOrderedProducts getFrequentlyOrderedProducts} documentation.
+     */
+    async getFrequentlyOrderedProducts(productId, marker, langCode = this.state.lang, signPrice) {
+        const query = {
+            langCode,
+            signPrice,
+        };
+        const data = await this._fetchGet(`/${marker}/products/${productId}/frequently-ordered?` +
+            this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Quick search for block objects with limited output.
+     * @handleName searchBlock
+     * @param {string} name - Search string. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ISearchBlock[] | IError>} Returns an array of ISearchBlock objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/searchBlock searchBlock} documentation.
+     */
+    async searchBlock(name, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/quick/search?langCode=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('SearchBlocksResponseSchema'));
+        return validated;
+    }
+    /**
+     * Get "complete your cart" products by the cart from context (auth user or guest).
+     * @handleName getCartComplement
+     * @param {string} marker - Block marker. Example: "cart_complement_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartComplement getCartComplement} documentation.
+     */
+    async getCartComplement(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/cart-complement?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get "complete your cart" products by an explicit list of productIds (POST body).
+     * @handleName getCartComplementByProductIds
+     * @param {string} marker - Block marker. Example: "cart_complement_block".
+     * @param {IBlockProductsLookup} body - Lookup body.
+     * @example
+        {
+          "productIds": [1, 2],
+          "langCode": "en_US"
+        }
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartComplementByProductIds getCartComplementByProductIds} documentation.
+     */
+    async getCartComplementByProductIds(marker, body) {
+        const data = await this._fetchPost(`/${marker}/cart-complement`, { langCode: this.state.lang, ...body });
+        return this._normalizeData(data);
+    }
+    /**
+     * Get "similar to cart" products by the cart from context (auth user or guest).
+     * @handleName getCartSimilar
+     * @param {string} marker - Block marker. Example: "cart_similar_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartSimilar getCartSimilar} documentation.
+     */
+    async getCartSimilar(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/cart-similar?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get "similar to cart" products by an explicit list of productIds (POST body).
+     * @handleName getCartSimilarByProductIds
+     * @param {string} marker - Block marker. Example: "cart_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup body.
+     * @example
+        {
+          "productIds": [1, 2],
+          "langCode": "en_US"
+        }
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartSimilarByProductIds getCartSimilarByProductIds} documentation.
+     */
+    async getCartSimilarByProductIds(marker, body) {
+        const data = await this._fetchPost(`/${marker}/cart-similar`, { langCode: this.state.lang, ...body });
+        return this._normalizeData(data);
+    }
+    /**
+     * Get personal recommendations for the user.
+     * @handleName getPersonalRecommendations
+     * @param {string} marker - Block marker. Example: "personal_recommendations_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getPersonalRecommendations getPersonalRecommendations} documentation.
+     */
+    async getPersonalRecommendations(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/personal-recommendations?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get recently viewed products.
+     * @handleName getRecentlyViewed
+     * @param {string} marker - Block marker. Example: "recently_viewed_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRecentlyViewed getRecentlyViewed} documentation.
+     */
+    async getRecentlyViewed(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/recently-viewed?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get products for repeat purchase.
+     * @handleName getRepeatPurchase
+     * @param {string} marker - Block marker. Example: "repeat_purchase_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRepeatPurchase getRepeatPurchase} documentation.
+     */
+    async getRepeatPurchase(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/repeat-purchase?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get the block's slides tree as a flat pre-order array (slider_block only).
+     * @handleName getSlides
+     * @param {string} marker - Block marker. Example: "slider_block".
+     * @returns {Promise<IBlockSlidesResponse | IError>} Returns the slides response.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getSlides getSlides} documentation.
+     */
+    async getSlides(marker) {
+        const data = await this._fetchGet(`/${marker}/slides`);
+        return this._normalizeData(data);
+    }
+    /**
+     * Get trending products of the block.
+     * @handleName getTrending
+     * @param {string} marker - Block marker. Example: "trending_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getTrending getTrending} documentation.
+     */
+    async getTrending(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/trending?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get "similar to wishlist" products by the wishlist from context (auth user or guest).
+     * @handleName getWishlistSimilar
+     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {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/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getWishlistSimilar getWishlistSimilar} documentation.
+     */
+    async getWishlistSimilar(marker, langCode = this.state.lang, signPrice) {
+        const query = { langCode, signPrice };
+        const data = await this._fetchGet(`/${marker}/wishlist-similar?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get "similar to wishlist" products by an explicit list of productIds (POST body).
+     * @handleName getWishlistSimilarByProductIds
+     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup body.
+     * @example
+        {
+          "productIds": [1, 2],
+          "langCode": "en_US"
+        }
+     * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getWishlistSimilarByProductIds getWishlistSimilarByProductIds} documentation.
+     */
+    async getWishlistSimilarByProductIds(marker, body) {
+        const data = await this._fetchPost(`/${marker}/wishlist-similar`, { langCode: this.state.lang, ...body });
+        return this._normalizeData(data);
+    }
+}