@gonsin/gview 2.1.12 → 2.1.14

package/dist/types/types/view.d.ts

@@ -0,0 +1,326 @@
+import type { PrimaryTableCol } from "tdesign-vue-next";
+/**
+ * @description 视图信息 一个页面的总描述
+ */
+export interface ViewInfo {
+    /**
+     * 页面名字，必须唯一，跳转页面时需要用到
+     */
+    viewName: string;
+    /**
+     * 页面标题
+     */
+    title: string;
+    /**
+     * 页面所拥有的 board
+     */
+    boards: ViewBoard[];
+    /**
+     * 该页面所需的参数
+     */
+    props: string[];
+    /**
+     * 2023 11 20 新增
+     * 后台传递到前端预设值 props，默认为空
+     */
+    serverPorps: object;
+}
+export interface ViewBoardData {
+    /**
+     * @description 用于调用接口
+     */
+    dataId: string;
+    /**
+     * @description 获取数据之后主键的名字
+     */
+    keyName: string;
+    /**
+     * @description 获取数据之后，value字段的名字（用于显示）
+     */
+    valueName: string;
+    /**
+     * @description  获取数据之后，父字段的名字（用于显示）
+     */
+    parentKeyName?: string;
+    /**
+     * @description  获取数据之后，value字段的名字（用于显示？）
+     */
+    titleName: string;
+    /**
+     * @description: 当 dataId为空，直接使用该数据
+     */
+    data: any;
+}
+/**
+ * @description 区域为每个View（视图）中显示的具体内容的描述
+ */
+export interface ViewBoard {
+    /**
+     * @description 区域类型
+     */
+    boardType?: "table" | "form" | "tab" | "dialog";
+    /**
+     * @description 标题栏的描述
+     */
+    header?: ViewHeader;
+    /**
+     * @description  表格列的描述
+     */
+    columns?: TableColumn[];
+    /**
+     * @description 用于显示多个board作为一个board
+     */
+    tabs?: ViewTab[];
+    /**
+     * 通用数据源
+     */
+    data?: ViewBoardData;
+    /**
+     * @description 表格数据源
+     */
+    tableData?: ViewBoardData;
+    /**
+     * @description 表单类型含有的表单项
+     */
+    formItems?: FormItem[];
+    /**
+     * @description ok按钮的描述
+     */
+    okButton?: ViewButton;
+    /**
+     * @description 取消按钮的描述
+     */
+    cancelButton?: ViewButton;
+}
+export interface ViewPaginationProps {
+    /**
+     * @description 每页数量
+     */
+    count: number;
+    /**
+     * @description 当前页数
+     */
+    page: number;
+    /**
+     * @description 总页数
+     */
+    pageCount: number;
+    /**
+     * @description 总数量
+     */
+    totalCount: number;
+}
+/**
+ * @description 用于显示多个board作为一个board
+ */
+export interface ViewTab {
+    /**
+     * @description tab标题
+     */
+    title: string;
+    /**
+     * @description 包含一个board
+     */
+    board: ViewBoard;
+    /**
+     * 新增服务器预定义 props
+     */
+    serverProps: any;
+}
+/**
+ * @description: 标题栏
+ */
+export interface ViewHeader {
+    /**
+     * @description: 标题栏上显示的按钮
+     */
+    buttons: ViewButton[];
+    /**
+     * @description:  搜索栏
+     */
+    searchBar: {
+        /**
+         * @description:过滤器列表
+         */
+        filters: FormItem[];
+    };
+}
+/**
+ * @description: 表格列
+ */
+export declare type TableColumn = {
+    /**
+     * @description 列的标题
+     */
+    name?: string;
+    /**
+     * @description: 对应数据源里的字段名
+     */
+    keyName: string;
+    value: string;
+    /**
+     * @description: 宽度占比
+     */
+    weight?: number;
+    /**
+     * @description: 列显示的格式
+     */
+    columnType?: "TEXT" | "ENUMS" | "BUTTONS" | "FORM_ITEM" | "DATE" | "QR_CODE" | "IMAGE";
+    /**
+     * @description: 枚举范围
+     */
+    enums?: TableColumnEnums[];
+    /**
+     * @description: 日期格式
+     */
+    format?: string;
+    /**
+     * @description: 表格显示按钮
+     */
+    buttons?: ViewButton[];
+    /**
+     * @description: 表格表单类型
+     */
+    formItems?: FormItem[];
+} & PrimaryTableCol;
+export interface TableColumnEnums {
+    value: string;
+    type: string;
+    text: string;
+}
+/**
+ * @description 用于不同区域之间传递的参数
+ */
+export interface ViewProps {
+    /**
+     * @description 传递的key
+     */
+    keyName?: string;
+    /**
+     * @description 传递的值
+     */
+    valueName?: string;
+}
+export declare type ViewButtonAction = "NONE" | "LINK" | "VIEW" | "VIEW_BY_DIALOG" | "UPLOAD_FILE" | "DOWNLOAD" | "CONFIRM" | "BATCH" | "CLOSE_DIALOG" | "CONFIRM_AND_CLOSE" | "RESET" | "RECOVER";
+export interface ViewButton {
+    /**
+     * @description 按钮显示的名字
+     */
+    name?: string;
+    /**
+     * @description 按钮显示的图标
+     */
+    icon?: string;
+    /**
+     * @description 按钮的唯一标识，用于请求后台
+     */
+    buttonId?: string;
+    /**
+     * @description 按钮文本的颜色
+     */
+    textColor?: string;
+    /**
+     * @description 按钮的类型
+     */
+    buttonType?: "default" | "primary" | "success" | "info" | "warning" | "danger";
+    /**
+     * @description 按钮的形状
+     */
+    buttonStyle?: "default" | "plain" | "round" | "circle";
+    props?: ViewProps[];
+    /**
+     * @description 按钮执行的内容
+     */
+    action?: ViewButtonAction;
+    showIf?: string;
+    disableIf?: string;
+    /**
+     * @description 确认信息
+     */
+    confirmMessage?: string;
+    /**
+     * @description  跳转到其他view
+     */
+    view: string;
+    /**
+     * @description 跳转到某个页面（直接url跳转）
+     */
+    link?: string;
+    /**
+     * @description: 是否跳转到外部
+     */
+    outLink: boolean;
+    /**
+     * @description 下载文件的路径
+     */
+    downloadUrl?: string;
+    /**
+     * @description: 上传文件类型
+     * @value: 'path' - 文件夹; 'file' 单文件
+     */
+    fileUploadType?: "path" | "file";
+    /**
+     * @description: 上传文件格式限制
+     */
+    accept?: string;
+    permission?: any[];
+}
+/**
+ * @description: 表单项类型
+ */
+export declare type FormItemType = "hidden" | "line" | "text_input" | "check_box" | "selector" | "label" | "file" | "multi_selector" | "date_time_selector" | "date_selector" | "delay_selector" | "time_selector" | "multi_tree_selector" | "tree_selector" | "tree_check_box" | "radio" | "switch" | "rich_text" | "tag" | "block_start" | "block_end";
+/**
+ * @description: 表单项结构
+ */
+export interface FormItem {
+    itemType: FormItemType;
+    inputType?: string;
+    /**
+     * @description: 是否必选
+     */
+    required?: boolean;
+    /**
+     * @description: 查询或提交表单时的key
+     */
+    keyName: string;
+    /**
+     * @description: 显示的名字
+     */
+    name: string;
+    /**
+     * @description: 提交表单时id
+     */
+    buttonId: string;
+    value?: string;
+    /**
+     * @description: hidden类型时有效
+     */
+    valueName?: string;
+    /**
+     * @description: 提示语
+     */
+    placeholder?: string;
+    showIf: string;
+    disableIf?: string;
+    /**
+     * @description: 选择器数据相关
+     */
+    listData?: ViewBoardData;
+    /**
+     * @description: 树选择器数据相关
+     */
+    treeData?: ViewBoardData;
+    /**
+     * @description: 日期时间选择相关
+     */
+    format?: string;
+    limit?: number;
+    maxSize?: number;
+    accept?: string;
+    filenameKeyName?: string;
+    /**
+     * @description: 上传文件类型
+     * @value: 'path' - 文件夹; 'file' 单文件
+     */
+    fileUploadType?: "path" | "file";
+}

