halo-fe 1.0.17 → 1.0.18

package/esm/helpers/task-helper.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 任务执行帮助类
+ */
+declare class TaskHelper {
+    /**
+     * 延时指定ms后执行指定任务
+     */
+    static delay: (fun: Function, ms: number) => number;
+    /**
+     * 在执行指定延时后，每隔指定ms执行指定任务
+     */
+    static execute: (fun: Function, ms: number, delay: number) => Promise<unknown>;
+    /**
+     * 清空定时器
+     */
+    static clearInterval: (id: number) => void;
+    /**
+     * 防抖（指定时间内只触发一次）
+     */
+    static debounce: (fun: Function, delay: number) => (e: any) => void;
+    /**
+     * 节流：https://segmentfault.com/a/1190000018428170
+     */
+    static throttle: (fun: Function, delay: number) => (e: any) => boolean;
+}
+export default TaskHelper;

package/esm/helpers/time-helper.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 时间帮助类
+ */
+declare class TimeHelper {
+    /**
+     * 获取相对于1970年1月1日的时间戳(ms)，不同时区结果相同
+     */
+    static getTimestamp: (value?: any) => number;
+    /**
+     * 根据字符串获取可对比的时间
+     */
+    static getTime: (value?: any) => Date;
+    /**
+     * 格式化时间
+     */
+    static format: (value: string, format: string) => string;
+    /**
+     * 获取当前日期时间的字符串
+     */
+    static getDateTimeString: () => string;
+    /**
+     * 获取当前时间的字符串
+     */
+    static getDateString: () => string;
+    /**
+     * 获取当前时间的字符串
+     */
+    static getTimeString: () => string;
+    /**
+     * 对时间值进行时间格式化
+     */
+    static formatSecondTime: (value: any) => string;
+    /**
+     * 对时间值进行时间格式化
+     */
+    static formatMillisecondTime: (value: string) => string;
+    /**
+     * 格式化成24小时时间格式
+     */
+    static formatTime: (value: any) => string;
+    /**
+     * 对时间值进行日期格式化
+     */
+    static formatDate: (value: any) => string;
+    /**
+     * 添加天数
+     */
+    static addDays: (value: any, days: number) => Date;
+    /**
+     * 添加月份
+     */
+    static addMonths: (value: any, months: number) => Date;
+    /**
+     * 添加小时
+     */
+    static addHours: (value: any, hours: number) => Date;
+    /**
+     * 判断指定时间是否是周末
+     */
+    static isWeekend: (value: any) => boolean;
+    /**
+     * 把中国时间，转换为当地时间
+     */
+    static localeTime: (time: any) => Date;
+}
+export default TimeHelper;

package/esm/helpers/tree-helper.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 树帮助类
+ */
+declare class TreeHelper {
+    /**
+     * 从树结构数据中，递归获取指定主键的对象
+     */
+    static getById: (id: any, idProp: string, tree: any[], childProp: string) => any;
+    /**
+     * 树节点
+     */
+    static getByIds: (ids: any[], idProp: string, tree: any[], childProp: string) => any[];
+    /**
+     * 找出指定层级集合中，指定对象的下一个对象
+     */
+    static getNextById: (id: any, idProp: string, tree: any[], childProp: string) => any;
+    /**
+     * 获取兄弟节点
+     */
+    static getSiblingsById: (id: any, idProp: string, tree: any[], childProp: string) => any;
+    /**
+     * 获取父节点
+     */
+    static getParentById: (id: any, idProp: string, tree: any[], childProp: string) => any;
+    /**
+     * 从树结构数据中，递归获取指定主键的父元素集合
+     */
+    static getParentsById: (id: any, idProp: string, tree: any[], childProp: string, hasSelf?: boolean) => any[];
+    /**
+     * 获取当前节点的所有孩子节点的集合
+     */
+    static getChildrenById: (id: any, idProp: string, tree: any[], childProp: string, hasSelf?: boolean) => any[];
+    /**
+     * 获取当前节点的所有孩子节点的集合
+     */
+    static getChildren: (element: any, childProp: string, hasSelf?: boolean) => any[];
+    /**
+     * 搜索指定文本的树结构
+     */
+    static searchTree: (keywords: string, tree: any[], childProp: string, searchProps: any) => any[];
+    /**
+     * 删除指定子元素
+     */
+    static removeById: (id: any, idProp: string, tree: any[], childProp: string) => void;
+    /**
+     * 获取树结构扁平化后的节点信息
+     */
+    static getFlat: (tree: any[], childProp: string) => any[];
+    /**
+     * 对树结点的数据进行重新映射，映射得到新的Tree数组
+     */
+    static map: (tree: any[], prevChildProp: string, childProp: string, fun: Function) => any[];
+}
+export default TreeHelper;

