@wix/auto_sdk_rich-content_ricos-documents 1.0.7 → 1.0.9

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
-import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse } from './index.typings.js';
-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, PricingData, 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.js';
+export { Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, BlockquoteData, BookingData, Border, BorderColors, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, EmbedData, EventData, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionWithLiterals, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemStyle, Layout, LayoutCellData, LayoutData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, PDFSettings, ParagraphData, Permissions, Placement, PlacementWithLiterals, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PluginWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Scaling, ScalingWithLiterals, Settings, Source, SourceWithLiterals, Spoiler, SpoilerData, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Target, TargetFormat, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, ValidateDocumentRequest, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {
@@ -11,7 +11,7 @@ interface ValidateDocumentSignature {
      * @param - Ricos document to validate.
      * @param - Options to use when validating the document.
      */
-    (document: Record<string, any>, options?: ValidateDocumentOptions): Promise<NonNullablePaths<ValidateDocumentResponse, `valid` | `violations` | `violations.${number}.message`>>;
+    (document: Record<string, any> | null, options?: ValidateDocumentOptions): Promise<ValidateDocumentResponse>;
 }
 declare function convertToRicosDocument$1(httpClient: HttpClient): ConvertToRicosDocumentSignature;
 interface ConvertToRicosDocumentSignature {
@@ -29,11 +29,11 @@ interface ConvertFromRicosDocumentSignature {
      * @param - Format to convert the document to.
      * @param - Options to use when converting from a Ricos document.
      */
-    (document: RichContent, targetFormat: TargetFormatWithLiterals, options?: ConvertFromRicosDocumentOptions): Promise<NonNullablePaths<ConvertFromRicosDocumentResponse, `markdown` | `html` | `plainText`>>;
+    (document: RichContent, targetFormat: TargetFormatWithLiterals, options?: ConvertFromRicosDocumentOptions): Promise<ConvertFromRicosDocumentResponse>;
 }
 
 declare const validateDocument: MaybeContext<BuildRESTFunction<typeof validateDocument$1> & typeof validateDocument$1>;
 declare const convertToRicosDocument: MaybeContext<BuildRESTFunction<typeof convertToRicosDocument$1> & typeof convertToRicosDocument$1>;
 declare const convertFromRicosDocument: MaybeContext<BuildRESTFunction<typeof convertFromRicosDocument$1> & typeof convertFromRicosDocument$1>;
 
-export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, validateDocument };
+export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, validateDocument };

package/build/cjs/index.js

@@ -31,6 +31,7 @@ __export(index_exports, {
   DividerDataAlignment: () => DividerDataAlignment,
   FontType: () => FontType,
   GIFType: () => GIFType,
+  ImagePosition: () => ImagePosition,
   InitialExpandedItems: () => InitialExpandedItems,
   Layout: () => Layout,
   LayoutType: () => LayoutType,
@@ -46,6 +47,8 @@ __export(index_exports, {
   PollLayoutType: () => PollLayoutType,
   Position: () => Position,
   Resizing: () => Resizing,
+  ResponsivenessBehaviour: () => ResponsivenessBehaviour,
+  Scaling: () => Scaling,
   Source: () => Source,
   StylesPosition: () => StylesPosition,
   Target: () => Target,
@@ -54,6 +57,7 @@ __export(index_exports, {
   ThumbnailsAlignment: () => ThumbnailsAlignment,
   Type: () => Type,
   VerticalAlignment: () => VerticalAlignment,
+  VerticalAlignmentAlignment: () => VerticalAlignmentAlignment,
   ViewMode: () => ViewMode,
   ViewRole: () => ViewRole,
   VoteRole: () => VoteRole,
@@ -107,6 +111,9 @@ function validateDocument(payload) {
       method: "POST",
       methodFqn: "wix.ricos.v1.RicosDocument.ValidateDocument",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixRicosV1RicosDocumentUrl({
         protoPath: "/v1/ricos-document/validate",
         data: payload,
@@ -141,7 +148,13 @@ function validateDocument(payload) {
             { path: "validDocument.nodes.videoData.video.duration" },
             { path: "validDocument.nodes.videoData.thumbnail.duration" },
             { path: "validDocument.nodes.audioData.audio.duration" },
-            { path: "validDocument.nodes.audioData.coverImage.duration" }
+            { path: "validDocument.nodes.audioData.coverImage.duration" },
+            {
+              path: "validDocument.nodes.layoutData.backgroundImage.media.duration"
+            },
+            {
+              path: "validDocument.nodes.layoutData.backdropImage.media.duration"
+            }
           ]
         },
         {
@@ -164,6 +177,9 @@ function convertToRicosDocument(payload) {
       method: "POST",
       methodFqn: "wix.ricos.v1.RicosDocument.ConvertToRicosDocument",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixRicosV1RicosDocumentUrl({
         protoPath: "/v1/ricos-document/convert/to-ricos",
         data: payload,
@@ -192,7 +208,13 @@ function convertToRicosDocument(payload) {
             { path: "document.nodes.videoData.video.duration" },
             { path: "document.nodes.videoData.thumbnail.duration" },
             { path: "document.nodes.audioData.audio.duration" },
-            { path: "document.nodes.audioData.coverImage.duration" }
+            { path: "document.nodes.audioData.coverImage.duration" },
+            {
+              path: "document.nodes.layoutData.backgroundImage.media.duration"
+            },
+            {
+              path: "document.nodes.layoutData.backdropImage.media.duration"
+            }
           ]
         },
         {
@@ -230,7 +252,9 @@ function convertFromRicosDocument(payload) {
           { path: "document.nodes.videoData.video.duration" },
           { path: "document.nodes.videoData.thumbnail.duration" },
           { path: "document.nodes.audioData.audio.duration" },
-          { path: "document.nodes.audioData.coverImage.duration" }
+          { path: "document.nodes.audioData.coverImage.duration" },
+          { path: "document.nodes.layoutData.backgroundImage.media.duration" },
+          { path: "document.nodes.layoutData.backdropImage.media.duration" }
         ]
       },
       {
@@ -246,6 +270,9 @@ function convertFromRicosDocument(payload) {
       method: "POST",
       methodFqn: "wix.ricos.v1.RicosDocument.ConvertFromRicosDocument",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixRicosV1RicosDocumentUrl({
         protoPath: "/v1/ricos-document/convert/from-ricos",
         data: serializedData,
@@ -423,6 +450,7 @@ var GIFType = /* @__PURE__ */ ((GIFType2) => {
 var Source = /* @__PURE__ */ ((Source2) => {
   Source2["HTML"] = "HTML";
   Source2["ADSENSE"] = "ADSENSE";
+  Source2["AI"] = "AI";
   return Source2;
 })(Source || {});
 var StylesPosition = /* @__PURE__ */ ((StylesPosition2) => {
@@ -551,6 +579,35 @@ var NullValue = /* @__PURE__ */ ((NullValue2) => {
   NullValue2["NULL_VALUE"] = "NULL_VALUE";
   return NullValue2;
 })(NullValue || {});
+var Scaling = /* @__PURE__ */ ((Scaling2) => {
+  Scaling2["AUTO"] = "AUTO";
+  Scaling2["CONTAIN"] = "CONTAIN";
+  Scaling2["COVER"] = "COVER";
+  return Scaling2;
+})(Scaling || {});
+var ImagePosition = /* @__PURE__ */ ((ImagePosition2) => {
+  ImagePosition2["CENTER"] = "CENTER";
+  ImagePosition2["CENTER_LEFT"] = "CENTER_LEFT";
+  ImagePosition2["CENTER_RIGHT"] = "CENTER_RIGHT";
+  ImagePosition2["TOP"] = "TOP";
+  ImagePosition2["TOP_LEFT"] = "TOP_LEFT";
+  ImagePosition2["TOP_RIGHT"] = "TOP_RIGHT";
+  ImagePosition2["BOTTOM"] = "BOTTOM";
+  ImagePosition2["BOTTOM_LEFT"] = "BOTTOM_LEFT";
+  ImagePosition2["BOTTOM_RIGHT"] = "BOTTOM_RIGHT";
+  return ImagePosition2;
+})(ImagePosition || {});
+var VerticalAlignmentAlignment = /* @__PURE__ */ ((VerticalAlignmentAlignment2) => {
+  VerticalAlignmentAlignment2["TOP"] = "TOP";
+  VerticalAlignmentAlignment2["MIDDLE"] = "MIDDLE";
+  VerticalAlignmentAlignment2["BOTTOM"] = "BOTTOM";
+  return VerticalAlignmentAlignment2;
+})(VerticalAlignmentAlignment || {});
+var ResponsivenessBehaviour = /* @__PURE__ */ ((ResponsivenessBehaviour2) => {
+  ResponsivenessBehaviour2["STACK"] = "STACK";
+  ResponsivenessBehaviour2["WRAP"] = "WRAP";
+  return ResponsivenessBehaviour2;
+})(ResponsivenessBehaviour || {});
 var TargetFormat = /* @__PURE__ */ ((TargetFormat2) => {
   TargetFormat2["UNKNOWN_TARGET_FORMAT"] = "UNKNOWN_TARGET_FORMAT";
   TargetFormat2["MARKDOWN"] = "MARKDOWN";
@@ -698,6 +755,7 @@ var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createR
   DividerDataAlignment,
   FontType,
   GIFType,
+  ImagePosition,
   InitialExpandedItems,
   Layout,
   LayoutType,
@@ -713,6 +771,8 @@ var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createR
   PollLayoutType,
   Position,
   Resizing,
+  ResponsivenessBehaviour,
+  Scaling,
   Source,
   StylesPosition,
   Target,
@@ -721,6 +781,7 @@ var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createR
   ThumbnailsAlignment,
   Type,
   VerticalAlignment,
+  VerticalAlignmentAlignment,
   ViewMode,
   ViewRole,
   VoteRole,