@wix/auto_sdk_media_files 1.0.93 → 1.0.94

package/build/es/index.typings.d.mts

@@ -993,7 +993,8 @@ interface GenerateFileUploadUrlRequest {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Notes:** <ul> <li>The name that appears in the Media Manager is taken from the `fileName` parameter in the Generate File Upload Url call.</li> <li>If you specify a `fileName`, the `filename` query parameter in the upload request itself is not required. </li> </ul>
-     * @maxLength 200
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     fileName?: string | null;
     /**
@@ -1106,7 +1107,8 @@ interface GenerateFileResumableUploadUrlRequest {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Notes:** <ul> <li>The name that appears in the Media Manager is taken from the `fileName` parameter in the Generate File Upload Url call.</li> <li>If you specify a `fileName`, the `filename` query parameter in the upload request itself is not required. </li> </ul>
-     * @maxLength 200
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     fileName?: string | null;
     /**
@@ -1176,7 +1178,8 @@ interface ImportFileRequest {
     mediaType?: MediaTypeWithLiterals;
     /**
      * File name that appears in the Media Manager.
-     * @maxLength 255
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     displayName?: string | null;
     /**
@@ -1448,6 +1451,17 @@ interface SearchFilesResponse {
     /** The next cursor if it exists. */
     nextCursor?: PagingMetadataV2;
 }
+interface SearchFilesCrossSiteRequest {
+    /** File media type filter. `UNKNOWN` (default) means no media-type filter is applied. */
+    mediaType?: MediaTypeWithLiterals;
+}
+interface SearchFilesCrossSiteResponse {
+    /**
+     * Files matching the tag across all sites of the account.
+     * @maxSize 200
+     */
+    files?: FileDescriptor[];
+}
 interface GenerateVideoStreamingUrlRequest {
     /**
      * File ID.
@@ -2229,7 +2243,8 @@ interface GenerateFileUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Notes:** <ul> <li>The name that appears in the Media Manager is taken from the `fileName` parameter in the Generate File Upload Url call.</li> <li>If you specify a `fileName`, the `filename` query parameter in the upload request itself is not required. </li> </ul>
-     * @maxLength 200
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     fileName?: string | null;
     /**
@@ -2287,7 +2302,8 @@ interface GenerateFileResumableUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Notes:** <ul> <li>The name that appears in the Media Manager is taken from the `fileName` parameter in the Generate File Upload Url call.</li> <li>If you specify a `fileName`, the `filename` query parameter in the upload request itself is not required. </li> </ul>
-     * @maxLength 200
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     fileName?: string | null;
     /**
@@ -2358,7 +2374,8 @@ interface ImportFileOptions {
     mediaType?: MediaTypeWithLiterals;
     /**
      * File name that appears in the Media Manager.
-     * @maxLength 255
+     * The file name is truncated to 255 characters if longer.
+     * @maxLength 1000
      */
     displayName?: string | null;
     /**
@@ -2578,6 +2595,20 @@ interface SearchFilesOptions {
     /** Cursor and paging information. */
     paging?: CursorPaging;
 }
