oneentry 1.0.145 → 1.0.147

package/dist/discounts/discountsInterfaces.d.ts

@@ -1,4 +1,8 @@
-import type { IError } from '../base/utils';
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
+/**
+ * Discount type.
+ */
+type IDiscountType = 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
 /**
  * Interface for the Discounts API module.
  * @interface IDiscountsApi
@@ -10,12 +14,12 @@ interface IDiscountsApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
      */
-    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'): Promise<IDiscountsResponse | IError>;
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
@@ -38,10 +42,10 @@ interface IDiscountsApi {
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusBalance(): Promise<IDiscountsEntity | IError>;
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
@@ -54,18 +58,18 @@ interface IDiscountsApi {
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusHistory(type?: BonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
 }
 /**
  * Query parameters for fetching discounts.
  * @interface IDiscountsQuery
- * @property {'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'} [type] - Filter discounts by type.
+ * @property {IDiscountType} [type] - Filter discounts by type.
  * @property {string} langCode - The language code for localization. Example: "en_US".
  * @property {number} [offset] - Offset for pagination. Default: 0.
  * @property {number} [limit] - Limit for pagination. Default: 30.
  */
 interface IDiscountsQuery {
-    type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type?: IDiscountType;
     langCode: string;
     offset?: number;
     limit?: number;
@@ -85,21 +89,21 @@ interface IDiscountCondition {
  * @interface IDiscountsEntity
  * @property {number} id - The unique identifier of the discount.
  * @property {number} [attributeSetId] - The identifier of the discount.
- * @property {object} [localizeInfos] - The name of the discount.
+ * @property {ILocalizeInfo} [localizeInfos] - The name of the discount.
  * @property {number} [version] - The version of the discount.
  * @property {string} [identifier] - The identifier of the discount.
- * @property {string} [type] - The type of the discount.
+ * @property {IDiscountType} type - The type of the discount.
  * @property {string} [startDate] - The start date of the discount.
  * @property {string} [endDate] - The end date of the discount.
- * @property {Record<string, unknown>} [discountValue] - The value of the discount.
+ * @property {IDiscountValue} [discountValue] - The value of the discount, including its type and amount limits.
  * @property {string} [conditionLogic] - The logic of the discount. Possible values are "AND" | "OR".
  * @property {IDiscountCondition[]} [conditions] - The conditions of the discount.
- * @property {object} [exclusions] - The exclusions of the discount.
- * @property {object} [gifts] - The gifts of the discount.
+ * @property {Record<string, unknown> | null} [exclusions] - The exclusions of the discount.
+ * @property {Record<string, unknown> | null} [gifts] - The gifts of the discount.
  * @property {boolean} [giftsReplaceCartItems] - Whether the gifts replace cart items.
- * @property {object} [userGroups] - The user groups of the discount.
- * @property {object} [userExclusions] - The user exclusions of the discount.
- * @property {object} [attributeValues] - The attribute values of the discount.
+ * @property {Record<string, unknown> | null} [userGroups] - The user groups of the discount.
+ * @property {Record<string, unknown> | null} [userExclusions] - The user exclusions of the discount.
+ * @property {IAttributeValues} [attributeValues] - The attribute values of the discount.
  * @property {string} [attributeSetIdentifier] - The identifier of the attribute set.
  * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
  * @property {number} [position] - Position number for sorting. Example: 1.
@@ -108,26 +112,60 @@ interface IDiscountCondition {
 interface IDiscountsEntity {
     id: number;
     attributeSetId?: number;
-    localizeInfos?: object;
+    localizeInfos?: ILocalizeInfo;
     version?: number;
     identifier?: string;
-    type: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type: IDiscountType;
     startDate?: string;
     endDate?: string;
-    discountValue?: Record<string, unknown>;
+    discountValue?: IDiscountValue;
     conditionLogic?: 'AND' | 'OR';
     conditions?: IDiscountCondition[];
-    exclusions?: object;
-    gifts?: object;
+    exclusions?: Record<string, unknown> | null;
+    gifts?: Record<string, unknown> | null;
     giftsReplaceCartItems?: boolean;
-    userGroups?: object;
-    userExclusions?: object;
-    attributeValues?: object;
+    userGroups?: Record<string, unknown> | null;
+    userExclusions?: Record<string, unknown> | null;
+    attributeValues?: IAttributeValues;
     attributeSetIdentifier?: string;
-    bonusEvent?: Record<string, unknown>;
+    bonusEvent?: Record<string, unknown> | null;
     position?: number;
     total?: number | string;
 }
+/**
+ * @interface IDiscountValue
+ * @property {'TO_PRODUCT' | 'TO_ORDER'} applicability - What the discount applies to. Example: "TO_PRODUCT".
+ * @property {'FIXED_AMOUNT' | 'PERCENT'} discountType - How the discount value is interpreted. Example: "FIXED_AMOUNT".
+ * @property {number} value - Discount amount (currency units for FIXED_AMOUNT, percentage points for PERCENT). Example: 10.
+ * @property {number} [maxAmount] - Optional cap on the absolute discount applied. Example: 5.
+ * @description Configuration of the discount calculation.
+ */
+interface IDiscountValue {
+    applicability: 'TO_PRODUCT' | 'TO_ORDER';
+    discountType: 'FIXED_AMOUNT' | 'PERCENT';
+    value: number;
+    maxAmount?: number;
+}
+/**
+ * @interface ICouponEntity
+ * @property {number} id - Coupon record id. Example: 1.
+ * @property {number} discountId - Discount the coupon belongs to. Example: 1.
+ * @property {string} code - Coupon code. Example: "SUMMER-KBWZ-2428".
+ * @property {boolean} isReusable - Whether the coupon can be used more than once. Example: false.
+ * @property {boolean} isUsed - Whether the coupon has already been used. Example: false.
+ * @property {number | null} orderId - Order id where the coupon was applied, or null. Example: null.
+ * @property {string | null} usedAt - When the coupon was used, or null. Example: null.
+ * @description Coupon entity returned by the discounts API.
+ */
+interface ICouponEntity {
+    id: number;
+    discountId: number;
+    code: string;
+    isReusable: boolean;
+    isUsed: boolean;
+    orderId: number | null;
+    usedAt: string | null;
+}
 /**
  * Paginated response for discounts list.
  * @interface IDiscountsResponse
@@ -150,12 +188,12 @@ interface IDiscountsValidateCoupon {
  * Result of coupon validation.
  * @interface ICouponValidationResult
  * @property {boolean} valid - Whether the coupon is valid.
- * @property {unknown} [coupon] - Coupon data if the coupon is valid.
+ * @property {ICouponEntity} [coupon] - Coupon data if the coupon is valid.
  * @property {string} [error] - Error message if the coupon is invalid.
  */
 interface ICouponValidationResult {
     valid: boolean;
-    coupon?: unknown;
+    coupon?: ICouponEntity;
     error?: string;
 }
 /**
@@ -171,10 +209,10 @@ interface IDiscountByMarkerQuery {
 /**
  *
  */
-type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
+type IBonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
 /**
  * @interface IBonusHistoryQuery
- * @property {BonusTransactionType} [type] - Transaction type filter.
+ * @property {IBonusTransactionType} [type] - Transaction type filter.
  * @property {string} [dateFrom] - Start date filter.
  * @property {string} [dateTo] - End date filter.
  * @property {number} [discountId] - Discount id filter.
@@ -182,7 +220,7 @@ type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL'
  * @property {boolean} [isAdmin] - Admin filter.
  */
 interface IBonusHistoryQuery {
-    type?: BonusTransactionType;
+    type?: IBonusTransactionType;
     dateFrom?: string;
     dateTo?: string;
     discountId?: number;
@@ -193,7 +231,7 @@ interface IBonusHistoryQuery {
  * @interface IBonusTransactionEntity
  * @property {number} balanceId - Balance id.
  * @property {number} amount - Transaction amount.
- * @property {BonusTransactionType} type - Transaction type.
+ * @property {IBonusTransactionType} type - Transaction type.
  * @property {number} [discountId] - Discount id.
  * @property {number} [moduleId] - Module id.
  * @property {string} [entityIdentifier] - Entity identifier.
@@ -207,7 +245,7 @@ interface IBonusHistoryQuery {
 interface IBonusTransactionEntity {
     balanceId: number;
     amount: number;
-    type: BonusTransactionType;
+    type: IBonusTransactionType;
     discountId?: number;
     moduleId?: number;
     entityIdentifier?: string;
@@ -218,4 +256,12 @@ interface IBonusTransactionEntity {
     expiresAt?: string;
     createdAt?: string;
 }
-export type { BonusTransactionType, IBonusHistoryQuery, IBonusTransactionEntity, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, };
+/**
+ * @interface IBonusBalanceEntity
+ * @description Represents the balance of bonus points.
+ * @property {number} balance - The balance of bonus points. Example: 100
+ */
+interface IBonusBalanceEntity {
+    balance: number;
+}
+export type { IBonusBalanceEntity, IBonusHistoryQuery, IBonusTransactionEntity, IBonusTransactionType, ICouponEntity, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, IDiscountType, IDiscountValue, };

package/dist/forms/formsInterfaces.d.ts

@@ -1,5 +1,6 @@
 import type { IPosition } from '../admins/adminsInterfaces';
-import type { IAttributes, IError, ILocalizeInfo } from '../base/utils';
+import type { AttributeType, IAttributeValidators, IListTitle } from '../attribute-sets/attributeSetsInterfaces';
+import type { IAttributeLocalizeInfo, IError, ILocalizeInfo } from '../base/utils';
 /**
  * Interface for retrieving forms in the system.
  * @interface IForms
@@ -60,7 +61,7 @@ interface IFromPages {
  * @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.
+ * @property {IFormLocalizeInfo} localizeInfos - The name of the form and form-side localization fields (success/error messages, processing config, etc.).
  * @example
     {
       "key": "value"
@@ -70,11 +71,7 @@ interface IFromPages {
  * @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 {IFormAttribute[]} attributes - Form fields with their localization, validators and form-specific flags.
  * @property {number | string} [total] - Total count of related entries. Example: "1".
  * @property {IFormConfig[]} [moduleFormConfigs] - Array of module form configurations associated with the form.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
@@ -83,16 +80,82 @@ interface IFormsEntity {
     id: number;
     attributeSetId: number | null;
     type: 'order' | 'sing_in_up' | 'collection' | 'data' | 'rating' | null;
-    localizeInfos: ILocalizeInfo;
+    localizeInfos: IFormLocalizeInfo;
     version: number;
     position: number;
     identifier: string;
     processingType: string;
     templateId: number | null;
-    attributes?: IAttributes[] | Record<string, unknown>;
+    attributes: IFormAttribute[];
     total?: number | string;
     moduleFormConfigs?: IFormConfig[];
 }
+/**
+ * @interface IFormLocalizeInfo
+ * @property {string} [titleForSite] - Public-facing title shown on the website. Example: "Form title (for application)".
+ * @property {string} [successMessage] - Message shown to the user after successful submission.
+ * @property {string} [unsuccessMessage] - Message shown to the user after a failed submission.
+ * @property {string} [urlAddress] - URL where the form data is sent for processing (used by `processingType: "url"`).
+ * @property {string} [database] - Database flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
+ * @property {string} [script] - Script flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
+ * @description Localization payload of a form — extends {@link ILocalizeInfo} with form-side fields (messages, processing config).
+ */
+interface IFormLocalizeInfo extends ILocalizeInfo {
+    titleForSite?: string;
+    successMessage?: string;
+    unsuccessMessage?: string;
+    urlAddress?: string;
+    database?: string;
+    script?: string;
+}
+/**
+ * @interface IFormAttribute
+ * @property {string} marker - Field marker (machine name). Example: "email".
+ * @property {AttributeType} type - Attribute data type (e.g. "string", "file").
+ * @property {number} position - Sort position of the field. Example: 1.
+ * @property {boolean} isVisible - Whether the field is exposed to the user. Example: true.
+ * @property {IAttributeLocalizeInfo} localizeInfos - Localized labels for the field. For `timeInterval` attributes, also carries the `intervals` schedule payload.
+ * @property {unknown} initialValue - Default value applied when the field is not filled.
+ * @property {IListTitle[]} listTitles - Predefined options for `list`/`radioButton` fields; empty array for other types.
+ * @property {IAttributeValidators} validators - Validation rules; empty object when no validators are configured.
+ * @property {Record<string, unknown>} settings - Field-specific configuration; empty object by default.
+ * @property {Record<string, IFormAttributeAdditionalField>} additionalFields - Nested sub-fields keyed by marker; empty object when none.
+ * @property {boolean} isLogin - Whether this field carries the login value used for authentication. Example: false.
+ * @property {boolean} isSignUp - Whether this field is required during sign-up. Example: false.
+ * @property {boolean} isNotificationEmail - Whether this field stores the email used for notifications. Example: false.
+ * @property {boolean} isNotificationPhonePush - Whether this field stores the phone number used for push notifications. Example: false.
+ * @property {boolean} isNotificationPhoneSMS - Whether this field stores the phone number used for SMS notifications. Example: false.
+ * @description Definition of a single field inside a form — extends a generic attribute with form-specific authentication / notification flags.
+ */
+interface IFormAttribute {
+    marker: string;
+    type: AttributeType;
+    position: number;
+    isVisible: boolean;
+    localizeInfos: IAttributeLocalizeInfo;
+    initialValue: unknown;
+    listTitles: IListTitle[];
+    validators: IAttributeValidators;
+    settings: Record<string, unknown>;
+    additionalFields: Record<string, IFormAttributeAdditionalField>;
+    isLogin: boolean;
+    isSignUp: boolean;
+    isNotificationEmail: boolean;
+    isNotificationPhonePush: boolean;
+    isNotificationPhoneSMS: boolean;
+}
+/**
+ * @interface IFormAttributeAdditionalField
+ * @property {string} marker - Marker of the additional field. Example: "additional_field".
+ * @property {string} type - Type of the additional field. Example: "string".
+ * @property {unknown} value - Value of the additional field. Example: "Additional field data".
+ * @description A single nested entry inside {@link IFormAttribute}'s `additionalFields` map.
+ */
+interface IFormAttributeAdditionalField {
+    marker: string;
+    type: string;
+    value: unknown;
+}
 /**
  * Represents the structure of a form configuration.
  * @interface IFormConfig
@@ -112,7 +175,7 @@ interface IFormsEntity {
  * @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}.
+ * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: `{"catalog": 306}`.
  * @property {boolean | null} [isRating] - Indicates whether this form config is for ratings. Example: null.
  * @property {boolean | null} [isAnonymous] - Indicates whether anonymous submissions are allowed. Example: null.
  * @property {boolean | null} [allowHalfRatings] - Indicates whether half ratings are allowed. Example: null.
@@ -132,10 +195,7 @@ interface IFormConfig {
     commentOnlyUserData?: boolean;
     viewOnlyMyData?: boolean;
     commentOnlyMyData?: boolean;
-    entityIdentifiers: {
-        id: string;
-        isNested: boolean;
-    }[];
+    entityIdentifiers: IEntityIdentifier[];
     nestedEntityIdentifiers?: string[];
     exceptionIds?: string[];
     formDataCount?: number;
@@ -147,6 +207,16 @@ interface IFormConfig {
     maxRatingScale?: number | null;
     ratingCalculation?: string;
 }
+/**
+ * @interface IEntityIdentifier
+ * @property {string} id - Entity identifier (e.g. page or product marker). Example: "blog".
+ * @property {boolean} isNested - Whether the entit, is treated as ,ested unde, its parent. Exa,ple: false.
+ * @description Refe,ence to an entity attached to a form configuration.
+ */
+interface IEntityIdentifier {
+    id: string;
+    isNested: boolean;
+}
 /**
  * Represents the paginated response structure for forms.
  * @interface IFormsResponse
@@ -157,4 +227,4 @@ interface IFormsResponse {
     total: number;
     items: IFormsEntity[];
 }
-export type { IFormConfig, IForms, IFormsEntity, IFormsResponse, IFromPages };
+export type { IEntityIdentifier, IFormAttribute, IFormAttributeAdditionalField, IFormConfig, IFormLocalizeInfo, IForms, IFormsEntity, IFormsResponse, IFromPages, };

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

@@ -241,22 +241,37 @@ interface IFormsByMarkerDataEntity {
         "value": "Jack"
       }
     ]
- * @property {string | Record<string, string>} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully" or { "en_US": "Success" }.
+ * @property {string} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully".
  */
 interface IPostFormResponse {
-    actionMessage: string | Record<string, any>;
-    formData: {
-        id: number;
-        formIdentifier: string;
-        time: string;
-        entityIdentifier: string;
-        fingerprint: string;
-        isUserAdmin: boolean;
-        formModuleId: number;
-        userIdentifier: string | null;
-        parentId: number | null;
-        formData: FormDataType[] | Record<string, any>;
-    };
+    formData: IPostFormResponseData;
+    actionMessage: string;
+}
+/**
+ * @interface IPostFormResponseData
+ * @property {number} id - Identifier of the created form data record. Example: 42.
+ * @property {string} formIdentifier - Identifier of the form. Example: "contact_form".
+ * @property {string} time - Time of submission. Example: "2023-10-01T12:00:00Z".
+ * @property {string} entityIdentifier - Identifier of the entity the form is attached to. Example: "blog".
+ * @property {string} fingerprint - Submission fingerprint.
+ * @property {boolean} isUserAdmin - Whether the submitting user is an administrator. Example: false.
+ * @property {number} formModuleId - Form module configuration identifier. Example: 2.
+ * @property {string | null} userIdentifier - Identifier of the submitting user, or null when anonymous.
+ * @property {number | null} parentId - Identifier of the parent record, or null when top-level.
+ * @property {FormDataType[]} formData - Submitted form fields.
+ * @description Inner `formData` payload of {@link IPostFormResponse} — describes the created form data record.
+ */
+interface IPostFormResponseData {
+    id: number;
+    formIdentifier: string;
+    time: string;
+    entityIdentifier: string;
+    fingerprint: string;
+    isUserAdmin: boolean;
+    formModuleId: number;
+    userIdentifier: string | null;
+    parentId: number | null;
+    formData: FormDataType[];
 }
 /**
  * Represents the structure of the response after updating form data.
@@ -356,11 +371,19 @@ interface IBodyTypeStringNumberFloat {
 interface IBodyTypeTimeDate {
     marker: string;
     type: 'date' | 'dateTime' | 'time';
-    value: {
-        fullDate: string;
-        formattedValue: string;
-        formatString: string;
-    };
+    value: ITimeDateValue;
+}
+/**
+ * @interface ITimeDateValue
+ * @property {string} fullDate - ISO date string. Example: "2024-05-07T21:02:00.000Z".
+ * @property {string} formattedValue - Human-readable formatted date. Example: "08-05-2024 00:02".
+ * @property {string} formatString - Format mask used to render `formattedValue`. Example: "DD-MM-YYYY HH:mm".
+ * @description Value payload for `date`/`dateTime`/`time` form fields.
+ */
+interface ITimeDateValue {
+    fullDate: string;
+    formattedValue: string;
+    formatString: string;
 }
 /**
  * Represents a text form data entity.
@@ -382,14 +405,29 @@ interface IBodyTypeTimeDate {
 interface IBodyTypeText {
     marker: string;
     type: 'text';
-    value: {
-        htmlValue: string;
-        plainValue: string;
-        params: {
-            isEditorDisabled: boolean;
-            isImageCompressed: boolean;
-        };
-    };
+    value: ITextValue;
+}
+/**
+ * @interface ITextEditorParams
+ * @property {boolean} isEditorDisabled - Whether the rich-text editor is disabled. Example: false.
+ * @property {boolean} isImageCompressed - Whether embedded images are compressed. Example: true.
+ * @description Editor parameters attached to text-type form values.
+ */
+interface ITextEditorParams {
+    isEditorDisabled: boolean;
+    isImageCompressed: boolean;
+}
+/**
+ * @interface ITextValue
+ * @property {string} htmlValue - HTML representation of the text. Example: "<p>Hello world</p>".
+ * @property {string} plainValue - Plain-text representation.
+ * @property {ITextEditorParams} params - Editor configuration applied to this value.
+ * @description Value payload for `text` form fields.
+ */
+interface ITextValue {
+    htmlValue: string;
+    plainValue: string;
+    params: ITextEditorParams;
 }
 /**
  * Represents a text with header form data entity.
@@ -412,15 +450,21 @@ interface IBodyTypeText {
 interface IBodyTypeTextWithHeader {
     marker: string;
     type: 'textWithHeader';
-    value: {
-        header: string;
-        htmlValue: string;
-        plainValue: string;
-        params: {
-            isEditorDisabled: boolean;
-            isImageCompressed: boolean;
-        };
-    };
+    value: ITextWithHeaderValue;
+}
+/**
+ * @interface ITextWithHeaderValue
+ * @property {string} header - Headline text. Example: "Headline".
+ * @property {string} htmlValue - HTML body. Example: "<p>Hello world</p>".
+ * @property {string} plainValue - Plain-text body.
+ * @property {ITextEditorParams} params - Editor configuration applied to this value.
+ * @description Value payload for `textWithHeader` form fields.
+ */
+interface ITextWithHeaderValue {
+    header: string;
+    htmlValue: string;
+    plainValue: string;
+    params: ITextEditorParams;
 }
 /**
  * Represents an image or group of images form data entity.
@@ -445,23 +489,31 @@ interface IBodyTypeTextWithHeader {
 interface IBodyTypeImageGroupOfImages {
     marker: string;
     type: 'image' | 'groupOfImage';
-    value: {
-        filename: string;
-        downloadLink: string;
-        size: number;
-        previewLink: string;
-        params: {
-            isImageCompressed: boolean;
-        };
-    } | Array<{
-        filename: string;
-        downloadLink: string;
-        size: number;
-        previewLink: string;
-        params: {
-            isImageCompressed: boolean;
-        };
-    }>;
+    value: IImageValue | IImageValue[];
+}
+/**
+ * @interface IImageValueParams
+ * @property {boolean} isImageCompressed - Whether the stored image has been compressed by the server. Example: true.
+ * @description Per-image parameters attached to an image form value.
+ */
+interface IImageValueParams {
+    isImageCompressed: boolean;
+}
+/**
+ * @interface IImageValue
+ * @property {string} filename - Server-side path to the image. Example: "files/project/page/10/image/foo.png".
+ * @property {string} downloadLink - Public URL to download the image.
+ * @property {number} size - File size in bytes. Example: 392585.
+ * @property {string} previewLink - URL to a preview-sized version (may be empty).
+ * @property {IImageValueParams} params - Image-specific parameters.
+ * @description Value payload for `image`/`groupOfImage` form fields.
+ */
+interface IImageValue {
+    filename: string;
+    downloadLink: string;
+    size: number;
+    previewLink: string;
+    params: IImageValueParams;
 }
 /**
  * Represents a file form data entity.
@@ -482,11 +534,19 @@ interface IBodyTypeImageGroupOfImages {
 interface IBodyTypeFile {
     marker: string;
     type: 'file';
-    value: {
-        filename: string;
-        downloadLink: string;
-        size: number;
-    };
+    value: IFileValue;
+}
+/**
+ * @interface IFileValue
+ * @property {string} filename - Server-side path to the file.
+ * @property {string} downloadLink - Public URL to download the file.
+ * @property {number} size - File size in bytes.
+ * @description Value payload for `file` form fields.
+ */
+interface IFileValue {
+    filename: string;
+    downloadLink: string;
+    size: number;
 }
 /**
  * Represents a radio button or list selection form data entity.
@@ -510,13 +570,28 @@ interface IBodyTypeFile {
 interface IBodyTypeRadioButtonList {
     marker: string;
     type: 'list' | 'radioButton';
-    value: Array<{
-        title: string;
-        value: string;
-        extended: {
-            value: string;
-            type: string;
-        };
-    }>;
+    value: IListOptionValue[];
+}
+/**
+ * @interface IListOptionExtended
+ * @property {string} value - Extended option value (e.g. color code "#ff0000"). Example: "red".
+ * @property {string} type - Type of the extended value (e.g. "string", "color"). Example: "string".
+ * @description Extended payload attached to a list/radio option.
+ */
+interface IListOptionExtended {
+    value: string;
+    type: string;
+}
+/**
+ * @interface IListOptionValue
+ * @property {string} title - Option title shown to the user.
+ * @property {string} value - Underlying option value.
+ * @property {IListOptionExtended} extended - Extended payload (e.g. color/code) attached to the option.
+ * @description Value payload for `list`/`radioButton` form fields.
+ */
+interface IListOptionValue {
+    title: string;
+    value: string;
+    extended: IListOptionExtended;
 }
-export type { FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFormByMarkerDataEntity, IFormDataEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse, IUpdateFormsData, };
+export type { FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };

package/dist/menus/menusInterfaces.d.ts

@@ -82,6 +82,6 @@ interface IMenusEntity {
     id: number;
     identifier: string;
     localizeInfos: ILocalizeInfo;
-    pages: IMenusPages[] | IMenusPages;
+    pages: IMenusPages[];
 }
 export type { IMenus, IMenusEntity, IMenusPages };