oneentry 1.0.126 → 1.0.127

package/dist/forms/formsInterfaces.d.ts

@@ -2,52 +2,50 @@ import type { IPosition } from '../admins/adminsInterfaces';
 import type { IAttributes, IError, ILocalizeInfo } from '../base/utils';
 /**
  * Interface for retrieving forms in the system.
- *
  * @interface IForms
- *
- * @property {function} getAllForms - Get all forms in array.
- * @property {function} getFormByMarker - Get one form by form marker.
+ * @property {Function} getAllForms     - Get all forms in array.
+ * @property {Function} getFormByMarker - Get one form by form marker.
  * @description This interface defines methods for retrieving forms in the system.
  */
 interface IForms {
     /**
      * Retrieves all forms in the system.
-     *
-     * @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 {IFormsEntity[]} A promise that resolves to an array of form entities or an error.
+     * @handleName getAllForms
+     * @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 {IFormsEntity[]}            A promise that resolves to an array of form entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves all forms in the system.
      */
     getAllForms(langCode: string, offset?: number, limit?: number): Promise<IFormsEntity[] | IError>;
     /**
      * Retrieves a form by its marker.
-     *
-     * @param {string} marker - The marker identifying the form. Example: "contact_form".
-     * @param {string} [langCode] - The language code for localization. Default: "en_US".
-     * @return {IFormsEntity} A promise that resolves to a form entity or an error.
+     * @handleName getFormByMarker
+     * @param   {string}       marker     - The marker identifying the form. Example: "contact_form".
+     * @param   {string}       [langCode] - The language code for localization. Default: "en_US".
+     * @returns {IFormsEntity}            A promise that resolves to a form 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 a form by its marker.
      */
     getFormByMarker(marker: string, langCode: string): Promise<IFormsEntity | IError>;
 }
 /**
  * Represents the structure of a form page.
- *
  * @interface IFromPages
- *
- * @property {number} id - The unique identifier of the form page. Example: 123.
- * @property {number} pageId - The identifier of the page. Example: 12.
- * @property {number} formId - The identifier of the form. Example: 321.
- * @property {number} positionId - The identifier of the position. Example: 1.
- * @property {IPosition} position - The position object. Example:
-    {
-      "id": 1,
-      "position": 1,
-      "objectId": 2,
-      "objectType": "admin",
-      "isLocked": false,
-      "objectCategoryId": 1
-    }
+ * @property {number}    id         - The unique identifier of the form page. Example: 123.
+ * @property {number}    pageId     - The identifier of the page. Example: 12.
+ * @property {number}    formId     - The identifier of the form. Example: 321.
+ * @property {number}    positionId - The identifier of the position. Example: 1.
+ * @property {IPosition} position   - The position object. Example:
+                                    {
+                                    "id": 1,
+                                    "position": 1,
+                                    "objectId": 2,
+                                    "objectType": "admin",
+                                    "isLocked": false,
+                                    "objectCategoryId": 1
+                                    }
  * @description This interface defines the structure of a form page.
  */
 interface IFromPages {
@@ -59,19 +57,17 @@ interface IFromPages {
 }
 /**
  * Represents the structure of a form entity.
- *
  * @interface IFormsEntity
- *
- * @property {number} id - The identifier of the object. Example: 12345.
- * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
- * @property {string | null} type - Form type. Example: "contact".
- * @property {ILocalizeInfo} localizeInfos - The name of the form, taking into account localization. Example: {"key": "value"}.
- * @property {number} version - The version number of the object. Example: 1.
- * @property {number} position - The position of the object. Example: 1.
- * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
- * @property {string} processingType - Type of form processing. Example: "async".
- * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
- * @property {IAttributes[] | Record<string, any>} attributes - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs. Example: {"key": "value"}.
+ * @property {number}                              id             - The identifier of the object. Example: 12345.
+ * @property {number | null}                       attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
+ * @property {string | null}                       type           - Form type. Example: "contact".
+ * @property {ILocalizeInfo}                       localizeInfos  - The name of the form, taking into account localization. Example: {"key": "value"}.
+ * @property {number}                              version        - The version number of the object. Example: 1.
+ * @property {number}                              position       - The position of the object. Example: 1.
+ * @property {string}                              identifier     - The textual identifier for the record field. Example: "form_contact_us".
+ * @property {string}                              processingType - Type of form processing. Example: "async".
+ * @property {number | null}                       templateId     - The identifier of the template used by the form, or null if no template is used. Example: 6789.
+ * @property {IAttributes[] | Record<string, any>} attributes     - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs. Example: {"key": "value"}.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {

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

@@ -4,76 +4,72 @@ import type { IError } from '../base/utils';
 import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
- *
  * @handle /api/content/form-data
  * @class FormsDataApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IFormsData}
  * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
  */
 export default class FormsDataApi extends AsyncModules implements IFormsData {
     protected state: StateModule;
     protected _url: string;
+    /**
+     *
+     */
     constructor(state: StateModule);
     /**
      * Get all forms data.
-     *
      * @handleName getFormsData
-     *
-     * @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 all forms data or an error object if there was an issue.
+     * @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 {IFormsDataEntity}            Returns an object containing all forms 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.
      */
     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: '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 {IPostFormResponse} Returns an object containing the created form data entry or an error object if there was an issue.
+     * @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".
+     * @returns {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: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
      * Get one object of form data by marker.
-     *
      * @handleName getFormsDataByMarker
-     *
-     * @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 {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
+     * @param   {string}                   marker             - Marker of the form. Example: "contact_form".
+     * @param   {number}                   formModuleConfigId - Form module configuration ID. Example: 4.
+     * @param   {object}                   [body]             - Request body. Example:
+                                                              {
+                                                              "entityIdentifier": "test",
+                                                              "userIdentifier": "",
+                                                              "status": "",
+                                                              "dateFrom": "2025-08-11",
+                                                              "dateTo": ""
+                                                              }
+     * @param   {any}                      [isNested]         - Flag for getting hierarchical data. 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 {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.
      */

package/dist/forms-data/formsDataApi.js

@@ -3,32 +3,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 const fileUploadingApi_1 = __importDefault(require("../file-uploading/fileUploadingApi"));
 /**
  * Controllers for working with form data
- *
  * @handle /api/content/form-data
  * @class FormsDataApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IFormsData}
  * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
  */
 class FormsDataApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/form-data';
     }
     /**
      * Get all forms data.
-     *
      * @handleName getFormsData
-     *
-     * @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 all forms data or an error object if there was an issue.
+     * @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 {IFormsDataEntity}            Returns an object containing all forms 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.
      */
@@ -38,26 +39,24 @@ class FormsDataApi extends asyncModules_1.default {
     }
     /**
      * 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} [langCode] - Language code. Default: "en_US".
-     * @return {IPostFormResponse} Returns an object containing the created form data entry or an error object if there was an issue.
+     * @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".
+     * @returns {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.
      */
@@ -116,28 +115,27 @@ class FormsDataApi extends asyncModules_1.default {
     }
     /**
      * Get one object of form data by marker.
-     *
      * @handleName getFormsDataByMarker
-     *
-     * @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 {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
+     * @param   {string}                   marker             - Marker of the form. Example: "contact_form".
+     * @param   {number}                   formModuleConfigId - Form module configuration ID. Example: 4.
+     * @param   {object}                   [body]             - Request body. Example:
+                                                              {
+                                                              "entityIdentifier": "test",
+                                                              "userIdentifier": "",
+                                                              "status": "",
+                                                              "dateFrom": "2025-08-11",
+                                                              "dateTo": ""
+                                                              }
+     * @param   {any}                      [isNested]         - Flag for getting hierarchical data. 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 {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, formModuleConfigId, body = {}, isNested = 1, langCode = this.state.lang, offset = 0, limit = 30) {
+        // ): Promise<IFormByMarkerDataEntity | IError> {
         const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isNested=${isNested}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
         return this._dataPostProcess(result, langCode);
     }