breakpoint-transfer-plugin 0.0.1

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "breakpoint-transfer-plugin",
+  "version": "v0.0.1",
+  "description": "JavaScript JDK plugin for implementing breakpoint continuation",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "typings": "typings/index.d.ts",
+  "files": [
+    "dist",
+    "typings"
+  ],
+  "scripts": {
+    "lint": "eslint --fix --ext .ts src --quiet",
+    "prepare": "husky install",
+    "build": "rollup --config rollup.config.ts --configPlugin typescript"
+  },
+  "keywords": [
+    "upload",
+    "big-file",
+    "breakpoint continuation"
+  ],
+  "homepage": "https://lvdaxianer.github.io/breakpoint-transfer-plugin",
+  "author": "lihh",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "prettier": "^3.3.2",
+    "rollup": "^4.18.0",
+    "rollup-plugin-del": "^1.0.1",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "typescript": "^5.5.3",
+    "vue": "^3.4.21"
+  },
+  "dependencies": {
+    "i18next": "^23.11.5",
+    "jsmethod-extra": "^2.0.7",
+    "localforage": "^1.10.0"
+  }
+}

package/typings/index.d.ts

@@ -0,0 +1,217 @@
+export { SubscriberSort, emitterAndTaker, equals, isHas, isNotEmpty, strFormat } from 'jsmethod-extra';
+
+declare enum UploadProgressState {
+    Prepare = "Prepare",
+    HashCalculationWaiting = "HashCalculationWaiting",
+    Waiting = "Waiting",
+    WaitAddQueue = "WaitAddQueue",
+    Uploading = "Uploading",
+    Merge = "Merge",
+    Done = "Done",
+    QuickUpload = "QuickUpload",
+    BreakPointUpload = "BreakPointUpload",
+    OtherUploading = "OtherUploading",
+    Pause = "Pause",
+    PauseRetry = "PauseRetry",
+    Canceled = "Canceled",
+    RequestError = "RequestError",
+    Retry = "Retry",
+    NetworkDisconnected = "NetworkDisconnected",
+    RetryFailed = "RetryFailed",
+    RefreshRetry = "RefreshRetry"
+}
+type QueueElementBase = Partial<{
+    type: UploadProgressState;
+    uniqueCode: string;
+    fileSize: number;
+    progress: number;
+    networkSpeed: number;
+    fileName: string;
+    uploadFile: File;
+    retryTimes: number;
+    requestErrorMsg: string;
+}>;
+type UploadConfigType = Partial<{
+    maxRetryTimes: number;
+    baseNetworkSpeed: number;
+    concurrentLimit: number;
+    persist: boolean;
+    language: LanguageEnumType;
+    maxHashNameCount: number;
+}> & {
+    req: {
+        listFilesReq: IListFilesReq | null;
+        sectionUploadReq: ISectionUploadReq | null;
+        mergeUploadReq: IMergeUploadReq | null;
+        verifyFileExistReq: IVerifyFileExistReq | null;
+    };
+};
+interface CurrentType<T = null> {
+    current: T;
+}
+type ProgressReturnType = [baseDir: string, fileName: string];
+declare enum LocalforageTypeEnum {
+    p1 = "p1",
+    p2 = "p2"
+}
+type ICommonResponse<T = unknown> = {
+    data: T;
+    message?: string;
+    msg?: string;
+    success?: boolean;
+    code: number;
+};
+declare enum HTTPEnumState {
+    OK = "200"
+}
+declare enum LanguageEnumType {
+    EN = "en",
+    ZH = "zh",
+    JA_JP = "ja_JP"
+}
+type IListFilesReq = (calculationHashCode: string) => Promise<ICommonResponse<[number, number]>>;
+type ISectionUploadReq = (calculationHashCode: string, chunkFileName: string, formData: FormData) => Promise<ICommonResponse<boolean>>;
+type IMergeUploadReq = (calculationHashCode: string, fileName: string) => Promise<ICommonResponse>;
+type IVerifyFileExistReq = (calculationHashName: string) => Promise<ICommonResponse<boolean>>;
+
+declare const UploadProgressStateText: Record<Required<UploadProgressState>, Record<LanguageEnumType, string>>;
+declare const COMPUTE_NETWORK_BYTE_SIZE: number;
+declare const UPLOADING_FILE_SUBSCRIBE_DEFINE = "UPLOADING_FILE_SUBSCRIBE_DEFINE";
+declare const REVERSE_CONTAINER_ACTION = "REVERSE_CONTAINER_ACTION";
+declare const SERVER_REQUEST_FAIL_MSG = "fetch fail, \u8BF7\u68C0\u67E5\u670D\u52A1";
+declare const NO_MESSAGE_DEFAULT_VALUE = "\u672A\u63D0\u4F9B\u9519\u8BEF\u6D88\u606F";
+declare const INNER_PROGRESS_CONST = "innerProgress";
+declare const CURRENT_CONSUME_BYTES = "currentConsumeBytes";
+declare const FILE_SIZE_CONST = "fileSize";
+declare const UPLOAD_FILE_CONST = "uploadFile";
+declare const EXT_NAME_CONST = "extName";
+declare const NETWORK_SPEED_CONST = "networkSpeed";
+declare const UPLOAD_CONFIG_KEYS: {
+    FILE_NAME: "fileName";
+    UNIQUE_CODE: "uniqueCode";
+    FILE_SIZE: string;
+    EXT_NAME: string;
+    UPLOAD_FILE: string;
+    INNER_PROGRESS: string;
+    CURRENT_CONSUME_BYTES_KEY: string;
+    NETWORK_SPEED: string;
+    CALCULATION_HASH_NAME: "calculationHashName";
+};
+declare const SPEED_TEST_PREFIX = "__speed_test__";
+declare const SYNC_NUMERIC_VALUE_KEYS: ReadonlySet<string>;
+declare const SOME_CONSTANT_VALUES: {
+    KEY1: string;
+    KEY2: string;
+    KEY3: string;
+    KEY4: string;
+    KEY5: string;
+    KEY6: string;
+    KEY7: string;
+    KEY8: string;
+    KEY9: string;
+    KEY10: string;
+};
+declare const zhLanguage: Record<string, string>;
+declare const jpLanguage: Record<string, string>;
+declare const enLanguage: Record<string, string>;
+
+/**
+ * 固定小数点的方法
+ *
+ * @author lihh
+ * @param size 大小
+ * @param count 个数
+ */
+declare function toFixedHandler(size: number, count: number): number;
+
+/**
+ * 选择的多语言
+ *
+ * @author lihh
+ * @param key 设置类型
+ */
+declare function getLng(key: UploadProgressState): string;
+
+/**
+ * 重新 上传文件
+ *
+ * @author lihh
+ * @param uniqueCode 文件 唯一的code
+ * @param newType 要修改的状态
+ */
+declare function restartUploadFileHandler(uniqueCode: string, newType: UploadProgressState): Promise<void>;
+/**
+ * 相同文件 是否继续下载
+ *
+ * @author lihh
+ * @param uniqueCode 文件 唯一的code
+ */
+declare function sameFileNeedProceedHandler(uniqueCode: string): Promise<void>;
+/**
+ * 正常 异常结束的事件
+ *
+ * @author lihh
+ * @param el queue 消息
+ */
+declare function progressNormalOrErrorCompletionHandler(el: QueueElementBase): void;
+/**
+ * 清除 缓存状态
+ *
+ * @author lihh
+ */
+declare function clearCacheStateHandler(uniqueCode: string): void;
+/**
+ * 计算断点续传的索引
+ *
+ * @author lihh
+ * @param calculationHashCode web worker 计算的code
+ * @param uniqueCode 表示唯一的code
+ */
+declare function computedBreakPointProgressHandler(calculationHashCode: string, uniqueCode: string): Promise<number>;
+/**
+ * 分割文件 上传事件
+ *
+ * @author lihh
+ * @param uniqueCode 唯一的code
+ * @param calculationHashCode web worker 计算的hashCode
+ * @param idx 索引的值
+ * @param retryTimes 重试次数
+ */
+declare function splitFileUploadingHandler(uniqueCode: string, calculationHashCode: string, idx: number, retryTimes?: number): Promise<void>;
+/**
+ * 开始执行任务
+ *
+ * @author lihh
+ * @param calculationHashCode 通过 webWorker 计算的hash值
+ * @param uniqueCode 唯一的值
+ */
+declare function startUploadFileNextHandler(calculationHashCode: string, uniqueCode: string): Promise<void>;
+/**
+ * 开始上传文件
+ *
+ * @author lihh
+ * @param calculationHashName 通过web worker 计算的hash名称
+ * @param uniqueCode 生成的唯一 code
+ */
+declare function startUploadFileHandler(calculationHashName: string, uniqueCode: string): Promise<void>;
+/**
+ * 这里生成任务 能让任务处理等待状态
+ *
+ * @author lihh
+ * @param uniqueCode 每个文件对应 唯一的值
+ */
+declare function generatorTask(uniqueCode: string): void;
+/**
+ * 表示上传的事件
+ *
+ * @author lihh
+ * @param uploadFile 要上传的文件
+ * @param callback 默认的回调方法
+ */
+declare function uploadHandler(uploadFile: File, callback?: (arr: ProgressReturnType) => void): Promise<ProgressReturnType>;
+declare namespace uploadHandler {
+    var config: (config: UploadConfigType) => void;
+    var lng: (language?: LanguageEnumType) => Promise<void>;
+}
+
+export { COMPUTE_NETWORK_BYTE_SIZE, CURRENT_CONSUME_BYTES, type CurrentType, EXT_NAME_CONST, FILE_SIZE_CONST, HTTPEnumState, type ICommonResponse, type IListFilesReq, type IMergeUploadReq, INNER_PROGRESS_CONST, type ISectionUploadReq, type IVerifyFileExistReq, LanguageEnumType, LocalforageTypeEnum, NETWORK_SPEED_CONST, NO_MESSAGE_DEFAULT_VALUE, type ProgressReturnType, type QueueElementBase, REVERSE_CONTAINER_ACTION, SERVER_REQUEST_FAIL_MSG, SOME_CONSTANT_VALUES, SPEED_TEST_PREFIX, SYNC_NUMERIC_VALUE_KEYS, UPLOADING_FILE_SUBSCRIBE_DEFINE, UPLOAD_CONFIG_KEYS, UPLOAD_FILE_CONST, type UploadConfigType, UploadProgressState, UploadProgressStateText, clearCacheStateHandler, computedBreakPointProgressHandler, enLanguage, generatorTask, getLng, jpLanguage, progressNormalOrErrorCompletionHandler, restartUploadFileHandler, sameFileNeedProceedHandler, splitFileUploadingHandler, startUploadFileHandler, startUploadFileNextHandler, toFixedHandler, uploadHandler, zhLanguage };