@skyfox2000/webui 1.3.19 → 1.3.21

package/lib/index.d.ts

@@ -0,0 +1,46 @@
+import { default as router } from './router';
+export { pinia } from './stores/pinia';
+export type { AnyControl, PostOptions, ExecuteOptions, } from './typings/data.d';
+export type { PageControl, PageControlOption, PrimaryKey, } from './typings/page.d';
+export { ProviderKeys } from './typings/page.d';
+export type { GridControl, GridControlOption, } from './typings/table.d';
+export type { EditorControl, EditorControlOption, InputFactoryItems, ValidateRule, ValidateRuleItem, ValidateError, } from './typings/form.d';
+export type { ButtonTool, ButtonTools, ButtonType, IconTool, RowRecord, } from './typings/tools.d';
+export type { TreeControl, TreeControlOption, TreeNode, } from './typings/tree.d';
+export type { UploadFile, MinioFile, ExcelFileParams, } from './typings/upload.d';
+export { UploadStatus } from './typings/upload.d';
+export type { ApiUrls, ReqUrls, } from './typings/urls.d';
+export type { OptionItemProps, OptionProps, SelectValue, } from './typings/option.d';
+export type { BreadcrumbRoute, } from './typings/menu.d';
+export { OPTIONS } from './const/options';
+export { OptionCommProps } from './typings/option.d';
+export { initDirective } from './directives/index';
+export { isEmpty } from './utils/isEmpty';
+export { queryTree } from './utils/tree';
+export { getToolByKey, getToolGroup, getToolStatus, getToolVisible, onReloadClick, onToolClicked, onFullscreenClick, onColumnVisibleChanged, defaultTools, useToolFactory, } from './utils/tools';
+export { initPageFactory, useEditorFactory, useGridFactory, useTreeFactory, usePageFactory, useOptionFactory, } from './utils/page';
+export { loadOption, unloadOption, getSelectedValues, outFormDataFields, onOptionChanged, getSelectedLabels, } from './utils/options';
+export { downloadBlob, donwloadFromMinio, previewFromMinio, CanPreviewFileExt } from './utils/download';
+export { ICONS_LIB, checkIconsExpired, circleLoading, createFromIconfont, parseIcons, getIconTransform, } from './utils/icon-loader';
+export { CacheKeys, Cache, initCacheCheck } from './utils/cache';
+export { initMenu, crumbs, showBreadcrumb } from './utils/menu';
+export { onFormSave, onFormSaveAs, onFormClose, saveForm, getFormDetail, openNewForm, setFormData } from './utils/form';
+export { initValidate, formValidate, validateData, resetRules, getRuleTexts, useInputFactory, useFormItemFactory, } from './utils/form-validate';
+export { validateExcel, checkExcelDuplicates, processExcelFile, appendExcelData, createMarkedExcelView, } from './utils/form-excel';
+export { csvToExcelBlob, processCsvFile } from './utils/form-csv';
+export { csvToNormalized, excelToNormalized, toExcel, csvToExcelView, excelToExcelView, normalizedToExcelView, type NormalizedData, type ExcelViewResult, type ExcelMarkCell, type ExcelMarkInfo, } from './utils/excel-view';
+export { filterColumns, mergeColumns, gridQueryList, gridQueryFind, gridRowUpdate, gridStatusUpdate, getRecordDetail, onGridRowExpand, onGridRowEdit, onGridRowDelete, } from './utils/table';
+export { doQuery, doExecute, doSave, doDelete } from './utils/data';
+export { exportSelectedRows, exportResults } from './utils/export-table';
+export { path, AsyncUploader } from './utils/file-upload';
+export { EventPrefix } from './utils/eventbus';
+export { default as eventBus } from './utils/eventbus';
+export { getHostInfo, getAppInfo, userLogin, userLogout, getToken, getUserInfo } from './utils/main-openapis';
+export { router as AppRouter };
+export { pendingNavigation, routes } from './router';
+export { useAppInfo } from './stores/appInfo';
+export { useHostInfo } from './stores/hostInfo';
+export { useUserInfo } from './stores/userInfo';
+export { usePageInfo } from './stores/pageInfo';
+export { useSettingInfo } from './stores/settingInfo';
+export { Alert, Button, Tooltip, AppIcon, Fullscreen, Helper, Icon, LayoutIcon, ProjectIcon, ToolIcon, Loading, Dialog, Drawer, Form, FormItem, Search, SearchItem, Table, TableOperate, Toolbar, Icontool, Tree, AutoComplete, Cascader, Checkbox, DatePicker, Input, InputIcon, InputPassword, InputNumber, PropEditor, type PropConfigItem, Radio, RadioStatus, RangePicker, Select, Switch, Textarea, TimePicker, Transfer, TransferTable, TreeSelect, UploadList, Breadcrumb, Content, Datetime, Header, HeaderExits, Menu, MenuTabs, } from './components/index';

