@wix/auto_sdk_rich-content_ricos-documents 1.0.57 → 1.0.58

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse } from './index.typings.js';
3
- export { Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOriginPresenceOneOf, BannerPosition, BannerPositionWithLiterals, BlockquoteData, BookingData, Border, BorderColors, BorderWidths, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, EmbedData, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, FileData, FileDownloadUrl, FileSource, FileSourceDataOneOf, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GenerateFileDownloadUrlRequest, GenerateFileUploadUrlRequest, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemStyle, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListItemNodeData, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, ParagraphData, Permissions, Placement, PlacementWithLiterals, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PluginWithLiterals, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Scaling, ScalingWithLiterals, SectionDivider, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, Source, SourceWithLiterals, Spoiler, SpoilerData, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Target, TargetFormat, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, ValidateDocumentRequest, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
2
+ import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, GenerateSiteMediaTokenResponse, GenerateSiteMediaTokenApplicationErrors } from './index.typings.js';
3
+ export { Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOriginPresenceOneOf, BannerPosition, BannerPositionWithLiterals, BlockquoteData, BookingData, Border, BorderColors, BorderWidths, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, EmbedData, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, FileData, FileDownloadUrl, FileSource, FileSourceDataOneOf, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GenerateFileDownloadUrlRequest, GenerateFileUploadUrlRequest, GenerateSiteMediaTokenRequest, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemStyle, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListItemNodeData, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, ParagraphData, Permissions, Placement, PlacementWithLiterals, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PluginWithLiterals, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Scaling, ScalingWithLiterals, SectionDivider, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, Source, SourceWithLiterals, Spoiler, SpoilerData, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Target, TargetFormat, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, ValidateDocumentRequest, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
4
4
 
5
5
  declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
6
6
  interface ValidateDocumentSignature {
@@ -80,11 +80,27 @@ interface GenerateFileUploadUrlSignature {
80
80
  */
81
81
  (mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<GenerateFileUploadUrlResponse>;
82
82
  }
83
+ declare function generateSiteMediaToken$1(httpClient: HttpClient): GenerateSiteMediaTokenSignature;
84
+ interface GenerateSiteMediaTokenSignature {
85
+ /**
86
+ * Generates a site media token that lets a Ricos editor open Wix media tools, such as Image Studio, for the current Wix user.
87
+ *
88
+ * Pass the token to the media tool when you open it. The token identifies the site and the Wix user,
89
+ * works only together with the user's Wix session, and expires after 14 days.
90
+ *
91
+ * Only Wix users can call this method. Calls by site members, site visitors, or apps without a Wix user
92
+ * fail with a `WIX_USER_REQUIRED` error.
93
+ */
94
+ (): Promise<GenerateSiteMediaTokenResponse & {
95
+ __applicationErrorsType?: GenerateSiteMediaTokenApplicationErrors;
96
+ }>;
97
+ }
83
98
 
84
99
  declare const validateDocument: MaybeContext<BuildRESTFunction<typeof validateDocument$1> & typeof validateDocument$1>;
85
100
  declare const convertToRicosDocument: MaybeContext<BuildRESTFunction<typeof convertToRicosDocument$1> & typeof convertToRicosDocument$1>;
86
101
  declare const convertFromRicosDocument: MaybeContext<BuildRESTFunction<typeof convertFromRicosDocument$1> & typeof convertFromRicosDocument$1>;
87
102
  declare const generateFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFileDownloadUrl$1> & typeof generateFileDownloadUrl$1>;
88
103
  declare const generateFileUploadUrl: MaybeContext<BuildRESTFunction<typeof generateFileUploadUrl$1> & typeof generateFileUploadUrl$1>;
104
+ declare const generateSiteMediaToken: MaybeContext<BuildRESTFunction<typeof generateSiteMediaToken$1> & typeof generateSiteMediaToken$1>;
89
105
 
90
- export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, generateFileUploadUrl, validateDocument };
106
+ export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, GenerateSiteMediaTokenApplicationErrors, GenerateSiteMediaTokenResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, generateFileUploadUrl, generateSiteMediaToken, validateDocument };
@@ -90,6 +90,7 @@ __export(index_exports, {
90
90
  convertToRicosDocument: () => convertToRicosDocument4,
91
91
  generateFileDownloadUrl: () => generateFileDownloadUrl4,
92
92
  generateFileUploadUrl: () => generateFileUploadUrl4,
93
+ generateSiteMediaToken: () => generateSiteMediaToken4,
93
94
  validateDocument: () => validateDocument4
94
95
  });
95
96
  module.exports = __toCommonJS(index_exports);
@@ -802,6 +803,27 @@ function generateFileUploadUrl(payload) {
802
803
  }
803
804
  return __generateFileUploadUrl;
804
805
  }
