@zjlab-fe/data-hub-ui 0.2.4 → 0.2.6

package/README.md

@@ -1,42 +1,42 @@
-## data-hub-ui
-
-### 使用
-
-`import { InputTag } from '@zjlab-fe/data-hub-ui`
-
-### 组件文档站点
-
-https://shelwinjue.github.io/fe-assets/data-hub-ui/doc
-
-
-
-### 新建组件
-
-在`src/components`目录下新建组件目录，参考组件`input-tag`的代码目录
-
-```
-component-folder
-├── demo // 确保是demo目录
-│    └── index.tsx // demo调试入口文件
-│
-├── index.module.scss // 组件的样式文件，使用css modules
-├── index.tsx // 组件入口文件
-└── README.md // 组件的说明文档，用于生成组件文档站点
-```
-
-### 增加组件demo路由
-
-为了调试组件，需要在`src/demo/router/index.tsx`中增加组件demo的路由配置
-
-### 组件库本地开发&调试
-
-`npm run start`
-
-### 组件README.md说明
-
-请在README.md中引入demo，用于代码演示，补充完整的API说明，可参考`src/components/input-tag/README.md`
-
-
-
-
-
+## data-hub-ui
+
+### 使用
+
+`import { InputTag } from '@zjlab-fe/data-hub-ui`
+
+### 组件文档站点
+
+https://shelwinjue.github.io/fe-assets/data-hub-ui/doc
+
+
+
+### 新建组件
+
+在`src/components`目录下新建组件目录，参考组件`input-tag`的代码目录
+
+```
+component-folder
+├── demo // 确保是demo目录
+│    └── index.tsx // demo调试入口文件
+│
+├── index.module.scss // 组件的样式文件，使用css modules
+├── index.tsx // 组件入口文件
+└── README.md // 组件的说明文档，用于生成组件文档站点
+```
+
+### 增加组件demo路由
+
+为了调试组件，需要在`src/demo/router/index.tsx`中增加组件demo的路由配置
+
+### 组件库本地开发&调试
+
+`npm run start`
+
+### 组件README.md说明
+
+请在README.md中引入demo，用于代码演示，补充完整的API说明，可参考`src/components/input-tag/README.md`
+
+
+
+
+

package/dist/types/components/FileUploader/FileUploadModal.d.ts

@@ -1,18 +1,12 @@
 import './utils/modalConfig.css';
 import { ModalProps } from 'antd';
