@wix/auto_sdk_rich-content_ricos-documents 1.0.2 → 1.0.4

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse } from './index.typings.js';
-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.js';
+import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, 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, Rel, Resizing, RibbonStyles, RichContent, 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';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {
@@ -23,13 +23,13 @@ declare function convertFromRicosDocument$1(httpClient: HttpClient): ConvertFrom
 interface ConvertFromRicosDocumentSignature {
     /**
      * Converts a Ricos document to the specified format.
-     * @param - Ricos document to convert.
+     * @param - Format to convert the document to.
      */
-    (document: RichContent, options?: NonNullablePaths<ConvertFromRicosDocumentOptions, `targetFormat`>): Promise<NonNullablePaths<ConvertFromRicosDocumentResponse, `markdown` | `html` | `plainText`>>;
+    (targetFormat: TargetFormatWithLiterals, options?: NonNullablePaths<ConvertFromRicosDocumentOptions, `document`>): Promise<NonNullablePaths<ConvertFromRicosDocumentResponse, `markdown` | `html` | `plainText`>>;
 }
 
 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, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, validateDocument };

package/build/cjs/index.js

@@ -22,25 +22,32 @@ var index_exports = {};
 __export(index_exports, {
   Alignment: () => Alignment,
   AppType: () => AppType,
+  AspectRatio: () => AspectRatio,
   BackgroundType: () => BackgroundType,
+  ButtonDataType: () => ButtonDataType,
   Crop: () => Crop,
   DecorationType: () => DecorationType,
   Direction: () => Direction,
+  DividerDataAlignment: () => DividerDataAlignment,
   FontType: () => FontType,
   GIFType: () => GIFType,
   InitialExpandedItems: () => InitialExpandedItems,
+  Layout: () => Layout,
   LayoutType: () => LayoutType,
   LineStyle: () => LineStyle,
   MapType: () => MapType,
   NodeType: () => NodeType,
   NullValue: () => NullValue,
   Orientation: () => Orientation,
+  Placement: () => Placement,
   Plugin: () => Plugin,
   PluginContainerDataAlignment: () => PluginContainerDataAlignment,
   PollLayoutDirection: () => PollLayoutDirection,
   PollLayoutType: () => PollLayoutType,
   Position: () => Position,
+  Resizing: () => Resizing,
   Source: () => Source,
+  StylesPosition: () => StylesPosition,
   Target: () => Target,
   TargetFormat: () => TargetFormat,
   TextAlignment: () => TextAlignment,
@@ -332,11 +339,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";
@@ -365,12 +372,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";
@@ -418,13 +425,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";
@@ -480,6 +487,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";
@@ -578,11 +622,11 @@ async function convertToRicosDocument2(options) {
     throw transformedError;
   }
 }
-async function convertFromRicosDocument2(document, options) {
+async function convertFromRicosDocument2(targetFormat, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
-    document,
-    targetFormat: options?.targetFormat,
+    targetFormat,
+    document: options?.document,
     plainTextOptions: options?.plainTextOptions
   });
   const reqOpts = convertFromRicosDocument(payload);
@@ -597,13 +641,13 @@ async function convertFromRicosDocument2(document, options) {
       {
         spreadPathsToArguments: {},
         explicitPathsToArguments: {
-          document: "$[0]",
-          targetFormat: "$[1].targetFormat",
+          targetFormat: "$[0]",
+          document: "$[1].document",
           plainTextOptions: "$[1].plainTextOptions"
         },
         singleArgumentUnchanged: false
       },
-      ["document", "options"]
+      ["targetFormat", "options"]
     );
     sideEffects?.onError?.(err);
     throw transformedError;
@@ -627,8 +671,8 @@ function convertToRicosDocument3(httpClient) {
   );
 }
 function convertFromRicosDocument3(httpClient) {
-  return (document, options) => convertFromRicosDocument2(
-    document,
+  return (targetFormat, options) => convertFromRicosDocument2(
+    targetFormat,
     options,
     // @ts-ignore
     { httpClient }
@@ -644,25 +688,32 @@ var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createR
 0 && (module.exports = {
   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,