xframelib 0.4.0 → 0.4.5

package/dist/utils/BigFileDownload.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 下载文件信息模型
+ */
+export interface IFileMeta {
+    id?: string;
+    name: string;
+    length: number;
+    downloadID: string;
+    chunkSize?: number;
+}
+/**
+ * 文件下载事件
+ */
+export declare 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?;
+    constructor(fileID: string, downloadURL: string, chunkSizeM?: 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;
+    /**
+     * 开始分段下载
+     */
+    download(downURL?: string): void;
+    /**
+     * 下载完成进度
+     */
+    private downloadProgress;
+    /**
+     * 输出保存文件进度-分片统计
+     */
+    private outputProgress;
+    /**
+     * 保存文件
+     */
+    private savefile;
+}

package/dist/utils/Color.d.ts

@@ -0,0 +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";

package/dist/utils/FileDownload.d.ts

@@ -0,0 +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 };

package/dist/utils/FileUpload.d.ts

@@ -0,0 +1,90 @@
+import { XhrHeaders } from 'xhr';
+export declare type FileEventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
+export declare 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 default 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;

package/dist/utils/H5Tool.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 常用H5相关操作
+ */
+export default class H5Tool {
+    /**
+     * HTML元素事件监听
+     * @param element Window或HTMLElement
+     * @param type 事件名称
+     * @param handler 处理函数
+     */
+    static addHandler(element: Window | HTMLElement | any, type: string, handler: Function): void;
+    /**
+     * 窗体变化事件
+     * @param handlerFunc 窗体变化处理函数
+     */
+    static windowResizeHandler(handlerFunc: Function): void;
+    /**
+     * 是否支持全屏操作
+     * @returns true/false
+     */
+    static fullscreenEnabled(): boolean;
+    /**
+     * 全屏
+     * @param el HTML元素
+     * @param isfull 是否全屏
+     */
+    static fullScreen(element: any | Element, isfull: boolean): void;
+    /**
+     * 进入全屏
+     * @param element 全屏要素容器
+     */
+    static requestFullScreen(el?: any | Element): void;
+    /**
+     * 退出全屏
+     */
+    static exitFullScreen(): void;
+    /**
+     * 获取全屏的容器元素
+     * @returns 全屏的容器元素
+     */
+    static fullScreenElement(): Element | HTMLElement | Document | null;
+    /**
+     * 是否是全屏
+     * @returns 全屏状态
+     */
+    static isFullScreen(): boolean;
+    /**
+     * 监听全屏变化状态
+     * @param handlerFunc 全屏状态变化的处理函数
+     */
+    static onFullScreenChanged(handlerFunc: (isfullscreen: boolean) => any): void;
+    /**
+     * 解决对象Json化循环引用问题
+     * @param key
+     * @param value
+     * @returns
+     */
+    static stringifyCircularHandler(key: string, value: any): any;
+    /**
+     * 对象Json化——解决循环引用问题
+     * @param obj 传入对象参数
+     * @returns 无循环引用的新对象
+     */
+    static jsonStringify(obj: any): string;
+    /**
+     * 去掉JSON循环引用关系
+     * @param obj 传入对象参数
+     * @returns 无循环引用的新对象
+     */
+    static jsonParse(obj: any): any;
+    /**
+     * 获取input File的对象的数据路径
+     * @param file File对象
+     * @returns
+     */
+    static getObjectURL(file: any): string | undefined;
+    /**
+     * 获取文件的短MD5摘要
+     * @param fileObj file对象
+     * @param handleMd5Result 处理文件MD5结果
+     */
+    static getFileShortMD5(fileObj: any, handleMd5Result: (data: {
+        isOK: boolean;
+        data: string;
+    }) => void): any;
+    /**
+     * 提供MD5值计算
+     * @param content 字符串
+     * @param needRawHash 是否需要是二进制格式的结果，默认为false
+     * @returns MD5值
+     */
+    static MD5(content: string, needRawHash?: boolean): string;
+    /**
+     * 复制文本
+     * @param text
+     */
+    static copyText: (text: string) => Promise<unknown>;
+}

