oneentry 1.0.142 → 1.0.144

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

@@ -0,0 +1,88 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces';
+/**
+ * Controllers for working with file uploading
+ * @handle /api/content/files
+ * @class FileUploadingApi
+ * @augments AsyncModules
+ * @implements {IFileUploading}
+ * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
+ */
+export default class FileUploadingApi extends AsyncModules implements IFileUploading {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructs a new instance of the FileUploadingApi class.
+     */
+    constructor(state: StateModule);
+    /** FileUploadingApi class */
+    private _defaultQuery;
+    /**
+     * Upload file function.
+     * @handleName upload
+     * @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 {string | number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
+    /**
+     * Deletes a file from the cloud file storage.
+     * @handleName delete
+     * @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.
+     * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    createFileFromUrl(url: string, filename: string, mimeType?: string): Promise<File>;
+    /**
+     * Get file by parameters.
+     * @handleName getFile
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
+}

package/dist/file-uploading/fileUploadingApi.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+// import { IFileEntity } from './fileUploadingInterfaces';
+const fileUploadingSchemas_1 = require("./fileUploadingSchemas");
+/**
+ * Controllers for working with file uploading
+ * @handle /api/content/files
+ * @class FileUploadingApi
+ * @augments AsyncModules
+ * @implements {IFileUploading}
+ * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
+ */
+class FileUploadingApi extends asyncModules_1.default {
+    /**
+     * Constructs a new instance of the FileUploadingApi class.
+     */
+    constructor(state) {
+        super(state);
+        /** FileUploadingApi class */
+        this._defaultQuery = {
+            type: null,
+            entity: null,
+            id: null,
+            width: null,
+            height: null,
+            compress: null,
+        };
+        this._url = state.url + '/api/content/files';
+    }
+    /**
+     * Upload file function.
+     * @handleName upload
+     * @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 {string | number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async upload(file, fileQuery) {
+        const query = { ...this._defaultQuery, ...fileQuery };
+        const body = new FormData();
+        body.append('files', file);
+        const result = await this._fetchPost('?' + this._queryParamsToString(query), body);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, fileUploadingSchemas_1.UploadResponseSchema);
+        return validated;
+    }
+    /**
+     * Deletes a file from the cloud file storage.
+     * @handleName delete
+     * @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.
+     * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async delete(filename, fileQuery) {
+        const query = { ...this._defaultQuery, ...fileQuery };
+        const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
+        return result;
+    }
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    async createFileFromUrl(url, filename, mimeType) {
+        // eslint-disable-next-line no-undef
+        const response = await fetch(url);
+        const blob = await response.blob();
+        const file = new File([blob], filename, { type: mimeType || blob.type });
+        return file;
+    }
+    /**
+     * Get file by parameters.
+     * @handleName getFile
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getFile(id, type, entity, filename, template) {
+        // eslint-disable-next-line no-undef
+        const response = await fetch(this._getFullPath(`?id=${id}&type=${type}&entity=${entity}${`&filename=${filename}`}${template ? `&template=${template}` : ''}`), {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                'x-app-token': this.state.token,
+            },
+        });
+        return response;
+    }
+}
+exports.default = FileUploadingApi;

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

@@ -0,0 +1,114 @@
+import type { IError } from '../base/utils';
+/**
+ * Interface for uploading, deleting, and retrieving files in the CMS.
+ * @interface IFileUploading
+ * @description This interface defines methods for uploading, deleting, and retrieving files in the CMS.
+ */
+interface IFileUploading {
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    createFileFromUrl(url: string, filename: string, mimeType?: string): Promise<File>;
+    /**
+     * Upload file function.
+     * @handleName upload
+     * @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 {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {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.
+     */
+    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
+    /**
+     * Deletes a file from the cloud file storage.
+     * @handleName delete
+     * @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.
+     * @returns {boolean | IError} 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.
+     */
+    delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    /**
+     * Get file by parameters.
+     * @handleName getFile
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {Response | IError} Returns a promise that resolves to a Response object containing the file 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.
+     */
+    getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
+}
+/**
+ * Represents a file entity that may contain a file object or a path as a string.
+ * @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".
+ * @description Represents a file entity that may contain a file object or a path as a string.
+ */
+interface IFileEntity {
+    file: File | string | null;
+}
+/**
+ * Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
+ * @interface IUploadingQuery
+ * @property {string} type - Type, determines the folder name in the storage. Example: "page".
+ * @property {string} entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+ * @property {number} id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+ * @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 {
+    type: string | null;
+    entity: string | null;
+    id: number | null;
+    [key: string]: string | number | boolean | null;
+}
+/**
+ * Represents the return value of an uploading operation, including the filename, download link, and file size.
+ * @interface IUploadingReturn
+ * @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 {
+    filename: string;
+    downloadLink: string;
+    size: number;
+}
+export type { IFileEntity, IFileUploading, IUploadingQuery, IUploadingReturn };

package/dist/file-uploading/fileUploadingInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,22 @@
+/**
+ * Validation schemas for FileUploading module
+ * @description Zod schemas for validating file uploading-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Upload return schema
+ * Includes filename, downloadLink, and size
+ */
+export declare const UploadingReturnSchema: z.ZodObject<{
+    filename: z.ZodString;
+    downloadLink: z.ZodString;
+    size: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Upload response schema (array of upload results)
+ */
+export declare const UploadResponseSchema: z.ZodArray<z.ZodObject<{
+    filename: z.ZodString;
+    downloadLink: z.ZodString;
+    size: z.ZodNumber;
+}, z.core.$strip>>;

package/dist/file-uploading/fileUploadingSchemas.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadResponseSchema = exports.UploadingReturnSchema = void 0;
+/**
+ * Validation schemas for FileUploading module
+ * @description Zod schemas for validating file uploading-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Upload return schema
+ * Includes filename, downloadLink, and size
+ */
+exports.UploadingReturnSchema = zod_1.z.object({
+    filename: zod_1.z.string(),
+    downloadLink: zod_1.z.string(),
+    size: zod_1.z.number(),
+});
+/**
+ * Upload response schema (array of upload results)
+ */
+exports.UploadResponseSchema = zod_1.z.array(exports.UploadingReturnSchema);

package/dist/forms/formsApi.d.ts

@@ -0,0 +1,42 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IForms, IFormsEntity, IFormsResponse } from './formsInterfaces';
+/**
+ * Controllers for forms objects
+ * @class FormsApi
+ * @augments AsyncModules
+ * @implements {IForms}
+ * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
+ */
+export default class FormsApi extends AsyncModules implements IForms {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all forms.
+     * @handleName getAllForms
+     * @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 {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsResponse | IError>;
+    /**
+     * Get one form by form marker.
+     * @handleName getFormByMarker
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
+}

package/dist/forms/formsApi.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const formsSchemas_1 = require("./formsSchemas");
+/**
+ * Controllers for forms objects
+ * @class FormsApi
+ * @augments AsyncModules
+ * @implements {IForms}
+ * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
+ */
+class FormsApi extends asyncModules_1.default {
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/forms';
+    }
+    /**
+     * Get all forms.
+     * @handleName getAllForms
+     * @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 {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
+        const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, formsSchemas_1.FormsResponseSchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+    /**
+     * Get one form by form marker.
+     * @handleName getFormByMarker
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getFormByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, formsSchemas_1.FormEntitySchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+}
+exports.default = FormsApi;

package/dist/forms/formsInterfaces.d.ts

@@ -0,0 +1,144 @@
+import type { IPosition } from '../admins/adminsInterfaces';
+import type { IAttributes, IError, ILocalizeInfo } from '../base/utils';
+/**
+ * Interface for retrieving forms in the system.
+ * @interface IForms
+ * @description This interface defines methods for retrieving forms in the system.
+ */
+interface IForms {
+    /**
+     * Retrieves all forms in the system.
+     * @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<IFormsResponse | IError>;
+    /**
+     * Retrieves a form by its marker.
+     * @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
+    }
+ * @description This interface defines the structure of a form page.
+ */
+interface IFromPages {
+    id: number;
+    pageId: number;
+    formId: number;
+    positionId: number;
+    position: IPosition;
+}
+/**
+ * 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"
+    }
+ * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
+ */
+interface IFormsEntity {
+    id: number;
+    attributeSetId: number | null;
+    type: 'order' | 'sing_in_up' | 'collection' | 'data' | 'rating' | null;
+    localizeInfos: ILocalizeInfo;
+    version: number;
+    position: number;
+    identifier: string;
+    processingType: string;
+    templateId: number | null;
+    attributes: IAttributes[] | Record<string, any>;
+}
+/**
+ * Represents the structure of a form configuration.
+ * @interface IFormConfig
+ * @property {number} id - The identifier of the form configuration. Example: 123.
+ * @property {string} [formIdentifier] - The form identifier (only in products/pages API). Example: "review".
+ * @property {string} moduleIdentifier - The identifier of the module associated with the form configuration. Example: "module_identifier".
+ * @property {boolean} isGlobal - Indicates whether the form configuration is global. Example: true.
+ * @property {boolean} isClosed - Indicates whether the form configuration is closed. Example: true.
+ * @property {boolean} [isModerate] - Indicates whether the form requires moderation (only in products/pages API). Example: false.
+ * @property {boolean} [viewOnlyUserData] - Indicates whether the form configuration allows viewing user data (used in forms API). Example: true.
+ * @property {boolean} [commentOnlyUserData] - Indicates whether the form configuration allows commenting on user data (used in forms API). Example: true.
+ * @property {boolean} [viewOnlyMyData] - Indicates whether the form configuration allows viewing my data (used in products/pages API). Example: false.
+ * @property {boolean} [commentOnlyMyData] - Indicates whether the form configuration allows commenting on my data (used in products/pages API). Example: false.
+ * @property {object[]} entityIdentifiers - An array of entity identifiers associated with the form configuration.
+ * @property {string} entityIdentifiers[].id - Entity identifier. Example: "catalog".
+ * @property {boolean} entityIdentifiers[].isNested - Indicates if entity is nested. Example: false.
+ * @property {string[]} [nestedEntityIdentifiers] - An array of nested entity identifier strings (only in products/pages API). Example: ["catalog"].
+ * @property {string[]} [exceptionIds] - An array of exception identifiers.
+ * @property {number} [formDataCount] - Total count of form data entries (only in products/pages API). Example: 306.
+ * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: {"catalog": 306}.
+ * @description This interface defines the structure of a form configuration, including its identifiers, module association, and entity identifiers. Different APIs return different field variants.
+ */
+interface IFormConfig {
+    id: number;
+    formIdentifier?: string;
+    moduleIdentifier: string;
+    isGlobal: boolean;
+    isClosed: boolean;
+    isModerate?: boolean;
+    viewOnlyUserData?: boolean;
+    commentOnlyUserData?: boolean;
+    viewOnlyMyData?: boolean;
+    commentOnlyMyData?: boolean;
+    entityIdentifiers: {
+        id: string;
+        isNested: boolean;
+    }[];
+    nestedEntityIdentifiers?: string[];
+    exceptionIds?: string[];
+    formDataCount?: number;
+    entityFormDataCount?: Record<string, number>;
+}
+/**
+ * Represents the paginated response structure for forms.
+ * @interface IFormsResponse
+ * @property {number} total - Total items count.
+ * @property {IFormsEntity[]} items - Array of form entities.
+ */
+interface IFormsResponse {
+    total: number;
+    items: IFormsEntity[];
+}
+export type { IFormConfig, IForms, IFormsEntity, IFormsResponse, IFromPages };

package/dist/forms/formsInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });