Compare commits

..
5 Commits
Author SHA1 Message Date
wc24 eb339ccc49 feat(filter): buildQuery 放行 _id 精确过滤(单项查看/relation 跳转)
filter 原本只认 filterable 字段,_id 会被丢弃。新增: key==='_id' 时始终以 eq 放行,
让 ?filter={_id} 能过滤到单条。_id 是主键精确匹配、用户已有列表权限,无安全顾虑。
2026-06-29 20:40:28 +08:00
wc24 8f9dfd40e0 feat(relation): 用整页 refs 字典替代逐行 _label
list 响应新增 refs: { moduleKey: { id: 显示名 } },整页一次性按模块批量查、去重;
去掉 relation 的 populateItems→${key}_label 逐行注入。前端显示时按 id 查 refs。
tab 的 resLabel/_label 不动(留待复合那步)。这是嵌套引用的地基:collectRefs 以后加
tab 的 children() 下钻即可覆盖任意深度。
2026-06-29 20:17:26 +08:00
wc24 ee35b47f69 revert(tab): 撤回 v0.6.5 嵌套 relation 解析,回到 format 纯展示
populateTabRelations / format 第二参是 tab 专属特例,太狭隘(object/array 同类问题未覆盖),
通用复合解析另当专门事做。嵌套关联名(如商品名)的展示需求改放业务侧(模块重写 list/get)。
框架只保留: format(同步纯展示) + stringify/parse(可逆往返)。
2026-06-29 17:33:52 +08:00
wc24 bc54b475cf feat(tab): format 可拿到子 relation 解析名(批量,无 N+1)
tab 字段的 relation 子字段(如 sellType.goods)原只有 id,format 显示不了关联名。
新增 populateTabRelations:批量(每个关联模块一次 $in via crud.list)解析子 relation 的
labelKey 名,挂到 item.__tabRel[fieldKey][childKey],作为 format 第二参 relLabels 传入;
不污染 tab 本体(避免回灌进库),响应末尾删除 __tabRel。
2026-06-29 16:56:45 +08:00
wc24 4b51d31e9f feat(tab): 拆开展示与序列化 — field.format(展示) vs stringify/parse(可逆往返)
v0.6.3 用同一个 stringify 同时扛表格展示和 export 序列化,二者诉求冲突:
展示要好看可有损,export 要可逆完整。现拆为:
- field.format → _label 展示文本(给人看,可有损),默认 JSON.stringify
- field.stringify/parse → export/import 可逆对(机器往返),默认 JSON
export 改用 stringify(可逆)而非 _label,import 的 parse 能还原。
2026-06-29 16:42:11 +08:00
3 changed files with 50 additions and 24 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "shrimp-server",
"version": "0.6.3",
"version": "0.6.8",
"description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)",
"main": "dist/main/index.js",
"types": "dist/main/index.d.ts",
+5 -2
View File
@@ -278,9 +278,11 @@ export interface IFieldConfig {
rules?: IFieldRule[] // 通用验证规则(前后端共用)
/** tab 类型专用:每个 type 对应的子字段配置 */
tabs?: { key: any; label: ILabel; fields: IFieldConfig[] }[]
/** tab 类型专用:自定义序列化(export 列 / `${key}_label` 用),默认 JSON.stringify */
/** tab 类型专用:展示文本(表格列 `${key}_label`),给人看、可有损好看,默认 JSON.stringify */
format?: (value: any) => string
/** tab 类型专用:export 序列化,须与 parse 可逆(机器往返),默认 JSON.stringify */
stringify?: (value: any) => string
/** tab 类型专用:自定义反序列化(import 还原对象),默认 JSON.parse */
/** tab 类型专用:import 反序列化,须与 stringify 可逆,默认 JSON.parse */
parse?: (text: string) => any
}
@@ -318,6 +320,7 @@ export interface IPageResult<T> {
page: number // 当前页码
pageSize: number // 每页数量
totalPages: number // 总页数
refs?: Record<string, Record<string, any>> // relation 显示名字典: { moduleKey: { id: 显示名 } },前端显示时查名,替代逐行 _label
}
// ============== 数据源查询协议 ==============
+44 -21
View File
@@ -60,8 +60,8 @@ export const defaultTypeHandlers: Record<string, IFieldTypeHandler> = {
}
return value
},
// 本体原样下发对象(不再 stringify);展示文本走 _label
resLabel: (value, field) => (field.stringify ?? JSON.stringify)(value),
// 本体原样下发对象(不再 stringify);展示文本走 _label,用 format(给人看,可有损)
resLabel: (value, field) => (field.format ?? JSON.stringify)(value),
},
}
@@ -230,22 +230,45 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
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)
}
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)
}
return this.processResItem(item)
}
/**
* 顶层 relation 字段批量解析成 refs 字典: { moduleKey: { id: 显示名 } }。
* 整页一次性、按模块各查一次 $in,去重;替代逐行注入 ${key}_label。前端显示时按 id 查名。
*/
private async buildRefs(rows: any[]): Promise<Record<string, Record<string, any>>> {
const relFields = this.getRelationFields()
if (relFields.length === 0 || rows.length === 0) return {}
const buckets = new Map<string, { labelKey: string; ids: Set<string> }>()
for (const row of rows) {
for (const f of relFields) {
const v = row[f.key]
if (v == null) continue
const { moduleKey, labelKey } = f.relation!
let b = buckets.get(moduleKey)
if (!b) buckets.set(moduleKey, (b = { labelKey, ids: new Set() }))
;(Array.isArray(v) ? v : [v]).forEach((id: any) => id != null && b!.ids.add(String(id)))
}
}
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 d of res.list as any[]) dict[String(d._id)] = d[b.labelKey]
}
refs[moduleKey] = dict
}
return refs
}
private excludeKeys(item: any, keys: string[]): any {
if (keys.length === 0) return item
const result = { ...item }
@@ -263,14 +286,6 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
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
@@ -285,6 +300,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
@@ -339,6 +359,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
}
@@ -395,13 +416,15 @@ 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)
// 导出是"给人看"的边界:把带 resLabel 的结构化字段(如 tab)用其字符串文本替换对象本体,
// 列保持可读,且能被 import 的 reqFilter(parse)原样还原;去掉额外的 _label 列。
// 导出是机器往返的边界:结构化字段(如 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}_label`] !== undefined) row[f.key] = row[`${f.key}_label`]
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