package/esm/helpers/type-helper.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 类型帮助类
+ */
+declare class TypeHelper {
+    /**
+     * 判断输入类型是否是字符串类型 null -> false
+     */
+    static isString: (input: any) => boolean;
+    /**
+     * 判断输入类型是否是Object类型
+     */
+    static isObject: (input: any) => boolean;
+    /**
+     * 判断输入类型是否是Array类型
+     */
+    static isArray: (input: any) => boolean;
+    /**
+     * 判断输入类型是否是Number类型，null -> false
+     */
+    static isNumber: (input: any) => boolean;
+    /**
+     * 判断输入类型是否是isBoolean类型
+     */
+    static isBoolean: (input: any) => boolean;
+}
+export default TypeHelper;

package/esm/helpers/url-helper.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Url帮助类
+ */
+declare class UrlHelper {
+    /**
+     * 获取指定地址路由对象
+     */
+    static getToRoute(url: string, withReturnUrl?: boolean): any;
+    /**
+     * 获取要跳转的Url地址信息，自动涵盖后退地址
+     */
+    static getToUrl(url: string, withReturnUrl?: boolean): string;
+    /**
+     * 获取菜单参数
+     */
+    static getM(url: string): any;
+    /**
+     * 获取后退地址路由
+     */
+    static getBackRoute(): any;
+    /**
+     * 获取要后退的地址URL
+     */
+    static getBackUrl(): string;
+    /**
+     * 获取指定地址的路由对象，自动合并qs，并解码
+     */
+    static getRoute(url: string, queryObj?: object): any;
+    /**
+     * 处理实体，得到url query参数形式
+     * 如：app=Tool&compare[language]=json&compare[sql]=App%3D%27Tool%27+and+[Table]+like+%27Ctl_%25%27+order+by+[Table],+Name
+     */
+    static getQuery(value: any): string;
+    /**
+     * 处理键值对的值
+     */
+    private static handleQueryValue;
+    /**
+     * 自动根据后面路径，决定是否要合并Url
+     */
+    static concatUrl: (url: string, path: string) => string;
+    /**
+     * 合并路径和查询对象（自动编码，并支持覆盖现有参数），得到完整URL地址，并会省略默认值
+     *  ? 对url参数不编码，只对 queryObj 参数编码，防止用户的参数被改成编码形式
+     *  ? 目前，对Url参数对象和目标对象都编码，因为源对象属性是经过解码的
+     */
+    static getUrl: (url: string, params?: any) => string;
+    /**
+     * 获取超链接配置对象
+     */
+    static getAnchor: (url: string, params?: any) => {
+        href: any;
+        target: any;
+    };
+    /**
+     * 从Url中提取路径
+     */
+    static getPath(url: string): string;
+    /**
+     * 获取path中最后一个片段信息
+     */
+    static getLastSegment(url: string): string;
+    /**
+     * 获取地址中的查询参数
+     */
+    static getQueryParam(url: string, key: string): string;
+    /**
+     * 从Url中提取查询对象
+     */
+    static deserialize(url: string): object;
+    /**
+     * 把查询字符串转换成对象（自动解码成源数据）
+     */
+    static deserializeQs(qs: string, decode?: boolean): any;
+    /**
+     * 把对象转换成查询字符串，自动编码
+     */
+    static serialize(obj: object, encoding?: boolean): string;
+    /**
+     * URL编码
+     */
+    static encode(val: string): string;
+    /**
+     * 把指定对象转换成base64字符串
+     */
+    static base64(obj: object): Promise<string>;
+    /**
+     * 把指定base64字符串解析为原对象
+     */
+    static base64Decode(val: string): Promise<any>;
+    /**
+     * 是否是http或https开头的地址
+     */
+    static httpOrHttps(url: string): boolean;
+}
+export default UrlHelper;

package/esm/plugins/HtmlTransform.d.ts

@@ -0,0 +1,6 @@
+import { PluginOption } from "vite";
+/**
+ * 首页VITE变量替换插件
+ */
+declare let htmlTransform: (env: object) => PluginOption;
+export default htmlTransform;

