@douyinfe/semi-foundation 2.1.1 → 2.1.2

package/lib/cjs/upload/constants.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.strings = exports.numbers = exports.cssClasses = void 0;
+
+var _constants = require("../base/constants");
+
+const PREFIX = "".concat(_constants.BASE_CLASS_PREFIX, "-upload");
+const FILE_LIST_PIC = 'picture';
+const FILE_LIST_DEFAULT = 'list';
+const PROGRESS_COEFFICIENT = 0.95;
+const cssClasses = {
+  PREFIX,
+  // WRAPPER: `${PREFIX}-wrapper`,
+  LIST: "".concat(PREFIX, "-list")
+};
+exports.cssClasses = cssClasses;
+const TRIGGER_AUTO = 'auto';
+const TRIGGER_CUSTOM = 'custom';
+const strings = {
+  FILE_STATUS_UPLOADING: 'uploading',
+  FILE_STATUS_SUCCESS: 'success',
+  FILE_STATUS_UPLOAD_FAIL: 'uploadFail',
+  FILE_STATUS_VALIDATING: 'validating',
+  FILE_STATUS_VALID_FAIL: 'validateFail',
+  FILE_STATUS_WAIT_UPLOAD: 'wait',
+  FILE_LIST_PIC,
+  FILE_LIST_DEFAULT,
+  LIST_TYPE: [FILE_LIST_PIC, FILE_LIST_DEFAULT],
+  imageTypes: ['image', 'webp', 'png', 'svg', 'gif', 'jpg', 'jpeg', 'bmp', 'dpg'],
+  DRAG_AREA_DEFAULT: 'default',
+  DRAG_AREA_LEGAL: 'legal',
+  DRAG_AREA_ILLEGAL: 'illegal',
+  TRIGGER_AUTO,
+  TRIGGER_CUSTOM,
+  UPLOAD_TRIGGER: [TRIGGER_AUTO, TRIGGER_CUSTOM],
+  VALIDATE_STATUS: _constants.VALIDATE_STATUS,
+  PROMPT_POSITION: ['left', 'right', 'bottom']
+};
+exports.strings = strings;
+const numbers = {
+  PROGRESS_COEFFICIENT
+};
+exports.numbers = numbers;

package/lib/cjs/upload/foundation.d.ts

