@wix/public-editor-platform-interfaces 1.25.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1124 @@
1
+ export interface DataItem extends DataItemDataValueOneOf {
2
+ /** Plain text value. */
3
+ text?: Text;
4
+ /** Rich text value with formatting. */
5
+ richText?: RichText;
6
+ /** Text value from a predefined set of options. */
7
+ textEnum?: TextEnum;
8
+ /** Image reference with optional metadata. */
9
+ image?: Image;
10
+ /** Numeric value (integer or decimal). */
11
+ number?: _Number;
12
+ /** Date without time component. */
13
+ localDate?: LocalDate;
14
+ /** Time without date component. */
15
+ localTime?: LocalTime;
16
+ /** Combined date and time. */
17
+ localDateTime?: LocalDateTime;
18
+ /** Web URL reference. */
19
+ webUrl?: WebUrl;
20
+ /** Email address. */
21
+ email?: Email;
22
+ /** Phone number. */
23
+ phone?: Phone;
24
+ /** Hostname/domain name. */
25
+ hostname?: Hostname;
26
+ /** Regular expression pattern. */
27
+ regex?: Regex;
28
+ /** Globally unique identifier. */
29
+ guid?: Guid;
30
+ /** Boolean true/false value. */
31
+ booleanValue?: BooleanValue;
32
+ /** Accessibility-related data. */
33
+ a11y?: A11y;
34
+ /** Hyperlink reference. */
35
+ link?: Link;
36
+ /** Container reference. */
37
+ container?: Container;
38
+ /** Text direction (LTR/RTL/auto). */
39
+ direction?: Direction;
40
+ /** Menu items collection. */
41
+ menuItems?: MenuItems;
42
+ /** Video reference with metadata. */
43
+ video?: Video;
44
+ /** Audio reference with playback settings. */
45
+ audio?: Audio;
46
+ /** Vector art/SVG reference. */
47
+ vectorArt?: VectorArt;
48
+ /** Nested data structure containing typed values. */
49
+ data?: Data;
50
+ /** Array of data items. */
51
+ arrayItems?: ArrayItems;
52
+ /** The type of this data item, indicating how to interpret the value. */
53
+ dataType?: DataType;
54
+ }
55
+ export interface DataItemDataValueOneOf {
56
+ /** Plain text value. */
57
+ text?: Text;
58
+ /** Rich text value with formatting. */
59
+ richText?: RichText;
60
+ /** Text value from a predefined set of options. */
61
+ textEnum?: TextEnum;
62
+ /** Image reference with optional metadata. */
63
+ image?: Image;
64
+ /** Numeric value (integer or decimal). */
65
+ number?: _Number;
66
+ /** Date without time component. */
67
+ localDate?: LocalDate;
68
+ /** Time without date component. */
69
+ localTime?: LocalTime;
70
+ /** Combined date and time. */
71
+ localDateTime?: LocalDateTime;
72
+ /** Web URL reference. */
73
+ webUrl?: WebUrl;
74
+ /** Email address. */
75
+ email?: Email;
76
+ /** Phone number. */
77
+ phone?: Phone;
78
+ /** Hostname/domain name. */
79
+ hostname?: Hostname;
80
+ /** Regular expression pattern. */
81
+ regex?: Regex;
82
+ /** Globally unique identifier. */
83
+ guid?: Guid;
84
+ /** Boolean true/false value. */
85
+ booleanValue?: BooleanValue;
86
+ /** Accessibility-related data. */
87
+ a11y?: A11y;
88
+ /** Hyperlink reference. */
89
+ link?: Link;
90
+ /** Container reference. */
91
+ container?: Container;
92
+ /** Text direction (LTR/RTL/auto). */
93
+ direction?: Direction;
94
+ /** Menu items collection. */
95
+ menuItems?: MenuItems;
96
+ /** Video reference with metadata. */
97
+ video?: Video;
98
+ /** Audio reference with playback settings. */
99
+ audio?: Audio;
100
+ /** Vector art/SVG reference. */
101
+ vectorArt?: VectorArt;
102
+ /** Nested data structure containing typed values. */
103
+ data?: Data;
104
+ /** Array of data items. */
105
+ arrayItems?: ArrayItems;
106
+ }
107
+ export declare enum DataType {
108
+ /** Unknown or unspecified data type. */
109
+ UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
110
+ /** Plain text string. */
111
+ TEXT = "TEXT",
112
+ /** Text value from a predefined set of options. */
113
+ TEXT_ENUM = "TEXT_ENUM",
114
+ /** Numeric value (integer or decimal). */
115
+ NUMBER = "NUMBER",
116
+ /** Boolean true/false value. */
117
+ BOOLEAN_VALUE = "BOOLEAN_VALUE",
118
+ /** Accessibility-related data. */
119
+ A11Y = "A11Y",
120
+ /** Hyperlink reference. */
121
+ LINK = "LINK",
122
+ /** Image reference with metadata. */
123
+ IMAGE = "IMAGE",
124
+ /** Video reference with metadata. */
125
+ VIDEO = "VIDEO",
126
+ /** Vector art/SVG reference. */
127
+ VECTOR_ART = "VECTOR_ART",
128
+ /** Audio file reference. */
129
+ AUDIO = "AUDIO",
130
+ /** Schema definition (deprecated). */
131
+ SCHEMA = "SCHEMA",
132
+ /** Date without time component (YYYY-MM-DD). */
133
+ LOCAL_DATE = "LOCAL_DATE",
134
+ /** Time without date component (HH:MM:SS). */
135
+ LOCAL_TIME = "LOCAL_TIME",
136
+ /** Combined date and time. */
137
+ LOCAL_DATE_TIME = "LOCAL_DATE_TIME",
138
+ /** Web URL reference. */
139
+ WEB_URL = "WEB_URL",
140
+ /** Email address. */
141
+ EMAIL = "EMAIL",
142
+ /** Phone number. */
143
+ PHONE = "PHONE",
144
+ /** Hostname/domain name. */
145
+ HOSTNAME = "HOSTNAME",
146
+ /** Regular expression pattern. */
147
+ REGEX = "REGEX",
148
+ /** Globally unique identifier. */
149
+ GUID = "GUID",
150
+ /** Rich text with formatting. */
151
+ RICH_TEXT = "RICH_TEXT",
152
+ /** Container for nested components. */
153
+ CONTAINER = "CONTAINER",
154
+ /** Array of items. */
155
+ ARRAY_ITEMS = "ARRAY_ITEMS",
156
+ /** Text direction (LTR/RTL). */
157
+ DIRECTION = "DIRECTION",
158
+ /** Menu items collection. */
159
+ MENU_ITEMS = "MENU_ITEMS",
160
+ /** Nested data structure containing typed values. */
161
+ DATA = "DATA"
162
+ }
163
+ export interface Text {
164
+ /**
165
+ * The text content.
166
+ * @maxLength 50000
167
+ */
168
+ value?: string;
169
+ }
170
+ export interface RichText {
171
+ /**
172
+ * The text content.
173
+ * @maxLength 50000
174
+ */
175
+ text?: string;
176
+ /**
177
+ * Links embedded within the rich text.
178
+ * @maxSize 1000
179
+ */
180
+ linkList?: Link[];
181
+ }
182
+ export interface TextEnum {
183
+ /**
184
+ * The selected enum value as a string identifier.
185
+ * @maxLength 500
186
+ */
187
+ value?: string;
188
+ }
189
+ export interface Image {
190
+ /**
191
+ * URI pointing to the image resource.
192
+ * @maxLength 2000
193
+ */
194
+ uri?: string;
195
+ /**
196
+ * Display name of the image file.
197
+ * @maxLength 256
198
+ */
199
+ name?: string | null;
200
+ /** Original width of the image in pixels. */
201
+ width?: number | null;
202
+ /** Original height of the image in pixels. */
203
+ height?: number | null;
204
+ /**
205
+ * Alternative text for accessibility purposes.
206
+ * @maxLength 1000
207
+ */
208
+ alt?: string | null;
209
+ /** Optional cropping configuration to display a portion of the image. */
210
+ crop?: Crop;
211
+ }
212
+ export interface Crop {
213
+ /** Width of the crop region as a fraction of the original image (0.0 to 1.0). */
214
+ width?: number;
215
+ /** Height of the crop region as a fraction of the original image (0.0 to 1.0). */
216
+ height?: number;
217
+ /** X-coordinate of the crop origin as a fraction of the original image (0.0 to 1.0). */
218
+ x?: number;
219
+ /** Y-coordinate of the crop origin as a fraction of the original image (0.0 to 1.0). */
220
+ y?: number;
221
+ }
222
+ export interface _Number {
223
+ /** The numeric value. */
224
+ value?: number;
225
+ }
226
+ export interface LocalDate {
227
+ /**
228
+ * The date value in YYYY-MM-DD format.
229
+ * @format LOCAL_DATE
230
+ */
231
+ value?: string;
232
+ }
233
+ export interface LocalTime {
234
+ /**
235
+ * The time value in HH:MM:SS format.
236
+ * @format LOCAL_TIME
237
+ */
238
+ value?: string;
239
+ }
240
+ export interface LocalDateTime {
241
+ /**
242
+ * The date-time value in ISO 8601 format.
243
+ * @format LOCAL_DATE_TIME
244
+ */
245
+ value?: string;
246
+ }
247
+ export interface WebUrl {
248
+ /**
249
+ * The web URL.
250
+ * @format WEB_URL
251
+ */
252
+ value?: string;
253
+ }
254
+ export interface Email {
255
+ /**
256
+ * The email address.
257
+ * @format EMAIL
258
+ */
259
+ value?: string;
260
+ }
261
+ export interface Phone {
262
+ /**
263
+ * The phone number.
264
+ * @format PHONE
265
+ */
266
+ value?: string;
267
+ }
268
+ export interface Hostname {
269
+ /**
270
+ * The hostname.
271
+ * @format HOSTNAME
272
+ */
273
+ value?: string;
274
+ }
275
+ export interface Regex {
276
+ /**
277
+ * The regular expression pattern.
278
+ * @maxLength 5000
279
+ */
280
+ value?: string;
281
+ }
282
+ export interface Guid {
283
+ /**
284
+ * The GUID value.
285
+ * @format GUID
286
+ */
287
+ value?: string;
288
+ }
289
+ export interface BooleanValue {
290
+ /** The boolean value. */
291
+ value?: boolean;
292
+ }
293
+ export interface Container {
294
+ /**
295
+ * The container value.
296
+ * @maxLength 1000
297
+ */
298
+ value?: string;
299
+ }
300
+ export interface Direction {
301
+ /** The direction value. */
302
+ value?: DirectionValue;
303
+ }
304
+ export declare enum DirectionValue {
305
+ /** Unspecified direction. */
306
+ UNKNOWN_DIRECTION = "UNKNOWN_DIRECTION",
307
+ /** Left-to-right. */
308
+ LTR = "LTR",
309
+ /** Right-to-left. */
310
+ RTL = "RTL",
311
+ /** Automatic detection. */
312
+ AUTO = "AUTO"
313
+ }
314
+ export interface Data {
315
+ /** Nested data items keyed by property name. */
316
+ properties?: Record<string, DataItem>;
317
+ }
318
+ export interface ArrayItems {
319
+ /**
320
+ * List of data items.
321
+ * @maxSize 1000
322
+ */
323
+ items?: Data[];
324
+ }
325
+ export interface MenuItems {
326
+ /**
327
+ * Name of the menu.
328
+ * @maxLength 500
329
+ */
330
+ name?: string | null;
331
+ /**
332
+ * App definition ID.
333
+ * @maxLength 100
334
+ */
335
+ appDefinitionId?: string | null;
336
+ /**
337
+ * List of menu items.
338
+ * @maxSize 100
339
+ */
340
+ items?: MenuItem[];
341
+ }
342
+ export interface MenuItem {
343
+ /** Link associated with this menu item. */
344
+ link?: Link;
345
+ /**
346
+ * Nested menu items (sub-menu).
347
+ * @maxSize 100
348
+ */
349
+ items?: MenuItem[];
350
+ /**
351
+ * Container reference.
352
+ * @maxLength 500
353
+ */
354
+ container?: string | null;
355
+ /**
356
+ * Display label for the menu item.
357
+ * @maxLength 1000
358
+ */
359
+ label?: string | null;
360
+ /** Whether the menu item is visible. */
361
+ visible?: boolean | null;
362
+ }
363
+ export interface Video {
364
+ /**
365
+ * Unique identifier for the video media.
366
+ * @maxLength 1000
367
+ */
368
+ uri?: string;
369
+ /**
370
+ * Available video sources in different qualities.
371
+ * @maxSize 20
372
+ */
373
+ sources?: VideoSource[];
374
+ /**
375
+ * Sources for adaptive streaming formats.
376
+ * @maxSize 10
377
+ */
378
+ adaptiveSources?: AdaptiveSource[];
379
+ /** Whether the video contains an audio track. */
380
+ hasAudio?: boolean | null;
381
+ /** Frames per second of the video. */
382
+ fps?: number | null;
383
+ /**
384
+ * Poster image reference for the video.
385
+ * @maxLength 2000
386
+ */
387
+ poster?: string | null;
388
+ /** Duration of the video in seconds. */
389
+ duration?: number | null;
390
+ /**
391
+ * Human-readable name for the video.
392
+ * @maxLength 100
393
+ */
394
+ name?: string | null;
395
+ }
396
+ export interface VideoSource {
397
+ /** Quality level of the video source. */
398
+ quality?: VideoQuality;
399
+ /** Width of the video in pixels. */
400
+ width?: number | null;
401
+ /** Height of the video in pixels. */
402
+ height?: number | null;
403
+ /**
404
+ * Available format types and their URIs for this quality.
405
+ * @maxSize 10
406
+ */
407
+ types?: VideoSourceType[];
408
+ }
409
+ export interface VideoSourceType {
410
+ /** Video format type. */
411
+ format?: VideoFormat;
412
+ /**
413
+ * URI to access the video file.
414
+ * @maxLength 2000
415
+ */
416
+ uri?: string | null;
417
+ }
418
+ export declare enum VideoQuality {
419
+ /** Unspecified quality. */
420
+ UNKNOWN_VIDEO_QUALITY = "UNKNOWN_VIDEO_QUALITY",
421
+ /** 1080p HD quality. */
422
+ VIDEO_QUALITY_1080P = "VIDEO_QUALITY_1080P",
423
+ /** 720p HD quality. */
424
+ VIDEO_QUALITY_720P = "VIDEO_QUALITY_720P",
425
+ /** 480p SD quality. */
426
+ VIDEO_QUALITY_480P = "VIDEO_QUALITY_480P",
427
+ /** 360p quality. */
428
+ VIDEO_QUALITY_360P = "VIDEO_QUALITY_360P"
429
+ }
430
+ export declare enum VideoFormat {
431
+ /** Unspecified format. */
432
+ UNKNOWN_VIDEO_FORMAT = "UNKNOWN_VIDEO_FORMAT",
433
+ /** Standard MP4 format. */
434
+ MP4 = "MP4",
435
+ /** MP4 with luminance encoding. */
436
+ MP4_LUMINANCE = "MP4_LUMINANCE"
437
+ }
438
+ export interface AdaptiveSource {
439
+ /** Adaptive streaming format. */
440
+ format?: AdaptiveFormat;
441
+ /**
442
+ * URI to access the stream manifest.
443
+ * @maxLength 2000
444
+ */
445
+ uri?: string | null;
446
+ }
447
+ export declare enum AdaptiveFormat {
448
+ /** Unspecified adaptive format. */
449
+ UNKNOWN_ADAPTIVE_FORMAT = "UNKNOWN_ADAPTIVE_FORMAT",
450
+ /** HTTP Live Streaming format. */
451
+ HLS = "HLS",
452
+ /** Dynamic Adaptive Streaming over HTTP. */
453
+ DASH = "DASH"
454
+ }
455
+ export interface Audio {
456
+ /**
457
+ * URI pointing to the audio resource.
458
+ * @maxLength 2000
459
+ */
460
+ uri?: string;
461
+ /** Whether the audio should play automatically. */
462
+ autoPlay?: boolean | null;
463
+ /** Whether the audio should loop when finished. */
464
+ loop?: boolean | null;
465
+ /** Whether the audio player is visible. */
466
+ visible?: boolean | null;
467
+ /** Volume level (0-100). */
468
+ volume?: number | null;
469
+ /**
470
+ * Title of the audio track.
471
+ * @maxLength 1000
472
+ */
473
+ title?: string | null;
474
+ /**
475
+ * Description of the audio.
476
+ * @maxLength 2000
477
+ */
478
+ description?: string | null;
479
+ /**
480
+ * Original file name of the audio file.
481
+ * @maxLength 2000
482
+ */
483
+ originalFileName?: string | null;
484
+ }
485
+ export interface VectorArt {
486
+ /**
487
+ * URI pointing to the vector art resource.
488
+ * @maxLength 2000
489
+ */
490
+ uri?: string | null;
491
+ }
492
+ export interface ComponentData {
493
+ /** Component-specific data properties keyed by property name. */
494
+ properties?: Record<string, DataItem>;
495
+ /**
496
+ * Conditional data overrides that apply when specific conditions are met.
497
+ * @maxSize 100
498
+ */
499
+ overrides?: ComponentDataOverride[];
500
+ }
501
+ export interface ComponentDataOverride extends ComponentDataOverrideComponentOverrideOneOf {
502
+ /** Override for a component inside a repeater. */
503
+ repeater?: RepeaterOverride;
504
+ }
505
+ export interface ComponentDataOverrideComponentOverrideOneOf {
506
+ /** Override for a component inside a repeater. */
507
+ repeater?: RepeaterOverride;
508
+ }
509
+ export interface RepeaterOverride {
510
+ /**
511
+ * ID of the variant to use for this repeater override.
512
+ * @maxLength 100
513
+ */
514
+ id?: string;
515
+ /** Component data properties that are applied for this repeated component instance. */
516
+ properties?: Record<string, DataItem>;
517
+ }
518
+ export interface ComponentStyle extends ComponentStyleStylePropertiesOneOf {
519
+ /** CSS-based styling for new Editor React components. */
520
+ css?: CssStyleProperties;
521
+ /** Legacy styling for components in studio or classic sites. */
522
+ legacy?: LegacyStyleProperties;
523
+ /** Reference to a theme style (TopLevelStyle). */
524
+ theme?: ThemeStyleReference;
525
+ /**
526
+ * Conditional style overrides (not applicable for theme references).
527
+ * @maxSize 100
528
+ */
529
+ overrides?: ComponentStyleOverride[];
530
+ }
531
+ export interface ComponentStyleStylePropertiesOneOf {
532
+ /** CSS-based styling for new Editor React components. */
533
+ css?: CssStyleProperties;
534
+ /** Legacy styling for components in studio or classic sites. */
535
+ legacy?: LegacyStyleProperties;
536
+ /** Reference to a theme style (TopLevelStyle). */
537
+ theme?: ThemeStyleReference;
538
+ }
539
+ export interface CssStyleProperties {
540
+ /** Standard CSS properties (e.g., backgroundColor, borderWidth). */
541
+ cssProperties?: Record<string, string>;
542
+ /** CSS custom properties/variables (e.g., content-horizontal-alignment). */
543
+ cssCustomProperties?: Record<string, string>;
544
+ }
545
+ export interface LegacyStyleProperties {
546
+ /** Style properties (e.g., bg, align, $st-css). */
547
+ properties?: Record<string, string>;
548
+ /** Source of each property (theme or value). */
549
+ propertiesSource?: Record<string, PropertySource>;
550
+ /** Style groups (arbitrary structure). */
551
+ groups?: Record<string, any> | null;
552
+ /** Text theme overrides per property (e.g., fnt). */
553
+ propertiesOverride?: Record<string, PartialTextTheme>;
554
+ }
555
+ export declare enum PropertySource {
556
+ /** Unknown property source. */
557
+ UNKNOWN_PROPERTY_SOURCE = "UNKNOWN_PROPERTY_SOURCE",
558
+ /** Property value comes from theme. */
559
+ THEME = "THEME",
560
+ /** Property has explicit value. */
561
+ VALUE = "VALUE"
562
+ }
563
+ export interface PartialTextTheme {
564
+ /**
565
+ * Font style (normal, italic).
566
+ * @maxLength 100
567
+ */
568
+ fontStyle?: string | null;
569
+ /**
570
+ * Font weight (normal, bold, 100-900).
571
+ * @maxLength 100
572
+ */
573
+ fontWeight?: string | null;
574
+ /**
575
+ * Font variant (normal, small-caps, inherit).
576
+ * @maxLength 100
577
+ */
578
+ fontVariant?: string | null;
579
+ /**
580
+ * Font size with unit (e.g., "14px", "1em").
581
+ * @maxLength 100
582
+ */
583
+ fontSize?: string | null;
584
+ /**
585
+ * Maximum font size.
586
+ * @maxLength 100
587
+ */
588
+ maxFontSize?: string | null;
589
+ /**
590
+ * Minimum font size.
591
+ * @maxLength 100
592
+ */
593
+ minFontSize?: string | null;
594
+ /**
595
+ * Scaled maximum font size.
596
+ * @maxLength 100
597
+ */
598
+ scaleMaxFontSize?: string | null;
599
+ /**
600
+ * Scaled minimum font size.
601
+ * @maxLength 100
602
+ */
603
+ scaleMinFontSize?: string | null;
604
+ /**
605
+ * Font family.
606
+ * @maxLength 500
607
+ */
608
+ fontFamily?: string | null;
609
+ /**
610
+ * Text color.
611
+ * @maxLength 100
612
+ */
613
+ color?: string | null;
614
+ /**
615
+ * Line height with unit.
616
+ * @maxLength 100
617
+ */
618
+ lineHeight?: string | null;
619
+ /**
620
+ * Letter spacing with unit.
621
+ * @maxLength 100
622
+ */
623
+ letterSpacing?: string | null;
624
+ }
625
+ export interface ThemeStyleReference {
626
+ /**
627
+ * The theme style ID (e.g., "txtTheme").
628
+ * @maxLength 100
629
+ */
630
+ referenceId?: string;
631
+ }
632
+ export interface ComponentStyleOverride extends ComponentStyleOverrideStylePropertiesOneOf {
633
+ /** CSS-based override. */
634
+ css?: CssStyleProperties;
635
+ /**
636
+ * Legacy style override.
637
+ * @deprecated
638
+ * @targetRemovalDate 2040-01-01
639
+ */
640
+ legacy?: LegacyStyleProperties;
641
+ /**
642
+ * Conditions (variant IDs) that must ALL be met.
643
+ * @maxSize 100
644
+ */
645
+ conditions?: ConditionalTrigger[];
646
+ }
647
+ export interface ComponentStyleOverrideStylePropertiesOneOf {
648
+ /** CSS-based override. */
649
+ css?: CssStyleProperties;
650
+ /**
651
+ * Legacy style override.
652
+ * @deprecated
653
+ * @targetRemovalDate 2040-01-01
654
+ */
655
+ legacy?: LegacyStyleProperties;
656
+ }
657
+ /**
658
+ * Condition that determines when a style override should be applied.
659
+ *
660
+ * Supports various UI and interaction-based conditions such as display width breakpoints,
661
+ * hover states, and user interactions. All conditions in an override are evaluated
662
+ * with AND logic, and apply the override only when all conditions are met.
663
+ */
664
+ export interface ConditionalTrigger {
665
+ /**
666
+ * Unique identifier for the condition.
667
+ * @maxLength 100
668
+ */
669
+ conditionId?: string;
670
+ }
671
+ export interface Link extends LinkLinkTypeOneOf {
672
+ pageLink?: PageLink;
673
+ externalLink?: ExternalLink;
674
+ emailLink?: EmailLink;
675
+ anchorLink?: AnchorLink;
676
+ documentLink?: DocumentLink;
677
+ phoneLink?: PhoneLink;
678
+ dynamicPageLink?: DynamicPageLink;
679
+ textLink?: TextLink;
680
+ loginToWixLink?: LoginToWixLink;
681
+ whatsAppLink?: WhatsAppLink;
682
+ addressLink?: AddressLink;
683
+ tpaPageLink?: TpaPageLink;
684
+ }
685
+ export interface LinkLinkTypeOneOf {
686
+ pageLink?: PageLink;
687
+ externalLink?: ExternalLink;
688
+ emailLink?: EmailLink;
689
+ anchorLink?: AnchorLink;
690
+ documentLink?: DocumentLink;
691
+ phoneLink?: PhoneLink;
692
+ dynamicPageLink?: DynamicPageLink;
693
+ textLink?: TextLink;
694
+ loginToWixLink?: LoginToWixLink;
695
+ whatsAppLink?: WhatsAppLink;
696
+ addressLink?: AddressLink;
697
+ tpaPageLink?: TpaPageLink;
698
+ }
699
+ export interface PageLink {
700
+ /**
701
+ * ID of the target page within the same document.
702
+ * @maxLength 100
703
+ */
704
+ pageId?: string | null;
705
+ /** Specifies where to open the linked document. */
706
+ target?: LinkTarget;
707
+ /** Relationship attributes for the link. */
708
+ rel?: LinkRel;
709
+ }
710
+ export interface ExternalLink {
711
+ /**
712
+ * URL of the external link.
713
+ * @maxLength 2000
714
+ */
715
+ url?: string;
716
+ /** Specifies where to open the linked document. */
717
+ target?: LinkTarget;
718
+ /** Relationship attributes for the link. */
719
+ rel?: LinkRel;
720
+ }
721
+ export interface EmailLink {
722
+ /**
723
+ * Email address of the recipient.
724
+ * @maxLength 320
725
+ */
726
+ recipient?: string;
727
+ /**
728
+ * Subject of the email.
729
+ * @maxLength 500
730
+ */
731
+ subject?: string;
732
+ /**
733
+ * Body or content of the email.
734
+ * @maxLength 5000
735
+ */
736
+ body?: string;
737
+ }
738
+ export interface AnchorLink {
739
+ /**
740
+ * Name of the anchor.
741
+ * @maxLength 200
742
+ */
743
+ anchorName?: string;
744
+ /**
745
+ * ID of the anchor data or "SCROLL_TO_TOP".
746
+ * @maxLength 100
747
+ */
748
+ anchorDataId?: string | null;
749
+ /**
750
+ * ID of the target page.
751
+ * @maxLength 100
752
+ */
753
+ pageId?: string | null;
754
+ /** Relationship attributes for the link. */
755
+ rel?: LinkRel;
756
+ }
757
+ export interface DocumentLink {
758
+ /**
759
+ * ID of the document.
760
+ * @maxLength 100
761
+ */
762
+ docId?: string;
763
+ /**
764
+ * Name of the document.
765
+ * @maxLength 500
766
+ */
767
+ name?: string;
768
+ /** Whether the document is indexable. */
769
+ indexable?: boolean;
770
+ }
771
+ export interface PhoneLink {
772
+ /**
773
+ * Phone number to call.
774
+ * @maxLength 100
775
+ */
776
+ phoneNumber?: string;
777
+ }
778
+ export interface DynamicPageLink {
779
+ /**
780
+ * ID of the router.
781
+ * @maxLength 100
782
+ */
783
+ routerId?: string;
784
+ /**
785
+ * Inner route path.
786
+ * @maxLength 500
787
+ */
788
+ innerRoute?: string;
789
+ /**
790
+ * ID of the anchor data.
791
+ * @maxLength 100
792
+ */
793
+ anchorDataId?: string | null;
794
+ /** Whether this is a TPA route. */
795
+ tpaRoute?: boolean;
796
+ /** Specifies where to open the linked document. */
797
+ target?: LinkTarget;
798
+ /** Relationship attributes for the link. */
799
+ rel?: LinkRel;
800
+ }
801
+ export interface TextLink {
802
+ /** Type of the text link. */
803
+ linkType?: LinkType;
804
+ /**
805
+ * URL or destination of the link.
806
+ * @maxLength 2000
807
+ */
808
+ href?: string;
809
+ /**
810
+ * Display text for the link.
811
+ * @maxLength 1200
812
+ */
813
+ text?: string;
814
+ /**
815
+ * Target attribute for the link.
816
+ * @maxLength 50
817
+ */
818
+ target?: string;
819
+ /**
820
+ * Icon identifier for the link.
821
+ * @maxLength 200
822
+ */
823
+ icon?: string;
824
+ }
825
+ export interface LoginToWixLink {
826
+ /**
827
+ * URL to redirect after login.
828
+ * @maxLength 2000
829
+ */
830
+ postLoginUrl?: string;
831
+ /**
832
+ * URL to redirect after signup.
833
+ * @maxLength 2000
834
+ */
835
+ postSignupUrl?: string;
836
+ /** Type of login dialog to show. */
837
+ dialog?: LoginDialog;
838
+ /** Whether to send email notification. */
839
+ sendMail?: boolean;
840
+ /**
841
+ * Mail template identifier.
842
+ * @maxLength 500
843
+ */
844
+ mailTemplate?: string;
845
+ /**
846
+ * User color preference.
847
+ * @maxLength 50
848
+ */
849
+ userColor?: string;
850
+ /**
851
+ * Login component name.
852
+ * @maxLength 200
853
+ */
854
+ loginCompName?: string;
855
+ }
856
+ export interface WhatsAppLink {
857
+ /**
858
+ * WhatsApp phone number.
859
+ * @maxLength 100
860
+ */
861
+ phoneNumber?: string;
862
+ }
863
+ export interface AddressLink {
864
+ /**
865
+ * Address to link to.
866
+ * @maxLength 200
867
+ */
868
+ address?: string;
869
+ }
870
+ export interface TpaPageLink {
871
+ /**
872
+ * Type identifier of the item.
873
+ * @maxLength 200
874
+ */
875
+ itemTypeIdentifier?: string;
876
+ /**
877
+ * ID of the item.
878
+ * @maxLength 100
879
+ */
880
+ itemId?: string;
881
+ /**
882
+ * ID of the target page.
883
+ * @maxLength 100
884
+ */
885
+ pageId?: string | null;
886
+ /**
887
+ * App definition ID.
888
+ * @maxLength 100
889
+ */
890
+ appDefinitionId?: string;
891
+ /**
892
+ * Path within the TPA page.
893
+ * @maxLength 500
894
+ */
895
+ path?: string;
896
+ /** Specifies where to open the linked document. */
897
+ target?: LinkTarget;
898
+ /** Relationship attributes for the link. */
899
+ rel?: LinkRel;
900
+ }
901
+ export declare enum LinkTarget {
902
+ UNSPECIFIED = "UNSPECIFIED",
903
+ /** Opens the linked document in the same frame as it was clicked (default). */
904
+ SELF = "SELF",
905
+ /** Opens the linked document in a new window or tab. */
906
+ BLANK = "BLANK"
907
+ }
908
+ export interface LinkRel {
909
+ /**
910
+ * List of relationship attributes for the link.
911
+ * @maxSize 100
912
+ */
913
+ items?: LinkRelEnumLinkRel[];
914
+ }
915
+ export declare enum LinkRelEnumLinkRel {
916
+ UNSPECIFIED = "UNSPECIFIED",
917
+ /** Instructs search engines not to follow the link. */
918
+ NOFOLLOW = "NOFOLLOW",
919
+ /** Prevents the new page from being able to access the window.opener property. */
920
+ NOOPENER = "NOOPENER",
921
+ /** Prevents the browser from sending the current page's address as referrer information when following the link. */
922
+ NOREFERRER = "NOREFERRER",
923
+ /** Indicates that the link is a paid link or an advertisement. */
924
+ SPONSORED = "SPONSORED"
925
+ }
926
+ export declare enum LinkType {
927
+ UNSPECIFIED = "UNSPECIFIED",
928
+ SMS = "SMS",
929
+ CALL = "CALL",
930
+ SKYPE = "SKYPE",
931
+ MAP = "MAP",
932
+ EMAIL = "EMAIL",
933
+ FACEBOOK = "FACEBOOK",
934
+ FLICKR = "FLICKR",
935
+ BLOGGER = "BLOGGER",
936
+ MYSPACE = "MYSPACE",
937
+ LINKEDIN = "LINKEDIN",
938
+ TWITTER = "TWITTER",
939
+ TUMBLR = "TUMBLR",
940
+ YOUTUBE = "YOUTUBE",
941
+ VIMEO = "VIMEO",
942
+ PAGE = "PAGE",
943
+ /** Default value. */
944
+ FREE_LINK = "FREE_LINK",
945
+ TEXT = "TEXT",
946
+ DELICIOUS = "DELICIOUS",
947
+ WEBSITE = "WEBSITE",
948
+ DOCUMENT = "DOCUMENT",
949
+ ADMIN_LOGIN = "ADMIN_LOGIN",
950
+ LOGIN = "LOGIN"
951
+ }
952
+ export declare enum LoginDialog {
953
+ UNSPECIFIED = "UNSPECIFIED",
954
+ /** Show create user dialog. */
955
+ CREATE_USER = "CREATE_USER",
956
+ /** Show login dialog (default). */
957
+ LOGIN = "LOGIN",
958
+ /** Show login dialog. */
959
+ SHOW_LOGIN = "SHOW_LOGIN"
960
+ }
961
+ export interface A11y {
962
+ /** Number attributes */
963
+ tabIndex?: number | null;
964
+ /** The value used for aria-level (1 to 6). */
965
+ ariaLevel?: number | null;
966
+ /** Boolean attributes */
967
+ ariaExpanded?: boolean | null;
968
+ /** The value used for aria-disabled. */
969
+ ariaDisabled?: boolean | null;
970
+ /** The value used for aria-atomic. */
971
+ ariaAtomic?: boolean | null;
972
+ /** The value used for aria-hidden. */
973
+ ariaHidden?: boolean | null;
974
+ /** The value used for aria-busy. */
975
+ ariaBusy?: boolean | null;
976
+ /** Indicates if should add Multiline instructions to aria-label. */
977
+ multiline?: boolean | null;
978
+ /** Indicates if should add Autocomplete instructions to aria-label. */
979
+ ariaAutocomplete?: boolean | null;
980
+ /** The value used for aria-multiline. */
981
+ ariaMultiline?: boolean | null;
982
+ /** Enum attributes */
983
+ ariaPressed?: AriaPressed;
984
+ /** The value used for aria-haspopup (true, false, dialog, menu). */
985
+ ariaHaspopup?: AriaHaspopup;
986
+ /** The value used for aria-relevant (additions, additions text, all, removals, text). */
987
+ ariaRelevant?: AriaRelevant;
988
+ /** The value used for role attribute. */
989
+ role?: AriaRole;
990
+ /** The value used for aria-live (polite, assertive). */
991
+ ariaLive?: AriaLive;
992
+ /** The value used for aria-current (page, step, location, date, time, true, false). */
993
+ ariaCurrent?: AriaCurrent;
994
+ /** The value used for aria-invalid (grammar, spelling, false, true). */
995
+ ariaInvalid?: AriaInvalid;
996
+ /**
997
+ * Free text string attributes
998
+ * @maxLength 1000
999
+ */
1000
+ ariaLabel?: string | null;
1001
+ /**
1002
+ * The text used for aria-roledescription.
1003
+ * @maxLength 1000
1004
+ */
1005
+ ariaRoledescription?: string | null;
1006
+ /**
1007
+ * The value used for aria-describedby.
1008
+ * @maxLength 1000
1009
+ */
1010
+ ariaDescribedby?: string | null;
1011
+ /**
1012
+ * The value used for aria-labelledby.
1013
+ * @maxLength 1000
1014
+ */
1015
+ ariaLabelledby?: string | null;
1016
+ /**
1017
+ * The text used for aria-errormessage.
1018
+ * @maxLength 1000
1019
+ */
1020
+ ariaErrormessage?: string | null;
1021
+ /**
1022
+ * The text used for aria-owns.
1023
+ * @maxLength 1000
1024
+ */
1025
+ ariaOwns?: string | null;
1026
+ /**
1027
+ * The text used for aria-controls.
1028
+ * @maxLength 1000
1029
+ */
1030
+ ariaControls?: string | null;
1031
+ /**
1032
+ * The HTML tag to use for the element.
1033
+ * @maxLength 1000
1034
+ */
1035
+ tag?: string | null;
1036
+ }
1037
+ export declare enum AriaPressed {
1038
+ UNSPECIFIED = "UNSPECIFIED",
1039
+ /** The element is not pressed. */
1040
+ FALSE = "FALSE",
1041
+ /** The element is pressed. */
1042
+ TRUE = "TRUE",
1043
+ /** The element is partially pressed. */
1044
+ MIXED = "MIXED"
1045
+ }
1046
+ export declare enum AriaHaspopup {
1047
+ UNSPECIFIED = "UNSPECIFIED",
1048
+ /** The element has a popup. */
1049
+ TRUE = "TRUE",
1050
+ /** The element does not have a popup. */
1051
+ FALSE = "FALSE",
1052
+ /** The popup is a dialog. */
1053
+ DIALOG = "DIALOG",
1054
+ /** The popup is a menu. */
1055
+ MENU = "MENU"
1056
+ }
1057
+ export declare enum AriaRelevant {
1058
+ UNSPECIFIED = "UNSPECIFIED",
1059
+ /** Element nodes added to the accessibility tree. */
1060
+ ADDITIONS = "ADDITIONS",
1061
+ /** Both additions and text changes. */
1062
+ ADDITIONS_TEXT = "ADDITIONS_TEXT",
1063
+ /** All changes. */
1064
+ ALL = "ALL",
1065
+ /** Element nodes removed from the accessibility tree. */
1066
+ REMOVALS = "REMOVALS",
1067
+ /** Text changes. */
1068
+ TEXT = "TEXT"
1069
+ }
1070
+ export declare enum AriaRole {
1071
+ UNSPECIFIED = "UNSPECIFIED",
1072
+ REGION = "REGION",
1073
+ GROUP = "GROUP",
1074
+ TABLIST = "TABLIST",
1075
+ TAB = "TAB",
1076
+ TABPANEL = "TABPANEL",
1077
+ ALERT = "ALERT",
1078
+ STATUS = "STATUS",
1079
+ LIST = "LIST",
1080
+ LISTITEM = "LISTITEM",
1081
+ MENUBAR = "MENUBAR",
1082
+ PRESENTATION = "PRESENTATION",
1083
+ BUTTON = "BUTTON",
1084
+ LINK = "LINK",
1085
+ NONE = "NONE",
1086
+ RADIOGROUP = "RADIOGROUP",
1087
+ HEADING = "HEADING",
1088
+ NAV = "NAV"
1089
+ }
1090
+ export declare enum AriaLive {
1091
+ UNSPECIFIED = "UNSPECIFIED",
1092
+ /** Updates are announced when the user is idle. */
1093
+ POLITE = "POLITE",
1094
+ /** Updates are announced immediately. */
1095
+ ASSERTIVE = "ASSERTIVE"
1096
+ }
1097
+ export declare enum AriaCurrent {
1098
+ UNSPECIFIED = "UNSPECIFIED",
1099
+ /** Represents the current page within a set of pages. */
1100
+ PAGE = "PAGE",
1101
+ /** Represents the current step within a process. */
1102
+ STEP = "STEP",
1103
+ /** Represents the current location within an environment. */
1104
+ LOCATION = "LOCATION",
1105
+ /** Represents the current date within a collection of dates. */
1106
+ DATE = "DATE",
1107
+ /** Represents the current time within a set of times. */
1108
+ TIME = "TIME",
1109
+ /** Represents the current item within a set. */
1110
+ TRUE = "TRUE",
1111
+ /** Does not represent the current item within a set. */
1112
+ FALSE = "FALSE"
1113
+ }
1114
+ export declare enum AriaInvalid {
1115
+ UNSPECIFIED = "UNSPECIFIED",
1116
+ /** A grammatical error was detected. */
1117
+ GRAMMAR = "GRAMMAR",
1118
+ /** A spelling error was detected. */
1119
+ SPELLING = "SPELLING",
1120
+ /** There are no detected errors in the value. */
1121
+ FALSE = "FALSE",
1122
+ /** The value entered by the user has failed validation. */
1123
+ TRUE = "TRUE"
1124
+ }