@wix/public-editor-platform-interfaces 1.37.0 → 1.38.0

package/dist/generated/dm-types.d.ts

@@ -49,7 +49,9 @@ export interface DataItem extends DataItemDataValueOneOf {
     data?: Data;
     /** Array of data items. */
     arrayItems?: ArrayItems;
-    /** The type of this data item, indicating how to interpret the value. */
+    /** Function definition with parameters, return value, and async flag. */
+    function?: _Function;
+    /** Data type of this item. Uses the app-service `DataTypeEnum.DataType` enum. */
     dataType?: DataType;
 }
 export interface DataItemDataValueOneOf {
@@ -103,85 +105,98 @@ export interface DataItemDataValueOneOf {
     data?: Data;
     /** Array of data items. */
     arrayItems?: ArrayItems;
+    /** Function definition with parameters, return value, and async flag. */
+    function?: _Function;
 }
 export declare enum DataType {
-    /** Unknown or unspecified data type. */
-    UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
-    /** Plain text string. */
-    TEXT = "TEXT",
-    /** Text value from a predefined set of options. */
-    TEXT_ENUM = "TEXT_ENUM",
-    /** Numeric value (integer or decimal). */
-    NUMBER = "NUMBER",
-    /** Boolean true/false value. */
-    BOOLEAN_VALUE = "BOOLEAN_VALUE",
-    /** Accessibility-related data. */
-    A11Y = "A11Y",
-    /** Hyperlink reference. */
-    LINK = "LINK",
-    /** Image reference with metadata. */
-    IMAGE = "IMAGE",
-    /** Video reference with metadata. */
-    VIDEO = "VIDEO",
-    /** Vector art/SVG reference. */
-    VECTOR_ART = "VECTOR_ART",
-    /** Audio file reference. */
-    AUDIO = "AUDIO",
-    /** Schema definition (deprecated). */
-    SCHEMA = "SCHEMA",
-    /** Date without time component (YYYY-MM-DD). */
-    LOCAL_DATE = "LOCAL_DATE",
-    /** Time without date component (HH:MM:SS). */
-    LOCAL_TIME = "LOCAL_TIME",
-    /** Combined date and time. */
-    LOCAL_DATE_TIME = "LOCAL_DATE_TIME",
-    /** Web URL reference. */
-    WEB_URL = "WEB_URL",
-    /** Email address. */
-    EMAIL = "EMAIL",
-    /** Phone number. */
-    PHONE = "PHONE",
-    /** Hostname/domain name. */
-    HOSTNAME = "HOSTNAME",
-    /** Regular expression pattern. */
-    REGEX = "REGEX",
-    /** Globally unique identifier. */
-    GUID = "GUID",
-    /** Rich text with formatting. */
-    RICH_TEXT = "RICH_TEXT",
-    /** Container for nested components. */
-    CONTAINER = "CONTAINER",
-    /** Array of items. */
-    ARRAY_ITEMS = "ARRAY_ITEMS",
-    /** Text direction (LTR/RTL). */
-    DIRECTION = "DIRECTION",
-    /** Menu items collection. */
-    MENU_ITEMS = "MENU_ITEMS",
-    /** Nested data structure containing typed values. */
-    DATA = "DATA"
+    UNKNOWN_DataType = "UNKNOWN_DataType",
+    /** A simple text value */
+    text = "text",
+    /** A list of predefined textual values to choose from */
+    textEnum = "textEnum",
+    /** Any number */
+    number = "number",
+    /** true / false value */
+    booleanValue = "booleanValue",
+    /** An object containing the selected A11Y fields chosen */
+    a11y = "a11y",
+    /** A Wix Link object type */
+    link = "link",
+    /** A Wix Image object type */
+    image = "image",
+    /** A Wix Video object type */
+    video = "video",
+    /** A Wix Sanitized Vector Art object */
+    vectorArt = "vectorArt",
+    /** A Wix Audio object */
+    audio = "audio",
+    /** DEPRECATED - use the `data` dataType instead. A [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply. */
+    schema = "schema",
+    /** Local date output ISO-8601 extended local date format (YYYY-MM-DD) */
+    localDate = "localDate",
+    /** Local time output ISO-8601 extended local time format (hh:mm[:ss][.sss]) */
+    localTime = "localTime",
+    /** Local Date Time output  ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss]) */
+    localDateTime = "localDateTime",
+    /** a URL with scheme http or https */
+    webUrl = "webUrl",
+    /** standard email address according to [RFC 5321, section 4.1.2](https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.2) */
+    email = "email",
+    /** a validation format designed to match phone numbers with a variety of common characters, including digits (0-9), spaces, parentheses, plus sign, hyphens, and periods */
+    phone = "phone",
+    /** hostname according to IANA */
+    hostname = "hostname",
+    /** A valid `regex` pattern supplied by the User */
+    regex = "regex",
+    /** A unique identifier */
+    guid = "guid",
+    /** a HTML text with css inline styling */
+    richText = "richText",
+    /** A container place in the component that will be passed in as {children} or a function prop, depending on the case */
+    container = "container",
+    /** An array type of data */
+    arrayItems = "arrayItems",
+    /** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
+    direction = "direction",
+    /** A list of menu-items */
+    menuItems = "menuItems",
+    /** A complex data type that can be used to define a data structure, such as an object or a map */
+    data = "data",
+    /** A custom function that can be used to call a function from a custom library */
+    'function' = "function",
+    /** Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event), can also handle: `()=>void` */
+    onClick = "onClick",
+    /** Standard input event [onChange](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) for text inputs, can also handle: `(value: string) => void` */
+    onChange = "onChange",
+    /** Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event), can also handle: `(event: KeyboardEvent) => void` */
+    onKeyPress = "onKeyPress",
+    /** Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event), can also handle: `(event: KeyboardEvent) => void` */
+    onKeyUp = "onKeyUp",
+    /** Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event), can also handle: `() => void` */
+    onSubmit = "onSubmit"
 }
 export interface Text {
     /**
-     * The text content.
+     * Text content.
      * @maxLength 50000
      */
     value?: string;
 }
 export interface RichText {
     /**
-     * The text content.
+     * Rich text content in HTML format.
      * @maxLength 50000
      */
     text?: string;
     /**
-     * Links embedded within the rich text.
+     * Links embedded within the rich text content.
      * @maxSize 1000
      */
     linkList?: Link[];
 }
 export interface TextEnum {
     /**
-     * The selected enum value as a string identifier.
+     * Selected enum value as a string identifier.
      * @maxLength 500
      */
     value?: string;
@@ -225,80 +240,80 @@ export interface _Number {
 }
 export interface LocalDate {
     /**
-     * The date value in YYYY-MM-DD format.
+     * Date value in YYYY-MM-DD format.
      * @format LOCAL_DATE
      */
     value?: string;
 }
 export interface LocalTime {
     /**
-     * The time value in HH:MM:SS format.
+     * Time value in HH:MM:SS format.
      * @format LOCAL_TIME
      */
     value?: string;
 }
 export interface LocalDateTime {
     /**
-     * The date-time value in ISO 8601 format.
+     * Date-time value in ISO 8601 format.
      * @format LOCAL_DATE_TIME
      */
     value?: string;
 }
 export interface WebUrl {
     /**
-     * The web URL.
+     * Web URL.
      * @format WEB_URL
      */
     value?: string;
 }
 export interface Email {
     /**
-     * The email address.
+     * Email address.
      * @format EMAIL
      */
     value?: string;
 }
 export interface Phone {
     /**
-     * The phone number.
+     * Phone number.
      * @format PHONE
      */
     value?: string;
 }
 export interface Hostname {
     /**
-     * The hostname.
+     * Hostname.
      * @format HOSTNAME
      */
     value?: string;
 }
 export interface Regex {
     /**
-     * The regular expression pattern.
+     * Regular expression pattern.
      * @maxLength 5000
      */
     value?: string;
 }
 export interface Guid {
     /**
-     * The GUID value.
+     * GUID value.
      * @format GUID
      */
     value?: string;
 }
 export interface BooleanValue {
-    /** The boolean value. */
+    /** Boolean value. */
     value?: boolean;
 }
 export interface Container {
     /**
-     * The container value.
+     * Component ID of the parent container.
      * @maxLength 1000
      */
     value?: string;
 }
 export interface Direction {
-    /** The direction value. */
+    /** Direction value. */
     value?: DirectionValue;
 }
 export declare enum DirectionValue {
@@ -322,28 +337,36 @@ export interface ArrayItems {
      */
     items?: Data[];
 }
+export interface _Function {
+    /** Ordered list of typed parameter values. */
+    parameters?: DataItem[];
+    /** Typed return value. */
+    returnValue?: DataItem;
+    /** Whether the function is asynchronous. */
+    isAsync?: boolean | null;
+}
 export interface MenuItems {
     /**
-     * Name of the menu.
+     * Menu name.
      * @maxLength 500
      */
     name?: string | null;
     /**
-     * App definition ID.
+     * ID of the app that owns this menu.
      * @maxLength 100
      */
-    appDefinitionId?: string | null;
+    appId?: string | null;
     /**
-     * List of menu items.
+     * Menu items.
      * @maxSize 100
      */
     items?: MenuItem[];
 }
 export interface MenuItem {
-    /** Link associated with this menu item. */
+    /** Link for this menu item. */
     link?: Link;
     /**
-     * Nested menu items (sub-menu).
+     * Nested sub-menu items.
      * @maxSize 100
      */
     items?: MenuItem[];
@@ -353,7 +376,7 @@ export interface MenuItem {
      */
     container?: string | null;
     /**
-     * Display label for the menu item.
+     * Display label.
      * @maxLength 1000
      */
     label?: string | null;
@@ -362,7 +385,7 @@ export interface MenuItem {
 }
 export interface Video {
     /**
-     * Unique identifier for the video media.
+     * URI to access the video file.
      * @maxLength 1000
      */
     uri?: string;
@@ -372,45 +395,45 @@ export interface Video {
      */
     sources?: VideoSource[];
     /**
-     * Sources for adaptive streaming formats.
+     * Adaptive streaming sources.
      * @maxSize 10
      */
     adaptiveSources?: AdaptiveSource[];
     /** Whether the video contains an audio track. */
     hasAudio?: boolean | null;
-    /** Frames per second of the video. */
+    /** Frames per second. */
     fps?: number | null;
     /**
-     * Poster image reference for the video.
+     * Poster image URI displayed before the video plays.
      * @maxLength 2000
      */
     poster?: string | null;
-    /** Duration of the video in seconds. */
+    /** Duration in seconds. */
     duration?: number | null;
     /**
-     * Human-readable name for the video.
+     * Display name of the video.
      * @maxLength 100
      */
     name?: string | null;
 }
 export interface VideoSource {
-    /** Quality level of the video source. */
+    /** Quality level. */
     quality?: VideoQuality;
-    /** Width of the video in pixels. */
+    /** Width in pixels. */
     width?: number | null;
-    /** Height of the video in pixels. */
+    /** Height in pixels. */
     height?: number | null;
     /**
-     * Available format types and their URIs for this quality.
+     * Available format types for this quality.
      * @maxSize 10
      */
     types?: VideoSourceType[];
 }
 export interface VideoSourceType {
-    /** Video format type. */
+    /** Video format. */
     format?: VideoFormat;
     /**
-     * URI to access the video file.
+     * URI to the video file.
      * @maxLength 2000
      */
     uri?: string | null;
@@ -439,7 +462,7 @@ export interface AdaptiveSource {
     /** Adaptive streaming format. */
     format?: AdaptiveFormat;
     /**
-     * URI to access the stream manifest.
+     * URI to the stream manifest.
      * @maxLength 2000
      */
     uri?: string | null;
@@ -454,30 +477,30 @@ export declare enum AdaptiveFormat {
 }
 export interface Audio {
     /**
-     * URI pointing to the audio resource.
+     * URI of the audio resource.
      * @maxLength 2000
      */
     uri?: string;
-    /** Whether the audio should play automatically. */
+    /** Whether the audio plays automatically. */
     autoPlay?: boolean | null;
-    /** Whether the audio should loop when finished. */
+    /** Whether the audio loops when finished. */
     loop?: boolean | null;
     /** Whether the audio player is visible. */
     visible?: boolean | null;
     /** Volume level (0-100). */
     volume?: number | null;
     /**
-     * Title of the audio track.
+     * Audio track title.
      * @maxLength 1000
      */
     title?: string | null;
     /**
-     * Description of the audio.
+     * Audio description.
      * @maxLength 2000
      */
     description?: string | null;
     /**
-     * Original file name of the audio file.
+     * Original file name.
      * @maxLength 2000
      */
     originalFileName?: string | null;
@@ -490,10 +513,10 @@ export interface VectorArt {
     uri?: string | null;
 }
 export interface ComponentData {
-    /** Component-specific data properties keyed by property name. */
+    /** Data properties keyed by property name. Available properties depend on the component type. */
     properties?: Record<string, DataItem>;
     /**
-     * Conditional data overrides that apply when specific conditions are met.
+     * Data overrides that apply different property values per repeater item.
      * @maxSize 100
      */
     overrides?: ComponentDataOverride[];
@@ -508,48 +531,63 @@ export interface ComponentDataOverrideComponentOverrideOneOf {
 }
 export interface RepeaterOverride {
     /**
-     * ID of the variant to use for this repeater override.
+     * Repeater item ID.
      * @maxLength 100
      */
     id?: string;
-    /** Component data properties that are applied for this repeated component instance. */
+    /** Data properties to apply for this repeater item. */
     properties?: Record<string, DataItem>;
 }
 export interface ComponentStyle extends ComponentStyleStylePropertiesOneOf {
-    /** CSS-based styling for new Editor React components. */
+    /** CSS-based styling. */
     css?: CssStyleProperties;
-    /** Legacy styling for components in studio or classic sites. */
+    /** Legacy styling for classic and Studio site components. */
     legacy?: LegacyStyleProperties;
-    /** Reference to a theme style (TopLevelStyle). */
+    /** Reference to a theme style. Applicable only for components built before the Wix Editor's builder platform. */
     theme?: ThemeStyleReference;
     /**
-     * Conditional style overrides (not applicable for theme references).
+     * Type of style applied to the component.
+     * @readonly
+     */
+    styleType?: StyleType;
+    /**
+     * Conditional style overrides that apply when all specified conditions are met. Not applicable for theme style references.
      * @maxSize 100
      */
     overrides?: ComponentStyleOverride[];
 }
 export interface ComponentStyleStylePropertiesOneOf {
-    /** CSS-based styling for new Editor React components. */
+    /** CSS-based styling. */
     css?: CssStyleProperties;
-    /** Legacy styling for components in studio or classic sites. */
+    /** Legacy styling for classic and Studio site components. */
     legacy?: LegacyStyleProperties;
-    /** Reference to a theme style (TopLevelStyle). */
+    /** Reference to a theme style. Applicable only for components built before the Wix Editor's builder platform. */
     theme?: ThemeStyleReference;
 }
+export declare enum StyleType {
+    /** Unknown style type. */
+    UNKNOWN_STYLE_TYPE = "UNKNOWN_STYLE_TYPE",
+    /** CSS-based styling. */
+    CSS = "CSS",
+    /** Legacy styling for classic and Studio site components. */
+    LEGACY = "LEGACY",
+    /** Reference to a theme style. */
+    THEME = "THEME"
+}
 export interface CssStyleProperties {
-    /** Standard CSS properties (e.g., backgroundColor, borderWidth). */
-    cssProperties?: Record<string, string>;
-    /** CSS custom properties/variables (e.g., content-horizontal-alignment). */
-    cssCustomProperties?: Record<string, string>;
+    /** CSS properties keyed by property name. For example, `backgroundColor`, `borderWidth`. */
+    properties?: Record<string, string>;
+    /** CSS custom properties (variables) keyed by variable name. For example, `--primary-color`, `--spacing-unit`. */
+    customProperties?: Record<string, string>;
 }
 export interface LegacyStyleProperties {
-    /** Style properties (e.g., bg, align, $st-css). */
+    /** Style properties keyed by property name. For example, `bg`, `align`. */
     properties?: Record<string, string>;
-    /** Source of each property (theme or value). */
+    /** Source of each property value, indicating whether the value comes from a theme or is explicitly set. */
     propertiesSource?: Record<string, PropertySource>;
-    /** Style groups (arbitrary structure). */
+    /** Style groups organizing related style properties into logical units such as fills, borders, and shadows. */
     groups?: Record<string, any> | null;
-    /** Text theme overrides per property (e.g., fnt). */
+    /** Text theme overrides keyed by property name. */
     propertiesOverride?: Record<string, PartialTextTheme>;
 }
 export declare enum PropertySource {
@@ -624,130 +662,144 @@ export interface PartialTextTheme {
 }
 export interface ThemeStyleReference {
     /**
-     * The theme style ID (e.g., "txtTheme").
+     * Theme style ID. For example, `txtTheme`.
      * @maxLength 100
      */
     referenceId?: string;
 }
 export interface ComponentStyleOverride extends ComponentStyleOverrideStylePropertiesOneOf {
-    /** CSS-based override. */
+    /** CSS-based style override. */
     css?: CssStyleProperties;
-    /**
-     * Legacy style override.
-     * @deprecated
-     * @targetRemovalDate 2040-01-01
-     */
+    /** Legacy style override. */
     legacy?: LegacyStyleProperties;
     /**
-     * Conditions (variant IDs) that must ALL be met.
+     * Conditions that must all be met for this override to apply.
      * @maxSize 100
      */
     conditions?: ConditionalTrigger[];
 }
 export interface ComponentStyleOverrideStylePropertiesOneOf {
-    /** CSS-based override. */
+    /** CSS-based style override. */
     css?: CssStyleProperties;
-    /**
-     * Legacy style override.
-     * @deprecated
-     * @targetRemovalDate 2040-01-01
-     */
+    /** Legacy style override. */
     legacy?: LegacyStyleProperties;
 }
-/**
- * Condition that determines when a style override should be applied.
- *
- * Supports various UI and interaction-based conditions such as display width breakpoints,
- * hover states, and user interactions. All conditions in an override are evaluated
- * with AND logic, and apply the override only when all conditions are met.
- */
 export interface ConditionalTrigger {
     /**
-     * Unique identifier for the condition.
+     * ID of the condition that triggers this override. Examples include responsive breakpoint IDs and interaction states such as hover.
      * @maxLength 100
      */
     conditionId?: string;
 }
-export interface Link extends LinkLinkTypeOneOf {
+export interface Link extends LinkLinkDataOneOf {
+    /** Link to a page on the same site. */
     pageLink?: PageLink;
+    /** Link to an external URL. */
     externalLink?: ExternalLink;
+    /** Link that opens an email client. */
     emailLink?: EmailLink;
+    /** Link to an anchor on a page. */
     anchorLink?: AnchorLink;
+    /** Link to a downloadable document. */
     documentLink?: DocumentLink;
+    /** Link that initiates a phone call. */
     phoneLink?: PhoneLink;
+    /** Link to a dynamic page route. */
     dynamicPageLink?: DynamicPageLink;
+    /** Text-based link. */
     textLink?: TextLink;
+    /** Link that opens a login or signup dialog. */
     loginToWixLink?: LoginToWixLink;
+    /** Link that opens WhatsApp. */
     whatsAppLink?: WhatsAppLink;
+    /** Link to a physical address on a map. */
     addressLink?: AddressLink;
-    tpaPageLink?: TpaPageLink;
+    /** Link to an app page. */
+    appPageLink?: AppPageLink;
+    /**
+     * The type of link.
+     * @readonly
+     */
+    linkType?: LinkType;
 }
-export interface LinkLinkTypeOneOf {
+export interface LinkLinkDataOneOf {
+    /** Link to a page on the same site. */
     pageLink?: PageLink;
+    /** Link to an external URL. */
     externalLink?: ExternalLink;
+    /** Link that opens an email client. */
     emailLink?: EmailLink;
+    /** Link to an anchor on a page. */
     anchorLink?: AnchorLink;
+    /** Link to a downloadable document. */
     documentLink?: DocumentLink;
+    /** Link that initiates a phone call. */
     phoneLink?: PhoneLink;
+    /** Link to a dynamic page route. */
     dynamicPageLink?: DynamicPageLink;
+    /** Text-based link. */
     textLink?: TextLink;
+    /** Link that opens a login or signup dialog. */
     loginToWixLink?: LoginToWixLink;
+    /** Link that opens WhatsApp. */
     whatsAppLink?: WhatsAppLink;
+    /** Link to a physical address on a map. */
     addressLink?: AddressLink;
-    tpaPageLink?: TpaPageLink;
+    /** Link to an app page. */
+    appPageLink?: AppPageLink;
 }
 export interface PageLink {
     /**
-     * ID of the target page within the same document.
+     * ID of the target page on the same site.
      * @maxLength 100
      */
     pageId?: string | null;
-    /** Specifies where to open the linked document. */
+    /** Where to open the linked page. */
     target?: LinkTarget;
     /** Relationship attributes for the link. */
     rel?: LinkRel;
 }
 export interface ExternalLink {
     /**
-     * URL of the external link.
+     * External URL.
      * @maxLength 2000
      */
     url?: string;
-    /** Specifies where to open the linked document. */
+    /** Where to open the linked URL. */
     target?: LinkTarget;
     /** Relationship attributes for the link. */
     rel?: LinkRel;
 }
 export interface EmailLink {
     /**
-     * Email address of the recipient.
+     * Recipient's email address.
      * @maxLength 320
      */
-    recipient?: string;
+    email?: string;
     /**
-     * Subject of the email.
+     * Email subject line.
      * @maxLength 500
      */
     subject?: string;
     /**
-     * Body or content of the email.
+     * Email body text.
      * @maxLength 5000
      */
     body?: string;
 }
 export interface AnchorLink {
     /**
-     * Name of the anchor.
+     * Display name of the anchor.
      * @maxLength 200
      */
-    anchorName?: string;
+    name?: string;
     /**
-     * ID of the anchor data or "SCROLL_TO_TOP".
+     * ID of the anchor element on the page. Use `SCROLL_TO_TOP` instead of an element ID to scroll to the top of the page.
      * @maxLength 100
      */
-    anchorDataId?: string | null;
+    dataId?: string | null;
     /**
-     * ID of the target page.
+     * ID of the page containing the anchor.
      * @maxLength 100
      */
     pageId?: string | null;
@@ -756,16 +808,16 @@ export interface AnchorLink {
 }
 export interface DocumentLink {
     /**
-     * ID of the document.
+     * Document ID.
      * @maxLength 100
      */
-    docId?: string;
+    documentId?: string;
     /**
-     * Name of the document.
+     * Document name.
      * @maxLength 500
      */
     name?: string;
-    /** Whether the document is indexable. */
+    /** Whether the document is indexable by search engines. */
     indexable?: boolean;
 }
 export interface PhoneLink {
@@ -773,92 +825,87 @@ export interface PhoneLink {
      * Phone number to call.
      * @maxLength 100
      */
-    phoneNumber?: string;
+    phone?: string;
 }
 export interface DynamicPageLink {
     /**
-     * ID of the router.
+     * Router ID.
      * @maxLength 100
      */
     routerId?: string;
     /**
-     * Inner route path.
+     * Inner route path within the router.
      * @maxLength 500
      */
     innerRoute?: string;
     /**
-     * ID of the anchor data.
+     * Anchor data ID.
      * @maxLength 100
      */
     anchorDataId?: string | null;
-    /** Whether this is a TPA route. */
-    tpaRoute?: boolean;
-    /** Specifies where to open the linked document. */
+    /** Whether this is an app route. */
+    appRoute?: boolean;
+    /** Where to open the linked page. */
     target?: LinkTarget;
     /** Relationship attributes for the link. */
     rel?: LinkRel;
 }
 export interface TextLink {
-    /** Type of the text link. */
-    linkType?: LinkType;
+    /** Text link type. */
+    textLinkType?: TextLinkType;
     /**
-     * URL or destination of the link.
+     * Link destination URL.
      * @maxLength 2000
      */
     href?: string;
     /**
-     * Display text for the link.
+     * Display text.
      * @maxLength 1200
      */
     text?: string;
     /**
-     * Target attribute for the link.
+     * Link target attribute. For example, `_blank` to open in a new tab.
      * @maxLength 50
      */
     target?: string;
-    /**
-     * Icon identifier for the link.
-     * @maxLength 200
-     */
-    icon?: string;
 }
 export interface LoginToWixLink {
     /**
-     * URL to redirect after login.
+     * URL to redirect to after login.
      * @maxLength 2000
      */
     postLoginUrl?: string;
     /**
-     * URL to redirect after signup.
+     * URL to redirect to after signup.
      * @maxLength 2000
      */
     postSignupUrl?: string;
-    /** Type of login dialog to show. */
+    /** Type of dialog to show. */
     dialog?: LoginDialog;
-    /** Whether to send email notification. */
-    sendMail?: boolean;
+    /** Whether to send an email notification after login or signup. */
+    emailNotificationEnabled?: boolean;
     /**
-     * Mail template identifier.
+     * Email template identifier.
      * @maxLength 500
      */
-    mailTemplate?: string;
+    emailTemplate?: string;
     /**
-     * User color preference.
+     * Accent color for the login or signup dialog, used to style buttons and highlights. For example, `#3899EC`.
      * @maxLength 50
      */
-    userColor?: string;
+    loginDialogAccentColor?: string;
     /**
-     * Login component name.
+     * Name of the login component that triggered this link. Used for analytics and tracking purposes.
      * @maxLength 200
      */
-    loginCompName?: string;
+    loginComponentName?: string;
 }
 export interface WhatsAppLink {
     /**
      * WhatsApp phone number.
      * @maxLength 100
      */
-    phoneNumber?: string;
+    phone?: string;
 }
 export interface AddressLink {
     /**
@@ -867,39 +914,39 @@ export interface AddressLink {
      */
     address?: string;
 }
-export interface TpaPageLink {
+export interface AppPageLink {
     /**
-     * Type identifier of the item.
+     * Item type identifier.
      * @maxLength 200
      */
     itemTypeIdentifier?: string;
     /**
-     * ID of the item.
+     * Item ID.
      * @maxLength 100
      */
     itemId?: string;
     /**
-     * ID of the target page.
+     * Target page ID.
      * @maxLength 100
      */
     pageId?: string | null;
     /**
-     * App definition ID.
+     * App ID.
      * @maxLength 100
      */
-    appDefinitionId?: string;
+    appId?: string;
     /**
-     * Path within the TPA page.
+     * Path within the app page.
      * @maxLength 500
      */
     path?: string;
-    /** Specifies where to open the linked document. */
+    /** Where to open the linked page. */
     target?: LinkTarget;
     /** Relationship attributes for the link. */
     rel?: LinkRel;
 }
 export declare enum LinkTarget {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_LINK_TARGET = "UNKNOWN_LINK_TARGET",
     /** Opens the linked document in the same frame as it was clicked (default). */
     SELF = "SELF",
     /** Opens the linked document in a new window or tab. */
@@ -913,7 +960,7 @@ export interface LinkRel {
     items?: LinkRelEnumLinkRel[];
 }
 export declare enum LinkRelEnumLinkRel {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_LINK_REL = "UNKNOWN_LINK_REL",
     /** Instructs search engines not to follow the link. */
     NOFOLLOW = "NOFOLLOW",
     /** Prevents the new page from being able to access the window.opener property. */
@@ -924,118 +971,163 @@ export declare enum LinkRelEnumLinkRel {
     SPONSORED = "SPONSORED"
 }
 export declare enum LinkType {
-    UNSPECIFIED = "UNSPECIFIED",
+    /** Unknown link type. */
+    UNKNOWN_LINK_TYPE = "UNKNOWN_LINK_TYPE",
+    /** Link to a page on the same site. */
+    PAGE_LINK = "PAGE_LINK",
+    /** Link to an external URL. */
+    EXTERNAL_LINK = "EXTERNAL_LINK",
+    /** Link that opens an email client. */
+    EMAIL_LINK = "EMAIL_LINK",
+    /** Link to an anchor on a page. */
+    ANCHOR_LINK = "ANCHOR_LINK",
+    /** Link to a downloadable document. */
+    DOCUMENT_LINK = "DOCUMENT_LINK",
+    /** Link that initiates a phone call. */
+    PHONE_LINK = "PHONE_LINK",
+    /** Link to a dynamic page route. */
+    DYNAMIC_PAGE_LINK = "DYNAMIC_PAGE_LINK",
+    /** Text-based link. */
+    TEXT_LINK = "TEXT_LINK",
+    /** Link that opens a login or signup dialog. */
+    LOGIN_TO_WIX_LINK = "LOGIN_TO_WIX_LINK",
+    /** Link that opens WhatsApp. */
+    WHATS_APP_LINK = "WHATS_APP_LINK",
+    /** Link to a physical address on a map. */
+    ADDRESS_LINK = "ADDRESS_LINK",
+    /** Link to an app page. */
+    APP_PAGE_LINK = "APP_PAGE_LINK"
+}
+export declare enum TextLinkType {
+    /** Unknown text link type. */
+    UNKNOWN_TEXT_LINK_TYPE = "UNKNOWN_TEXT_LINK_TYPE",
+    /** SMS message link. */
     SMS = "SMS",
+    /** Phone call link. */
     CALL = "CALL",
+    /** Skype link. */
     SKYPE = "SKYPE",
+    /** Map link. */
     MAP = "MAP",
+    /** Email link. */
     EMAIL = "EMAIL",
+    /** Facebook link. */
     FACEBOOK = "FACEBOOK",
+    /** Flickr link. */
     FLICKR = "FLICKR",
-    BLOGGER = "BLOGGER",
-    MYSPACE = "MYSPACE",
+    /** LinkedIn link. */
     LINKEDIN = "LINKEDIN",
+    /** Twitter link. */
     TWITTER = "TWITTER",
+    /** Tumblr link. */
     TUMBLR = "TUMBLR",
+    /** YouTube link. */
     YOUTUBE = "YOUTUBE",
+    /** Vimeo link. */
     VIMEO = "VIMEO",
+    /** Internal page link. */
     PAGE = "PAGE",
-    /** Default value. */
+    /** Custom URL link. */
     FREE_LINK = "FREE_LINK",
+    /** Text link. */
     TEXT = "TEXT",
-    DELICIOUS = "DELICIOUS",
+    /** External website link. */
     WEBSITE = "WEBSITE",
+    /** Document link. */
     DOCUMENT = "DOCUMENT",
+    /** Admin login link. */
     ADMIN_LOGIN = "ADMIN_LOGIN",
+    /** Login link. */
     LOGIN = "LOGIN"
 }
 export declare enum LoginDialog {
-    UNSPECIFIED = "UNSPECIFIED",
-    /** Show create user dialog. */
+    /** Unknown login dialog type. */
+    UNKNOWN_LOGIN_DIALOG = "UNKNOWN_LOGIN_DIALOG",
+    /** Shows the signup registration form directly. */
     CREATE_USER = "CREATE_USER",
-    /** Show login dialog (default). */
+    /** Shows a login-only dialog without a signup option. This is the default value. */
     LOGIN = "LOGIN",
-    /** Show login dialog. */
-    SHOW_LOGIN = "SHOW_LOGIN"
+    /** Shows a login dialog that also includes an option to switch to signup. */
+    LOGIN_WITH_SIGNUP = "LOGIN_WITH_SIGNUP"
 }
 export interface A11y {
-    /** Number attributes */
+    /** Value of the `tabindex` attribute. */
     tabIndex?: number | null;
-    /** The value used for aria-level (1 to 6). */
+    /** Value of the `aria-level` attribute. */
     ariaLevel?: number | null;
-    /** Boolean attributes */
+    /** Value of the `aria-expanded` attribute. */
     ariaExpanded?: boolean | null;
-    /** The value used for aria-disabled. */
+    /** Value of the `aria-disabled` attribute. */
     ariaDisabled?: boolean | null;
-    /** The value used for aria-atomic. */
+    /** Value of the `aria-atomic` attribute. */
     ariaAtomic?: boolean | null;
-    /** The value used for aria-hidden. */
+    /** Value of the `aria-hidden` attribute. */
     ariaHidden?: boolean | null;
-    /** The value used for aria-busy. */
+    /** Value of the `aria-busy` attribute. */
     ariaBusy?: boolean | null;
-    /** Indicates if should add Multiline instructions to aria-label. */
-    multiline?: boolean | null;
-    /** Indicates if should add Autocomplete instructions to aria-label. */
-    ariaAutocomplete?: boolean | null;
-    /** The value used for aria-multiline. */
+    /** Whether to include multiline instructions in the `aria-label`. Not the same as the standard `aria-multiline` attribute (see field 10). */
+    includeMultilineInstructions?: boolean | null;
+    /** Whether to include autocomplete instructions in the `aria-label`. Not the same as the standard `aria-autocomplete` attribute, which accepts string values. */
+    includeAutocompleteInstructions?: boolean | null;
+    /** Value of the `aria-multiline` attribute. */
     ariaMultiline?: boolean | null;
-    /** Enum attributes */
+    /** Value of the `aria-pressed` attribute. */
     ariaPressed?: AriaPressed;
-    /** The value used for aria-haspopup (true, false, dialog, menu). */
+    /** Value of the `aria-haspopup` attribute. */
     ariaHaspopup?: AriaHaspopup;
-    /** The value used for aria-relevant (additions, additions text, all, removals, text). */
+    /** Value of the `aria-relevant` attribute. */
     ariaRelevant?: AriaRelevant;
-    /** The value used for role attribute. */
+    /** Value of the `role` attribute. */
     role?: AriaRole;
-    /** The value used for aria-live (polite, assertive). */
+    /** Value of the `aria-live` attribute. */
     ariaLive?: AriaLive;
-    /** The value used for aria-current (page, step, location, date, time, true, false). */
+    /** Value of the `aria-current` attribute. */
     ariaCurrent?: AriaCurrent;
-    /** The value used for aria-invalid (grammar, spelling, false, true). */
+    /** Value of the `aria-invalid` attribute. */
     ariaInvalid?: AriaInvalid;
     /**
-     * Free text string attributes
+     * Value of the `aria-label` attribute.
      * @maxLength 1000
      */
     ariaLabel?: string | null;
     /**
-     * The text used for aria-roledescription.
+     * Value of the `aria-roledescription` attribute.
      * @maxLength 1000
      */
     ariaRoledescription?: string | null;
     /**
-     * The value used for aria-describedby.
+     * Value of the `aria-describedby` attribute.
      * @maxLength 1000
      */
     ariaDescribedby?: string | null;
     /**
-     * The value used for aria-labelledby.
+     * Value of the `aria-labelledby` attribute.
      * @maxLength 1000
      */
     ariaLabelledby?: string | null;
     /**
-     * The text used for aria-errormessage.
+     * Value of the `aria-errormessage` attribute.
      * @maxLength 1000
      */
     ariaErrormessage?: string | null;
     /**
-     * The text used for aria-owns.
+     * Value of the `aria-owns` attribute.
      * @maxLength 1000
      */
     ariaOwns?: string | null;
     /**
-     * The text used for aria-controls.
+     * Value of the `aria-controls` attribute.
      * @maxLength 1000
      */
     ariaControls?: string | null;
     /**
-     * The HTML tag to use for the element.
+     * HTML tag to render the element with. For example, `h1`, `section`.
      * @maxLength 1000
      */
     tag?: string | null;
 }
 export declare enum AriaPressed {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_PRESSED = "UNKNOWN_ARIA_PRESSED",
     /** The element is not pressed. */
     FALSE = "FALSE",
     /** The element is pressed. */
@@ -1044,7 +1136,7 @@ export declare enum AriaPressed {
     MIXED = "MIXED"
 }
 export declare enum AriaHaspopup {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_HASPOPUP = "UNKNOWN_ARIA_HASPOPUP",
     /** The element has a popup. */
     TRUE = "TRUE",
     /** The element does not have a popup. */
@@ -1055,7 +1147,7 @@ export declare enum AriaHaspopup {
     MENU = "MENU"
 }
 export declare enum AriaRelevant {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_RELEVANT = "UNKNOWN_ARIA_RELEVANT",
     /** Element nodes added to the accessibility tree. */
     ADDITIONS = "ADDITIONS",
     /** Both additions and text changes. */
@@ -1068,7 +1160,7 @@ export declare enum AriaRelevant {
     TEXT = "TEXT"
 }
 export declare enum AriaRole {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_ROLE = "UNKNOWN_ARIA_ROLE",
     REGION = "REGION",
     GROUP = "GROUP",
     TABLIST = "TABLIST",
@@ -1088,14 +1180,14 @@ export declare enum AriaRole {
     NAV = "NAV"
 }
 export declare enum AriaLive {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_LIVE = "UNKNOWN_ARIA_LIVE",
     /** Updates are announced when the user is idle. */
     POLITE = "POLITE",
     /** Updates are announced immediately. */
     ASSERTIVE = "ASSERTIVE"
 }
 export declare enum AriaCurrent {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_CURRENT = "UNKNOWN_ARIA_CURRENT",
     /** Represents the current page within a set of pages. */
     PAGE = "PAGE",
     /** Represents the current step within a process. */
@@ -1112,7 +1204,7 @@ export declare enum AriaCurrent {
     FALSE = "FALSE"
 }
 export declare enum AriaInvalid {
-    UNSPECIFIED = "UNSPECIFIED",
+    UNKNOWN_ARIA_INVALID = "UNKNOWN_ARIA_INVALID",
     /** A grammatical error was detected. */
     GRAMMAR = "GRAMMAR",
     /** A spelling error was detected. */