@uploadcare/file-uploader 1.32.0-alpha.1 → 1.32.0

package/web/file-uploader.min.d.ts

@@ -2,8 +2,8 @@ import { LitElement, PropertyValues, TemplateResult, nothing } from 'lit';
 import * as lit_html from 'lit-html';
 import * as lit_html_directives_ref_js from 'lit-html/directives/ref.js';
 import * as _uploadcare_upload_client from '@uploadcare/upload-client';
-import { UploadcareFile, FileFromOptions, Metadata, UploadError, NetworkError, UploadcareGroup, Queue } from '@uploadcare/upload-client';
-export { Metadata, NetworkError, UploadError, UploadcareError, UploadcareFile, UploadcareGroup } from '@uploadcare/upload-client';
+import { UploadcareFile, FileFromOptions, Metadata, Tags, UploadError, NetworkError, UploadcareGroup, Queue } from '@uploadcare/upload-client';
+export { Metadata, NetworkError, Tags, UploadError, UploadcareError, UploadcareFile, UploadcareGroup } from '@uploadcare/upload-client';
 import { Ref } from 'lit/directives/ref.js';
 import { TelemetryRequest } from '@uploadcare/quality-insights';
 
@@ -1363,6 +1363,20 @@ declare class UploaderPublicApi extends SharedInstance {
         fullPath?: string;
     }) => OutputFileEntry<"idle">;
     addFileFromUploadcareFile: (file: UploadcareFile, { silent, fileName, source }?: ApiAddFileCommonOptions) => OutputFileEntry<"success">;
+    /**
+     * Replace an existing entry with an already-uploaded Uploadcare file, keeping
+     * its position in the list. The original entry is removed and a fresh one is
+     * added in its place, so the replacement goes through the full add pipeline
+     * (validators, events) like any newly added file.
+     *
+     * The original entry's `source`, `metadata`, `fullPath` and `silent` are
+     * preserved by default; `silent`, `fileName` and `source` can be overridden
+     * via `options`.
+     *
+     * Returns the new entry. Note: it has a NEW `internalId` — use the returned
+     * entry to reference the replacement going forward.
+     */
+    replaceFile: (internalId: string, file: UploadcareFile, { silent, fileName, source }?: ApiAddFileCommonOptions) => OutputFileEntry<"success">;
     removeFileByInternalId: (internalId: string) => void;
     removeAllFiles(): void;
     uploadAll: () => void;
@@ -1451,6 +1465,7 @@ declare class LitUploaderBlock extends LitActivityBlock {
     private _flushCommonUploadProgress;
     private _setInitialCrop;
     protected getMetadataFor(entryId: string): Promise<_uploadcare_upload_client.Metadata | undefined>;
+    protected getTagsFor(entryId: string): Promise<_uploadcare_upload_client.Tags | undefined>;
     protected getUploadClientOptions(): Promise<FileFromOptions>;
     getOutputData(): OutputFileEntry[];
 }
