@wix/auto_sdk_rich-content_ricos-documents 1.0.47 → 1.0.49

package/build/cjs/index.typings.d.ts

@@ -50,10 +50,11 @@ declare enum Plugin {
     CARD = "CARD",
     SMART_BLOCK = "SMART_BLOCK",
     TOC = "TOC",
-    SHAPE = "SHAPE"
+    SHAPE = "SHAPE",
+    SLOT = "SLOT"
 }
 /** @enumType */
-type PluginWithLiterals = Plugin | 'UNKNOWN_PLUGIN' | 'ACTION_BUTTON' | 'AUDIO' | 'CODE_BLOCK' | 'COLLAPSIBLE_LIST' | 'DIVIDER' | 'EMOJI' | 'FILE' | 'GALLERY' | 'GIPHY' | 'HASHTAG' | 'HEADING' | 'HTML' | 'IMAGE' | 'INDENT' | 'LAYOUT' | 'LINE_SPACING' | 'LINK' | 'LINK_BUTTON' | 'LINK_PREVIEW' | 'MENTIONS' | 'POLL' | 'SPOILER' | 'TABLE' | 'TEXT_COLOR' | 'TEXT_HIGHLIGHT' | 'VERTICAL_EMBED' | 'VIDEO' | 'FONT_FAMILY' | 'CARD' | 'SMART_BLOCK' | 'TOC' | 'SHAPE';
+type PluginWithLiterals = Plugin | 'UNKNOWN_PLUGIN' | 'ACTION_BUTTON' | 'AUDIO' | 'CODE_BLOCK' | 'COLLAPSIBLE_LIST' | 'DIVIDER' | 'EMOJI' | 'FILE' | 'GALLERY' | 'GIPHY' | 'HASHTAG' | 'HEADING' | 'HTML' | 'IMAGE' | 'INDENT' | 'LAYOUT' | 'LINE_SPACING' | 'LINK' | 'LINK_BUTTON' | 'LINK_PREVIEW' | 'MENTIONS' | 'POLL' | 'SPOILER' | 'TABLE' | 'TEXT_COLOR' | 'TEXT_HIGHLIGHT' | 'VERTICAL_EMBED' | 'VIDEO' | 'FONT_FAMILY' | 'CARD' | 'SMART_BLOCK' | 'TOC' | 'SHAPE' | 'SLOT';
 interface ValidateDocumentResponse {
     /** Whether the document is valid. */
     valid?: boolean;
@@ -161,6 +162,8 @@ interface Node extends NodeDataOneOf {
     checkboxListData?: CheckboxListData;
     /** Data for a list item node. */
     listItemData?: ListItemNodeData;
+    /** Data for a slot node. */
+    slotData?: SlotData;
     /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
     type?: NodeTypeWithLiterals;
     /** Node ID. */
@@ -242,6 +245,8 @@ interface NodeDataOneOf {
     checkboxListData?: CheckboxListData;
     /** Data for a list item node. */
     listItemData?: ListItemNodeData;
+    /** Data for a slot node. */
+    slotData?: SlotData;
 }
 declare enum NodeType {
     PARAGRAPH = "PARAGRAPH",
@@ -283,10 +288,11 @@ declare enum NodeType {
     TOC = "TOC",
     SMART_BLOCK = "SMART_BLOCK",
     SMART_BLOCK_CELL = "SMART_BLOCK_CELL",
-    CHECKBOX_LIST = "CHECKBOX_LIST"
+    CHECKBOX_LIST = "CHECKBOX_LIST",
+    SLOT = "SLOT"
 }
 /** @enumType */
-type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL' | 'SHAPE' | 'CARD' | 'TOC' | 'SMART_BLOCK' | 'SMART_BLOCK_CELL' | 'CHECKBOX_LIST';
+type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL' | 'SHAPE' | 'CARD' | 'TOC' | 'SMART_BLOCK' | 'SMART_BLOCK_CELL' | 'CHECKBOX_LIST' | 'SLOT';
 interface NodeStyle {
     /** The top padding value in pixels. */
     paddingTop?: string | null;
@@ -1610,10 +1616,41 @@ interface AnchorData {
     anchor?: string;
 }
 interface ColorData {
-    /** The text's background color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `backgroundStyle` instead. The text's background color as a hexadecimal value.
+     * @deprecated
+     */
     background?: string | null;
-    /** The text's foreground color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `foregroundStyle` instead. The text's foreground color as a hexadecimal value.
+     * @deprecated
+     */
     foreground?: string | null;
+    /** Text fill styling (color or gradient). When present, takes precedence over `foreground`. */
+    foregroundStyle?: ColorDataBackground;
+    /** Text background (highlight) styling (color or gradient). When present, takes precedence over `background`. */
+    backgroundStyle?: ColorDataBackground;
+}
+/** Background type */
+declare enum ColorDataBackgroundType {
+    /** Solid color */
+    COLOR = "COLOR",
+    /** Gradient */
+    GRADIENT = "GRADIENT"
+}
+/** @enumType */
+type ColorDataBackgroundTypeWithLiterals = ColorDataBackgroundType | 'COLOR' | 'GRADIENT';
+/** Fill styling (color or gradient) */
+interface ColorDataBackground {
+    /** Background type. */
+    type?: ColorDataBackgroundTypeWithLiterals;
+    /**
+     * Color as a hexadecimal value.
+     * @maxLength 19
+     */
+    color?: string | null;
+    /** Gradient configuration. */
+    gradient?: Gradient;
 }
 interface LinkData {
     /** Link details. */
@@ -2787,6 +2824,42 @@ interface ListItemNodeData {
     /** Node animation. */
     animation?: Animation;
 }
+interface SlotData {
+    /** Integration type, for example `wix.forms.form`. Used to render the slot in the editor and viewer. */
+    integrationType?: string | null;
+    /** ID of the resource the slot renders, for example a form ID. Passed as-is to the integration. */
+    resourceId?: string | null;
+    /** Node animation. */
+    animation?: Animation;
+    /** Design overrides for this slot. Unset colours use the Ricos theme; unset sizes default to 0. */
+    design?: SlotDesign;
+}
+interface SlotDesign {
+    /** Text colour: CSS colour or `$theme-color-N[-opacity]` token. */
+    textColor?: string | null;
+    /** Accent colour. */
+    accentColor?: string | null;
+    /** Button background colour. */
+    buttonColor?: string | null;
+    /** Button text colour. */
+    buttonTextColor?: string | null;
+    /** Block background colour. */
+    backgroundColor?: string | null;
+    /** Block border colour. */
+    borderColor?: string | null;
+    /** Block border width, px. */
+    borderWidth?: number | null;
+    /** Block corner radius, px. */
+    borderRadius?: number | null;
+    /** Horizontal inner padding, px. */
+    paddingHorizontal?: number | null;
+    /** Vertical inner padding, px. */
+    paddingVertical?: number | null;
+    /** Vertical gap between rows, px. */
+    rowGap?: number | null;
+    /** Horizontal gap between columns, px. */
+    columnGap?: number | null;
+}
 interface Metadata {
     /** Schema version. */
     version?: number;
@@ -3034,4 +3107,4 @@ interface ConvertFromRicosDocumentOptionsOptionsOneOf {
     plainTextOptions?: PlainTextOptions;
 }
 
-export { Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BorderWidths, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type ConvertFromRicosDocumentOptions, type ConvertFromRicosDocumentOptionsOptionsOneOf, type ConvertFromRicosDocumentRequest, type ConvertFromRicosDocumentRequestOptionsOneOf, type ConvertFromRicosDocumentResponse, type ConvertFromRicosDocumentResponseResultOneOf, type ConvertToRicosDocumentOptions, type ConvertToRicosDocumentOptionsSourceOneOf, type ConvertToRicosDocumentRequest, type ConvertToRicosDocumentRequestSourceOneOf, type ConvertToRicosDocumentResponse, Crop, type CropWithLiterals, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type EmbedData, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type FileData, type FileSource, type FileSourceDataOneOf, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListItemNodeData, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type Metadata, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlainTextOptions, type PlaybackOptions, Plugin, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type PluginWithLiterals, type PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, type PricingData, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RibbonStyles, type RichContent, type RicosDocumentOptions, type RicosDocumentPlaceholder, type RicosDocumentViolation, Scaling, type ScalingWithLiterals, type SectionDivider, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, Target, TargetFormat, type TargetFormatWithLiterals, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type ValidateDocumentOptions, type ValidateDocumentRequest, type ValidateDocumentResponse, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, convertFromRicosDocument, convertToRicosDocument, validateDocument };
+export { Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BorderWidths, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type ColorDataBackground, ColorDataBackgroundType, type ColorDataBackgroundTypeWithLiterals, type Colors, ColumnSize, type ColumnSizeWithLiterals, type ConvertFromRicosDocumentOptions, type ConvertFromRicosDocumentOptionsOptionsOneOf, type ConvertFromRicosDocumentRequest, type ConvertFromRicosDocumentRequestOptionsOneOf, type ConvertFromRicosDocumentResponse, type ConvertFromRicosDocumentResponseResultOneOf, type ConvertToRicosDocumentOptions, type ConvertToRicosDocumentOptionsSourceOneOf, type ConvertToRicosDocumentRequest, type ConvertToRicosDocumentRequestSourceOneOf, type ConvertToRicosDocumentResponse, Crop, type CropWithLiterals, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type EmbedData, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type FileData, type FileSource, type FileSourceDataOneOf, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListItemNodeData, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type Metadata, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlainTextOptions, type PlaybackOptions, Plugin, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type PluginWithLiterals, type PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, type PricingData, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RibbonStyles, type RichContent, type RicosDocumentOptions, type RicosDocumentPlaceholder, type RicosDocumentViolation, Scaling, type ScalingWithLiterals, type SectionDivider, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SlotData, type SlotDesign, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, Target, TargetFormat, type TargetFormatWithLiterals, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type ValidateDocumentOptions, type ValidateDocumentRequest, type ValidateDocumentResponse, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, convertFromRicosDocument, convertToRicosDocument, validateDocument };