package/lib/router/index.d.ts

@@ -0,0 +1,15 @@
+import { RouteRecord } from '../../../502424_MicroBase';
+import { RouteLocationNormalizedGeneric, RouteRecordRaw, Router } from 'vue-router';
+import { Ref } from 'vue';
+export declare const LOGIN_PATH = "/login/";
+declare const routes: RouteRecord[];
+export declare const addAppRoutes: (subRoutes: RouteRecord[]) => void;
+export declare const flattenRoute: (route: RouteRecordRaw, flattenRoutes: Record<string, RouteRecord>, parent?: RouteRecord, parentPath?: string) => void;
+declare const router: Router;
+export { routes };
+export declare const pendingNavigation: Ref<{
+    to: RouteLocationNormalizedGeneric;
+    next: Function;
+} | null>;
+export declare const continueNavigation: (defaultPage: string) => void;
+export default router;

package/lib/stores/appInfo.d.ts

@@ -0,0 +1,31 @@
+import { RouteRecordRaw } from 'vue-router';
+import { AppInfo, RouteRecord } from '../../../502424_MicroBase';
+import { Component } from 'vue';
+import { StoreDefinition } from 'pinia';
+export declare const useAppInfo: StoreDefinition<"appInfo", {
+    appInfo: AppInfo & {
+        Routes: RouteRecordRaw[];
+        flattenRoutes: Record<string, RouteRecord>;
+        defaultPage: string;
+    };
+    appList: AppInfo[];
+    CachedComponents: string[];
+    ExcludeComponents: string[];
+    menuLoaded: boolean;
+}, {}, {
+    loadAppList(appList?: AppInfo[]): Promise<void>;
+    getRemoteAppList(): Promise<void>;
+    toDefaultApp(url?: string): Promise<void>;
+    setActiveApp(key: string, appRoutes?: RouteRecord[]): Promise<void>;
+    setAppRoutes(appRoutes: RouteRecord[]): void;
+    formatRoute(path: string): string;
+    push(path: string): void;
+    findRoute(key: string): RouteRecord | undefined;
+    cacheComponent(component: Component, route: {
+        path: string;
+    }): Component;
+    excludeComponent(path: string): void;
+    matchedRoutes(key: string): RouteRecord[];
+    clean(): void;
+    logout(): void;
+}>;

package/lib/stores/hostInfo.d.ts

@@ -0,0 +1,11 @@
+import { HostInfo, MainOpenApis } from '../../../502424_MicroBase';
+import { StoreDefinition } from 'pinia';
+export declare const useHostInfo: StoreDefinition<"hostInfo", {
+    hostInfo: HostInfo;
+}, {}, {
+    getSiteHostApi(): string;
+    loadHostInfo(hostApi: string, hostKey?: string, mainOpenApis?: MainOpenApis): Promise<void>;
+    clear(): void;
+    _setHostInfo(hostInfo: HostInfo | null): void;
+    getHostInfo(): HostInfo;
+}>;

package/lib/stores/pageInfo.d.ts

