halo-fe 1.0.0

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

@@ -0,0 +1,14 @@
+/**
+ * 事件挂载帮助类
+ */
+declare class MountHelper {
+    /**
+     * 激发主框架事件
+     */
+    static emit: (event: string, payload: any) => void;
+    /**
+     * 批量激发主框架事件
+     */
+    static emits: (events: any) => void;
+}
+export default MountHelper;

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

@@ -0,0 +1,34 @@
+/**
+ * 对象帮助类
+ */
+declare class ObjectHelper {
+    /**
+     * 净化对象，返回不带默认属性的对象
+     */
+    static pure(input: object): {};
+    /**
+     * 过滤key，并输出新对象
+     */
+    static filter(input: object, filter: (n: any) => boolean, valueHandler: (n: any) => {}): any[];
+    /**
+     * 把数组转换成对象
+     */
+    static toObject(array: any[], keySelector: (n: any) => string, valueSelector: (n: any) => string): {};
+    /**
+     * 手动复制，并对字段执行指定自定义处理
+     */
+    static copy: (obj: any, handler?: {}) => any[] | any;
+    /**
+     * 对对象进行深度克隆，同时可以移除Proxy对象
+     */
+    static clone: (obj: any, handler?: (n: any) => void) => any;
+    /**
+     * 合并来源对象到目标对象上
+     */
+    static mergeTo: (target: any, from: any) => any;
+    /**
+     * 给对象添加属性集合，并赋值
+     */
+    static addProperties: (obj: object, keys: string[], value: string) => void;
+}
+export default ObjectHelper;

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

@@ -0,0 +1,31 @@
+/**
+ * 脚本帮助类
+ */
+declare class ScriptHelper {
+    /**
+     * 异步加载脚本/样式内容，把内容处理为行内html
+     * 这种方式，依赖的内部资源，会从当前站点加载
+     */
+    static loadContentAsync: (src: string | string[]) => Promise<void[]>;
+    /**
+     * 异步加载单个路径下的多个文件
+     */
+    static loadPathAsync: (path: string, files: string[]) => Promise<void>;
+    /**
+     * 通过注入DOM标签异步加载脚本或样式表
+     */
+    static loadAsync: (src: string | string[]) => Promise<void>;
+    /**
+     * 注意：箭头函数没有参数
+     */
+    static loadAll: (...args: any[]) => Promise<any[]>;
+    /**
+     * 根据路径获取标签（无src）
+     */
+    static getInnerTagByUrl: (url: string) => HTMLStyleElement | HTMLScriptElement;
+    /**
+     * 根据路径获取待加载的元素，同时包含Url
+     */
+    static getOuterTagByUrl: (url: string) => HTMLLinkElement | HTMLScriptElement;
+}
+export default ScriptHelper;

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

@@ -0,0 +1,14 @@
+/**
+ * 滚动帮助类
+ */
+declare class ScrollHelper {
+    /**
+     * 判断指定元素滚动条位置，是否到了页面底部
+     */
+    static isBottom: (selector: any) => boolean;
+    /**
+     * 滚动指定元素的滚动条到页面底部
+     */
+    static scrollToBottom: (selector: any) => void;
+}
+export default ScrollHelper;

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

@@ -0,0 +1,14 @@
+/**
+ * 签名帮助类
+ */
+declare class SignHelper {
+    /**
+     * 清空对象中的空值
+     */
+    static clean(obj: object): void;
+    /**
+     * 签名字典
+     */
+    static signDictionary(dictionary: object, encoding?: boolean): string;
+}
+export default SignHelper;

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

@@ -0,0 +1,34 @@
+/**
+ * 存储帮助类
+ */
+declare class StorageHelper {
+    /**
+     * 获取本地存储
+     */
+    static get: (key: string, value?: any) => any;
+    /**
+     * 设置本地存储
+     */
+    static set: (key: string, value: string) => void;
+    /**
+     * 获取本地存储
+     */
+    static getObject: (key: string) => any;
+    /**
+     * 设置本地存储
+     */
+    static setObject: (key: string, value: any) => void;
+    /**
+     * 移除存储数据
+     */
+    static remove: (key: string) => void;
+    /**
+     * 以5M为基准，获取剩余可用容量(KB)
+     */
+    static getLeftStorage: () => number;
+    /**
+     * 判断指定值是否能够存储到storage中
+     */
+    static canStorage: (value: object) => boolean;
+}
+export default StorageHelper;

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

