@wix/auto_sdk_rich-content_ricos-documents 1.0.21 → 1.0.23

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

@@ -143,6 +143,8 @@ interface Node extends NodeDataOneOf {
     layoutData?: LayoutData;
     /** Data for a cell node. */
     layoutCellData?: LayoutCellData;
+    /** Data for a shape node. */
+    shapeData?: ShapeData;
     /** 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. */
@@ -210,6 +212,8 @@ interface NodeDataOneOf {
     layoutData?: LayoutData;
     /** Data for a cell node. */
     layoutCellData?: LayoutCellData;
+    /** Data for a shape node. */
+    shapeData?: ShapeData;
 }
 declare enum NodeType {
     PARAGRAPH = "PARAGRAPH",
@@ -245,10 +249,11 @@ declare enum NodeType {
     AUDIO = "AUDIO",
     CAPTION = "CAPTION",
     LAYOUT = "LAYOUT",
-    LAYOUT_CELL = "LAYOUT_CELL"
+    LAYOUT_CELL = "LAYOUT_CELL",
+    SHAPE = "SHAPE"
 }
 /** @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';
+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';
 interface NodeStyle {
     /** The top padding value in pixels. */
     paddingTop?: string | null;
@@ -1842,6 +1847,8 @@ interface LayoutData {
     containerData?: PluginContainerData;
     /** Defines where selected design propertied applies to */
     designTarget?: DesignTargetWithLiterals;
+    /** Banner configuration. When present, this layout is displayed as a banner. */
+    banner?: Banner;
 }
 declare enum Scaling {
     /** Auto image scaling */
@@ -1875,6 +1882,14 @@ declare enum ImagePosition {
 }
 /** @enumType */
 type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
+declare enum Origin {
+    /** Banner originated from an image */
+    IMAGE = "IMAGE",
+    /** Banner originated from a layout */
+    LAYOUT = "LAYOUT"
+}
+/** @enumType */
+type OriginWithLiterals = Origin | 'IMAGE' | 'LAYOUT';
 interface BackgroundImage {
     /** Background image. */
     media?: Media;
@@ -1911,10 +1926,31 @@ declare enum DesignTarget {
 }
 /** @enumType */
 type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
+interface Banner {
+    /** Origin of the banner */
+    origin?: OriginWithLiterals;
+}
 interface LayoutCellData {
     /** Size of the cell in 12 columns grid. */
     colSpan?: number | null;
 }
+interface ShapeData {
+    /** Styling for the shape's container. */
+    containerData?: PluginContainerData;
+    /** Shape file details. */
+    shape?: Media;
+    /** Styling for the shape. */
+    styles?: ShapeDataStyles;
+}
+interface ShapeDataStyles {
+    /**
+     * Shape fill color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    color?: string | null;
+    /** Map of original color keys to their new color values. */
+    colors?: Record<string, string>;
+}
 interface Metadata {
     /** Schema version. */
     version?: number;
@@ -2163,4 +2199,4 @@ interface ConvertFromRicosDocumentOptionsOptionsOneOf {
     plainTextOptions?: PlainTextOptions;
 }
 
-export { Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BorderWidths, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, 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 DocumentStyle, type EmbedData, 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, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, 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, 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 Poll, type PollData, type PollDataLayout, type PollDesign, 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 Settings, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, 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, type TypeWithLiterals, type ValidateDocumentOptions, type ValidateDocumentRequest, type ValidateDocumentResponse, 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 AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, type BlockquoteData, type BookingData, type Border, type BorderColors, type BorderWidths, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, 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 DocumentStyle, type EmbedData, 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, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, 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 Poll, type PollData, type PollDataLayout, type PollDesign, 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 Settings, type ShapeData, type ShapeDataStyles, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, 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, type TypeWithLiterals, type ValidateDocumentOptions, type ValidateDocumentRequest, type ValidateDocumentResponse, 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 };

package/build/internal/cjs/index.typings.js

@@ -41,6 +41,7 @@ __export(index_typings_exports, {
   NodeType: () => NodeType,
   NullValue: () => NullValue,
   Orientation: () => Orientation,
+  Origin: () => Origin,
   Placement: () => Placement,
   Plugin: () => Plugin,
   PluginContainerDataAlignment: () => PluginContainerDataAlignment,
@@ -179,7 +180,8 @@ function validateDocument(payload) {
             },
             {
               path: "validDocument.nodes.layoutData.backdropImage.media.duration"
-            }
+            },
+            { path: "validDocument.nodes.shapeData.shape.duration" }
           ]
         },
         {
@@ -239,7 +241,8 @@ function convertToRicosDocument(payload) {
             },
             {
               path: "document.nodes.layoutData.backdropImage.media.duration"
-            }
+            },
+            { path: "document.nodes.shapeData.shape.duration" }
           ]
         },
         {
@@ -279,7 +282,8 @@ function convertFromRicosDocument(payload) {
           { path: "document.nodes.audioData.audio.duration" },
           { path: "document.nodes.audioData.coverImage.duration" },
           { path: "document.nodes.layoutData.backgroundImage.media.duration" },
-          { path: "document.nodes.layoutData.backdropImage.media.duration" }
+          { path: "document.nodes.layoutData.backdropImage.media.duration" },
+          { path: "document.nodes.shapeData.shape.duration" }
         ]
       },
       {
@@ -377,6 +381,7 @@ var NodeType = /* @__PURE__ */ ((NodeType2) => {
   NodeType2["CAPTION"] = "CAPTION";
   NodeType2["LAYOUT"] = "LAYOUT";
   NodeType2["LAYOUT_CELL"] = "LAYOUT_CELL";
+  NodeType2["SHAPE"] = "SHAPE";
   return NodeType2;
 })(NodeType || {});
 var WidthType = /* @__PURE__ */ ((WidthType2) => {
@@ -624,6 +629,11 @@ var ImagePosition = /* @__PURE__ */ ((ImagePosition2) => {
   ImagePosition2["BOTTOM_RIGHT"] = "BOTTOM_RIGHT";
   return ImagePosition2;
 })(ImagePosition || {});
+var Origin = /* @__PURE__ */ ((Origin2) => {
+  Origin2["IMAGE"] = "IMAGE";
+  Origin2["LAYOUT"] = "LAYOUT";
+  return Origin2;
+})(Origin || {});
 var VerticalAlignmentAlignment = /* @__PURE__ */ ((VerticalAlignmentAlignment2) => {
   VerticalAlignmentAlignment2["TOP"] = "TOP";
   VerticalAlignmentAlignment2["MIDDLE"] = "MIDDLE";
@@ -765,6 +775,7 @@ async function convertFromRicosDocument2(document, targetFormat, options) {
   NodeType,
   NullValue,
   Orientation,
+  Origin,
   Placement,
   Plugin,
   PluginContainerDataAlignment,