oneentry 1.0.138 → 1.0.140

package/dist/products/productsApi.js

@@ -1,464 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable jsdoc/reject-any-type */
-const asyncModules_1 = __importDefault(require("../base/asyncModules"));
-const productsSchemas_1 = require("./productsSchemas");
-/**
- * Controllers for working with product pages
- * @handle /api/content/products
- * @description Controllers for working with product pages
- */
-class ProductApi extends asyncModules_1.default {
-    /**
-     * Constructor
-     * @param {StateModule} state - StateModule instance
-     * @description Constructor initializes the ProductApi with a given state.
-     */
-    constructor(state) {
-        super(state);
-        this._defaultQuery = {
-            offset: 0,
-            limit: 30,
-            sortOrder: 'DESC',
-            sortKey: 'id',
-        };
-        this._url = state.url + '/api/content/products';
-    }
-    /**
-     * Search for all products with pagination and filter.
-     * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @example
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "mth",
-            "statusMarker": "waiting",
-            "conditionValue": 1,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "lth",
-            "conditionValue": 3,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          }
-        ]
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "signPrice": "orders",
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "limit": 30,
-          "offset": 0,
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @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.
-     */
-    async getProducts(body = [], langCode = this.state.lang, userQuery) {
-        const query = {
-            ...this._defaultQuery,
-            ...userQuery,
-            langCode,
-        };
-        const result = await this._fetchPost(`/all?` + this._queryParamsToString(query), body);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductsResponseSchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Search for all product page objects with pagination that do not have a category.
-     * @handleName getProductsEmptyPage
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Search for all product page objects with pagination that do not have a category.
-     */
-    async getProductsEmptyPage(langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
-        const result = await this._fetchGet(`/empty-page?langCode=${langCode}&` + this._queryParamsToString(query));
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductsResponseSchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Search for all products with pagination for the selected category.
-     * @handleName getProductsByPageId
-     * @param {number} id - Page id. Example: 2492.
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @example
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "mth",
-            "statusMarker": "waiting",
-            "conditionValue": 1,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "lth",
-            "conditionValue": 3,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          }
-        ]
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Fetch products by page ID with optional filters and pagination.
-     */
-    async getProductsByPageId(id, body = [], langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
-        const result = await this._fetchPost(`/page/${id}?langCode=${langCode}&` + this._queryParamsToString(query), body);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductsResponseSchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Search for information about products and prices for the selected category.
-     * @handleName getProductsPriceByPageUrl
-     * @param {string} [url] - Page url. Example: "23-laminat-floorwood-maxima".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Search for information about products and prices for the selected category.
-     */
-    async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
-        const query = {
-            ...this._defaultQuery,
-            ...userQuery,
-            langCode,
-        };
-        const result = await this._fetchGet(`/page/${url}/prices?` + this._queryParamsToString(query));
-        return result;
-    }
-    /**
-     * Search for all products with pagination for the selected category.
-     * @handleName getProductsByPageUrl
-     * @param {string} url - Page url. Example: "catalog".
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @example
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "mth",
-            "statusMarker": "waiting",
-            "conditionValue": 1,
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "lth",
-            "conditionValue": 3,
-            "pageUrls": [
-            "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          }
-        ]
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Search for all products with pagination for the selected category.
-     */
-    async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
-        const result = await this._fetchPost(`/page/url/${url}?langCode=${langCode}&` +
-            this._queryParamsToString(query), body);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductsResponseSchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Find all related product page objects.
-     * @handleName getRelatedProductsById
-     * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @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".
-     * @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.
-     */
-    async getRelatedProductsById(id, langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
-        const result = await this._fetchGet(`/${id}/related?langCode=${langCode}&` + this._queryParamsToString(query));
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductsResponseSchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Find products by its ids.
-     * @handleName getProductsByIds
-     * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
-     * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @example
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @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 {number} [userQuery.statusId] - Optional parameter - search by status id. Example: 123.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: "in_stock".
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: "new".
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: "equals".
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: "color".
-     * @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.
-     */
-    async getProductsByIds(ids, langCode = this.state.lang, userQuery) {
-        const query = {
-            ids,
-            langCode,
-            ...this._defaultQuery,
-            ...userQuery,
-        };
-        const result = await this._fetchGet(`/ids?` + this._queryParamsToString(query));
-        return this._dataPostProcess(result, langCode);
-    }
-    /**
-     * Retrieve one product object.
-     * @handleName getProductById
-     * @param {number} id - Product id. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Retrieve one product object.
-     */
-    async getProductById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, productsSchemas_1.ProductEntitySchema);
-        return this._dataPostProcess(validated, langCode);
-    }
-    /**
-     * Getting a product block object by product id.
-     * @handleName getProductBlockById
-     * @param {number} id - Product id. Example: 12345.
-     * @returns {Promise<IProductBlock | IError>} - Product block object.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting a product block object by product id.
-     */
-    async getProductBlockById(id) {
-        const response = await this._fetchGet(`/${id}/blocks`);
-        return this._normalizeData(response);
-    }
-    /**
-     * Quick search for product page objects with limited output.
-     * @handleName searchProduct
-     * @param {string} name - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration). Example: "laminat".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Quick search for product page objects with limited output.
-     */
-    async searchProduct(name, langCode = this.state.lang) {
-        const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
-        if (!this.state.traficLimit) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const productsList = [];
-            await Promise.all(searchProducts.map(async (product) => {
-                await this.getProductById(product.id, langCode).then((result) => {
-                    productsList.push(result);
-                });
-            }));
-            return this._dataPostProcess(productsList, langCode);
-        }
-        return searchProducts;
-    }
-    /**
-     * Getting the number of products for the entire catalog.
-     * @handleName getProductsCount
-     * @param {any[]} body - Body parameters for filter. Deault: [].
-     * @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 total number of products present across the entire catalog, optionally applying specified filters.
-     */
-    async getProductsCount(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    body = []) {
-        const result = await this._fetchPost(`/all/counts`, body);
-        return result;
-    }
-    /**
-     * Getting the number of products on a catalog page by page ID.
-     * @handleName getProductsCountByPageId
-     * @param {string} id - Page ID.
-     * @param {any[]} body - Body parameters for filter. Deault: [].
-     * @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 page ID, with optional filtering.
-     */
-    async getProductsCountByPageId(id, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    body = []) {
-        const result = await this._fetchPost(`/page/${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 - Body parameters for filter. Deault: [].
-     * @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.
-     */
-    async getProductsCountByPageUrl(url, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    body = []) {
-        const result = await this._fetchPost(`/page/url/${url}/counts`, body);
-        return result;
-    }
-}
-exports.default = ProductApi;