oneentry 1.0.138 → 1.0.140

package/dist/products/productsInterfaces.d.ts

@@ -1,583 +0,0 @@
-import type { AttributeType, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
-import type { IFormConfig } from '../forms/formsInterfaces';
-/**
- * @interface IProductApi
- * @property {Function} getProducts - Search for all product page objects with pagination and filtering.
- * @property {Function} getProductsEmptyPage - Search for all product page objects with pagination that do not have a category.
- * @property {Function} getProductsByPageId - Search for all products with pagination for the selected category.
- * @property {Function} getProductsPriceByPageUrl - Search for information about products and prices for the selected category.
- * @property {Function} getProductsByPageUrl - Search for all products with pagination for the selected category.
- * @property {Function} getRelatedProductsById - Find all related product page objects.
- * @property {Function} getProductsByIds - Find products by its ids.
- * @property {Function} getProductById - Retrieve one product object.
- * @property {Function} getProductBlockById - Getting a product block object by product id.
- * @property {Function} searchProduct - Quick search for product page objects with limited output.
- * @property {Function} getProductsCount - Retrieves the total number of products available in the entire catalog.
- * @property {Function} getProductsCountByPageId - Retrieves the number of products on a specific catalog page identified by its page ID.
- * @property {Function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
- * @description This interface defines methods for retrieving and managing products in the system.
- */
-interface IProductApi {
-    /**
-     * 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
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @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?: IProductsQuery): Promise<IProductsResponse | IError>;
-    /**
-     * 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 {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(langCode?: LangType, userQuery?: IProductsQuery): Promise<IProductsResponse | 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 {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 {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?: IProductsQuery): 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 {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 {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?: IProductsQuery): 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 {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 {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?: IProductsQuery): 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 {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 {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?: IProductsQuery): 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 {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 {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?: IProductsQuery): Promise<IProductsEntity[] | IError>;
-    /**
-     * Retrieve one product object.
-     * @handleName getProductById
-     * @param {number} id - Product id. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @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): 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[]} Array with ProductEntity objects
-     * @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.
-     */
-    searchProduct(name: string, langCode?: string): Promise<IProductsEntity[] | 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>;
-}
-/**
- * @interface IProductsQuery
- * @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] - Price sign. Default: null.
- * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
- * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
- * @property {string | null} [conditionValue] - The value that is being searched for, default null. Example: "new".
- * @property {string | null} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered, default null. Example: "color".
- * @property {string | null} [conditionMarker] - Marker of the filter condition by which the values are filtered, default null. Example: "equals".
- * @description This interface defines the structure of a query for retrieving products, including pagination, sorting, and filtering parameters.
- */
-interface IProductsQuery {
-    offset: number;
-    limit: number;
-    sortOrder: 'DESC' | 'ASC' | null;
-    sortKey: 'id' | 'position' | 'title' | 'date' | 'price' | null;
-    signPrice?: string;
-    templateMarker?: string | null;
-    statusMarker?: string | null;
-    conditionValue?: string | null;
-    attributeMarker?: string | null;
-    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 */ | null;
-    [key: string]: any;
-}
-/**
- * @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 | 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} [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 */ | null;
-    conditionValue: number | string | null;
-    pageUrl?: string | null;
-    statusMarker?: string;
-    title?: string;
-    isNested?: boolean;
-}
-/**
- * @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 {Record<string, any>} statusLocalizeInfos - JSON description of the item status object, taking into account the language. Example: {}.
- * @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
-    {
-      "en": "In Stock",
-      "de": "Auf Lager"
-    }
- * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
- * @property {number | boolean} isSync - Indication of page indexing. Example: true.
- * @property {AttributeType} 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 {boolean} isPositionLocked - Sorting position lock indicator (optional). Example: false.
- * @property {number[]} relatedIds - Ids of related product pages.
- * @example
-    [
-      12345,
-      67890
-    ]
- * @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] - Price sign.
- * @property {Array<Record<string, any>> | Record<string, any>} [productPages] - Array of product pages or a single product page object. Example: [].
- * @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: Record<string, any>;
-    attributeSetIdentifier: string | null;
-    position: number;
-    price: number | null;
-    additional: {
-        prices: {
-            min: number;
-            max: number;
-        };
-    };
-    sku: string | null;
-    isSync: number | boolean;
-    attributeValues: AttributeType;
-    categories: string[];
-    isVisible: boolean;
-    moduleFormConfigs?: Array<IFormConfig>;
-    templateIdentifier?: string | null;
-    shortDescTemplateIdentifier?: string | null;
-    signedPrice?: string;
-    productPages?: Array<Record<string, any>> | Record<string, any>;
-    blocks?: string[];
-    isPositionLocked?: boolean;
-    relatedIds?: number[];
-}
-/**
- * @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"
-      }
-    ]
- * @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;
-}
-/**
- * @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.
- * @description This interface defines the structure of a product information object, including its identifier and price.
- */
-interface IProductInfo {
-    id: number;
-    price: number;
-}
-/**
- * @interface IProductBlock
- * @property {number} id - Unique identifier of the product block. Example: 3289.
- * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
- * @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 {Types} 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 {AttributeType} 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 IProductBlock {
-    id: number;
-    attributeSetIdentifier: number | null;
-    localizeInfos: ILocalizeInfo;
-    version: number;
-    position: number;
-    identifier: string;
-    type: Types;
-    customSettings: {
-        sliderDelay: number | null;
-        sliderDelayType: string | null;
-        productConfig: {
-            quantity: string | number;
-            countElementsPerRow: string | number;
-            sortType?: string | number;
-            sortOrder?: string | number;
-        };
-        similarProductRules: Array<{
-            property: string;
-            includes: string;
-            keywords: string;
-            strict: string;
-        }>;
-        condition: Record<string, any>;
-    };
-    templateIdentifier: string | null;
-    isVisible: boolean;
-    isSync: boolean;
-    attributeValues: AttributeType;
-}
-export type { IFilterParams, IProductApi, IProductBlock, IProductInfo, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, };

package/dist/products/productsInterfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });