Browse Source

📝 docs(goods, merchant, supplier): enhance module documentation with detailed references

- goods-module:
  - add source references for package dependencies and entity relationships
  - update task descriptions with specific source links for关联关系配置
  - add supplier-module and merchant-module as explicit dependencies

- merchant-module:
  - clarify user schema behavior: remove permission fields from requests but keep完整字段 in responses

- supplier-module:
  - clarify user schema behavior: remove permission fields from requests but keep完整字段 in responses
yourname 1 tháng trước cách đây
mục cha
commit
0a3246543c

+ 8 - 6
docs/stories/005.010.goods-module.story.md

@@ -24,7 +24,7 @@ Draft
 
 - [ ] Task 1: 创建 goods-module package 基础结构 (AC: 1, 2)
   - [ ] 创建 packages/goods-module 目录结构
-  - [ ] 配置 package.json 和依赖关系
+  - [ ] 配置 package.json 和依赖关系,包含供应商和商户模块依赖 [Source: packages/supplier-module/package.json#L48-L58]
   - [ ] 配置 TypeScript 编译配置
   - [ ] 配置 vitest.config.ts 测试配置
   - [ ] 创建基础导出文件
@@ -49,14 +49,14 @@ Draft
   - [ ] 创建商品分类管理路由 packages/goods-module/src/routes/goods-categories.ts
   - [ ] 集成认证中间件
   - [ ] 配置用户追踪字段
-  - [ ] 配置关联关系(分类、供应商、商户、文件)
+  - [ ] 配置关联关系(分类、供应商、商户、文件) [Source: packages/server/src/modules/goods/goods.entity.ts#L104-L114]
 
 - [ ] Task 4.1: 创建随机商品功能 (AC: 3, 4)
   - [ ] 迁移随机商品查询Schema packages/goods-module/src/schemas/random.schema.ts
   - [ ] 创建随机商品路由 packages/goods-module/src/routes/random.ts
   - [ ] 实现随机商品查询逻辑(支持分类过滤和图片包含选项)
   - [ ] 配置随机排序和状态过滤
-  - [ ] 验证关联数据加载(图片、分类、供应商等)
+  - [ ] 验证关联数据加载(图片、分类、供应商、商户等) [Source: packages/server/src/modules/goods/goods.entity.ts#L104-L114]
 
 - [ ] Task 5: 创建用户权限API路由文件 (AC: 3, 4)
   - [ ] 创建用户专用schema packages/goods-module/src/schemas/user-goods.schema.ts
@@ -74,7 +74,7 @@ Draft
   - [ ] 创建用户路由集成测试 packages/goods-module/tests/integration/user-routes.integration.test.ts
   - [ ] 创建管理员路由集成测试 packages/goods-module/tests/integration/admin-routes.integration.test.ts
   - [ ] 配置测试数据库连接,使用 shared-test-util
-  - [ ] 添加关联关系测试场景
+  - [ ] 添加关联关系测试场景(分类、供应商、商户、文件) [Source: packages/server/src/modules/goods/goods.entity.ts#L104-L114]
   - [ ] 测试商品状态管理逻辑
   - [ ] 测试随机商品查询功能
   - [ ] 确保测试覆盖率满足要求
@@ -103,7 +103,7 @@ Draft
 ### 项目结构
 - **包位置**: `packages/goods-module/` [Source: architecture/source-tree.md#实际项目结构]
 - **代码结构**: 遵循现有模块化包模式 [Source: architecture/source-tree.md#包架构层次]
-- **依赖层次**: goods-module → file-module → auth-module → user-module → shared-crud → shared-utils → shared-types [Source: docs/prd/epic-005-mini-auth-modules-integration.md#依赖层次]
+- **依赖层次**: goods-module → supplier-module → merchant-module → file-module → auth-module → user-module → shared-crud → shared-utils → shared-types [Source: docs/architecture/source-tree.md#包架构层次]
 
 ### 商品功能详情
 - **商品实体**: Goods 实体包含名称、价格、成本价、销售数量、点击次数、三级分类ID、商品类型、供应商ID、商户ID、图片文件ID、轮播图、详情、简介、排序、状态、库存、SPU信息、最小起购量等字段 [Source: packages/server/src/modules/goods/goods.entity.ts:1-115]
@@ -152,6 +152,8 @@ Draft
   - `@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/file-module` - 文件管理 [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L353-L366]
+  - `@d8d/supplier-module` - 供应商管理 [Source: packages/server/src/modules/goods/goods.entity.ts#L104-L106]
+  - `@d8d/merchant-module` - 商户管理 [Source: packages/server/src/modules/goods/goods.entity.ts#L112-L114]
 - **测试依赖**: `@d8d/shared-test-util` [Source: docs/prd/epic-005-mini-auth-modules-integration.md#L294-L306]
 
 ### 配置参考
@@ -163,7 +165,7 @@ Draft
 ### 当前用户权限API路由设计
 - **用户路由**: `packages/goods-module/src/routes/user-routes.ts` - 仅限当前用户使用 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
 - **管理员路由**: `packages/goods-module/src/routes/admin-routes.ts` - 管理员使用的完整权限路由 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
-- **用户专用Schema**: `packages/goods-module/src/schemas/user-goods.schema.ts` - 移除用户权限相关字段,自动使用当前登录用户权限
+- **用户专用Schema**: `packages/goods-module/src/schemas/user-goods.schema.ts` - 移除请求schema中的用户权限相关字段,自动使用当前登录用户权限(响应schema保持完整字段)
 - **管理员专用Schema**: `packages/goods-module/src/schemas/admin-goods.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]

+ 1 - 1
docs/stories/005.012.merchant-module.story.md

@@ -153,7 +153,7 @@ Ready for Review
 ### 当前用户权限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**: `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]

+ 1 - 1
docs/stories/005.015.supplier-module.story.md

@@ -151,7 +151,7 @@ Ready for Review
 ### 当前用户权限API路由设计
 - **用户路由**: `packages/supplier-module/src/routes/user-routes.ts` - 仅限当前用户使用 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
 - **管理员路由**: `packages/supplier-module/src/routes/admin-routes.ts` - 管理员使用的完整权限路由 [Source: docs/stories/006.001.shared-crud-data-permission.story.md#L21-L50]
-- **用户专用Schema**: `packages/supplier-module/src/schemas/user-supplier.schema.ts` - 移除用户权限相关字段,自动使用当前登录用户权限
+- **用户专用Schema**: `packages/supplier-module/src/schemas/user-supplier.schema.ts` - 移除请求schema中的用户权限相关字段,自动使用当前登录用户权限(响应schema保持完整字段)
 - **管理员专用Schema**: `packages/supplier-module/src/schemas/admin-supplier.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]