Cursor rule

1---
2description: NestJS 后端（@apps/server）模块、鉴权、接口与库表部署约定
3globs: apps/server/**/*.{ts,yml,yaml,sql,md}
4alwaysApply: false
5---
6 
7# Server（NestJS）
8 
9## 结构
10 
11- 业务按 **Nest 模块** 划分：`src/modules/<domain>/`（controller、service、dto、entities 等）。
12- 模块域：`system/*`（用户/角色/菜单/部门等）、`monitor/*`（日志/缓存/服务器）、`upload`、`tasks`、`area` 等；新功能按域建 module。
13- 全局能力在 `src/common/`（守卫、过滤器、装饰器、工具）、`src/plugins/`、`src/config/`。
14- **通用能力放 `src/plugins/`**：OCR（`OcrModule`）、VLM（`VlmModule`）、HTTP/MQTT/邮件等；通过 `PluginsModule` 导出，业务模块 `imports: [PluginsModule]` 注入使用。
15- **业务模块只保留领域逻辑**：prompt、DTO/校验、编排流程、错误码到用户文案的映射；不要把 OCR/VLM 厂商 SDK、chat/completions 请求等通用实现写进 `modules/`。
16- 数据库：**TypeORM**；迁移在 `src/migrations/`，通过 `migration:*` 脚本执行；空库初始化脚本为 `db/init.sql`。
17- **Entity 关联约定（逻辑外键）**：表之间关联在 Entity / 库表上只存 `xxxId` 列（如 `userId`），**不使用** `@ManyToOne` / `@OneToMany` / `@JoinColumn`，也**不建库级 FOREIGN KEY / ON DELETE CASCADE**。完整性由应用层保证（写入时用登录态 `userId`、查询带归属过滤、软删不硬删父行）。需要联表时在 Service 用 `leftJoinAndMapOne` / QueryBuilder。与现有 `sys_user.dept_id`、`sys_user_role` 等风格一致。
18- 配置：`src/config/dev.yml` / `prod.yml` + `typeorm.config.ts`。
19 
20## 库表部署约定（init.sql ↔ migration）
21 
22两套产物分工不同，**禁止只改其一**：
23 
24| 产物 | 路径 | 用途 |
25|------|------|------|
26| 空库初始化 | `db/init.sql` | **全新环境**一次性建表 + 种子数据 |
27| 增量迁移 | `src/migrations/*.ts` | **已有库**升级结构（加列/加表/改索引） |
28 
29### 新功能改表时（时机 + 必做）
30 
31**一个业务功能尽量只对应一条 migration**，禁止「每改一次 Entity / 每轮对话就新建一条」。
32 
33| 阶段 | Agent / 开发做法 |
34|------|------------------|
35| **功能开发中**（表结构还可能再改） | 只改 Entity（及业务代码）与必要时同步 `init.sql` 终态构思；**禁止**新建 `src/migrations/*.ts` |
36| **功能收口** | 在回复中**先询问**用户是否现在生成迁移；**仅当用户明确同意**（如「生成迁移」「可以 generate」）后，才执行 `migration:generate` / 手写一条 migration，并同步 `init.sql` 终态 |
37| **已上线库的事后补丁** | 上一版 migration 已在测服/生产执行过 → 只能再加**新的一条**补丁迁移，禁止改已执行文件；同样须先征得用户同意再落文件 |
38 
39**Agent 硬性约束**：未经用户明确同意，**禁止**创建、生成或提交任何 `src/migrations/*.ts` 文件（含「审查落地」「顺手补一条」）。计划 to-do / 收口步骤里若含 migration，也只允许「提醒用户确认」，不得自行落盘。
40 
41收口且用户同意后必做：
42 
431. 确认 Entity 已是本功能最终结构（`synchronize` 保持 `false`）。
442. **生成或补全一条** migration（优先 `pnpm migration:generate`，纯数据迁移等再用 `migration:create` 手写）。
453. **同步把迁移「跑完后的终态」写进 `init.sql`**（最终列、索引；不要写中间态；**不要**新增库级外键）。
464. 种子 `INSERT` 若依赖列顺序，加列后必须改对应 `VALUES`。
47 
48### 部署场景
49 
50| 场景 | 做法 |
51|------|------|
52| **全新环境** | 只导入更新后的 `init.sql` 即可对齐当前代码结构 |
53| **已有环境（测服/生产）** | 执行 `pnpm migration:run` 或 `migration:run:prod`；**禁止**用新 init 覆盖冲库 |
54| **只导了旧 init、没跑迁移** | 会出现「实体有字段、库无列」（如缺 `login_type`）→ 对该库补跑 migration |
55 
56### 禁止与注意
57 
58- 不要假设「有 migration 就不用改 init」——新环境若只导 init 会缺表/缺列。
59- 不要手改已在生产执行过的 migration；修缺陷用**新迁移**。
60- 新表/改表统一用逻辑外键（只存关联 ID），与全库风格一致。
61- 功能未收口前**禁止**为中间态（加了又删、改了又改）连续堆 migration 文件。
62- 详细 migration 命令见 `src/migrations/README.md`。
63 
64### 新业务表对照样板（`sys_dept`）
65 
66新建业务 Entity / 表时对照 [`dept.entity.ts`](apps/server/src/modules/system/dept/entities/dept.entity.ts)，清单如下：
67 
681. `@Entity("snake_table", { comment: "..." })`，表名 `snake_case`（业务表可用域前缀，如 `salary_*`；系统表用 `sys_*`）。
692. `extends BaseEntity`（日志、上传流水、纯关联表除外）。
703. 主键：`@PrimaryGeneratedColumn({ type: "int", name: "<域>_id", comment: "..." })`（如 `dept_id`），避免无业务含义的裸 `id`（存量例外勿为统一而强改）。
714. 每列显式 `name: "snake_case"` + `comment`；禁止地理表那种 camelCase 列名、禁止库级 FK。
725. 受限取值优先 `type: "enum"` + 共享/模块 enum；金额用 `decimal(p,s)`。
736. 唯一约束在 Entity 用 `@Index(..., { unique: true })`，并与 `init.sql` / migration 同名同步（如 `UQ_sys_user_openid`）。
747. **二级索引按需**：有慢查询或明确高频过滤再加（候选见下）；禁止「为审查清单盲加」。
75 
76### 二级索引（按需，勿盲加）
77 
78全库默认几乎只有 PK / UNIQUE。数据量上来后再考虑。审查已落地的逻辑外键/反向列索引（与 Entity `@Index`、`init.sql` 同步）：
79 
80- `idx_sys_user_dept_id`、`idx_sys_menu_parent_id`、`idx_sys_dept_parent_id`
81- `idx_sys_user_role_role_id`、`idx_sys_user_post_post_id`、`idx_sys_role_menu_menu_id`、`idx_sys_role_dept_dept_id`
82- `idx_salary_verify_history_user_list`（`user_id, del_flag, history_type`）
83 
84其余索引仍须有慢查询或明确高频过滤再加。加索引时：Entity `@Index` + **一条** migration（须用户确认）+ `init.sql` 终态同步。
85 
86### 薪资历史软删语义
87 
88`salary_verify_history`：同用户同月（verify）仅一条业务记录。软删后再次 upsert **复活**原行（`findVerifyHistory` 不按 `del_flag` 过滤，更新时置回 `NORMAL`）。唯一键不含 `del_flag`；勿改成「软删后可再插第二行」除非同步改唯一约束。列表/展示时间用 BaseEntity 的 `update_time`（API `updateTime`），**不要**再加 `saved_at`。
89 
90## 注释约定
91 
92遵循全仓 **`comment-standards.mdc`**。Server 侧额外强调：
93 
94- 注释**非显而易见**的设计：懒加载/并发、坐标排版算法、plugins 与业务的边界、错误码映射、配置键含义。
95- 不写复述代码的注释（如「调用 recognize 方法」）；已有 JSDoc 的工具函数不再重复。
96- plugins 类/对外方法用简短 JSDoc；业务 `Service.recognize` 等主流程用步骤注释（`// 1. OCR`）标清编排顺序。
97 
98## 鉴权
99 
100- 全局 **`JwtAuthGuard`**（`common/guards/auth.guard.ts`），在 `app.module.ts` 注册。
101- 取当前用户：**`@GetRequestUser("user")`**；角色元数据：**`@RequireRole()`**。
102- 需登录接口加 **`@ApiBearerAuth()`**。
103 
104## 控制器与文档
105 
106- 使用 `@ApiTags`、`@ApiOperation`。
107- 接口方法约定：**获取数据只用 `@Get`**，**修改数据只用 `@Post`**（包含创建、更新、删除、状态变更等写操作）。
108- 为保持接口风格统一，默认不使用 `@Delete`、`@Put`、`@Patch`。
109- 路由命名语义与方法保持一致：查询类如 `/list`、`/:id` 使用 `GET`；写操作如 `/create`、`/update`、`/delete/:id` 使用 `POST`。
110- DTO 用 **class-validator / class-transformer**；全局 `ValidationPipe`（whitelist、transform），DTO 字段需装饰器才进白名单。
111- 统一响应：**`@ApiResult()`** 等装饰器（见 `src/common/decorator`）。
112- Swagger：`main.ts` 配置；开发环境可导出 `swagger.json` 供 admin 生成类型。
113 
114## 与 admin 协作
115 
116- 接口路径与 admin `src/api/**` 的 url 保持一致（如 `/system/user/list`）。
117- 复杂查询与事务放在 **Service**，Controller 保持薄层。
118 
119## 代码风格
120 
121- TypeScript 严格模式；字符串引号与格式以仓库 ESLint/Prettier 为准（当前多为双引号）。
122 
123## 日期与公共能力
124 
125- 服务端日期处理统一使用 **day.js**（通过 `@llcz/common` 的 `dateUtil`/相关工具），避免在业务模块重复实现原生 `Date` 逻辑。
126- 涉及持久化时间字段、调度时间计算、对外时间格式化时，优先复用 `@llcz/common`，不要在模块内重复造轮子。
127- 非日历语义场景（耗时统计、traceId、缓存戳）允许使用 `Date.now()`。
128 
129## 示例
130 
131```typescript
132@ApiTags("systemDept")
133@ApiBearerAuth()
134@Controller("system/dept")
135export class DeptController {
136  @ApiOperation({ summary: "部门管理-创建" })
137  @ApiResult()
138  @Post("/create")
139  create(@Body() dto: CreateDeptDto, @GetRequestUser("user") user: RequestUserPayload["user"]) {
140    return this.deptService.create(dto, user.userId);
141  }
142}
143```
144