oneentry 1.0.124 → 1.0.126

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

@@ -0,0 +1,462 @@
+import type { IError } from '../base/utils';
+import type { IUploadingQuery } from '../file-uploading/fileUploadingInterfaces';
+/**
+ * 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>;
+    /**
+     * Creating an object of data save information by form
+     *
+     * @handleName postFormsData
+     *
+     * @param {IBodyPostFormData} body - Request body. Example:
+        {
+          "formIdentifier": "form",
+          "formData": [
+            {
+              "marker": "name",
+              "type": "string",
+              "value": "Jack"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
+     * @param {FormDataType[]} body.formData - 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".
+     * @return {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.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     */
+    postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
+    /**
+     * Retrieves form data by its marker.
+     *
+     * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
+     * @param {number} formModuleConfigId - Example: 4.
+     * @param {object} [body] - Default: {}. Example:
+        {
+          "entityIdentifier": "test",
+          "userIdentifier": "",
+          "status": "",
+          "dateFrom": "2025-08-11",
+          "dateTo": ""
+        }
+     * @param {any} [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 {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, formModuleConfigId: number, body?: object, isNested?: number, 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 {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 | null} [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: FormDataType[];
+    attributeSetIdentifier?: string | null;
+    actionMessage?: string | null;
+}
+/**
+ * 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"
+      }
+    ]
+ * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
+ * @property {number} total - Total number of found records. Example: 100.
+ */
+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 {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {number} depth - Example: 1.
+ * @property {FormDataType[]} formData - Form data. Example:
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Test"
+      }
+    ]
+ * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
+ * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {string | null} [ip] - Example: '127.0.0.1'.
+ * @property {string | null} [status] - Example: ''.
+ * @property {string | null} [userIdentifier] - Example: ''.
+ * @property {string} [entityIdentifier] - Example: 'blog'.
+ * @property {boolean} [isUserAdmin] - Example: false.
+ * @property {number} [formModuleConfigId] - 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;
+    time: Date | string;
+    formData: FormDataType[];
+    actionMessage?: string | null;
+    attributeSetIdentifier?: string | null;
+    ip?: string | null;
+    status?: string | null;
+    userIdentifier?: string | null;
+    entityIdentifier: string;
+    isUserAdmin: boolean;
+    formModuleConfigId: 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;
+}
+interface IPostFormResponse {
+    actionMessage: string;
+    formData: {
+        id: number;
+        formIdentifier: string;
+        time: string;
+        entityIdentifier: string;
+        isUserAdmin: boolean;
+        formModuleId: number;
+        userIdentifier: any;
+        parentId: any;
+        formData: FormDataType[];
+    };
+}
+/**
+ * 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 the body for posting form data.
+ *
+ * @interface IBodyPostFormData
+ *
+ * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "form".
+ * @property {number} formModuleConfigId - Example: 2.
+ * @property {string} moduleEntityIdentifier - Example: "blog".
+ * @property {string | null} replayTo - Example: "".
+ * @property {string} status - Example: "sent".
+ * @property {FormDataType[]} formData - Array of form data objects. Example:
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Jack"
+      }
+    ]
+ * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
+ * @property {string} formData[index].type - The type of the form field. Example: "string".
+ * @property {string} formData[index].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} 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, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFormByMarkerDataEntity, IFormDataEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse, };

package/dist/general-types/generalTypesApi.d.ts

@@ -9,7 +9,6 @@ import type { IGeneralTypes, IGeneralTypesEntity } from './generalTypesInterface
  * @class GeneralTypesApi
  * @extends AsyncModules
  * @implements {IGeneralTypes}
- *
  * @description This class provides methods to interact with general types, including retrieving all types.
  */
 export default class GeneralTypesApi extends AsyncModules implements IGeneralTypes {
@@ -23,8 +22,7 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
      *
      * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method retrieves all general types available in the system.
      */
-    getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
 }

package/dist/general-types/generalTypesApi.js

@@ -11,7 +11,6 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  * @class GeneralTypesApi
  * @extends AsyncModules
  * @implements {IGeneralTypes}
- *
  * @description This class provides methods to interact with general types, including retrieving all types.
  */
 class GeneralTypesApi extends asyncModules_1.default {
@@ -26,7 +25,6 @@ class GeneralTypesApi extends asyncModules_1.default {
      *
      * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method retrieves all general types available in the system.
      */
     async getAllTypes() {

package/dist/general-types/generalTypesInterfaces.d.ts

@@ -6,7 +6,6 @@ import type { IError } from '../base/utils';
  * @interface IGeneralTypes
  *
  * @property {function} getAllTypes - Get all types.
- *
  * @description This interface defines a method for retrieving all general types in the system.
  */
 interface IGeneralTypes {
@@ -16,7 +15,7 @@ interface IGeneralTypes {
      * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
 }
 /**
  * Represents a general type entity.
@@ -24,8 +23,7 @@ interface IGeneralTypes {
  * @interface IGeneralTypesEntity
  *
  * @property {number} id - Type id. Example: 1.
- * @property {Types} type - Types enum. Example: 'product', 'category', etc.
- *
+ * @property {Types} type - Types enum. Example: "product", "category", "etc".
  * @description Represents a general type entity with an identifier and a type.
  */
 interface IGeneralTypesEntity {

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import BlocksApi from './blocks/blocksApi';
 import EventsApi from './events/eventsApi';
 import FileUploadingApi from './file-uploading/fileUploadingApi';
 import FormsApi from './forms/formsApi';
-import FormsDataApi from './formsData/formsDataApi';
+import FormsDataApi from './forms-data/formsDataApi';
 import GeneralTypesApi from './general-types/generalTypesApi';
 import IntegrationCollectionsApi from './integration-collections/integrationCollectionsApi';
 import LocalesApi from './locales/localesApi';

package/dist/index.js

@@ -15,7 +15,7 @@ const blocksApi_1 = __importDefault(require("./blocks/blocksApi"));
 const eventsApi_1 = __importDefault(require("./events/eventsApi"));
 const fileUploadingApi_1 = __importDefault(require("./file-uploading/fileUploadingApi"));
 const formsApi_1 = __importDefault(require("./forms/formsApi"));
-const formsDataApi_1 = __importDefault(require("./formsData/formsDataApi"));
+const formsDataApi_1 = __importDefault(require("./forms-data/formsDataApi"));
 const generalTypesApi_1 = __importDefault(require("./general-types/generalTypesApi"));
 const integrationCollectionsApi_1 = __importDefault(require("./integration-collections/integrationCollectionsApi"));
 const localesApi_1 = __importDefault(require("./locales/localesApi"));