xframelib 0.7.3 → 0.7.5

package/dist/utils/BigFileDownload.d.ts

@@ -1,117 +1,117 @@
-/**
- * 下载文件信息模型
- */
-export interface IFileMeta {
-    id?: string;
-    name: string;
-    length: number;
-    downloadID: string;
-    chunkSize?: number;
-}
-/**
- * 文件下载事件
- */
-export type FileDownloadEvent = 'init' | 'info' | 'error' | 'downloadProgress' | 'saveProgress' | 'success';
-/**
- * 大文件分片/断点续传下载
- */
-export declare class BigFileDownload {
-    private fileID;
-    private downloadURL?;
-    ChunkUnitM: number;
-    private chunkByteSize;
-    private totalChunks;
-    private currentDB?;
-    private keys?;
-    private fileMetaData;
-    private finishNum;
-    private eventTarget;
-    private cancelSource;
-    private isStarting;
-    private fileName?;
-    private cacheSize;
-    private requestTimeout;
-    /**
-     *
-     * @param fileID
-     * @param downloadURL 下载链接(可空)
-     * @param chunkSizeM 分片大小，默认为3M
-     * @param cacheNum 缓存大小
-     * @param requestTimeoutMS 请求超时时间(毫秒)默认为60s
-     */
-    constructor(fileID: string, downloadURL?: string | undefined, chunkSizeM?: number, cacheNum?: number, requestTimeoutMS?: number);
-    /**
-     * 订阅事件
-     */
-    on(eventName: FileDownloadEvent, fn: (event: any) => void): void;
-    /**
-     * 发送消息
-     */
-    private dispatch;
-    /**
-     * 抛出异常信息
-     * @param data 异常描述
-     */
-    private dispatchError;
-    /**
-     * 推送文字进度
-     * @param data 文字消息
-     */
-    private dispatchInfo;
-    /**
-     * Get请求获取文件元数据信息
-     * @param baseURL 根URL路径
-     * @param apiPath  方法路径
-     * @param queryParams 请求参数
-     * @returns IFileMeta
-     */
-    queryDownloadFileMeta(baseURL: string, apiPath?: string, queryParams?: any): Promise<IFileMeta | null>;
-    /**
-     *获取本地的File元数据信息
-     */
-    getIFileMeta(): Promise<IFileMeta | null>;
-    /**
-     * 初始化信息
-     */
-    private initIndexDB;
-    /**
-     * 初始化要下载的文件元数据
-     * @param url 下载路径
-     * @returns
-     */
-    init(fileMeta: IFileMeta): Promise<void>;
-    /**
-     * 获取分片大小
-     * @returns
-     */
-    getTotalChunks(): number;
-    /**
-     * 暂停下载
-     */
-    pause(): void;
-    /**
-     * 重新开始
-     */
-    restart(): void;
-    /**
-     * 删除下载任务
-     */
-    delete(): void;
-    sleep(ms: any): Promise<unknown>;
-    /**
-     * 开始分段下载
-     */
-    download(downloadAPI?: string, baseURL?: string): Promise<void>;
-    /**
-     * 下载完成进度
-     */
-    private downloadProgress;
-    /**
-     * 输出保存文件进度-分片统计
-     */
-    private outputProgress;
-    /**
-     * 保存文件
-     */
-    private savefile;
-}
+/**
+ * 下载文件信息模型
+ */
+export interface IFileMeta {
+    id?: string;
+    name: string;
+    length: number;
+    downloadID: string;
+    chunkSize?: number;
+}
+/**
+ * 文件下载事件
+ */
+export type FileDownloadEvent = 'init' | 'info' | 'error' | 'downloadProgress' | 'saveProgress' | 'success';
+/**
+ * 大文件分片/断点续传下载
+ */
+export declare class BigFileDownload {
+    private fileID;
+    private downloadURL?;
+    ChunkUnitM: number;
+    private chunkByteSize;
+    private totalChunks;
+    private currentDB?;
+    private keys?;
+    private fileMetaData;
+    private finishNum;
+    private eventTarget;
+    private cancelSource;
+    private isStarting;
+    private fileName?;
+    private cacheSize;
+    private requestTimeout;
+    /**
+     *
+     * @param fileID
+     * @param downloadURL 下载链接(可空)
+     * @param chunkSizeM 分片大小，默认为3M
+     * @param cacheNum 缓存大小
+     * @param requestTimeoutMS 请求超时时间(毫秒)默认为60s
+     */
+    constructor(fileID: string, downloadURL?: string | undefined, chunkSizeM?: number, cacheNum?: number, requestTimeoutMS?: number);
+    /**
+     * 订阅事件
+     */
+    on(eventName: FileDownloadEvent, fn: (event: any) => void): void;
+    /**
+     * 发送消息
+     */
+    private dispatch;
+    /**
+     * 抛出异常信息
+     * @param data 异常描述
+     */
+    private dispatchError;
+    /**
+     * 推送文字进度
+     * @param data 文字消息
+     */
+    private dispatchInfo;
+    /**
+     * Get请求获取文件元数据信息
+     * @param baseURL 根URL路径
+     * @param apiPath  方法路径
+     * @param queryParams 请求参数
+     * @returns IFileMeta
+     */
+    queryDownloadFileMeta(baseURL: string, apiPath?: string, queryParams?: any): Promise<IFileMeta | null>;
+    /**
+     *获取本地的File元数据信息
+     */
+    getIFileMeta(): Promise<IFileMeta | null>;
+    /**
+     * 初始化信息
+     */
+    private initIndexDB;
+    /**
+     * 初始化要下载的文件元数据
+     * @param url 下载路径
+     * @returns
+     */
+    init(fileMeta: IFileMeta): Promise<void>;
+    /**
+     * 获取分片大小
+     * @returns
+     */
+    getTotalChunks(): number;
+    /**
+     * 暂停下载
+     */
+    pause(): void;
+    /**
+     * 重新开始
+     */
+    restart(): void;
+    /**
+     * 删除下载任务
+     */
+    delete(): void;
+    sleep(ms: any): Promise<unknown>;
+    /**
+     * 开始分段下载
+     */
+    download(downloadAPI?: string, baseURL?: string): Promise<void>;
+    /**
+     * 下载完成进度
+     */
+    private downloadProgress;
+    /**
+     * 输出保存文件进度-分片统计
+     */
+    private outputProgress;
+    /**
+     * 保存文件
+     */
+    private savefile;
+}

