@kengic/vue 0.16.6 → 0.16.7

package/dist/src/utils/kg-logger.util.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 日志服务.
+ */
+declare class KgLogger {
+    /**
+     * 打印弃用日志.
+     *
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static deprecated(message: string, args?: Record<string, any>, collapsed?: boolean): void;
+    /**
+     * 打印错误日志.
+     *
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static error(message: string, args?: Record<string, any>, collapsed?: boolean): void;
+    /**
+     * 打印普通日志.
+     *
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static info(message: string, args?: Record<string, any>, collapsed?: boolean): void;
+    /**
+     * 打印日志.
+     *
+     * @param level 日志等级.
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     * @param style 样式.
+     */
+    static log(level: "debug" | "info" | "warn" | "error" | "deprecated" | undefined, message: string, args?: Record<string, any>, collapsed?: boolean, style?: string | null): void;
+    /**
+     * 打印警告日志.
+     *
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static warn(message: string, args?: Record<string, any>, collapsed?: boolean): void;
+    /**
+     * 打印调试日志.
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static debug(message: string, args?: Record<string, any>, collapsed?: boolean): void;
+    /**
+     * 打印调试日志: DDA.
+     * @param formID 界面标识.
+     * @param component 组件.
+     * @param method 方法.
+     * @param message 提示消息.
+     * @param args 数据对象.
+     * @param collapsed 是否折叠.
+     */
+    static debugDDA(formID: string | null | undefined, component: string | null | undefined, method: string | null | undefined, message: string | null | undefined, args?: Record<string, any>, collapsed?: boolean): void;
+}
+export { KgLogger };

package/dist/src/utils/kg-route.util.d.ts

@@ -0,0 +1,54 @@
+import { KG_APP, Menu } from '../consts';
+export declare class KgRouteUtil {
+    /**
+     * 给所有模块都添加在线表单的路由.
+     * 由于默认的在线表单路由是没有区分模块的, 而每个模块下都可能有在线表单, 因此给每个模块都添加在线表单的路由.
+     * @param routes 当前路由列表.
+     */
+    static addOnlineRoutesForAllApps(routes: any[]): any[];
+    /**
+     * 根据地址获取菜单.
+     * @param menus 菜单列表.
+     * @param path 地址.
+     * @return {} 如果能找到某个菜单的地址等于传入的地址, 则返回该菜单, 否则返回 null.
+     */
+    static getMenuByPath(menus: Array<Menu> | null | undefined, path: string): Menu | null;
+    /**
+     * 获取第一个类型为叶子节点的菜单, 即第一个没有下级菜单的菜单, 即第一个拥有页面的菜单.
+     * 如果参数 app 不为空, 表示只在该模块的菜单中找; 否则在所有的菜单中找.
+     * @param app 模块.
+     * @return {} 如果能找到, 则返回该菜单, 否则返回 null.
+     */
+    static getFirstLeafMenu(app?: KG_APP | null): Menu | null;
+    /**
+     * 翻译菜单标题.
+     * @param menus 菜单列表, 树形结构.
+     * @param titleKey 标题的属性名, 即要将哪个属性作为菜单的标题.
+     */
+    static translateMenus(menus: Array<Menu> | null | undefined, titleKey?: string): Array<Menu>;
+    /**
+     * 转换菜单列表.
+     *     1. 根据模块分组,
+     * @param menus 菜单列表, 树形结构.
+     */
+    static transformMenus(menus: Array<Menu> | null | undefined): Array<Menu>;
+    /**
+     * 判断某个路径是否属于某个模块.
+     * @param path 路径.
+     * @param app 模块.
+     */
+    static isPathInApp(path: string | null | undefined, app: KG_APP | null): boolean;
+    /**
+     * 根据地址获取模块.
+     * @param path 地址.
+     * @return {} 地址所属模块.
+     */
+    static getAppByPath(path: string): KG_APP | null;
+    /**
+     * 获取模块的首页地址.
+     * @param app 模块.
+     * @return {} 该模块的首页地址.
+     * @throws {} 如果模块无法识别, 会报错.
+     */
+    static getAppIndexPath(app: KG_APP): string;
+}

