Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ad5f7f18f5 | ||
|
|
e04d01a80c | ||
|
|
eb339ccc49 | ||
|
|
8f9dfd40e0 | ||
|
|
ee35b47f69 |
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "shrimp-server",
|
||||
"version": "0.6.5",
|
||||
"version": "0.6.10",
|
||||
"description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)",
|
||||
"main": "dist/main/index.js",
|
||||
"types": "dist/main/index.d.ts",
|
||||
|
||||
+2
-8
@@ -248,8 +248,6 @@ export interface IFieldTypeHandler {
|
||||
reqFilter?: (value: any, field: IFieldConfig, item: Record<string, any>) => any | Promise<any>
|
||||
/** 响应过滤:数据库取出 → 返回前端前转换(如密码脱敏为 ***、日期格式化) */
|
||||
resFilter?: (value: any, field: IFieldConfig, item: Record<string, any>) => any
|
||||
/** 响应附带的展示文本:返回值写入 `${key}_label`,本体不变。用于结构化字段(如 tab)给人看的字符串,前端表格直接显示,不必自己序列化 */
|
||||
resLabel?: (value: any, field: IFieldConfig, item: Record<string, any>) => string
|
||||
/** 验证:保存前校验,返回错误 ILabel 或 null(可直接返回字面字符串、{t}、{tc} 等) */
|
||||
validate?: (value: any, field: IFieldConfig, item: Record<string, any>) => ILabel | null | Promise<ILabel | null>
|
||||
/** 新增时的默认值(静态值或工厂函数) */
|
||||
@@ -278,12 +276,7 @@ export interface IFieldConfig {
|
||||
rules?: IFieldRule[] // 通用验证规则(前后端共用)
|
||||
/** tab 类型专用:每个 type 对应的子字段配置 */
|
||||
tabs?: { key: any; label: ILabel; fields: IFieldConfig[] }[]
|
||||
/** tab 类型专用:展示文本(表格列 `${key}_label`),给人看、可有损好看,默认 JSON.stringify。
|
||||
* relLabels 是已解析的子 relation 名(`{childKey: 名 | 名[]}`),单选为名、multiple 为名数组 */
|
||||
format?: (value: any, relLabels?: Record<string, any>) => string
|
||||
/** tab 类型专用:export 序列化,须与 parse 可逆(机器往返),默认 JSON.stringify */
|
||||
stringify?: (value: any) => string
|
||||
/** tab 类型专用:import 反序列化,须与 stringify 可逆,默认 JSON.parse */
|
||||
/** tab 类型专用:import 反序列化(把字符串还原成对象,如 xlsx 导入),默认 JSON.parse */
|
||||
parse?: (text: string) => any
|
||||
}
|
||||
|
||||
@@ -321,6 +314,7 @@ export interface IPageResult<T> {
|
||||
page: number // 当前页码
|
||||
pageSize: number // 每页数量
|
||||
totalPages: number // 总页数
|
||||
refs?: Record<string, Record<string, any>> // relation 显示名字典: { moduleKey: { id: 显示名 } },前端显示时查名,替代逐行 _label
|
||||
}
|
||||
|
||||
// ============== 数据源查询协议 ==============
|
||||
|
||||
@@ -60,9 +60,6 @@ export const defaultTypeHandlers: Record<string, IFieldTypeHandler> = {
|
||||
}
|
||||
return value
|
||||
},
|
||||
// 本体原样下发对象(不再 stringify);展示文本走 _label,用 format(给人看,可有损)
|
||||
// 第二参是已批量解析的子 relation 名(item.__tabRel[field.key]),让 format 能显示关联名而非 id
|
||||
resLabel: (value, field, item) => (field.format ?? JSON.stringify)(value, item?.__tabRel?.[field.key]),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -222,83 +219,60 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
||||
if (handler?.resFilter && result[field.key] !== undefined) {
|
||||
result[field.key] = await handler.resFilter(result[field.key], field, result)
|
||||
}
|
||||
if (handler?.resLabel && result[field.key] !== undefined) {
|
||||
result[`${field.key}_label`] = handler.resLabel(result[field.key], field, result)
|
||||
}
|
||||
}
|
||||
delete result.__tabRel // 临时挂的子 relation 解析结果,不下发
|
||||
return result
|
||||
}
|
||||
|
||||
private async prepareResponseItems(items: any[]): Promise<any[]> {
|
||||
if (items.length === 0) return items
|
||||
const populates = this.getRelationPopulates()
|
||||
if (populates.length > 0 && this.dataSource.populateItems) {
|
||||
await this.dataSource.populateItems(items, populates, this.root.crudRegistry)
|
||||
}
|
||||
await this.populateTabRelations(items)
|
||||
return Promise.all(items.map(item => this.processResItem(item)))
|
||||
}
|
||||
|
||||
private async prepareResponseItem(item: any): Promise<any> {
|
||||
if (!item) return item
|
||||
const populates = this.getRelationPopulates()
|
||||
if (populates.length > 0 && this.dataSource.populateItems) {
|
||||
await this.dataSource.populateItems([item], populates, this.root.crudRegistry)
|
||||
}
|
||||
await this.populateTabRelations([item])
|
||||
return this.processResItem(item)
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析 tab 字段里 relation 子字段的名字,批量(每个关联模块一次 $in),
|
||||
* 挂到 item.__tabRel[fieldKey][childKey],供该字段的 format 第二参使用。
|
||||
* 不污染 tab 本体对象(避免回灌进库),__tabRel 在 processResItem 末尾删除。
|
||||
* relation 字段(含 tab 分支里的嵌套 relation)批量解析成 refs 字典: { moduleKey: { id: 显示名 } }。
|
||||
* 整页一次性、按模块各查一次 $in,去重;替代逐行注入 ${key}_label。前端显示时按 id 查名。
|
||||
*/
|
||||
private async populateTabRelations(items: any[]): Promise<void> {
|
||||
const tabFields = this.fields.filter(f => f.type === ShrimpFieldTypes.Tab && Array.isArray(f.tabs))
|
||||
if (tabFields.length === 0 || items.length === 0) return
|
||||
|
||||
const need = new Map<string, { labelKey: string; ids: Set<string> }>()
|
||||
const refs: { item: any; fieldKey: string; childKey: string; moduleKey: string; multiple: boolean }[] = []
|
||||
for (const item of items) {
|
||||
for (const tf of tabFields) {
|
||||
const val = item[tf.key]
|
||||
if (!val || typeof val !== "object") continue
|
||||
const tab = tf.tabs!.find(t => t.key === val.type)
|
||||
if (!tab) continue
|
||||
for (const child of tab.fields) {
|
||||
if (child.type !== ShrimpFieldTypes.Relation || !child.relation || val[child.key] == null) continue
|
||||
const { moduleKey, labelKey } = child.relation
|
||||
let bucket = need.get(moduleKey)
|
||||
if (!bucket) need.set(moduleKey, (bucket = { labelKey, ids: new Set() }))
|
||||
const cv = val[child.key]
|
||||
;(Array.isArray(cv) ? cv : [cv]).forEach((id: any) => id != null && bucket!.ids.add(String(id)))
|
||||
refs.push({ item, fieldKey: tf.key, childKey: child.key, moduleKey, multiple: !!child.multiple })
|
||||
}
|
||||
}
|
||||
private async buildRefs(rows: any[]): Promise<Record<string, Record<string, any>>> {
|
||||
if (rows.length === 0) return {}
|
||||
const buckets = new Map<string, { labelKey: string; ids: Set<string> }>()
|
||||
const add = (moduleKey: string, labelKey: string, id: any) => {
|
||||
let b = buckets.get(moduleKey)
|
||||
if (!b) buckets.set(moduleKey, (b = { labelKey, ids: new Set() }))
|
||||
b.ids.add(String(id))
|
||||
}
|
||||
if (refs.length === 0) return
|
||||
|
||||
const labelMaps = new Map<string, Map<string, any>>()
|
||||
for (const [moduleKey, b] of need) {
|
||||
const m = new Map<string, any>()
|
||||
for (const row of rows) {
|
||||
this.collectRefs(this.fields, (k) => row[k], add)
|
||||
}
|
||||
if (buckets.size === 0) return {}
|
||||
const refs: Record<string, Record<string, any>> = {}
|
||||
for (const [moduleKey, b] of buckets) {
|
||||
const dict: Record<string, any> = {}
|
||||
const crud = this.root.crudRegistry.get(moduleKey)
|
||||
if (crud && b.ids.size > 0) {
|
||||
const res = await crud.list({ where: { _id: { in: Array.from(b.ids) } }, limit: b.ids.size })
|
||||
for (const doc of res.list as any[]) m.set(String(doc._id), doc[b.labelKey])
|
||||
for (const d of res.list as any[]) dict[String(d._id)] = d[b.labelKey]
|
||||
}
|
||||
labelMaps.set(moduleKey, m)
|
||||
refs[moduleKey] = dict
|
||||
}
|
||||
return refs
|
||||
}
|
||||
|
||||
for (const ref of refs) {
|
||||
const m = labelMaps.get(ref.moduleKey)!
|
||||
const cv = ref.item[ref.fieldKey][ref.childKey]
|
||||
const label = ref.multiple
|
||||
? (Array.isArray(cv) ? cv.map((id: any) => m.get(String(id)) ?? null) : [])
|
||||
: m.get(String(cv)) ?? null
|
||||
const bag = (ref.item.__tabRel ||= {})
|
||||
;(bag[ref.fieldKey] ||= {})[ref.childKey] = label
|
||||
/** 递归收集 relation 引用:relation 叶子直接收;tab 按 value.type 进选中分支继续下钻(覆盖嵌套/tab套tab) */
|
||||
private collectRefs(fields: IFieldConfig[], valueOf: (key: string) => any, add: (moduleKey: string, labelKey: string, id: any) => void): void {
|
||||
for (const f of fields) {
|
||||
const v = valueOf(f.key)
|
||||
if (v == null) continue
|
||||
if (f.type === "relation" && f.relation) {
|
||||
;(Array.isArray(v) ? v : [v]).forEach((id: any) => id != null && add(f.relation!.moduleKey, f.relation!.labelKey, id))
|
||||
} else if (f.type === ShrimpFieldTypes.Tab && Array.isArray(f.tabs) && typeof v === "object") {
|
||||
const branch = f.tabs.find(t => t.key === v.type)
|
||||
if (branch) this.collectRefs(branch.fields, (k) => v[k], add)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -315,18 +289,6 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
||||
return this.excludeKeys(item, this.fields.filter(f => f.hidden).map(f => f.key))
|
||||
}
|
||||
|
||||
private getRelationFields(): IFieldConfig[] {
|
||||
return this.fields.filter(f => f.type === "relation" && f.relation)
|
||||
}
|
||||
|
||||
private getRelationPopulates(): IShrimpPopulate[] {
|
||||
return this.getRelationFields().map(f => ({
|
||||
key: f.key,
|
||||
moduleKey: f.relation!.moduleKey,
|
||||
labelKey: f.relation!.labelKey,
|
||||
}))
|
||||
}
|
||||
|
||||
private buildQuery(query?: IPageQuery & any): IShrimpQuery {
|
||||
const { keyword, page, pageSize, sortBy, sortOrder, filter, ownerId } = query || {}
|
||||
const p = page || 1
|
||||
@@ -341,6 +303,11 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
||||
const stringLikeTypes = new Set(['string', 'textarea'])
|
||||
const where: Record<string, IShrimpCondition> = {}
|
||||
for (const [key, value] of Object.entries(filter)) {
|
||||
// _id 始终放行精确过滤(单项查看/relation 跳转用),无需配 filterable
|
||||
if (key === '_id') {
|
||||
if (value != null && value !== '') where['_id'] = { eq: value }
|
||||
continue
|
||||
}
|
||||
const field = filterableFields.get(key)
|
||||
if (!field) continue
|
||||
if (value == null) continue
|
||||
@@ -395,6 +362,7 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
||||
const result = await this.dataSource.list(shrimpQuery)
|
||||
result.list = await this.prepareResponseItems(result.list)
|
||||
result.list = result.list.map(item => this.filterHidden(item))
|
||||
result.refs = await this.buildRefs(result.list)
|
||||
return result
|
||||
}
|
||||
|
||||
@@ -451,19 +419,9 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
||||
delete shrimpQuery.limit
|
||||
const result = await this.dataSource.list(shrimpQuery)
|
||||
result.list = await this.prepareResponseItems(result.list)
|
||||
// 导出是机器往返的边界:结构化字段(如 tab)用可逆的 stringify 序列化(默认 JSON),
|
||||
// import 端的 reqFilter(parse) 能原样还原;展示用的 _label 不进导出,去掉。
|
||||
const labelFields = this.fields.filter(f => this.getTypeHandler(f)?.resLabel)
|
||||
return result.list.map(item => {
|
||||
const row = this.filterHidden(item)
|
||||
for (const f of labelFields) {
|
||||
if (row[f.key] !== undefined && typeof row[f.key] === "object") {
|
||||
row[f.key] = (f.stringify ?? JSON.stringify)(row[f.key])
|
||||
}
|
||||
delete row[`${f.key}_label`]
|
||||
}
|
||||
return row
|
||||
})
|
||||
// export 只取全量原始数据,不做序列化;结构化字段(如 tab)的字符串化交前端(生成 xlsx 时)。
|
||||
// import 端如传字符串,由各类型 reqFilter(如 tab 的 parse)还原。
|
||||
return result.list.map(item => this.filterHidden(item))
|
||||
}
|
||||
async import(data?: T[], ownerId?: string): Promise<void> {
|
||||
if (!data || data.length === 0) return
|
||||
|
||||
Reference in New Issue
Block a user