@@ -0,0 +1,18 @@
+import { StoreDefinition } from 'pinia';
+interface TabPaneProps {
+    key: string;
+    title: string;
+    closable?: boolean;
+    keepAlive?: boolean;
+    content: any;
+}
+interface PageInfo {
+    TabActive: string;
+    TabPanes: TabPaneProps[];
+    TabEnabled: boolean;
+}
+export declare const usePageInfo: StoreDefinition<"pageInfo", PageInfo, {}, {
+    removeTabPane(path: string): void;
+    setTabActive(path: string): Promise<void>;
+}>;
+export {};

package/lib/stores/pinia.d.ts

@@ -0,0 +1,3 @@
+import { Pinia } from 'pinia';
+declare const pinia: Pinia;
+export { pinia };

package/lib/stores/settingInfo.d.ts

@@ -0,0 +1,8 @@
+import { SettingInfo } from '../../../502424_MicroBase';
+import { StoreDefinition } from 'pinia';
+export declare const useSettingInfo: StoreDefinition<"settingInfo", SettingInfo, {}, {
+    setFullscreen(status: boolean): void;
+    setMenuCollapse(status: boolean): void;
+    getTableColumns(pageUrl: string): Record<string, any>[];
+    setTableColumns(pageUrl: string, columns: Record<string, any>[]): void;
+}>;

package/lib/stores/userInfo.d.ts

@@ -0,0 +1,25 @@
+import { ApiResponse } from '../../../502417_fapi';
+import { LoginInfo, UserInfo } from '../../../502424_MicroBase';
+import { StoreDefinition } from 'pinia';
+interface UserState {
+    isLogin: boolean;
+    userInfo: UserInfo;
+    token?: string;
+    refreshToken?: string;
+}
+export declare const useUserInfo: StoreDefinition<"userInfo", UserState, {}, {
+    init(): void;
+    login(loginInfo: LoginInfo, redirect?: boolean): Promise<ApiResponse<LoginInfo> | void>;
+    getRolePermits(appId: string): Promise<boolean>;
+    hasRole(role: string | string[]): boolean;
+    hasPermit(url: string, permitCode: string): boolean;
+    getUserInfo(): UserInfo;
+    setUserInfo(userInfo: UserInfo, token: string): void;
+    getToken(): string;
+    isSuperAdmin(): boolean;
+    isAdmin(): boolean;
+    getUserLevel(): string;
+    clean(): Promise<void>;
+    logout(): Promise<void>;
+}>;
+export {};

package/lib/typings/data.d.ts

@@ -0,0 +1,80 @@
+import { Ref } from 'vue';
+import { PageControl } from './page';
+import { AnyData, ApiResponse, IUrlInfo, ReqParams } from '../../../502417_fapi';
+/**
+ * 任何控制对象的通用接口
+ * 包括TreeControl和GridControl等
+ */
+export interface AnyControl {
+   /**
+    * 所属页面控制器
+    */
+   page: PageControl<AnyData>;
+
+   /**
+    * URL信息
+    */
+   url?: IUrlInfo;
+
+   /**
+    * 是否重新加载相关数据
+    */
+   reload?: Ref<boolean>;
+}
+
+/**
+ * 通用选项
+ */
+export interface PostOptions<T> {
+   /**
+    * Page页面URL的Key
+    */
+   urlKey: string;
+
+   /**
+    * 自定义URL，优先使用
+    */
+   url?: IUrlInfo;
+
+   /**
+    * 执行提示文字
+    * - false时，不显示提示文字
+    * - 空时，显示默认文字
+    */
+   loadingText?: string | boolean;
+
+   /**
+    * 是否隐藏错误提示
+    */
+   hideErrorToast?: boolean;
+
+   /**
+    * 执行参数
+    */
+   params?: ReqParams;
+
+   /**
+    * 处理参数的函数
+    */
+   processParams?: (params: ReqParams) => ReqParams;
+
+   /**
+    * 加载状态引用
+    */
+   loadingState?: Ref<boolean>;
+}
+
+/**
+ * 执行选项
+ */
+export interface ExecuteOptions<T> extends PostOptions<T> {
+   /**
+    * 主键字段名
+    */
+   primaryKey?: string;
+
+   /**
+    * 状态字段名
+    */
+   statusKey?: string;
+}