package/dist/utils/CodeHelper.d.ts

@@ -1,14 +1,14 @@
-import { ISysRightOptions } from '../permission/register';
-/**
- * 输出动态Icon图标列表文件
- * @param iconArray
- * @param filePath
- */
-declare function writeIconifyList(iconArray: string[], filePath?: string): void;
-/**
- * 导出系统功能权限文件
- * @param options 系统权限参数对象
- * @param filename 文件名（无需后缀）
- */
-declare function writeSysRoleRight(options: ISysRightOptions, filename: string): void;
-export { writeIconifyList, writeSysRoleRight };
+import { ISysRightOptions } from '../permission/register';
+/**
+ * 输出动态Icon图标列表文件
+ * @param iconArray
+ * @param filePath
+ */
+declare function writeIconifyList(iconArray: string[], filePath?: string): void;
+/**
+ * 导出系统功能权限文件
+ * @param options 系统权限参数对象
+ * @param filename 文件名（无需后缀）
+ */
+declare function writeSysRoleRight(options: ISysRightOptions, filename: string): void;
+export { writeIconifyList, writeSysRoleRight };

package/dist/utils/Color.d.ts

@@ -1,74 +1,74 @@
-/**
- * rgb转十六进制
- * @param colorRGB rgb颜色值
- * @returns
- */
-export declare function getHexColor(colorRGB: string): string;
-/**
- * 十六进制转RGB
- * @param color16 十六进制颜色值
- * @returns
- */
-export declare function getRGBColor(color16: string): string;
-/**
- * 解决十六进制短颜色问题
- * @param colorHex 十六进制颜色
- * @returns
- */
-export declare function getLongHexColor(colorHex: string): string;
-export declare enum EnumColor {
-    RGBA = 0,
-    Hex = 1,
-    Hsla = 2
-}
-/**
- * 判断是否是16进制颜色
- * @param colorStr 颜色字符串
- * @returns
- */
-export declare function isEnumColor(colorStr: string): EnumColor | undefined;
-export declare function getRGBColorFromHSLA(colorHSLA: string): string | undefined;
-/**
- * 判断是否 十六进制颜色值.
- * 输入形式可为 #fff000 #f00
- *
- * @param   String  color   十六进制颜色值
- * @return  Boolean
- */
-export declare function isHexColor(color: string): boolean;
-/**
- * RGB 颜色值转换为 十六进制颜色值.
- * r, g, 和 b 需要在 [0, 255] 范围内
- *
- * @return  String          类似#ff00ff
- * @param r
- * @param g
- * @param b
- */
-export declare function rgbToHex(r: number, g: number, b: number): string;
-/**
- * Transform a HEX color to its RGB representation
- * @param {string} hex The color to transform
- * @returns The RGB representation of the passed color
- */
-export declare function hexToRGB(hex: string): string;
-export declare function colorIsDark(color: string): boolean | undefined;
-/**
- * Darkens a HEX color given the passed percentage
- * @param {string} color The color to process
- * @param {number} amount The amount to change the color by
- * @returns {string} The HEX representation of the processed color
- */
-export declare function darken(color: string, amount: number): string;
-/**
- * Lightens a 6 char HEX color according to the passed percentage
- * @param {string} color The color to change
- * @param {number} amount The amount to change the color by
- * @returns {string} The processed color represented as HEX
- */
-export declare function lighten(color: string, amount: number): string;
-/**
- * Determines what the best text color is (black or white) based con the contrast with the background
- * @param hexColor - Last selected color by the user
- */
-export declare function calculateBestTextColor(hexColor: string): "#000000" | "#FFFFFF";
+/**
+ * rgb转十六进制
+ * @param colorRGB rgb颜色值
+ * @returns
+ */
+export declare function getHexColor(colorRGB: string): string;
+/**
+ * 十六进制转RGB
+ * @param color16 十六进制颜色值
+ * @returns
+ */
+export declare function getRGBColor(color16: string): string;
+/**
+ * 解决十六进制短颜色问题
+ * @param colorHex 十六进制颜色
+ * @returns
+ */
+export declare function getLongHexColor(colorHex: string): string;
+export declare enum EnumColor {
+    RGBA = 0,
+    Hex = 1,
+    Hsla = 2
+}
+/**
+ * 判断是否是16进制颜色
+ * @param colorStr 颜色字符串
+ * @returns
+ */
+export declare function isEnumColor(colorStr: string): EnumColor | undefined;
+export declare function getRGBColorFromHSLA(colorHSLA: string): string | undefined;
+/**
+ * 判断是否 十六进制颜色值.
+ * 输入形式可为 #fff000 #f00
+ *
+ * @param   String  color   十六进制颜色值
+ * @return  Boolean
+ */
+export declare function isHexColor(color: string): boolean;
+/**
+ * RGB 颜色值转换为 十六进制颜色值.
+ * r, g, 和 b 需要在 [0, 255] 范围内
+ *
+ * @return  String          类似#ff00ff
+ * @param r
+ * @param g
+ * @param b
+ */
+export declare function rgbToHex(r: number, g: number, b: number): string;
+/**
+ * Transform a HEX color to its RGB representation
+ * @param {string} hex The color to transform
+ * @returns The RGB representation of the passed color
+ */
+export declare function hexToRGB(hex: string): string;
+export declare function colorIsDark(color: string): boolean | undefined;
+/**
+ * Darkens a HEX color given the passed percentage
+ * @param {string} color The color to process
+ * @param {number} amount The amount to change the color by
+ * @returns {string} The HEX representation of the processed color
+ */
+export declare function darken(color: string, amount: number): string;
+/**
+ * Lightens a 6 char HEX color according to the passed percentage
+ * @param {string} color The color to change
+ * @param {number} amount The amount to change the color by
+ * @returns {string} The processed color represented as HEX
+ */
+export declare function lighten(color: string, amount: number): string;
+/**
+ * Determines what the best text color is (black or white) based con the contrast with the background
+ * @param hexColor - Last selected color by the user
+ */
+export declare function calculateBestTextColor(hexColor: string): "#000000" | "#FFFFFF";

