fast-crud-ui3 1.5.16 → 1.5.18-beta

package/lib/model/fastTableOption.d.ts

@@ -0,0 +1,513 @@
+import { default as Cond } from './cond.js';
+export default FastTableOption;
+export type ComponentInstance = import('vue').ComponentPublicInstance;
+/**
+ * @typedef {import('vue').ComponentPublicInstance} ComponentInstance
+ */
+declare class FastTableOption {
+    static $http: any;
+    static $router: any;
+    constructor({ context, id, title, showTitle, module, baseUrl, pageUrl, listUrl, insertUrl, batchInsertUrl, updateUrl, batchUpdateUrl, deleteUrl, batchDeleteUrl, uploadUrl, exportUrl, existsUrl, enableDblClickEdit, enableMulti, enableIndex, enableColumnFilter, enableFilterCache, lazyLoad, editType, queryable, insertable, updatable, deletable, exportable, idField, createTimeField, sortField, sortDesc, moreButtons, pagination, style, render, conds, condGroups, condExtra, beforeReset, beforeLoad, loadSuccess, loadFail, beforeToInsert, beforeInsert, insertSuccess, insertFail, beforeToUpdate, beforeUpdate, updateSuccess, updateFail, beforeDeleteTip, beforeDelete, deleteSuccess, deleteFail, beforeCancel, beforeExport, exportSuccess, exportFail }: {
+        context: any;
+        id?: string;
+        title?: string;
+        showTitle?: boolean;
+        module?: string;
+        baseUrl?: string;
+        pageUrl?: string;
+        listUrl?: string;
+        insertUrl?: string;
+        batchInsertUrl?: string;
+        updateUrl?: string;
+        batchUpdateUrl?: string;
+        deleteUrl?: string;
+        batchDeleteUrl?: string;
+        uploadUrl?: string;
+        exportUrl?: string;
+        existsUrl?: string;
+        enableDblClickEdit?: boolean;
+        enableMulti?: boolean;
+        enableIndex?: boolean;
+        enableColumnFilter?: boolean;
+        enableFilterCache?: boolean;
+        lazyLoad?: boolean;
+        editType?: string;
+        queryable?: boolean;
+        insertable?: boolean;
+        updatable?: boolean;
+        deletable?: boolean;
+        exportable?: boolean;
+        idField?: string;
+        createTimeField?: string;
+        sortField?: string;
+        sortDesc?: boolean;
+        moreButtons?: any[];
+        pagination?: {
+            layout: string;
+            'page-sizes': number[];
+            size: number;
+        };
+        style?: {};
+        render?: () => any[];
+        conds?: any[];
+        condGroups?: any[];
+        condExtra?: {};
+        beforeReset?: ({ query }: {
+            query: any;
+        }) => Promise<void>;
+        beforeLoad?: ({ query }: {
+            query: any;
+        }) => Promise<void>;
+        loadSuccess?: ({ query, res }: {
+            query: any;
+            res: any;
+        }) => Promise<any>;
+        loadFail?: ({ query, error }: {
+            query: any;
+            error: any;
+        }) => Promise<void>;
+        beforeToInsert?: (rows: any) => Promise<void>;
+        beforeInsert?: ({ fatRows, rows, editRows }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+        }) => Promise<any>;
+        insertSuccess?: ({ fatRows, rows, editRows, res }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+            res: any;
+        }) => Promise<void>;
+        insertFail?: ({ fatRows, rows, editRows, error }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+            error: any;
+        }) => Promise<void>;
+        beforeToUpdate?: ({ fatRows, rows }: {
+            fatRows: any;
+            rows: any;
+        }) => Promise<void>;
+        beforeUpdate?: ({ fatRows, rows, editRows }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+        }) => Promise<any>;
+        updateSuccess?: ({ fatRows, rows, editRows, res }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+            res: any;
+        }) => Promise<void>;
+        updateFail?: ({ fatRows, rows, editRows, error }: {
+            fatRows: any;
+            rows: any;
+            editRows: any;
+            error: any;
+        }) => Promise<void>;
+        beforeDeleteTip?: ({ fatRows, rows }: {
+            fatRows: any;
+            rows: any;
+        }) => Promise<void>;
+        beforeDelete?: ({ fatRows, rows }: {
+            fatRows: any;
+            rows: any;
+        }) => Promise<any>;
+        deleteSuccess?: ({ fatRows, rows, res }: {
+            fatRows: any;
+            rows: any;
+            res: any;
+        }) => Promise<void>;
+        deleteFail?: ({ fatRows, rows, error }: {
+            fatRows: any;
+            rows: any;
+            error: any;
+        }) => Promise<void>;
+        beforeCancel?: ({ fatRows, rows, status }: {
+            fatRows: any;
+            rows: any;
+            status: any;
+        }) => Promise<void>;
+        beforeExport?: ({ columns, pageQuery }: {
+            columns: any;
+            pageQuery: any;
+        }) => Promise<any>;
+        exportSuccess?: ({ columns, pageQuery, data }: {
+            columns: any;
+            pageQuery: any;
+            data: any;
+        }) => Promise<void>;
+        exportFail?: ({ columns, pageQuery, error }: {
+            columns: any;
+            pageQuery: any;
+            error: any;
+        }) => Promise<void>;
+    });
+    /**
+     * 当前组件。一般配置当前组件(this), 这样钩子函数中可以使用this
+     * @type {ComponentInstance | null}
+     */
+    context: ComponentInstance | null;
+    ref: any;
+    /**
+     * 唯一id值。用于浏览器缓存时不同fast-table之间的隔离，不配置则内部默认生成(取baseUrl)
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 表格标题。配置后默认会显示在表格上方
+     * @type {string}
+     */
+    title: string;
+    /**
+     * 是否显示标题。默认true
+     * @type {boolean}
+     */
+    showTitle: boolean;
+    /**
+     * 表格Rest接口的根path。
+     * @type {string}
+     */
+    baseUrl: string;
+    /**
+     * 表格分页接口path。默认 ${baseUrl}/page
+     * @type {string}
+     */
+    pageUrl: string;
+    /**
+     * 列表url: 默认为${baseUrl}/list
+     * @type {string}
+     */
+    listUrl: string;
+    /**
+     * 新增url: 默认为${baseUrl}/insert
+     * @type {string}
+     */
+    insertUrl: string;
+    /**
+     * 批量新增url: 默认为${baseUrl}/insert/batch
+     * @type {string}
+     */
+    batchInsertUrl: string;
+    /**
+     * 更新url: 默认为${baseUrl}/update
+     * @type {string}
+     */
+    updateUrl: string;
+    /**
+     * 批量更新url: 默认为${baseUrl}/update/batch
+     * @type {string}
+     */
+    batchUpdateUrl: string;
+    /**
+     * 删除url: 默认为${baseUrl}/delete
+     * @type {string}
+     */
+    deleteUrl: string;
+    /**
+     * 批量删除url: 默认为${baseUrl}/delete/batch
+     * @type {string}
+     */
+    batchDeleteUrl: string;
+    /**
+     * 文件上传接口: 默认为${baseUrl}/upload
+     * @type {string}
+     */
+    uploadUrl: string;
+    /**
+     * 数据导出接口: 默认为${baseUrl}/export
+     * @type {string}
+     */
+    exportUrl: string;
+    /**
+     * 存在性判断接口path: 默认为${baseUrl}/exists
+     * @type {string}
+     */
+    existsUrl: string;
+    /**
+     * 是否启用双击编辑。默认true
+     * @type {boolean}
+     */
+    enableDblClickEdit: boolean;
+    /**
+     * 是否启用表格多选。默认启用
+     * @type {boolean}
+     */
+    enableMulti: boolean;
+    /**
+     * 是否启用序号列
+     * @type {boolean}
+     */
+    enableIndex: boolean;
+    /**
+     * 启用列过滤：即动筛。默认启用，若为false, 则表头均无法点击
+     * @type {boolean}
+     */
+    enableColumnFilter: boolean;
+    /**
+     * 是否启用过滤条件缓存(页面刷新后过滤条件不丢失),若为true则缓存到session中,有效期为会话。默认启用
+     * @type {boolean}
+     */
+    enableFilterCache: boolean;
+    /**
+     * 是否延迟加载分页数据，即不立即加载数据。默认false，若设置true, 则表格渲染后不立即加载数据，需要手动触发加载。
+     * @type {boolean}
+     */
+    lazyLoad: boolean;
+    /**
+     * 编辑模式。可选值: inline/form, 默认为inline,即双击行内编辑，若配置为form，则双击将打开弹窗。
+     * @type {string}
+     */
+    editType: string;
+    /**
+     * 是否允许分页查询。默认为true。若为false, 则查询等按钮会隐藏, 一般静态表格(前端静态数据)有用。
+     * @type {boolean}
+     */
+    queryable: boolean;
+    /**
+     * 是否支持内置新建功能。默认为true
+     * @type {boolean}
+     */
+    insertable: boolean;
+    /**
+     * 是否支持内置编辑。默认true
+     * @type {boolean}
+     */
+    updatable: boolean;
+    /**
+     * 是否支持内置删除。默认true
+     * @type {boolean}
+     */
+    deletable: boolean;
+    /**
+     * 是否支持导出。默认true
+     * @type {boolean}
+     */
+    exportable: boolean;
+    /**
+     * 主键字段名。默认为"id"。必须正确设置，否则更新、删除等功能无法使用。
+     * @type {string}
+     */
+    idField: string;
+    /**
+     * "创建时间"的字段名。如果配置了，则内部动态构造3个存筛(当天/当周/当月), 此值必须为显示列
+     * @type {string}
+     */
+    createTimeField: string;
+    /**
+     * TODO 待实现 父子表级联(父表取choseRow作为选中的行)
+     * @type {{map: Object | ObjectConstructor, option: FastTableOption}}
+     */
+    parent: {
+        map: any | ObjectConstructor;
+        option: FastTableOption;
+    };
+    /**
+     * 表格默认的排序字段。默认依次取createTimeField、idField
+     */
+    sortField: any;
+    /**
+     * 降序。若为false, 则为升序
+     * @type {boolean}
+     */
+    sortDesc: boolean;
+    /**
+     * 配置【更多】下拉功能按钮。定义: {label: String, click: Function<Promise>, icon: Component, showable: Boolean|Function<Boolean>, disable: Boolean|Function<Boolean>, }
+     * @type {[]}
+     */
+    moreButtons: [];
+    /**
+     * 分页条配置
+     * @type {{layout: string, size: number, "page-sizes": number[]}}
+     */
+    pagination: {
+        layout: string;
+        size: number;
+        "page-sizes": number[];
+    };
+    /**
+     * 样式配置
+     * @type {{flexHeight: boolean, quickFilterGridGap: string, formLabelWidth: string, formLayout: null, quickFilterSpan: number, bodyRowHeight: string, size: string}}
+     */
+    style: {
+        flexHeight: boolean;
+        quickFilterGridGap: string;
+        formLabelWidth: string;
+        formLayout: null;
+        quickFilterSpan: number;
+        bodyRowHeight: string;
+        size: string;
+    };
+    /**
+     * render函数。当前FastTableOption对应的表格若被pick时有用
+     * @type {Function}
+     */
+    render: Function;
+    /**
+     * 内置固定的筛选条件。将始终在分页查询条件里，无法被用户取消
+     * @type {Cond[]}
+     */
+    conds: Cond[];
+    /**
+     * 开发者预置的条件组——即存筛，例如: [{label: '成年男孩', conds: [{col: 'sex', val: '1'}, {col: 'age', opt: Opt.LE, val: 18}]}] <br/>
+     * 注意: 要求conds中每个col都必须启用了filter，只要有一项未启用则整个筛选组无效。
+     * @type {[]}
+     */
+    condGroups: [];
+    /**
+     * 扩展的查询条件, 可配合#quickFilter插槽使用。例如配置了keyword(表格中并不存在此列), 则可将query.extra.keyword绑定到自定义输入控件上，
+     * 后端配合针对此值做自定义筛选功能。
+     * @type {{}}
+     */
+    condExtra: {};
+    /**
+     * 重置按钮点击前触发的钩子函数
+     * @type {Function}
+     */
+    beforeReset: Function;
+    /**
+     * 分页请求前触发的钩子函数
+     * @type {Function}
+     */
+    beforeLoad: Function;
+    /**
+     * 分页请求成功后的钩子函数
+     * @type {Function}
+     */
+    loadSuccess: Function;
+    /**
+     * 分页请求失败后的钩子函数
+     * @type {Function}
+     */
+    loadFail: Function;
+    /**
+     * 进入新建前(行内模式新增一行前，表单模式为弹窗前)的钩子函数
+     * @type {Function}
+     */
+    beforeToInsert: Function;
+    /**
+     * 插入请求前执行的钩子函数
+     * @type {Function}
+     */
+    beforeInsert: Function;
+    /**
+     * 插入成功后的钩子函数
+     * @type {Function}
+     */
+    insertSuccess: Function;
+    /**
+     * 插入失败后的钩子函数
+     * @type {Function}
+     */
+    insertFail: Function;
+    /**
+     * 进入更新模式前的钩子函数(行内模式为行切换为可编辑模式前，表单模式为弹窗前)
+     * @type {Function}
+     */
+    beforeToUpdate: Function;
+    /**
+     * 更新请求前的钩子函数
+     * @type {Function}
+     */
+    beforeUpdate: Function;
+    /**
+     * 更新成功后的钩子函数。
+     * @type {Function}
+     */
+    updateSuccess: Function;
+    /**
+     * 更新失败后的钩子函数
+     * @type {Function}
+     */
+    updateFail: Function;
+    /**
+     * 删除提示前的钩子函数
+     * @type {Function}
+     */
+    beforeDeleteTip: Function;
+    /**
+     * 删除请求前的钩子函数
+     * @type {Function}
+     */
+    beforeDelete: Function;
+    /**
+     * 删除请求成功后的钩子函数
+     * @type {Function}
+     */
+    deleteSuccess: Function;
+    /**
+     * 删除请求失败后的钩子函数
+     * @type {Function}
+     */
+    deleteFail: Function;
+    /**
+     * 点击取消按钮前的钩子函数(处于新建、编辑模式时会有取消按钮)
+     * @type {Function}
+     */
+    beforeCancel: Function;
+    /**
+     * 导出请求前的钩子函数
+     * @type {Function}
+     */
+    beforeExport: Function;
+    /**
+     * 导出成功后的钩子函数
+     * @type {Function}
+     */
+    exportSuccess: Function;
+    /**
+     * 导出失败后的钩子函数
+     * @type Function
+     */
+    exportFail: Function;
+    /**
+     * 向内置条件组中增加条件
+     * @param cond
+     * @param repeatable 是否允许重复的col, 默认false, 即若多次添加相同col的条件, 只会保留最新的
+     * @return {FastTableOption} 返回当前对象
+     */
+    addCond(cond: any, repeatable?: boolean): FastTableOption;
+    /**
+     * 从内置条件组中移除条件
+     * @param col {string} 字段名
+     * @return {FastTableOption} 返回当前对象
+     */
+    removeCond(col: string): FastTableOption;
+    /**
+     * 新增行, 返回promise
+     * @param fatRows
+     * @returns {Promise<void>|Promise<unknown>}
+     */
+    _insertRows(fatRows: any): Promise<void> | Promise<unknown>;
+    /**
+     * 更新行
+     * @param fatRows
+     * @return 返回promise, 若成功更新则resolve; 若失败或取消, 则返回reject err或用户自定义的内容
+     */
+    _updateRows(fatRows: any): Promise<any>;
+    /**
+     * 列表查询
+     * @param query 查询条件 Query类型
+     * @param config
+     */
+    _list(query: any, config: any): any;
+    /**
+     * 导出
+     * @param columnConfigs
+     * @param pageQuery
+     */
+    _exportData(columnConfigs: any, pageQuery: any): void;
+    /**
+     * 存在性判断
+     */
+    _exist(conds?: any[]): Promise<any>;
+    /**
+     * 利用/list接口构造选项列表数据
+     * @param query
+     * @param valKey
+     * @param labelKey
+     * @param forceRefresh 是否强制刷新，若true则跳过缓存
+     * @return {Promise<*>}
+     */
+    _buildSelectOptions(query: any, valKey: any, labelKey: any, forceRefresh?: boolean): Promise<any>;
+}

