oneentry 1.0.162 → 1.0.163

package/esm/base/utils.d.ts

@@ -266,10 +266,19 @@ interface ITimeIntervalRange {
  * @property {string} type - Attribute data type (e.g. "string", "integer", "list", "file", "image").
  * @property {unknown} value - Attribute value — actual TS type depends on `type`, and the SDK normalizes it to the same shape in every module: `string` for "string"/"text"; `number | null` for "integer"/"float"/"real"; the file object itself for a single-file "image"/"file" and an array of them for several; an array for "list" and "groupOfImages". An attribute with no value is always `null`. Example: "Admins text".
  * @property {number} [position] - Sort position of the value inside its set; the containing collection is returned sorted by it. Example: 0.
- * @property {Record<string, IAttributeValue> | unknown[]} [additionalFields] - Nested attribute values keyed by marker; the API may also return an empty array when none are configured. Optional.
+ * @property {Record<string, IAttributeValue> | unknown[]} [additionalFields] - Nested attribute values keyed by marker; the API may also return an empty array when none are configured. Read it through `getAdditionalFields`, which collapses that array to an empty map. Optional.
  * @property {boolean} [isIcon] - Block/preview attribute flag — whether the field is treated as an icon. Optional.
  * @property {boolean} [isProductPreview] - Block/preview attribute flag — whether the field is shown in product preview. Optional.
  * @description A single attribute value attached to an entity (admin, user, page, product, …).
+ *
+ * `value` is `unknown` because its shape is decided by `type` at runtime, which
+ * a single interface cannot express. Do not read it by assumption — the type
+ * checker cannot catch a wrong guess (an array read on a single file yields
+ * `undefined`, silently, with no error anywhere). Reach it through the guards
+ * and helpers instead: `isFileAttribute` / `getAttributeFiles`,
+ * `isStringAttribute`, `isNumberAttribute`, `isListAttribute`,
+ * `isTimeIntervalAttribute`; or annotate with {@link ITypedAttributeValue} to
+ * have the compiler enforce the rule.
  */
 interface IAttributeValue {
     type: string;
@@ -286,6 +295,90 @@ interface IAttributeValue {
 interface IAttributeValues {
     [key: string]: IAttributeValue;
 }
+/**
+ * @interface IAttributeFile
+ * @property {string} filename - Storage-relative path of the file. Example: "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg".
+ * @property {string} downloadLink - Public URL of the original file. Example: "https://my-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf.jpeg".
+ * @property {number} size - File size in bytes. Example: 742690.
+ * @property {string} contentType - MIME type of the file. Example: "image/jpeg".
+ * @property {Record<string, string[]>} [previewLink] - Generated previews keyed by preview template. Each entry is a `[placeholder, url]` pair: the first item is an inline base64 thumbnail (usable as a `blurDataURL`), the second the preview URL. Optional — previews are generated for images; a non-image `file` may arrive without them. Example: { "default": ["data:image/webp;base64,UklGRmwA…", "https://…48853cbf.preview.default.jpeg"] }.
+ * @property {string} [defaultPreview] - Key of `previewLink` to use by default. Optional — present alongside `previewLink`. Example: "default".
+ * @description One file of an `image`, `file` or `groupOfImages` attribute value. Reach it through {@link IFileAttributeValue} — or, without caring whether the attribute holds one file or many, through `getAttributeFiles`.
+ */
+interface IAttributeFile {
+    filename: string;
+    downloadLink: string;
+    size: number;
+    contentType: string;
+    previewLink?: Record<string, string[]>;
+    defaultPreview?: string;
+}
+/**
+ * @interface IFileAttributeValue
+ * @property {'image' | 'file' | 'groupOfImages'} type - Discriminant identifying the attribute as file-bearing.
+ * @property {IAttributeFile | IAttributeFile[] | null} value - The file itself when an `image`/`file` attribute holds exactly one, an array when it holds several, always an array for `groupOfImages`, `null` when nothing is set.
+ * @description {@link IAttributeValue} narrowed to attributes that carry files, whose generic `value: unknown` resolves to {@link IAttributeFile}. The single/array split is what the SDK's normalization produces, so it has to be handled: narrow with `isFileAttribute`, or skip the branch entirely with `getAttributeFiles` / `getAttributeFile`.
+ */
+interface IFileAttributeValue extends IAttributeValue {
+    type: 'image' | 'file' | 'groupOfImages';
+    value: IAttributeFile | IAttributeFile[] | null;
+}
+/**
+ * @interface IStringAttributeValue
+ * @property {'string' | 'text' | 'textEditor'} type - Discriminant identifying the attribute as text-bearing.
+ * @property {string | null} value - The text; `null` when no value is set.
+ * @description {@link IAttributeValue} narrowed to text attributes. Narrow to it with `isStringAttribute`.
+ */
+interface IStringAttributeValue extends IAttributeValue {
+    type: 'string' | 'text' | 'textEditor';
+    value: string | null;
+}
+/**
+ * @interface INumberAttributeValue
+ * @property {'integer' | 'float' | 'real'} type - Discriminant identifying the attribute as numeric.
+ * @property {number | null} value - The number, cast by the SDK from the API's string form; `null` when no value is set.
+ * @description {@link IAttributeValue} narrowed to numeric attributes. Narrow to it with `isNumberAttribute`.
+ */
+interface INumberAttributeValue extends IAttributeValue {
+    type: 'integer' | 'float' | 'real';
+    value: number | null;
+}
+/**
+ * @interface IListAttributeValue
+ * @property {'list'} type - Discriminant identifying the attribute as a list.
+ * @property {unknown[]} value - The selected options. The option shape is defined by the attribute set, so the entries stay `unknown` — only the array container is guaranteed.
+ * @description {@link IAttributeValue} narrowed to `list` attributes. Narrow to it with `isListAttribute`.
+ */
+interface IListAttributeValue extends IAttributeValue {
+    type: 'list';
+    value: unknown[];
+}
+/**
+ * ITypedAttributeValue — {@link IAttributeValue} as a discriminated union over `type`.
+ *
+ * Opt-in, and deliberately closed: it lists only the types whose `value` shape
+ * the SDK guarantees, so `switch (attr.type)` narrows `value` for you. A loose
+ * member (`type: string`) would be assignable to every case and collapse the
+ * narrowing back to `unknown`, which is exactly what this type exists to avoid.
+ *
+ * `IAttributeValues` keeps the loose `IAttributeValue`, so nothing existing
+ * changes: narrow into this union with the guards (`isFileAttribute` and the
+ * rest), or annotate a value you control. Attribute types the SDK does not
+ * model (`entity`, `date`, custom ones) stay on `IAttributeValue`.
+ * @example
+ * ```ts
+ * function render(attr: ITypedAttributeValue) {
+ *     switch (attr.type) {
+ *         case 'image':
+ *         case 'file':
+ *             return attr.value; // IAttributeFile | IAttributeFile[] | null
+ *         case 'integer':
+ *             return attr.value; // number | null
+ *     }
+ * }
+ * ```
+ */
+type ITypedAttributeValue = IFileAttributeValue | IStringAttributeValue | INumberAttributeValue | IListAttributeValue | ITimeIntervalAttributeValue;
 /**
  * @interface IRating
  * @property {number} [value] - Average rating value. Example: 4.5.
@@ -351,4 +444,4 @@ type LangType = string | Array<string>;
  * LocalizeType
  */
 type LocalizeType = ILocalizeInfo;
-export type { IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IHttpHeaders, IHttpOptions, ILocalizeInfo, IRating, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, LangType, LocalizeType, TimeIntervalPair, };
+export type { IAttributeFile, IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IFileAttributeValue, IHttpHeaders, IHttpOptions, IListAttributeValue, ILocalizeInfo, INumberAttributeValue, IRating, IStringAttributeValue, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, ITypedAttributeValue, LangType, LocalizeType, TimeIntervalPair, };

package/esm/base/validation.d.ts

@@ -36,6 +36,35 @@ export declare const AttributeSchema: z.ZodObject<{
     }, z.core.$strip>>>;
     value: z.ZodOptional<z.ZodAny>;
 }, z.core.$strip>;
+/**
+ * Attribute file schema
+ *
+ * One file of an `image`, `file` or `groupOfImages` attribute value, as the API
+ * returns it — mirrors `IAttributeFile`. Loose: the API may add fields, and a
+ * new one is not a reason to report a broken response.
+ */
+export declare const AttributeFileSchema: z.ZodObject<{
+    filename: z.ZodString;
+    downloadLink: z.ZodString;
+    size: z.ZodNumber;
+    contentType: z.ZodString;
+    previewLink: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    defaultPreview: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+/**
+ * Attribute values schema
+ *
+ * The container the API returns under `attributeValues`. Both nestings are
+ * accepted, since the raw response wraps the marker map in a locale
+ * (`{ en_US: { marker: attr } }`) while some endpoints return it flat.
+ *
+ * Attribute values are open by design — what `value` holds is decided by the
+ * project's attribute set — so the schema validates the one part the API fixes
+ * and the SDK relies on: the shape of files. If a future API release renames or
+ * drops a file field, `getAttributeFiles` would silently return nothing;
+ * validation (`config.validation.enabled`) reports it instead.
+ */
+export declare const AttributeValuesSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 /**
  * User entity schema
  */

package/esm/base/validation.js

@@ -33,6 +33,98 @@ export const AttributeSchema = z.object({
     localizeInfos: z.record(z.string(), LocalizeInfoSchema).optional(),
     value: z.any().optional(),
 });
+/**
+ * Attribute file schema
+ *
+ * One file of an `image`, `file` or `groupOfImages` attribute value, as the API
+ * returns it — mirrors `IAttributeFile`. Loose: the API may add fields, and a
+ * new one is not a reason to report a broken response.
+ */
+export const AttributeFileSchema = z.looseObject({
+    filename: z.string(),
+    downloadLink: z.string(),
+    size: z.number(),
+    contentType: z.string(),
+    previewLink: z.record(z.string(), z.array(z.string())).optional(),
+    defaultPreview: z.string().optional(),
+});
+/**
+ * Attribute types whose value carries files.
+ */
+const FILE_ATTRIBUTE_TYPES = ['image', 'file', 'groupOfImages'];
+/**
+ * Reports whether a value is the empty localization map the API sends for an
+ * attribute with no value set.
+ * @param {unknown} value - The value to test.
+ * @returns {boolean} True when the value carries nothing.
+ */
+function isEmptyValue(value) {
+    if (value === null || value === undefined)
+        return true;
+    return (typeof value === 'object' &&
+        !Array.isArray(value) &&
+        Object.keys(value).length === 0);
+}
+/**
+ * Validates the files of one attribute value, recursing into nested fields.
+ *
+ * Only file-bearing attributes are inspected. Everything else is left alone:
+ * the shape of `value` is defined per attribute type by the project's own
+ * attribute set, so a schema cannot describe it — but the file shape is fixed
+ * by the API, and the SDK's own helpers (`getAttributeFiles`) depend on it.
+ * @param {unknown} node - An attribute value, or a container of them.
+ * @param {string[]} path - Path to the node, for issue reporting.
+ * @param {z.RefinementCtx} ctx - Zod refinement context issues are added to.
+ */
+function validateAttributeFiles(node, path, ctx) {
+    if (!node || typeof node !== 'object')
+        return;
+    if (Array.isArray(node)) {
+        node.forEach((item, index) => validateAttributeFiles(item, [...path, String(index)], ctx));
+        return;
+    }
+    const attr = node;
+    const isAttribute = typeof attr.type === 'string' && 'value' in attr;
+    if (isAttribute && FILE_ATTRIBUTE_TYPES.includes(attr.type)) {
+        if (!isEmptyValue(attr.value)) {
+            // The API always sends files as an array; the SDK unwraps a single one
+            // afterwards, so both shapes are accepted here.
+            const files = Array.isArray(attr.value) ? attr.value : [attr.value];
+            files.forEach((file, index) => {
+                const result = AttributeFileSchema.safeParse(file);
+                if (result.success)
+                    return;
+                result.error.issues.forEach((issue) => ctx.addIssue({
+                    code: 'custom',
+                    path: [...path, 'value', index, ...issue.path],
+                    message: `Attribute of type "${attr.type}" carries an unexpected file shape: ${issue.message}`,
+                }));
+            });
+        }
+    }
+    // Nested fields carry attribute values of their own, files included.
+    if (isAttribute) {
+        validateAttributeFiles(attr.additionalFields, [...path, 'additionalFields'], ctx);
+        return;
+    }
+    Object.entries(attr).forEach(([key, value]) => validateAttributeFiles(value, [...path, key], ctx));
+}
+/**
+ * Attribute values schema
+ *
+ * The container the API returns under `attributeValues`. Both nestings are
+ * accepted, since the raw response wraps the marker map in a locale
+ * (`{ en_US: { marker: attr } }`) while some endpoints return it flat.
+ *
+ * Attribute values are open by design — what `value` holds is decided by the
+ * project's attribute set — so the schema validates the one part the API fixes
+ * and the SDK relies on: the shape of files. If a future API release renames or
+ * drops a file field, `getAttributeFiles` would silently return nothing;
+ * validation (`config.validation.enabled`) reports it instead.
+ */
+export const AttributeValuesSchema = z
+    .record(z.string(), z.unknown())
+    .superRefine((values, ctx) => validateAttributeFiles(values, [], ctx));
 /**
  * User entity schema
  */

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

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

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
@@ -118,7 +151,7 @@ interface IFormsDataVectorSearch {
  * @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.
@@ -134,7 +167,7 @@ interface IFormDataSearchEntity {
     ip?: string;
     fingerprint?: string;
     isUserAdmin?: boolean;
-    status?: 'sent' | 'banned' | 'deleted' | 'moderation' | 'approved';
+    status?: FormDataStatus;
     formModuleId?: number;
     distance?: number;
 }
@@ -154,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
     [
       {
@@ -206,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
     [
       {
@@ -547,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
     [
@@ -565,7 +598,7 @@ interface ITextWithHeaderValue {
  */
 interface IBodyTypeImageGroupOfImages {
     marker: string;
-    type: 'image' | 'groupOfImage';
+    type: 'image' | 'groupOfImages';
     value: IImageValue | IImageValue[];
 }
 /**
@@ -583,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;
@@ -671,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.