806
+ function generateSiteMediaToken(payload) {
807
+ function __generateSiteMediaToken({ host }) {
808
+ const metadata = {
809
+ entityFqdn: "wix.ricos.v1.document",
810
+ method: "POST",
811
+ methodFqn: "wix.ricos.v1.RicosDocument.GenerateSiteMediaToken",
812
+ packageName: PACKAGE_NAME,
813
+ migrationOptions: {
814
+ optInTransformResponse: true
815
+ },
816
+ url: resolveWixRicosV1RicosDocumentUrl({
817
+ protoPath: "/v1/ricos-document/generate-site-media-token",
818
+ data: payload,
819
+ host
820
+ }),
821
+ data: payload
822
+ };
823
+ return metadata;
824
+ }
825
+ return __generateSiteMediaToken;
826
+ }
805
827
 
806
828
  // src/ricos-v1-document-ricos-documents.universal.ts
807
829
  var Plugin = /* @__PURE__ */ ((Plugin2) => {
@@ -1512,6 +1534,29 @@ async function generateFileUploadUrl2(mimeType, options) {
1512
1534
  throw transformedError;
1513
1535
  }
1514
1536
  }
1537
+ async function generateSiteMediaToken2() {
1538
+ const { httpClient, sideEffects } = arguments[0];
1539
+ const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({});
1540
+ const reqOpts = generateSiteMediaToken(payload);
1541
+ sideEffects?.onSiteCall?.();
1542
+ try {
1543
+ const result = await httpClient.request(reqOpts);
1544
+ sideEffects?.onSuccess?.(result);
1545
+ return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
1546
+ } catch (err) {
1547
+ const transformedError = (0, import_transform_error.transformError)(
1548
+ err,
1549
+ {
1550
+ spreadPathsToArguments: {},
1551
+ explicitPathsToArguments: {},
1552
+ singleArgumentUnchanged: false
1553
+ },
1554
+ []
1555
+ );
1556
+ sideEffects?.onError?.(err);
1557
+ throw transformedError;
1558
+ }
1559
+ }
1515
1560
 
1516
1561
  // src/ricos-v1-document-ricos-documents.public.ts
1517
1562
  function validateDocument3(httpClient) {
@@ -1553,6 +1598,12 @@ function generateFileUploadUrl3(httpClient) {
1553
1598
  { httpClient }
1554
1599
  );
1555
1600
  }
1601
+ function generateSiteMediaToken3(httpClient) {
1602
+ return () => generateSiteMediaToken2(
1603
+ // @ts-ignore
1604
+ { httpClient }
1605
+ );
1606
+ }
1556
1607
 
1557
1608
  // src/ricos-v1-document-ricos-documents.context.ts
1558
1609
  var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
@@ -1561,6 +1612,7 @@ var convertToRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRES
1561
1612
  var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(convertFromRicosDocument3);
1562
1613
  var generateFileDownloadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(generateFileDownloadUrl3);
1563
1614
  var generateFileUploadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(generateFileUploadUrl3);
1615
+ var generateSiteMediaToken4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(generateSiteMediaToken3);
1564
1616
  // Annotate the CommonJS export names for ESM import in node:
1565
1617
  0 && (module.exports = {
1566
1618
  Alignment,
@@ -1633,6 +1685,7 @@ var generateFileUploadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createREST
1633
1685
  convertToRicosDocument,
1634
1686
  generateFileDownloadUrl,
1635
1687
  generateFileUploadUrl,
1688
+ generateSiteMediaToken,
1636
1689
  validateDocument
1637
1690
  });
1638
1691
  //# sourceMappingURL=index.js.map