nuxt-upload-kit 0.1.1

package/dist/runtime/composables/useUploadKit/index.d.ts

@@ -0,0 +1,471 @@
+import type { UploaderEvents, UploadFile, UploadOptions, UploadStatus, UploadFn, GetRemoteFileFn, Plugin as UploaderPlugin } from "./types.js";
+export declare const useUploadKit: <TUploadResult = any>(_options?: UploadOptions) => {
+    files: Readonly<import("@vue/reactivity").Ref<readonly ({
+        readonly source: "local";
+        readonly data: {
+            readonly lastModified: number;
+            readonly name: string;
+            readonly webkitRelativePath: string;
+            readonly size: number;
+            readonly type: string;
+            readonly arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            readonly bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            readonly slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            readonly stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            readonly text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        } | {
+            readonly size: number;
+            readonly type: string;
+            readonly arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            readonly bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            readonly slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            readonly stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            readonly text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        };
+        readonly remoteUrl?: string | undefined;
+        readonly id: string;
+        readonly name: string;
+        readonly size: number;
+        readonly mimeType: string;
+        readonly status: import("./types.js").FileStatus;
+        readonly preview?: string | undefined;
+        readonly progress: {
+            readonly percentage: number;
+        };
+        readonly error?: {
+            readonly message: string;
+            readonly details?: Readonly<unknown> | undefined;
+        } | undefined;
+        readonly uploadResult?: import("@vue/reactivity").DeepReadonly<import("@vue/reactivity").UnwrapRef<TUploadResult>> | undefined;
+        readonly meta: {
+            readonly [x: string]: Readonly<unknown>;
+        };
+    } | {
+        readonly source: Exclude<import("./types.js").FileSource, "local">;
+        readonly data: null;
+        readonly remoteUrl: string;
+        readonly id: string;
+        readonly name: string;
+        readonly size: number;
+        readonly mimeType: string;
+        readonly status: import("./types.js").FileStatus;
+        readonly preview?: string | undefined;
+        readonly progress: {
+            readonly percentage: number;
+        };
+        readonly error?: {
+            readonly message: string;
+            readonly details?: Readonly<unknown> | undefined;
+        } | undefined;
+        readonly uploadResult?: import("@vue/reactivity").DeepReadonly<import("@vue/reactivity").UnwrapRef<TUploadResult>> | undefined;
+        readonly meta: {
+            readonly [x: string]: Readonly<unknown>;
+        };
+    })[], readonly ({
+        readonly source: "local";
+        readonly data: {
+            readonly lastModified: number;
+            readonly name: string;
+            readonly webkitRelativePath: string;
+            readonly size: number;
+            readonly type: string;
+            readonly arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            readonly bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            readonly slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            readonly stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            readonly text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        } | {
+            readonly size: number;
+            readonly type: string;
+            readonly arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            readonly bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            readonly slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            readonly stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            readonly text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        };
+        readonly remoteUrl?: string | undefined;
+        readonly id: string;
+        readonly name: string;
+        readonly size: number;
+        readonly mimeType: string;
+        readonly status: import("./types.js").FileStatus;
+        readonly preview?: string | undefined;
+        readonly progress: {
+            readonly percentage: number;
+        };
+        readonly error?: {
+            readonly message: string;
+            readonly details?: Readonly<unknown> | undefined;
+        } | undefined;
+        readonly uploadResult?: import("@vue/reactivity").DeepReadonly<import("@vue/reactivity").UnwrapRef<TUploadResult>> | undefined;
+        readonly meta: {
+            readonly [x: string]: Readonly<unknown>;
+        };
+    } | {
+        readonly source: Exclude<import("./types.js").FileSource, "local">;
+        readonly data: null;
+        readonly remoteUrl: string;
+        readonly id: string;
+        readonly name: string;
+        readonly size: number;
+        readonly mimeType: string;
+        readonly status: import("./types.js").FileStatus;
+        readonly preview?: string | undefined;
+        readonly progress: {
+            readonly percentage: number;
+        };
+        readonly error?: {
+            readonly message: string;
+            readonly details?: Readonly<unknown> | undefined;
+        } | undefined;
+        readonly uploadResult?: import("@vue/reactivity").DeepReadonly<import("@vue/reactivity").UnwrapRef<TUploadResult>> | undefined;
+        readonly meta: {
+            readonly [x: string]: Readonly<unknown>;
+        };
+    })[]>>;
+    totalProgress: import("@vue/reactivity").ComputedRef<number>;
+    addFiles: (newFiles: File[]) => Promise<UploadFile[]>;
+    addFile: (file: File) => Promise<UploadFile>;
+    onGetRemoteFile: (fn: GetRemoteFileFn) => void;
+    onUpload: (fn: UploadFn<TUploadResult>) => void;
+    removeFile: (fileId: string) => Promise<void>;
+    removeFiles: (fileIds: string[]) => ({
+        source: "local";
+        data: {
+            readonly lastModified: number;
+            readonly name: string;
+            readonly webkitRelativePath: string;
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        } | {
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        };
+        remoteUrl?: string | undefined;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    } | {
+        source: Exclude<import("./types.js").FileSource, "local">;
+        data: null;
+        remoteUrl: string;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    })[];
+    clearFiles: () => ({
+        source: "local";
+        data: {
+            readonly lastModified: number;
+            readonly name: string;
+            readonly webkitRelativePath: string;
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        } | {
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        };
+        remoteUrl?: string | undefined;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    } | {
+        source: Exclude<import("./types.js").FileSource, "local">;
+        data: null;
+        remoteUrl: string;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    })[];
+    reorderFile: (oldIndex: number, newIndex: number) => void;
+    getFile: (fileId: string) => {
+        source: "local";
+        data: {
+            readonly lastModified: number;
+            readonly name: string;
+            readonly webkitRelativePath: string;
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        } | {
+            readonly size: number;
+            readonly type: string;
+            arrayBuffer: {
+                (): Promise<ArrayBuffer>;
+                (): Promise<ArrayBuffer>;
+            };
+            bytes: {
+                (): Promise<Uint8Array<ArrayBuffer>>;
+                (): Promise<Uint8Array<ArrayBuffer>>;
+            };
+            slice: {
+                (start?: number, end?: number, contentType?: string): Blob;
+                (start?: number, end?: number, contentType?: string): Blob;
+            };
+            stream: {
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+                (): ReadableStream<Uint8Array<ArrayBuffer>>;
+            };
+            text: {
+                (): Promise<string>;
+                (): Promise<string>;
+            };
+        };
+        remoteUrl?: string | undefined;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    } | {
+        source: Exclude<import("./types.js").FileSource, "local">;
+        data: null;
+        remoteUrl: string;
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+        status: import("./types.js").FileStatus;
+        preview?: string | undefined;
+        progress: {
+            percentage: number;
+        };
+        error?: {
+            message: string;
+            details?: unknown;
+        } | undefined;
+        uploadResult?: import("@vue/reactivity").UnwrapRef<TUploadResult> | undefined;
+        meta: Record<string, unknown>;
+    };
+    upload: () => Promise<void>;
+    reset: () => void;
+    status: import("@vue/reactivity").Ref<UploadStatus, UploadStatus>;
+    getFileData: (fileId: string) => Promise<Blob>;
+    getFileURL: (fileId: string) => Promise<string>;
+    getFileStream: (fileId: string) => Promise<ReadableStream<Uint8Array>>;
+    replaceFileData: (fileId: string, newData: Blob, newName?: string, shouldAutoUpload?: boolean) => Promise<UploadFile>;
+    updateFile: (fileId: string, updatedFile: Partial<UploadFile<TUploadResult>>) => void;
+    initializeExistingFiles: (initialFiles: Array<Partial<UploadFile>>) => Promise<void>;
+    addPlugin: (plugin: UploaderPlugin<any, any>) => void;
+    on: {
+        <K extends keyof UploaderEvents<TUploadResult>>(type: K, handler: (event: UploaderEvents<TUploadResult>[K]) => void): void;
+        (type: string, handler: (event: any) => void): void;
+    };
+};