package/dist/src/utils/kg-var.util.d.ts

@@ -0,0 +1,36 @@
+import dayjs from 'dayjs';
+import { KG_FORM_ITEM_TYPE } from '../consts';
+/**
+ * 变量相关工具.
+ */
+export declare class KgVarUtil {
+    /**
+     * 将 JSON 字符串形式的参数 `'{"foo":1,"bar":2}'` 转换为对象形式的参数 `{ "foo": 1, "bar": 2 }`.
+     * @param params JSON 字符串形式的参数.
+     * @return {} 参数对象.
+     */
+    static parseCommandParameter(params?: string | null): Record<string, any>;
+    /**
+     * 根据控件类型, 将任意的值(可能非法)转换为合法的值.
+     * @param frm_id 界面标识.
+     * @param var_name 变量名称.
+     * @param $dayjs dayjs.
+     * @param value 原始的值.
+     * @param op 操作类型. C: 创建, R: 查询, U: 更新, D: 删除, CP: 复制.
+     * @return {} 转换后的合法的值.
+     */
+    static transformFormItemValue(frm_id: string, var_name: string, $dayjs: typeof dayjs, value: any, op: 'C' | 'R' | 'U' | 'D' | 'CP'): any;
+    /**
+     * 根据控件类型, 将任意的高级查询操作符(可能非法)转换为合法的值.
+     * @param frm_id 界面标识.
+     * @param var_name 变量名称.
+     * @param value 原始的高级查询操作符.
+     * @return {} 转换后的合法的值.
+     */
+    static transformFormItemDynamicQueryOperator(frm_id: string, var_name: string, value: string | null | undefined): string;
+    /**
+     * 根据控件类型获取高级查询操作符的下拉列表.
+     * @param controlType 控件类型.
+     */
+    static getDynamicQueryOperatorSelectOptions(controlType: KG_FORM_ITEM_TYPE): any;
+}

package/dist/src/utils/kg.util.d.ts

