Compare commits

...
9 Commits
Author SHA1 Message Date
wc24 31b723839e fix(populate): 跳过空串关联 id,避免可选 Relation 存 "" 时 $in 转 ObjectId 抛 CastError 整页 500
bump 0.7.11
2026-07-29 14:56:43 +08:00
wc24 1f48a02083 test+chore: 修 stale 测试(_label→refs 新契约)+ bump 0.7.10
crudRegistry.test 还在断言已退场的 tagIds_label,改断言整页 refs 字典。
两端版本归一到 0.7.10。
2026-06-30 17:47:08 +08:00
wc24 0f2b4d6428 fix(pkg): 删掉 shrimp-server 对自身的 git 依赖(致 npm install OOM)
dependencies 误列了 shrimp-server 自引用(#v0.7.4)→ arborist 顺着自引用无限解析
依赖树、堆爆 OOM。真正依赖全在 peerDependencies,该块整体删除。含 0.7.6 的
isEmptyValue 递归判空。
2026-06-30 17:22:39 +08:00
wc24 06aec7f0dc feat(required): 按类型递归判定空(tab/object/array 各自语义)
isEmptyValue(field,value) 递归: tab=没选type / object=所有子字段都空 / array=无元素或
所有元素都空(多维递归) / 标量=null|''/空数组(0、false 不算空)。required=!isEmpty 自动
对所有类型生效。validateNode: 空的复合(非必填)不下钻校验子(整个结构缺席)。
2026-06-30 16:52:08 +08:00
wc24 172c49816e feat(filter): 嵌套 filterable 叶子 → 点路径过滤(object/tab)
collectFilterablePaths 递归收集标了 filterable 的字段(object 子/tab 分支子)连同点路径;
buildQuery 白名单从顶层字段扩成路径(点路径本就是 mongoose 嵌套查询,翻译逻辑不变)。
array 下钻、tab 判别值过滤留后续。
2026-06-30 16:01:20 +08:00
wc24 a8cd07f851 fix(validate): 错误信息不再拼开发用的 [path],回归干净字段名+i18n
校验错只发 {t:i18nKey, params:{field:label}}(不能为空走语言包 key、字段名走 label),
不把 groups.0.title 这种路径塞进可见文案。path 仍递归传递,留给将来 inline 标红结构化携带。
2026-06-30 15:17:58 +08:00
wc24 24afc42de9 feat(validate): 递归校验引擎(校验下沉到任意深度)
childrenOf(field,value): tab 选中分支 fields / object fields / array 元素套 item → 子(字段,值)对。
validateNode 递归: 每节点跑 validateField,出错即抛(带 path),再下钻复合。
接入 prepareAddItem/prepareEditItem(替原顶层 validateField)。第一版 fail-fast,
嵌套错 message 缀 [path] 定位。默认/transform 下沉、collect-all、inline 标红留后续。
2026-06-30 14:49:48 +08:00
wc24 6383aade98 fix(crud): 响应统一剥掉 mongoose 版本键 __v
filterHidden 出口加剥 __v(连同 hidden 字段),list/get/add/edit 全覆盖。
前端无用的 __v 不再下发。
2026-06-30 14:09:44 +08:00
wc24 d12877f846 fix(crud): add/edit 返回普通对象(toObject/lean),不再抖出 mongoose Document 内部
add 用 create 返回 Document、edit 用 findByIdAndUpdate 返回 Document,下游 processResItem
的 {...item} 会把 $__/_doc/$isNew 等内部属性展开、真数据埋进 _doc。改:add 转 toObject、
edit 加 .lean()(与 list/get 一致)。响应回归干净 POJO。
2026-06-30 14:06:40 +08:00
5 changed files with 298 additions and 182 deletions
+206 -162
View File
File diff suppressed because it is too large Load Diff
+16 -8
View File
@@ -1,6 +1,6 @@
{ {
"name": "shrimp-server", "name": "shrimp-server",
"version": "0.7.0", "version": "0.7.11",
"description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)", "description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)",
"main": "dist/main/index.js", "main": "dist/main/index.js",
"types": "dist/main/index.d.ts", "types": "dist/main/index.d.ts",
@@ -24,21 +24,29 @@
"typecheck": "tsc --noEmit" "typecheck": "tsc --noEmit"
}, },
"peerDependencies": { "peerDependencies": {
"bcrypt": "^5 || ^6",
"express": "^4 || ^5", "express": "^4 || ^5",
"mongoose": "^6 || ^7 || ^8",
"jsonwebtoken": "^8 || ^9", "jsonwebtoken": "^8 || ^9",
"bcrypt": "^5 || ^6" "mongoose": "^6 || ^7 || ^8"
}, },
"peerDependenciesMeta": { "peerDependenciesMeta": {
"express": { "optional": true }, "express": {
"mongoose": { "optional": true }, "optional": true
"jsonwebtoken": { "optional": true }, },
"bcrypt": { "optional": true } "mongoose": {
"optional": true
},
"jsonwebtoken": {
"optional": true
},
"bcrypt": {
"optional": true
}
}, },
"devDependencies": { "devDependencies": {
"@types/bcrypt": "^5.0.0",
"@types/express": "^4.17.21", "@types/express": "^4.17.21",
"@types/jsonwebtoken": "^9.0.0", "@types/jsonwebtoken": "^9.0.0",
"@types/bcrypt": "^5.0.0",
"@types/node": "^20.0.0", "@types/node": "^20.0.0",
"bcrypt": "^5.1.1", "bcrypt": "^5.1.1",
"express": "^4.19.0", "express": "^4.19.0",
+68 -7
View File
@@ -68,9 +68,27 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
return ShrimpTableModule.typeHandlers.get(field.type) return ShrimpTableModule.typeHandlers.get(field.type)
} }
/** 按类型递归判定"空":tab=没选type / object=所有子字段都空 / array=无元素或所有元素都空(多维递归)/ 标量=null|'' / 空数组 */
private isEmptyValue(field: IFieldConfig, value: any): boolean {
if (value === undefined || value === null) return true
switch (field.type) {
case ShrimpFieldTypes.Tab:
return typeof value !== "object" || value.type == null
case ShrimpFieldTypes.Object:
if (typeof value !== "object" || !Array.isArray(field.fields)) return true
return field.fields.every(f => this.isEmptyValue(f, value[f.key]))
case ShrimpFieldTypes.Array:
if (!Array.isArray(value) || value.length === 0) return true
return field.item ? value.every(el => this.isEmptyValue(field.item!, el)) : false
default:
// 标量/relation/select:'' 或空数组(multiple)算空;0、false 不算空
return value === "" || (Array.isArray(value) && value.length === 0)
}
}
/** 前置验证 */ /** 前置验证 */
private async validateField(field: IFieldConfig, value: any, item: Record<string, any>): Promise<ILabel | null> { private async validateField(field: IFieldConfig, value: any, item: Record<string, any>): Promise<ILabel | null> {
const isEmpty = value === undefined || value === null || value === '' || (Array.isArray(value) && value.length === 0) const isEmpty = this.isEmptyValue(field, value)
if (field.required && isEmpty) { if (field.required && isEmpty) {
return field.rules?.find(r => r.required)?.message || { t: 'shrimp.fieldRequired', params: { field: field.label } } return field.rules?.find(r => r.required)?.message || { t: 'shrimp.fieldRequired', params: { field: field.label } }
@@ -151,8 +169,7 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
result[field.key] = await handler.reqFilter(result[field.key], field, result) result[field.key] = await handler.reqFilter(result[field.key], field, result)
} }
const fieldErr = await this.validateField(field, result[field.key], result) await this.validateNode(field, result[field.key], [field.key], result)
if (fieldErr) throw new ShrimpError(fieldErr)
if (handler?.validate && result[field.key] !== undefined) { if (handler?.validate && result[field.key] !== undefined) {
const err = await handler.validate(result[field.key], field, result) const err = await handler.validate(result[field.key], field, result)
@@ -181,8 +198,7 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
result[field.key] = await handler.reqFilter(result[field.key], field, result) result[field.key] = await handler.reqFilter(result[field.key], field, result)
} }
const fieldErr = await this.validateField(field, result[field.key], result) await this.validateNode(field, result[field.key], [field.key], result)
if (fieldErr) throw new ShrimpError(fieldErr)
if (handler?.validate) { if (handler?.validate) {
const err = await handler.validate(result[field.key], field, result) const err = await handler.validate(result[field.key], field, result)
@@ -192,6 +208,35 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
return result return result
} }
/** 递归校验:本节点 validateField,出错即抛(带 path);再下钻复合(tab/object/array)子节点。第一版 fail-fast */
private async validateNode(field: IFieldConfig, value: any, path: (string | number)[], rootItem: Record<string, any>): Promise<void> {
const err = await this.validateField(field, value, rootItem)
// 出错只发字段名(label) + i18n key 的 message,不把开发用的 path 拼进可见文案。
// path 仍递归往下传(供将来 inline 标红按结构化方式携带,不在这里塞进 message)。
if (err) throw new ShrimpError(err)
// 空的复合(走到这必是非必填)→ 不下钻校验子:整个结构缺席,里面的 required 不该触发
if (this.isEmptyValue(field, value)) return
for (const child of this.childrenOf(field, value)) {
await this.validateNode(child.field, child.value, [...path, child.key], rootItem)
}
}
/** 复合类型吐出子 (字段, 值) 对:tab 选中分支的 fields / object 的 fields / array 每个元素套 item。叶子或空 → [] */
private childrenOf(field: IFieldConfig, value: any): { key: string | number; field: IFieldConfig; value: any }[] {
if (value == null || typeof value !== "object") return []
if (field.type === ShrimpFieldTypes.Tab && Array.isArray(field.tabs)) {
const branch = field.tabs.find(t => t.key === value.type)
return branch ? branch.fields.map(f => ({ key: f.key, field: f, value: value[f.key] })) : []
}
if (field.type === ShrimpFieldTypes.Object && Array.isArray(field.fields)) {
return field.fields.map(f => ({ key: f.key, field: f, value: value[f.key] }))
}
if (field.type === ShrimpFieldTypes.Array && field.item && Array.isArray(value)) {
return value.map((el, i) => ({ key: i as number, field: field.item!, value: el }))
}
return []
}
private async processResItem(item: Record<string, any>): Promise<Record<string, any>> { private async processResItem(item: Record<string, any>): Promise<Record<string, any>> {
const result = { ...item } const result = { ...item }
for (const field of this.fields) { for (const field of this.fields) {
@@ -268,7 +313,21 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
} }
private filterHidden(item: any): any { private filterHidden(item: any): any {
return this.excludeKeys(item, this.fields.filter(f => f.hidden).map(f => f.key)) // __v 是 mongoose 版本键,前端无用,统一剥掉(连同 hidden 字段)
return this.excludeKeys(item, ["__v", ...this.fields.filter(f => f.hidden).map(f => f.key)])
}
/** 递归收集标了 filterable 的字段 → 点路径(object 子 / tab 分支子)。array 暂不下钻(后续) */
private collectFilterablePaths(fields: IFieldConfig[], base: string[], out: Map<string, IFieldConfig>): void {
for (const f of fields) {
const path = [...base, f.key]
if (f.filterable) out.set(path.join("."), f)
if (f.type === ShrimpFieldTypes.Tab && Array.isArray(f.tabs)) {
for (const t of f.tabs) this.collectFilterablePaths(t.fields, path, out)
} else if (f.type === ShrimpFieldTypes.Object && Array.isArray(f.fields)) {
this.collectFilterablePaths(f.fields, path, out)
}
}
} }
private buildQuery(query?: IPageQuery & any): IShrimpQuery { private buildQuery(query?: IPageQuery & any): IShrimpQuery {
@@ -281,7 +340,9 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
} }
if (filter && typeof filter === 'object') { if (filter && typeof filter === 'object') {
const filterableFields = new Map(this.fields.filter(f => f.filterable).map(f => [f.key, f])) // filterable 路径(含 object/tab 嵌套叶子,点路径如 condition.level)→ 白名单。点路径本就是 mongoose 嵌套查询,翻译逻辑不变
const filterableFields = new Map<string, IFieldConfig>()
this.collectFilterablePaths(this.fields, [], filterableFields)
const stringLikeTypes = new Set(['string', 'textarea']) const stringLikeTypes = new Set(['string', 'textarea'])
const where: Record<string, IShrimpCondition> = {} const where: Record<string, IShrimpCondition> = {}
for (const [key, value] of Object.entries(filter)) { for (const [key, value] of Object.entries(filter)) {
+6 -4
View File
@@ -79,9 +79,10 @@ export class MongoShrimpCrud<T> implements ShrimpCrud<T> {
const allRefIds = new Set<string>() const allRefIds = new Set<string>()
for (const item of items) { for (const item of items) {
const val = (item as any)[pop.key] const val = (item as any)[pop.key]
// 跳过空串:可选 Relation 常存 "",混进 { _id: { $in } } 会让 Mongoose 转 ObjectId 抛 CastError、整页 500。
if (Array.isArray(val)) { if (Array.isArray(val)) {
val.forEach((id: any) => { if (id != null) allRefIds.add(String(id)) }) val.forEach((id: any) => { if (id != null && id !== "") allRefIds.add(String(id)) })
} else if (val != null) { } else if (val != null && val !== "") {
allRefIds.add(String(val)) allRefIds.add(String(val))
} }
} }
@@ -107,10 +108,11 @@ export class MongoShrimpCrud<T> implements ShrimpCrud<T> {
return await this.model.findById(id).lean() as T | null return await this.model.findById(id).lean() as T | null
} }
async add(item: Omit<T, '_id'>): Promise<T> { async add(item: Omit<T, '_id'>): Promise<T> {
return await this.model.create(item) const doc = await this.model.create(item)
return doc.toObject() as T // 转普通对象,否则下游 {...item} 展开的是 mongoose Document 内部($__/_doc/$isNew)
} }
async edit(id: string, item: Partial<T>): Promise<T | null> { async edit(id: string, item: Partial<T>): Promise<T | null> {
return await this.model.findByIdAndUpdate(id, item, { new: true }) return await this.model.findByIdAndUpdate(id, item, { new: true }).lean() as T | null
} }
async delete(id: string): Promise<boolean> { async delete(id: string): Promise<boolean> {
const result = await this.model.findByIdAndDelete(id) const result = await this.model.findByIdAndDelete(id)
+2 -1
View File
@@ -34,6 +34,7 @@ describe("crudRegistry 自动登记", () => {
await productCrud.add({ code: "P001", tagIds: [t1._id, t2._id] } as any) await productCrud.add({ code: "P001", tagIds: [t1._id, t2._id] } as any)
const result = await productModule.list({}) const result = await productModule.list({})
expect((result.list[0] as any).tagIds_label).toEqual(["热门", "促销"]) // _label 逐行机制已退场:relation 显示名走整页 refs 字典(refs[moduleKey][id])
expect((result as any).refs?.tag).toEqual({ [t1._id]: "热门", [t2._id]: "促销" })
}) })
}) })