@uploadcare/file-uploader 1.31.2-alpha.0 → 1.31.2

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

@@ -224,6 +224,22 @@ declare const _default: {
 
 type LocaleDefinition = typeof _default;
 type LocaleDefinitionResolver = () => Promise<LocaleDefinition>;
+/**
+ * Interface for TypeScript module augmentation.
+ * Plugins should extend this interface to add their own locale string keys, so
+ * `localeDefinitionOverride` is typed for them instead of a loose record.
+ *
+ * @example
+ * ```typescript
+ * declare module '@uploadcare/file-uploader' {
+ *   interface CustomLocaleDefinition {
+ *     'my-plugin-title': string;
+ *   }
+ * }
+ * ```
+ */
+interface CustomLocaleDefinition {
+}
 declare const defineLocale: (localeName: string, definitionOrResolver: LocaleDefinition | LocaleDefinitionResolver) => void;
 
 type AfterFileAddContext = {
@@ -390,7 +406,9 @@ declare class TypedCollection<T extends Record<string, unknown>> {
     private _scheduleDestroyMarkedItems;
     observeCollection(handler: TypedCollectionObserverHandler<T>): () => void;
     unobserveCollection(handler: TypedCollectionObserverHandler<T>): void;
-    add(init: Partial<T>): Uid;
+    add(init: Partial<T>, options?: {
+        index?: number;
+    }): Uid;
     hasItem(id: Uid): boolean;
     read(id: Uid): TypedData<T> | null;
     readProp<K extends keyof T>(id: Uid, propName: K): T[K];
@@ -1345,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;
@@ -1960,7 +1992,7 @@ declare global {
 }
 
 type MetadataCallback = (fileEntry: OutputFileEntry) => Promise<Metadata> | Metadata;
-type LocaleDefinitionOverride = Record<string, Partial<LocaleDefinition>>;
+type LocaleDefinitionOverride = Record<string, Partial<LocaleDefinition & CustomLocaleDefinition>>;
 type SecureDeliveryProxyUrlResolver = (previewUrl: string, urlParts: {
     uuid: string;
     cdnUrlModifiers: string;
@@ -2565,6 +2597,9 @@ type PluginFilesApi = {
     /**
      * Update mutable properties of a file entry by its internalId.
      * `fileSize` is recalculated automatically when `file` is provided.
+     *
+     * Other file operations (add / remove / `replaceFile`) live on the public
+     * uploader API, which plugins receive as `uploaderApi` in `setup`.
      */
     update: (internalId: string, changes: PluginFileEntryUpdate) => void;
 };
@@ -3416,4 +3451,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, 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, Thumb, UID, UploadCtxProvider, UploadList, UploadSource, LitUploaderBlock as UploaderBlock, type UploaderPlugin, UploaderPublicApi, UrlSource, defineComponents, defineLocale, loadFileUploaderFrom, toKebabCase };