package/lib/typings/form.d.ts

@@ -0,0 +1,206 @@
+import { AnyData, IUrlInfo, ReqParams } from '../../../502417_fapi';
+import { PageControl } from './page';
+import { default as Validator, RuleItem, ValidateError } from 'async-validator';
+import { Ref, DefineProps } from 'vue';
+import { GridControl } from './table';
+interface ValidateRuleItem extends RuleItem {
+   errors?: ValidateError[];
+}
+type ValidateRule =
+   | ValidateRuleItem
+   | (ValidateRuleItem[] & {
+        required?: boolean;
+        errors?: ValidateError[];
+     });
+
+/**
+ * 弹窗控制默认设置
+ */
+export interface EditorControlOption {
+   /**
+    * 主键名，默认为Id
+    */
+   primaryKey: string | 'Id' | 'id';
+   /**
+    * 保存后自动关闭窗口
+    */
+   autoClose: boolean;
+   /**
+    * 弹窗自动获取详情并赋值给formData
+    * - 默认 false，使用表格的数据
+    * - true 自动获取详情并赋值给formData
+    */
+   autoDetail: boolean;
+   /**
+    * 保存按钮是否可见
+    */
+   saveBtnVisible: boolean;
+   /**
+    * 另存为按钮是否可见
+    */
+   saveAsBtnVisible: boolean;
+}
+
+/**
+ * 页面表单数据交互标准定义
+ */
+export type EditorControl<T> = EditorControlOption & {
+   /**
+    * 表单名称
+    */
+   readonly name: string;
+   /**
+    * 表单是否可见
+    */
+   visible: Ref<boolean>;
+   /**
+    * 表单默认数据
+    */
+   default: Readonly<T>;
+   /**
+    * 所属页面控制器
+    */
+   page: PageControl<AnyData>;
+   /**
+    * 所属表格控制器
+    */
+   grid?: GridControl<AnyData>;
+   /**
+    * 表单保存前判断
+    * @param editorCtrl 表单配置数据
+    * @returns 是否保存
+    */
+   beforeSave?: (params?: ReqParams) => boolean | undefined | void;
+   /**
+    * 表单保存后处理
+    * @param editorCtrl 表单配置数据
+    * @param pageCtrl 页面控制器
+    */
+   afterSave?: (result: ApiResponse<any>) => void | undefined;
+   /**
+    * 表单数据
+    * - Model对象
+    */
+   formData: Ref<T>;
+   /**
+    * 更新数据
+    * - 自定义对象
+    */
+   updateData: Ref<Record<string, any> | undefined>;
+   /**
+    * 表单验证条件
+    * - errors 验证失败信息数组
+    */
+   formRules: Ref<Record<string, ValidateRule> | undefined>;
+   /**
+    * 验证器
+    */
+   ruleValidator?: Validator;
+   /**
+    * 验证结果
+    * @example
+    * ```ts
+    * const ruleResults: Record<string, ValidateError[]> = {};
+    * fieldNames.forEach((fieldName) => {
+    *    const rule = formRules[fieldName];
+    *    if (rule) {
+    *       ruleResults[fieldName] = [
+    *          {
+    *             field: fieldName,
+    *             fieldValue: fieldValue,
+    *             message: `数据重复`,
+    *          },
+    *       ];
+    *    }
+    * });
+    * ```
+    */
+   ruleResults: Ref<Record<string, ValidateError[]> | undefined>;
+   /**
+    * 表单存储接口
+    *  - 优先使用
+    *  - 或使用PageData.urls.save
+    */
+   saveUrl?: IUrlInfo;
+   /**
+    * 获取详情接口
+    */
+   detailUrl?: IUrlInfo;
+   /**
+    * 表单是否正在执行存储
+    */
+   isFormSaving: Ref<boolean>;
+   /**
+    * 表单详情加载中
+    */
+   isFormLoading: Ref<boolean>;
+   /**
+    * 上级表单
+    */
+   parentEditor?: EditorControl<any>;
+};
+
+/**
+ * 输入项工厂结构
+ */
+export interface InputFactoryItems<T> {
+   /**
+    * 页面表单数据
+    */
+   editorCtrl: EditorControl<T> | undefined;
+   /**
+    * 表单项Label文字
+    */
+   labelText: Ref<string>;
+   /**
+    * 输入项错误列表
+    */
+   // ruleErrors: Ref<ValidateError[] | undefined>;
+   /**
+    * 输入项验证规则名
+    */
+   ruleKey: Ref<string>;
+   /**
+    * 输入项错误状态
+    */
+   errInfo?: Ref<{ msg: string; errClass: string }>;
+   /**
+    * 输入项属性
+    */
+   inputProps?: DefineProps;
+   /**
+    * 输入项reload事件处理
+    * @param event 事件名
+    * @param params 参数
+    * @returns
+    */
+   reloadHandler?: (event: string, params: Record<string, AnyData> | AnyData[]) => void;
+   /**
+    * 输入项事件
+    * @param evt 事件
+    * @param args 参数
+    * @returns
+    */
+   inputEmit?: (evt: any, ...args) => void;
+}
+
+/**
+ * 属性编辑器配置项
+ */
+export interface PropConfigItem {
+   id: number;
+   /**
+    * 文本
+    */
+   text?: string;
+   /**
+    * 配置名
+    */
+   field: string;
+   /**
+    * 配置值
+    */
+   value: string;
+}
+
+export type { ValidateRule, ValidateRuleItem, ValidateError };