+/**
+ * Searches files by an internal tag across all sites of the account.
+ *
+ * Unlike SearchFiles, which is scoped to a single site, this account-level action
+ * matches files by their internal tag across every site belonging to the account.
+ * @public
+ * @permissionId media:site_media:v1:file_descriptor:search_files_cross_site
+ * @fqn com.wix.media.site_media.v1.FilesService.SearchFilesCrossSite
+ */
+declare function searchFilesCrossSite(options?: SearchFilesCrossSiteOptions): Promise<NonNullablePaths<SearchFilesCrossSiteResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6>>;
+interface SearchFilesCrossSiteOptions {
+    /** File media type filter. `UNKNOWN` (default) means no media-type filter is applied. */
+    mediaType?: MediaTypeWithLiterals;
+}
 /**
  * Generates a URL for streaming a specific video file in the Media Manager. <br/>
  *
@@ -2831,4 +2862,4 @@ declare const utils: {
     };
 };
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type AnnotationContext, type ApplicationError, type Archive, type AudioAdditionalProperties, type AudioAssetAdditionalProperties, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkInternalImportFilesRequest, type BulkInternalImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, type CommonQueryWithEntityContext, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DocumentAdditionalProperties, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileAdditionalProperties, type FileAdditionalPropertiesMediaAdditionalPropertiesOneOf, type FileDescriptor, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorQuery, type FileDescriptorQuerySpec, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FilesQueryBuilder, type FilesQueryResult, type FocalPoint, type FontAdditionalProperties, type FontAsset, type FontAssetAdditionalProperties, type FontMedia, type GenerateAnimatedVectorRequest, type GenerateAnimatedVectorResponse, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type GetSiteFileDescriptorsRequest, type GetSiteFileDescriptorsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAdditionalProperties, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImageOutputAdditionalProperties, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, type ListRecentItemsRequest, type ListRecentItemsResponse, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, type Model3dAdditionalProperties, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type QueryFileDescriptorsRequest, type QueryFileDescriptorsResponse, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type SyncImportFileDescriptorRequest, type SyncImportFileDescriptorResponse, type SyncImportFileRequest, type SyncImportFileResponse, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoAdditionalProperties, type VideoResolution, type VideoResolutionAdditionalProperties, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorFileFailed, onFileDescriptorFileReady, queryFileDescriptors, searchFiles, typedQueryFileDescriptors, updateFileDescriptor, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type AnnotationContext, type ApplicationError, type Archive, type AudioAdditionalProperties, type AudioAssetAdditionalProperties, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkInternalImportFilesRequest, type BulkInternalImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, type CommonQueryWithEntityContext, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DocumentAdditionalProperties, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileAdditionalProperties, type FileAdditionalPropertiesMediaAdditionalPropertiesOneOf, type FileDescriptor, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorQuery, type FileDescriptorQuerySpec, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FilesQueryBuilder, type FilesQueryResult, type FocalPoint, type FontAdditionalProperties, type FontAsset, type FontAssetAdditionalProperties, type FontMedia, type GenerateAnimatedVectorRequest, type GenerateAnimatedVectorResponse, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type GetSiteFileDescriptorsRequest, type GetSiteFileDescriptorsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAdditionalProperties, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImageOutputAdditionalProperties, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, type ListRecentItemsRequest, type ListRecentItemsResponse, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, type Model3dAdditionalProperties, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type QueryFileDescriptorsRequest, type QueryFileDescriptorsResponse, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesCrossSiteOptions, type SearchFilesCrossSiteRequest, type SearchFilesCrossSiteResponse, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type SyncImportFileDescriptorRequest, type SyncImportFileDescriptorResponse, type SyncImportFileRequest, type SyncImportFileResponse, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoAdditionalProperties, type VideoResolution, type VideoResolutionAdditionalProperties, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorFileFailed, onFileDescriptorFileReady, queryFileDescriptors, searchFiles, searchFilesCrossSite, typedQueryFileDescriptors, updateFileDescriptor, utils };

package/build/es/index.typings.mjs

@@ -900,6 +900,83 @@ function searchFiles(payload) {
   }
   return __searchFiles;
 }
+function searchFilesCrossSite(payload) {
+  function __searchFilesCrossSite({ host }) {
+    const metadata = {
+      entityFqdn: "wix.media.site_media.v1.file_descriptor",
+      method: "POST",
+      methodFqn: "com.wix.media.site_media.v1.FilesService.SearchFilesCrossSite",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveComWixMediaSiteMediaV1FilesServiceUrl({
+        protoPath: "/v1/files/search-cross-site",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "files.createdDate" },
+            { path: "files.updatedDate" },
+            { path: "files.lastUsedDate" },
+            { path: "files.media.image.image.urlExpirationDate" },
+            { path: "files.media.image.previewImage.urlExpirationDate" },
+            { path: "files.media.video.urlExpirationDate" },
+            { path: "files.media.video.resolutions.urlExpirationDate" },
+            {
+              path: "files.media.video.resolutions.poster.urlExpirationDate"
+            },
+            { path: "files.media.video.posters.urlExpirationDate" },
+            { path: "files.media.audio.assets.urlExpirationDate" },
+            { path: "files.media.document.urlExpirationDate" },
+            { path: "files.media.document.thumbnail.urlExpirationDate" },
+            { path: "files.media.vector.image.urlExpirationDate" },
+            { path: "files.media.vector.previewImage.urlExpirationDate" },
+            { path: "files.media.archive.urlExpirationDate" },
+            { path: "files.media.model3d.urlExpirationDate" },
+            { path: "files.media.model3d.thumbnail.urlExpirationDate" },
+            { path: "files.media.icon.image.urlExpirationDate" },
+            { path: "files.media.icon.previewImage.urlExpirationDate" }
+          ]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "files.media.image.image.focalPoint.x" },
+            { path: "files.media.image.image.focalPoint.y" },
+            { path: "files.media.image.faces.confidence" },
+            { path: "files.media.image.previewImage.focalPoint.x" },
+            { path: "files.media.image.previewImage.focalPoint.y" },
+            { path: "files.media.video.resolutions.poster.focalPoint.x" },
+            { path: "files.media.video.resolutions.poster.focalPoint.y" },
+            { path: "files.media.video.posters.focalPoint.x" },
+            { path: "files.media.video.posters.focalPoint.y" },
+            { path: "files.media.document.thumbnail.focalPoint.x" },
+            { path: "files.media.document.thumbnail.focalPoint.y" },
+            { path: "files.media.vector.image.focalPoint.x" },
+            { path: "files.media.vector.image.focalPoint.y" },
+            { path: "files.media.vector.faces.confidence" },
+            { path: "files.media.vector.previewImage.focalPoint.x" },
+            { path: "files.media.vector.previewImage.focalPoint.y" },
+            { path: "files.media.model3d.thumbnail.focalPoint.x" },
+            { path: "files.media.model3d.thumbnail.focalPoint.y" },
+            { path: "files.media.icon.image.focalPoint.x" },
+            { path: "files.media.icon.image.focalPoint.y" },
+            { path: "files.media.icon.faces.confidence" },
+            { path: "files.media.icon.previewImage.focalPoint.x" },
+            { path: "files.media.icon.previewImage.focalPoint.y" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __searchFilesCrossSite;
+}
 function generateVideoStreamingUrl(payload) {
   function __generateVideoStreamingUrl({ host }) {
     const metadata = {
@@ -1875,6 +1952,58 @@ async function searchFiles2(options) {
     throw transformedError;
   }
 }
+async function searchFilesCrossSite2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    mediaType: options?.mediaType
+  });
+  const reqOpts = searchFilesCrossSite(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(
+      transformPaths2(result.data, [
+        {
+          transformFn: transformRESTVideoV2ToSDKVideoV2,
+          paths: [{ path: "files.media.video" }]
+        },
+        {
+          transformFn: transformRESTDocumentToSDKDocument,
+          paths: [{ path: "files.media.document" }]
+        },
+        {
+          transformFn: transformRESTImageToSDKImage,
+          paths: [
+            { path: "files.media.image.image" },
+            { path: "files.media.image.previewImage" },
+            { path: "files.media.vector.image" },
+            { path: "files.media.vector.previewImage" },
+            { path: "files.media.model3d.thumbnail" },
+            { path: "files.media.icon.image" },
+            { path: "files.media.icon.previewImage" }
+          ]
+        },
+        {
+          transformFn: transformRESTAudioToSDKAudio,
+          paths: [{ path: "files.media.audio.assets", isRepeated: true }]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { mediaType: "$[0].mediaType" },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function generateVideoStreamingUrl2(fileId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -2179,6 +2308,7 @@ export {
   listFiles2 as listFiles,
   queryFileDescriptors2 as queryFileDescriptors,
   searchFiles2 as searchFiles,
+  searchFilesCrossSite2 as searchFilesCrossSite,
   typedQueryFileDescriptors,
   updateFileDescriptor2 as updateFileDescriptor,
   utils