package/lib/model/filterComponentConfig.d.ts

@@ -0,0 +1,55 @@
+import { default as Opt } from './opt.js';
+export default FilterComponentConfig;
+/**
+ * 筛选组件配置
+ */
+export type OptValue = (typeof Opt)[keyof typeof Opt];
+/**
+ * 筛选组件配置
+ * @typedef {typeof Opt[keyof typeof Opt]} OptValue
+ */
+declare class FilterComponentConfig {
+    /**
+     * 构造函数
+     * @param component {string} 组件名
+     * @param col {string} 字段名
+     * @param opt {OptValue} 操作符
+     * @param val {any} 值
+     * @param label {string} 中文名
+     * @param props {Object} 组件对应的props
+     * @param condMapFn {Function} 条件获取过滤函数
+     * @param type {string} quick|easy|dynamic
+     */
+    constructor({ component, col, opt, val, label, props, condMapFn, type }: string);
+    component: any;
+    col: any;
+    opt: any;
+    val: any;
+    label: any;
+    props: any;
+    defaultVal: any;
+    disabled: boolean;
+    type: any;
+    condMapFn: (cond: any) => any[];
+    index: number;
+    condMsg: string;
+    /**
+     * 值为默认值
+     */
+    isDefaultVal(): boolean;
+    /**
+     * 此筛选项是否有效
+     * @returns {boolean}
+     */
+    isEffective(): boolean;
+    /**
+     * 返回值是否变更
+     * @return {boolean}
+     */
+    reset(): boolean;
+    getConds(): any[];
+    /**
+     * 更新条件的文本描述, 例如用于回显在dynamic-filter-list上
+     */
+    updateCondMsg(): Promise<any>;
+}

