oneentry 1.0.148 → 1.0.150

package/dist/blocks/blocksInterfaces.d.ts

@@ -51,6 +51,111 @@ interface IBlocks {
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
     getFrequentlyOrderedProducts(productId: number, marker: string, langCode?: string, signPrice?: string): Promise<IProductsResponse | IError>;
+    /**
+     * Get "complete your cart" products by the cart from context (auth user or guest).
+     * @handleName getCartComplement
+     * @param {string} marker - Block marker. Example: "cart_complement_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getCartComplement(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get "complete your cart" products by an explicit list of productIds (POST body).
+     * @handleName getCartComplementByProductIds
+     * @param {string} marker - Block marker. Example: "cart_complement_block".
+     * @param {IBlockProductsLookup} body - Lookup body. Example: `{ productIds: [1, 2], langCode: "en_US" }`.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getCartComplementByProductIds(marker: string, body: IBlockProductsLookup): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get "similar to cart" products by the cart from context (auth user or guest).
+     * @handleName getCartSimilar
+     * @param {string} marker - Block marker. Example: "cart_similar_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getCartSimilar(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get "similar to cart" products by an explicit list of productIds (POST body).
+     * @handleName getCartSimilarByProductIds
+     * @param {string} marker - Block marker. Example: "cart_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup body. Example: `{ productIds: [1, 2], langCode: "en_US" }`.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getCartSimilarByProductIds(marker: string, body: IBlockProductsLookup): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get personal recommendations for the user.
+     * @handleName getPersonalRecommendations
+     * @param {string} marker - Block marker. Example: "personal_recommendations_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getPersonalRecommendations(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get recently viewed products.
+     * @handleName getRecentlyViewed
+     * @param {string} marker - Block marker. Example: "recently_viewed_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getRecentlyViewed(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get products for repeat purchase.
+     * @handleName getRepeatPurchase
+     * @param {string} marker - Block marker. Example: "repeat_purchase_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getRepeatPurchase(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get the block's slides tree as a flat pre-order array (slider_block only).
+     * @handleName getSlides
+     * @param {string} marker - Block marker. Example: "slider_block".
+     * @returns {IBlockSlidesResponse} A promise that resolves to the slides response or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getSlides(marker: string): Promise<IBlockSlidesResponse | IError>;
+    /**
+     * Get trending products of the block.
+     * @handleName getTrending
+     * @param {string} marker - Block marker. Example: "trending_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getTrending(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get "similar to wishlist" products by the wishlist from context (auth user or guest).
+     * @handleName getWishlistSimilar
+     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {string} [signPrice] - Sign price.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getWishlistSimilar(marker: string, langCode?: string, signPrice?: string): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get "similar to wishlist" products by an explicit list of productIds (POST body).
+     * @handleName getWishlistSimilarByProductIds
+     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup body. Example: `{ productIds: [1, 2], langCode: "en_US" }`.
+     * @returns {IProductsEntity[]} A promise that resolves to an array of products or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getWishlistSimilarByProductIds(marker: string, body: IBlockProductsLookup): Promise<IProductsEntity[] | IError>;
 }
 /**
  * Represents a response from the blocks API.
@@ -175,5 +280,58 @@ interface ISearchBlock {
  * @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' | 'frequently_ordered_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount' | 'none';
-export type { BlockType, IBlockEntity, IBlocks, IBlocksResponse, ISearchBlock };
+type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount' | 'none';
+/**
+ * Lookup body for block product endpoints by explicit productIds.
+ * @interface IBlockProductsLookup
+ * @property {number[]} productIds - Product identifiers to look up. Example: [1, 2, 3].
+ * @property {string} [langCode] - Language code. Default: "en_US".
+ * @property {number} [limit] - Max number of products to return. Example: 10.
+ * @property {string} [signPrice] - Sign price.
+ * @description Body for the POST block product endpoints (cart-complement / cart-similar / wishlist-similar) that accept an explicit list of productIds.
+ */
+interface IBlockProductsLookup {
+    productIds: number[];
+    langCode?: string;
+    limit?: number;
+    signPrice?: string;
+}
+/**
+ * A single slide item of a slider block (flat pre-order tree node).
+ * @interface IBlockSlideItem
+ * @property {number} id - Slide identifier. Example: 1.
+ * @property {number | null} [parentId] - Parent slide identifier, or null for root slides. Example: null.
+ * @property {number} depth - Depth of the slide in the tree. Example: 0.
+ * @property {number} position - Position of the slide among its siblings. Example: 1.
+ * @property {boolean} visible - Whether the slide is visible. Example: true.
+ * @property {number} [time] - Display time for the slide. Example: 5.
+ * @property {'sec' | 'ms'} [timeInterval] - Unit of the time field. Example: "sec".
+ * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker.
+ * @description A single slide item returned in the slides flat pre-order array.
+ */
+interface IBlockSlideItem {
+    id: number;
+    parentId?: number | null;
+    depth: number;
+    position: number;
+    visible: boolean;
+    time?: number;
+    timeInterval?: 'sec' | 'ms';
+    attributeValues: IAttributeValues;
+}
+/**
+ * Slides response for a slider block.
+ * @interface IBlockSlidesResponse
+ * @property {number} total - Total number of slides. Example: 3.
+ * @property {number} [time] - Default display time for slides. Example: 5.
+ * @property {'sec' | 'ms'} [timeInterval] - Unit of the time field. Example: "sec".
+ * @property {IBlockSlideItem[]} items - Flat pre-order array of slide items.
+ * @description Response of the block slides endpoint (slider_block only).
+ */
+interface IBlockSlidesResponse {
+    total: number;
+    time?: number;
+    timeInterval?: 'sec' | 'ms';
+    items: IBlockSlideItem[];
+}
+export type { BlockType, IBlockEntity, IBlockProductsLookup, IBlocks, IBlockSlideItem, IBlockSlidesResponse, IBlocksResponse, ISearchBlock, };

package/dist/blocks/blocksSchemas.d.ts

@@ -49,6 +49,7 @@ export declare const BlockEntitySchema: z.ZodObject<{
             isPositionLocked: z.ZodOptional<z.ZodBoolean>;
             relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
             paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            distance: z.ZodOptional<z.ZodNumber>;
             discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
         }, z.core.$strip>>;
         total: z.ZodNumber;
@@ -90,6 +91,7 @@ export declare const BlockEntitySchema: z.ZodObject<{
         isPositionLocked: z.ZodOptional<z.ZodBoolean>;
         relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
         paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+        distance: z.ZodOptional<z.ZodNumber>;
         discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
@@ -143,6 +145,7 @@ export declare const BlocksResponseSchema: z.ZodObject<{
                 isPositionLocked: z.ZodOptional<z.ZodBoolean>;
                 relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
                 paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+                distance: z.ZodOptional<z.ZodNumber>;
                 discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
             }, z.core.$strip>>;
             total: z.ZodNumber;
@@ -184,6 +187,7 @@ export declare const BlocksResponseSchema: z.ZodObject<{
             isPositionLocked: z.ZodOptional<z.ZodBoolean>;
             relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
             paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            distance: z.ZodOptional<z.ZodNumber>;
             discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;

package/dist/events/eventsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IEvents, ISubscriptions } from './eventsInterfaces';
+import type { IContentApiEvent, IEvents, IListFormSubscription, ISubscribeFormEvent, ISubscriptions } from './eventsInterfaces';
 /**
  * Controllers for working with events
  * @handle /api/content/events
@@ -57,4 +57,45 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Returns all available events.
+     * @handleName getAllEvents
+     * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method returns all available events.
+     */
+    getAllEvents(): Promise<IContentApiEvent[] | IError>;
+    /**
+     * Subscribe to a form event by marker.
+     * @handleName subscribeToForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the subscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    subscribeToForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
+    /**
+     * Returns all form subscriptions.
+     * @handleName getFormSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<IListFormSubscription[] | IError>} Returns an array of form subscriptions.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getFormSubscriptions(offset?: number, limit?: number): Promise<IListFormSubscription[] | IError>;
+    /**
+     * Unsubscribe from form notifications by marker.
+     * @handleName unsubscribeFromForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the unsubscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    unsubscribeFromForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
 }

package/dist/events/eventsApi.js

@@ -93,5 +93,72 @@ class EventsApi extends asyncModules_1.default {
             return e;
         }
     }
+    /**
+     * Returns all available events.
+     * @handleName getAllEvents
+     * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method returns all available events.
+     */
+    async getAllEvents() {
+        const data = await this._fetchGet(`/all`);
+        return this._normalizeData(data);
+    }
+    /**
+     * Subscribe to a form event by marker.
+     * @handleName subscribeToForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the subscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async subscribeToForm(marker, body) {
+        try {
+            await this._fetchPost(`/forms/subscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+    /**
+     * Returns all form subscriptions.
+     * @handleName getFormSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<IListFormSubscription[] | IError>} Returns an array of form subscriptions.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async getFormSubscriptions(offset = 0, limit = 30) {
+        const query = {
+            offset,
+            limit,
+        };
+        const data = await this._fetchGet(`/forms/subscriptions?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Unsubscribe from form notifications by marker.
+     * @handleName unsubscribeFromForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the unsubscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    async unsubscribeFromForm(marker, body) {
+        try {
+            await this._fetchDelete(`/forms/unsubscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
 }
 exports.default = EventsApi;

package/dist/events/eventsInterfaces.d.ts

@@ -37,6 +37,47 @@ interface IEvents {
      * @description This method unsubscribes from an event on a product by its marker.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Returns all available events.
+     * @handleName getAllEvents
+     * @returns {Promise<IContentApiEvent[] | IError>} A promise that resolves to an array of events or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method returns all available events.
+     */
+    getAllEvents(): Promise<IContentApiEvent[] | IError>;
+    /**
+     * Subscribe to a form event by marker.
+     * @handleName subscribeToForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} A promise that resolves to true on success, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method subscribes to a form event by marker. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    subscribeToForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
+    /**
+     * Returns all form subscriptions.
+     * @handleName getFormSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<IListFormSubscription[] | IError>} A promise that resolves to an array of form subscriptions or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method returns all form subscriptions. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getFormSubscriptions(offset?: number, limit?: number): Promise<IListFormSubscription[] | IError>;
+    /**
+     * Unsubscribe from form notifications by marker.
+     * @handleName unsubscribeFromForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} A promise that resolves to true on success, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method unsubscribes from form notifications by marker. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    unsubscribeFromForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
 }
 /**
  * Represents a response from the events API containing a total count and an array of subscription items.
@@ -84,4 +125,41 @@ interface ISubscribeBody {
     locale: string;
     productId: number;
 }
-export type { IEvents, ISubscribeBody, ISubscriptions };
+/**
+ * Represents an event returned by the events API.
+ * @interface IContentApiEvent
+ * @property {number} id - Event identifier. Example: 1.
+ * @property {string} identifier - Event text identifier. Example: "price_change".
+ * @property {Record<string, unknown>} localizeInfos - Localized info of the event.
+ * @property {string} module - Module the event belongs to. Example: "catalog".
+ * @description Represents a single available event.
+ */
+interface IContentApiEvent {
+    id: number;
+    identifier: string;
+    localizeInfos: Record<string, unknown>;
+    module: string;
+}
+/**
+ * Represents a form subscription item.
+ * @interface IListFormSubscription
+ * @property {string} eventMarker - Event marker. Example: "form_marker".
+ * @property {number} formDataId - Form data identifier. Example: 123.
+ * @description Represents a single form subscription.
+ */
+interface IListFormSubscription {
+    eventMarker: string;
+    formDataId: number;
+}
+/**
+ * Body for subscribing to / unsubscribing from a form event.
+ * @interface ISubscribeFormEvent
+ * @property {number} formDataId - Form data identifier. Example: 123.
+ * @property {string} [status] - Optional subscription status.
+ * @description Body for the form subscribe/unsubscribe methods.
+ */
+interface ISubscribeFormEvent {
+    formDataId: number;
+    status?: string;
+}
+export type { IContentApiEvent, IEvents, IListFormSubscription, ISubscribeBody, ISubscribeFormEvent, ISubscriptions, };

package/dist/filters/filtersApi.d.ts

@@ -0,0 +1,31 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IContentFilter, IFiltersApi } from './filtersInterfaces';
+/**
+ * Controllers for working with content filters.
+ * @handle /api/content/filters
+ * @class FiltersApi
+ * @augments AsyncModules
+ * @implements {IFiltersApi}
+ * @description This class provides methods to retrieve content filters.
+ */
+export default class FiltersApi extends AsyncModules implements IFiltersApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for FiltersApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     */
+    getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
+}

