@kengic/vue 0.16.7-beta.0 → 0.17.0

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

@@ -0,0 +1,253 @@
+export * from './i18n';
+export * from './index.vm';
+export * from './injection-keys.const';
+/** 模块. */
+export declare const enum KG_APP {
+    WMS_DATA_MANAGER = "data-manager",
+    WMS_BUSINESS_MANAGER = "business-manager",
+    WCS = "wcs",
+    SYS = "sys"
+}
+/** 所有模块. */
+export declare const KG_APPS: Array<KG_APP>;
+/** 模块路径前缀. */
+export declare const enum KG_APP_PREFIX {
+    WMS_DATA_MANAGER = "/wms/data-manager",
+    WMS_BUSINESS_MANAGER = "/wms/business-manager",
+    WCS = "/wcs",
+    SYS = "/sys"
+}
+/** 所有模块路径前缀. */
+export declare const KG_APP_PREFIXS: Array<KG_APP_PREFIX>;
+/**
+ * 表单控件类型.
+ * @see VarVariableConfig.ctrl_prop
+ * @see IKgVariableConfigProps
+ */
+export declare const enum KG_FORM_ITEM_TYPE {
+    /** 文本. */
+    INPUT = "INPUT",
+    /** 密码. */
+    INPUT_PASSWORD = "INPUT_PASSWORD",
+    /** 数字. */
+    INPUT_NUMBER = "INPUT_NUMBER",
+    /** 多行文本. */
+    TEXT_AREA = "TEXT_AREA",
+    /** 多选框. */
+    CHECKBOX = "CHECKBOX",
+    /**
+     * 多选框列表.
+     * 配置属性参见 {@link IKgVariableConfigProps.CHECKBOX_GROUP}.
+     */
+    CHECKBOX_GROUP = "CHECKBOX_GROUP",
+    /**
+     * 单选框列表.
+     * 配置属性参见 {@link IKgVariableConfigProps.RADIO_GROUP}.
+     */
+    RADIO_GROUP = "RADIO_GROUP",
+    /** 开关. */
+    SWITCH = "SWITCH",
+    /** 下拉列表单选. */
+    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",
+    /** 文件上传按钮. */
+    BUTTON_UPLOAD = "BUTTON_UPLOAD"
+}
+/** 表单控件所处环境. */
+export declare const enum KG_FORM_CONTEXT {
+    /** 位于查询条件. */
+    SEARCH = "SEARCH",
+    /** 位于表单. */
+    SUBMIT = "SUBMIT",
+    /** 位于表格内的表单. */
+    TABLE = "TABLE"
+}
+/**
+ * 表格单元格的显示类型.
+ * @see VarGridDetail.display_type_properties
+ * @see IKgGridDetailDisplayTypeProperties
+ */
+export declare const enum KG_TABLE_CELL_DISPLAY_TYPE {
+    /** 布尔数据, 使用 KgYesOrNo 组件显示. */
+    YN = "YN",
+    /** 枚举数据, 使用 Tag 组件显示. */
+    ENUM = "ENUM",
+    /** 进度条, 使用 KgProgressA 组件显示. */
+    PROGRESS = "PROGRESS",
+    /** 文件大小, 将以字节(byte)为单位的数字格式化显示(XXX MB, XXX GB, ...). */
+    FILE_SIZE = "FILE_SIZE",
+    /** 显示为超链接, 点击打开更新弹窗. */
+    UPDATE_LINK = "UPDATE_LINK",
+    /** 显示为超链接, 点击跳转到其他路由. */
+    ROUTE_LINK = "ROUTE_LINK",
+    /**
+     * 显示描述字段.
+     * 假如原字段为 'status', 则实际上会显示描述字段 'status_dsc(或者 statusDsc)' 的值.
+     * 默认, 描述字段是原字段加上 '_dsc(或者 Dsc)' 后缀, 比如原字段为 'status', 则描述字段为 'status_dsc(或者 statusDsc)'.
+     * 可以通过 {@link IKgGridDetailDisplayTypeProperties.DESC.dscFieldName} 设置自定义的描述字段名.
+     */
+    DESC = "DESC"
+}
+/** 按钮类型. */
+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_BUTTON_COLOR {
+    /** 错误. */
+    DANGER = "DANGER",
+    /** 警告. */
+    WARN = "WARN"
+}
+/** 按钮显示方式. */
+export declare const enum KG_BUTTON_DISPLAY_TYPE {
+    /** 按钮依次排列在一横排. */
+    DEFAULT = "DEFAULT",
+    /** 显示为下拉的菜单列表. */
+    SELECT = "SELECT"
+}
+/** 表单显示方式. */
+export declare const enum KG_VAR_SUBMIT__DISPLAY_TYPE {
+    /** 弹窗. */
+    MODAL = "MODAL",
+    /** 抽屉. */
+    DRAWER = "DRAWER",
+    /** 在表格内. */
+    TABLE = "TABLE"
+}
+/** 表单布局方式. */
+export declare const enum KG_VAR_SUBMIT__LAYOUT {
+    /** 垂直. */
+    VERTICAL = "vertical",
+    /** 水平. */
+    HORIZONTAL = "horizontal"
+}
+/** 变量表单输入验证: 数据类型. */
+export declare const enum KG_VAR_INPUT__DATA_TYPE {
+    /** 数字(整数, 小数). */
+    NUMBER = "NUMBER"
+}
+/** 定制级别. */
+export declare const enum KG_CUSTOM_LEVEL {
+    /** 系统. */
+    L0 = 0,
+    /** 用户. */
+    L10 = 10
+}
+/** 下拉列表数据中值的类型. */
+export declare const enum KG_POSSIBILITY_DATA_TYPE {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean"
+}
+/** 宽度单位. */
+export declare const enum KG_WIDTH_UNIT {
+    /** 网格. */
+    SPAN = "SPAN",
+    /** 像素. */
+    PX = "PX"
+}
+/** EXCEL 文件后缀. */
+export declare const enum KG_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_DYNAMIC_QUERY = "Kg-Dynamic-Query",
+    /** 拼接后的查询 SQL: WHERE + ORDER BY. */
+    KG_QUERY_SQL = "Kg-Query-Sql",
+    /** 拼接后的查询 SQL: WHERE. */
+    KG_QUERY_WHERE_SQL = "Kg-Query-Where-Sql",
+    /** 拼接后的查询 SQL: ORDER BY. */
+    KG_QUERY_ORDER_BY_SQL = "Kg-Query-Order-By-Sql",
+    /**
+     * 高级查询时, 每个查询字段的操作符(=,>,<...).
+     * 是一个 JSON 字符串, 由后端进行解析.
+     */
+    KG_QUERY_OPERATOR = "Kg-Query-Operator"
+}
+/** 特殊属性:请求返回的原始响应数据. */
+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";

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

