Compare commits

...
5 Commits
Author SHA1 Message Date
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
wc24 c264ec6673 feat!: 去掉 json 类型(object 取代) + 版本统一 0.7.0
- object 字段已能声明式表达嵌套结构,freeform 的 json 类型不再需要:
  删 ShrimpFieldTypes.Json + defaultTypeHandlers[Json](reqFilter/resFilter)。
- 源码无任何 type:json 使用,安全移除。
- 前后端版本自此统一:一起推的版本用相同版本号,本批 = 0.7.0。
2026-06-29 22:25:58 +08:00
wc24 f437e2e5e0 feat(composite): 新增 object/array 字段类型(refs 下钻 + 类型常量/配置)
- ShrimpFieldTypes 加 Object/Array
- IFieldConfig 加 fields(object 嵌套字段) + item(array 元素配置,递归)
- collectRefs 重构成 collectOne(单字段+值),加 object(遍历 fields)/array(遍历元素套 item)
  分支 → refs 下钻覆盖 object/array 里的嵌套 relation。
显示/编辑组件在 shrimp-admin。第一版从简:无 min/max、无排序、无递归校验引擎。
2026-06-29 22:21:26 +08:00
5 changed files with 281 additions and 209 deletions
+203 -162
View File
File diff suppressed because it is too large Load Diff
+19 -8
View File
@@ -1,6 +1,6 @@
{ {
"name": "shrimp-server", "name": "shrimp-server",
"version": "0.6.10", "version": "0.7.3",
"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",
@@ -47,5 +55,8 @@
"tsx": "^4.7.0", "tsx": "^4.7.0",
"typescript": "^5.3.0", "typescript": "^5.3.0",
"vitest": "^1.4.0" "vitest": "^1.4.0"
},
"dependencies": {
"shrimp-server": "git+http://git.zeromvc.com/wc24/shrimp-server.git#v0.7.2"
} }
} }
+6 -1
View File
@@ -235,8 +235,9 @@ export const ShrimpFieldTypes = {
Textarea: "textarea" as ShrimpFieldType, Textarea: "textarea" as ShrimpFieldType,
Password: "password" as ShrimpFieldType, Password: "password" as ShrimpFieldType,
Relation: "relation" as ShrimpFieldType, Relation: "relation" as ShrimpFieldType,
Json: "json" as ShrimpFieldType,
Tab: "tab" as ShrimpFieldType, Tab: "tab" as ShrimpFieldType,
Object: "object" as ShrimpFieldType,
Array: "array" as ShrimpFieldType,
} }
/** 字段可编辑状态 */ /** 字段可编辑状态 */
@@ -276,6 +277,10 @@ export interface IFieldConfig {
rules?: IFieldRule[] // 通用验证规则(前后端共用) rules?: IFieldRule[] // 通用验证规则(前后端共用)
/** tab 类型专用:每个 type 对应的子字段配置 */ /** tab 类型专用:每个 type 对应的子字段配置 */
tabs?: { key: any; label: ILabel; fields: IFieldConfig[] }[] tabs?: { key: any; label: ILabel; fields: IFieldConfig[] }[]
/** object 类型专用:嵌套字段组 */
fields?: IFieldConfig[]
/** array 类型专用:每个元素的字段配置(递归 IFieldConfig;元素无需 key,label 用作每项标题) */
item?: IFieldConfig
/** tab 类型专用:import 反序列化(把字符串还原成对象,如 xlsx 导入),默认 JSON.parse */ /** tab 类型专用:import 反序列化(把字符串还原成对象,如 xlsx 导入),默认 JSON.parse */
parse?: (text: string) => any parse?: (text: string) => any
} }
+50 -36
View File
@@ -27,26 +27,6 @@ export const defaultTypeHandlers: Record<string, IFieldTypeHandler> = {
[ShrimpFieldTypes.Boolean]: { [ShrimpFieldTypes.Boolean]: {
defaultValue: false, defaultValue: false,
}, },
[ShrimpFieldTypes.Json]: {
reqFilter: (value) => {
if (value == null || value === "") return undefined
if (typeof value === "string") {
try {
return JSON.parse(value)
} catch {
throw new ShrimpError({ t: 'shrimp.invalidJson' })
}
}
return value
},
resFilter: (value) => {
if (value == null) return value
if (typeof value === "object") {
return JSON.stringify(value)
}
return value
},
},
[ShrimpFieldTypes.Tab]: { [ShrimpFieldTypes.Tab]: {
// tab 是结构化字段:库里/响应/编辑全程是对象,只在"给人看"的边界(import/export/label)走字符串。 // tab 是结构化字段:库里/响应/编辑全程是对象,只在"给人看"的边界(import/export/label)走字符串。
reqFilter: (value, field) => { reqFilter: (value, field) => {
@@ -171,8 +151,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)
@@ -201,8 +180,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)
@@ -212,6 +190,39 @@ 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)
if (err) throw new ShrimpError(this.errWithPath(err, path))
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 []
}
/** 嵌套字段出错时把 path 缀进 message(顶层不缀,已有字段名),让用户知道是哪个嵌套位置 */
private errWithPath(err: ILabel, path: (string | number)[]): ILabel {
if (path.length <= 1 || typeof err !== "object" || err === null) return err
const e = err as any
const tag = `[${path.join(".")}]`
return { ...e, params: { ...e.params, field: e.params?.field != null ? `${e.params.field} ${tag}` : tag } }
}
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) {
@@ -246,7 +257,7 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
b.ids.add(String(id)) b.ids.add(String(id))
} }
for (const row of rows) { for (const row of rows) {
this.collectRefs(this.fields, (k) => row[k], add) for (const f of this.fields) this.collectOne(f, row[f.key], add)
} }
if (buckets.size === 0) return {} if (buckets.size === 0) return {}
const refs: Record<string, Record<string, any>> = {} const refs: Record<string, Record<string, any>> = {}
@@ -263,16 +274,18 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
} }
/** 递归收集 relation 引用:relation 叶子直接收;tab 按 value.type 进选中分支继续下钻(覆盖嵌套/tab套tab) */ /** 递归收集 relation 引用:relation 叶子直接收;tab 按 value.type 进选中分支继续下钻(覆盖嵌套/tab套tab) */
private collectRefs(fields: IFieldConfig[], valueOf: (key: string) => any, add: (moduleKey: string, labelKey: string, id: any) => void): void { /** 单个 (字段,值) 收集 relation 引用,递归复合(tab/object/array)。array 的 item 无 key —— 元素即值 */
for (const f of fields) { private collectOne(f: IFieldConfig, v: any, add: (moduleKey: string, labelKey: string, id: any) => void): void {
const v = valueOf(f.key) if (v == null) return
if (v == null) continue if (f.type === "relation" && f.relation) {
if (f.type === "relation" && f.relation) { ;(Array.isArray(v) ? v : [v]).forEach((id: any) => id != null && add(f.relation!.moduleKey, f.relation!.labelKey, id))
;(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") {
} else if (f.type === ShrimpFieldTypes.Tab && Array.isArray(f.tabs) && typeof v === "object") { const branch = f.tabs.find(t => t.key === v.type)
const branch = f.tabs.find(t => t.key === v.type) if (branch) for (const c of branch.fields) this.collectOne(c, v[c.key], add)
if (branch) this.collectRefs(branch.fields, (k) => v[k], add) } else if (f.type === ShrimpFieldTypes.Object && Array.isArray(f.fields) && typeof v === "object") {
} for (const c of f.fields) this.collectOne(c, v[c.key], add)
} else if (f.type === ShrimpFieldTypes.Array && f.item && Array.isArray(v)) {
for (const el of v) this.collectOne(f.item, el, add)
} }
} }
@@ -286,7 +299,8 @@ 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)])
} }
private buildQuery(query?: IPageQuery & any): IShrimpQuery { private buildQuery(query?: IPageQuery & any): IShrimpQuery {
+3 -2
View File
@@ -107,10 +107,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)