package/dist/utils/IsTool.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @description: 判断值是否未某个类型
+ */
+export declare function is(val: unknown, type: string): boolean;
+/**
+ * @description:  是否为函数
+ */
+export declare function isFunction<T = Function>(val: unknown): val is T;
+/**
+ * @description: 是否已定义
+ */
+export declare const isDef: <T = unknown>(val?: T | undefined) => val is T;
+export declare const isUnDef: <T = unknown>(val?: T | undefined) => val is T;
+export declare function isNull(val: unknown): val is null;
+export declare function isNullAndUnDef(val: unknown): val is null | undefined;
+export declare function isNullOrUnDef(val: unknown): val is null | undefined;
+/**
+ * @description: 是否为对象
+ */
+export declare const isObject: (val: any) => val is Record<any, any>;
+/**
+ * @description:  是否为时间
+ */
+export declare function isDate(val: unknown): val is Date;
+/**
+ * @description:  是否为数值
+ */
+export declare function isNumber(val: unknown): val is number;
+/**
+ * @description:  是否为AsyncFunction
+ */
+export declare function isAsyncFunction<T = any>(val: unknown): val is Promise<T>;
+/**
+ * @description:  是否为promise
+ */
+export declare function isPromise<T = any>(val: unknown): val is Promise<T>;
+/**
+ * @description:  是否为字符串
+ */
+export declare function isString(val: unknown): val is string;
+/**
+ * @description:  是否为boolean类型
+ */
+export declare function isBoolean(val: unknown): val is boolean;
+/**
+ * @description:  是否为数组
+ */
+export declare function isArray(val: any): val is Array<any>;
+/**
+ * @description: 是否客户端
+ */
+export declare const isClient: () => boolean;
+/**
+ * @description: 是否为浏览器
+ */
+export declare const isWindow: (val: any) => val is Window;
+export declare const isElement: (val: unknown) => val is Element;
+export declare const isServer: boolean;
+export declare function isImageDom(o: Element): boolean;
+/**
+ * 是否为空
+ * @param source
+ * @returns
+ */
+export declare function isEmpty(source: unknown): boolean;
+/**
+ * 是否是异常
+ * @param val
+ * @returns
+ */
+export declare function isError(val: unknown): boolean;
+/**
+ * 判断元素是否为WeakSet
+ * @param source
+ * @returns
+ */
+export declare function isWeakSet(source: unknown): boolean;
+/**
+ * @description 判断元素是否为WeakMap
+ * @param {*} source 元素
+ * @return {Boolen}
+ */
+export declare function isWeakMap(source: unknown): boolean;
+/**
+ * @description 判断元素是否为Symbol
+ * @param {*} source 元素
+ * @return {Boolen}
+ */
+export declare function isSymbol(source: unknown): boolean;
+/**
+ * @description 判断元素是否为Map
+ * @param {*} source 元素
+ * @return {Boolen}
+ */
+export declare function isMap(source: unknown): boolean;
+/**
+ * 是否有效的URL地址
+ * @param url
+ * @returns
+ */
+export declare const isValidURL: (url: string) => boolean;

package/dist/utils/JQuery.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 模仿JQuery相关方法
+ */
+declare class JQuery {
+    /**
+     * 是否有Style类名
+     * @param ele HTML元素
+     * @param className 类名
+     * @returns
+     */
+    hasClass(ele: HTMLElement, className: string): RegExpMatchArray | null;
+    /**
+     * 为元素添加Style类名
+     * @param ele HTML元素
+     * @param className 类名
+     */
+    addClass(ele: HTMLElement, className: string): void;
+    /**
+     * 移除元素的Style类名
+     * @param ele HTML元素
+     * @param className 类名
+     */
+    removeClass(ele: HTMLElement, className: string): void;
+    /**
+     * 切换Style类名
+     * @param ele HTML元素
+     * @param className 类名
+     */
+    toggleClass(ele: HTMLElement, className: string): void;
+}
+/**
+ * jquery对象
+ */
+export declare const jquery: JQuery;
+export {};

package/dist/utils/LockHelper.d.ts

@@ -0,0 +1,17 @@
+export interface ILockState {
+    isLock: boolean;
+    lockTime: number;
+}
+/**
+ * 获取当前Lock状态
+ * @returns 是否Locked
+ */
+export declare function getLockState(): any;
+/**
+ * 全局监听Lock
+ */
+export declare function onLockListener(): void;
+/**
+ * 取消全局监听Lock
+ */
+export declare function unLockListener(): void;

