@wix/auto_sdk_media_files 1.0.77 → 1.0.78

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

@@ -479,6 +479,183 @@ declare enum IdentityType {
 }
 /** @enumType */
 type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/**
+ * Internal-only metadata preserved from the raw PM contract that has no
+ * representation in the domain model. Populated during toDomain and used
+ * by fromDomain to reconstruct a lossless raw PM file.
+ */
+interface FileAdditionalProperties extends FileAdditionalPropertiesMediaAdditionalPropertiesOneOf {
+    /** Set when the file is an audio file; preserves PM-specific audio fields. */
+    audio?: AudioAdditionalProperties;
+    /** Set when the file is a video file; preserves PM-specific video fields. */
+    video?: VideoAdditionalProperties;
+    /** Set when the file is a font file; preserves PM-specific font fields. */
+    font?: FontAdditionalProperties;
+    /** Set when the file is a document file; preserves PM-specific document fields. */
+    document?: DocumentAdditionalProperties;
+    /** Set when the file is a 3D model file; preserves PM-specific model3d fields. */
+    model3d?: Model3dAdditionalProperties;
+    /** Set when the file is an image file; preserves PM-specific image fields. */
+    image?: ImageAdditionalProperties;
+}
+/** @oneof */
+interface FileAdditionalPropertiesMediaAdditionalPropertiesOneOf {
+    /** Set when the file is an audio file; preserves PM-specific audio fields. */
+    audio?: AudioAdditionalProperties;
+    /** Set when the file is a video file; preserves PM-specific video fields. */
+    video?: VideoAdditionalProperties;
+    /** Set when the file is a font file; preserves PM-specific font fields. */
+    font?: FontAdditionalProperties;
+    /** Set when the file is a document file; preserves PM-specific document fields. */
+    document?: DocumentAdditionalProperties;
+    /** Set when the file is a 3D model file; preserves PM-specific model3d fields. */
+    model3d?: Model3dAdditionalProperties;
+    /** Set when the file is an image file; preserves PM-specific image fields. */
+    image?: ImageAdditionalProperties;
+}
+interface AudioAdditionalProperties {
+    /** From PmAudioInfo.file_input.sample_rate, in Hz (e.g. 44100). */
+    sampleRate?: number | null;
+    /** From PmAudioInfo.file_input.channels (e.g. 2 for stereo). */
+    channels?: number | null;
+    /**
+     * Parallel array to AudioV2.assets, same sort order.
+     * @maxSize 10
+     */
+    assets?: AudioAssetAdditionalProperties[];
+}
+interface AudioAssetAdditionalProperties {
+    /**
+     * From PmAudioInfo.file_output.audio[].tag (e.g. "high").
+     * @maxLength 100
+     */
+    tag?: string | null;
+    /** From PmAudioInfo.file_output.audio[].audio_bitrate, in bits per second. */
+    audioBitrate?: number | null;
+    /**
+     * From PmAudioInfo.file_output.audio[].status (e.g. "READY").
+     * @maxLength 30
+     */
+    status?: string | null;
+    /**
+     * From PmAudioInfo.file_output.audio[].url (only populated for secure assets where PM omits the URL).
+     * @format WEB_URL
+     */
+    url?: string | null;
+}
+interface VideoAdditionalProperties {
+    /**
+     * From PmVideoInfo.file_input.fps (e.g. "25/1").
+     * @maxLength 10
+     */
+    fps?: string | null;
+    /** From PmVideoInfo.file_input.video_bitrate, in bits per second. */
+    videoBitrate?: number | null;
+    /** From PmVideoInfo.file_input.rotation, in degrees (e.g. 0, 90, 180, 270). */
+    rotation?: number | null;
+    /**
+     * From PmVideoInfo.file_input.display_aspect_ratio (e.g. "16:9").
+     * @maxLength 10
+     */
+    displayAspectRatio?: string | null;
+    /** From PmVideoInfo.file_input.audio_bitrate, in bits per second. */
+    audioBitrate?: number | null;
+    /**
+     * From PmVideoInfo.file_input.sample_aspect_ration (e.g. "1:1").
+     * @maxLength 10
+     */
+    sampleAspectRatio?: string | null;
+    /**
+     * Keyed by VideoResolution.assetKey (e.g. "720p.mp4", "storyboard-00001.jpg").
+     * Covers both file_output.video[] and file_output.storyboard[] on the raw side.
+     */
+    resolutions?: Record<string, VideoResolutionAdditionalProperties>;
+    /**
+     * Parallel array to VideoV2.posters, same sort order.
+     * @maxSize 10
+     */
+    posters?: ImageOutputAdditionalProperties[];
+}
+interface VideoResolutionAdditionalProperties {
+    /** From PmVideoInfo.file_output.video[].audio_bitrate or storyboard[].audio_bitrate, in bits per second. */
+    audioBitrate?: number | null;
+    /**
+     * From PmVideoInfo.file_output.video[].display_aspect_ratio or storyboard[].display_aspect_ratio (e.g. "16:9").
+     * @maxLength 10
+     */
+    displayAspectRatio?: string | null;
+    /**
+     * From PmVideoInfo.file_output.video[].fps or storyboard[].fps (e.g. "25/1").
+     * @maxLength 10
+     */
+    fps?: string | null;
+    /**
+     * From PmVideoInfo.file_output.video[].status or storyboard[].status (e.g. "READY").
+     * @maxLength 20
+     */
+    status?: string | null;
+    /**
+     * From PmVideoInfo.file_output.video[].tag or storyboard[].tag (e.g. "HD").
+     * @maxLength 100
+     */
+    tag?: string | null;
+    /** From PmVideoInfo.file_output.video[].video_bitrate or storyboard[].video_bitrate, in bits per second. */
+    videoBitrate?: number | null;
+}
+/**
+ * Shared additional properties for any ImageOutput in the raw PM contract
+ * (video poster outputs and preview outputs for document/model3d/image files).
+ */
+interface ImageOutputAdditionalProperties {
+    /**
+     * From ImageOutput.key (e.g. "poster.0", "image.preview").
+     * @maxLength 100
+     */
+    key?: string | null;
+    /** From ImageOutput.secure. */
+    secure?: boolean | null;
+    /**
+     * From ImageOutput.status (e.g. "READY").
+     * @maxLength 30
+     */
+    status?: string | null;
+    /**
+     * From ImageOutput.format (e.g. "jpg", "png"). Absent when original raw had no format field.
+     * @maxLength 10
+     */
+    format?: string | null;
+    /**
+     * From ImageOutput.name. Present for model3d and some document previews; absent for video posters.
+     * @maxLength 200
+     */
+    name?: string | null;
+}
+interface FontAdditionalProperties {
+    /**
+     * Parallel array to FontMedia.assets, same sort order.
+     * @maxSize 10
+     */
+    assets?: FontAssetAdditionalProperties[];
+}
+interface FontAssetAdditionalProperties {
+    /**
+     * From PmFontInfo.file_output.font[].status (e.g. "READY").
+     * @maxLength 30
+     */
+    status?: string | null;
+}
+interface DocumentAdditionalProperties {
+    /** From PmDocumentInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
+    preview?: ImageOutputAdditionalProperties;
+}
+interface Model3dAdditionalProperties {
+    /** From PmModel3dInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
+    preview?: ImageOutputAdditionalProperties;
+}
+interface ImageAdditionalProperties {
+    /** From PmImageInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
+    preview?: ImageOutputAdditionalProperties;
+}
 interface DraftFilePublished {
     /** The file after it was published */
     file?: FileDescriptor;
@@ -2583,4 +2760,4 @@ declare const utils: {
     };
 };
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type Archive, 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 DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, 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 FontAsset, 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 ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, 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, 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 VideoResolution, 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 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 };