package/dist/types/utils/color.d.ts

@@ -0,0 +1,2 @@
+import type { ColorSeries, ColorToken } from "~/constant/color";
+export declare function getBrandColor(type: string, colorList: ColorSeries): ColorToken;

package/dist/types/utils/download.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description: 获取文件名
+ * @param {string} disposition
+ */
+export declare function getFileNameFromContentDisposition(disposition: string): string | null;
+/**
+ * @description: 下载文件方法
+ * @param {string} url
+ * @param {string} filename
+ */
+export declare function downloadFile(url: string, downloadFilename?: string, type?: "file" | "blob", props?: any): void;

package/dist/types/utils/eval.d.ts

@@ -0,0 +1,12 @@
+export declare function evalContext(text: string, context?: {}): any;
+/**
+ * @description: 处理showIf可能出现的值
+ * @param {any} value
+ * @return {any}
+ */
+export declare function v(value: any): any;
+declare global {
+    interface Window {
+        v: Function;
+    }
+}

package/dist/types/utils/form.d.ts

@@ -0,0 +1,52 @@
+import type { FormItem, FormItemType } from "~/types/view";
+/**
+ * @description 初始化表单项的数值，返回对应的表单类型的初始值
+ * @param itemType
+ */
+export declare function initEmptyFormItems(itemType: FormItemType, isHeaderForm?: boolean): false | any[] | "" | "all";
+/**
+ * @description 初始化表单数据
+ * @return 表单模型数据
+ */
+export declare function initFormModel(formData: any, formItems: FormItem[], isHeaderForm?: boolean): any;
+/**
+ * @description: 初始化处理树形选择列表数据
+ * @param {*} config
+ * @return {*}
+ */
+export declare function initTreeSelectorData(config: {
+    list: any[];
+    keyName: string;
+    valueName: string;
+    titleName: string;
+    parentKey: string | null;
+    parentKeyName: string;
+}): any;
+interface OptionNode {
+    key: string;
+    label: string;
+    value: string;
+    children: OptionNode[];
+}
+/**
+ * @description: 过滤在收到的值中，包含的子元素选项并没有完全选中时的父元素
+ * @param {*} options
+ * @param {*} values
+ */
+export declare function filterTreeValues(options: OptionNode[], values: string[]): string[];
+/**
+ * @description: 检查输入框placeholder是否省略显示 如果省略显示则hover显示完整内容
+ * @param {any} formItemRef
+ */
+export declare function checkPlaceholderIfHidden(formItemRef: any): boolean;
+/**
+ * @description: 比较对象数据的属性差异
+ * @param {object} obj1
+ * @param {object} obj2
+ */
+export declare function deepCompareObjects(obj1: {
+    [x: string]: any;
+}, obj2: {
+    [x: string]: any;
+}, excludeKeys?: string[]): Record<string, any>;
+export {};

