oneentry 1.0.125 → 1.0.127

package/dist/formsData/formsDataInterfaces.d.ts

@@ -1,350 +0,0 @@
-import type { IUploadingQuery } from 'file-uploading/fileUploadingInterfaces';
-import type { IError } from '../base/utils';
-/**
- * Interface for retrieving and posting form data in the system.
- *
- * @interface IFormsData
- *
- * @property {function} getFormsData - Get all forms data.
- * @property {function} postFormsData - Find all product page objects with pagination and multiple filtering.
- * @property {function} getFormsDataByMarker - Get one object of form data by marker.
- * @description This interface defines methods for retrieving and posting form data in the system.
- */
-interface IFormsData {
-    /**
-     * Retrieves all forms data.
-     *
-     * @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.
-     * @return {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     */
-    getFormsData(langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
-    /**
-     * Posts form data to the system.
-     *
-     * @param {IFormsPost} data - The form data to be posted. Example:
-        {
-          "id": 1,
-          "formIdentifier": "string",
-          "time": "string",
-          "formData": [],
-          "fileQuery": {
-            "type": null;
-            "entity": null;
-            "id": null;
-            "key": null;
-          }
-        }
-     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @return {IFormDataEntity} 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.
-     */
-    postFormsData(data: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
-    /**
-     * Retrieves form data by its marker.
-     *
-     * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
-     * @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 {IFormsDataEntity} 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.
-     */
-    getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
-}
-/**
- * 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 {IFormsPost} formData - The identifier of the position. Example:
-    {
-      "id": 1,
-      "formIdentifier": "string",
-      "time": "string",
-      "formData": [],
-      "fileQuery": {
-        "type": null;
-        "entity": null;
-        "id": null;
-        "key": null;
-      }
-    }
- * @property {string} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
- * @property {string} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
- * @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: IFormsPost;
-    attributeSetIdentifier?: string;
-    actionMessage?: string;
-}
-/**
- * Represents a collection of form data entities.
- *
- * @interface IFormsDataEntity
- *
- * @property {number} total - Total number of found records. Example: 100.
- * @property {IFormDataEntity[]} items - Array of form data objects. Example:
-    [
-      {
-        "id": 1,
-        "formIdentifier": "string",
-        "time": "string",
-        "formData": "IFormsPost",
-        "attributeSetIdentifier": "string",
-        "actionMessage": "string"
-      }
-    ]
- * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
- */
-interface IFormsDataEntity {
-    total: number;
-    items: IFormDataEntity[];
-}
-/**
- * Contains an array of data form objects with the following values
- */
-type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, any>;
-/**
- * Represents the structure of a form post object.
- *
- * @interface IFormsPost
- *
- * @property {number} [id] - Optional identifier of the form post. Example: 1.
- * @property {string} formIdentifier - The identifier of the page. Example: "string".
- * @property {Date | string} [time] - Date and time of form modification. Example: "string".
- * @property {FormDataType[]} formData - The form data object. Example:
-    [
-      {
-        "marker": "string",
-        "type": "string",
-        "value": "string"
-      }
-    ]
- * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
-    {
-      "type": null,
-      "entity": null,
-      "id": null,
-      "key": null,
-    }
- * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
- */
-interface IFormsPost {
-    id?: number;
-    formIdentifier: string;
-    time?: Date | 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} value - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
- * @description Represents a form data entity with a marker, type, and value.
- */
-interface IBodyTypeStringNumberFloat {
-    marker: string;
-    type: 'string' | 'number' | 'float';
-    value: string;
-}
-/**
- * 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: {
-        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: {
-        htmlValue: string;
-        plainValue: string;
-        params: {
-            isEditorDisabled: boolean;
-            isImageCompressed: boolean;
-        };
-    };
-}
-/**
- * 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: {
-        header: string;
-        htmlValue: string;
-        plainValue: string;
-        params: {
-            isEditorDisabled: boolean;
-            isImageCompressed: boolean;
-        };
-    };
-}
-/**
- * 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: {
-        filename: string;
-        downloadLink: string;
-        size: number;
-        previewLink: string;
-        params: {
-            isImageCompressed: boolean;
-        };
-    } | Array<{
-        filename: string;
-        downloadLink: string;
-        size: number;
-        previewLink: string;
-        params: {
-            isImageCompressed: boolean;
-        };
-    }>;
-}
-/**
- * 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. 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: {
-        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: Array<{
-        title: string;
-        value: string;
-        extended: {
-            value: string;
-            type: string;
-        };
-    }>;
-}
-export type { FormDataType, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFormDataEntity, IFormsData, IFormsDataEntity, IFormsPost, };