package/dist/filters/filtersApi.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const filtersSchemas_1 = require("./filtersSchemas");
+/**
+ * Controllers for working with content filters.
+ * @handle /api/content/filters
+ * @class FiltersApi
+ * @augments AsyncModules
+ * @implements {IFiltersApi}
+ * @description This class provides methods to retrieve content filters.
+ */
+class FiltersApi extends asyncModules_1.default {
+    /**
+     * Constructor for FiltersApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/filters';
+    }
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     */
+    async getFilterByMarker(marker, langCode = this.state.lang) {
+        const data = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        const validated = this._validateResponse(data, filtersSchemas_1.ContentFilterSchema);
+        return this._normalizeData(validated);
+    }
+}
+exports.default = FiltersApi;

package/dist/filters/filtersInterfaces.d.ts

@@ -0,0 +1,56 @@
+import type { IError, ILocalizeInfo } from '../base/utils';
+/**
+ * Interface for the Filters API module.
+ * @interface IFiltersApi
+ * @description This interface defines methods for retrieving content filters.
+ */
+interface IFiltersApi {
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     */
+    getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
+}
+/**
+ * Type of a filter item tree node.
+ * @description Type of a filter item tree node (including `custom` for custom entries).
+ */
+type TContentFilterItemType = 'page' | 'product' | 'admin' | 'attribute' | 'discount' | 'personal-discount' | 'bonus' | 'payment-method' | 'custom';
+/**
+ * Content filter item (tree node).
+ * @interface IContentFilterItem
+ * @property {TContentFilterItemType} type - Tree node type. Example: "page".
+ * @property {string | null} [marker] - Marker of the linked entity, or null for type=page. Example: "about".
+ * @property {string | null} [url] - Page URL (only for type=page; null otherwise). Example: "about".
+ * @property {ILocalizeInfo} [localizeInfos] - Localized info of the linked entity in the requested locale.
+ * @property {string | null} [value] - Unified node value (e.g. discount value, attribute title); null otherwise. Example: "10".
+ * @property {number} [position] - Numeric position (per-level). Example: 1.
+ * @property {IContentFilterItem[]} [children] - Nested tree nodes (regular and custom items in a single array).
+ * @description A single node of a content filter items tree.
+ */
+interface IContentFilterItem {
+    type: TContentFilterItemType;
+    marker?: string | null;
+    url?: string | null;
+    localizeInfos?: ILocalizeInfo;
+    value?: string | null;
+    position?: number;
+    children?: IContentFilterItem[];
+}
+/**
+ * Content filter.
+ * @interface IContentFilter
+ * @property {ILocalizeInfo} localizeInfos - Localized info of the filter in the requested locale.
+ * @property {IContentFilterItem[]} [items] - Filter items tree (regular items + custom items in a single array).
+ * @description A content filter with its localized info and items tree.
+ */
+interface IContentFilter {
+    localizeInfos: ILocalizeInfo;
+    items?: IContentFilterItem[];
+}
+export type { IContentFilter, IContentFilterItem, IFiltersApi, TContentFilterItemType, };

