581 lines
15 KiB
TypeScript
581 lines
15 KiB
TypeScript
import type { VbenFormSchema } from '#/adapter/form';
|
||
import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
|
||
import type { InfraCodegenApi } from '#/api/infra/codegen';
|
||
import type { InfraDataSourceConfigApi } from '#/api/infra/data-source-config';
|
||
import type { SystemMenuApi } from '#/api/system/menu';
|
||
import type { Recordable } from '@vben/types';
|
||
|
||
import { IconifyIcon } from '@vben/icons';
|
||
|
||
import { z } from '#/adapter/form';
|
||
import { getMenuList } from '#/api/system/menu';
|
||
import { getRangePickerDefaultProps } from '#/utils/date';
|
||
import { DICT_TYPE, getDictOptions } from '#/utils/dict';
|
||
import { handleTree } from '#/utils/tree';
|
||
import { h } from 'vue';
|
||
|
||
import { useAccess } from '@vben/access';
|
||
import { $t } from '@vben/locales';
|
||
|
||
const { hasAccessByCodes } = useAccess();
|
||
|
||
/** 导入数据库表的表单 */
|
||
export function useImportTableFormSchema(
|
||
dataSourceConfigList: InfraDataSourceConfigApi.InfraDataSourceConfig[],
|
||
): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
fieldName: 'dataSourceConfigId',
|
||
label: '数据源',
|
||
component: 'Select',
|
||
componentProps: {
|
||
options: dataSourceConfigList.map((item) => ({
|
||
label: item.name,
|
||
value: item.id,
|
||
})),
|
||
placeholder: '请选择数据源',
|
||
},
|
||
defaultValue: dataSourceConfigList[0]?.id,
|
||
rules: 'required',
|
||
},
|
||
{
|
||
fieldName: 'name',
|
||
label: '表名称',
|
||
component: 'Input',
|
||
componentProps: {
|
||
allowClear: true,
|
||
placeholder: '请输入表名称',
|
||
},
|
||
},
|
||
{
|
||
fieldName: 'comment',
|
||
label: '表描述',
|
||
component: 'Input',
|
||
componentProps: {
|
||
allowClear: true,
|
||
placeholder: '请输入表描述',
|
||
},
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 基本信息表单的 schema */
|
||
export function useBasicInfoFormSchema(): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
fieldName: 'tableName',
|
||
label: '表名称',
|
||
component: 'Input',
|
||
componentProps: {
|
||
placeholder: '请输入仓库名称',
|
||
},
|
||
rules: 'required',
|
||
},
|
||
{
|
||
fieldName: 'tableComment',
|
||
label: '表描述',
|
||
component: 'Input',
|
||
componentProps: {
|
||
placeholder: '请输入',
|
||
},
|
||
rules: 'required',
|
||
},
|
||
{
|
||
fieldName: 'className',
|
||
label: '实体类名称',
|
||
component: 'Input',
|
||
componentProps: {
|
||
placeholder: '请输入',
|
||
},
|
||
rules: 'required',
|
||
help: '默认去除表名的前缀。如果存在重复，则需要手动添加前缀，避免 MyBatis 报 Alias 重复的问题。',
|
||
},
|
||
{
|
||
fieldName: 'author',
|
||
label: '作者',
|
||
component: 'Input',
|
||
componentProps: {
|
||
placeholder: '请输入',
|
||
},
|
||
rules: 'required',
|
||
},
|
||
{
|
||
fieldName: 'remark',
|
||
label: '备注',
|
||
component: 'Textarea',
|
||
componentProps: {
|
||
rows: 3,
|
||
},
|
||
// 使用 Tailwind 的 col-span-2 让元素跨越两列
|
||
formItemClass: 'md:col-span-2',
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 生成信息表单基础 schema */
|
||
export function useGenerationInfoBaseFormSchema(): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'templateType',
|
||
label: '生成模板',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
options: getDictOptions(DICT_TYPE.INFRA_CODEGEN_TEMPLATE_TYPE, 'number'),
|
||
},
|
||
rules: z.number().min(1, { message: '生成模板不能为空' }),
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'frontType',
|
||
label: '前端类型',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
options: getDictOptions(DICT_TYPE.INFRA_CODEGEN_FRONT_TYPE, 'number'),
|
||
},
|
||
rules: z.number().min(1, { message: '前端类型不能为空' }),
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'scene',
|
||
label: '生成场景',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
options: getDictOptions(DICT_TYPE.INFRA_CODEGEN_SCENE, 'number'),
|
||
},
|
||
rules: z.number().min(1, { message: '生成场景不能为空' }),
|
||
},
|
||
{
|
||
fieldName: 'parentMenuId',
|
||
label: '上级菜单',
|
||
help: '分配到指定菜单下，例如 系统管理',
|
||
component: 'ApiTreeSelect',
|
||
componentProps: {
|
||
allowClear: true,
|
||
api: async () => {
|
||
const data = await getMenuList();
|
||
data.unshift({
|
||
id: 0,
|
||
name: '顶级菜单',
|
||
} as SystemMenuApi.SystemMenu);
|
||
return handleTree(data);
|
||
},
|
||
class: 'w-full',
|
||
labelField: 'name',
|
||
valueField: 'id',
|
||
childrenField: 'children',
|
||
placeholder: '请选择上级菜单',
|
||
filterTreeNode(input: string, node: Recordable<any>) {
|
||
if (!input || input.length === 0) {
|
||
return true;
|
||
}
|
||
const name: string = node.label ?? '';
|
||
if (!name) return false;
|
||
return name.includes(input) || $t(name).includes(input);
|
||
},
|
||
showSearch: true,
|
||
treeDefaultExpandedKeys: [0],
|
||
},
|
||
rules: 'selectRequired',
|
||
renderComponentContent() {
|
||
return {
|
||
title({ label, icon }: { icon: string; label: string }) {
|
||
const components = [];
|
||
if (!label) return '';
|
||
if (icon) {
|
||
components.push(h(IconifyIcon, { class: 'size-4', icon }));
|
||
}
|
||
components.push(h('span', { class: '' }, $t(label || '')));
|
||
return h('div', { class: 'flex items-center gap-1' }, components);
|
||
},
|
||
};
|
||
},
|
||
},
|
||
{
|
||
component: 'Input',
|
||
fieldName: 'moduleName',
|
||
label: '模块名',
|
||
help: '模块名，即一级目录，例如 system、infra、tool 等等',
|
||
rules: z.string().min(1, { message: '模块名不能为空' }),
|
||
},
|
||
{
|
||
component: 'Input',
|
||
fieldName: 'businessName',
|
||
label: '业务名',
|
||
help: '业务名，即二级目录，例如 user、permission、dict 等等',
|
||
rules: z.string().min(1, { message: '业务名不能为空' }),
|
||
},
|
||
{
|
||
component: 'Input',
|
||
fieldName: 'className',
|
||
label: '类名称',
|
||
help: '类名称（首字母大写），例如SysUser、SysMenu、SysDictData 等等',
|
||
rules: z.string().min(1, { message: '类名称不能为空' }),
|
||
},
|
||
{
|
||
component: 'Input',
|
||
fieldName: 'classComment',
|
||
label: '类描述',
|
||
help: '用作类描述，例如 用户',
|
||
rules: z.string().min(1, { message: '类描述不能为空' }),
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 树表信息 schema */
|
||
export function useTreeTableFormSchema(columns: InfraCodegenApi.CodegenColumn[] = []): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
component: 'Divider',
|
||
fieldName: 'treeDivider',
|
||
label: '',
|
||
renderComponentContent: () => {
|
||
return {
|
||
default: () => ['树表信息'],
|
||
};
|
||
},
|
||
formItemClass: 'md:col-span-2',
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'treeParentColumnId',
|
||
label: '父编号字段',
|
||
help: '树显示的父编码字段名， 如：parent_Id',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
allowClear: true,
|
||
placeholder: '请选择',
|
||
options: columns.map((column) => ({
|
||
label: column.columnName,
|
||
value: column.id,
|
||
})),
|
||
},
|
||
rules: 'selectRequired',
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'treeNameColumnId',
|
||
label: '名称字段',
|
||
help: '树节点显示的名称字段，一般是name',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
allowClear: true,
|
||
placeholder: '请选择',
|
||
options: columns.map((column) => ({
|
||
label: column.columnName,
|
||
value: column.id,
|
||
})),
|
||
},
|
||
rules: 'selectRequired',
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 主子表信息 schema */
|
||
export function useSubTableFormSchema(
|
||
columns: InfraCodegenApi.CodegenColumn[] = [],
|
||
tables: InfraCodegenApi.CodegenTable[] = [],
|
||
): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
component: 'Divider',
|
||
fieldName: 'subDivider',
|
||
label: '',
|
||
renderComponentContent: () => {
|
||
return {
|
||
default: () => ['主子表信息'],
|
||
};
|
||
},
|
||
formItemClass: 'md:col-span-2',
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'masterTableId',
|
||
label: '关联的主表',
|
||
help: '关联主表（父表）的表名， 如：system_user',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
allowClear: true,
|
||
placeholder: '请选择',
|
||
options: tables.map((table) => ({
|
||
label: `${table.tableName}：${table.tableComment}`,
|
||
value: table.id,
|
||
})),
|
||
},
|
||
rules: 'selectRequired',
|
||
},
|
||
{
|
||
component: 'Select',
|
||
fieldName: 'subJoinColumnId',
|
||
label: '子表关联的字段',
|
||
help: '子表关联的字段， 如：user_id',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
allowClear: true,
|
||
placeholder: '请选择',
|
||
options: columns.map((column) => ({
|
||
label: `${column.columnName}:${column.columnComment}`,
|
||
value: column.id,
|
||
})),
|
||
},
|
||
rules: 'selectRequired',
|
||
},
|
||
{
|
||
component: 'RadioGroup',
|
||
fieldName: 'subJoinMany',
|
||
label: '关联关系',
|
||
help: '主表与子表的关联关系',
|
||
componentProps: {
|
||
class: 'w-full',
|
||
allowClear: true,
|
||
placeholder: '请选择',
|
||
options: [
|
||
{
|
||
label: '一对多',
|
||
value: true,
|
||
},
|
||
{
|
||
label: '一对一',
|
||
value: 'false',
|
||
},
|
||
],
|
||
},
|
||
rules: 'required',
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 列表的搜索表单 */
|
||
export function useGridFormSchema(): VbenFormSchema[] {
|
||
return [
|
||
{
|
||
fieldName: 'tableName',
|
||
label: '表名称',
|
||
component: 'Input',
|
||
componentProps: {
|
||
allowClear: true,
|
||
placeholder: '请输入表名称',
|
||
},
|
||
},
|
||
{
|
||
fieldName: 'tableComment',
|
||
label: '表描述',
|
||
component: 'Input',
|
||
componentProps: {
|
||
allowClear: true,
|
||
placeholder: '请输入表描述',
|
||
},
|
||
},
|
||
{
|
||
fieldName: 'createTime',
|
||
label: '创建时间',
|
||
component: 'RangePicker',
|
||
componentProps: {
|
||
...getRangePickerDefaultProps(),
|
||
allowClear: true,
|
||
},
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 列表的字段 */
|
||
export function useGridColumns<T = InfraCodegenApi.CodegenTable>(
|
||
onActionClick: OnActionClickFn<T>,
|
||
dataSourceConfigList: InfraDataSourceConfigApi.InfraDataSourceConfig[],
|
||
): VxeTableGridOptions['columns'] {
|
||
return [
|
||
{
|
||
field: 'dataSourceConfigId',
|
||
title: '数据源',
|
||
minWidth: 120,
|
||
formatter: ({ cellValue }) => {
|
||
const config = dataSourceConfigList.find((item) => item.id === cellValue);
|
||
return config ? config.name : '';
|
||
},
|
||
},
|
||
{
|
||
field: 'tableName',
|
||
title: '表名称',
|
||
minWidth: 200,
|
||
},
|
||
{
|
||
field: 'tableComment',
|
||
title: '表描述',
|
||
minWidth: 200,
|
||
},
|
||
{
|
||
field: 'className',
|
||
title: '实体',
|
||
minWidth: 200,
|
||
},
|
||
{
|
||
field: 'createTime',
|
||
title: '创建时间',
|
||
minWidth: 180,
|
||
formatter: 'formatDateTime',
|
||
},
|
||
{
|
||
field: 'updateTime',
|
||
title: '更新时间',
|
||
minWidth: 180,
|
||
formatter: 'formatDateTime',
|
||
},
|
||
{
|
||
field: 'operation',
|
||
title: '操作',
|
||
width: 300,
|
||
fixed: 'right',
|
||
align: 'center',
|
||
cellRender: {
|
||
attrs: {
|
||
nameField: 'tableName',
|
||
nameTitle: '代码生成',
|
||
onClick: onActionClick,
|
||
},
|
||
name: 'CellOperation',
|
||
options: [
|
||
{
|
||
code: 'preview',
|
||
text: '预览',
|
||
show: hasAccessByCodes(['infra:codegen:preview']),
|
||
},
|
||
{
|
||
code: 'edit',
|
||
show: hasAccessByCodes(['infra:codegen:update']),
|
||
},
|
||
{
|
||
code: 'delete',
|
||
show: hasAccessByCodes(['infra:codegen:delete']),
|
||
},
|
||
{
|
||
code: 'sync',
|
||
text: '同步',
|
||
show: hasAccessByCodes(['infra:codegen:update']),
|
||
},
|
||
{
|
||
code: 'generate',
|
||
text: '生成代码',
|
||
show: hasAccessByCodes(['infra:codegen:download']),
|
||
},
|
||
],
|
||
},
|
||
},
|
||
];
|
||
}
|
||
|
||
/** 代码生成表格列定义 */
|
||
export function useCodegenColumnTableColumns(): VxeTableGridOptions['columns'] {
|
||
return [
|
||
{ field: 'columnName', title: '字段列名', minWidth: 130 },
|
||
{
|
||
field: 'columnComment',
|
||
title: '字段描述',
|
||
minWidth: 100,
|
||
slots: { default: 'columnComment' },
|
||
},
|
||
{ field: 'dataType', title: '物理类型', minWidth: 100 },
|
||
{
|
||
field: 'javaType',
|
||
title: 'Java类型',
|
||
minWidth: 100,
|
||
slots: { default: 'javaType' },
|
||
params: {
|
||
options: [
|
||
{ label: 'Long', value: 'Long' },
|
||
{ label: 'String', value: 'String' },
|
||
{ label: 'Integer', value: 'Integer' },
|
||
{ label: 'Double', value: 'Double' },
|
||
{ label: 'BigDecimal', value: 'BigDecimal' },
|
||
{ label: 'LocalDateTime', value: 'LocalDateTime' },
|
||
{ label: 'Boolean', value: 'Boolean' },
|
||
],
|
||
},
|
||
},
|
||
{
|
||
field: 'javaField',
|
||
title: 'java属性',
|
||
minWidth: 100,
|
||
slots: { default: 'javaField' },
|
||
},
|
||
{
|
||
field: 'createOperation',
|
||
title: '插入',
|
||
width: 40,
|
||
slots: { default: 'createOperation' },
|
||
},
|
||
{
|
||
field: 'updateOperation',
|
||
title: '编辑',
|
||
width: 40,
|
||
slots: { default: 'updateOperation' },
|
||
},
|
||
{
|
||
field: 'listOperationResult',
|
||
title: '列表',
|
||
width: 40,
|
||
slots: { default: 'listOperationResult' },
|
||
},
|
||
{
|
||
field: 'listOperation',
|
||
title: '查询',
|
||
width: 40,
|
||
slots: { default: 'listOperation' },
|
||
},
|
||
{
|
||
field: 'listOperationCondition',
|
||
title: '查询方式',
|
||
minWidth: 100,
|
||
slots: { default: 'listOperationCondition' },
|
||
params: {
|
||
options: [
|
||
{ label: '=', value: '=' },
|
||
{ label: '!=', value: '!=' },
|
||
{ label: '>', value: '>' },
|
||
{ label: '>=', value: '>=' },
|
||
{ label: '<', value: '<' },
|
||
{ label: '<=', value: '<=' },
|
||
{ label: 'LIKE', value: 'LIKE' },
|
||
{ label: 'BETWEEN', value: 'BETWEEN' },
|
||
],
|
||
},
|
||
},
|
||
{
|
||
field: 'nullable',
|
||
title: '允许空',
|
||
width: 50,
|
||
slots: { default: 'nullable' },
|
||
},
|
||
{
|
||
field: 'htmlType',
|
||
title: '显示类型',
|
||
width: 120,
|
||
slots: { default: 'htmlType' },
|
||
params: {
|
||
options: [
|
||
{ label: '文本框', value: 'input' },
|
||
{ label: '文本域', value: 'textarea' },
|
||
{ label: '下拉框', value: 'select' },
|
||
{ label: '单选框', value: 'radio' },
|
||
{ label: '复选框', value: 'checkbox' },
|
||
{ label: '日期控件', value: 'datetime' },
|
||
{ label: '图片上传', value: 'imageUpload' },
|
||
{ label: '文件上传', value: 'fileUpload' },
|
||
{ label: '富文本控件', value: 'editor' },
|
||
],
|
||
},
|
||
},
|
||
{
|
||
field: 'dictType',
|
||
title: '字典类型',
|
||
width: 120,
|
||
slots: { default: 'dictType' },
|
||
},
|
||
{
|
||
field: 'example',
|
||
title: '示例',
|
||
minWidth: 100,
|
||
slots: { default: 'example' },
|
||
},
|
||
];
|
||
}
|