xframelib 0.3.9 → 0.4.3

package/dist/index.d.ts

@@ -1,832 +1,10 @@
-import { ClientContext, Client } from '@hprose/rpc-core';
-import { XhrHeaders } from 'xhr';
-
-declare class ProxyClient {
-    private hproseClient;
-    private hpProxyObj;
-    private readonly defaultContext;
-    constructor(hproseUrl: string);
-    getClientContext(): ClientContext | null;
-    getHproseProxy(): Promise<any>;
-    hproseInvoke(methodName: string, args?: any[] | undefined): Promise<any>;
-    hproseInvokeContext(methodName: string, context: ClientContext | undefined, ...args: any): Promise<any>;
-    /**
-     * 编码参数方式请求
-     * @param request
-     */
-    hproseInvokeEncode(requestParamsEncode: string): Promise<any>;
-    /**
-     * 对请求参数编码
-     * @param name 方法名
-     * @param args 请求参数
-     */
-    encodeRequest(name: string, ...args: any): string;
-}
-
-declare type EventType = string | symbol;
-declare type Handler<T = any> = (event?: T) => void;
-declare type WildcardHandler = (type: EventType, event?: any) => void;
-declare type EventHandlerList = Array<Handler>;
-declare type WildCardEventHandlerList = Array<WildcardHandler>;
-declare type EventHandlerMap = Map<EventType, EventHandlerList | WildCardEventHandlerList>;
-interface Emitter {
-    all: EventHandlerMap;
-    on<T = any>(type: EventType, handler: Handler<T>): void;
-    on(type: '*', handler: WildcardHandler): void;
-    off<T = any>(type: EventType, handler: Handler<T>): void;
-    off(type: '*', handler: WildcardHandler): void;
-    emit<T = any>(type: EventType, event?: T): void;
-    emit(type: '*', event?: any): void;
-}
-/**
- * 默认全局总线对象
- */
-declare const GlobalMitt: Emitter;
-
-declare class MsgHelper {
-    private message;
-    private eventBus;
-    constructor(messageui: any, eventbus?: Emitter | undefined);
-    /**共用消息 */
-    msg(msgInfo: string, seconds?: number, typename?: string): void;
-    info(msgInfo: string, seconds?: number): void;
-    warn(msgInfo: string, seconds?: number): void;
-    err(msgInfo: string, seconds?: number): void;
-}
-
-/**
- * UI界面相关
- */
-interface IUIObject {
-  /**
-   * 网站标题
-   */
-  SiteTitle: string;
-  /**
-   * 版权
-   */
-  CopyRight: string; //'Copyright ©XXX  2021-2025',
-  /**
-   * 官方链接
-   */
-  WebSite?: string; //网站链接
-  /**
-   * 超时锁屏时间(单位：秒s)
-   */
-  LockTime?: number; //
-  /**
-   * 其他扩展的属性
-   */
-  [props: string]: any;
-}
-/**
- * 服务URL
- */
-interface IServiceURL {
-  /**
-   * 用户登录（统一用户登录）
-   */
-  LoginAuthURL: string; //用户验证
-  /**
-   * Axios普通WebAPI的BaseURL
-   * 全局默认的http请求地址（一般与主hprose相同或不同）;文件上传地址
-   */
-  DefaultWebAPI?: string;
-  /**
-   * 默认HproseAPI的服务地址
-   */
-  DefaultHproseAPI?: string;
-  /**
-   * 其他扩展的URL属性
-   */
-  [props: string]: any;
-}
-
-/**
- * 地图相关Keys
- */
-interface IMapKeys {
-  /**
-   * 天地图Key
-   */
-  TDTKey?: string;
-  /**
-   * MapboxKey
-   */
-  MapboxKey?: string;
-  /**
-   * Cesium Key
-   */
-  CesiumKey?: string;
-  /**
-   * Google地图Key
-   */
-  GoogleKey?: string;
-  /**
-   * 其他扩展的Key属性
-   */
-  [props: string]: any;
-}
-/**
- * 系统配置信息
- */
-interface ISystemConfig {
-  /**
-   * 用户界面配置
-   */
-  UI?: IUIObject;
-  /**
-   * 服务URL
-   */
-  ServiceURL: IServiceURL;
-  /**
-   * 地图相关Keys
-   */
-  MapKeys?: IMapKeys;
-  /**
-   * API服务路径
-   */
-  APIPath?: object; //
-  //其他配置信息
-  [props: string]: any;
-}
-
-/**
- * 当前存储的token对象
- */
-interface ITokenInfo {
-  id: string;
-  name: string;
-  token: string;
-  expire: string;
-  refresh: string;
-}
-/**
- * 单个token对象内容
- * 与后台相匹配
- */
-interface IToken {
-  /**
-   * token内容
-   */
-  tokenContent: string;
-  /**
-   * 超时时间
-   */
-  expires: string;
-}
-
-/**
- * 双Token接口定义
- */
-interface IDoubleToken {
-  /**
-   * 当前有效token
-   */
-  accessToken: IToken;
-  /**
-   * 用于刷新的token
-   */
-  refreshToken: IToken;
-}
-/**
- * 系统用户
- */
-interface ISystemUser {
-  /**
-   * 用户ID
-   */
-  id: string;
-  /**
-   * 用户名
-   */
-  name: string;
-  /**
-   * 用户组ID
-   */
-  groupid?: string;
-  photo?: string;
-  mobile?: string;
-  qq?: string;
-  email?: string;
-  img?: string;
-  issystem?: boolean;
-  createtime?: string;
-  updatetime?: string;
-  issecurity?: boolean;
-  appkey?: string;
-  role?: string;
-  doubleToken?: IDoubleToken;
-}
-
-interface InnerObject {
-    /**
-     * 当前登录用户对象
-     */
-    User?: ISystemUser;
-    /**
-     * axios对象
-     */
-    Axios: any;
-    Config: ISystemConfig;
-    EventBus: Emitter;
-    DefaultProxyClient: ProxyClient | null | undefined;
-    Message?: MsgHelper;
-    [props: string]: any;
-}
-/**
- * 初始化配置信息
- */
-interface XOptions {
-    config?: any;
-    message?: any;
-    axios?: any;
-    defaultHproseURL?: string;
-}
-
-declare const Global: InnerObject;
-/**
- * 通过配置文件初始化系统
- * @param options 配置参数对象
- */
-declare function initXFrame(options: XOptions): void;
-/**
- * 框架初始化
- * @param messageUI 消息UI
- * @param defaultHproseURL 默认HproseURL
- */
-declare const init: (messageUI: any, axiosObj: any, defaultHproseURL?: string | undefined) => void;
-/**
- * 获取HproseProxy对象
- * @param hproseURL Hprose服务链接地址
- * @returns Hprose代理对象
- */
-declare function getProxyClient(hproseURL?: string): ProxyClient | undefined;
-/**
- * 初始化Global.DefaultProxyClient对象
- * @param defaulthproseURL 默认的Hprose服务对象URL
- * @returns ProxyClient对象
- */
-declare function initDefaultProxyClient(defaulthproseURL?: string): ProxyClient | undefined;
-
-declare const SysEvents: {
-    HproseServiceErrorEvent: string;
-    WebAPIErrorEvent: string;
-    AlertInfoEvent: string;
-    /**
-     * 一般通用警告或错误
-     */
-    CommonWarnEvent: string;
-};
-
-/**
- * 常用H5相关操作
- */
-declare 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(el: any | Element, isfull: boolean): void;
-    /**
-     * 进入全屏
-     * @param element 全屏要素容器
-     */
-    static requestFullScreen(element: 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;
-}
-
-declare class StringUtils {
-    /**
-     * 判断字符串是否为空或undefined,不判断为0,不判断为false
-     * @param str
-     * @returns {boolean}
-     */
-    static isNullOrEmpty: (str: any) => boolean;
-    static isNotEmpty: (str: any) => boolean;
-}
-
-/**
- * 创建本地缓存对象
- */
-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;
-}
-declare const storage: StorageHelper;
-
-declare function uuid(): string;
-declare function newGuid(): string;
-
-/**
- * rgb转十六进制
- * @param colorRGB rgb颜色值
- * @returns
- */
-declare function getHexColor(colorRGB: string): string;
-/**
- * 十六进制转RGB
- * @param color16 十六进制颜色值
- * @returns
- */
-declare function getRGBColor(color16: string): string;
-/**
- * 解决十六进制短颜色问题
- * @param colorHex 十六进制颜色
- * @returns
- */
-declare function getLongHexColor(colorHex: string): string;
-declare enum EnumColor {
-    RGBA = 0,
-    Hex = 1,
-    Hsla = 2
-}
-/**
- * 判断是否是16进制颜色
- * @param colorStr 颜色字符串
- * @returns
- */
-declare function isEnumColor(colorStr: string): EnumColor | undefined;
-declare function getRGBColorFromHSLA(colorHSLA: string): string | undefined;
-
-/**
- * 下载文件
- * @param content 文本或二进制文件
- * @param filename 文件名
- */
-declare const Download: (content: string | any, filename: string) => void;
-/**
- * JSON对象下载为.json文件
- * @param jsonObject Json对象
- * @param jsonID 名称
- */
-declare const JsonDownload: (jsonObject: object, jsonID: string) => void;
-/**
- * 从Web上下载文件
- * @param requestUrl URL下载地址
- * @param fileName 文件名
- */
-declare const HttpDownload: (axios: any, requestUrl: string, fileName: string) => void;
-
-declare function sleep(delay: any): void;
-
-declare type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
-/**
- * Get服务请求
- * @param apiUrl API接口路径
- * @param baseUrl 基础服务路径
- * @param _params 参数
- * @param headers headers参数
- * @param responseType 响应类型,默认为json
- * @param cancelToken  取消标识
- * @returns 返回Promise对象
- */
-declare function requestGet(apiUrl: string, baseUrl?: string, _params?: any, headers?: any, responseType?: ResponseType, cancelToken?: any): Promise<any>;
-/**
- * Post服务请求-FormData
- * @param apiUrl API接口路径
- * @param baseUrl 基础服务路径
- * @param _params 参数
- * @param headers headers参数
- * @returns 返回Promise对象
- */
-declare function requestPost(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType): Promise<any>;
-/**
- * Post服务请求-Body方式
- * @param apiUrl API接口路径
- * @param baseUrl 基础服务路径
- * @param _params 参数
- * @returns 返回Promise对象
- */
-declare function requestPostBody(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType): Promise<any>;
-/**
- * 业务服务Get请求
- * @param apiUrl API接口路径
- * @param _params 参数
- * @returns 返回Promise对象
- */
-declare function get(apiUrl: string, _params?: any): Promise<any>;
-/**
- * 业务服务Post请求
- * @param apiUrl API接口路径
- * @param _params 参数
- * @returns 返回Promise对象
- */
-declare function post(apiUrl: string, _params?: any): Promise<any>;
-/**
- * 独立的外部Get请求（无token验证信息）
- * @param fullRequestURL 完整请求路径
- * @param _params 请求参数
- * @returns  返回Promise对象
- */
-declare function getData(fullRequestURL: string, _params?: any): Promise<any>;
-
-declare const storageHelper: StorageHelper;
-/**
- * 获取token中的授权Key
- * @returns
- */
-declare function getLocalToken(): ITokenInfo;
-/**
- * 清除本地Token
- */
-declare function clearLocalToken(): void;
-/**
- * 获得RefreshToken
- * @returns
- */
-declare function getRefreshToken(): string;
-
-declare type FileEventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
-declare type AllowedMethods = 'PUT' | 'POST' | 'PATCH';
-/**
- * 文件上传配置
- */
-interface FileUploadOptions {
-    endpoint: string | ((file?: File) => Promise<string>);
-    file: File;
-    method?: AllowedMethods;
-    headers?: XhrHeaders;
-    maxFileSize?: number;
-    chunkSize?: number;
-    attempts?: number;
-    /**
-     * 单位：秒
-     */
-    delayBeforeAttempt?: number;
-    md5?: string;
-}
-/**
- * 文件上传类
- */
-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
- */
-declare const createFileUpload: (options: FileUploadOptions) => FileUpload;
-
-/**
- * 模仿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对象
- */
-declare const jquery: JQuery;
-
-interface ILockState {
-    isLock: boolean;
-    lockTime: number;
-}
-/**
- * 获取当前Lock状态
- * @returns 是否Locked
- */
-declare function getLockState(): any;
-/**
- * 全局监听Lock
- */
-declare function onLockListener(): void;
-/**
- * 取消全局监听Lock
- */
-declare function unLockListener(): void;
-
-/**
- * 下载文件信息模型
- */
-interface IFileMeta {
-    id?: string;
-    name: string;
-    length: number;
-    downloadID: string;
-    chunkSize?: number;
-}
-/**
- * 文件下载事件
- */
-declare type FileDownloadEvent = 'init' | 'info' | 'error' | 'downloadProgress' | 'saveProgress' | 'success';
-
-declare class HproseClient {
-    private hproseURL?;
-    client?: Client;
-    private hproseProxy;
-    private static httpTransport?;
-    constructor(url?: string);
-    private init;
-    /**
-     * 获取HproseProxy
-     */
-    getProxy(): Promise<any>;
-    invoke(methodName: string, args?: any[], context?: ClientContext): Promise<any>;
-    /**
-     * 解码和编码
-     */
-    encode(name: string, args: any[], context: ClientContext): Uint8Array | undefined;
-    decode(response: Uint8Array, context: ClientContext): any;
-}
-
-interface GIHprose {
-    getDefaultClient(): ProxyClient;
-    registerHprose(hpClientName: string, hproseUrl: string): HproseClient | undefined;
-    getHprose(hpClientName: string): HproseClient | undefined;
-    getProxyHprose(hpClientName: string): ProxyClient | undefined;
-    unregisterHprose(hpClientName: string): void;
-}
-declare const GlobalHprose: GIHprose;
-
-/**
- * 刷新Token
- */
-declare function doRefreshToken(): void;
-/**
- * 检查和刷新Token
- * @param userToken
- */
-declare function checkDoRefreshToken(userToken: ITokenInfo): void;
-/**
- * 存储Token对象
- * @param userToken
- */
-declare function setLocalToken(userToken: IDoubleToken): void;
-/**
- * 设置当前用户
- * @param userInfo
- */
-declare function setUser(userInfo: ISystemUser): void;
-
-interface IUserInfo {
-    /**
-     * 用户名
-     */
-    username: string;
-    oldpwd: string;
-    newpwd: string;
-}
-interface IUser {
-    username: string;
-    pwd: string;
-    /**
-     * 所属系统
-     */
-    system?: string;
-}
-/**
- * 用户登录
- * @param data 用户信息
- * @returns
- */
-declare function login(data: IUser): Promise<any>;
-/**
- * 检查某一系统的用户
- * @param data 用户对象
- * @returns
- */
-declare function checkLogin(data: IUser): Promise<any>;
-/**
- * 修改密码
- * @param data 用户数据
- * @returns
- */
-declare function changePWD(data: IUserInfo): Promise<any>;
-/**
- * 退出登录
- */
-declare function logout(): void;
-/**
- * 验证 已有的token
- * @param token 需要验证的token
- * @returns
- */
-declare function checkToken(token: string): Promise<any>;
-
-/**
- * 刷新提前量(毫秒,ms)
- */
-declare const TOKEN_REFRESH_TIME: number;
-/**
- * 用户和Token相关服务API
- */
-declare const USER_TOKEN_API: {
-    Login: string;
-    CheckLogin: string;
-    Logout: string;
-    ChangePWD: string;
-    RefreshToken: string;
-    CheckToken: string;
-};
-
-export { AllowedMethods, Download, Emitter, EnumColor, EventHandlerList, EventHandlerMap, EventType, FileDownloadEvent, FileEventName, FileUploadOptions, GIHprose, Global, GlobalHprose, GlobalMitt, H5Tool, Handler, HproseClient, HttpDownload, IDoubleToken, IFileMeta, ILockState, IMapKeys, IServiceURL, ISystemConfig, ISystemUser, IToken, ITokenInfo, IUIObject, JsonDownload, ProxyClient, ResponseType, StorageHelper as Storage, StringUtils, SysEvents, TOKEN_REFRESH_TIME, USER_TOKEN_API, WildCardEventHandlerList, WildcardHandler, changePWD, checkDoRefreshToken, checkLogin, checkToken, clearLocalToken, createFileUpload, doRefreshToken, get, getData, getHexColor, getLocalToken, getLockState, getLongHexColor, getProxyClient, getRGBColor, getRGBColorFromHSLA, getRefreshToken, init, initDefaultProxyClient, initXFrame, isEnumColor, jquery, login, logout, newGuid, onLockListener, post, requestGet, requestPost, requestPostBody, setLocalToken, setUser, sleep, storage, storageHelper, unLockListener, uuid };
+export * from './controls/splitpanes';
+export * from './controls/collapsepanel';
+export * from './controls/vuewindow';
+export * from './controls/layoutcontainer';
+export * from './core';
+export * from './mitt';
+export * from './utils';
+export * from './hprose';
+export * from './api';
+export * from './model';