@@ -0,0 +1,166 @@
+import BaseFoundation, { DefaultAdapter } from '../base/foundation';
+export interface XhrError extends Error {
+    status: XMLHttpRequest['status'];
+    method: string;
+    url: string;
+}
+export declare type FileItemStatus = 'success' | 'uploadFail' | 'validateFail' | 'validating' | 'uploading' | 'wait';
+export interface BaseFileItem {
+    showReplace?: boolean;
+    showRetry?: boolean;
+    response?: any;
+    event?: Event;
+    status: FileItemStatus;
+    name: string;
+    size: string;
+    uid: string;
+    url?: string;
+    fileInstance?: File;
+    percent?: number;
+    _sizeInvalid?: boolean;
+    preview?: boolean;
+    validateMessage?: unknown;
+    shouldUpload?: boolean;
+    [key: string]: any;
+}
+export interface CustomFile extends File {
+    uid?: string;
+    _sizeInvalid?: boolean;
+    status?: string;
+}
+export interface BeforeUploadObjectResult {
+    shouldUpload?: boolean;
+    status?: string;
+    autoRemove?: boolean;
+    validateMessage?: unknown;
+    fileInstance?: CustomFile;
+}
+export interface AfterUploadResult {
+    autoRemove?: boolean;
+    status?: string;
+    validateMessage?: unknown;
+    name?: string;
+}
+export interface UploadAdapter<P = Record<string, any>, S = Record<string, any>> extends DefaultAdapter<P, S> {
+    notifyFileSelect: (files: Array<CustomFile>) => void;
+    notifyError: (error: XhrError, fileInstance: File, fileList: Array<BaseFileItem>, xhr: XMLHttpRequest) => void;
+    notifySuccess: (body: any, fileInstance: File, newFileList: Array<BaseFileItem>) => void;
+    notifyProgress: (percent: number, fileInstance: File, newFileList: Array<BaseFileItem>) => void;
+    notifyRemove: (file: File, newFileList: Array<BaseFileItem>, fileItem: BaseFileItem) => void;
+    notifySizeError: (file: File, fileList: Array<BaseFileItem>) => void;
+    notifyExceed: (files: Array<File>) => void;
+    updateFileList: (newFileList: Array<BaseFileItem>, callback?: () => void) => void;
+    notifyBeforeUpload: ({ file, fileList }: {
+        file: BaseFileItem;
+        fileList: Array<BaseFileItem>;
+    }) => boolean | BeforeUploadObjectResult | Promise<BeforeUploadObjectResult>;
+    notifyAfterUpload: ({ response, file, fileList }: {
+        response: any;
+        file: BaseFileItem;
+        fileList: Array<BaseFileItem>;
+    }) => AfterUploadResult;
+    resetInput: () => void;
+    resetReplaceInput: () => void;
+    updateDragAreaStatus: (dragAreaStatus: string) => void;
+    notifyBeforeRemove: (file: BaseFileItem, fileList: Array<BaseFileItem>) => boolean | Promise<boolean>;
+    notifyBeforeClear: (fileList: Array<BaseFileItem>) => boolean | Promise<boolean>;
+    notifyChange: ({ currentFile, fileList }: {
+        currentFile: BaseFileItem | null;
+        fileList: Array<BaseFileItem>;
+    }) => void;
+    updateLocalUrls: (urls: Array<string>) => void;
+    notifyClear: () => void;
+    notifyPreviewClick: (file: any) => void;
+    notifyDrop: (e: any, files: Array<File>, fileList: Array<BaseFileItem>) => void;
+    notifyAcceptInvalid: (invalidFiles: Array<File>) => void;
+}
+declare class UploadFoundation<P = Record<string, any>, S = Record<string, any>> extends BaseFoundation<UploadAdapter<P, S>, P, S> {
+    constructor(adapter: UploadAdapter<P, S>);
+    destroy(): void;
+    getError({ action, xhr, message, fileName }: {
+        action: string;
+        xhr: XMLHttpRequest;
+        message?: string;
+        fileName: string;
+    }): XhrError;
+    getBody(xhr: XMLHttpRequest): any;
+    checkFileSize(file: File): boolean;
+    /**
+     * 1. 选择文件
+     * 2. transform转换. 添加uid
+     * 3. 检查文件个数是否超出
+     *   若超出，不添加到list中，触发onExceed，中止流程
+     *   若未超出，执行以下流程
+     * 4. 检查文件尺寸，添加尺寸是否合法的标识
+     * 5. 检查uploadTrigger是否为'auto'，若是执行步骤6-8
+     * 6. 遍历文件列表触发上传
+     *    - 对尺寸不合适的不需要触发上传
+     * 7. beforeUpload
+     *    - 对beforeUpload中设为不合法的不需要触发上传
+     * 8. TODO: check
+     * 9. afterUpload
+     *
+     * 1. Select file
+     * 2. transform, add uid
+     * 3. Check whether the number of files exceeds
+     *   If it exceeds, it is not added to the list, trigger onExceed, and abort the process
+     *   If it is not exceeded, execute the following process
+     * 4. check the file size, add the size is legal logo
+     * 5. Check whether the uploadTrigger is'auto ', if so, perform steps 6-8
+     * 6. Traversing the file list triggers upload
+     *    - No need to trigger uploads for inappropriate sizes
+     * 7. beforeUpload
+     *    - no need to trigger upload if beforeUpload is not set to be valid
+     * 8. TODO: check
+     * 9. afterUpload
+     */
+    handleChange(currentFileList: FileList | Array<File>): void;
+    handleReplaceChange(currentFileList: FileList | Array<File>): void;
+    buildFileItem(fileInstance: CustomFile, uploadTrigger: string): BaseFileItem;
+    replaceFileList(files: Array<CustomFile>): void;
+    addFilesToList(files: Array<CustomFile>): void;
+    manualUpload(): void;
+    startUpload(fileList: Array<BaseFileItem>): void;
+    upload(file: BaseFileItem): void;
+    handleBeforeUploadResultInObject(buResult: Partial<BeforeUploadObjectResult>, file: BaseFileItem): void;
+    post(file: BaseFileItem): void;
+    handleProgress({ e, fileInstance }: {
+        e: ProgressEvent;
+        fileInstance: File;
+    }): void;
+    handleOnLoad({ e, xhr, fileInstance }: {
+        e: ProgressEvent;
+        xhr: XMLHttpRequest;
+        fileInstance: File;
+    }): void;
+    handleSuccess({ e, fileInstance, isCustomRequest, xhr, response }: {
+        e: ProgressEvent;
+        fileInstance: CustomFile;
+        isCustomRequest?: boolean;
+        xhr?: XMLHttpRequest;
+        response?: any;
+    }): void;
+    _getFileIndex(file: CustomFile | BaseFileItem, fileList: Array<BaseFileItem>): number;
+    handleRemove(file: BaseFileItem): void;
+    handleError({ e, xhr, fileInstance }: {
+        e: ProgressEvent;
+        xhr: XMLHttpRequest;
+        fileInstance: CustomFile;
+    }): void;
+    handleClear(): void;
+    _createURL(fileInstance: CustomFile): string;
+    releaseMemory(): void;
+    _releaseBlob(url: string): void;
+    isImage(file: CustomFile): boolean;
+    isMultiple(): boolean;
+    _dragEnterTarget: EventTarget;
+    handleDragEnter(e: any): void;
+    handleDirectoryDrop(e: any): Promise<void>;
+    handleDrop(e: any): void;
+    handleDragOver(e: any): void;
+    handleDragLeave(e: any): void;
+    checkFileFormat(accept: string, file: File): boolean;
+    retry(fileItem: BaseFileItem): void;
+    handlePreviewClick(fileItem: BaseFileItem): void;
+}
+export default UploadFoundation;