oneentry 1.0.159 → 1.0.161

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

@@ -0,0 +1,670 @@
+import type { IError } from '../base/utils.js';
+import type { IUploadingQuery } from '../file-uploading/fileUploadingInterfaces.js';
+/**
+ * Interface for retrieving and posting form data in the system.
+ * @interface IFormsData
+ * @description This interface defines methods for retrieving and posting form data in the system.
+ */
+interface IFormsData {
+    /**
+     * Creating an object of data save information by form
+     * @handleName postFormsData
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
+        {
+          "formIdentifier": "test-form",
+          "formModuleConfigId": 2,
+          "moduleEntityIdentifier": "blog",
+          "replayTo": null,
+          "status": "sent",
+          "formData": [
+            {
+              "marker": "name",
+              "type": "string",
+              "value": "Test"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent. Example: null.
+     * @param {string | null} [body.status] - The status of the form submission. Example: "sent".
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
+        [
+          {
+            "marker": "name",
+            "type": "string",
+            "value": "Jack"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
+    /**
+     * Retrieves form data by its marker.
+     * @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: {}.
+     * @example
+        {
+          "entityIdentifier": "test",
+          "userIdentifier": "",
+          "status": "",
+          "dateFrom": "2025-08-11",
+          "dateTo": ""
+        }
+     * @param {number} [isNested] - Flag for getting hierarchical data. 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.
+     */
+    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
+    /**
+     * Semantic (vector) search for form data.
+     * @handleName getFormsDataByVectorSearch
+     * @param {IFormsDataVectorSearch} body - Vector search body. Example: `{ queryText: "order confirmation" }`.
+     * @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<IFormsDataSearchResponse | IError>} Returns an object with an array of found form data records and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getFormsDataByVectorSearch(body: IFormsDataVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataSearchResponse | IError>;
+}
+/**
+ * Body for semantic (vector) form data search.
+ * @interface IFormsDataVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "order confirmation".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the form-data vector/search endpoint.
+ */
+interface IFormsDataVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * Represents a form data record returned by the vector search endpoint.
+ * @interface IFormDataSearchEntity
+ * @property {number} [id] - The unique identifier of the form data record. Example: 12345.
+ * @property {string} [formIdentifier] - Text identifier of the form. Example: "contact_form".
+ * @property {Date | string} [time] - Date and time the form data was last changed. Example: "2023-02-12 10:56".
+ * @property {FormDataType[]} [formData] - Data submitted by the form.
+ * @example
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "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} [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".
+ * @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 {
+    id?: number;
+    formIdentifier?: string;
+    time?: Date | string;
+    formData?: FormDataType[];
+    userIdentifier?: string;
+    entityIdentifier?: string;
+    parentId?: number;
+    ip?: string;
+    fingerprint?: string;
+    isUserAdmin?: boolean;
+    status?: 'sent' | 'banned' | 'deleted' | 'moderation' | 'approved';
+}
+/**
+ * @interface IFormsDataSearchResponse
+ * @property {IFormDataSearchEntity[]} items - Array of found form data records.
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of the response returned by the form data vector search endpoint.
+ */
+interface IFormsDataSearchResponse {
+    items: IFormDataSearchEntity[];
+    total: number;
+}
+/**
+ * Represents the structure of a form data entity.
+ * @interface IFormDataEntity
+ * @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.
+ * @example
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Test"
+      }
+    ]
+ * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
+ * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
+ */
+interface IFormDataEntity {
+    id: number;
+    formIdentifier: string;
+    time: Date | string;
+    formData: FormDataType[];
+    attributeSetIdentifier: string | null;
+    moduleIdentifier?: string;
+}
+/**
+ * Represents a collection of form data entities.
+ * @interface IFormsDataEntity
+ * @property {IFormDataEntity[]} items - Array of form data objects.
+ * @example
+    [
+      {
+        "id": 1,
+        "formIdentifier": "form",
+        "time": "2025-06-06T19:07:45.993Z",
+        "formData": {},
+        "attributeSetIdentifier": "form",
+        "actionMessage": "Action message string"
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
+ */
+interface IFormsDataEntity {
+    items: IFormDataEntity[];
+    total: number;
+}
+/**
+ * Represents the structure of a form data entity.
+ * @interface IFormByMarkerDataEntity
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
+ * @property {null | number} parentId - The unique identifier of the parent form page. Example: 123.
+ * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
+ * @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} userIdentifier - Text identifier (marker) of the user. Example: "admin".
+ * @property {FormDataType[]} formData - Form data.
+ * @example
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Test"
+      }
+    ]
+ * @property {string | null} attributeSetIdentifier - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {string} entityIdentifier - Text identifier (marker) of the entity. Example: "test".
+ * @property {boolean} isUserAdmin - Is user admin. Example: true.
+ * @property {number} formModuleConfigId - Form module config Id. Example: 2.
+ * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
+ * @property {number} entityId - Form module config Id. Example: 2.
+ * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
+ */
+interface IFormByMarkerDataEntity {
+    id: number;
+    parentId?: null | number;
+    formIdentifier: string;
+    depth?: number;
+    ip?: string | null;
+    fingerprint?: string | null;
+    status?: string | null;
+    userIdentifier?: string | null;
+    formData: FormDataType[];
+    attributeSetIdentifier?: string | null;
+    time: Date | string;
+    entityIdentifier?: string;
+    isUserAdmin?: boolean;
+    formModuleConfigId?: number;
+    moduleIdentifier?: string;
+    entityId?: number;
+}
+/**
+ * Represents a collection of form data entities.
+ * @interface IFormsByMarkerDataEntity
+ * @property {IFormByMarkerDataEntity[]} items - Array of form data objects.
+ * @example
+    [
+      {
+        "id": 42,
+        "parentId": null,
+        "formIdentifier": "test-form",
+        "depth": 0,
+        "ip": null,
+        "status": null,
+        "userIdentifier": null,
+        "formData": [
+          {
+          "marker": "name",
+          "type": "string",
+          "value": "Test"
+          }
+        ],
+        "attributeSetIdentifier": "form",
+        "time": "2025-03-03T15:51:17.458Z",
+        "entityIdentifier": "blog",
+        "isUserAdmin": false,
+        "formModuleConfigId": 2
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
+ */
+interface IFormsByMarkerDataEntity {
+    items: IFormByMarkerDataEntity[];
+    total: number;
+}
+/**
+ * Represents the structure of the response after posting form data.
+ * @interface IPostFormResponse
+ * @property {object} formData - Form data.
+ * @example
+    {
+      "id": 42,
+      "formIdentifier": "contact_form",
+      "time": "2023-10-01T12:00:00Z",
+      "entityIdentifier": "blog",
+      "isUserAdmin": false,
+      "formModuleId": 2,
+      "parentId": null,
+      "userIdentifier": null,
+      "formData": [
+        {
+          "marker": "name",
+          "type": "string",
+          "value": "Jack"
+        }
+      ]
+    }
+ * @property {number} formData.id - The unique identifier of the form page. Example: 12345.
+ * @property {string} formData.formIdentifier - The identifier of the form. Example: "contact_form".
+ * @property {string} formData.time - The time of the form submit. Example: "2023-10-01T12:00:00Z".
+ * @property {string} formData.entityIdentifier - The entity identifier. Example: "blog".
+ * @property {boolean} formData.isUserAdmin - Is user admin. Example: false.
+ * @property {number} formData.formModuleId - The form module identifier. Example: 2.
+ * @property {string | null} formData.userIdentifier - The user identifier. Example: null.
+ * @property {number | null} formData.parentId - The parent identifier. Example: null.
+ * @property {FormDataType[]} formData.formData - Form fields data.
+ * @example
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Jack"
+      }
+    ]
+ * @property {string} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully".
+ */
+interface IPostFormResponse {
+    formData: IPostFormResponseData;
+    actionMessage: string;
+}
+/**
+ * @interface IPostFormResponseData
+ * @property {number} id - Identifier of the created form data record. Example: 42.
+ * @property {string} formIdentifier - Identifier of the form. Example: "contact_form".
+ * @property {string} time - Time of submission. Example: "2023-10-01T12:00:00Z".
+ * @property {string} entityIdentifier - Identifier of the entity the form is attached to. Example: "blog".
+ * @property {string | null} fingerprint - Submission fingerprint, or null for anonymous / app-token submissions.
+ * @property {boolean} isUserAdmin - Whether the submitting user is an administrator. Example: false.
+ * @property {number} formModuleId - Form module configuration identifier. Example: 2.
+ * @property {string | null} userIdentifier - Identifier of the submitting user, or null when anonymous.
+ * @property {number | null} parentId - Identifier of the parent record, or null when top-level.
+ * @property {FormDataType[]} formData - Submitted form fields.
+ * @description Inner `formData` payload of {@link IPostFormResponse} — describes the created form data record.
+ */
+interface IPostFormResponseData {
+    id: number;
+    formIdentifier: string;
+    time: string;
+    entityIdentifier: string;
+    fingerprint: string | null;
+    isUserAdmin: boolean;
+    formModuleId: number;
+    userIdentifier: string | null;
+    parentId: number | null;
+    formData: FormDataType[];
+}
+/**
+ * Represents the structure of the response after updating form data.
+ * @interface IUpdateFormsData
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
+ * @property {string} formIdentifier - The identifier of the form. Example: "contact_form".
+ * @property {string} time - The time of the form submit. Example: "2023-10-01T12:00:00Z".
+ * @property {FormDataType[]} formData - Form fields data.
+ * @property {string} userIdentifier - The user identifier. Example: null.
+ * @property {string} entityIdentifier - The entity identifier. Example: "blog".
+ * @property {null | number} parentId - The parent identifier. Example: null.
+ * @property {null | string} fingerprint - The fingerprint of the form. Example: null.
+ * @property {boolean} isUserAdmin - Is user admin. Example: false.
+ * @property {number} formModuleId - The form module identifier. Example: 2.
+ */
+interface IUpdateFormsData {
+    id: number;
+    formIdentifier: string;
+    time: string;
+    formData: FormDataType[];
+    userIdentifier: string;
+    entityIdentifier: string;
+    parentId: null | number;
+    fingerprint: null | string;
+    isUserAdmin: boolean;
+    formModuleId: number;
+}
+/**
+ * Contains an array of data form objects with the following values
+ */
+type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, unknown>;
+/**
+ * Represents the structure of the body for posting form data.
+ * @interface IBodyPostFormData
+ * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "form".
+ * @property {number} formModuleConfigId - The unique identifier of the form module configuration. Example: 2.
+ * @property {string} moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
+ * @property {string | null} replayTo - Email to reply to. Example: "some@email.com".
+ * @property {string} status - Status of the form. Example: "sent".
+ * @property {FormDataType[]} formData - Array of form data objects.
+ * @example
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Jack"
+      }
+    ]
+ * @property {string} formData[].marker - The marker identifying the form field. Example: "name".
+ * @property {string} formData[].type - The type of the form field. Example: "string".
+ * @property {string} formData[].value - The value of the form field. Example: "name".
+ * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files.
+ * @example
+    {
+      "type": "page",
+      "entity": "editor",
+      "id": 3787
+    }
+ * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
+ */
+interface IBodyPostFormData {
+    formIdentifier: string;
+    formModuleConfigId: number;
+    moduleEntityIdentifier: string;
+    replayTo: string | null;
+    status: string;
+    formData: FormDataType[];
+    fileQuery?: IUploadingQuery;
+}
+/**
+ * Represents a form data entity with a simple value.
+ * @interface IBodyTypeStringNumberFloat
+ * @property {string} marker - marker name. Example: "some_marker".
+ * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
+ * @property {string | number | null} value - Value of the form data entity. Send it as a string; in responses numeric fields come back normalized to `number`, or `null` when the field is empty. Example: "string".
+ * @description Represents a form data entity with a marker, type, and value.
+ */
+interface IBodyTypeStringNumberFloat {
+    marker: string;
+    type: 'string' | 'number' | 'float';
+    value: string | number | null;
+}
+/**
+ * Represents a date/time form data entity.
+ * @interface IBodyTypeTimeDate
+ * @property {string} marker - marker name. Example: "ome_marker".
+ * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString.
+ * @example
+    {
+      "fullDate": "2024-05-07T21:02:00.000Z",
+      "formattedValue": "08-05-2024 00:02",
+      "formatString": "DD-MM-YYYY HH:mm"
+    }
+ * @description Represents a date, dateTime, or time value in a structured format.
+ */
+interface IBodyTypeTimeDate {
+    marker: string;
+    type: 'date' | 'dateTime' | 'time';
+    value: ITimeDateValue;
+}
+/**
+ * @interface ITimeDateValue
+ * @property {string} fullDate - ISO date string. Example: "2024-05-07T21:02:00.000Z".
+ * @property {string} formattedValue - Human-readable formatted date. Example: "08-05-2024 00:02".
+ * @property {string} formatString - Format mask used to render `formattedValue`. Example: "DD-MM-YYYY HH:mm".
+ * @description Value payload for `date`/`dateTime`/`time` form fields.
+ */
+interface ITimeDateValue {
+    fullDate: string;
+    formattedValue: string;
+    formatString: string;
+}
+/**
+ * Represents a text form data entity.
+ * @interface IBodyTypeText
+ * @property {string} marker - marker name. Example: "some_marker".
+ * @property {string} type - Type value. Example: "text".
+ * @property {object} value - Text Object. Contains html as string, plain text and params.
+ * @example
+    {
+      "htmlValue": "<p>Hello world</p>",
+      "plainValue": "",
+      "params": {
+        "isEditorDisabled": false,
+        "isImageCompressed": true
+      }
+    }
+ * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
+ */
+interface IBodyTypeText {
+    marker: string;
+    type: 'text';
+    value: ITextValue;
+}
+/**
+ * @interface ITextEditorParams
+ * @property {boolean} isEditorDisabled - Whether the rich-text editor is disabled. Example: false.
+ * @property {boolean} isImageCompressed - Whether embedded images are compressed. Example: true.
+ * @description Editor parameters attached to text-type form values.
+ */
+interface ITextEditorParams {
+    isEditorDisabled: boolean;
+    isImageCompressed: boolean;
+}
+/**
+ * @interface ITextValue
+ * @property {string} htmlValue - HTML representation of the text. Example: "<p>Hello world</p>".
+ * @property {string} plainValue - Plain-text representation.
+ * @property {ITextEditorParams} params - Editor configuration applied to this value.
+ * @description Value payload for `text` form fields.
+ */
+interface ITextValue {
+    htmlValue: string;
+    plainValue: string;
+    params: ITextEditorParams;
+}
+/**
+ * Represents a text with header form data entity.
+ * @interface IBodyTypeTextWithHeader
+ * @property {string} marker - marker name. Example: "about".
+ * @property {string} type - Type value. Example: "textWithHeader".
+ * @property {object} value - Text Object. Contains html as string, header and params.
+ * @example
+    {
+      "header": "Headline",
+      "htmlValue": "<p>Hello World</p>",
+      "plainValue": "",
+      "params": {
+        "isEditorDisabled": false,
+        "isImageCompressed": true
+      }
+    }
+ * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
+ */
+interface IBodyTypeTextWithHeader {
+    marker: string;
+    type: 'textWithHeader';
+    value: ITextWithHeaderValue;
+}
+/**
+ * @interface ITextWithHeaderValue
+ * @property {string} header - Headline text. Example: "Headline".
+ * @property {string} htmlValue - HTML body. Example: "<p>Hello world</p>".
+ * @property {string} plainValue - Plain-text body.
+ * @property {ITextEditorParams} params - Editor configuration applied to this value.
+ * @description Value payload for `textWithHeader` form fields.
+ */
+interface ITextWithHeaderValue {
+    header: string;
+    htmlValue: string;
+    plainValue: string;
+    params: ITextEditorParams;
+}
+/**
+ * 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 {object} value - Image Object. Contains image information.
+ * @example
+    [
+      {
+        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "size": 392585,
+        "previewLink": "",
+        "params": {
+          "isImageCompressed": true
+        }
+      }
+    ]
+ * @description Represents an image or a group of images with their details, including filename, download link, size, preview link, and parameters for image compression.
+ */
+interface IBodyTypeImageGroupOfImages {
+    marker: string;
+    type: 'image' | 'groupOfImage';
+    value: IImageValue | IImageValue[];
+}
+/**
+ * @interface IImageValueParams
+ * @property {boolean} isImageCompressed - Whether the stored image has been compressed by the server. Example: true.
+ * @description Per-image parameters attached to an image form value.
+ */
+interface IImageValueParams {
+    isImageCompressed: boolean;
+}
+/**
+ * @interface IImageValue
+ * @property {string} filename - Server-side path to the image. Example: "files/project/page/10/image/foo.png".
+ * @property {string} downloadLink - Public URL to download the image.
+ * @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.
+ */
+interface IImageValue {
+    filename: string;
+    downloadLink: string;
+    size: number;
+    previewLink: string;
+    params: IImageValueParams;
+}
+/**
+ * Represents a file form data entity.
+ * @interface IBodyTypeFile
+ * @property {string} marker - marker name. Example: "picture".
+ * @property {'file'} type - Type value. Example: "file".
+ * @property {object} value - File Object. Contains file information. A single attached file is returned as the object itself, several files as an array.
+ * @example
+    [
+      {
+        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "size": 392585
+      }
+    ]
+ * @description Represents a file with its details, including filename, download link, and size.
+ */
+interface IBodyTypeFile {
+    marker: string;
+    type: 'file';
+    value: IFileValue | IFileValue[];
+}
+/**
+ * @interface IFileValue
+ * @property {string} filename - Server-side path to the file.
+ * @property {string} downloadLink - Public URL to download the file.
+ * @property {number} size - File size in bytes.
+ * @description Value payload for `file` form fields.
+ */
+interface IFileValue {
+    filename: string;
+    downloadLink: string;
+    size: number;
+}
+/**
+ * Represents a radio button or list selection form data entity.
+ * @interface IBodyTypeRadioButtonList
+ * @property {string} marker - marker name. Example: "selector".
+ * @property {string} type - Type value. Example: 'list'.
+ * @property {Array} value - Array of list or radioButton bojects.
+ * @example
+    [
+      {
+        "title": "red",
+        "value": "1",
+        "extended": {
+          "value": "red",
+          "type": "string"
+        }
+      }
+    ]
+ * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
+ */
+interface IBodyTypeRadioButtonList {
+    marker: string;
+    type: 'list' | 'radioButton';
+    value: IListOptionValue[];
+}
+/**
+ * @interface IListOptionExtended
+ * @property {string} value - Extended option value (e.g. color code "#ff0000"). Example: "red".
+ * @property {string} type - Type of the extended value (e.g. "string", "color"). Example: "string".
+ * @description Extended payload attached to a list/radio option.
+ */
+interface IListOptionExtended {
+    value: string;
+    type: string;
+}
+/**
+ * @interface IListOptionValue
+ * @property {string} title - Option title shown to the user.
+ * @property {string} value - Underlying option value.
+ * @property {IListOptionExtended} extended - Extended payload (e.g. color/code) attached to the option.
+ * @description Value payload for `list`/`radioButton` form fields.
+ */
+interface IListOptionValue {
+    title: string;
+    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, };

package/esm/forms-data/formsDataInterfaces.js

@@ -0,0 +1 @@
+export {};