@@ -0,0 +1,94 @@
+/**
+ * 字符串帮助类
+ */
+declare class StringHelper {
+    /**
+     * 生成唯一字符串
+     */
+    static getUniqueId: () => string;
+    /**
+     * 填充字符串到指定长度，使用pad填充
+     */
+    static padLeft: (value: string, length: number, pad: string) => any;
+    /**
+     * 去掉头部字符串
+     */
+    static trimStart: (value: string, trim: string) => string;
+    /**
+     * 去掉尾部字符串
+     */
+    static trimEnd: (value: string, trim: string) => string;
+    /**
+     * 去掉头尾字符串
+     */
+    static trim: (value: string, start: string, end: string) => string;
+    /**
+     * 获取中划线命名法
+     */
+    static getDashName: (value: string) => string;
+    /**
+     * 忽略大小写包含判断，支持从数组中搜索关键词
+     */
+    static containsIgnoreCase: (keywords: string, value: string | string[]) => boolean;
+    /**
+     * 从html中提取纯文本
+     */
+    static getTextFromHtml: (html: string) => string;
+    /**
+     * 判断是否是数字类型，这样支持0
+     */
+    static isNumber: (value: any) => boolean;
+    /**
+     * 验证是否是邮箱格式
+     */
+    static isEmail: (email: string) => boolean;
+    /**
+     * 判断是否是json
+     */
+    static isJson: (value: string) => boolean;
+    /**
+     * 判断是否是isJsonp
+     */
+    static isJsonp: (value: string) => boolean;
+    /**
+     * 判断是否是html
+     */
+    static isHtml: (value: string) => boolean;
+    /**
+     * 获取内容类型
+     */
+    static getContentType: (value: string) => "json" | "html" | "text";
+    /**
+     * 判断字符串是否为空或空串
+     */
+    static isNullOrEmpty: (value: string) => boolean;
+    /**
+     * 判断字符串是否为空或空串
+     */
+    static isEmpty: (value: string) => value is "";
+    /**
+     * 判断是否符合密码要求
+     */
+    static isPassword: (value: string) => boolean;
+    /**
+     * 获取数据值或者空
+     */
+    static getNumberOrNull: (value: any) => number;
+    /**
+     * 格式化成留指定位数的小数
+     */
+    static format: (value: string, digits: number) => any;
+    /**
+     * 获取两个字符串之间的字符串
+     */
+    static getBetween: (value: string, start: string, end: string) => string;
+    /**
+     * 根据字符串或数组，自动返回数组
+     */
+    static getArray(name: string | string[]): string[];
+    /**
+     * 忽略大小写比较
+     */
+    static equalsIgnoreCase(value: any, valueCompare: string): boolean;
+}
+export default StringHelper;

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,62 @@
+/**
+ * 时间帮助类
+ */
+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) => string;
+    /**
+     * 添加月份
+     */
+    static addMonths: (value: any, months: number) => string;
+    /**
+     * 判断指定时间是否是周末
+     */
+    static isWeekend: (value: any) => boolean;
+    /**
+     * 把中国时间，转换为当地时间
+     */
+    static localeTime: (time: any) => string;
+}
+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): string;
+    /**
+     * 把指定base64字符串解析为原对象
+     */
+    static base64Decode(val: string): any;
+    /**
+     * 是否是http或https开头的地址
+     */
+    static httpOrHttps(url: string): boolean;
+}
+export default UrlHelper;

package/esm/main.d.ts

@@ -0,0 +1,3 @@
+export * from "./drivers/index";
+export * from "./helpers/index";
+export * from "./services/index";

package/esm/services/SettingService.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 获取前端配置
+ */
+declare let SettingService: any;
+export default SettingService;

package/esm/services/index.d.ts

@@ -0,0 +1,15 @@
+import SettingService from "./SettingService";
+/**
+ * 消息提示接口，下游自己定义
+ */
+interface IMessageService {
+    /**
+     * 成功消息提示
+     */
+    success(message: string): void;
+    /**
+     * 错误消息提示
+     */
+    error(message: string): void;
+}
+export { IMessageService, SettingService };

package/esm/stores/config.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 使用配置仓储
+ */
+declare let useConfigStore: import("pinia").StoreDefinition<"config", {
+    /**
+     * 默认背景
+     */
+    background: any;
+    /**
+     * 当前主题
+     */
+    theme: any;
+    /**
+     * 当前布局方式
+     */
+    layout: any;
+    /**
+     * 当前语言
+     */
+    language: any;
+    /**
+     * 字体
+     */
+    font: any;
+    /**
+     * 文件布局方式
+     */
+    fileLayout: any;
+    /**
+     * 请求器
+     */
+    requester: import("../drivers").IRequester;
+}, {}, {
+    /**
+     * 初始化配置值（不一定跟登录用户相关，这也是单独分离的好处）
+     */
+    init(configs: any[]): void;
+    /**
+     * 获取本地配置
+     */
+    getLocalConfig(type: string): any;
+    /**
+     * 设置背景
+     */
+    setBackground(background: string): void;
+    /**
+     * 加载用户配置
+     */
+    loadConfig(type: string, cached?: boolean): Promise<any>;
+    /**
+     * 全量保存用户配置
+     */
+    saveConfig(type: string, data: any, cached?: boolean): Promise<any>;
+    /**
+     * 部分保存用户配置
+     */
+    patchConfig(type: string, pairs: any): Promise<any>;
+}>;
+export default useConfigStore;

package/esm/stores/driver.d.ts

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

package/esm/stores/env.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 前端环境仓储
+ */
+declare let useEnvStore: import("pinia").StoreDefinition<"env", {
+    env: any;
+}, {}, {
+    /**
+     * 使用环境变量
+     */
+    useEnv(env: any): void;
+}>;
+export default useEnvStore;

package/esm/stores/index.d.ts

@@ -0,0 +1,7 @@
+import useConfigStore from "./config";
+import useSettingStore from "./setting";
+import useLogStore from "./log";
+import useUserStore from "./user";
+import useSocketStore from "./socket";
+import useDriverStore from "./driver";
+export { useConfigStore, useSettingStore, useLogStore, useUserStore, useSocketStore, useDriverStore };

package/esm/stores/log.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 使用日志仓储
+ */
+declare let useLogStore: import("pinia").StoreDefinition<"log", {
+    logs: any[];
+}, {}, {
+    /**
+     * 手动添加日志
+     */
+    add(code: string, message: string, stack: string, elapsed?: number): void;
+    /**
+     * 删除日志
+     */
+    remove(index: number): void;
+    /**
+     * 清空日志
+     */
+    clear(): void;
+}>;
+export default useLogStore;