@wix/auto_sdk_rich-content_ricos-documents 1.0.51 → 1.0.53

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse } from './index.typings.js';
-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, FileSource, FileSourceDataOneOf, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, 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';
+import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlApplicationErrors } from './index.typings.js';
+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, 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';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {
@@ -31,9 +31,20 @@ interface ConvertFromRicosDocumentSignature {
      */
     (document: RichContent, targetFormat: TargetFormatWithLiterals, options?: ConvertFromRicosDocumentOptions): Promise<ConvertFromRicosDocumentResponse>;
 }
+declare function generateFileDownloadUrl$1(httpClient: HttpClient): GenerateFileDownloadUrlSignature;
+interface GenerateFileDownloadUrlSignature {
+    /**
+     * Generates a temporary URL for downloading a file uploaded through a Ricos file plugin.
+     * @param - File ID as stored in the Ricos file plugin data.
+     */
+    (fileId: string): Promise<GenerateFileDownloadUrlResponse & {
+        __applicationErrorsType?: GenerateFileDownloadUrlApplicationErrors;
+    }>;
+}
 
 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>;
+declare const generateFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFileDownloadUrl$1> & typeof generateFileDownloadUrl$1>;
 
-export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, validateDocument };
+export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, validateDocument };

package/build/cjs/index.js

@@ -88,6 +88,7 @@ __export(index_exports, {
   WidthType: () => WidthType,
   convertFromRicosDocument: () => convertFromRicosDocument4,
   convertToRicosDocument: () => convertToRicosDocument4,
+  generateFileDownloadUrl: () => generateFileDownloadUrl4,
   validateDocument: () => validateDocument4
 });
 module.exports = __toCommonJS(index_exports);
@@ -758,6 +759,27 @@ function convertFromRicosDocument(payload) {
   }
   return __convertFromRicosDocument;
 }
+function generateFileDownloadUrl(payload) {
+  function __generateFileDownloadUrl({ host }) {
+    const metadata = {
+      entityFqdn: "wix.ricos.v1.document",
+      method: "POST",
+      methodFqn: "wix.ricos.v1.RicosDocument.GenerateFileDownloadUrl",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixRicosV1RicosDocumentUrl({
+        protoPath: "/v1/ricos-document/generate-file-download-url",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __generateFileDownloadUrl;
+}
 
 // src/ricos-v1-document-ricos-documents.universal.ts
 var Plugin = /* @__PURE__ */ ((Plugin2) => {
@@ -1412,6 +1434,29 @@ async function convertFromRicosDocument2(document, targetFormat, options) {
     throw transformedError;
   }
 }
+async function generateFileDownloadUrl2(fileId) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ fileId });
+  const reqOpts = generateFileDownloadUrl(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { fileId: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["fileId"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 
 // src/ricos-v1-document-ricos-documents.public.ts
 function validateDocument3(httpClient) {
@@ -1438,12 +1483,20 @@ function convertFromRicosDocument3(httpClient) {
     { httpClient }
   );
 }
+function generateFileDownloadUrl3(httpClient) {
+  return (fileId) => generateFileDownloadUrl2(
+    fileId,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 
 // src/ricos-v1-document-ricos-documents.context.ts
 var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
 var validateDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(validateDocument3);
 var convertToRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(convertToRicosDocument3);
 var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(convertFromRicosDocument3);
+var generateFileDownloadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(generateFileDownloadUrl3);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Alignment,
@@ -1514,6 +1567,7 @@ var convertFromRicosDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createR
   WidthType,
   convertFromRicosDocument,
   convertToRicosDocument,
+  generateFileDownloadUrl,
   validateDocument
 });
 //# sourceMappingURL=index.js.map