@@ -1593,7 +1608,7 @@ declare global {
 /**
  * Config keys that can't be passed as attribute (because they are object or function)
  */
-declare const complexConfigKeys: readonly ["metadata", "plugins", "localeDefinitionOverride", "secureUploadsSignatureResolver", "secureDeliveryProxyUrlResolver", "iconHrefResolver", "fileValidators", "collectionValidators", "mediaRecorderOptions"];
+declare const complexConfigKeys: readonly ["metadata", "tags", "plugins", "localeDefinitionOverride", "secureUploadsSignatureResolver", "secureDeliveryProxyUrlResolver", "iconHrefResolver", "fileValidators", "collectionValidators", "mediaRecorderOptions"];
 declare class Config extends LitBlock {
     attributesMeta: Partial<ConfigPlainType> & {
         'ctx-name': string;
@@ -1978,6 +1993,7 @@ declare global {
 }
 
 type MetadataCallback = (fileEntry: OutputFileEntry) => Promise<Metadata> | Metadata;
+type TagsCallback = (fileEntry: OutputFileEntry) => Promise<Tags> | Tags;
 type LocaleDefinitionOverride = Record<string, Partial<LocaleDefinition & CustomLocaleDefinition>>;
 type SecureDeliveryProxyUrlResolver = (previewUrl: string, urlParts: {
     uuid: string;
@@ -2197,6 +2213,10 @@ type ConfigType = {
      * Metadata for the file.
      */
     metadata: Metadata | MetadataCallback | null;
+    /**
+     * Tags for the file.
+     */
+    tags: Tags | TagsCallback | null;
     /**
      * Override locale definitions.
      */
@@ -2346,6 +2366,7 @@ type OutputFileEntry<TStatus extends OutputFileStatus = OutputFileStatus> = {
     isImage: boolean;
     mimeType: string;
     metadata: Metadata | null;
+    tags: Tags | null;
     file: File | Blob | null;
     externalUrl: string | null;
     uploadProgress: number;
@@ -2583,22 +2604,11 @@ type PluginFilesApi = {
     /**
      * Update mutable properties of a file entry by its internalId.
      * `fileSize` is recalculated automatically when `file` is provided.
-     */
-    update: (internalId: string, changes: PluginFileEntryUpdate) => void;
-    /**
-     * Replace an existing entry with an already-uploaded Uploadcare file, keeping
-     * its position in the list. The original entry is removed and a fresh one is
-     * added in its place, so the replacement goes through the full add pipeline
-     * (validators, events) like any newly added file.
      *
-     * The original entry's `source`, `metadata`, `fullPath` and `silent` are
-     * preserved by default; `silent`, `fileName` and `source` can be overridden
-     * via `options`.
-     *
-     * Returns the new entry. Note: it has a NEW `internalId` — use the returned
-     * entry to reference the replacement going forward.
+     * Other file operations (add / remove / `replaceFile`) live on the public
+     * uploader API, which plugins receive as `uploaderApi` in `setup`.
      */
-    replace: (internalId: string, file: UploadcareFile, options?: ApiAddFileCommonOptions) => OutputFileEntry<'success'>;
+    update: (internalId: string, changes: PluginFileEntryUpdate) => void;
 };
 type PluginApi = {
     registry: PluginRegistryApi;
@@ -2653,6 +2663,7 @@ interface UploadEntryData extends Record<string, unknown> {
     source: string | null;
     fullPath: string | null;
     metadata: Metadata | null;
+    tags: Tags | null;
     errors: OutputErrorFile[];
     uploadError: Error | null;
     isRemoved: boolean;
@@ -3448,4 +3459,4 @@ declare global {
 declare const PACKAGE_NAME = "blocks";
 declare const PACKAGE_VERSION: string;
 
-export { LitActivityBlock as ActivityBlock, ActivityHeader, type ActivityType, type ApiAddFileCommonOptions, BaseComponent, LitBlock as Block, BtnUi, CameraSource, CloudImageEditor, CloudImageEditorActivity, CloudImageEditorBlock, type CollectionValidators, Config, type ConfigAttributesType, type ConfigComplexType, type ConfigPlainType, type ConfigType, Copyright, CropFrame, type CustomActivities, type CustomConfig, type CustomConfigDefinition, type CustomLocaleDefinition, PubSub as Data, DropArea, DropDown, DynamicBtn, EditorAspectRatioButtonControl, EditorCropButtonControl, EditorFilterControl, EditorFreeformButtonControl, EditorImageCropper, EditorImageFader, EditorOperationControl, EditorScroller, EditorSlider, EditorToolbar, type EventMap, type EventPayload, EventType, ExternalSource, ExternalUploadSource, FileActionButton, FileItem, FileUploaderInline, FileUploaderMinimal, FileUploaderRegular, type FileValidator, type FileValidatorDescriptor, type FileValidators, FormInput, type FuncCollectionValidator, type FuncFileValidator, type GroupFlag, Icon, type IconHrefResolver, Img, type KebabCase$1 as KebabCase, type KebabCaseKeys, LineLoaderUi, type LocaleDefinitionOverride, type LowerCase, type LowerCaseKeys, type MetadataCallback, Modal, ModalEvents, type ModalId, NoWrapModeDynamicBtn, type OutputCollectionErrorType, type OutputCollectionState, type OutputCollectionStatus, type OutputCustomErrorType, type OutputError, type OutputErrorCollection, type OutputErrorFile, type OutputErrorTypePayload, type OutputFileEntry, type OutputFileErrorPayload, type OutputFileErrorType, type OutputFileStatus, type Owned, PACKAGE_NAME, PACKAGE_VERSION, type PluginActivityApi, PluginActivityHost, type PluginActivityRegistration, PluginActivityRenderer, type PluginApi, type PluginConfigApi, type PluginFileActionRegistration, type PluginFileEntryUpdate, type PluginFileHookContext, type PluginFileHookRegistration, type PluginFileHookResult, type PluginFilesApi, type PluginIconRegistration, type PluginL10nRegistration, type PluginRegistryApi, type PluginRegistrySnapshot, type PluginRender, type PluginRenderDispose, type PluginSetupParams, type PluginSetupResult, type PluginSourceRegistration, type PluginUploaderApi, PresenceToggle, PrimaryAction, ProgressBar, ProgressBarCommon, type SecureDeliveryProxyUrlResolver, type SecureUploadsSignatureAndExpire, type SecureUploadsSignatureResolver, Select, SimpleBtn, SliderUi, LitSolutionBlock as SolutionBlock, SourceBtn, SourceList, type SourceTypes, Spinner, StartFrom, Thumb, UID, UploadCtxProvider, UploadList, UploadSource, LitUploaderBlock as UploaderBlock, type UploaderPlugin, UploaderPublicApi, UrlSource, defineComponents, defineLocale, loadFileUploaderFrom, toKebabCase };
+export { LitActivityBlock as ActivityBlock, ActivityHeader, type ActivityType, type ApiAddFileCommonOptions, BaseComponent, LitBlock as Block, BtnUi, CameraSource, CloudImageEditor, CloudImageEditorActivity, CloudImageEditorBlock, type CollectionValidators, Config, type ConfigAttributesType, type ConfigComplexType, type ConfigPlainType, type ConfigType, Copyright, CropFrame, type CustomActivities, type CustomConfig, type CustomConfigDefinition, type CustomLocaleDefinition, PubSub as Data, DropArea, DropDown, DynamicBtn, EditorAspectRatioButtonControl, EditorCropButtonControl, EditorFilterControl, EditorFreeformButtonControl, EditorImageCropper, EditorImageFader, EditorOperationControl, EditorScroller, EditorSlider, EditorToolbar, type EventMap, type EventPayload, EventType, ExternalSource, ExternalUploadSource, FileActionButton, FileItem, FileUploaderInline, FileUploaderMinimal, FileUploaderRegular, type FileValidator, type FileValidatorDescriptor, type FileValidators, FormInput, type FuncCollectionValidator, type FuncFileValidator, type GroupFlag, Icon, type IconHrefResolver, Img, type KebabCase$1 as KebabCase, type KebabCaseKeys, LineLoaderUi, type LocaleDefinitionOverride, type LowerCase, type LowerCaseKeys, type MetadataCallback, Modal, ModalEvents, type ModalId, NoWrapModeDynamicBtn, type OutputCollectionErrorType, type OutputCollectionState, type OutputCollectionStatus, type OutputCustomErrorType, type OutputError, type OutputErrorCollection, type OutputErrorFile, type OutputErrorTypePayload, type OutputFileEntry, type OutputFileErrorPayload, type OutputFileErrorType, type OutputFileStatus, type Owned, PACKAGE_NAME, PACKAGE_VERSION, type PluginActivityApi, PluginActivityHost, type PluginActivityRegistration, PluginActivityRenderer, type PluginApi, type PluginConfigApi, type PluginFileActionRegistration, type PluginFileEntryUpdate, type PluginFileHookContext, type PluginFileHookRegistration, type PluginFileHookResult, type PluginFilesApi, type PluginIconRegistration, type PluginL10nRegistration, type PluginRegistryApi, type PluginRegistrySnapshot, type PluginRender, type PluginRenderDispose, type PluginSetupParams, type PluginSetupResult, type PluginSourceRegistration, type PluginUploaderApi, PresenceToggle, PrimaryAction, ProgressBar, ProgressBarCommon, type SecureDeliveryProxyUrlResolver, type SecureUploadsSignatureAndExpire, type SecureUploadsSignatureResolver, Select, SimpleBtn, SliderUi, LitSolutionBlock as SolutionBlock, SourceBtn, SourceList, type SourceTypes, Spinner, StartFrom, type TagsCallback, Thumb, UID, UploadCtxProvider, UploadList, UploadSource, LitUploaderBlock as UploaderBlock, type UploaderPlugin, UploaderPublicApi, UrlSource, defineComponents, defineLocale, loadFileUploaderFrom, toKebabCase };