package/dist/utils/Storage.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 创建本地缓存对象
+ */
+declare class StorageHelper {
+    private prefixKey;
+    private storage;
+    constructor(prefixKey?: string, storage?: Storage);
+    private getKey;
+    /**
+     * @description 设置缓存
+     * @param {string} key 缓存键
+     * @param {*} value 缓存值
+     * @param expire
+     */
+    set(key: string, value: any, expire?: number | null): void;
+    /**
+     * 读取缓存
+     * @param {string} key 缓存键
+     * @param {*=} def 默认值
+     */
+    get(key: string, def?: any): any;
+    /**
+     * 从缓存删除某项
+     * @param {string} key
+     */
+    remove(key: string): void;
+    /**
+     * 清空所有缓存
+     * @memberOf Cache
+     */
+    clear(): void;
+    /**
+     * 设置cookie
+     * @param {string} name cookie 名称
+     * @param {*} value cookie 值
+     * @param {number=} expire 过期时间
+     * 如果过期时间为设置，默认关闭浏览器自动删除
+     * @example
+     */
+    setCookie(name: string, value: any, expire?: number | null): void;
+    /**
+     * 根据名字获取cookie值
+     * @param name
+     */
+    getCookie(name: string): string;
+    /**
+     * 根据名字删除指定的cookie
+     * @param {string} key
+     */
+    removeCookie(key: string): void;
+    /**
+     * 清空cookie，使所有cookie失效
+     */
+    clearCookie(): void;
+}
+export declare const storage: StorageHelper;
+export default StorageHelper;

package/dist/utils/StringUtils.d.ts

@@ -0,0 +1,15 @@
+declare class StringUtils {
+    /**
+     * 判断字符串是否为空或undefined,不判断为0,不判断为false
+     * @param str
+     * @returns {boolean}
+     */
+    static isNullOrEmpty: (str: any) => boolean;
+    static isNotEmpty: (str: any) => boolean;
+    /**
+     * / _ - 转换成驼峰并将view替换成空字符串
+     * @param {*} name name
+     */
+    static toHump(name: any): any;
+}
+export default StringUtils;

package/dist/utils/Time.d.ts

@@ -0,0 +1 @@
+export declare function sleep(delay: any): void;

package/dist/utils/TokenHelper.d.ts

@@ -0,0 +1,18 @@
+import { ITokenInfo } from '../model/Token';
+import StorageHelper from '../utils/Storage';
+export declare const storageHelper: StorageHelper;
+/**
+ * 获取token中的授权Key
+ * @returns
+ */
+declare function getLocalToken(): ITokenInfo;
+/**
+ * 清除本地Token
+ */
+declare function clearLocalToken(): void;
+/**
+ * 获得RefreshToken
+ * @returns
+ */
+declare function getRefreshToken(): string;
+export { getLocalToken, getRefreshToken, clearLocalToken };

package/dist/utils/URLTool.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 将对象添加当作参数拼接到URL上面
+ * @param baseUrl 需要拼接的url
+ * @param obj 参数对象
+ * @returns {string} 拼接后的对象
+ * 例子:
+ *  let obj = {a: '3', b: '4'}
+ *  setObjToUrlParams('www.baidu.com', obj)
+ *  ==>www.baidu.com?a=3&b=4
+ */
+export declare function ObjToUrlParams(baseUrl: string, obj: object): string;
+/**
+ * 深入拷贝对象
+ * @param src
+ * @param target
+ * @returns
+ */
+export declare function deepMerge<T = any>(src?: any, target?: any): T;

package/dist/utils/index.d.ts

@@ -0,0 +1,16 @@
+import H5Tool from './H5Tool';
+import StringUtils from './StringUtils';
+import StorageHelper, { storage } from './Storage';
+import uuid, { newGuid } from './uuid';
+export * from './Color';
+export * from './FileDownload';
+export * from './Time';
+export { H5Tool, StringUtils, StorageHelper as Storage, storage, uuid, newGuid };
+export * from './AxiosHelper';
+export * from './TokenHelper';
+export * from './FileUpload';
+export * from './JQuery';
+export * from './LockHelper';
+export * from './BigFileDownload';
+export * from './IsTool';
+export * from './URLTool';

package/dist/utils/uuid.d.ts

@@ -0,0 +1,3 @@
+export default function uuid(): string;
+export declare function newGuid(): string;
+export declare function shortUUID(prefix?: string): string;