package/lib/model/opt.d.ts

@@ -0,0 +1,20 @@
+export default Opt;
+declare const Opt: Readonly<{
+    EQ: "=";
+    NE: "!=";
+    GT: ">";
+    GE: ">=";
+    LT: "<";
+    LE: "<=";
+    IN: "in";
+    NIN: "nin";
+    LIKE: "like";
+    LLIKE: "llike";
+    RLIKE: "rlike";
+    NLIKE: "nlike";
+    NULL: "null";
+    NNULL: "nnull";
+    EMPTY: "empty";
+    NEMPTY: "nempty";
+    BTW: "between";
+}>;

package/lib/model/order.d.ts

@@ -0,0 +1,28 @@
+export default Order;
+/**
+ * 排序对象
+ */
+declare class Order {
+    /**
+     * 构造器
+     * @param col 排序字段
+     * @param asc 是否升序，默认false，即降序
+     */
+    constructor(col: any, asc?: boolean);
+    /**
+     * 排序字段(英文字段),需要和后端分页响应的字段名对应
+     * @type {string}
+     */
+    col: string;
+    /**
+     * 是否升序
+     * @type {boolean}
+     */
+    asc: boolean;
+    /**
+     * 设置是否升序
+     * @param asc
+     * @return {Order}
+     */
+    setAsc(asc: any): Order;
+}

package/lib/model/pageQuery.d.ts

@@ -0,0 +1,43 @@
+import { default as Query } from './query.js';
+export default PageQuery;
+/**
+ * 分页请求参数模型
+ */
+declare class PageQuery extends Query {
+    /**
+     * 构造器
+     * @param current 当前页(默认1)
+     * @param size 每页条数(默认20)
+     */
+    constructor(current?: number, size?: number);
+    /**
+     * 当前页，默认1
+     * @type {number}
+     */
+    current: number;
+    /**
+     * 每页条数，默认20条
+     * @type {number}
+     */
+    size: number;
+    /**
+     * 设置每页大小
+     * @param size
+     */
+    setSize(size: any): this;
+    /**
+     * 将当前对象转为json
+     * @return {{current: number, size: number, conds: *, extra: {[p: string]: null|*}, distinct: *, orders: *, cols: *}}
+     */
+    toJson(): {
+        current: number;
+        size: number;
+        conds: any;
+        extra: {
+            [p: string]: null | any;
+        };
+        distinct: any;
+        orders: any;
+        cols: any;
+    };
+}