package/dist/types/utils/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./color";
+export * from "./eval";
+export * from "./is";
+export * from "./menu";
+export * from "./storage";
+export * from "./table";
+export * from "./url";
+export * from "./withInstall";
+export * from "./download";
+export * from "./form";
+export * from "./message";

package/dist/types/utils/is.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @description: 判断值是否未某个类型
+ */
+export declare function is(val: unknown, type: string): boolean;
+/**
+ * @description:  是否为函数
+ */
+export declare function isFunction<T = Function>(val: unknown): val is T;
+/**
+ * @description: 是否已定义
+ */
+export declare const isDef: <T = unknown>(val?: T) => val is T;
+export declare const isUnDef: <T = unknown>(val?: T) => val is T;
+/**
+ * @description: 是否为对象
+ */
+export declare const isObject: (val: any) => val is Record<any, any>;
+/**
+ * @description:  是否为时间
+ */
+export declare function isDate(val: unknown): val is Date;
+/**
+ * @description:  是否为数值
+ */
+export declare function isNumber(val: unknown): val is number;
+/**
+ * @description:  是否为AsyncFunction
+ */
+export declare function isAsyncFunction<T = any>(val: unknown): val is Promise<T>;
+/**
+ * @description:  是否为promise
+ */
+export declare function isPromise<T = any>(val: unknown): val is Promise<T>;
+/**
+ * @description:  是否为字符串
+ */
+export declare function isString(val: unknown): val is string;
+/**
+ * @description:  是否为boolean类型
+ */
+export declare function isBoolean(val: unknown): val is boolean;
+/**
+ * @description:  是否为数组
+ */
+export declare function isArray(val: any): val is Array<any>;
+/**
+ * @description: 是否客户端
+ */
+export declare const isClient: () => boolean;
+/**
+ * @description: 是否为浏览器
+ */
+export declare const isWindow: (val: any) => val is Window;
+/**
+ * @description: 是否为元素
+ */
+export declare const isElement: (val: unknown) => val is Element;
+/**
+ * @description: 判断当前运行环境
+ */
+export declare const isServer: boolean;
+/**
+ * @description: 判断是否为null
+ */
+export declare function isNull(val: unknown): val is null;
+/**
+ * @description: 判断是否为null和未定义
+ */
+export declare function isNullAndUnDef(val: unknown): val is null | undefined;
+/**
+ * @description: 判断是否为null或未定义
+ */
+export declare function isNullOrUnDef(val: unknown): val is null | undefined;
+/**
+ * @description: 判断表单数据是否为空
+ */
+export declare function isFormVoid(val: unknown): boolean;

