oneentry 1.0.125 → 1.0.126

package/dist/{formsData → forms-data}/formsDataApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IFormDataEntity, IFormsData, IFormsDataEntity, IFormsPost } from './formsDataInterfaces';
+import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
  *
@@ -33,45 +33,49 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      *
      * @handleName postFormsData
      *
-     * @param {object} body - Request body. Example:
-        {
-          "formIdentifier": "file",
-          "formData": [
-            {
-              "marker": "name",
-              "type": "string",
-              "value": "filesArray"
-            },
-            {
-              "marker": "file",
-              "type": "file",
-              "value": filesArray,
-              "fileQuery": {
-                "type": "page",
-                "entity": "editor",
-                "id": 3492,
-              }
-            }
-          ]
-        }
+     * @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} [langCode] - Language code. Default: "en_US".
-     * @return {IFormDataEntity} Returns an object containing the created form data entry or an error object if there was an issue.
+     * @return {IPostFormResponse} Returns an object containing the created form data entry 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    postFormsData(body: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
+    postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
      * Get one object of form data by marker.
      *
      * @handleName getFormsDataByMarker
      *
-     * @param {string} marker - Marker of the form data. Example: "contact_form_data".
+     * @param {string} marker - Marker of the form. Example: "contact_form".
+     * @param {number} formModuleConfigId - Example: 12.
+     * @param {object} [body] - Example:
+        {
+          "entityIdentifier": "test",
+          "userIdentifier": "",
+          "status": "",
+          "dateFrom": "2025-08-11",
+          "dateTo": ""
+        }
+     * @param {any} [isNested] - 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.
-     * @return {IFormsDataEntity} Returns an object containing the form data or an error object if there was an issue.
+     * @return {IFormsByMarkerDataEntity} Returns an object containing the form data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    getFormsDataByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
+    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
 }

package/dist/{formsData → forms-data}/formsDataApi.js

@@ -41,29 +41,23 @@ class FormsDataApi extends asyncModules_1.default {
      *
      * @handleName postFormsData
      *
-     * @param {object} body - Request body. Example:
-        {
-          "formIdentifier": "file",
-          "formData": [
-            {
-              "marker": "name",
-              "type": "string",
-              "value": "filesArray"
-            },
-            {
-              "marker": "file",
-              "type": "file",
-              "value": filesArray,
-              "fileQuery": {
-                "type": "page",
-                "entity": "editor",
-                "id": 3492,
-              }
-            }
-          ]
-        }
+     * @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} [langCode] - Language code. Default: "en_US".
-     * @return {IFormDataEntity} Returns an object containing the created form data entry or an error object if there was an issue.
+     * @return {IPostFormResponse} Returns an object containing the created form data entry 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -125,16 +119,26 @@ class FormsDataApi extends asyncModules_1.default {
      *
      * @handleName getFormsDataByMarker
      *
-     * @param {string} marker - Marker of the form data. Example: "contact_form_data".
+     * @param {string} marker - Marker of the form. Example: "contact_form".
+     * @param {number} formModuleConfigId - Example: 12.
+     * @param {object} [body] - Example:
+        {
+          "entityIdentifier": "test",
+          "userIdentifier": "",
+          "status": "",
+          "dateFrom": "2025-08-11",
+          "dateTo": ""
+        }
+     * @param {any} [isNested] - 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.
-     * @return {IFormsDataEntity} Returns an object containing the form data or an error object if there was an issue.
+     * @return {IFormsByMarkerDataEntity} Returns an object containing the form data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    async getFormsDataByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+    async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isNested = 1, langCode = this.state.lang, offset = 0, limit = 30) {
+        const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isNested=${isNested}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
         return this._dataPostProcess(result, langCode);
     }
 }

package/dist/{formsData → forms-data}/formsDataInterfaces.d.ts

@@ -1,5 +1,5 @@
-import type { IUploadingQuery } from 'file-uploading/fileUploadingInterfaces';
 import type { IError } from '../base/utils';
+import type { IUploadingQuery } from '../file-uploading/fileUploadingInterfaces';
 /**
  * Interface for retrieving and posting form data in the system.
  *
@@ -22,37 +22,60 @@ interface IFormsData {
      */
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
     /**
-     * Posts form data to the system.
+     * Creating an object of data save information by form
      *
-     * @param {IFormsPost} data - The form data to be posted. Example:
+     * @handleName postFormsData
+     *
+     * @param {IBodyPostFormData} body - Request body. Example:
         {
-          "id": 1,
-          "formIdentifier": "string",
-          "time": "string",
-          "formData": [],
-          "fileQuery": {
-            "type": null;
-            "entity": null;
-            "id": null;
-            "key": null;
-          }
+          "formIdentifier": "form",
+          "formData": [
+            {
+              "marker": "name",
+              "type": "string",
+              "value": "Jack"
+            }
+          ]
         }
-     * @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.
+     * @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(data: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
+    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 {string} langCode - The language code for localization. Default: "en_US".
+     * @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, langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
+    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.
@@ -62,87 +85,176 @@ interface IFormsData {
  * @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 {FormDataType[]} formData - Form data. Example:
+    [
+      {
+        "marker": "name",
+        "type": "string",
+        "value": "Test"
       }
-    }
- * @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".
+    ]
+ * @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: IFormsPost;
-    attributeSetIdentifier?: string;
-    actionMessage?: string;
+    formData: FormDataType[];
+    attributeSetIdentifier?: string | null;
+    actionMessage?: string | null;
 }
 /**
  * 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"
+        "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 {
-    total: number;
     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 a form post object.
+ * Represents the structure of the body for posting form data.
  *
- * @interface IFormsPost
+ * @interface IBodyPostFormData
  *
- * @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:
+ * @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": "string",
+        "marker": "name",
         "type": "string",
-        "value": "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": null,
-      "entity": null,
-      "id": null,
-      "key": null,
+      "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 IFormsPost {
-    id?: number;
+interface IBodyPostFormData {
     formIdentifier: string;
-    time?: Date | string;
+    formModuleConfigId: number;
+    moduleEntityIdentifier: string;
+    replayTo: string | null;
+    status: string;
     formData: FormDataType[];
     fileQuery?: IUploadingQuery;
 }
@@ -347,4 +459,4 @@ interface IBodyTypeRadioButtonList {
         };
     }>;
 }
-export type { FormDataType, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFormDataEntity, IFormsData, IFormsDataEntity, IFormsPost, };
+export type { FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFormByMarkerDataEntity, IFormDataEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.125",
+  "version": "1.0.126",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",