package/lib/typings/menu.d.ts

@@ -0,0 +1,7 @@
+export interface BreadcrumbRoute {
+   index?: number;
+   path: string;
+   breadcrumbName: string;
+   icon?: string;
+   children?: Array<BreadcrumbRoute>;
+}

package/lib/typings/option.d.ts

@@ -0,0 +1,209 @@
+import { AnyData, IUrlInfo, ReqParams } from '../../../502417_fapi';
+import { Ref, ShallowRef, PropType } from 'vue';
+import { InputFactoryItems } from './form.d';
+type RawValue = string | number;
+export type SelectValue = RawValue | RawValue[];
+/**
+ * 选项基础属性
+ */
+export interface OptionItemProps {
+   label: string;
+   title?: string;
+   value: string | number | undefined;
+   key?: string | number;
+   role?: string | string[];
+   permit?: string;
+   [key: string]: AnyData;
+}
+
+/**
+ * 选项类公共属性接口
+ */
+export interface OptionProps {
+   /**
+    * 选项数据接口
+    */
+   url?: IUrlInfo;
+   /**
+    * 自定义选项数据, 优先级高于optionCtrl.data
+    */
+   data?: OptionItemProps[];
+   /**
+    * 表单数据
+    */
+   formData?: Record<string, any>;
+   /**
+    * 返回文字内容或文字内容数组
+    */
+   labels?: string | number | (string | number)[];
+   /**
+    * 输出字段转换控制
+    * - Key：目的字段
+    * - Value：源字段，支持模板 ${}
+    */
+   outFields?: Record<string, string>;
+   /**
+    * 通过消息重载数据，只允许改变查询条件
+    * - eventBus.on(组件限定前缀 +"."+ reloadEvent, { Q参数 } | 数据[])
+    * - 数据组仅用于联动显示
+    * - 其它情况使用Query参数
+    */
+   reloadEvent?: string;
+   /**
+    * 通过消息触发事件，只允许改变查询条件
+    * - eventBus.emit(changeEvent, { Q参数 } | 数据[])
+    * - 数据组仅用于联动显示
+    * - 其它情况使用Query参数
+    * - 第一个参数为事件名，第二个参数为事件参数模板，支持模板 ${selectedValues}
+    */
+   changeEvent?: [string | string[], string];
+   /**
+    * 选项控制器
+    */
+   optionCtrl?: OptionControl;
+}
+
+/**
+ * 选项类props公共属性
+ */
+export const OptionCommProps = {
+   /**
+    * 选项数据接口
+    */
+   url: {
+      type: Object as PropType<IUrlInfo>,
+      required: false,
+   },
+   /**
+    * 选项数据
+    */
+   data: {
+      type: Array as PropType<OptionItemProps[]>,
+      required: false,
+   },
+   /**
+    * 返回文字内容或文字内容数组
+    */
+   labels: {
+      type: [String, Number, Array] as PropType<string | number | (string | number)[]>,
+      required: false,
+   },
+   /**
+    * 表单数据
+    */
+   formData: {
+      type: Object as PropType<Record<string, any>>,
+      required: false,
+   },
+   /**
+    * 输出字段转换控制
+    * - Key：目的字段，支持 "." 嵌套
+    * - Value：源字段，支持模板 ${} 或者 ${index} 或者 ${index}.${key}
+    */
+   outFields: {
+      type: Object as PropType<Record<string, string>>,
+      required: false,
+   },
+   /**
+    * 通过消息重载数据，只允许改变查询条件
+    * - eventBus.on(组件限定前缀 +"."+ reloadEvent, { Q参数 } | 数据[])
+    * - 数据组仅用于联动显示
+    * - 其它情况使用Query参数
+    */
+   reloadEvent: {
+      type: String as PropType<string>,
+      required: false,
+   },
+   /**
+    * 通过消息触发事件，只允许改变查询条件
+    * - eventBus.emit(changeEvent, { Q参数 } | 数据[])
+    * - 数据组仅用于联动显示
+    * - 其它情况使用Query参数
+    * - 第一个参数为事件名，第二个参数为事件参数模板，支持模板 ${selectedValues}
+    */
+   changeEvent: {
+      type: Array as PropType<[string | string[], string]>,
+      required: false,
+   },
+   optionCtrl: {
+      type: Object as PropType<OptionControl>,
+      required: false,
+   },
+};
+
+/**
+ * 表格控制默认设置
+ */
+export type OptionControlOption = {
+   /**
+    * 是否显示全部选项
+    * - 默认为false
+    */
+   all: boolean;
+   /**
+    * 全部选项值
+    * 自定义全部选项的值
+    * 如果all为true，则显示全部选项
+    * 未设置allValue，则默认[0, 1]
+    */
+   allValue: string | number | string[] | number[] | undefined;
+   /**
+    * 自动加载数据
+    */
+   autoload: boolean;
+   /**
+    * 字段转换控制
+    * - Key：目的字段
+    * - Value：源字段，支持模板 ${}
+    */
+   fieldMap?: Record<string, string>;
+};
+
+/**
+ * 选项数据交互标准定义
+ */
+export type OptionControl = OptionControlOption & {
+   /**
+    * 输入项工厂
+    */
+   inputFactory?: ShallowRef<InputFactoryItems<any>>;
+   /**
+    * 重新加载数据
+    */
+   reload: Ref<boolean>;
+   /**
+    * 当前查询条件
+    */
+   optionQuery?: ReqParams;
+   /**
+    * 当前传入数据
+    */
+   data: ShallowRef<OptionItemProps[] | undefined>;
+   /**
+    * 实际选项数据
+    * - 已转换fieldMap
+    */
+   options: Ref<OptionItemProps[]>;
+   /**
+    * 基础选中数据
+    */
+   selected: Ref<RawValue | RawValue[] | undefined | null>;
+   /**
+    * 选中数据
+    */
+   selectedOptions: Ref<OptionItemProps | OptionItemProps[] | undefined | null>;
+   /**
+    * 查询接口
+    *  - 优先使用
+    *  - 或使用PageData.urls.option
+    */
+   url?: IUrlInfo;
+   /**
+    * 额外查询参数
+    */
+   params?: ReqParams;
+   /**
+    * 是否正在加载中
+    */
+   isOptionLoading: Ref<boolean>;
+};