package/esm/plugins/types/IMessager.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 消息提示接口，下游自己定义
+ */
+interface IMessager {
+    /**
+     * 显示全局成功消息
+     */
+    success(message: string): void;
+    /**
+     * 显示全局警告消息
+     */
+    warning(message: string | number): void;
+    /**
+     * 显示全局信息消息
+     */
+    info(message: string): void;
+    /**
+     * 显示全局错误消息
+     */
+    error(message: string): void;
+    /**
+     * 显示全局错误消息
+     */
+    confirm(title: string, message: string, options?: any): Promise<any>;
+    /**
+     * 显示警告框
+     */
+    alert(title: string, message: string, options?: any): void;
+    /**
+     * 通知
+     */
+    notify(title: string, message: string, type: string): void;
+}
+export default IMessager;

package/esm/plugins/types/index.d.ts

@@ -0,0 +1,7 @@
+import type IMessager from "./IMessager";
+declare let messager: IMessager;
+/**
+ * 重新设置消息对象
+ */
+declare let setMessager: (msgr: IMessager) => void;
+export { IMessager, messager, setMessager };

package/esm/services/ConfigService.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 不一定跟用户相关，此时如果使用配置仓储，使用的是配置文件的配置，非接口配置
+ */
+declare class ConfigService {
+    /**
+     * 默认背景
+     */
+    background: string;
+    /**
+     * 当前主题
+     */
+    theme: string;
+    /**
+     * 当前布局方式
+     */
+    layout: string;
+    /**
+     * 当前语言
+     */
+    language: string;
+    /**
+     * 字体
+     */
+    font: string;
+    /**
+     * 文件布局方式
+     */
+    fileLayout: string;
+    editor: {
+        schemas: any[];
+        completions: {};
+    };
+    /**
+     * 初始化配置值（不一定跟登录用户相关，这也是单独分离的好处）
+     */
+    init(configs: any[]): void;
+    /**
+     * 尝试添加架构
+     */
+    tryAddSchema(uri: string, fileMatch: string, schema: object): void;
+    /**
+     * 获取本地配置
+     */
+    getLocalConfig(type: string): Promise<any>;
+    /**
+     * 设置背景
+     */
+    setBackground(background: string): void;
+    /**
+     * 加载用户配置
+     */
+    loadConfig(type: string, cached?: boolean): Promise<any>;
+    /**
+     * 全量保存用户配置
+     */
+    saveConfig(type: string, data: any, cached?: boolean): Promise<boolean>;
+    /**
+     * 部分保存用户配置
+     */
+    patchConfig(type: string, pairs: any): Promise<boolean>;
+    /**
+     * 获取当前语言
+     */
+    getLanguage(): string;
+}
+export default ConfigService;

package/esm/services/DriverService.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 使用驱动仓储
+ */
+declare class DriverService {
+    /**
+     * 加载完毕状态记录
+     */
+    loaded: {
+        apps: boolean;
+        envs: boolean;
+    };
+    /**
+     * 是否加载中状态，用于并发场景 防止重复拉取接口
+     */
+    loading: {
+        apps: boolean;
+        envs: boolean;
+    };
+    /**
+     * 应用集合，存储到Store中，防止每一个Driver实例重复加载
+     */
+    apps: any[];
+    /**
+     * 环境集合，存储到Store中，防止每一个Driver实例重复加载
+     */
+    envs: any[];
+    /**
+     * 加载应用选项
+     */
+    loadApps(reload?: boolean): Promise<void>;
+    /**
+     * 加载环境选项
+     */
+    loadEnvs(reload?: boolean): Promise<void>;
+}
+export default DriverService;

package/esm/services/EnvService.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 前端环境仓储
+ */
+declare class EnvService {
+    /**
+     * 环境变量
+     */
+    env: any;
+    /**
+     * 使用环境变量
+     */
+    useEnv(env: any): void;
+}
+export default EnvService;

package/esm/services/LogService.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 日志服务
+ */
+declare class LogService {
+    logs: any[];
+    /**
+     * 手动添加日志
+     */
+    add(code: string, message: string, stack: string, elapsed?: number): void;
+    /**
+     * 删除日志
+     */
+    remove(index: number): void;
+    /**
+     * 清空日志
+     */
+    clear(): void;
+}
+export default LogService;

