@wix/auto_sdk_rich-content_ricos-documents 1.0.2 → 1.0.3

package/build/cjs/meta.d.ts

@@ -252,7 +252,7 @@ interface ButtonData {
     /** Styling for the button's container. */
     containerData?: PluginContainerData;
     /** The button type. */
-    type?: TypeWithLiterals;
+    type?: ButtonDataTypeWithLiterals;
     /** Styling for the button. */
     styles?: Styles;
     /** The text to display on the button. */
@@ -360,14 +360,14 @@ interface Height {
     /** A custom height value in pixels. */
     custom?: string | null;
 }
-declare enum Type {
+declare enum ButtonDataType {
     /** Regular link button */
     LINK = "LINK",
     /** Triggers custom action that is defined in plugin configuration by the consumer */
     ACTION = "ACTION"
 }
 /** @enumType */
-type TypeWithLiterals = Type | 'LINK' | 'ACTION';
+type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
 interface Styles {
     /**
      * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -500,7 +500,7 @@ interface DividerData {
     /** Divider width. */
     width?: WidthWithLiterals;
     /** Divider alignment. */
-    alignment?: AlignmentWithLiterals;
+    alignment?: DividerDataAlignmentWithLiterals;
 }
 declare enum LineStyle {
     /** Single Line */
@@ -524,7 +524,7 @@ declare enum Width {
 }
 /** @enumType */
 type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
-declare enum Alignment {
+declare enum DividerDataAlignment {
     /** Center alignment */
     CENTER = "CENTER",
     /** Left alignment */
@@ -533,7 +533,7 @@ declare enum Alignment {
     RIGHT = "RIGHT"
 }
 /** @enumType */
-type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
+type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
 interface FileData {
     /** Styling for the file's container. */
     containerData?: PluginContainerData;
@@ -658,7 +658,7 @@ interface ItemDataOneOf {
 }
 interface GalleryOptions {
     /** Gallery layout. */
-    layout?: Layout;
+    layout?: GalleryOptionsLayout;
     /** Styling for gallery items. */
     item?: ItemStyle;
     /** Styling for gallery thumbnail images. */
@@ -718,7 +718,7 @@ declare enum ThumbnailsAlignment {
 }
 /** @enumType */
 type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
-interface Layout {
+interface GalleryOptionsLayout {
     /** Gallery layout type. */
     type?: LayoutTypeWithLiterals;
     /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -880,7 +880,7 @@ interface LinkPreviewData {
     /** Styling for the link preview. */
     styles?: LinkPreviewDataStyles;
 }
-declare enum Position {
+declare enum StylesPosition {
     /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
     START = "START",
     /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -891,7 +891,7 @@ declare enum Position {
     HIDDEN = "HIDDEN"
 }
 /** @enumType */
-type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
+type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
 interface LinkPreviewDataStyles {
     /**
      * Background color as a hexadecimal value.
@@ -923,7 +923,7 @@ interface LinkPreviewDataStyles {
      */
     borderColor?: string | null;
     /** Position of thumbnail. Defaults to `START`. */
-    thumbnailPosition?: PositionWithLiterals;
+    thumbnailPosition?: StylesPositionWithLiterals;
 }
 interface MapData {
     /** Styling for the map's container. */
@@ -1277,6 +1277,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
     url?: string | null;
     /** An image for the embedded content. */
     image?: Media;
+    /** Whether to hide the image. */
+    hideImage?: boolean | null;
+    /** Whether to hide the title. */
+    hideTitle?: boolean | null;
+    /** Whether to hide the price. */
+    hidePrice?: boolean | null;
+    /** Whether to hide the description (Event and Booking). */
+    hideDescription?: boolean | null;
+    /** Whether to hide the date and time (Event). */
+    hideDateTime?: boolean | null;
+    /** Whether to hide the location (Event). */
+    hideLocation?: boolean | null;
+    /** Whether to hide the duration (Booking). */
+    hideDuration?: boolean | null;
+    /** Whether to hide the button. */
+    hideButton?: boolean | null;
+    /** Whether to hide the ribbon. */
+    hideRibbon?: boolean | null;
+    /** Button styling options. */
+    buttonStyles?: ButtonStyles;
+    /** Image styling options. */
+    imageStyles?: ImageStyles;
+    /** Ribbon styling options. */
+    ribbonStyles?: RibbonStyles;
+    /** Card styling options. */
+    cardStyles?: CardStyles;
 }
 /** @oneof */
 interface AppEmbedDataAppDataOneOf {
@@ -1285,6 +1311,66 @@ interface AppEmbedDataAppDataOneOf {
     /** Data for embedded Wix Events content. */
     eventData?: EventData;
 }
+declare enum Position {
+    /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
+    START = "START",
+    /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
+    END = "END",
+    /** Image positioned at the top */
+    TOP = "TOP"
+}
+/** @enumType */
+type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
+declare enum AspectRatio {
+    /** 1:1 aspect ratio */
+    SQUARE = "SQUARE",
+    /** 16:9 aspect ratio */
+    RECTANGLE = "RECTANGLE"
+}
+/** @enumType */
+type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
+declare enum Resizing {
+    /** Fill the container, may crop the image */
+    FILL = "FILL",
+    /** Fit the image within the container */
+    FIT = "FIT"
+}
+/** @enumType */
+type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
+declare enum Placement {
+    /** Ribbon placed on the image */
+    IMAGE = "IMAGE",
+    /** Ribbon placed on the product information */
+    PRODUCT_INFO = "PRODUCT_INFO"
+}
+/** @enumType */
+type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
+declare enum Type {
+    /** Card with visible border and background */
+    CONTAINED = "CONTAINED",
+    /** Card without visible border */
+    FRAMELESS = "FRAMELESS"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
+declare enum Alignment {
+    /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
+    START = "START",
+    /** Content centered */
+    CENTER = "CENTER",
+    /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
+    END = "END"
+}
+/** @enumType */
+type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
+declare enum Layout {
+    /** Elements stacked vertically */
+    STACKED = "STACKED",
+    /** Elements arranged horizontally */
+    SIDE_BY_SIDE = "SIDE_BY_SIDE"
+}
+/** @enumType */
+type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
 declare enum AppType {
     PRODUCT = "PRODUCT",
     EVENT = "EVENT",
@@ -1302,6 +1388,122 @@ interface EventData {
     /** Event location. */
     location?: string | null;
 }
+interface ButtonStyles {
+    /** Text to display on the button. */
+    buttonText?: string | null;
+    /** Border width in pixels. */
+    borderWidth?: number | null;
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Border color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    borderColorHover?: string | null;
+    /**
+     * Text color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    textColorHover?: string | null;
+    /**
+     * Background color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    backgroundColorHover?: string | null;
+    /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
+    buttonSize?: string | null;
+}
+interface ImageStyles {
+    /** Whether to hide the image. */
+    hideImage?: boolean | null;
+    /** Position of image. Defaults to `START`. */
+    imagePosition?: PositionWithLiterals;
+    /** Aspect ratio for the image. Defaults to `SQUARE`. */
+    aspectRatio?: AspectRatioWithLiterals;
+    /** How the image should be resized. Defaults to `FILL`. */
+    resizing?: ResizingWithLiterals;
+    /**
+     * Image border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Image border width in pixels. */
+    borderWidth?: number | null;
+    /** Image border radius in pixels. */
+    borderRadius?: number | null;
+}
+interface RibbonStyles {
+    /** Text to display on the ribbon. */
+    ribbonText?: string | null;
+    /**
+     * Ribbon background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Ribbon text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Ribbon border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Ribbon border width in pixels. */
+    borderWidth?: number | null;
+    /** Ribbon border radius in pixels. */
+    borderRadius?: number | null;
+    /** Placement of the ribbon. Defaults to `IMAGE`. */
+    ribbonPlacement?: PlacementWithLiterals;
+}
+interface CardStyles {
+    /**
+     * Card background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Card border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Card border width in pixels. */
+    borderWidth?: number | null;
+    /** Card border radius in pixels. */
+    borderRadius?: number | null;
+    /** Card type. Defaults to `CONTAINED`. */
+    type?: TypeWithLiterals;
+    /** Content alignment. Defaults to `START`. */
+    alignment?: AlignmentWithLiterals;
+    /** Layout for title and price. Defaults to `STACKED`. */
+    titlePriceLayout?: LayoutWithLiterals;
+    /**
+     * Title text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    titleColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+}
 interface VideoData {
     /** Styling for the video's container. */
     containerData?: PluginContainerData;

package/build/es/index.d.mts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse } from './index.typings.mjs';
-export { Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BlockquoteData, BookingData, Border, BorderColors, BulletedListData, ButtonData, CaptionData, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, EmbedData, EventData, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataStyles, InitialExpandedItems, Item, ItemDataOneOf, ItemStyle, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, PDFSettings, ParagraphData, Permissions, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, Position, Rel, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Settings, Source, Spoiler, SpoilerData, Styles, StylesBorder, TableCellData, TableData, Target, TargetFormat, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, ValidateDocumentRequest, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VoteRole, Width, WidthType } from './index.typings.mjs';
+export { Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AspectRatio, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BlockquoteData, BookingData, Border, BorderColors, BulletedListData, ButtonData, ButtonDataType, ButtonStyles, CaptionData, CardStyles, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DividerDataAlignment, DocumentStyle, EmbedData, EventData, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GalleryOptionsLayout, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataStyles, ImageStyles, InitialExpandedItems, Item, ItemDataOneOf, ItemStyle, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, PDFSettings, ParagraphData, Permissions, Placement, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, Position, Rel, Resizing, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Settings, Source, Spoiler, SpoilerData, Styles, StylesBorder, StylesPosition, TableCellData, TableData, Target, TargetFormat, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, ValidateDocumentRequest, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VoteRole, Width, WidthType } from './index.typings.mjs';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {

package/build/es/index.mjs

@@ -275,11 +275,11 @@ var PluginContainerDataAlignment = /* @__PURE__ */ ((PluginContainerDataAlignmen
   PluginContainerDataAlignment2["RIGHT"] = "RIGHT";
   return PluginContainerDataAlignment2;
 })(PluginContainerDataAlignment || {});
-var Type = /* @__PURE__ */ ((Type2) => {
-  Type2["LINK"] = "LINK";
-  Type2["ACTION"] = "ACTION";
-  return Type2;
-})(Type || {});
+var ButtonDataType = /* @__PURE__ */ ((ButtonDataType2) => {
+  ButtonDataType2["LINK"] = "LINK";
+  ButtonDataType2["ACTION"] = "ACTION";
+  return ButtonDataType2;
+})(ButtonDataType || {});
 var Target = /* @__PURE__ */ ((Target2) => {
   Target2["SELF"] = "SELF";
   Target2["BLANK"] = "BLANK";
@@ -308,12 +308,12 @@ var Width = /* @__PURE__ */ ((Width2) => {
   Width2["SMALL"] = "SMALL";
   return Width2;
 })(Width || {});
-var Alignment = /* @__PURE__ */ ((Alignment2) => {
-  Alignment2["CENTER"] = "CENTER";
-  Alignment2["LEFT"] = "LEFT";
-  Alignment2["RIGHT"] = "RIGHT";
-  return Alignment2;
-})(Alignment || {});
+var DividerDataAlignment = /* @__PURE__ */ ((DividerDataAlignment2) => {
+  DividerDataAlignment2["CENTER"] = "CENTER";
+  DividerDataAlignment2["LEFT"] = "LEFT";
+  DividerDataAlignment2["RIGHT"] = "RIGHT";
+  return DividerDataAlignment2;
+})(DividerDataAlignment || {});
 var ViewMode = /* @__PURE__ */ ((ViewMode2) => {
   ViewMode2["NONE"] = "NONE";
   ViewMode2["FULL"] = "FULL";
@@ -361,13 +361,13 @@ var Source = /* @__PURE__ */ ((Source2) => {
   Source2["ADSENSE"] = "ADSENSE";
   return Source2;
 })(Source || {});
-var Position = /* @__PURE__ */ ((Position2) => {
-  Position2["START"] = "START";
-  Position2["END"] = "END";
-  Position2["TOP"] = "TOP";
-  Position2["HIDDEN"] = "HIDDEN";
-  return Position2;
-})(Position || {});
+var StylesPosition = /* @__PURE__ */ ((StylesPosition2) => {
+  StylesPosition2["START"] = "START";
+  StylesPosition2["END"] = "END";
+  StylesPosition2["TOP"] = "TOP";
+  StylesPosition2["HIDDEN"] = "HIDDEN";
+  return StylesPosition2;
+})(StylesPosition || {});
 var MapType = /* @__PURE__ */ ((MapType2) => {
   MapType2["ROADMAP"] = "ROADMAP";
   MapType2["SATELITE"] = "SATELITE";
@@ -423,6 +423,43 @@ var FontType = /* @__PURE__ */ ((FontType2) => {
   FontType2["EM"] = "EM";
   return FontType2;
 })(FontType || {});
+var Position = /* @__PURE__ */ ((Position2) => {
+  Position2["START"] = "START";
+  Position2["END"] = "END";
+  Position2["TOP"] = "TOP";
+  return Position2;
+})(Position || {});
+var AspectRatio = /* @__PURE__ */ ((AspectRatio2) => {
+  AspectRatio2["SQUARE"] = "SQUARE";
+  AspectRatio2["RECTANGLE"] = "RECTANGLE";
+  return AspectRatio2;
+})(AspectRatio || {});
+var Resizing = /* @__PURE__ */ ((Resizing2) => {
+  Resizing2["FILL"] = "FILL";
+  Resizing2["FIT"] = "FIT";
+  return Resizing2;
+})(Resizing || {});
+var Placement = /* @__PURE__ */ ((Placement2) => {
+  Placement2["IMAGE"] = "IMAGE";
+  Placement2["PRODUCT_INFO"] = "PRODUCT_INFO";
+  return Placement2;
+})(Placement || {});
+var Type = /* @__PURE__ */ ((Type2) => {
+  Type2["CONTAINED"] = "CONTAINED";
+  Type2["FRAMELESS"] = "FRAMELESS";
+  return Type2;
+})(Type || {});
+var Alignment = /* @__PURE__ */ ((Alignment2) => {
+  Alignment2["START"] = "START";
+  Alignment2["CENTER"] = "CENTER";
+  Alignment2["END"] = "END";
+  return Alignment2;
+})(Alignment || {});
+var Layout = /* @__PURE__ */ ((Layout2) => {
+  Layout2["STACKED"] = "STACKED";
+  Layout2["SIDE_BY_SIDE"] = "SIDE_BY_SIDE";
+  return Layout2;
+})(Layout || {});
 var AppType = /* @__PURE__ */ ((AppType2) => {
   AppType2["PRODUCT"] = "PRODUCT";
   AppType2["EVENT"] = "EVENT";
@@ -586,25 +623,32 @@ var convertFromRicosDocument4 = /* @__PURE__ */ createRESTModule(convertFromRico
 export {
   Alignment,
   AppType,
+  AspectRatio,
   BackgroundType,
+  ButtonDataType,
   Crop,
   DecorationType,
   Direction,
+  DividerDataAlignment,
   FontType,
   GIFType,
   InitialExpandedItems,
+  Layout,
   LayoutType,
   LineStyle,
   MapType,
   NodeType,
   NullValue,
   Orientation,
+  Placement,
   Plugin,
   PluginContainerDataAlignment,
   PollLayoutDirection,
   PollLayoutType,
   Position,
+  Resizing,
   Source,
+  StylesPosition,
   Target,
   TargetFormat,
   TextAlignment,