@wix/auto_sdk_rich-content_ricos-documents 1.0.54 → 1.0.56

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, 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';
+import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse } 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, 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';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {
@@ -54,10 +54,37 @@ interface GenerateFileDownloadUrlSignature {
         __applicationErrorsType?: GenerateFileDownloadUrlApplicationErrors;
     }>;
 }
+declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
+interface GenerateFileUploadUrlSignature {
+    /**
+     * Generates a URL for uploading a file to the site's Media Manager, so you can add the file to a Ricos document.
+     *
+     * To upload the file, send a `PUT` request to `uploadUrl` with the file content as the request body and a
+     * `Content-Type` header that matches `mimeType`. If you didn't specify `fileName`, add the file name as the
+     * `filename` query parameter. For example, `PUT {uploadUrl}?filename=report.pdf`. The URL expires after 24 hours.
+     * Learn more about the [Upload API](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api).
+     *
+     * The upload response contains the uploaded file's
+     * [file descriptor](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-object).
+     * Specify its `file.id` as the file node's `fileData.src.id` in the Ricos document.
+     * A successful upload response doesn't mean the file is ready. To run code when it's ready, listen for the
+     * [File Ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-file-ready) and
+     * [File Failed](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-file-failed) events.
+     *
+     * Use this method to let site visitors and members add files to the content they create.
+     * To download a private file, call [Generate File Download URL](https://dev.wix.com/docs/api-reference/assets/rich-content/ricos-documents/generate-file-download-url).
+     *
+     * This method doesn't support resumable uploads. For the supported file types and sizes, see
+     * [Wix Media: Supported Media File Types and File Sizes](https://support.wix.com/en/article/wix-media-supported-media-file-types-and-file-sizes).
+     * @param - MIME type of the file to upload. For example, `application/pdf`.
+     */
+    (mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<GenerateFileUploadUrlResponse>;
+}
 
 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>;
+declare const generateFileUploadUrl: MaybeContext<BuildRESTFunction<typeof generateFileUploadUrl$1> & typeof generateFileUploadUrl$1>;
 
-export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, validateDocument };
+export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, generateFileUploadUrl, validateDocument };

package/build/cjs/index.js

@@ -89,6 +89,7 @@ __export(index_exports, {
   convertFromRicosDocument: () => convertFromRicosDocument4,
   convertToRicosDocument: () => convertToRicosDocument4,
   generateFileDownloadUrl: () => generateFileDownloadUrl4,
+  generateFileUploadUrl: () => generateFileUploadUrl4,
   validateDocument: () => validateDocument4
 });
 module.exports = __toCommonJS(index_exports);
@@ -780,6 +781,27 @@ function generateFileDownloadUrl(payload) {
   }
   return __generateFileDownloadUrl;
 }
+function generateFileUploadUrl(payload) {
+  function __generateFileUploadUrl({ host }) {
+    const metadata = {
+      entityFqdn: "wix.ricos.v1.document",
+      method: "POST",
+      methodFqn: "wix.ricos.v1.RicosDocument.GenerateFileUploadUrl",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixRicosV1RicosDocumentUrl({
+        protoPath: "/v1/ricos-document/generate-file-upload-url",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __generateFileUploadUrl;
+}
 
 // src/ricos-v1-document-ricos-documents.universal.ts
 var Plugin = /* @__PURE__ */ ((Plugin2) => {
@@ -1457,6 +1479,39 @@ async function generateFileDownloadUrl2(fileId) {
     throw transformedError;
   }
 }
+async function generateFileUploadUrl2(mimeType, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    mimeType,
+    fileName: options?.fileName,
+    parentFolderId: options?.parentFolderId,
+    private: options?.private
+  });
+  const reqOpts = generateFileUploadUrl(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: {
+          mimeType: "$[0]",
+          fileName: "$[1].fileName",
+          parentFolderId: "$[1].parentFolderId",
+          private: "$[1].private"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["mimeType", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 
 // src/ricos-v1-document-ricos-documents.public.ts
 function validateDocument3(httpClient) {
@@ -1490,6 +1545,14 @@ function generateFileDownloadUrl3(httpClient) {
     { httpClient }
   );
 }
+function generateFileUploadUrl3(httpClient) {
+  return (mimeType, options) => generateFileUploadUrl2(
+    mimeType,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 
 // src/ricos-v1-document-ricos-documents.context.ts
 var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
@@ -1497,6 +1560,7 @@ var validateDocument4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModul
 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);
+var generateFileUploadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(generateFileUploadUrl3);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Alignment,
@@ -1568,6 +1632,7 @@ var generateFileDownloadUrl4 = /* @__PURE__ */ (0, import_rest_modules2.createRE
   convertFromRicosDocument,
   convertToRicosDocument,
   generateFileDownloadUrl,
+  generateFileUploadUrl,
   validateDocument
 });
 //# sourceMappingURL=index.js.map