# Story 005.012: Merchant Module

## Status
Ready for Review

## Story

**As a** 小程序开发者，
**I want** 将商户管理模块从 packages/server/src 拆分到主项目的 packages 目录下作为独立 package，
**so that** 项目可以按需引入商户管理功能，保持模块独立性和向后兼容性

## Acceptance Criteria

1. 创建 `@d8d/merchant-module` package，包含完整的商户管理功能
2. 从 packages/server/src/modules/merchant 迁移商户服务代码
3. 实现商户的完整CRUD功能，包括商户登录统计、状态管理等
4. 提供完整的 TypeScript 类型定义和 API 文档
5. 集成到现有的认证系统和用户管理系统
6. 保持与现有认证系统的兼容性
7. 提供单元测试和集成测试，覆盖率满足要求
8. 更新 server package 依赖关系，支持按需引入

## Tasks / Subtasks

- [x] Task 1: 创建 merchant-module package 基础结构 (AC: 1)
  - [x] 创建 packages/merchant-module 目录结构
  - [x] 配置 package.json，参考广告模块的依赖版本 [Source: packages/advertisements-module/package.json#L47-L66]
  - [x] 配置 tsconfig.json，参考广告模块配置 [Source: packages/advertisements-module/tsconfig.json#L1-L16]
  - [x] 配置 vitest.config.ts，参考广告模块配置 [Source: packages/advertisements-module/vitest.config.ts#L1-L21]
  - [x] 创建 src/index.ts 导出文件

- [x] Task 2: 迁移商户实体和类型定义 (AC: 2, 4)
  - [x] 迁移 Merchant 实体到 packages/merchant-module/src/entities/
  - [x] 迁移 MerchantSchema、CreateMerchantDto、UpdateMerchantDto 到 packages/merchant-module/src/schemas/
  - [x] 创建类型定义文件 packages/merchant-module/src/types/merchant.types.ts
  - [x] 更新实体导入路径，使用 workspace:* 依赖

- [x] Task 3: 迁移商户服务 (AC: 2, 3)
  - [x] 迁移 MerchantService 到 packages/merchant-module/src/services/
  - [x] 重构服务使用 shared-crud 基础设施
  - [x] 更新服务依赖注入配置

- [x] Task 4: 创建商户路由 (AC: 3, 4)
  - [x] 创建商户管理路由 packages/merchant-module/src/routes/index.ts
  - [x] 迁移商户的完整CRUD路由，使用 shared-crud 基础设施
  - [x] 集成认证中间件
  - [x] 配置用户追踪字段

- [x] Task 5: 创建当前用户权限API路由文件 (AC: 3, 4)
  - [x] 创建 packages/merchant-module/src/schemas/user-merchant.schema.ts - 用户专用schema
  - [x] 移除userId字段，自动使用当前登录用户权限
  - [x] 创建 packages/merchant-module/src/schemas/admin-merchant.schema.ts - 管理员专用schema
  - [x] 保留userId字段，允许管理员指定用户
  - [x] 创建 packages/merchant-module/src/routes/user-routes.ts - 仅限当前用户使用的路由
  - [x] 配置数据权限控制，使用 shared-crud 的 dataPermission 配置
  - [x] 设置 userIdField: 'createdBy'，确保用户只能操作自己的数据
  - [x] 使用用户专用schema
  - [x] 创建 packages/merchant-module/src/routes/admin-routes.ts - 管理员使用的完整权限路由
  - [x] 配置管理员路由不使用数据权限控制，保持完整CRUD功能
  - [x] 使用管理员专用schema
  - [x] 更新 packages/merchant-module/src/routes/index.ts 导出两个路由集合
  - [x] 验证用户路由只能访问和操作当前用户的数据
  - [x] 验证管理员路由可以访问所有用户的数据

- [x] Task 6: 创建测试套件 (AC: 7)
  - [x] 创建用户路由集成测试 packages/merchant-module/tests/integration/user-routes.integration.test.ts
  - [x] 测试用户路由只能访问和操作当前用户的数据
  - [x] 验证用户创建商户时自动使用当前用户ID
  - [x] 验证用户无法访问其他用户的数据
  - [x] 创建管理员路由集成测试 packages/merchant-module/tests/integration/admin-routes.integration.test.ts
  - [x] 测试管理员路由可以访问所有用户的数据
  - [x] 验证管理员可以为其他用户创建商户
  - [x] 验证管理员可以更新和删除任何用户的商户
  - [x] 配置测试数据库连接，使用 shared-test-util [Source: packages/shared-test-util/src/integration-test-db.ts#L1-L30]
  - [x] 添加商户状态管理测试场景
  - [x] 测试商户登录统计功能
  - [x] 确保测试覆盖率满足要求

- [ ] Task 7: 集成到现有系统 (AC: 5, 6, 8)
  - [ ] 更新 server package 依赖，添加 @d8d/merchant-module
  - [ ] 在 server 中注册商户路由
  - [ ] 验证与用户模块的集成
  - [ ] 验证与认证系统的集成
  - [ ] 确保商户登录统计功能正常工作

- [ ] Task 8: 验证和文档 (AC: 4, 6)
  - [ ] 运行所有测试验证功能
  - [ ] 更新 docs/architecture/source-tree.md 文档
  - [ ] 验证向后兼容性

## Dev Notes

### 技术栈信息
- **后端框架**: Hono 4.8.5 [Source: architecture/tech-stack.md#现有技术栈维护]
- **数据库**: PostgreSQL 17 + TypeORM 0.3.25 [Source: architecture/tech-stack.md#现有技术栈维护]
- **认证**: JWT Bearer Token [Source: architecture/api-design-integration.md#API集成策略]
- **文件存储**: MinIO + file-module [Source: architecture/source-tree.md#实际项目结构]

### 项目结构
- **包位置**: `packages/merchant-module/` [Source: architecture/source-tree.md#实际项目结构]
- **代码结构**: 遵循现有模块化包模式 [Source: architecture/source-tree.md#包架构层次]
- **依赖层次**: merchant-module → auth-module → user-module → shared-crud → shared-utils → shared-types [Source: docs/prd/epic-005-mini-auth-modules-integration.md#依赖层次]

### 商户功能详情
- **商户实体**: Merchant 实体包含商户名称、用户名、密码、手机号、真实姓名、登录次数、登录时间、登录IP、上次登录时间、上次登录IP、状态、RSA公钥、AES密钥等字段 [Source: packages/server/src/modules/merchant/merchant.entity.ts:1-58]
- **服务层**: 使用 GenericCrudService 提供标准CRUD操作 [Source: packages/server/src/modules/merchant/merchant.service.ts:1-9]
- **API路由**: 使用 createCrudRoutes 创建完整CRUD路由 [Source: packages/server/src/api/merchants/index.ts:1-20]

### 实体设计
**Merchant 实体关键字段**:
- `name`: 商户名称 (varchar(255), nullable)
- `username`: 用户名 (varchar(20), unique)
- `password`: 密码 (varchar(255))
- `phone`: 手机号码 (char(11), nullable)
- `realname`: 姓名 (varchar(20), nullable)
- `loginNum`: 登录次数 (int, default: 0)
- `loginTime`: 登录时间 (int, default: 0)
- `loginIp`: 登录IP (varchar(15), nullable)
- `lastLoginTime`: 上次登录时间 (int, default: 0)
- `lastLoginIp`: 上次登录IP (varchar(15), nullable)
- `state`: 状态 (smallint, default: 2, 1启用 2禁用)
- `rsaPublicKey`: 公钥 (varchar(2000), nullable)
- `aesKey`: aes秘钥 (varchar(32), nullable)
- `createdBy`: 创建用户ID (int, nullable)
- `updatedBy`: 更新用户ID (int, nullable)

### 集成点
- **认证集成**: 使用 auth-module 的认证中间件 [Source: packages/auth-module/src/middleware/auth.middleware.ts:1]
- **用户集成**: 依赖 user-module 获取用户信息 [Source: packages/server/src/modules/merchant/merchant.entity.ts:53-57]
- **数据库**: 使用现有 TypeORM 数据源 [Source: architecture/source-tree.md:74]
- **API 设计**: 遵循现有 RESTful API 模式 [Source: architecture/api-design-integration.md#API集成策略]

### 环境配置要求
- **数据库表**: 需要 merchant 表 [Source: packages/server/src/modules/merchant/merchant.entity.ts:3]
- **认证配置**: 需要配置 JWT 认证 [Source: architecture/api-design-integration.md#API集成策略]

### 依赖关系
- **基础设施依赖**:
  - `@d8d/shared-types` - 基础类型定义 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L269-L276]
  - `@d8d/shared-utils` - 工具函数 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L280-L291]
  - `@d8d/shared-crud` - CRUD基础设施 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L266-L278]
- **业务模块依赖**:
  - `@d8d/user-module` - 用户管理 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L321-L334]
  - `@d8d/auth-module` - 认证管理 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L337-L350]
- **测试依赖**: `@d8d/shared-test-util` [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L294-L306]

### 配置参考
- **package.json**: 参考广告模块配置，统一依赖版本 [Source: packages/advertisements-module/package.json#L47-L66]
- **tsconfig.json**: 参考广告模块配置 [Source: packages/advertisements-module/tsconfig.json#L1-L16]
- **vitest.config.ts**: 参考广告模块配置 [Source: packages/advertisements-module/vitest.config.ts#L1-L21]
- **shared-test-util**: 测试基础设施包，提供统一的测试工具 [Source: packages/shared-test-util/package.json#L1-L16]

### 当前用户权限API路由设计
- **用户路由**: `packages/merchant-module/src/routes/user-routes.ts` - 仅限当前用户使用 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
- **管理员路由**: `packages/merchant-module/src/routes/admin-routes.ts` - 管理员使用的完整权限路由 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
- **用户专用Schema**: `packages/merchant-module/src/schemas/user-merchant.schema.ts` - 移除请求schema中的用户权限相关字段，自动使用当前登录用户权限（响应schema保持完整字段）
- **管理员专用Schema**: `packages/merchant-module/src/schemas/admin-merchant.schema.ts` - 保留完整权限字段，允许管理员指定权限
- **数据权限配置**: 使用 shared-crud 的 `dataPermission` 配置 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L22-L25]
- **权限验证**: 查询、创建、更新、删除操作都会验证用户权限 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L26-L41]

### 向后兼容性
- **API 兼容**: 现有商户API保持不变 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L101]
- **数据库兼容**: 数据库schema保持不变 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L102]
- **认证兼容**: 认证流程保持不变 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L103]

## Testing

### 测试标准
- **测试文件位置**: `packages/merchant-module/tests/` [Source: architecture/testing-strategy.md#L39-L42]
- **单元测试**: `tests/unit/**/*.test.ts` [Source: architecture/testing-strategy.md#L39-L42]
- **集成测试**: `tests/integration/**/*.test.ts` [Source: architecture/testing-strategy.md#L47-L56]
- **测试框架**: Vitest 3.2.4 [Source: architecture/testing-strategy.md#L43]

### 测试要求
- **覆盖率目标**: 单元测试 ≥ 80%，集成测试 ≥ 60% [Source: architecture/testing-strategy.md#L166-L171]
- **测试数据库**: 使用专用测试数据库，事务回滚 [Source: architecture/testing-strategy.md#L200-L202]
- **测试模式**: 遵循测试金字塔策略 [Source: architecture/testing-strategy.md#L33-L64]

### 关键测试场景
- 商户CRUD操作
- 商户状态管理
- 商户登录统计功能
- 认证和权限验证
- **用户路由权限测试**:
  - 验证用户只能访问和操作授权的数据
  - 验证用户创建商户时自动使用当前用户权限
  - 验证用户无法访问其他权限的数据
- **管理员路由权限测试**:
  - 验证管理员可以访问所有数据
  - 验证管理员可以为其他权限创建商户
  - 验证管理员可以更新任何商户
  - 验证管理员可以删除任何商户
- **数据权限配置测试**: 验证 dataPermission 配置正确工作

## Change Log

| Date | Version | Description | Author |
|------|---------|-------------|--------|
| 2025-11-11 | 1.0 | 初始故事创建 | Bob (Scrum Master) |

## Dev Agent Record

*此部分由开发代理在实现过程中填写*

### Agent Model Used
- James (Developer Agent)

### Debug Log References

### Completion Notes List
- Task 1-5 已完成：商户模块基础结构、实体迁移、服务重构、路由创建和权限API路由文件
- Task 6 已完成：测试套件创建和验证，所有29个测试用例全部通过
- 所有核心代码文件已创建并添加到git暂存区
- 测试验证了用户路由权限控制和管理员路由完整权限功能
- 系统集成尚未完成（Task 7-8）

### File List
- packages/merchant-module/package.json
- packages/merchant-module/tsconfig.json
- packages/merchant-module/vitest.config.ts
- packages/merchant-module/src/index.ts
- packages/merchant-module/src/entities/merchant.entity.ts
- packages/merchant-module/src/entities/index.ts
- packages/merchant-module/src/types/merchant.types.ts
- packages/merchant-module/src/types/index.ts
- packages/merchant-module/src/schemas/merchant.schema.ts
- packages/merchant-module/src/schemas/user-merchant.schema.ts
- packages/merchant-module/src/schemas/admin-merchant.schema.ts
- packages/merchant-module/src/schemas/index.ts
- packages/merchant-module/src/services/merchant.service.ts
- packages/merchant-module/src/services/index.ts
- packages/merchant-module/src/routes/index.ts
- packages/merchant-module/src/routes/user-routes.ts
- packages/merchant-module/src/routes/admin-routes.ts
- packages/merchant-module/tests/integration/user-routes.integration.test.ts
- packages/merchant-module/tests/integration/admin-routes.integration.test.ts

## QA Results

*此部分由QA代理在质量审查后填写*