package/dist/utils/FileDownload.d.ts

@@ -1,36 +1,36 @@
-/**
- * 下载文件
- * @param content 文本或二进制文件
- * @param filename 文件名
- */
-declare const Download: (content: string | any, filename: string) => void;
-/**
- * URL方式保存文件到本地
- * @param data 文件的blob数据
- * @param name 文件名
- */
-declare function SaveAs(data: string | any, name: string): void;
-/**
- * JSON对象下载为.json文件
- * @param jsonObject Json对象
- * @param jsonID 名称(不需要后缀名)
- */
-declare const JsonDownload: (jsonObject: object, jsonID: string) => void;
-/**
- * 从Web上下载文件
- * （通过axios下载）
- * @param requestUrl URL下载地址
- * @param fileName 文件名
- */
-declare const HttpDownload: (axios: any, requestUrl: string, fileName: string) => void;
-/**
- * 根据文件地址下载文件
- * (网站内部文件或外部图片地址)
- * @param {*} sUrl
- */
-declare function DownloadByUrl({ url, target, fileName }: {
-    url: string;
-    target?: '_self' | '_blank';
-    fileName?: string;
-}): Promise<boolean>;
-export { Download, SaveAs, JsonDownload, HttpDownload, DownloadByUrl };
+/**
+ * 下载文件
+ * @param content 文本或二进制文件
+ * @param filename 文件名
+ */
+declare const Download: (content: string | any, filename: string) => void;
+/**
+ * URL方式保存文件到本地
+ * @param data 文件的blob数据
+ * @param name 文件名
+ */
+declare function SaveAs(data: string | any, name: string): void;
+/**
+ * JSON对象下载为.json文件
+ * @param jsonObject Json对象
+ * @param jsonID 名称(不需要后缀名)
+ */
+declare const JsonDownload: (jsonObject: object, jsonID: string) => void;
+/**
+ * 从Web上下载文件
+ * （通过axios下载）
+ * @param requestUrl URL下载地址
+ * @param fileName 文件名
+ */
+declare const HttpDownload: (axios: any, requestUrl: string, fileName: string) => void;
+/**
+ * 根据文件地址下载文件
+ * (网站内部文件或外部图片地址)
+ * @param {*} sUrl
+ */
+declare function DownloadByUrl({ url, target, fileName }: {
+    url: string;
+    target?: '_self' | '_blank';
+    fileName?: string;
+}): Promise<boolean>;
+export { Download, SaveAs, JsonDownload, HttpDownload, DownloadByUrl };