package/dist/filters/filtersInterfaces.js

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

package/dist/filters/filtersSchemas.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Validation schemas for Filters module
+ * @description Zod schemas for validating filters-related API responses (raw API data, before normalization)
+ */
+import { z } from 'zod';
+/**
+ * Raw content filter item shape (before normalization), used to type the recursive schema.
+ * @description Raw filter item tree node as returned by the API (localizeInfos kept as a locale map).
+ */
+type IContentFilterItemRaw = {
+    type: string;
+    marker?: string | null;
+    url?: string | null;
+    localizeInfos?: Record<string, unknown>;
+    value?: string | null;
+    position?: number;
+    children?: IContentFilterItemRaw[];
+};
+/**
+ * Content filter item schema (recursive)
+ * @description Schema for a single filter item tree node; `children` recurses into the same schema
+ */
+export declare const ContentFilterItemSchema: z.ZodType<IContentFilterItemRaw>;
+/**
+ * Content filter schema
+ * @description Schema for a content filter returned by getFilterByMarker
+ */
+export declare const ContentFilterSchema: z.ZodObject<{
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    items: z.ZodOptional<z.ZodArray<z.ZodType<IContentFilterItemRaw, unknown, z.core.$ZodTypeInternals<IContentFilterItemRaw, unknown>>>>;
+}, z.core.$strip>;
+export {};