package/esm/services/SettingService.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 获取前端配置
+ */
+declare class SettingService {
+    loaded: boolean;
+    particles: boolean;
+    home: string;
+    background: any;
+    font: string;
+    language: string;
+    layout: string;
+    theme: string;
+    themes: any[];
+    layouts: any[];
+    backgrounds: any[];
+    locales: any[];
+    fonts: any;
+    ssos: any[];
+    size: string;
+    watermark: any;
+    app: string;
+    env: string;
+    /**
+     * 中心库
+     */
+    central: any;
+    /**
+     * 业务库
+     */
+    business: any;
+    upload: any;
+    version: any;
+    /**
+     * 系统初始化
+     */
+    init(): Promise<void>;
+    /**
+     * 加载设置
+     */
+    load(): Promise<any>;
+}
+export default SettingService;

package/esm/services/SocketService.d.ts

@@ -0,0 +1,23 @@
+declare class SocketService {
+    socket: any;
+    connected: any;
+    reconnect: boolean;
+    handler: any;
+    /**
+     * 登录后，连接Socket
+     */
+    connect(): Promise<void>;
+    /**
+     * 订阅并替换Socket事件处理程序
+     */
+    subscribe(handler?: (event: MessageEvent) => void): void;
+    /**
+     * 取消订阅Socket事件处理程序，防止内存泄漏
+     */
+    unsubscribe(): void;
+    /**
+     * 退出时断开连接
+     */
+    disconnect(): void;
+}
+export default SocketService;

package/esm/services/UserService.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 用户服务
+ */
+declare class UserService {
+    /**
+     * 用户信息
+     */
+    user: any;
+    /**
+     * 接口返回的菜单信息（空:菜单未加载 空数组：匿名用户已加载菜单，但是无菜单；防止未登录状态每次跳转路由都加载菜单）
+     */
+    menus: any;
+    menusFlat: any;
+    /**
+     * 是否调试人
+     */
+    debugger: any;
+    /**
+     * 当前访问环境
+     */
+    env: any;
+    /**
+     * 获取本地缓存中的用户信息；好处：即使手动更改storage数据，也可以里面获取到
+     */
+    getSso(): Promise<any>;
+    /**
+     * 登录后，获取用户信息
+     */
+    loadInfo(): Promise<any>;
+    /**
+     * 未登录，获取匿名登录信息
+     */
+    getAnonymous(): void;
+    /**
+     * 根据路径获取路由
+     */
+    getMenuByUrl(url: string): any;
+    /**
+     * 加载服务端路由
+     */
+    loadMenus(): Promise<any>;
+    /**
+     * 退出登录
+     */
+    logout(): Promise<void>;
+}
+export default UserService;

package/esm/services/index.d.ts

@@ -0,0 +1,15 @@
+import ConfigService from "./ConfigService";
+import DriverService from "./DriverService";
+import EnvService from "./EnvService";
+import LogService from "./LogService";
+import SettingService from "./SettingService";
+import SocketService from "./SocketService";
+import UserService from "./UserService";
+declare let configService: ConfigService;
+declare let driverService: DriverService;
+declare let envService: EnvService;
+declare let logService: LogService;
+declare let settingService: SettingService;
+declare let socketService: SocketService;
+declare let userService: UserService;
+export { configService, driverService, envService, logService, settingService, socketService, userService };

package/esm/services/types/IMessage.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 消息提示接口，下游自己定义
+ */
+interface IMessage {
+    /**
+     * 成功消息提示
+     */
+    success(message: string): void;
+    /**
+     * 错误消息提示
+     */
+    error(message: string): void;
+}
+export default IMessage;

package/esm/services/types/IMessager.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 消息提示接口，下游自己定义
+ */
+interface IMessager {
+    /**
+     * 显示全局成功消息
+     */
+    success(message: string): void;
+    /**
+     * 显示全局警告消息
+     */
+    warning(message: string): void;
+    /**
+     * 显示全局信息消息
+     */
+    info(message: string): void;
+    /**
+     * 显示全局错误消息
+     */
+    error(message: string): void;
+    /**
+     * 显示全局错误消息
+     */
+    confirm(title: string, message: string, options?: any): void;
+    /**
+     * 显示警告框
+     */
+    alert(title: string, message: string, options?: any): void;
+    /**
+     * 通知
+     */
+    notify(title: string, message: string, type: string): void;
+}
+export default IMessager;

package/esm/services/types/index.d.ts

@@ -0,0 +1,2 @@
+import type IMessager from "./IMessager";
+export { IMessager };