@@ -0,0 +1,114 @@
+import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
+import dayjs, { Dayjs } from 'dayjs';
+import { IKgButtonModalProps } from '../consts';
+/**
+ * 通用工具.
+ */
+export declare class KgUtil {
+    /**
+     * 根据'文件大小数值'获取'文件大小文本'.
+     * @param size 文件大小数值.
+     */
+    static getFileSize(size: any): string;
+    /**
+     * BASE64 转换为 BLOB.
+     * @param base64 base64 字符串.
+     * @param contentType 文件类型.
+     * @param sliceSize 分块大小.
+     */
+    static base64toBlob(base64: string, contentType: string, sliceSize?: number): Blob;
+    /**
+     * 下载文件.
+     * @param data 文件数据.
+     * @param fileName 文件名称, 包含后缀.
+     * @param contentType 文件类型.
+     */
+    static downloadFile(data: string | BlobPart, fileName: string, contentType?: string): void;
+    /**
+     * <p>处理请求参数.</p>
+     * <ol>
+     *     <li>填充通用参数的值:
+     *         <ul>
+     *             <li>仓库: '{WAREHOUSE}'</li>
+     *         </ul>
+     *     </li>
+     * </ol>
+     * @param params 请求参数.
+     * @param formID 界面标识.
+     * @param $dayjs dayjs.
+     */
+    static parseParams(params: Record<string, any> | null | undefined, formID?: string | null, $dayjs?: typeof dayjs): Record<string, any>;
+    /**
+     * <p>获取高级查询的各个请求头的值.</p>
+     * <p>处理查询参数, 最终拼接为一个 SQL 格式如下: `WHERE ... ORDER BY ...`.</p>
+     * <p>
+     *     参数 formID 和 operators 只能其中一个传值.
+     *     <ul>
+     *         <li>如果 formID 传值, 表示通过变量配置获取各个字段的高级查询操作符.</li>
+     *         <li>如果 operators 传值, 表示直接使用传入的 operators 作为各个字段的高级查询操作符.</li>
+     *     </ul>
+     * </p>
+     * <ol>
+     *     <li>填充通用参数的值:
+     *         <ul>
+     *             <li>仓库: '{WAREHOUSE}'</li>
+     *         </ul>
+     *     </li>
+     * </ol>
+     * @param params 请求参数.
+     * @param formID 界面标识.
+     * @param operators 各个字段的高级查询操作符.
+     * @param $dayjs dayjs.
+     * @return {} 拼接好的 SQL.
+     */
+    static getQuerySql(params: Record<string, any> | null | undefined, formID: string | null | undefined, operators: Record<string, any> | null | undefined, $dayjs: typeof dayjs): {
+        sql: string;
+        whereSql: string;
+        orderBySql: string;
+    };
+    /**
+     * 处理请求参数: 解析字符串类型的参数值.
+     * @param value 参数的原始值.
+     */
+    private static parseParamFromString;
+    /**
+     * 处理请求参数: 解析 DayJS 类型的参数值.
+     * @param key 属性名.
+     * @param value 参数的原始值.
+     * @param formID 界面标识.
+     * @param isPad 是否补齐日期格式. 即将 `YYYY-MM-DD` 补齐为 `YYYY-MM-DD 00:00:00`, 将 `HH:mm:ss` 补齐为 `1900-01-01 HH:mm:ss`.
+     */
+    private static parseParamFromDayJS;
+    /**
+     * 确认弹窗.
+     * 设置了多个属性的默认值, 简化使用.
+     * https://www.antdv.com/components/modal
+     * @param props
+     */
+    static confirm(props: IKgButtonModalProps): ModalFunc;
+    /**
+     * 如果不是表单验证错误, 则抛出该错误.
+     * @param e 错误对象.
+     */
+    static throwIfNotFormError(e: any): void;
+    /**
+     * 将 JSON 字符串转换为 JSON 对象, 如果转化失败, 则返回空对象.
+     * @param str JSON 字符串.
+     */
+    static tryParseJSON<T = Record<string, any>>(str?: string | null): T;
+    /**
+     * 将值转换为 Dayjs 对象.
+     * @param value 值.
+     */
+    static toDayjs(value: any): Dayjs | undefined;
+    /** 显示全局遮罩. */
+    static showLoading(): void;
+    /** 隐藏全局遮罩. */
+    static hideLoading(): void;
+}
+export declare type ModalFunc = {
+    destroy: () => void;
+    update: (configUpdate: ModalFuncProps | ((prevConfig: ModalFuncProps) => ModalFuncProps)) => void;
+    showLoading(): void;
+    hideLoading(): void;
+};

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "@kengic/vue",
-    "version": "0.16.6",
+    "version": "0.16.7",
     "scripts": {
-        "build": "npm run switch-node-version && rimraf dist && vite build",
-        "build:dev": "npm run switch-node-version && rimraf dist && vite build --mode development",
+        "build": "npm run switch-node-version && rimraf dist && vue-tsc && vite build",
+        "build:dev": "npm run switch-node-version && rimraf dist && vue-tsc && vite build --mode development",
         "--------------------------------------------------": "",
         "publish:all:beta": "npm run bump-version:beta && npm run publish:all",
         "publish:all:patch": "npm run bump-version:patch && npm run publish:all",
@@ -69,7 +69,8 @@
         "tsx": "3.12.3",
         "typescript": "~4.8.4",
         "vite": "3.2.5",
-        "vue": "3.2.43"
+        "vue": "3.2.43",
+        "vue-tsc": "1.8.27"
     },
     "main": "./dist/kengic-vue.js",
     "module": "./dist/kengic-vue.js",
@@ -82,7 +83,7 @@
     },
     "prettier": {
         "endOfLine": "auto",
-        "printWidth": 160,
+        "printWidth": 120,
         "semi": true,
         "singleQuote": true,
         "tabWidth": 4,