oneentry 1.0.161 → 1.0.163

package/esm/blocks/blocksApi.js

@@ -185,14 +185,16 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns a products response with items and total.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getFrequentlyOrderedProducts getFrequentlyOrderedProducts} documentation.
      */
-    async getFrequentlyOrderedProducts(productId, marker, langCode = this.state.lang, signPrice) {
+    async getFrequentlyOrderedProducts(productId, marker, langCode = this.state.lang, signPrice, limit) {
         const query = {
             langCode,
             signPrice,
+            limit,
         };
         const data = await this._fetchGet(`/${marker}/products/${productId}/frequently-ordered?` +
             this._queryParamsToString(query));
@@ -220,12 +222,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartComplement getCartComplement} documentation.
      */
-    async getCartComplement(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getCartComplement(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/cart-complement?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -254,12 +257,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartSimilar getCartSimilar} documentation.
      */
-    async getCartSimilar(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getCartSimilar(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/cart-similar?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -288,12 +292,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getPersonalRecommendations getPersonalRecommendations} documentation.
      */
-    async getPersonalRecommendations(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getPersonalRecommendations(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/personal-recommendations?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -304,12 +309,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRecentlyViewed getRecentlyViewed} documentation.
      */
-    async getRecentlyViewed(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getRecentlyViewed(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/recently-viewed?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -320,12 +326,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRepeatPurchase getRepeatPurchase} documentation.
      */
-    async getRepeatPurchase(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getRepeatPurchase(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/repeat-purchase?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -348,12 +355,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getTrending getTrending} documentation.
      */
-    async getTrending(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getTrending(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/trending?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }
@@ -364,12 +372,13 @@ export default class BlocksApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getWishlistSimilar getWishlistSimilar} documentation.
      */
-    async getWishlistSimilar(marker, langCode = this.state.lang, signPrice) {
-        const query = { langCode, signPrice };
+    async getWishlistSimilar(marker, langCode = this.state.lang, signPrice, limit) {
+        const query = { langCode, signPrice, limit };
         const data = await this._fetchGet(`/${marker}/wishlist-similar?` + this._queryParamsToString(query));
         return this._normalizeData(data);
     }

package/esm/blocks/blocksInterfaces.d.ts

@@ -29,7 +29,7 @@ interface IBlocks {
      * @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>;
+    getBlockByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IBlockEntity | IError>;
     /**
      * Performs a quick search for block objects with limited output.
      * @handleName searchBlock
@@ -48,10 +48,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total) or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getFrequentlyOrderedProducts(productId: number, marker: string, langCode?: string, signPrice?: string): Promise<IProductsResponse | IError>;
+    getFrequentlyOrderedProducts(productId: number, marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get "complete your cart" products by the cart from context (auth user or guest).
      * @handleName getCartComplement
@@ -59,10 +60,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getCartComplement(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get "complete your cart" products by an explicit list of productIds (POST body).
      * @handleName getCartComplementByProductIds
@@ -84,10 +86,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getCartSimilar(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get "similar to cart" products by an explicit list of productIds (POST body).
      * @handleName getCartSimilarByProductIds
@@ -109,10 +112,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getPersonalRecommendations(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get recently viewed products.
      * @handleName getRecentlyViewed
@@ -120,10 +124,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getRecentlyViewed(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get products for repeat purchase.
      * @handleName getRepeatPurchase
@@ -131,10 +136,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getRepeatPurchase(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get the block's slides tree as a flat pre-order array (slider_block only).
      * @handleName getSlides
@@ -150,10 +156,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getTrending(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get "similar to wishlist" products by the wishlist from context (auth user or guest).
      * @handleName getWishlistSimilar
@@ -161,10 +168,11 @@ interface IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
+     * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) 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<IProductsResponse | IError>;
+    getWishlistSimilar(marker: string, langCode?: string, signPrice?: string, limit?: number): Promise<IProductsResponse | IError>;
     /**
      * Get "similar to wishlist" products by an explicit list of productIds (POST body).
      * @handleName getWishlistSimilarByProductIds

package/esm/blocks/blocksSchemas.d.ts

@@ -12,7 +12,7 @@ export declare const BlockEntitySchema: z.ZodObject<{
     type: z.ZodString;
     templateIdentifier: z.ZodNullable<z.ZodString>;
     isVisible: z.ZodBoolean;
-    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     similarProducts: z.ZodOptional<z.ZodObject<{
         items: z.ZodArray<z.ZodObject<{
             id: z.ZodNumber;
@@ -30,7 +30,7 @@ export declare const BlockEntitySchema: z.ZodObject<{
             }, z.core.$strip>;
             sku: z.ZodNullable<z.ZodString>;
             isSync: z.ZodBoolean;
-            attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+            attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             categories: z.ZodArray<z.ZodString>;
             isVisible: z.ZodBoolean;
             moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -73,7 +73,7 @@ export declare const BlockEntitySchema: z.ZodObject<{
         }, z.core.$strip>;
         sku: z.ZodNullable<z.ZodString>;
         isSync: z.ZodBoolean;
-        attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+        attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         categories: z.ZodArray<z.ZodString>;
         isVisible: z.ZodBoolean;
         moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -109,7 +109,7 @@ export declare const BlocksResponseSchema: z.ZodObject<{
         type: z.ZodString;
         templateIdentifier: z.ZodNullable<z.ZodString>;
         isVisible: z.ZodBoolean;
-        attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+        attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         similarProducts: z.ZodOptional<z.ZodObject<{
             items: z.ZodArray<z.ZodObject<{
                 id: z.ZodNumber;
@@ -127,7 +127,7 @@ export declare const BlocksResponseSchema: z.ZodObject<{
                 }, z.core.$strip>;
                 sku: z.ZodNullable<z.ZodString>;
                 isSync: z.ZodBoolean;
-                attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+                attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
                 categories: z.ZodArray<z.ZodString>;
                 isVisible: z.ZodBoolean;
                 moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -170,7 +170,7 @@ export declare const BlocksResponseSchema: z.ZodObject<{
             }, z.core.$strip>;
             sku: z.ZodNullable<z.ZodString>;
             isSync: z.ZodBoolean;
-            attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+            attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             categories: z.ZodArray<z.ZodString>;
             isVisible: z.ZodBoolean;
             moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;

package/esm/blocks/blocksSchemas.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { AttributeValuesSchema } from '../base/validation.js';
 import { ProductEntitySchema, ProductsResponseSchema, } from '../products/productsSchemas.js';
 /**
  * Block entity schema
@@ -13,7 +14,7 @@ export const BlockEntitySchema = z.object({
     type: z.string(),
     templateIdentifier: z.string().nullable(),
     isVisible: z.boolean(),
-    attributeValues: z.record(z.string(), z.any()),
+    attributeValues: AttributeValuesSchema,
     similarProducts: ProductsResponseSchema.optional(),
     countElementsPerRow: z.number().optional(),
     quantity: z.number().optional(),

package/esm/discounts/discountsInterfaces.d.ts

@@ -29,7 +29,7 @@ interface IDiscountsApi {
      * @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>;
+    getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon
@@ -134,6 +134,7 @@ interface IDiscountCondition {
  * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
  * @property {number} [position] - Position number for sorting. Example: 1.
  * @property {number | string} [total] - Total count of related entries. Example: "1".
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  */
 interface IDiscountsEntity {
     id: number;
@@ -157,6 +158,7 @@ interface IDiscountsEntity {
     bonusEvent?: Record<string, unknown> | null;
     position?: number;
     total?: number | string;
+    distance?: number;
 }
 /**
  * @interface IDiscountValue

package/esm/forms-data/formsDataApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataSearchResponse, IFormsDataVectorSearch, IPostFormResponse, IUpdateFormsData } from './formsDataInterfaces.js';
+import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IPostFormResponse, IUpdateFormsData } from './formsDataInterfaces.js';
 /**
  * Controllers for working with form data
  * @handle /api/content/form-data
@@ -56,6 +56,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Field values are typed per field type by {@link FormDataType}. For attached files see {@link IImageValue} (`image`, `groupOfImages`) and {@link IFileValue} (`file`) — the shape the endpoint expects, which is **not** what `FileUploading.upload` returns: that object carries `contentType`, which form data rejects. Passing a `File`/`FileList` as the value is also supported — the SDK uploads it first, then strips `contentType` from the resulting value.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
@@ -64,25 +65,34 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @handleName getFormsDataByMarker
      * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body.
+     * @param {IFormsDataFilter} [body] - Filter for the records to return. Every field is optional; an omitted or empty one is not applied.
      * @example
         {
-          "entityIdentifier": 14,
-          "entityparentIdentifier": 167,
+          "entityIdentifier": "blog",
+          "parentId": 10,
           "userIdentifier": "",
-          "status": ["new", "approved"],
+          "status": ["moderation", "approved"],
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
+     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
+     * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
+     * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].
+     * @param {string} [body.dateFrom] - Lower bound of the submission date, `YYYY-MM-DD`. An unparsable value fails the request with a `500`. Example: "2025-01-01".
+     * @param {string} [body.dateTo] - Upper bound of the submission date, `YYYY-MM-DD`. Example: "2025-12-31".
      * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
      * @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<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Each record's `formData` comes back **already unwrapped from its locale**. The API sends `formData: { "en_US": [ … ] }`; the SDK normalizes the response and hands over the array for `langCode`, so read `record.formData` — `record.formData[langCode]` is `undefined` and yields an empty list with no error. This holds for both values of `isExtended`.
+     *
+     * The filter body is typed for a reason: the API silently ignores a field it does not know, so a misspelled `statuses` returns every record — unmoderated ones included — and the code looks like it works.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
      */
-    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
+    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: IFormsDataFilter, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
     /**
      * Update one object of form data by id. Requires user authentication.
      * @handleName updateFormsDataByid

package/esm/forms-data/formsDataApi.js

@@ -58,6 +58,7 @@ export default class FormsDataApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Field values are typed per field type by {@link FormDataType}. For attached files see {@link IImageValue} (`image`, `groupOfImages`) and {@link IFileValue} (`file`) — the shape the endpoint expects, which is **not** what `FileUploading.upload` returns: that object carries `contentType`, which form data rejects. Passing a `File`/`FileList` as the value is also supported — the SDK uploads it first, then strips `contentType` from the resulting value.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
      */
     async postFormsData(body, langCode = this.state.lang) {
@@ -126,22 +127,31 @@ export default class FormsDataApi extends AsyncModules {
      * @handleName getFormsDataByMarker
      * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body.
+     * @param {IFormsDataFilter} [body] - Filter for the records to return. Every field is optional; an omitted or empty one is not applied.
      * @example
         {
-          "entityIdentifier": 14,
-          "entityparentIdentifier": 167,
+          "entityIdentifier": "blog",
+          "parentId": 10,
           "userIdentifier": "",
-          "status": ["new", "approved"],
+          "status": ["moderation", "approved"],
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
+     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
+     * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
+     * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].
+     * @param {string} [body.dateFrom] - Lower bound of the submission date, `YYYY-MM-DD`. An unparsable value fails the request with a `500`. Example: "2025-01-01".
+     * @param {string} [body.dateTo] - Upper bound of the submission date, `YYYY-MM-DD`. Example: "2025-12-31".
      * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
      * @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<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Each record's `formData` comes back **already unwrapped from its locale**. The API sends `formData: { "en_US": [ … ] }`; the SDK normalizes the response and hands over the array for `langCode`, so read `record.formData` — `record.formData[langCode]` is `undefined` and yields an empty list with no error. This holds for both values of `isExtended`.
+     *
+     * The filter body is typed for a reason: the API silently ignores a field it does not know, so a misspelled `statuses` returns every record — unmoderated ones included — and the code looks like it works.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
      */
     async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isExtended = 0, langCode = this.state.lang, offset = 0, limit = 30) {

package/esm/forms-data/formsDataInterfaces.d.ts

@@ -52,24 +52,24 @@ interface IFormsData {
      * @handleName getFormsDataByMarker
      * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
      * @param {number} formModuleConfigId - The form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body. Default: {}.
+     * @param {IFormsDataFilter} [body] - Filter for the records to return. Default: {}. Every field is optional; an omitted or empty one is not applied. Valid `status` values: "sent", "moderation", "approved", "banned", "deleted".
      * @example
         {
-          "entityIdentifier": "test",
+          "entityIdentifier": "blog",
           "userIdentifier": "",
-          "status": "",
+          "status": ["approved"],
           "dateFrom": "2025-08-11",
           "dateTo": ""
         }
-     * @param {number} [isNested] - Flag for getting hierarchical data. Example: 1.
+     * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
      * @param {string} [langCode] - The 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 {IFormsByMarkerDataEntity} A promise that resolves to a form data 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 form data by its marker.
+     * @description This method retrieves form data by its marker. Each record's `formData` is returned **already unwrapped from its locale**: the API sends `{ "en_US": [ … ] }`, the SDK hands over the array for `langCode` — read `record.formData`, not `record.formData[langCode]`.
      */
-    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
+    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: IFormsDataFilter, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
     /**
      * Semantic (vector) search for form data.
      * @handleName getFormsDataByVectorSearch
@@ -97,6 +97,39 @@ interface IFormsDataVectorSearch {
     maxHits?: number;
     debug?: boolean;
 }
+/**
+ * FormDataStatus — moderation status of a form data record.
+ *
+ * The set the API accepts and returns: a submission arrives as `sent`, may be
+ * routed to `moderation`, and ends up `approved`, `banned` or `deleted`. Any
+ * other value is rejected with `400 each value in status must be a valid enum
+ * value` — an error that does not list the valid ones.
+ */
+type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
+/**
+ * Represents the filter body of `getFormsDataByMarker`.
+ * @interface IFormsDataFilter
+ * @property {string} [entityIdentifier] - Text identifier (marker) of the entity the records belong to; an empty string means "no filter". Example: "blog".
+ * @property {number} [parentId] - Identifier of the parent record — the way to fetch replies to one comment. Example: 10.
+ * @property {string} [userIdentifier] - Text identifier of the sender; an empty string means "no filter". Example: "admin".
+ * @property {FormDataStatus[]} [status] - Moderation statuses to keep. Must be an array — a bare string is rejected with `400`. An empty array means "no filter". Example: ["approved"].
+ * @property {string} [dateFrom] - Lower bound of the submission date, `YYYY-MM-DD`; an empty string means "no bound". A value the API cannot parse fails the request with a `500`. Example: "2025-01-01".
+ * @property {string} [dateTo] - Upper bound of the submission date, `YYYY-MM-DD`; an empty string means "no bound". Example: "2025-12-31".
+ * @description Filter for reading form submissions. Every field is optional and an omitted one is simply not applied.
+ *
+ * Typed rather than left as `object` on purpose: the API **ignores** a field it
+ * does not know, so `statuses: ['approved']` (note the "s") is not an error —
+ * it returns every record, unmoderated ones included. That is premoderation
+ * leaking onto a public page, from one typo the compiler used to accept.
+ */
+interface IFormsDataFilter {
+    entityIdentifier?: string;
+    parentId?: number;
+    userIdentifier?: string;
+    status?: FormDataStatus[];
+    dateFrom?: string;
+    dateTo?: string;
+}
 /**
  * Represents a form data record returned by the vector search endpoint.
  * @interface IFormDataSearchEntity
@@ -112,13 +145,15 @@ interface IFormsDataVectorSearch {
         "value": "Test"
       }
     ]
- * @property {string} [userIdentifier] - Text identifier of the user who submitted the form. Example: "user_12345".
- * @property {string} [entityIdentifier] - Text identifier of the entity the record belongs to. Example: "product_1".
- * @property {number} [parentId] - Identifier of the parent form data record. Example: 1.
+ * @property {string | null} [userIdentifier] - Text identifier of the user who submitted the form, or `null` for an anonymous submission. Example: null.
+ * @property {string} [entityIdentifier] - Text identifier of the entity the record belongs to. Example: "blog".
+ * @property {number | null} [parentId] - Identifier of the parent form data record, or `null` for a top-level record. Example: null.
  * @property {string} [ip] - IP address the form was submitted from. Example: "127.0.0.1".
  * @property {string} [fingerprint] - Device fingerprint of the sender. Example: "UQ_123456_abcdef".
  * @property {boolean} [isUserAdmin] - Whether the record was submitted by an admin. Example: false.
- * @property {'sent' | 'banned' | 'deleted' | 'moderation' | 'approved'} [status] - Moderation status of the record. Example: "sent".
+ * @property {FormDataStatus} [status] - Moderation status of the record. Example: "sent".
+ * @property {number} [formModuleId] - Identifier of the form module the record belongs to. Example: 2.
+ * @property {number} [distance] - Cosine distance to the query. Returned only when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines a form data record as returned by the semantic (vector) search endpoint. Unlike IFormDataEntity it carries the moderation and sender fields of the raw record.
  */
 interface IFormDataSearchEntity {
@@ -126,13 +161,15 @@ interface IFormDataSearchEntity {
     formIdentifier?: string;
     time?: Date | string;
     formData?: FormDataType[];
-    userIdentifier?: string;
+    userIdentifier?: string | null;
     entityIdentifier?: string;
-    parentId?: number;
+    parentId?: number | null;
     ip?: string;
     fingerprint?: string;
     isUserAdmin?: boolean;
-    status?: 'sent' | 'banned' | 'deleted' | 'moderation' | 'approved';
+    status?: FormDataStatus;
+    formModuleId?: number;
+    distance?: number;
 }
 /**
  * @interface IFormsDataSearchResponse
@@ -150,7 +187,7 @@ interface IFormsDataSearchResponse {
  * @property {number} id - The unique identifier of the form page. Example: 12345.
  * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
  * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
- * @property {FormDataType[]} formData - Form data.
+ * @property {FormDataType[]} formData - Submitted fields, **already unwrapped from the locale**: the API returns `{ "en_US": [ … ] }` and the SDK hands over the array for the requested `langCode`.
  * @example
     [
       {
@@ -202,9 +239,9 @@ interface IFormsDataEntity {
  * @property {number} depth - Example: 1.
  * @property {string | null} ip - Ip. Example: '127.0.0.1'.
  * @property {string | null} fingerprint - Fingerprint. Example: 'fingerprint'.
- * @property {string | null} status - Status. Example: 'approved'.
+ * @property {string | null} status - Moderation status of the record: "sent", "moderation", "approved", "banned" or "deleted"; `null` when the form does not moderate. Example: 'approved'.
  * @property {string | null} userIdentifier - Text identifier (marker) of the user. Example: "admin".
- * @property {FormDataType[]} formData - Form data.
+ * @property {FormDataType[]} formData - Submitted fields, **already unwrapped from the locale**: the API returns `{ "en_US": [ … ] }` and the SDK hands over the array for the requested `langCode`. Read `formData` directly — `formData[langCode]` is `undefined`.
  * @example
     [
       {
@@ -543,7 +580,7 @@ interface ITextWithHeaderValue {
  * Represents an image or group of images form data entity.
  * @interface IBodyTypeImageGroupOfImages
  * @property {string} marker - marker name. Example: "avatar".
- * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
+ * @property {'image' | 'groupOfImages'} type - Type value — must match the attribute type in the set, note the plural in "groupOfImages". Example: "image".
  * @property {object} value - Image Object. Contains image information.
  * @example
     [
@@ -561,7 +598,7 @@ interface ITextWithHeaderValue {
  */
 interface IBodyTypeImageGroupOfImages {
     marker: string;
-    type: 'image' | 'groupOfImage';
+    type: 'image' | 'groupOfImages';
     value: IImageValue | IImageValue[];
 }
 /**
@@ -579,7 +616,7 @@ interface IImageValueParams {
  * @property {number} size - File size in bytes. Example: 392585.
  * @property {string} previewLink - URL to a preview-sized version (may be empty).
  * @property {IImageValueParams} params - Image-specific parameters.
- * @description Value payload for `image`/`groupOfImage` form fields.
+ * @description Value payload for `image`/`groupOfImages` form fields. Note it is **not** the object `FileUploading.upload` returns: that one carries `contentType`, which the form-data endpoint rejects. Build the value from `filename`, `downloadLink`, `size` and `previewLink` (the SDK also strips `contentType` from an image value passed to `postFormsData`).
  */
 interface IImageValue {
     filename: string;
@@ -667,4 +704,4 @@ interface IListOptionValue {
     value: string;
     extended: IListOptionExtended;
 }
-export type { FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };
+export type { FormDataStatus, FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };

package/esm/index.d.ts

@@ -30,6 +30,7 @@ import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
 import UserActivityApi from './user-activity/userActivityApi.js';
 import UsersApi from './users/usersApi.js';
 import WsApi from './web-socket/wsApi.js';
+export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes.js';
 export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttribute, } from './base/timeIntervals.js';
 export type * from './types.js';
 /**

package/esm/index.js

@@ -30,6 +30,7 @@ import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
 import UserActivityApi from './user-activity/userActivityApi.js';
 import UsersApi from './users/usersApi.js';
 import WsApi from './web-socket/wsApi.js';
+export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes.js';
 export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttribute, } from './base/timeIntervals.js';
 /**
  * Define API.