oneentry 1.0.124 → 1.0.125

package/dist/file-uploading/fileUploadingInterfaces.d.ts

@@ -7,28 +7,57 @@ import type { IError } from '../base/utils';
  * @property {function} upload - Upload file from CMS.
  * @property {function} delete - Delete file from CMS.
  * @property {function} getFile - Get file by parameters.
- *
  * @description This interface defines methods for uploading, deleting, and retrieving files in the CMS.
  */
 interface IFileUploading {
     /**
-     * Uploads a file to the CMS.
+     * Upload file function.
      *
-     * @param {File | Blob} data - The file or blob data to be uploaded. Example: new File(["content"], "file.png", { type: "image/png" }).
-     * @param {IUploadingQuery} [fileQuery] - Optional query parameters for the upload. Example: { type: 'page', entity: 'editor', id: 3787, width: 0, height: 0, compress: true, template: 1 }.
+     * @handleName upload
      *
-     * @return {IUploadingReturns} A promise that resolves to an array of upload return values or an error.
+     * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "width": 0,
+          "height": 0,
+          "compress": true,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @return {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
-    upload(data: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturns | IError>;
+    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
-     * Deletes a file from the CMS.
+     * Deletes a file from the cloud file storage.
      *
-     * @param {string} filename - The name of the file to be deleted. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional query parameters for the deletion. Example: { type: 'page', entity: 'editor', id: 3787, template: 1 }.
+     * @handleName delete
      *
-     * @returns {any} A promise that resolves to any type or an error.
+     * @param {string} [filename] - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @return {any} Returns a promise that resolves to the result of the deletion operation 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.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
     /**
@@ -38,8 +67,7 @@ interface IFileUploading {
      * @param {string} type - The type of the file. Example: "page".
      * @param {string} entity - The entity associated with the file. Example: "editor".
      * @param {string} [filename] - Optional filename to retrieve. Example: "file.png".
-     *
-     * @returns {Blob} A promise that resolves to a Blob object or an error.
+     * @return {Blob} A promise that resolves to a Blob object or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
     getFile(id: number, type: string, entity: string, filename?: string): Promise<any | IError>;
@@ -49,8 +77,7 @@ interface IFileUploading {
  *
  * @interface IFileEntity
  *
- * @property {File | string | null} file - File object or string representing the file path. Example: new File(["content"], "file.png", { type: "image/png" }) or "/path/to/file.png".
- *
+ * @property {File | string | null} file - File object or string representing the file path. Example: new File(["content"], "file.png", { "type": "image/png" }) or "/path/to/file.png".
  * @description Represents a file entity that may contain a file object or a path as a string.
  */
 interface IFileEntity {
@@ -67,7 +94,6 @@ interface IFileEntity {
  * @property {number} [width] - Width parameter. Example: 0.
  * @property {number} [height] - Height parameter. Example: 0.
  * @property {boolean} [compress] - Flag of optimization (compression) for images. Example: true.
- *
  * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
  */
 interface IUploadingQuery {
@@ -84,7 +110,6 @@ interface IUploadingQuery {
  * @property {string} filename - Filename with relative path. Example: "uploads/file.png".
  * @property {string} downloadLink - Link for downloading the file. Example: "https://example.com/uploads/file.png".
  * @property {number} size - Size of the file in bytes. Example: 1024.
- *
  * @description Represents the return value of an uploading operation, including the filename, download link, and file size.
  */
 interface IUploadingReturn {
@@ -92,5 +117,4 @@ interface IUploadingReturn {
     downloadLink: string;
     size: number;
 }
-type IUploadingReturns = IUploadingReturn[];
-export type { IFileEntity, IFileUploading, IUploadingQuery, IUploadingReturns };
+export type { IFileEntity, IFileUploading, IUploadingQuery, IUploadingReturn };

package/dist/forms/formsApi.d.ts

@@ -23,13 +23,11 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @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 {IFormsEntity} Returns array for all objects of type FormEntity.
+     * @return {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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.
      */
-    getAllForms(langCode?: string, offset?: number, limit?: number): Promise<Array<IFormsEntity> | IError>;
+    getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsEntity[] | IError>;
     /**
      * Get one form by form marker.
      *
@@ -37,10 +35,8 @@ export default class FormsApi extends AsyncModules implements IForms {
      *
      * @param {string} marker - Marker of form. Example: "contact_form".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return - Returns object of type FormEntity.
+     * @return {IFormsEntity} Returns object of type FormEntity.
      * @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.
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;

package/dist/forms/formsApi.js

@@ -26,10 +26,8 @@ class FormsApi extends asyncModules_1.default {
      * @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 {IFormsEntity} Returns array for all objects of type FormEntity.
+     * @return {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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 getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
@@ -43,10 +41,8 @@ class FormsApi extends asyncModules_1.default {
      *
      * @param {string} marker - Marker of form. Example: "contact_form".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return - Returns object of type FormEntity.
+     * @return {IFormsEntity} Returns object of type FormEntity.
      * @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 getFormByMarker(marker, langCode = this.state.lang) {

package/dist/forms/formsInterfaces.d.ts

@@ -1,5 +1,5 @@
 import type { IPosition } from '../admins/adminsInterfaces';
-import type { IAttributes, IError } from '../base/utils';
+import type { IAttributes, IError, ILocalizeInfo } from '../base/utils';
 /**
  * Interface for retrieving forms in the system.
  *
@@ -7,7 +7,6 @@ import type { IAttributes, IError } from '../base/utils';
  *
  * @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 {
@@ -17,17 +16,15 @@ interface IForms {
      * @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.
+     * @return {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.
      */
-    getAllForms(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsEntity> | IError>;
+    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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -38,12 +35,19 @@ interface IForms {
  *
  * @interface IFromPages
  *
- * @property {number} id - The unique identifier of the form page. Example: .
- * @property {number} pageId - The identifier of the page. Example: .
- * @property {number} formId - The identifier of the form. Example: .
- * @property {number} positionId - The identifier of the position. Example: .
- * @property {IPosition} position - The position object. Example: .
- *
+ * @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 {
@@ -58,29 +62,41 @@ interface IFromPages {
  *
  * @interface IFormsEntity
  *
- * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
- * @property {Array<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: .
  * @property {number} id - The identifier of the object. Example: 12345.
- * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
- * @property {Record<string, any>} localizeInfos - The name of the form, taking into account localization. Example: .
- * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
+ * @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} type - Form type. Example: "contact".
+ * @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} version - The version number of the object. Example: 1.
- *
+ * @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 {
-    attributeSetId: number | null;
-    attributes: Array<IAttributes> | Record<string, any>;
     id: number;
-    identifier: string;
-    localizeInfos: Record<string, any>;
-    templateId: number | null;
-    position: number;
+    attributeSetId: number | null;
     type: string | null;
-    processingType: string;
+    localizeInfos: ILocalizeInfo;
     version: number;
+    position: number;
+    identifier: string;
+    processingType: string;
+    templateId: number | null;
+    attributes: IAttributes[] | Record<string, any>;
+    moduleFormConfigs?: Array<IFormConfig>;
+}
+interface IFormConfig {
+    id: number;
+    moduleIdentifier: string;
+    isGlobal: boolean;
+    isClosed: boolean;
+    viewOnlyUserData: boolean;
+    commentOnlyUserData: boolean;
+    entityIdentifiers: {
+        id: string;
+        isNested: boolean;
+    }[];
 }
-export type { IForms, IFormsEntity, IFromPages };
+export type { IFormConfig, IForms, IFormsEntity, IFromPages };

package/dist/formsData/formsDataApi.d.ts

@@ -9,7 +9,6 @@ import type { IFormDataEntity, IFormsData, IFormsDataEntity, IFormsPost } from '
  * @class FormsDataApi
  * @extends 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 {
@@ -24,10 +23,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @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.
      * @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>;
@@ -36,14 +33,31 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      *
      * @handleName postFormsData
      *
-     * @param {object} body - Request body. { "formIdentifier": "file", "formData": [ {"marker": "name", "type": "string", "value": "filesArray" }, { "marker": "file", "type": "file", "value": filesArray, fileQuery: { type: 'page', entity: 'editor', id: 3492, }, } ] }
+     * @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 {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.
      * @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>;
     /**
@@ -55,10 +69,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @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.
      * @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>;

package/dist/formsData/formsDataApi.js

@@ -13,7 +13,6 @@ const fileUploadingApi_1 = __importDefault(require("../file-uploading/fileUpload
  * @class FormsDataApi
  * @extends 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 {
@@ -29,10 +28,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @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.
      * @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 getFormsData(langCode = this.state.lang, offset = 0, limit = 30) {
@@ -44,14 +41,31 @@ class FormsDataApi extends asyncModules_1.default {
      *
      * @handleName postFormsData
      *
-     * @param {object} body - Request body. { "formIdentifier": "file", "formData": [ {"marker": "name", "type": "string", "value": "filesArray" }, { "marker": "file", "type": "file", "value": filesArray, fileQuery: { type: 'page', entity: 'editor', id: 3492, }, } ] }
+     * @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 {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.
      * @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 postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -115,10 +129,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @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.
      * @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) {