package/dist/filters/filtersSchemas.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentFilterSchema = exports.ContentFilterItemSchema = void 0;
+/**
+ * Validation schemas for Filters module
+ * @description Zod schemas for validating filters-related API responses (raw API data, before normalization)
+ */
+const zod_1 = require("zod");
+/**
+ * Content filter item schema (recursive)
+ * @description Schema for a single filter item tree node; `children` recurses into the same schema
+ */
+exports.ContentFilterItemSchema = zod_1.z.lazy(() => zod_1.z.object({
+    type: zod_1.z.string(),
+    marker: zod_1.z.string().nullable().optional(),
+    url: zod_1.z.string().nullable().optional(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+    value: zod_1.z.string().nullable().optional(),
+    position: zod_1.z.number().optional(),
+    children: zod_1.z.array(exports.ContentFilterItemSchema).optional(),
+}));
+/**
+ * Content filter schema
+ * @description Schema for a content filter returned by getFilterByMarker
+ */
+exports.ContentFilterSchema = zod_1.z.object({
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+    items: zod_1.z.array(exports.ContentFilterItemSchema).optional(),
+});

package/dist/forms-data/formsDataApi.js

@@ -65,14 +65,14 @@ class FormsDataApi extends asyncModules_1.default {
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
-        // filter spam and button fields, send file
+        // filter button fields; keep spam fields so the captcha token in their `value` reaches the server
         formData[langCode] = Array.isArray(body.formData)
-            ? body.formData.filter((fd) => fd.type !== 'spam' && fd.type !== 'button')
-            : [body.formData].filter((fd) => fd.type !== 'spam' && fd.type !== 'button');
+            ? body.formData.filter((fd) => fd.type !== 'button')
+            : [body.formData].filter((fd) => fd.type !== 'button');
         /**
          * Handle file uploads if fileQuery is present
+         * Check if there is any element in formData[langCode] that contains one of the specified types
          */
-        // Check if there is any element in formData[langCode] that contains one of the specified types
         if (formData[langCode].find((fd) => ['file', 'image', 'groupOfImages'].includes(fd.type))) {
             // Create an instance of FileUploadingApi with the current state
             const fileUploader = new fileUploadingApi_1.default(this.state);