oneentry 1.0.140 → 1.0.141

package/dist/blocks/blocksApi.js

@@ -0,0 +1,188 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const blocksSchemas_1 = require("./blocksSchemas");
+/**
+ * Controllers for working with blocks.
+ * @handle /api/content/blocks
+ * @class BlocksApi
+ * @augments AsyncModules
+ * @implements {IBlocks}
+ * @description This class provides methods to interact with blocks.
+ */
+class BlocksApi extends asyncModules_1.default {
+    /**
+     * Constructor for BlocksApi class.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/blocks';
+    }
+    /**
+     * Get blocks by parameters.
+     * @handleName getBlocks
+     * @param {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none". 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
+     */
+    async getBlocks(type = '', langCode = this.state.lang, offset = 0, limit = 30) {
+        const response = await this._fetchPost(`?langCode=${langCode}&type=${type}&offset=${offset}&limit=${limit}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(response, blocksSchemas_1.BlocksResponseSchema);
+        if (!this.state.traficLimit) {
+            const normalizeResponse = this._normalizeData(validated);
+            await Promise.all(normalizeResponse.items.map(async (block) => {
+                const customSettings = block.customSettings;
+                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 (block.type === 'similar_products_block') {
+                    try {
+                        await this.getSimilarProducts(block.identifier, langCode, offset, limit).then((result) => {
+                            block.similarProducts = result;
+                        });
+                    }
+                    catch {
+                        block.similarProducts = [];
+                    }
+                }
+                else if (block.type === 'product_block') {
+                    try {
+                        await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit).then((result) => {
+                            block.products = result;
+                        });
+                    }
+                    catch {
+                        block.products = [];
+                    }
+                }
+            }));
+            return this._normalizeData(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.
+     */
+    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 = this._validateResponse(response, blocksSchemas_1.BlockEntitySchema);
+        const normalizeResponse = this._normalizeData(validated);
+        const customSettings = normalizeResponse.customSettings;
+        if (customSettings &&
+            Object.prototype.hasOwnProperty.call(customSettings, 'productConfig')) {
+            if (customSettings.productConfig.countElementsPerRow)
+                normalizeResponse.countElementsPerRow =
+                    +customSettings.productConfig.countElementsPerRow;
+            if (customSettings.productConfig.quantity)
+                normalizeResponse.quantity = +customSettings.productConfig.quantity;
+        }
+        delete normalizeResponse.customSettings;
+        delete normalizeResponse.attributesSetIdentifier;
+        delete normalizeResponse.productPageUrls;
+        if (!this.state.traficLimit) {
+            if (normalizeResponse.type === 'similar_products_block') {
+                try {
+                    await this.getSimilarProducts(normalizeResponse.identifier, langCode, offset, limit).then((result) => {
+                        normalizeResponse.similarProducts = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.similarProducts = [];
+                }
+            }
+            else if (normalizeResponse.type === 'product_block') {
+                try {
+                    await this.getProductsByBlockMarker(normalizeResponse.identifier, langCode, offset, limit).then((result) => {
+                        normalizeResponse.products = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.products = [];
+                }
+            }
+        }
+        return this._normalizeData(normalizeResponse);
+    }
+    /**
+     * 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] - Sign price.
+     * @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
+     */
+    async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+            signPrice,
+        };
+        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] - Sign price.
+     * @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    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));
+        return this._normalizeData(result.items);
+    }
+    /**
+     * 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
+     */
+    async searchBlock(name, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, blocksSchemas_1.SearchBlocksResponseSchema);
+        return validated;
+    }
+}
+exports.default = BlocksApi;

package/dist/blocks/blocksInterfaces.d.ts

@@ -0,0 +1,173 @@
+import type { AttributeType, IError, ILocalizeInfo } from '../base/utils';
+import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces';
+/**
+ * Interface for managing and retrieving blocks in the system.
+ * @interface IBlocks
+ * @property {Function} getBlocks - Get all Blocks objects.
+ * @property {Function} getBlockByMarker - Get Block object by marker.
+ * @property {Function} getSimilarProducts - Get Array of similar products from product-similar block.
+ * @property {Function} getProductsByBlockMarker - Get Array of products from product block.
+ * @property {Function} searchBlock - Quick search for block objects with limited output.
+ * @description This interface defines methods for retrieving and managing blocks in the system.
+ */
+interface IBlocks {
+    /**
+     * Retrieves all block objects of a specific type.
+     * @handleName getBlocks
+     * @param {BlockType} type - The type of blocks to retrieve. Example: "product".
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {IBlocksResponse} A promise that resolves to a blocks response or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves all block objects of a specific type.
+     */
+    getBlocks(type: BlockType, langCode?: string, offset?: number, limit?: number): Promise<IBlocksResponse | IError>;
+    /**
+     * Retrieves a block object by its marker.
+     * @handleName getBlockByMarker
+     * @param {string} marker - The marker identifying the block. Example: "product_block".
+     * @param {string} langCode - Language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {IBlockEntity} A promise that resolves to a block entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves a block object by its marker.
+     */
+    getBlockByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IBlockEntity | IError>;
+    /**
+     * Performs a quick search for block objects with limited output.
+     * @handleName searchBlock
+     * @param {string} name - The name to search for. Example: "product_block".
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {ISearchBlock[]} A promise that resolves to an array of search blocks 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 quick search for block objects with limited output.
+     */
+    searchBlock(name: string, langCode?: string): Promise<ISearchBlock[] | IError>;
+}
+/**
+ * Represents a response from the blocks API.
+ * @interface IBlocksResponse
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {IBlockEntity[]} items - Array of block entities.
+ * @example
+    [
+      {
+        "attributeValues": [],
+        "id": 1,
+        "identifier": "block1",
+        "isVisible": true,
+        "localizeInfos": { "key": "value" },
+        "position": 1,
+        "templateIdentifier": null,
+        "type": "product",
+        "version": 1,
+        "countElementsPerRow": 3,
+        "quantity": 9,
+        "similarProducts": {
+          "total": 0,
+          "items": []
+        },
+        "products": [
+          {
+          "id": 1,
+          "name": "Product 1"
+          },
+          {
+          "id": 2,
+          "name": "Product 2"
+          }
+        ]
+      }
+    ]
+ * @description Represents a response from the blocks API containing a total count and an array of block entities.
+ */
+interface IBlocksResponse {
+    items: IBlockEntity[];
+    total: number;
+}
+/**
+ * Represents a block entity with various attributes and properties.
+ * @interface IBlockEntity
+ * @property {AttributeType} attributeValues - Type of attributes used in the block.
+ * @example
+   {
+    "block-text": {
+      "type": "string",
+      "value": "some text",
+      "isIcon": false,
+      "position": 0,
+      "additionalFields": [],
+      "isProductPreview": false
+    }
+   }
+ * @property {number} id - Unique identifier of the block. Example: 1234.
+ * @property {ILocalizeInfo} localizeInfos - Localization information for the block.
+ * @example
+    {
+      "key": "value"
+    }
+ * @property {number} version - Version of the block entity. Example: 1.
+ * @property {string} identifier - Unique string identifier for the block. Example: "block1".
+ * @property {string} type - Type of the block, such as 'product', 'error_page', etc. Example: "product".
+ * @property {number} position - Position of the block for sorting. Example: 1.
+ * @property {string | null} templateIdentifier - Identifier for the template used by the block, or null if not applicable. Example: "template1".
+ * @property {boolean} isVisible - Indicates whether the block is visible. Example: true.
+ * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
+ * @property {number} [quantity] - Quantity of items in the block, if applicable. Example: 5.
+ * @property {IProductsResponse} [similarProducts] - Response containing similar products associated with the block.
+ * @example
+    {
+     "total": 10,
+     "items": []
+    }
+ * @property {IProductsEntity[]} [products] - Array of product entities associated with the block.
+ * @example
+    [
+     {
+       "id": 1,
+       "name": "Product 1"
+     },
+     {
+       "id": 2,
+       "name": "Product 2"
+     }
+    ]
+ * @description Represents a block entity with various attributes and properties.
+ */
+interface IBlockEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    version: number;
+    position: number;
+    identifier: string;
+    type: string;
+    templateIdentifier: string | null;
+    isVisible: boolean;
+    attributeValues: AttributeType;
+    similarProducts?: IProductsResponse;
+    countElementsPerRow?: number;
+    quantity?: number;
+    products?: IProductsEntity[];
+}
+/**
+ * Represents a search block entity with an identifier, name, and ID.
+ * @interface ISearchBlock
+ * @property {number} id - Unique identifier of the search block. Example: 1.
+ * @property {string} identifier - Unique string identifier for the search block. Example: "search_block_1".
+ * @property {string} name - Name of the search block. Example: "Search Block 1".
+ * @description Represents a search block entity with an identifier, name, and ID.
+ */
+interface ISearchBlock {
+    id: number;
+    identifier: string;
+    name: string;
+}
+/**
+ * BlockType
+ * @type {BlockType}
+ * @description This type defines the possible values for block types used in the system.
+ */
+type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount' | 'none';
+export type { BlockType, IBlockEntity, IBlocks, IBlocksResponse, ISearchBlock };

package/dist/blocks/blocksInterfaces.js

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

package/dist/blocks/blocksSchemas.d.ts

@@ -0,0 +1,187 @@
+import { z } from 'zod';
+/**
+ * Block entity schema
+ * Includes all fields returned by the API
+ */
+export declare const BlockEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    identifier: z.ZodString;
+    type: z.ZodString;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    similarProducts: z.ZodOptional<z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            identifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            isVisible: z.ZodOptional<z.ZodBoolean>;
+            statusIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            position: z.ZodOptional<z.ZodNumber>;
+            isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+            templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            price: z.ZodNullable<z.ZodNumber>;
+            additional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            sku: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            isSync: z.ZodOptional<z.ZodBoolean>;
+            categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            productPages: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+            blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+            currency: z.ZodOptional<z.ZodString>;
+            images: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodNumber;
+                filename: z.ZodString;
+                url: z.ZodString;
+                size: z.ZodOptional<z.ZodNumber>;
+                type: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            relatedProducts: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            pageId: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        total: z.ZodNumber;
+    }, z.core.$strip>>;
+    countElementsPerRow: z.ZodOptional<z.ZodNumber>;
+    quantity: z.ZodOptional<z.ZodNumber>;
+    products: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        identifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        isVisible: z.ZodOptional<z.ZodBoolean>;
+        statusIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        position: z.ZodOptional<z.ZodNumber>;
+        isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+        templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        price: z.ZodNullable<z.ZodNumber>;
+        additional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        sku: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        isSync: z.ZodOptional<z.ZodBoolean>;
+        categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        productPages: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+        blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+        currency: z.ZodOptional<z.ZodString>;
+        images: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            filename: z.ZodString;
+            url: z.ZodString;
+            size: z.ZodOptional<z.ZodNumber>;
+            type: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        relatedProducts: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        pageId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Blocks response schema
+ */
+export declare const BlocksResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+        version: z.ZodNumber;
+        position: z.ZodNumber;
+        identifier: z.ZodString;
+        type: z.ZodString;
+        templateIdentifier: z.ZodNullable<z.ZodString>;
+        isVisible: z.ZodBoolean;
+        attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+        similarProducts: z.ZodOptional<z.ZodObject<{
+            items: z.ZodArray<z.ZodObject<{
+                id: z.ZodNumber;
+                identifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                isVisible: z.ZodOptional<z.ZodBoolean>;
+                statusIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                position: z.ZodOptional<z.ZodNumber>;
+                isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+                templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                price: z.ZodNullable<z.ZodNumber>;
+                additional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                sku: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                isSync: z.ZodOptional<z.ZodBoolean>;
+                categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                productPages: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+                blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+                currency: z.ZodOptional<z.ZodString>;
+                images: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    id: z.ZodNumber;
+                    filename: z.ZodString;
+                    url: z.ZodString;
+                    size: z.ZodOptional<z.ZodNumber>;
+                    type: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>>;
+                relatedProducts: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+                pageId: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strip>>;
+            total: z.ZodNumber;
+        }, z.core.$strip>>;
+        countElementsPerRow: z.ZodOptional<z.ZodNumber>;
+        quantity: z.ZodOptional<z.ZodNumber>;
+        products: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            identifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            isVisible: z.ZodOptional<z.ZodBoolean>;
+            statusIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            position: z.ZodOptional<z.ZodNumber>;
+            isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+            templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            price: z.ZodNullable<z.ZodNumber>;
+            additional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            sku: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            isSync: z.ZodOptional<z.ZodBoolean>;
+            categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            productPages: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+            blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+            currency: z.ZodOptional<z.ZodString>;
+            images: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodNumber;
+                filename: z.ZodString;
+                url: z.ZodString;
+                size: z.ZodOptional<z.ZodNumber>;
+                type: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            relatedProducts: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            pageId: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Search block schema
+ */
+export declare const SearchBlockSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Search blocks response schema
+ */
+export declare const SearchBlocksResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>>;

package/dist/blocks/blocksSchemas.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchBlocksResponseSchema = exports.SearchBlockSchema = exports.BlocksResponseSchema = exports.BlockEntitySchema = void 0;
+const zod_1 = require("zod");
+const productsSchemas_1 = require("../products/productsSchemas");
+/**
+ * Block entity schema
+ * Includes all fields returned by the API
+ */
+exports.BlockEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    version: zod_1.z.number(),
+    position: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    type: zod_1.z.string(),
+    templateIdentifier: zod_1.z.string().nullable(),
+    isVisible: zod_1.z.boolean(),
+    attributeValues: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    similarProducts: productsSchemas_1.ProductsResponseSchema.optional(),
+    countElementsPerRow: zod_1.z.number().optional(),
+    quantity: zod_1.z.number().optional(),
+    products: zod_1.z.array(productsSchemas_1.ProductEntitySchema).optional(),
+});
+/**
+ * Blocks response schema
+ */
+exports.BlocksResponseSchema = zod_1.z.object({
+    items: zod_1.z.array(exports.BlockEntitySchema),
+    total: zod_1.z.number(),
+});
+/**
+ * Search block schema
+ */
+exports.SearchBlockSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    name: zod_1.z.string(),
+});
+/**
+ * Search blocks response schema
+ */
+exports.SearchBlocksResponseSchema = zod_1.z.array(exports.SearchBlockSchema);

package/dist/discounts/discountsApi.d.ts

@@ -0,0 +1,56 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse } from './discountsInterfaces';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class DiscountsApi
+ * @augments AsyncModules
+ * @implements {IDiscountsApi}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class DiscountsApi extends AsyncModules implements IDiscountsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the Constructor for DiscountsApi class with the provided state module.
+     * @class DiscountsApi
+     * @augments AsyncModules
+     * @implements {DiscountsApi}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the DiscountsApi with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Return all discounts.
+     * @handleName getAllDiscounts
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches all discounts from the server.
+     */
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS'): Promise<IDiscountsResponse | IError>;
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     */
+    getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     */
+    validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
+}