oneentry 1.0.160 → 1.0.162

package/esm/products/productsInterfaces.d.ts

@@ -0,0 +1,723 @@
+import type { IAttributeValues, IError, ILocalizeInfo, IRating } from '../base/utils.js';
+import type { BlockType } from '../blocks/blocksInterfaces.js';
+import type { IFormConfig } from '../forms/formsInterfaces.js';
+/**
+ * @interface IProductsApi
+ * @description This interface defines methods for retrieving and managing products in the system.
+ */
+interface IProductsApi {
+    /**
+     * 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 {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "signPrice": "orders"
+        }
+     * @returns {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
+    /**
+     * Search for all product page objects with pagination that do not have a category.
+     * @handleName getProductsEmptyPage
+     * @param body
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "signPrice": "orders"
+        }
+     * @returns {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all product page objects with pagination that do not have a category.
+     */
+    getProductsEmptyPage(body?: object, langCode?: string, userQuery?: IProductsQueryBase): Promise<IAggregatedProductGroup[] | IError>;
+    /**
+     * Search for all products with pagination for the selected category.
+     * @handleName getProductsByPageId
+     * @param {number} id - Page id. Example: 12345.
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {string} [langCode] - Language code. Default "en_US".
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "signPrice": "orders"
+        }
+     * @returns {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all products with pagination for the selected category.
+     */
+    getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
+    /**
+     * 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 {IProductsPriceQuery} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "signPrice": "orders",
+          "statusMarker": "in_stock"
+        }
+     * @returns {IProductsInfo} Array with ProductInformation objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for information about products prices for the selected category.
+     */
+    getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsPriceQuery): Promise<IProductsInfo | IError>;
+    /**
+     * Search for all products with pagination for the selected category.
+     * @handleName getProductsByPageUrl
+     * @param {string} url - Page url. Example: "23-laminat-floorwood-maxima".
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "signPrice": "orders"
+        }
+     * @returns {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all products with pagination for the selected category.
+     */
+    getProductsByPageUrl(url: string, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
+    /**
+     * 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 {IProductsRelatedQuery} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "signPrice": "orders",
+          "statusMarker": "in_stock",
+          "templateMarker": "template_12345"
+        }
+     * @returns {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds all related product page objects for the selected product page.
+     */
+    getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsRelatedQuery): Promise<IProductsResponse | IError>;
+    /**
+     * 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 {IProductsByIdsQuery} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "signPrice": "orders"
+        }
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds products by its ids.
+     */
+    getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsByIdsQuery): Promise<IProductsEntity[] | IError>;
+    /**
+     * Retrieve one product object.
+     * @handleName getProductById
+     * @param {number} id - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
+     * @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.
+     */
+    getProductById(id: number, langCode?: string, isNormalized?: boolean): Promise<IProductsEntity | IError>;
+    /**
+     * Getting a product block object by product id.
+     * @handleName getProductBlockById
+     * @param {number} id - Product id. Example: 12345.
+     * @returns {IProductBlock}
+     * @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>;
+    /**
+     * 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 {IProductsEntity[] | IProductSearchResult[]} Array with ProductEntity objects, or an array with short ProductSearchResult cards when the traficLimit config option is enabled
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a quick search for product page objects with limited output. With traficLimit enabled the raw quick search response is returned as short cards; otherwise full product entities are fetched for the found ids.
+     */
+    searchProduct(name: string, langCode?: string): Promise<IProductsEntity[] | IProductSearchResult[] | IError>;
+    /**
+     * Getting the number of products for the entire catalog.
+     * @handleName getProductsCount
+     * @param {object[]} [body] - Body parameters for filter. Deault: [].
+     * @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"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
+     */
+    getProductsCount(body?: object[]): Promise<IProductsCount | IError>;
+    /**
+     * Getting the number of products on a catalog page by page ID.
+     * @handleName getProductsCountByPageId
+     * @param {string} id - Page id. Example: "12345".
+     * @param {object[]} body - Body parameters for filter. Deault: [].
+     * @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"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
+     */
+    getProductsCountByPageId(id: string, body?: object[]): Promise<IProductsCount | IError>;
+    /**
+     * Getting the number of products on a catalog page by page URL.
+     * @handleName getProductsCountByPageUrl
+     * @param {string} url - Page url. Example: "catalog".
+     * @param {string} body - Body parameters for filter. Deault: [].
+     * @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"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
+     */
+    getProductsCountByPageUrl(url: string, body?: object[]): Promise<IProductsCount | IError>;
+    /**
+     * Semantic (vector) search for products.
+     * @handleName getProductsByVectorSearch
+     * @param {IVectorSearchProducts} body - Vector search body. Example: `{ queryText: "red running shoes" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IProductsResponse} A promise that resolves to a products response (items + total) or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a semantic (vector) search for products.
+     */
+    getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IProductsResponse | IError>;
+}
+/**
+ * @interface IProductsQueryBase
+ * @property {number} offset - Parameter for pagination. Default: 0.
+ * @property {number} limit - Parameter for pagination. Default: 30.
+ * @property {string} sortOrder - Sort order "DESC" | "ASC". Default: "DESC".
+ * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.
+ * @property {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+ * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
+ * @description Base query parameters shared by the product listing endpoints (getProducts, getProductsEmptyPage, getProductsByPageId, getProductsByPageUrl): pagination, sorting and price fixing.
+ */
+interface IProductsQueryBase {
+    offset?: number;
+    limit?: number;
+    sortOrder?: 'DESC' | 'ASC' | null;
+    sortKey?: 'id' | 'position' | 'title' | 'date' | 'price' | null;
+    signPrice?: string;
+}
+/**
+ * @interface IProductsRelatedQuery
+ * @augments IProductsQueryBase
+ * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
+ * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
+ * @description Query parameters for getRelatedProductsById: the base query plus product page status and template markers.
+ */
+interface IProductsRelatedQuery extends IProductsQueryBase {
+    statusMarker?: string | null;
+    templateMarker?: string | null;
+}
+/**
+ * Query parameters for getProductsPriceByPageUrl: the base query without
+ * `sortKey`, plus the product page status marker.
+ * @typedef {object} IProductsPriceQuery
+ * @property {number} [offset] - Parameter for pagination. Default: 0.
+ * @property {number} [limit] - Parameter for pagination. Default: 30.
+ * @property {string} [sortOrder] - Sort order "DESC" | "ASC". Default: "DESC".
+ * @property {string} [signPrice] - Order storage marker for price fixing.
+ * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
+ */
+type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
+    statusMarker?: string | null;
+};
+/**
+ * Query parameters for getProductsByIds: only price fixing — `ids` is passed
+ * as a dedicated method argument.
+ * @typedef {object} IProductsByIdsQuery
+ * @property {string} [signPrice] - Order storage marker for price fixing.
+ */
+type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
+/**
+ * Query parameters for retrieving products.
+ * @deprecated Use the per-method query types instead — IProductsQueryBase
+ * (getProducts / getProductsEmptyPage / getProductsByPageId / getProductsByPageUrl),
+ * IProductsRelatedQuery (getRelatedProductsById), IProductsPriceQuery
+ * (getProductsPriceByPageUrl) or IProductsByIdsQuery (getProductsByIds).
+ * Kept as an alias of the base query for backward compatibility.
+ * @typedef {IProductsQueryBase} IProductsQuery
+ */
+type IProductsQuery = IProductsQueryBase;
+/**
+ * @interface IFilterParams
+ * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
+ * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "equals".
+ * @property {number | string | null} conditionValue - The value that is being searched for, default null. Example: "new".
+ * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
+ * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
+ * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
+ * @property {string | null} [title] - Product name. Example: "Laminatboden Maxima".
+ * @property {boolean} [isNested] - Flag for nested attributes, default false. Example: true.
+ * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
+ */
+interface IFilterParams {
+    attributeMarker: string;
+    conditionMarker?: 'in' /** 'in' - Contains */ | 'nin' /** 'nin' - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | 'pat' /** 'pat' - Matches pattern */ | 'same' /** 'same' - Matches the value exactly */ | 'same_part' /** 'same_part' - Matches a part of the value exactly */ | null;
+    conditionValue: number | string | null;
+    pageUrl?: string | null;
+    pageUrls?: string[] | null;
+    statusMarker?: string;
+    title?: string;
+    isNested?: boolean;
+}
+/**
+ * @interface IProductAdditional
+ * @property {object} prices - Aggregated price range for the product across all variants.
+ * @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.
+ */
+interface IProductAdditional {
+    prices: IProductPriceRange;
+}
+/**
+ * @interface IProductPriceRange
+ * @property {number} min - Minimum price across product variants. Example: 5.
+ * @property {number} max - Maximum price across product variants. Example: 150.
+ * @description Aggregated price range for a product, computed from all its variants.
+ */
+interface IProductPriceRange {
+    min: number;
+    max: number;
+}
+/**
+ * @interface IProductPageRef
+ * @property {number} id - Unique identifier of the product-to-page link record. Example: 16.
+ * @property {number} pageId - Identifier of the page the product is linked to. Example: 4.
+ * @property {number} productId - Identifier of the product. Example: 15.
+ * @property {number} positionId - Sorting position identifier within the page. Example: 244.
+ * @property {string} categoryPath - Category path of the page the product belongs to. Example: "products".
+ * @description Reference linking a product to one of the pages it is published on.
+ */
+interface IProductPageRef {
+    id: number;
+    pageId: number;
+    productId: number;
+    positionId: number;
+    categoryPath: string;
+}
+/**
+ * @interface IProductsEntity
+ * @property {number} id - The unique identifier. Example: 12345.
+ * @property {ILocalizeInfo} localizeInfos - The name of the products, taking into account localization. Example: {}.
+ * @property {string | null} statusIdentifier - Product page status identifiers (may be null). Example: "in_stock".
+ * @property {ILocalizeInfo} statusLocalizeInfos - Localized status name for the product. Example: `{ "title": "Sale" }`.
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "set_12345".
+ * @property {number} position - Item number (for sorting). Example: 1.
+ * @property {number | null} price - The value of the product page price taken from the index. Example: 150.00.
+ * @property {object} additional - Additional value from the index.
+ * @example
+    {
+      "prices": {
+        "min": 5,
+        "max": 150
+      }
+    }
+ * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
+ * @property {boolean} isSync - Indication of page indexing. Example: true.
+ * @property {IAttributeValues} attributeValues - Array of attribute values from the index, represented.
+ * @example
+    [
+      {
+        "id": "color",
+        "value": "red"
+      }
+    ]
+ * @property {string[]} categories - Product categories.
+ * @example
+    [
+      1,
+      2,
+      3
+    ]
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations (optional).
+ * @property {IRating} [rating] - Rating data.
+ * @property {boolean} isPositionLocked - Sorting position lock indicator (optional). Example: false.
+ * @property {number[]} relatedIds - Ids of related product pages.
+ * @example
+    [
+      12345,
+      67890
+    ]
+ * @property {unknown} [paymentStages] - Payment stages data (may be null). Example: null.
+ * @property {number} [distance] - Vector (semantic) search relevance distance. Present only in results of vector search. Example: 0.42.
+ * @property {Record<string, unknown>} [discountConfig] - Discount configuration object. Example: {}.
+ * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
+ * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
+ * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
+ * @property {IProductPageRef[]} [productPages] - Array of product page references linking the product to its pages.
+ * @example
+    [
+      {
+        "id": 16,
+        "pageId": 4,
+        "productId": 15,
+        "positionId": 244,
+        "categoryPath": "products"
+      }
+    ]
+ * @property {string[]} [blocks] - Array of block identifiers.
+ * @example
+    [
+      "block_12345",
+      "block_67890"
+    ]
+ * @description This interface defines the structure of a product entity, including its identifiers, attributes, and related information.
+ */
+interface IProductsEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    statusIdentifier: string | null;
+    statusLocalizeInfos: ILocalizeInfo;
+    attributeSetIdentifier: string | null;
+    position: number;
+    price: number | null;
+    additional: IProductAdditional;
+    sku: string | null;
+    isSync: boolean;
+    attributeValues: IAttributeValues;
+    categories: string[];
+    isVisible: boolean;
+    moduleFormConfigs?: Array<IFormConfig>;
+    rating?: IRating;
+    templateIdentifier?: string | null;
+    shortDescTemplateIdentifier?: string | null;
+    signedPrice?: string;
+    productPages?: IProductPageRef[];
+    blocks?: string[];
+    isPositionLocked?: boolean;
+    relatedIds?: number[];
+    paymentStages?: unknown;
+    distance?: number;
+    discountConfig?: Record<string, unknown>;
+}
+/**
+ * @interface IProductsResponse
+ * @property {number} total - The total number of products found. Example: 100.
+ * @property {IProductsEntity[]} items - An array of product entities.
+ * @example
+    [
+      {
+        "id": 12345,
+        "title": "Product 1"
+      },
+      {
+        "id": 67890,
+        "title": "Product 2"
+      }
+    ]
+ * @property {number} [totalFound] - Number of products matched before limits are applied; returned by block product endpoints (`similarProducts`, cart/wishlist recommendations, frequently ordered). Optional. Example: 2.
+ * @description This interface defines the structure of a response containing multiple product entities, including the total count and an array of product items.
+ */
+interface IProductsResponse {
+    items: IProductsEntity[];
+    total: number;
+    totalFound?: number;
+}
+/**
+ * @interface IProductSearchResult
+ * @property {number} id - The identifier of the product. Example: 2957.
+ * @property {string} title - Product title in the requested language. Example: "Cosmo".
+ * @property {number} pageId - The identifier of the catalog page the product is linked to. Example: 10.
+ * @description This interface defines the short product card returned by the quick search endpoint when the traficLimit config option is enabled. It contains only identification fields, without attributeValues, localizeInfos and other fields of a full product entity.
+ */
+interface IProductSearchResult {
+    id: number;
+    title: string;
+    pageId: number;
+}
+/**
+ * @interface IProductsCount
+ * @property {number} totalAll - The total number of products found. Example: 100.
+ * @property {number} totalInCategory - The total number of products found in category. Example: 50.
+ * @property {number} totalInCategoryWithNested - The total number of products found in nested category. Example: 10.
+ * @description This interface defines the structure of a response with total count of product items.
+ */
+interface IProductsCount {
+    totalAll: number;
+    totalInCategory: number;
+    totalInCategoryWithNested: number;
+}
+/**
+ * @interface IProductsInfo
+ * @property {number} total - The total number of products found. Example: 100.
+ * @property {IProductInfo[]} items - An array of product information objects.
+ * @example
+    [
+      {
+        "id": 12345,
+        "price": 150.00
+      },
+      {
+        "id": 67890,
+        "price": 200.00
+      }
+    ]
+ * @description This interface defines the structure of a response containing product information, including the total count and an array of product items.
+ */
+interface IProductsInfo {
+    items: Array<IProductInfo>;
+    total: number;
+}
+/**
+ * @interface IProductInfo
+ * @property {number} id - The unique identifier of the product. Example: 12345.
+ * @property {number} price - The price of the product. Example: 150.00.
+ * @property {string} [signedPrice] - The signed (fixed) price of the product, returned when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
+ * @description This interface defines the structure of a product information object, including its identifier and price.
+ */
+interface IProductInfo {
+    id: number;
+    price: number;
+    signedPrice?: string;
+}
+/**
+ * @interface IProductBlock
+ * @property {number} id - Unique identifier of the product block. Example: 3289.
+ * @property {string | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: "product_block".
+ * @property {ILocalizeInfo} localizeInfos - Localization information for the product block.
+ * @example
+    {
+      "title": "Box"
+    }
+ * @property {number} version - Version of the product block entity. Example: 1.
+ * @property {number} position - Position of the product block in a list or layout. Example: 1.
+ * @property {string} identifier - Unique string identifier for the product block. Example: "product_block_12345".
+ * @property {BlockType} type - Type of the product block, such as "product", "error_page", etc. Example: "product".
+ * @property {object} customSettings - Custom settings for the product block, including slider delay, product configuration, similar product rules, and conditions. Example: {}
+ * @property {string | null} templateIdentifier - Identifier for the template used by the product block, or null if not applicable. Example: "template_12345".
+ * @property {boolean} isVisible - Indicates whether the product block is visible. Example: true.
+ * @property {boolean} isSync - Indicates whether the product block is synchronized. Example: false.
+ * @property {IAttributeValues} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value.
+ * @example
+    [
+      {
+        "id": "color",
+        "value": "red"
+      }
+    ]
+ * @description This interface defines the structure of a product block entity, including its identifiers, attributes, and custom settings.
+ */
+/**
+ * @interface IProductBlockSettings
+ * @property {number | null} sliderDelay - Slider auto-advance delay. Example: 5000.
+ * @property {string | null} sliderDelayType - Unit of `sliderDelay` (e.g. "ms", "s"). Example: "ms".
+ * @property {IProductBlockProductConfig} productConfig - Layout configuration for products inside the block.
+ * @property {IProductBlockSimilarRule[]} similarProductRules - Rules used to find similar products.
+ * @property {Record<string, unknown>} condition - Filter condition applied to products in the block; field set varies by condition type (e.g. `{ name: "cost", costFrom: 0, costTo: 130 }`).
+ * @property {Record<string, unknown> | null} [frequentlyOrderedConfig] - Configuration for the frequently-ordered products feature, or null when not configured.
+ * @description Custom settings of a product block — controls layout, sorting and similarity rules.
+ */
+interface IProductBlockSettings {
+    sliderDelay: number | null;
+    sliderDelayType: string | null;
+    productConfig: IProductBlockProductConfig;
+    similarProductRules: IProductBlockSimilarRule[];
+    condition: Record<string, unknown>;
+    frequentlyOrderedConfig?: Record<string, unknown> | null;
+}
+/**
+ * @interface IProductBlockProductConfig
+ * @property {string | number} [quantity] - Number of products to render; absent when the block config is empty. Example: 9.
+ * @property {string | number} [countElementsPerRow] - Products per row; absent when the block config is empty. Example: 3.
+ * @property {string | number} [sortType] - Sort field. Example: "price".
+ * @property {string | number} [sortOrder] - Sort direction. Example: "ASC".
+ * @description Layout config for products inside a {@link IProductBlock}; an empty object when the block is not configured.
+ */
+interface IProductBlockProductConfig {
+    quantity?: string | number;
+    countElementsPerRow?: string | number;
+    sortType?: string | number;
+    sortOrder?: string | number;
+}
+/**
+ * @interface IProductBlockSimilarRule
+ * @property {string} id - Rule identifier (UUID). Example: "812ee2bb-a90f-4743-9643-663f87acedf5".
+ * @property {string} title - Rule title; empty string when not set. Example: "".
+ * @property {string} attributeMarker - Marker of the product attribute the rule matches on. Example: "nameofproduct_3".
+ * @property {string} conditionMarker - Condition operator applied to the attribute. Example: "in".
+ * @property {string} conditionValue - Value the condition compares against. Example: "Blue".
+ * @property {string} statusMarker - Product status marker the rule is limited to; empty string when not limited. Example: "".
+ * @property {string[]} pageUrls - Page URLs the rule is scoped to; empty array when not restricted.
+ * @description Single rule used to compute similar products for a {@link IProductBlock}.
+ */
+interface IProductBlockSimilarRule {
+    id: string;
+    title: string;
+    attributeMarker: string;
+    conditionMarker: string;
+    conditionValue: string;
+    statusMarker: string;
+    pageUrls: string[];
+}
+interface IProductBlock {
+    id: number;
+    attributeSetIdentifier: string | null;
+    localizeInfos: ILocalizeInfo;
+    version: number;
+    position: number;
+    identifier: string;
+    type: BlockType;
+    customSettings: IProductBlockSettings;
+    templateIdentifier: string | null;
+    isVisible: boolean;
+    isSync: boolean;
+    attributeValues: IAttributeValues;
+}
+/**
+ * @interface IAggregatedProductGroup
+ * @property {string} attrValue - Attribute value.
+ * @property {IProductsEntity[]} items - Array of product entities.
+ * @property {string[]} productIds - Array of product ids.
+ * @property {number} total - Total count.
+ */
+interface IAggregatedProductGroup {
+    attrValue: string;
+    items: IProductsEntity[];
+    productIds: string[];
+    total: number;
+}
+/**
+ * Body for semantic (vector) product search.
+ * @interface IVectorSearchProducts
+ * @property {string} queryText - Natural-language search query. Example: "red running shoes".
+ * @property {number} [vectorDistanceThreshold] - Max vector distance for a hit. Example: 0.5.
+ * @property {number} [maxHits] - Max number of hits to return. Example: 50.
+ * @property {boolean} [debug] - Include debug info in the response. Example: false.
+ * @description Body for the products vector/search endpoint.
+ */
+interface IVectorSearchProducts {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductSearchResult, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts, };