@@ -0,0 +1,170 @@
+import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
+/** 移除事件监听函数. */
+export declare type IRemoveEventListenerHandler = () => void;
+export declare type IKgEventCb = {
+    /** 是否只会触发一次. */
+    once?: 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;
+}
+/** 语言. */
+export declare type IKgLocale = 'zh_CN' | 'en' | 'ru' | 'ja' | 'ko';
+/**
+ * 按钮确认弹窗的参数.
+ * <p>对应于 {@link VarButton.modal_props} 字段.</p>
+ */
+export declare type IKgButtonModalProps = ModalFuncProps & {
+    /** 是否隐藏取消按钮. */
+    kgHideCancelButton?: boolean;
+};
+/**
+ * 提交弹窗的参数.
+ * <p>对应于 {@link VarSubmitConfig.props} 字段.</p>
+ */
+export interface IKgSubmitConfigProps {
+    /** 创建时, 确认按钮的文本对应的变量名. */
+    'footer.ok-button.text-var-name.creating'?: string;
+    /** 更新时, 确认按钮的文本对应的变量名. */
+    'footer.ok-button.text-var-name.updating'?: string;
+    /** 复制时, 确认按钮的文本对应的变量名. */
+    'footer.ok-button.text-var-name.copying'?: string;
+    /** 删除时, 确认按钮的文本对应的变量名. */
+    'footer.ok-button.text-var-name.deleting'?: string;
+}
+/**
+ * 表单控件的参数.
+ * <p>对应于 {@link VarVariableConfig.ctrl_prop} 字段, 根据表单控件的类型, 设置额外的参数.</p>
+ * @see VarVariableConfig.ctrl_prop
+ * @see KG_FORM_ITEM_TYPE
+ */
+export interface IKgVariableConfigProps {
+    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];
+    };
+    TEXT_AREA: {
+        /**
+         * 文本框的高度.
+         * @default 5
+         */
+        rows?: number;
+    };
+    CHECKBOX_GROUP: {
+        /**
+         * 数据项的宽度.
+         * @default 24
+         */
+        span?: number;
+        /** 要排除哪些值. */
+        excludeValues?: Array<any>;
+    };
+    RADIO_GROUP: {
+        /**
+         * 数据项的宽度.
+         * @default 24
+         */
+        span?: number;
+    };
+    SELECT: {
+        /**
+         * 是否允许清空.
+         * @default true
+         */
+        allowClear?: boolean;
+    };
+}
+/**
+ * 对应于 {@link VarGridDetail.display_type_properties} 字段, 根据显示类型, 设置额外的参数.
+ * @see VarGridDetail.display_type_properties
+ * @see KG_TABLE_CELL_DISPLAY_TYPE
+ */
+export interface IKgGridDetailDisplayTypeProps {
+    YN: {
+        /**
+         * 显示为'是'的值.
+         * @default 1
+         */
+        yValue?: any;
+        /**
+         * 显示为'否'的值.
+         * @default 0
+         */
+        nValue?: any;
+        /**
+         * 是否将 null/undefined 当成 false.
+         * @default false
+         */
+        nilAsFalse?: boolean;
+    };
+    /** @deprecated 请使用 {@link IKgGridDetailDisplayTypeProps.DESC}. */
+    ENUM: Array<{
+        /** 变量名称. */
+        varName: string;
+        /** 数据. */
+        value: any;
+        /**
+         * 颜色.
+         * @default 'default'
+         */
+        color?: string;
+    }>;
+    PROGRESS: {
+        /** 左侧数值对应的列. */
+        leftColumn: string;
+        /** 右侧数值对应的列. */
+        rightColumn: string;
+        /**
+         * 右侧文本的宽度. 例如: "100px".
+         * @default 'auto'
+         */
+        textWidth?: 'auto' | string;
+    };
+    FILE_SIZE: {};
+    UPDATE_LINK: {};
+    ROUTE_LINK: {
+        /** 要跳转的路由地址. */
+        path: string;
+    };
+    DESC: {
+        /**
+         * 对应的描述字段的名称.
+         * @default 原字段 + '_dsc', 原字段 + 'Dsc'
+         */
+        dscFieldName?: string;
+        /**
+         * 是否显示为一个 Tag 标签.
+         * @default false
+         */
+        isTag?: boolean;
+        /**
+         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 true, 则该属性用来定义每个值对应的标签颜色分别是什么.
+         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 false, 则该属性会被忽略.
+         */
+        tagColors?: Array<{
+            /** 值. */
+            value: any;
+            /**
+             * 颜色.
+             * @default 'default'
+             */
+            color?: string;
+        }>;
+    };
+}

package/dist/src/consts/injection-keys.const.d.ts

@@ -0,0 +1,9 @@
+import { InjectionKey } from 'vue';
+/** 界面标识. */
+export declare const KG_DI_FORM_ID: InjectionKey<string>;
+/** 宿主界面标识. */
+export declare const KG_DI_HOST_FORM_ID: InjectionKey<string>;
+/** 变量名称. */
+export declare const KG_DI_VAR_NAME: InjectionKey<string>;
+/** 变量查找编号. */
+export declare const KG_DI_LOOKUP_ID: InjectionKey<string>;