Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
355f808294 | ||
|
|
064bc108d7 | ||
|
|
19afdf3615 | ||
|
|
31b723839e | ||
|
|
1f48a02083 | ||
|
|
0f2b4d6428 | ||
|
|
06aec7f0dc | ||
|
|
172c49816e | ||
|
|
a8cd07f851 | ||
|
|
24afc42de9 | ||
|
|
6383aade98 | ||
|
|
d12877f846 | ||
|
|
c264ec6673 | ||
|
|
f437e2e5e0 | ||
|
|
ad5f7f18f5 | ||
|
|
e04d01a80c | ||
|
|
eb339ccc49 | ||
|
|
8f9dfd40e0 | ||
|
|
ee35b47f69 | ||
|
|
bc54b475cf |
@@ -112,7 +112,7 @@ shrimp 不是铁板一块的协议,它是**一组可选拼装件**。每个件
|
|||||||
|
|
||||||
| 启用前提 | 它的契约 |
|
| 启用前提 | 它的契约 |
|
||||||
|---|---|
|
|---|---|
|
||||||
| **使用 `ShrimpTable`(前端表格组件)** | • list 响应必须是 `IPageResult` = `{ list, total, page, pageSize, totalPages }`<br>• 字段 `type` 必须落在内置枚举:`string` / `number` / `boolean` / `date` / `select` / `textarea` / `password` / `relation` / `json` / `tab` —— 或自行注册 `IFieldTypeHandler`<br>• populate 字段旁挂 `${key}_label`(数组关联挂数组) |
|
| **使用 `ShrimpTable`(前端表格组件)** | • list 响应必须是 `IPageResult` = `{ list, total, page, pageSize, totalPages }`<br>• 字段 `type` 必须落在内置枚举(见下方 §字段类型)—— 或自行注册 `IFieldTypeHandler`<br>• populate 字段旁挂 `${key}_label`(数组关联挂数组) |
|
||||||
| **使用 `buildShrimpRouter` / `ShrimpServer`** | • HTTP 路由形状:`GET /config`、`POST /login`、`GET /me`、`POST /<modulePath>/<event>`<br>• JWT 携带:`Authorization: Bearer <token>`<br>• 后端需实现 `IUserAccessor`(getJwtPayload / isUserActive / getUserRoleIds / isRoleSuperAdmin / getRolePowers / getUserDisplayName) — 见 [src/forExpress/types.ts](src/forExpress/types.ts) |
|
| **使用 `buildShrimpRouter` / `ShrimpServer`** | • HTTP 路由形状:`GET /config`、`POST /login`、`GET /me`、`POST /<modulePath>/<event>`<br>• JWT 携带:`Authorization: Bearer <token>`<br>• 后端需实现 `IUserAccessor`(getJwtPayload / isUserActive / getUserRoleIds / isRoleSuperAdmin / getRolePowers / getUserDisplayName) — 见 [src/forExpress/types.ts](src/forExpress/types.ts) |
|
||||||
| **使用 `MongoShrimp`** | • User/Role/OperationLog 的 mongoose Schema 形状<br>• `onDbConnected` 钩子时序:连接就绪后才能注册需要 DB 的模块 |
|
| **使用 `MongoShrimp`** | • User/Role/OperationLog 的 mongoose Schema 形状<br>• `onDbConnected` 钩子时序:连接就绪后才能注册需要 DB 的模块 |
|
||||||
| **挂 `OperationLogModule`** | • CRUD 动作自动写日志的字段集(operator / module / action / target / time) |
|
| **挂 `OperationLogModule`** | • CRUD 动作自动写日志的字段集(operator / module / action / target / time) |
|
||||||
@@ -248,8 +248,31 @@ export class MyAdmin extends ShrimpServer {
|
|||||||
- `required: true` — 表单必填
|
- `required: true` — 表单必填
|
||||||
- `defaultValue: ...` — 新增时的默认值
|
- `defaultValue: ...` — 新增时的默认值
|
||||||
|
|
||||||
**字段 type 选这些:**
|
### 字段类型
|
||||||
`string` / `number` / `boolean` / `date` / `textarea` / `password` / `select` / `relation` / `json` / `tab`
|
|
||||||
|
内置就这 11 个,以 [src/IShrimpType.ts](src/IShrimpType.ts) 的 `ShrimpFieldTypes` 为准:
|
||||||
|
|
||||||
|
| type | 用途 |
|
||||||
|
|---|---|
|
||||||
|
| `string` | 单行文本 |
|
||||||
|
| `number` | 数字 |
|
||||||
|
| `boolean` | 开关 |
|
||||||
|
| `date` | 日期 |
|
||||||
|
| `textarea` | 多行文本 |
|
||||||
|
| `password` | 密码,列表不回显 |
|
||||||
|
| `select` | 枚举,配 `options: [{label, value}]`(属性名就叫 `options`) |
|
||||||
|
| `relation` | 关联别的模块,配 `relation: {moduleKey, labelKey}`,见 §3 |
|
||||||
|
| `tab` | 分组容器 |
|
||||||
|
| `object` | 嵌套对象,配 `fields: IFieldConfig[]` 描述内部字段 |
|
||||||
|
| `array` | 数组,配 `item: IFieldConfig` 描述元素 |
|
||||||
|
|
||||||
|
字符串数组用 `array` + `item`,不要用 `object`——`object` 要的是 `fields`(一组具名字段),装不下一个同构列表:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
{ key: 'tags', label: '标签', type: 'array', item: { key: '', label: '标签', type: 'string' } }
|
||||||
|
```
|
||||||
|
|
||||||
|
**没有 `json` 这个类型。** 写了它不会报错:前端查不到处理器,静默回落成 `string` 渲染(0.8.2 起控制台留一条 warning)。需要别的形状就自行注册 `IFieldTypeHandler`,别借用不存在的名字。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -287,6 +310,15 @@ const orderFields: IFieldConfig[] = [
|
|||||||
|
|
||||||
`initCrud()` 注册了 5 个标准事件,如果你需要更多,自己加。
|
`initCrud()` 注册了 5 个标准事件,如果你需要更多,自己加。
|
||||||
|
|
||||||
|
**要注册得更少(只读模块):不调 `initCrud()` 就行。** 模块访问权本身就涵盖 `list` / `get`,不需要也不应该手动 `addEvent('list')`——`initCrud()` 加的是 `add` / `edit` / `delete` 这几个写入口:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// 只能看,不能改。前端表格照常出,但没有新增/编辑/删除按钮
|
||||||
|
new ShrimpTableModule(this, 'item', new MongoShrimpCrud(itemModel), itemFields, '物品管理')
|
||||||
|
```
|
||||||
|
|
||||||
|
字段一律配 `editable: 'readonly'` 是另一件事——那管的是表单控件,不管有没有写入口。两个都要做。
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
class OrderTable extends ShrimpTableModule<IOrder> {
|
class OrderTable extends ShrimpTableModule<IOrder> {
|
||||||
constructor(parent, dataSource) {
|
constructor(parent, dataSource) {
|
||||||
|
|||||||
Generated
+294
-398
File diff suppressed because it is too large
Load Diff
+20
-11
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "shrimp-server",
|
"name": "shrimp-server",
|
||||||
"version": "0.6.4",
|
"version": "0.8.1",
|
||||||
"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",
|
||||||
@@ -18,30 +18,39 @@
|
|||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc -p tsconfig.build.json",
|
"build": "tsc -p tsconfig.build.json",
|
||||||
|
"postbuild": "node scripts/check-admin-contract.mjs",
|
||||||
"prepare": "tsc -p tsconfig.build.json",
|
"prepare": "tsc -p tsconfig.build.json",
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
"test:watch": "vitest",
|
"test:watch": "vitest",
|
||||||
"typecheck": "tsc --noEmit"
|
"typecheck": "tsc --noEmit"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"express": "^4 || ^5",
|
"bcrypt": "^5 || ^6",
|
||||||
"mongoose": "^6 || ^7 || ^8",
|
"express": "^5",
|
||||||
"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/express": "^4.17.21",
|
|
||||||
"@types/jsonwebtoken": "^9.0.0",
|
|
||||||
"@types/bcrypt": "^5.0.0",
|
"@types/bcrypt": "^5.0.0",
|
||||||
|
"@types/express": "^5.0.0",
|
||||||
|
"@types/jsonwebtoken": "^9.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": "^5.1.0",
|
||||||
"jsonwebtoken": "^9.0.2",
|
"jsonwebtoken": "^9.0.2",
|
||||||
"mongoose": "^8.0.0",
|
"mongoose": "^8.0.0",
|
||||||
"tsx": "^4.7.0",
|
"tsx": "^4.7.0",
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
/**
|
||||||
|
* build 后把契约同步给同级的 shrimp-admin。
|
||||||
|
*
|
||||||
|
* 契约的真身在这边,shrimp-admin 那份是派生物——所以是单向覆盖,跟 codegen 一个性质,
|
||||||
|
* 不是"两份文件互相对齐"。admin 那份的注释头是它自己的(声明自己是副本),同步时保留。
|
||||||
|
*
|
||||||
|
* 只在本地开发时生效:找不到同级 shrimp-admin(CI、别人只 clone 了这个仓库)就跳过。
|
||||||
|
* 挂在 postbuild 而不是 prepare:消费侧从 git 装本包时跑的是 prepare,不该被这事打扰。
|
||||||
|
*
|
||||||
|
* 为什么要自动做:上次靠人工复制,漂了一整代没人发现——
|
||||||
|
* 副本停在旧的 json 类型、缺 object/array/fields/item/parse/refs,
|
||||||
|
* 而前端对未注册类型静默回落到 string,漂移不报错、只悄悄渲染错。
|
||||||
|
*/
|
||||||
|
import { existsSync } from "node:fs"
|
||||||
|
import { execFileSync } from "node:child_process"
|
||||||
|
import { fileURLToPath } from "node:url"
|
||||||
|
|
||||||
|
const syncer = fileURLToPath(new URL("../../shrimp-admin/scripts/check-contract.mjs", import.meta.url))
|
||||||
|
|
||||||
|
if (!existsSync(syncer)) {
|
||||||
|
console.log("skip: 同级没有 shrimp-admin,契约副本无从同步")
|
||||||
|
process.exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
execFileSync(process.execPath, [syncer, "--fix"], { stdio: "inherit" })
|
||||||
|
} catch {
|
||||||
|
// 同步脚本自己挂了(权限、文件被占)。契约漂着不能当没事发生,让 build 失败。
|
||||||
|
console.error("❌ 契约副本同步失败,见上方输出")
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
+17
-13
@@ -1,12 +1,16 @@
|
|||||||
/**
|
/**
|
||||||
* Shrimp 类型契约 — 前后端 wire protocol 定义
|
* Shrimp 类型契约 — 前后端 wire protocol 定义
|
||||||
*
|
*
|
||||||
* @contractVersion 1.0.0
|
* 这份是契约本身。shrimp-admin/src/IShrimpType.ts 是它的副本,
|
||||||
|
* 由本仓库 postbuild 自动覆盖过去(scripts/check-admin-contract.mjs),不用手工同步。
|
||||||
*
|
*
|
||||||
* 改动此文件需要:
|
* 改动此文件 = 改 wire protocol,所以:
|
||||||
* 1. 升 @contractVersion(语义化版本)
|
* 1. 发版升 package version(0.x 里破坏性改动升 minor),消费侧按 tag 钉包
|
||||||
* 2. 同步到 shrimp-admin/src/IShrimpType.ts,更新其 @syncedFrom
|
* 2. 通知消费侧对齐
|
||||||
* 3. 通知消费侧对齐
|
*
|
||||||
|
* 这里原本另有一个 @contractVersion 轴,删了:它从 1.0.0 起没动过,
|
||||||
|
* 期间契约丢了 json、多了 object/array/fields/item/parse/refs,数字全程说谎。
|
||||||
|
* 副本新不新改由字节比对回答(shrimp-admin 的 npm run check:contract)。
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** 业务错误码 */
|
/** 业务错误码 */
|
||||||
@@ -235,8 +239,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,
|
||||||
}
|
}
|
||||||
|
|
||||||
/** 字段可编辑状态 */
|
/** 字段可编辑状态 */
|
||||||
@@ -248,8 +253,6 @@ export interface IFieldTypeHandler {
|
|||||||
reqFilter?: (value: any, field: IFieldConfig, item: Record<string, any>) => any | Promise<any>
|
reqFilter?: (value: any, field: IFieldConfig, item: Record<string, any>) => any | Promise<any>
|
||||||
/** 响应过滤:数据库取出 → 返回前端前转换(如密码脱敏为 ***、日期格式化) */
|
/** 响应过滤:数据库取出 → 返回前端前转换(如密码脱敏为 ***、日期格式化) */
|
||||||
resFilter?: (value: any, field: IFieldConfig, item: Record<string, any>) => 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} 等) */
|
/** 验证:保存前校验,返回错误 ILabel 或 null(可直接返回字面字符串、{t}、{tc} 等) */
|
||||||
validate?: (value: any, field: IFieldConfig, item: Record<string, any>) => ILabel | null | Promise<ILabel | null>
|
validate?: (value: any, field: IFieldConfig, item: Record<string, any>) => ILabel | null | Promise<ILabel | null>
|
||||||
/** 新增时的默认值(静态值或工厂函数) */
|
/** 新增时的默认值(静态值或工厂函数) */
|
||||||
@@ -278,11 +281,11 @@ 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[] }[]
|
||||||
/** tab 类型专用:展示文本(表格列 `${key}_label`),给人看、可有损好看,默认 JSON.stringify */
|
/** object 类型专用:嵌套字段组 */
|
||||||
format?: (value: any) => string
|
fields?: IFieldConfig[]
|
||||||
/** tab 类型专用:export 序列化,须与 parse 可逆(机器往返),默认 JSON.stringify */
|
/** array 类型专用:每个元素的字段配置(递归 IFieldConfig;元素无需 key,label 用作每项标题) */
|
||||||
stringify?: (value: any) => string
|
item?: IFieldConfig
|
||||||
/** tab 类型专用:import 反序列化,须与 stringify 可逆,默认 JSON.parse */
|
/** tab 类型专用:import 反序列化(把字符串还原成对象,如 xlsx 导入),默认 JSON.parse */
|
||||||
parse?: (text: string) => any
|
parse?: (text: string) => any
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -320,6 +323,7 @@ export interface IPageResult<T> {
|
|||||||
page: number // 当前页码
|
page: number // 当前页码
|
||||||
pageSize: number // 每页数量
|
pageSize: number // 每页数量
|
||||||
totalPages: number // 总页数
|
totalPages: number // 总页数
|
||||||
|
refs?: Record<string, Record<string, any>> // relation 显示名字典: { moduleKey: { id: 显示名 } },前端显示时查名,替代逐行 _label
|
||||||
}
|
}
|
||||||
|
|
||||||
// ============== 数据源查询协议 ==============
|
// ============== 数据源查询协议 ==============
|
||||||
|
|||||||
+121
-63
@@ -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) => {
|
||||||
@@ -60,8 +40,6 @@ export const defaultTypeHandlers: Record<string, IFieldTypeHandler> = {
|
|||||||
}
|
}
|
||||||
return value
|
return value
|
||||||
},
|
},
|
||||||
// 本体原样下发对象(不再 stringify);展示文本走 _label,用 format(给人看,可有损)
|
|
||||||
resLabel: (value, field) => (field.format ?? JSON.stringify)(value),
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,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 } }
|
||||||
@@ -173,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)
|
||||||
@@ -203,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)
|
||||||
@@ -214,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) {
|
||||||
@@ -221,31 +244,66 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
|||||||
if (handler?.resFilter && result[field.key] !== undefined) {
|
if (handler?.resFilter && result[field.key] !== undefined) {
|
||||||
result[field.key] = await handler.resFilter(result[field.key], field, result)
|
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)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
private async prepareResponseItems(items: any[]): Promise<any[]> {
|
private async prepareResponseItems(items: any[]): Promise<any[]> {
|
||||||
if (items.length === 0) return items
|
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)))
|
return Promise.all(items.map(item => this.processResItem(item)))
|
||||||
}
|
}
|
||||||
|
|
||||||
private async prepareResponseItem(item: any): Promise<any> {
|
private async prepareResponseItem(item: any): Promise<any> {
|
||||||
if (!item) return item
|
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)
|
return this.processResItem(item)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* relation 字段(含 tab 分支里的嵌套 relation)批量解析成 refs 字典: { moduleKey: { id: 显示名 } }。
|
||||||
|
* 整页一次性、按模块各查一次 $in,去重;替代逐行注入 ${key}_label。前端显示时按 id 查名。
|
||||||
|
*/
|
||||||
|
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))
|
||||||
|
}
|
||||||
|
for (const row of rows) {
|
||||||
|
for (const f of this.fields) this.collectOne(f, row[f.key], 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 d of res.list as any[]) dict[String(d._id)] = d[b.labelKey]
|
||||||
|
}
|
||||||
|
refs[moduleKey] = dict
|
||||||
|
}
|
||||||
|
return refs
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 递归收集 relation 引用:relation 叶子直接收;tab 按 value.type 进选中分支继续下钻(覆盖嵌套/tab套tab) */
|
||||||
|
/** 单个 (字段,值) 收集 relation 引用,递归复合(tab/object/array)。array 的 item 无 key —— 元素即值 */
|
||||||
|
private collectOne(f: IFieldConfig, v: any, add: (moduleKey: string, labelKey: string, id: any) => void): void {
|
||||||
|
if (v == null) return
|
||||||
|
if (f.type === "relation" && f.relation) {
|
||||||
|
// 跳过空串:可选 Relation 常存 "",混进 { _id: { $in } } 会让 Mongoose 转 ObjectId 抛 CastError、整页 500。
|
||||||
|
;(Array.isArray(v) ? v : [v]).forEach((id: any) => id != null && id !== "" && 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) for (const c of branch.fields) this.collectOne(c, v[c.key], 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private excludeKeys(item: any, keys: string[]): any {
|
private excludeKeys(item: any, keys: string[]): any {
|
||||||
if (keys.length === 0) return item
|
if (keys.length === 0) return item
|
||||||
const result = { ...item }
|
const result = { ...item }
|
||||||
@@ -256,19 +314,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)])
|
||||||
}
|
}
|
||||||
|
|
||||||
private getRelationFields(): IFieldConfig[] {
|
/** 递归收集标了 filterable 的字段 → 点路径(object 子 / tab 分支子)。array 暂不下钻(后续) */
|
||||||
return this.fields.filter(f => f.type === "relation" && f.relation)
|
private collectFilterablePaths(fields: IFieldConfig[], base: string[], out: Map<string, IFieldConfig>): void {
|
||||||
}
|
for (const f of fields) {
|
||||||
|
const path = [...base, f.key]
|
||||||
private getRelationPopulates(): IShrimpPopulate[] {
|
if (f.filterable) out.set(path.join("."), f)
|
||||||
return this.getRelationFields().map(f => ({
|
if (f.type === ShrimpFieldTypes.Tab && Array.isArray(f.tabs)) {
|
||||||
key: f.key,
|
for (const t of f.tabs) this.collectFilterablePaths(t.fields, path, out)
|
||||||
moduleKey: f.relation!.moduleKey,
|
} else if (f.type === ShrimpFieldTypes.Object && Array.isArray(f.fields)) {
|
||||||
labelKey: f.relation!.labelKey,
|
this.collectFilterablePaths(f.fields, path, out)
|
||||||
}))
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private buildQuery(query?: IPageQuery & any): IShrimpQuery {
|
private buildQuery(query?: IPageQuery & any): IShrimpQuery {
|
||||||
@@ -281,10 +341,17 @@ 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)) {
|
||||||
|
// _id 始终放行精确过滤(单项查看/relation 跳转用),无需配 filterable
|
||||||
|
if (key === '_id') {
|
||||||
|
if (value != null && value !== '') where['_id'] = { eq: value }
|
||||||
|
continue
|
||||||
|
}
|
||||||
const field = filterableFields.get(key)
|
const field = filterableFields.get(key)
|
||||||
if (!field) continue
|
if (!field) continue
|
||||||
if (value == null) continue
|
if (value == null) continue
|
||||||
@@ -339,6 +406,7 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
|||||||
const result = await this.dataSource.list(shrimpQuery)
|
const result = await this.dataSource.list(shrimpQuery)
|
||||||
result.list = await this.prepareResponseItems(result.list)
|
result.list = await this.prepareResponseItems(result.list)
|
||||||
result.list = result.list.map(item => this.filterHidden(item))
|
result.list = result.list.map(item => this.filterHidden(item))
|
||||||
|
result.refs = await this.buildRefs(result.list)
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -395,19 +463,9 @@ export class ShrimpTableModule<T, P extends ITableCrudProto<T> = ITableCrudProto
|
|||||||
delete shrimpQuery.limit
|
delete shrimpQuery.limit
|
||||||
const result = await this.dataSource.list(shrimpQuery)
|
const result = await this.dataSource.list(shrimpQuery)
|
||||||
result.list = await this.prepareResponseItems(result.list)
|
result.list = await this.prepareResponseItems(result.list)
|
||||||
// 导出是机器往返的边界:结构化字段(如 tab)用可逆的 stringify 序列化(默认 JSON),
|
// export 只取全量原始数据,不做序列化;结构化字段(如 tab)的字符串化交前端(生成 xlsx 时)。
|
||||||
// import 端的 reqFilter(parse) 能原样还原;展示用的 _label 不进导出,去掉。
|
// import 端如传字符串,由各类型 reqFilter(如 tab 的 parse)还原。
|
||||||
const labelFields = this.fields.filter(f => this.getTypeHandler(f)?.resLabel)
|
return result.list.map(item => this.filterHidden(item))
|
||||||
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
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
async import(data?: T[], ownerId?: string): Promise<void> {
|
async import(data?: T[], ownerId?: string): Promise<void> {
|
||||||
if (!data || data.length === 0) return
|
if (!data || data.length === 0) return
|
||||||
|
|||||||
@@ -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)
|
||||||
|
|||||||
@@ -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]: "促销" })
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in New Issue
Block a user