-import { FileDraggerProps } from './FileUploaderFileDragger';
-import { FileInfo, UploadManager } from './types';
-export default function FileUploadModal({ config: { modal, dragArea }, ...props }: {
-    root?: string;
-    identifier: string;
-    showFinished?: boolean;
-    externalUploadContext?: FileInfo[];
-    onUploadSuccess?: (file: {
-        fileName: string;
-    }) => void;
-    extra?: React.ReactNode;
+import { FileUploaderProps } from './FileUploaderImpl/FileUploader';
+interface FileUploadModalProps extends Omit<FileUploaderProps, 'dragAreaConfig'> {
     config: {
         modal: ModalProps;
-        dragArea?: Omit<FileDraggerProps, 'onFileReceived'>;
+        dragArea?: FileUploaderProps['dragAreaConfig'];
+        uploadRequestConfig?: FileUploaderProps['uploadRequestConfig'];
     };
-} & UploadManager): import("react/jsx-runtime").JSX.Element;
+}
+export default function FileUploadModal({ config: { modal, dragArea }, ...props }: FileUploadModalProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/FileUploader/FileUploader.d.ts

@@ -1,9 +1,2 @@
-import { FileInfo, UploadableFile, UploadManager } from './types';
-import { FileUploaderProps } from './FileUploaderMain';
-export default function FileUploader(props: {
-    root?: string;
-    identifier: string;
-    showFinished?: boolean;
-    externalUploadContext?: FileInfo[];
-    onUploadSuccess?: (file: UploadableFile) => void;
-} & UploadManager & FileUploaderProps): import("react/jsx-runtime").JSX.Element;
+import { FileUploaderProps } from './FileUploaderImpl/FileUploader';
+export default function FileUploader(props: FileUploaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploader.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { FileReceiverProps } from './FileUploaderFileReceiver';
+import { FileUploaderContextProviderProps } from './FileUploaderContextProvider';
+interface FileUploaderImplProps {
+    extra?: React.ReactNode;
+    dragAreaConfig?: Omit<FileReceiverProps, 'onFileReceived'>;
+}
+export type FileUploaderProps = Omit<FileUploaderContextProviderProps, 'children'> & FileUploaderImplProps;
+export default function FileUploader({ extra, dragAreaConfig, ...props }: FileUploaderProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderContextProvider.d.ts

@@ -0,0 +1,17 @@
+import { FileInfo, UploadableFile, UploadManager } from '../types';
+import { AxiosRequestConfig } from 'axios';
+export declare const RootContext: import("react").Context<string | undefined>;
+export declare const IdentifierContext: import("react").Context<string>;
+export declare const ShowFinishedContext: import("react").Context<boolean | undefined>;
+export declare const ExternalUploadContextContext: import("react").Context<FileInfo[] | undefined>;
+export declare const UploadRequestConfigContext: import("react").Context<AxiosRequestConfig<Blob> | undefined>;
+export interface FileUploaderContextProviderProps extends UploadManager {
+    children: React.ReactNode;
+    root?: string;
+    identifier: string;
+    showFinished?: boolean;
+    externalUploadContext?: FileInfo[];
+    uploadRequestConfig?: AxiosRequestConfig<Blob>;
+    onUploadSuccess?: (file: UploadableFile) => void;
+}
+export default function FileUploaderContextProvider({ children, root, identifier, showFinished, uploadRequestConfig, externalUploadContext, onUploadSuccess, getUploadUrls, onCancelUpload, onOnePartDone, onAllPartDone, onDeleteFile, }: FileUploaderContextProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderFileReceiver.d.ts

@@ -0,0 +1,11 @@
+import './FileUploaderFileReceiver.css';
+import { ReactNode } from 'react';
+export interface FileReceiverProps {
+    accept?: string;
+    directory?: boolean;
+    dragAreaDescription?: ReactNode;
+    maxSizePerFile?: number;
+    className?: string;
+    onFileReceived: (_files: File[]) => void;
+}
+export default function FileUploaderFileReceiver({ accept, className, directory, dragAreaDescription, maxSizePerFile, onFileReceived, }: FileReceiverProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderFileReceiverContainer.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+export default function FileUploaderFileReceiverContainer({ className, description, onClick, handleDrop, }: {
+    className?: string;
+    description: ReactNode;
+    onClick: () => void;
+    handleDrop: (e: React.DragEvent<HTMLDivElement>) => Promise<void>;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderFileReceiverDesc.d.ts

@@ -0,0 +1,4 @@
+import { ReactNode } from 'react';
+export default function FileUploaderFileReceiverDesc({ description }: {
+    description: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderList.d.ts

@@ -0,0 +1 @@
+export default function FileUploadModalList(): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderListItem.d.ts

@@ -0,0 +1,26 @@
+import { ProgressProps } from 'antd';
+import { UploadableFile } from '../types';
+export declare const progressStyleProps: ProgressProps;
+declare const _default: import("react").NamedExoticComponent<{
+    file: UploadableFile;
+}>;
+export default _default;
+export declare function ListItemOutline({ children, className }: {
+    children: React.ReactNode;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function ListItemName({ fileName, className }: {
+    fileName: string;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function ListItemStatus({ className, fileStatus, percentage, strokeColor, }: {
+    className?: string;
+    fileStatus: string;
+    percentage: number;
+    strokeColor?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function ListItemActions({ onDelete, extraActions, className, }: {
+    onDelete: () => void;
+    extraActions?: React.ReactNode;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderListItemFail.d.ts

@@ -0,0 +1,5 @@
+import { UploadableFile } from '../types';
+declare const _default: import("react").NamedExoticComponent<{
+    file: UploadableFile;
+}>;
+export default _default;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderListItemPaused.d.ts

@@ -0,0 +1,5 @@
+import { UploadableFile } from '../types';
+declare const _default: import("react").NamedExoticComponent<{
+    file: UploadableFile;
+}>;
+export default _default;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderListItemUploading.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("react").NamedExoticComponent<object>;
+export default _default;

package/dist/types/components/FileUploader/FileUploaderImpl/FileUploaderlListItemFinished.d.ts

@@ -0,0 +1,5 @@
+import { UploadableFile } from '../types';
+declare const _default: import("react").NamedExoticComponent<{
+    file: UploadableFile;
+}>;
+export default _default;

package/dist/types/components/FileUploader/Locale/translations.d.ts

@@ -0,0 +1,4 @@
+export type Locale = Record<string, string>;
+declare const localeEn: Locale;
+declare const localeZh: Locale;
+export { localeEn, localeZh };

package/dist/types/components/FileUploader/Locale/useTranslate.d.ts

@@ -0,0 +1 @@
+export declare function useTranslate(): (key: string) => string;

package/dist/types/components/FileUploader/UploadStoreProvider/UploadStoreProvider.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { Dispath, OnUploadSuccesMap, UploadManagerMap, UploadStore, UploadStoreDispatch } from '../types';
+import { Locale } from '../Locale/translations';
+export declare const FileUploaderLocaleContext: React.Context<Locale>;
+export declare const AllUploaderManagersContext: React.Context<UploadManagerMap>;
+export declare const AllUploaderManagersDispatchContext: React.Context<Dispath<UploadManagerMap>>;
+export declare const AllOnUploadSuccessesContext: React.Context<OnUploadSuccesMap>;
+export declare const AllOnUploadSuccessesDispatchContext: React.Context<Dispath<OnUploadSuccesMap>>;
+export declare const TEMP_STORE: {};
+export declare const UploadStoreContext: React.Context<UploadStore>;
+export declare const UploadStoreDispatchContext: React.Context<UploadStoreDispatch>;
+export default function UploadStoreProvider({ locale, children, }: {
+    locale?: 'zh' | 'en';
+    children: React.ReactElement;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/FileUploader/UploadStoreProvider/uploadStoreReducer.d.ts

@@ -0,0 +1,4 @@
+import { UploadableFile, UploadStore, UploadStoreAction } from '../types';
+export declare function uploadReducer(uploads: UploadStore, action: UploadStoreAction): {
+    [x: string]: UploadableFile[];
+};

package/dist/types/components/FileUploader/UploadStoreProvider/useOnFileAllUploaded.d.ts

@@ -0,0 +1,2 @@
+import { UploadStore, UploadStoreAction } from '../types';
+export declare function useOnFileAllUploaded(uploadStore: UploadStore, setUploadStore: React.Dispatch<UploadStoreAction>): void;

package/dist/types/components/FileUploader/UploadStoreProvider/useSaveUnfinishedUploads.d.ts

@@ -0,0 +1,10 @@
+import { UploadableFile, UploadStore } from '../types';
+/**
+ * 未完成任务信息存储在localStorage而不是indexdb中，需要分别处理
+ * 因为之前的测试中发现，indexdb的存储方式在某些浏览器中会丢失数据
+ * 所以需要将未完成任务信息存储在localStorage中
+ *
+ * TODO: 将未完成任务信息存储在indexdb中
+ */
+export declare function useSaveUnfinishedUploads(uploadStore: UploadStore): void;
+export declare function formatUnfinishedUploads(uploads: UploadableFile[]): string;

package/dist/types/components/FileUploader/UploadStoreProvider/useSetupMergingEvent.d.ts

@@ -0,0 +1,2 @@
+import { UploadableFile, UploadManager, UploadStore, UploadStoreAction } from '../types';
+export declare function useSetupMergingEvent(uploadStore: UploadStore, allUploaderManagers: Record<string, UploadManager>, allOnUploadSuccesses: Record<string, ((file: UploadableFile) => void) | undefined>, setUploadStore: React.Dispatch<UploadStoreAction>): void;

package/dist/types/components/FileUploader/hooks/useCurrentFile.d.ts

@@ -1,14 +1,11 @@
-import { UploadableFile, FILE_UPLOAD_STATUS } from '../types';
+import { UploadableFile } from '../types';
 export declare const currentFileAtom: import("jotai").PrimitiveAtom<UploadableFile | null> & {
     init: UploadableFile | null;
 };
 export declare const currentFileNameAtom: import("jotai").Atom<string | undefined>;
-export declare const currentFileStatusAtom: import("jotai").Atom<FILE_UPLOAD_STATUS | undefined>;
 export declare const currentFileExpiryTimeAtom: import("jotai").Atom<string | undefined>;
 export declare const currentFileUploadIdAtom: import("jotai").Atom<string | undefined>;
 export declare const currentFileRawAtom: import("jotai").Atom<File | undefined>;
 export declare const currentFilePercentageAtom: import("jotai").Atom<number | undefined>;
-export declare const currentFileCancelControllersAtom: import("jotai").Atom<{
-    [key: string]: AbortController;
-} | undefined>;
+export declare const currentFileCancelControllersAtom: import("jotai").Atom<AbortController[] | undefined>;
 export declare function useCurrentFile(): void;

package/dist/types/components/FileUploader/hooks/useCurrentFileOnUploading.d.ts

@@ -1,5 +1,5 @@
 import { UploadUrl } from '../types';
-export declare function useOnUploading(): (chunks: {
+export declare function useCurrentFileOnUploading(): (chunks: {
     url: UploadUrl;
     chunk: Blob;
 }[]) => Promise<void>;

package/dist/types/components/FileUploader/hooks/useCurrentFileSetupAndBackUp.d.ts

@@ -0,0 +1 @@
+export declare function useCurrentFileSetupAndBackUp(): void;

package/dist/types/components/FileUploader/hooks/useFormatFiles.d.ts

@@ -1 +1,4 @@
-export declare function useFormatFiles(): (allFiles: File[]) => Promise<void>;
+export declare function useFormatFiles(): {
+    isFormatingFiles: boolean;
+    formatFiles: (allFiles: File[]) => Promise<void>;
+};

package/dist/types/components/FileUploader/hooks/useFormatFilesFindDuplicates.d.ts

@@ -0,0 +1 @@
+export declare function useFindDuplicates(): (files: File[]) => Promise<[boolean, Set<string>]>;

package/dist/types/components/FileUploader/hooks/useFormatFilesRemoveDuplicates.d.ts

@@ -0,0 +1 @@
+export declare function useRemoveDuplicates(): (duplicationOfName: Set<string>) => void;

package/dist/types/components/FileUploader/hooks/useHandleChunkCompletion.d.ts

@@ -0,0 +1,2 @@
+import { UploadUrl } from '../types';
+export declare function useHandleChunkCompletion(identifier: string): (urlInfo: UploadUrl) => Promise<void>;

package/dist/types/components/FileUploader/hooks/useHandleFileDrop.d.ts

@@ -0,0 +1 @@
+export declare function useHandleFileDrop(directory: boolean, acceptList: Set<string>, triggerOnFileReceived: (files: File[]) => void): (e: React.DragEvent<HTMLDivElement>) => Promise<void>;

package/dist/types/components/FileUploader/hooks/useOnMountedResumeUnfinished.d.ts

@@ -0,0 +1 @@
+export declare function useOnMountedResumeUnfinished(identifier: string): () => Promise<void>;

package/dist/types/components/FileUploader/hooks/useUploadChunk.d.ts

@@ -0,0 +1,2 @@
+import { UploadUrl } from '../types';
+export declare function useUploadChunk(): (urlInfo: UploadUrl, chunk: Blob) => Promise<void>;

package/dist/types/components/FileUploader/index.d.ts

@@ -1,5 +1,5 @@
 import './index.css';
-import UploadStoreProvider from './UploadStoreProvider';
+import UploadStoreProvider from './UploadStoreProvider/UploadStoreProvider';
 import FileUploader from './FileUploader';
 import FileUploadModal from './FileUploadModal';
 export { UploadStoreProvider };

package/dist/types/components/FileUploader/types.d.ts

@@ -6,10 +6,11 @@ export declare const enum FILE_UPLOAD_STATUS {
     INIT = 1,
     UPLOADING = 2,
     ALL_UPLOADED = 3,
-    FINISHED = 4,
-    FAILED = 5,
-    PAUSED = 6,
-    CANCELED = 7
+    MERGING = 4,
+    FINISHED = 5,
+    FAILED = 6,
+    PAUSED = 7,
+    CANCELED = 8
 }
 export type UploadableFile = {
     raw?: File;
@@ -24,9 +25,7 @@ export type UploadableFile = {
     uploadUrls: UploadUrl[];
     completeSeq: UploadUrl[];
     fileStatus: FILE_UPLOAD_STATUS;
-    cancelControllers: {
-        [key: string]: AbortController;
-    };
+    cancelControllers: AbortController[];
 };
 export type FileInfo = {
     fileName: string;
@@ -57,4 +56,38 @@ export type UploadManager = {
     }>;
     onDeleteFile?: (filePath: string) => Promise<boolean>;
 };
+export type UploadManagerMap = Record<string, UploadManager>;
+type OnUploadSucces = ((file: UploadableFile) => void) | undefined;
+export type OnUploadSuccesMap = Record<string, OnUploadSucces>;
+export type Dispath<T> = React.Dispatch<React.SetStateAction<T>>;
+export type UploadStore = {
+    [key: string]: UploadableFile[];
+};
+export type UploadStoreAction = {
+    type: 'add';
+    identifier: string | number;
+} | {
+    type: 'edit_file';
+    identifier: string | number;
+    file: UploadableFile;
+} | {
+    type: 'edit_files';
+    files: Record<string, UploadableFile[]>;
+} | {
+    type: 'remove_file';
+    identifier: string | number;
+    fileName: string;
+} | {
+    type: 'add_file';
+    identifier: string | number;
+    file: UploadableFile;
+} | {
+    type: 'clear_finished';
+    identifier: string | number;
+} | {
+    type: 'add_files';
+    identifier: string | number;
+    files: UploadableFile[];
+};
+export type UploadStoreDispatch = React.Dispatch<UploadStoreAction>;
 export {};

package/dist/types/demo/layout/index.d.ts

@@ -0,0 +1,2 @@
+declare function Layout(): import("react/jsx-runtime").JSX.Element;
+export default Layout;