@kengic/vue 0.26.6-beta.1 → 0.26.6-beta.3

package/dist/src/consts/index.vm.d.ts

@@ -1,725 +0,0 @@
-import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
-/** 模块. */
-export declare const enum KG_APP {
-    /** 数据管理. */
-    WMS_DATA_MANAGER = "data-manager",
-    /** 仓库管理. */
-    WMS_BUSINESS_MANAGER = "business-manager",
-    /** WCS. */
-    WCS = "wcs",
-    /** 系统管理. */
-    SYS = "sys"
-}
-/** 模块路径前缀. */
-export declare const enum KG_APP_PREFIX {
-    /** 数据管理. */
-    WMS_DATA_MANAGER = "/wms/data-manager",
-    /** 仓库管理. */
-    WMS_BUSINESS_MANAGER = "/wms/business-manager",
-    /** WCS. */
-    WCS = "/wcs",
-    /** 系统管理. */
-    SYS = "/sys"
-}
-/** 所有模块. */
-export declare const KG_APPS: Array<KG_APP>;
-/** 所有模块路径前缀. */
-export declare const KG_APP_PREFIXS: Array<KG_APP_PREFIX>;
-/**
- * 表单控件类型.
- * @see VarConfigControl.ctrl_prop
- * @see IKgVarConfigControlControlProperties
- */
-export declare enum KG__VAR_CONFIG_CONTROL__CONTROL_TYPE {
-    /** 单行文本. */
-    INPUT = "INPUT",
-    /** 密码. */
-    INPUT_PASSWORD = "INPUT_PASSWORD",
-    /** 数字. */
-    INPUT_NUMBER = "INPUT_NUMBER",
-    /**
-     * <p>多行文本.</p>
-     * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.TEXT_AREA}.</p>
-     */
-    TEXT_AREA = "TEXT_AREA",
-    /** 多选框. */
-    CHECKBOX = "CHECKBOX",
-    /**
-     * <p>多选框列表.</p>
-     * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.CHECKBOX_GROUP}.</p>
-     */
-    CHECKBOX_GROUP = "CHECKBOX_GROUP",
-    /**
-     * <p>单选框列表.</p>
-     * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.RADIO_GROUP}.</p>
-     */
-    RADIO_GROUP = "RADIO_GROUP",
-    /** 开关. */
-    SWITCH = "SWITCH",
-    /**
-     * <p>单选下拉列表.<p>
-     * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.SELECT}.</p>
-     */
-    SELECT = "SELECT",
-    /** 多选下拉列表. */
-    SELECT_MULTIPLE = "SELECT_MULTIPLE",
-    /** 年月日, 2020-05-01. */
-    DATE_DATE = "DATE_DATE",
-    /** 年月日的范围, [DATE_DATE, DATE_DATE] */
-    DATE_DATE_RANGE = "DATE_DATE_RANGE",
-    /** 时分秒, 11:59:59. */
-    DATE_TIME = "DATE_TIME",
-    /** 时分秒的范围, [DATE_TIME, DATE_TIME]. */
-    DATE_TIME_RANGE = "DATE_TIME_RANGE",
-    /** 年月日时分秒, 2020-05-01 11:59:59. */
-    DATE_DATETIME = "DATE_DATETIME",
-    /** 年月日时分秒的范围, [DATE_DATETIME, DATE_DATETIME] */
-    DATE_DATETIME_RANGE = "DATE_DATETIME_RANGE",
-    DATE_WEEK = "DATE_WEEK",
-    DATE_MONTH = "DATE_MONTH",
-    DATE_YEAR = "DATE_YEAR",
-    /**
-     * <p>图片.</p>
-     * <p>点击可以预览.</p>
-     */
-    IMAGE = "IMAGE",
-    /** 文件上传按钮. */
-    BUTTON_UPLOAD = "BUTTON_UPLOAD"
-}
-/**
- * 表单控件所处环境.
- */
-export declare const enum KG_FORM_CONTEXT {
-    /**
-     * 位于查询条件.
-     */
-    SEARCH = "SEARCH",
-    /**
-     * 位于提交表单弹窗.
-     */
-    SUBMIT = "SUBMIT",
-    /**
-     * 位于表格内的提交表单.
-     */
-    TABLE = "TABLE"
-}
-/**
- * 定制级别.
- */
-export declare const enum KG_CUSTOM_LEVEL {
-    /**
-     * 系统.
-     */
-    L0 = 0,
-    /**
-     * 用户.
-     */
-    L10 = 10
-}
-/**
- * 接口请求方式.
- */
-export declare enum KG__API_METHOD {
-    GET = "GET",
-    POST = "POST",
-    DELETE = "DELETE",
-    PUT = "PUT"
-}
-/**
- * 表格单元格的显示类型.
- * @see VarGridDetail.display_type_properties
- * @see IKgVarGridDetailDisplayTypeProperties
- */
-export declare const enum KG__VAR_GRID_DETAIL__DISPLAY_TYPE {
-    /** 布尔数据, 使用 KgYesOrNo 组件显示. */
-    YN = "YN",
-    /**
-     * <p>描述. 显示该列的值所对应的描述, 而不是直接显示该列的值.</p>
-     * <p>
-     *     描述的来源有 2 种, 按优先级从高到低依次为:
-     *     <ul>
-     *         <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.description.codeName} 不为空, 则描述来源于系统描述表, 并且默认的 codeValue 就是该列的值,</li>
-     *         <li>
-     *             <p>否则, 描述来源于描述列.</p>
-     *             <p>默认情况下, 描述列的列名为原始列的列名加上 _dsc 或者 Dsc 后缀, 比如原始列的列名为 xyz, 则描述列的列名为 xyz_dsc 或者 xyzDsc, 可以通过 {@link IKgVarGridDetailDisplayTypeProperties.DESC.dscFieldName} 将描述列的列名配置为其他值,</p>
-     *         </li>
-     *     </ul>
-     * </p>
-     */
-    DESC = "DESC",
-    /** 进度条, 使用 KgProgressA 组件显示. */
-    PROGRESS = "PROGRESS",
-    /** 文件大小, 将以字节(byte)为单位的数字格式化显示(XXX MB, XXX GB, ...). */
-    FILE_SIZE = "FILE_SIZE",
-    /** 超链接, 点击打开更新弹窗. */
-    UPDATE_LINK = "UPDATE_LINK",
-    /** 超链接, 点击跳转到其他页面. */
-    ROUTE_LINK = "ROUTE_LINK",
-    /**
-     * <p>图片, 可以点击预览大图.</p>
-     */
-    IMAGE = "IMAGE",
-    /**
-     * <p>图标, 使用 iconify 进行渲染.</p>
-     */
-    ICON = "ICON"
-}
-/**
- * 表格单元格的对齐方式.
- */
-export declare const enum KG__VAR_GRID_DETAIL__ALIGN {
-    LEFT = "left",
-    CENTER = "center",
-    RIGHT = "right"
-}
-/**
- * 单击某行时的操作.
- */
-export declare const enum KG__VAR_GRID_CONFIG__OPERATION_ON_ROW_CLICK {
-    /**
-     * 不做操作.
-     */
-    A = 0,
-    /**
-     * 勾选该行, 并取消其他勾选行.
-     */
-    B = 1,
-    /**
-     * 勾选该行, 并保留其他勾选行.
-     */
-    C = 2
-}
-/** @deprecated 已弃用, 请使用 {@link KG__VAR_BUTTON__TYPE}. */
-export declare const enum KG_BUTTON_TYPE {
-    /** 查询. */
-    SEARCH = "SEARCH",
-    /** 创建. */
-    CREATE = "CREATE",
-    /** 更新. */
-    UPDATE = "UPDATE",
-    /** 复制. */
-    COPY = "COPY",
-    /** 删除. */
-    DELETE = "DELETE",
-    /** 导入. */
-    IMPORT = "IMPORT",
-    /** 下载导入模板. */
-    IMPORT_TEMPLATE = "IMPORT_TEMPLATE",
-    /** 导出. */
-    EXPORT = "EXPORT",
-    /** 其他. */
-    OTHER = "OTHER"
-}
-/**
- * 按钮类型.
- */
-export declare const enum KG__VAR_BUTTON__TYPE {
-    /** 查询. */
-    SEARCH = "SEARCH",
-    /** 创建. */
-    CREATE = "CREATE",
-    /** 更新. */
-    UPDATE = "UPDATE",
-    /** 复制. */
-    COPY = "COPY",
-    /** 删除. */
-    DELETE = "DELETE",
-    /** 导入. */
-    IMPORT = "IMPORT",
-    /** 下载导入模板. */
-    IMPORT_TEMPLATE = "IMPORT_TEMPLATE",
-    /** 导出. */
-    EXPORT = "EXPORT",
-    /** 其他. */
-    OTHER = "OTHER"
-}
-/**
- * 按钮颜色.
- */
-export declare const enum KG__VAR_BUTTON__COLOR {
-    /**
-     * 蓝色.
-     */
-    BLUE = "BLUE",
-    /**
-     * 红色.
-     */
-    RED = "RED",
-    /**
-     * 黄色.
-     */
-    YELLOW = "YELLOW"
-}
-/** 按钮显示方式. */
-export declare const enum KG__VAR_BUTTON_CONFIG__DISPLAY_TYPE {
-    /**
-     * 按钮依次排列在一横排.
-     */
-    DEFAULT = "DEFAULT",
-    /**
-     * 显示为下拉的菜单列表.
-     */
-    SELECT = "SELECT"
-}
-/** 表单显示方式. */
-export declare const enum KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE {
-    /** 弹窗. */
-    MODAL = "MODAL",
-    /** 抽屉. */
-    DRAWER = "DRAWER",
-    /** 在表格内. */
-    TABLE = "TABLE",
-    /** 嵌入页面. */
-    INLINE = "INLINE"
-}
-/**
- * 表单布局方式.
- */
-export declare enum KG__VAR_SUBMIT_CONFIG__LAYOUT {
-    /**
-     * 垂直.
-     */
-    VERTICAL = "vertical",
-    /**
-     * 水平.
-     */
-    HORIZONTAL = "horizontal"
-}
-/**
- * 变量配置:表单输入验证:数据类型.
- */
-export declare const enum KG__VAR_CONFIG_INPUT__DATA_TYPE {
-    /**
-     * 任意字符.
-     */
-    ANY = "ANY",
-    /**
-     * 整数.
-     */
-    INTEGER = "INTEGER",
-    /**
-     * 小数.
-     */
-    FLOAT = "FLOAT",
-    /**
-     * 英文字母.
-     */
-    LETTER = "LETTER",
-    /**
-     * 大写英文字母.
-     */
-    UPPER_CASE_LETTER = "UPPER_CASE_LETTER",
-    /**
-     * 小写英文字母.
-     */
-    LOWER_CASE_LETTER = "LOWER_CASE_LETTER",
-    /**
-     * JSON.
-     */
-    JSON = "JSON"
-}
-/**
- * 变量配置:表单输入验证:验证方式.
- */
-export declare const enum KG__VAR_CONFIG_INPUT__VALIDATION_TYPE {
-    /**
-     * 配置.
-     */
-    OPTIONS = "OPTIONS",
-    /**
-     * 正则.
-     */
-    REGULAR_EXPRESSION = "REGULAR_EXPRESSION"
-}
-/**
- * 变量配置:提示文本:位置.
- */
-export declare enum KG__VAR_CONFIG_TIP__PLACEMENT {
-    /**
-     * 在标签的右边, 显示为一个小图标, 鼠标划过时显示弹框.
-     */
-    RIGHT = "RIGHT",
-    /**
-     * 在标签的下面.
-     */
-    BOTTOM = "BOTTOM"
-}
-/**
- * 变量配置:下拉列表:数据源的类型.
- */
-export declare enum KG__VAR_CONFIG_POSSIBILITY__DATA_SOURCE_TYPE {
-    API = "API",
-    SQL = "SQL"
-}
-/**
- * 变量配置:下拉列表:值的类型.
- */
-export declare enum KG__VAR_CONFIG_POSSIBILITY__VALUE_DATA_TYPE {
-    /**
-     * 默认类型.
-     */
-    DEFAULT = "DEFAULT",
-    /**
-     * 字符串.
-     */
-    STRING = "STRING",
-    /**
-     * 数字.
-     */
-    NUMBER = "NUMBER",
-    /**
-     * 布尔.
-     */
-    BOOLEAN = "BOOLEAN"
-}
-/** 宽度单位. */
-export declare const enum KG__VAR_SUBMIT_CONFIG__LABEL_COLUMN_UNIT {
-    /**
-     * 栅格.
-     */
-    SPAN = "SPAN",
-    /**
-     * 像素.
-     */
-    PX = "PX"
-}
-/**
- * 栅格布局宽度.
- */
-export declare const enum KG__SPAN {
-    _1 = 1,
-    _2 = 2,
-    _3 = 3,
-    _4 = 4,
-    _5 = 5,
-    _6 = 6,
-    _7 = 7,
-    _8 = 8,
-    _9 = 9,
-    _10 = 10,
-    _11 = 11,
-    _12 = 12,
-    _13 = 13,
-    _14 = 14,
-    _15 = 15,
-    _16 = 16,
-    _17 = 17,
-    _18 = 18,
-    _19 = 19,
-    _20 = 20,
-    _21 = 21,
-    _22 = 22,
-    _23 = 23,
-    _24 = 24
-}
-/**
- * 导出 EXCEL 文件的后缀.
- */
-export declare const enum KG__VAR_BUTTON__EXPORT_EXCEL_SUFFIX {
-    XLS = "XLS",
-    XLSX = "XLSX"
-}
-/** 系统描述表中的键. */
-export declare const enum KG_DESCRIPTION_CODE_NAME {
-    /** 是否. */
-    YN = "yn",
-    /** 表单布局方式. */
-    VAR_SUBMIT_LAYOUT = "var_submit_layout",
-    /** 栅格布局可选的列. */
-    VAR_SPAN = "var_span",
-    /** 按钮显示样式. */
-    VAR_BUTTON_DISPLAY_TYPE = "var_button_display_type",
-    /** 宽度单位. */
-    VAR_WIDTH_UNIT = "var_width_unit"
-}
-/** 高级查询的操作符. */
-export declare enum KG_DYNAMIC_QUERY_OPERATOR {
-    /** 等于. */
-    EQ = "EQ",
-    /** 不等于. */
-    NE = "NE",
-    /** 大于. */
-    GT = "GT",
-    /** 小于. */
-    LT = "LT",
-    /** 大于等于. */
-    GTE = "GTE",
-    /** 小于等于. */
-    LTE = "LTE",
-    /** 以之开始. */
-    START_WITH = "START",
-    /** 以之结束. */
-    END_WITH = "END",
-    /** 包含. */
-    CONTAIN = "CONTAIN",
-    /** 属于. */
-    IN = "IN",
-    /** 范围之内. */
-    BETWEEN = "BETWEEN"
-}
-/** 请求头部. */
-export declare enum KG_HTTP_HEADERS {
-    /** 界面标识. */
-    KG_FORM_ID = "Kg-Form-Id",
-    KG_BUTTON_VAR_NAME = "Kg-Button-Var-Name",
-    /** 是否启用高级查询. */
-    KG_IS_DYNAMIC_QUERY = "Kg-Is-Dynamic-Query",
-    /** 查询语句中的 WHERE 片段. */
-    KG_QUERY_WHERE_SQL = "Kg-Query-Where-Sql",
-    /** 查询语句中的 ORDER BY 片段. */
-    KG_QUERY_ORDER_BY_SQL = "Kg-Query-Order-By-Sql",
-    /** 查询语句中的 OFFSET 片段. */
-    KG_QUERY_OFFSET_SQL = "Kg-Query-Offset-Sql",
-    /** 查询语句中的 WHERE + ORDER BY + OFFSET 片段. */
-    KG_QUERY_SQL = "Kg-Query-Sql",
-    /**
-     * <p>高级查询时, 每个查询字段的操作符(=,>,<...).</p>
-     * <p>是一个 JSON 字符串, 由后端进行解析. 其中的 key 表示查询字段的名称, 其中的 value 表示查询字段的操作符.</p>
-     */
-    KG_QUERY_OPERATOR = "Kg-Query-Operator",
-    /**
-     * 仓库编号.
-     */
-    KG_WAREHOUSE = "Kg-Warehouse"
-}
-/** 特殊属性:请求返回的原始响应数据. */
-export declare const __KG__RESPONSE__ = "__KG__RESPONSE__";
-/** 模块菜单的临时ID:数据管理. */
-export declare const KG_TMP_MENU_ID__DATA_MANAGER = "KG_TMP_MENU_ID__DATA_MANAGER";
-/** 模块菜单的临时ID:仓库管理. */
-export declare const KG_TMP_MENU_ID__BUSINESS_MANAGER = "KG_TMP_MENU_ID__BUSINESS_MANAGER";
-/** 模块菜单的临时ID:WCS. */
-export declare const KG_TMP_MENU_ID__WCS = "KG_TMP_MENU_ID__WCS";
-/** 模块菜单的临时ID:系统配置. */
-export declare const KG_TMP_MENU_ID__SYS = "KG_TMP_MENU_ID__SYS";
-/** 模块菜单的临时ID:PDA. */
-export declare const KG_TMP_MENU_ID__PDA = "KG_TMP_MENU_ID__PDA";
-/** 移除事件监听函数. */
-export declare type IRemoveEventListenerHandler = () => void;
-export declare type IKgEventListener = {
-    /** 是否只会触发一次. */
-    isOnce?: boolean;
-    /** 是否已经触发过一次了. */
-    invoked?: boolean;
-};
-/** 菜单. */
-export interface Menu {
-    id: string;
-    app: string | null;
-    name: string;
-    title: string;
-    path?: string;
-    icon?: string;
-    hideMenu?: boolean;
-    children?: Menu[];
-    [key: string]: any;
-}
-/**
- * 按钮确认弹窗的参数.
- * <p>对应于 {@link VarButton#modal_props} 字段.</p>
- */
-export declare type IKgVarButtonModalProperties = ModalFuncProps & {
-    /** 是否隐藏取消按钮. */
-    kgHideCancelButton?: boolean;
-};
-/**
- * <p>提交弹窗的配置参数.</p>
- * <p>对应于 {@link VarSubmitConfig#props} 字段.</p>
- */
-export interface IKgVarSubmitConfigProperties {
-    /** 确认按钮. */
-    okButton?: {
-        /** 确认按钮的文本, 实际是一个变量名, 根据变量进行翻译. */
-        textVarName?: string;
-    };
-    /** 显示方式. */
-    displayType?: {
-        [KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE.INLINE]?: {
-            /** 要嵌入的页面位置, 是一个 CSS 选择器, 如: #submit-target-xxx. */
-            target?: string;
-        };
-    };
-}
-/**
- * <p>表单控件的参数.</p>
- * <p>对应于 {@link VarConfigControl.ctrl_prop} 字段, 根据表单控件的类型, 设置额外的参数.</p>
- * @see VarConfigControl.ctrl_prop
- * @see KG__VAR_CONFIG_CONTROL__CONTROL_TYPE
- */
-export interface IKgVarConfigControlControlProperties {
-    CHECKBOX_GROUP: {
-        /**
-         * <p>要排除的数据.</p>
-         * <p>这些数据会从列表数据中移除.</p>
-         */
-        excludeValues?: Array<any>;
-        /**
-         * 数据项的宽度.
-         *
-         * @default 24
-         */
-        span?: number;
-        /**
-         * 是否显示「全选」.
-         *
-         * @default true
-         */
-        isShowSelectAll?: boolean;
-    };
-    DATE_RANGE: {
-        /**
-         * <p>是否允许为空.</p>
-         * <p>参考 <a href="https://3x.antdv.com/components/date-picker#RangePicker">https://3x.antdv.com/components/date-picker#RangePicker</a>.</p>
-         *
-         * @default [false, false]
-         */
-        allowEmpty?: [boolean, boolean];
-    };
-    IMAGE: {
-        /**
-         * 高度.
-         *
-         * @default 100
-         */
-        height?: number;
-        /**
-         * 宽度.
-         *
-         * @default 100
-         */
-        width?: number;
-    };
-    RADIO_GROUP: {
-        /**
-         * 数据项的宽度.
-         * @default 24
-         */
-        span?: number;
-    };
-    SELECT: {
-        /**
-         * <p>是否允许清空.</p>
-         *
-         * @default true
-         */
-        allowClear?: boolean;
-    };
-    TEXT_AREA: {
-        /**
-         * 文本框的高度.
-         * @default 5
-         */
-        rows?: number;
-    };
-}
-/**
- * 对应的是 {@link VarGridDetail.display_type_properties} 字段, 根据显示类型, 设置额外的参数.
- *
- * @see VarGridDetail.display_type_properties
- * @see KG__VAR_GRID_DETAIL__DISPLAY_TYPE
- */
-export interface IKgVarGridDetailDisplayTypeProperties {
-    DESC: {
-        description?: {
-            /**
-             * <p>对应的是 {@link Description.codnam}.</p>
-             * <p>当该配置项不为空时, 表示描述来自于系统描述表, 否则来自于 {@link IKgVarGridDetailDisplayTypeProperties.DESC.dscFieldName} 对应的列.<p>
-             */
-            codeName?: string;
-            /**
-             * <p>对应的是 {@link Description.codval}.</p>
-             * <p>默认值为该列的值.</p>
-             * <p>
-             *     可以是一个 JS 表达式, 组件库会解析该表达式, 并得到真正的值. 比如表达式 \`${row.id}\` 表示获取该行的 id 列的值. 表达式中可以使用下列变量:
-             *     <ul>
-             *         <li>row: 表示该行数据,</li>
-             *     </ul>
-             * </p>
-             */
-            codeValue?: string;
-            /**
-             * <p>是否延迟获取系统描述数据.</p>
-             * <p>默认情况下, 在页面加载后会立即获取 {@link IKgVarGridDetailDisplayTypeProperties.DESC.description.codeName} 对应的系统描述数据. 这种场景适合数据较少的枚举数据.</p>
-             * <p>如果描述数据特别多, 比如每一行的描述都不一样, 则可以将该配置项的值配置为 true, 表示会在表格每次查询的时候, 才去请求这些列表数据对应的系统描述数据.</p>
-             *
-             * @default false
-             */
-            isDefer?: boolean;
-        };
-        /**
-         * <p>默认情况下, 当原始列的列名为 xyz 时, 描述列的列名为 xyz_dsc 或者 xyzDsc.</p>
-         * <p>通过该配置项可以将描述列的列名配置为其他值.</p>
-         * @default <列名>_dsc 或者 <列名>Dsc
-         */
-        dscFieldName?: string;
-        /**
-         * 是否显示为一个 Tag 标签.
-         * @default false
-         */
-        isTag?: boolean;
-        /**
-         * <ul>
-         *     <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.isTag} 为 true, 则此属性用来定义每个值对应的标签颜色分别是什么,</li>
-         *     <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.isTag} 为 false, 则此属性会被忽略,</li>
-         * </ul>
-         */
-        tagColors?: Array<{
-            /** 值. */
-            value: any;
-            /**
-             * 颜色.
-             * @default 'default'
-             */
-            color?: string;
-        }>;
-    };
-    FILE_SIZE: {};
-    ICON: {};
-    IMAGE: {
-        /**
-         * 宽度.
-         *
-         * @default 29
-         */
-        width?: number;
-        /**
-         * 宽度.
-         *
-         * @default 29
-         */
-        height?: number;
-    };
-    PROGRESS: {
-        /** 左侧数值对应的列. */
-        leftColumn: string;
-        /** 右侧数值对应的列. */
-        rightColumn: string;
-        /**
-         * 右侧文本的宽度. 例如: "100px".
-         * @default 'auto'
-         */
-        textWidth?: 'auto' | string;
-    };
-    ROUTE_LINK: {
-        /** 要跳转的路由地址. */
-        path: string;
-    };
-    UPDATE_LINK: {};
-    YN: {
-        /**
-         * 显示为'否'的值.
-         * @default 0
-         */
-        nValue?: any;
-        /**
-         * 是否将 null/undefined 当成 false.
-         * @default false
-         */
-        nilAsFalse?: boolean;
-        /**
-         * 显示为'是'的值.
-         * @default 1
-         */
-        yValue?: any;
-    };
-}