@wix/auto_sdk_rich-content_ricos-documents 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,35 @@
+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';
+
+declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
+interface ValidateDocumentSignature {
+    /**
+     * Checks whether a Ricos document is valid given the specified plugins.
+     *
+     * Use the `fixDocument` parameter to include a valid version of your Ricos document in the response.
+     * @param - Ricos document to validate.
+     */
+    (document: Record<string, any>, options?: ValidateDocumentOptions): Promise<NonNullablePaths<ValidateDocumentResponse, `valid` | `violations` | `violations.${number}.message`>>;
+}
+declare function convertToRicosDocument$1(httpClient: HttpClient): ConvertToRicosDocumentSignature;
+interface ConvertToRicosDocumentSignature {
+    /**
+     * Converts content in the specified format to a Ricos document.
+     */
+    (options?: ConvertToRicosDocumentOptions): Promise<ConvertToRicosDocumentResponse>;
+}
+declare function convertFromRicosDocument$1(httpClient: HttpClient): ConvertFromRicosDocumentSignature;
+interface ConvertFromRicosDocumentSignature {
+    /**
+     * Converts a Ricos document to the specified format.
+     * @param - Ricos document to convert.
+     */
+    (document: RichContent, options?: NonNullablePaths<ConvertFromRicosDocumentOptions, `targetFormat`>): 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 };