@kengic/vue 0.26.6-beta.10 → 0.26.6-beta.12

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

@@ -0,0 +1,150 @@
+import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
+import dayjs, { Dayjs } from 'dayjs';
+import { IKgVarButtonModalProperties } 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 <p>文件类型. 如果为空, 则根据文件名的后缀自动设置.</p>
+     *                    <ul>
+     *                        <li>{@link KG__VAR_BUTTON__EXPORT_EXCEL_SUFFIX.XLS}: <code>application/vnd.ms-excel</code></li>
+     *                        <li>{@link KG__VAR_BUTTON__EXPORT_EXCEL_SUFFIX.XLSX}: <code>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code></li>
+     *                    </ul>
+     */
+    static downloadFile(data: string | BlobPart, fileName: string, contentType?: string): void;
+    /**
+     * <p>处理请求参数.</p>
+     * <ul>
+     *     <li>删除无用属性,</li>
+     *     <li>日期转换为字符串,</li>
+     *     <li>解析动态属性, 比如「仓库号」,</li>
+     * </ul>
+     *
+     * @param params 请求参数.
+     * @param formID 界面标识.
+     * @param $dayjs dayjs.
+     */
+    static parseParams(params: Record<string, any> | null | undefined, formID?: string | null, $dayjs?: typeof dayjs): Record<string, any>;
+    /**
+     * 处理请求参数: 解析字符串类型的参数值.
+     *
+     * <ol>
+     *     <li>填充通用参数的值:
+     *         <ul>
+     *             <li>{WAREHOUSE}: 当前仓库编号</li>
+     *             <li>{WORK_STATION}: 当前工作站</li>
+     *             <li>{WORK_AREA}: 当前工作区</li>
+     *             <li>{LOCALE}: 当前语言</li>
+     *             <li>{NOW}: 当前时间</li>
+     *             <li>{USER}: 当前用户</li>
+     *             <li>{ROW}: 当前勾选行对应的属性</li>
+     *         </ul>
+     *     </li>
+     * </ol>
+     *
+     * @param param.$dayjs dayjs.
+     * @param param.formID 界面标识.
+     * @param param.value 参数的原始值.
+     * @param param.varName 变量名称.
+     */
+    static parseParamFromString(param: {
+        $dayjs?: typeof dayjs;
+        formID?: string | null;
+        value: string;
+        varName?: string | null;
+    }): string;
+    /**
+     * 处理请求参数: 解析 Dayjs 类型的参数值.
+     * @param param.formID 界面标识.
+     * @param param.isPad 是否补齐日期格式. 即将 `YYYY-MM-DD` 补齐为 `YYYY-MM-DD 00:00:00`, 将 `HH:mm:ss` 补齐为 `1900-01-01 HH:mm:ss`.
+     * @param param.key 属性名.
+     * @param param.value 参数的原始值.
+     */
+    static parseParamFromDayjs(param: {
+        formID?: string | null;
+        isPad?: boolean;
+        key: string;
+        value: any;
+    }): string;
+    /**
+     * 确认弹窗.
+     * 设置了多个属性的默认值, 简化使用.
+     * https://www.antdv.com/components/modal
+     * @param props
+     */
+    static confirm(props: IKgVarButtonModalProperties): ModalFunc;
+    /**
+     * @deprecated 已弃用, 请使用 {@link KgUtil.throwNotFormValidationError()} 方法.
+     */
+    static throwIfNotFormError(e: any): void;
+    /**
+     * <p>如果不是表单验证错误, 则直接抛出该错误.</p>
+     * <p>如果是表单验证错误, 则弹框提示表单验证失败消息.</p>
+     *
+     * @param param.error 错误对象.
+     * @param param.formID 界面标识. 通过界面标识可以显示对应字段的翻译, 否则只能显示对应字段的变量名称.
+     * @param param.isShowFormValidationErrorMessage 是否弹框提示表单验证失败消息. 默认为 true.
+     */
+    static throwNotFormValidationError(param: {
+        error: {
+            errorFields: Array<{
+                errors: Array<string>;
+                name: Array<string>;
+                warnings: Array<any>;
+            }>;
+            outOfDate: boolean;
+            values: Record<string, any>;
+        } | any;
+        formID?: string;
+        isShowFormValidationErrorMessage?: boolean;
+    }): 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;
+    /**
+     * <p>使用 lodash 的 snakeCase() 将字符串转换为 snake_case 的命名方式. 但是数字前面不加下划线.</p>
+     *
+     * @param value 转换前的字符串.
+     * @return 转换后的字符串.
+     */
+    static snakeCase(value: any): string;
+    /**
+     * 获取唯一标识.
+     *
+     * @return UUID.
+     */
+    static uuid(): string;
+}
+export declare type ModalFunc = {
+    destroy: () => void;
+    update: (configUpdate: ModalFuncProps | ((prevConfig: ModalFuncProps) => ModalFuncProps)) => void;
+    showLoading(): void;
+    hideLoading(): void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/vue",
-    "version": "0.26.6-beta.10",
+    "version": "0.26.6-beta.12",
     "scripts": {
         "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",
@@ -40,7 +40,7 @@
         "@iconify-icons/mdi": "1.2.48",
         "@iconify-icons/ph": "1.2.5",
         "@iconify/vue": "4.1.1",
-        "@kengic/core": "6.0.1-beta.12",
+        "@kengic/core": "6.0.1-beta.13",
         "@kengic/pont": "1.2.17-beta.1",
         "@rys-fe/vite-plugin-theme": "0.8.6",
         "@thymine/xunee": "0.4.9-beta.8",