package/dist/utils/FileUpload.d.ts

@@ -1,90 +1,90 @@
-import { XhrHeaders } from 'xhr';
-export type FileEventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
-export type AllowedMethods = 'PUT' | 'POST' | 'PATCH';
-/**
- * 文件上传配置
- */
-export interface FileUploadOptions {
-    endpoint: string | ((file?: File) => Promise<string>);
-    file: File;
-    method?: AllowedMethods;
-    headers?: XhrHeaders;
-    maxFileSize?: number;
-    chunkSize?: number;
-    attempts?: number;
-    /**
-     * 单位：秒
-     */
-    delayBeforeAttempt?: number;
-    md5?: string;
-}
-/**
- * 文件上传类
- */
-export declare class FileUpload {
-    endpoint: string | ((file?: File) => Promise<string>);
-    file: File;
-    headers: XhrHeaders;
-    method: AllowedMethods;
-    chunkSize: number;
-    attempts: number;
-    delayBeforeAttempt: number;
-    md5: string;
-    private chunk?;
-    private chunkCount;
-    private chunkByteSize;
-    private maxFileBytes;
-    private endpointValue?;
-    private totalChunks;
-    private attemptCount;
-    private offline;
-    private paused;
-    private success;
-    private currentXhr?;
-    private reader;
-    private eventTarget;
-    private fileName;
-    constructor(options: FileUploadOptions);
-    /**
-     * 订阅事件
-     */
-    on(FileEventName: FileEventName, fn: (event: any) => void): void;
-    abort(): void;
-    pause(): void;
-    resume(): void;
-    /**
-     * 发送消息
-     */
-    private dispatch;
-    /**
-     *验证参数的正确性
-     */
-    private validateOptions;
-    /**
-     * Endpoint can either be a URL or a function that returns a promise that resolves to a string.
-     */
-    private getEndpoint;
-    /**
-     * Get portion of the file of x bytes corresponding to chunkSize
-     */
-    private getChunk;
-    private xhrPromise;
-    /**
-     * Send chunk of the file with appropriate headers and add post parameters if it's last chunk
-     */
-    private sendChunk;
-    /**
-     * 失败处理和尝试
-     */
-    private manageRetries;
-    /**
-     * 进行分片上传，并处理错误和重试
-     */
-    private sendChunks;
-}
-/**
- * 创建文件上传对象方法
- * @param options
- * @returns
- */
-export declare const createFileUpload: (options: FileUploadOptions) => FileUpload;
+import { XhrHeaders } from 'xhr';
+export type FileEventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
+export type AllowedMethods = 'PUT' | 'POST' | 'PATCH';
+/**
+ * 文件上传配置
+ */
+export interface FileUploadOptions {
+    endpoint: string | ((file?: File) => Promise<string>);
+    file: File;
+    method?: AllowedMethods;
+    headers?: XhrHeaders;
+    maxFileSize?: number;
+    chunkSize?: number;
+    attempts?: number;
+    /**
+     * 单位：秒
+     */
+    delayBeforeAttempt?: number;
+    md5?: string;
+}
+/**
+ * 文件上传类
+ */
+export declare class FileUpload {
+    endpoint: string | ((file?: File) => Promise<string>);
+    file: File;
+    headers: XhrHeaders;
+    method: AllowedMethods;
+    chunkSize: number;
+    attempts: number;
+    delayBeforeAttempt: number;
+    md5: string;
+    private chunk?;
+    private chunkCount;
+    private chunkByteSize;
+    private maxFileBytes;
+    private endpointValue?;
+    private totalChunks;
+    private attemptCount;
+    private offline;
+    private paused;
+    private success;
+    private currentXhr?;
+    private reader;
+    private eventTarget;
+    private fileName;
+    constructor(options: FileUploadOptions);
+    /**
+     * 订阅事件
+     */
+    on(FileEventName: FileEventName, fn: (event: any) => void): void;
+    abort(): void;
+    pause(): void;
+    resume(): void;
+    /**
+     * 发送消息
+     */
+    private dispatch;
+    /**
+     *验证参数的正确性
+     */
+    private validateOptions;
+    /**
+     * Endpoint can either be a URL or a function that returns a promise that resolves to a string.
+     */
+    private getEndpoint;
+    /**
+     * Get portion of the file of x bytes corresponding to chunkSize
+     */
+    private getChunk;
+    private xhrPromise;
+    /**
+     * Send chunk of the file with appropriate headers and add post parameters if it's last chunk
+     */
+    private sendChunk;
+    /**
+     * 失败处理和尝试
+     */
+    private manageRetries;
+    /**
+     * 进行分片上传，并处理错误和重试
+     */
+    private sendChunks;
+}
+/**
+ * 创建文件上传对象方法
+ * @param options
+ * @returns
+ */
+export declare const createFileUpload: (options: FileUploadOptions) => FileUpload;