package/dist/types/utils/menu.d.ts

@@ -0,0 +1,25 @@
+import type { SideMenu } from "~/types/menu";
+/**
+ * 递归生成菜单树
+ * @param data 原始菜单树数据
+ * @param parent 标记父菜单
+ * @param level 标记当前菜单层级
+ * @returns
+ */
+export declare function generateMenuTree(data: SideMenu[], parent: string | null, level: number): SideMenu[];
+/**
+ * @description: 保存时转换url到path属性
+ * @param {SideMenu} tree
+ */
+export declare function urlToPath(tree: SideMenu[]): SideMenu[];
+/**
+ * 扁平化菜单树
+ */
+export declare const flattenMenuData: (tree: SideMenu[]) => SideMenu[];
+/**
+ * 获取首页菜单 第一个url不为空的菜单信息
+ * @param menus
+ * @param url
+ * @returns
+ */
+export declare const getHomeUrl: (menus: SideMenu[], url?: string) => string;

package/dist/types/utils/message.d.ts

@@ -0,0 +1,21 @@
+interface MessageOptions {
+    duration?: number;
+    maxCount?: number;
+}
+declare class MessageManagerConstructor {
+    private messageQueue;
+    private displayedMessages;
+    private options;
+    constructor(options?: MessageOptions);
+    private showMessage;
+    private processQueue;
+    private addToQueue;
+    success(content: string): void;
+    error(content: string): void;
+    info(content: string): void;
+    warning(content: string): void;
+    loading(content: string): void;
+    question(content: string): void;
+}
+declare const MessageManager: MessageManagerConstructor;
+export { MessageManager };

package/dist/types/utils/storage.d.ts

@@ -0,0 +1,13 @@
+export declare class StorageUtils {
+    /**
+     * 存储实例: 默认为 local
+     */
+    storage: Storage;
+    constructor(type?: "local" | "session");
+    setItem(key: string, value: any): void;
+    getItem(key: string): any | null;
+    removeItem(key: string): void;
+    clear(): void;
+}
+export declare const sessionStorageUtils: StorageUtils;
+export declare const localStorageUtils: StorageUtils;

package/dist/types/utils/table.d.ts

@@ -0,0 +1,8 @@
+import type { TableColumn } from "../types/view";
+import type { PrimaryTableCol } from "tdesign-vue-next";
+export declare function initTableColumns(tableColumns: TableColumn[]): Array<PrimaryTableCol>;
+export declare function initTableDisplayColumns(tableColumns: TableColumn[]): {
+    colKey: string;
+    title: string;
+}[];
+export declare function highlightSearchResult(data: any, filterProps: any): any;

package/dist/types/utils/url.d.ts

@@ -0,0 +1,4 @@
+export declare function getUrlQuery(url: string): any;
+export declare function resolveUrl(url: string, queryParams: any, checkOuter?: boolean): string;
+export declare function isOuterUrl(str: string): boolean;
+export declare function isResourceUrl(str: string): boolean;

package/dist/types/utils/withInstall.d.ts

@@ -0,0 +1,5 @@
+import type { Plugin, Directive } from "vue";
+export declare function withInstall<T>(comp: T, alias?: string, directive?: {
+    name: string;
+    comp: Directive<T>;
+}): T & Plugin;

package/dist/types/views/GLogin/index.d.ts

@@ -0,0 +1,2 @@
+export declare const GLogin: any;
+export default GLogin;

package/dist/types/views/index.d.ts

@@ -0,0 +1 @@
+export * from "./GLogin";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@gonsin/gview",
-	"version": "2.1.12",
+	"version": "2.1.14",
 	"main": "dist/index.mjs",
 	"typings": "dist/types/index.d.ts",
 	"files": [