import { OzoneAPIRequest } from 'ozone-api-request'; import { OzoneClient } from 'ozone-typescript-client'; import TaskHandlerOption = OzoneClient.TaskHandlerOption; export interface UploadSessionResult { file: FormData; sessionId: string; } export interface UploadIdResult extends UploadSessionResult { uploadId: string; folderId: string; } export interface UploadFileId { uploadFileId: string; } export interface UploadEndResult extends UploadIdResult, UploadFileId { } export interface TaskResult { mediaId: string; asyncTasksGroupId?: string; } export interface TaskExecutions { completed?: boolean; isComplete?: boolean; stepsCout: number; stepsDone: number; taskResult?: TaskResult; } export interface WaitResponse { groupId: string; hasErrors: boolean; stepsCount: number; stepsDone: number; taskExecutions: { [key: string]: TaskExecutions; }; } export interface XMLHttpRequestLike { upload: { onprogress: { (event: Event): void; }; onloadstart: { (event: Event): void; }; }; onreadystatechange?: { (): void; }; readonly readyState: number; readonly status: number; open(method: string, url: string, async: boolean): void; send(formData: FormData): void; abort(): void; setRequestHeader(key: string, value: string): void; } /** * UploadFileRequest is a JavaScrip class that can be use as an * XMLHttpRequest to upload media using ozone v2 upload chanel. * It mask the complex series of AJAX call to one XMLHttpRequest like request. * Note: that UploadFileRequest implement only a subset of XMLHttpRequest * * example: * ```javaScript * import {UploadFileRequest} from 'ozone-api-upload' * const uploader = new UploadFileRequest(); * uploader.open(); * const formData = new FormData(); * formData.append(file.formDataName, file, file.name); * uploader.send(formData); * ``` * * ### Events * * *ozone-upload-completed*: *CustomEvent* * Fired when upload is complete with detail: {mediaId: uuid} * */ export declare class UploadFileRequest implements XMLHttpRequestLike { /** * Minimalist XMLHttpRequest.upload interface. */ upload: { onprogress: { (event: Event): void; }; onloadstart: { (event: Event): void; }; }; /** * XMLHttpRequest.onreadystatechange event handler */ onreadystatechange?: { (): void; }; private callOneadystatechange; /** * set the interval to verify ozone has finish the element processing * @type {number} poll interval in ms */ pollInterval: number; /** * XMLHttpRequest.readyState * @type {number} */ get readyState(): number; private set _readyState(value); private _internalReadyState; /** * XMLHttpRequest.status * @type {number} */ status: number; /** * Set target for dispatchEvent. * @type {Node} */ eventTarget?: Node; private _mediaId; /** * Accessor to uploaded media id. * default value is null * * @return {string | null} */ get mediaId(): string | null; private isAbort; private currentRequest; constructor(); /** * like an XMLHttpRequest.open() * Parameters passed are not used. * method and URL come from the config file. * Request will always be async. * * @param {string} method * @param {string} url * @param {boolean} async */ open(method: string, url: string, async?: boolean): void; /** * like an XMLHttpRequest.send() * start async process to upload the file inside the form. * @param {FormData} formData * @return {Promise} */ send(formData: FormData): Promise; /** * like XMLHttpRequest.abort() * cancel current upload process */ abort(): void; /** * unused. * @param {string} key * @param {string} value */ setRequestHeader(key: string, value: string): void; protected _createRequest(): OzoneAPIRequest; private _buildUrl; private createBlob; private submitTask; /** * alias to send method. * @param {FormData} formData * @param {string} folderId * @param options TaskHandlerOption * @return {Promise} */ uploadFile(formData: FormData, folderId?: string, options?: TaskHandlerOption): Promise; _waitForTask(taskId: string, options: TaskHandlerOption): Promise; }