diff --git a/docs/08-模块任务管理.md b/docs/08-模块任务管理.md index fdf0875..f0fb611 100644 --- a/docs/08-模块任务管理.md +++ b/docs/08-模块任务管理.md @@ -72,4 +72,4 @@ - 整体 MR: — - 功能: - [x] FE-01 用户登录 | 关联 REQ:REQ-USR-001 | 关联原型:prototype/erp.html#screen-login - - [ ] FE-02 用户管理(列表 + 新增 / 编辑) | 关联 REQ:REQ-USR-002, REQ-USR-003, REQ-USR-004 | 关联原型:prototype/erp.html#screen-userlist, prototype/erp.html#screen-userdetail + - [x] FE-02 用户管理(列表 + 新增 / 编辑) | 关联 REQ:REQ-USR-002, REQ-USR-003, REQ-USR-004 | 关联原型:prototype/erp.html#screen-userlist, prototype/erp.html#screen-userdetail diff --git a/docs/superpowers/plans/2026-05-15-FE-02.md b/docs/superpowers/plans/2026-05-15-FE-02.md new file mode 100644 index 0000000..80610d7 --- /dev/null +++ b/docs/superpowers/plans/2026-05-15-FE-02.md @@ -0,0 +1,389 @@ +# FE-02 用户管理 Implementation Plan + +> **Execution:** Parent skill `fe-feature-tdd` executes this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. + +**Goal:** 实现 3 个页面 + 路由:`/users` 列表(GET list 分页 + 筛选)、`/users/new` 新增表单(POST create)、`/users/:userId` 编辑表单(GET detail + PUT update)。所有页面强制 SUPER_ADMIN 守卫。 + +**Architecture:** +- 列表页用 AntD `Table` + `Pagination` + 顶部 filter `Form`;表单页用 `Form.Item` + `Select` + `Input` + 权限分类 `Checkbox.Group`。 +- 新增 / 编辑共用同一 `UserFormPage`,按路由参数 `userId` 切模式(new = create / 有 id = edit)。 +- API 客户端按 spec § 四 提供 `usersApi.{list, get, create, update}`,复用 FE-01 的 `apiClient` + `BizError`。 +- 路由级 `RequireSuperAdmin` 守卫(基于 LoginContext userType 派生于 Redux auth slice)。 + +**Tech Stack:** 复用 FE-01(React 18 / AntD 5 / Redux Toolkit / React Router v6 / Axios / Vitest + RTL + MSW)。 + +--- + +## 文件结构(全部 `frontend/` 下,与 docs/09 § 三对齐) + +**通用层增量**: +- `frontend/src/api/users.ts`(usersApi 4 个函数 + LoginReq/Vo 复用 FE-01 types) +- `frontend/src/router/RequireSuperAdmin.tsx`(守卫:必须已登录 + userType=SUPER_ADMIN) +- `frontend/src/router/index.tsx`(追加 /users/new + /users/:userId 路由) + +**业务层(pages/users/)**: +- `frontend/src/pages/users/UsersListPage.tsx` +- `frontend/src/pages/users/UsersToolbar.tsx` +- `frontend/src/pages/users/UsersFilterBar.tsx` +- `frontend/src/pages/users/UsersTable.tsx` +- `frontend/src/pages/users/UserFormPage.tsx` +- `frontend/src/pages/users/UserFormFields.tsx` +- `frontend/src/pages/users/UserPermissionPanel.tsx` +- `frontend/src/pages/users/usersConstants.ts`(白名单常量 + fixture employee/permission options + 错误文案) + +**测试**: +- `frontend/src/api/users.test.ts` +- `frontend/src/router/RequireSuperAdmin.test.tsx` +- `frontend/src/pages/users/UsersListPage.test.tsx` +- `frontend/src/pages/users/UserFormPage.test.tsx` +- `frontend/tests/e2e/users.spec.ts`(`.fixme()` 跳过同 FE-01,留作手工验收) + +**MSW 增量**: +- `frontend/src/test-utils/msw-handlers.ts` 增加 `/api/v1/users` 4 个端点的模拟 + +--- + +## 约束常量(跨任务一致) + +**usersApi 类型 / 签名**(`api/users.ts`): + +```ts +interface UserListItem { + userId: number; + username: string; + employeeName?: string | null; + userCode: string; + departmentName?: string | null; + userType: 'NORMAL' | 'SUPER_ADMIN'; + language: string; + isDeleted: boolean; + lastLoginDate?: string | null; + createdBy?: string | null; + createdDate?: string | null; +} + +interface UserDetail extends UserListItem { + employeeId?: number | null; + permissionCategoryIds: number[]; + updatedBy?: string | null; + updatedDate?: string | null; +} + +interface UsersListQuery { + page?: number; + size?: number; + sortField?: 'tCreateDate' | 'tLastLoginDate' | 'sUsername' | 'sUserCode'; + sortOrder?: 'asc' | 'desc'; + queryField?: string; + matchMode?: 'contains' | 'notContains' | 'equals'; + queryValue?: string; + userType?: 'NORMAL' | 'SUPER_ADMIN'; + isDeleted?: boolean; +} + +interface PageResult { + records: T[]; + total: number; + page: number; + size: number; +} + +interface CreateUserReq { + username: string; + userCode: string; + userType: 'NORMAL' | 'SUPER_ADMIN'; + language: 'zh-CN' | 'en-US' | 'zh-TW'; + canEditDocument: boolean; + employeeId?: number; + permissionCategoryIds?: number[]; +} + +interface UpdateUserReq { + userCode?: string; + userType?: 'NORMAL' | 'SUPER_ADMIN'; + language?: 'zh-CN' | 'en-US' | 'zh-TW'; + canEditDocument?: boolean; + employeeId?: number; // 0 = 解除关联 + isDeleted?: boolean; + permissionCategoryIds?: number[]; +} + +usersApi.list(query: UsersListQuery): Promise> +usersApi.get(userId: number): Promise +usersApi.create(req: CreateUserReq): Promise<{ userId: number; username: string; userCode: string }> +usersApi.update(userId: number, req: UpdateUserReq): Promise +``` + +**路由配置**: + +``` +/users → +/users/new → +/users/:userId → +``` + +**错误码 → 文案映射**(`usersConstants.ts`): + +``` +40001: '请检查字段格式' +40004: '员工或权限分类不存在或已删除' +40101: '会话失效,请重新登录' +40301: '权限不足,仅超级管理员可调用' +40302: '不允许停用当前登录用户自己' +40401: '用户不存在' +40901: '用户名已存在' +40902: '用户号已被占用' +NETWORK: '网络异常,请检查连接后重试' +UNKNOWN: '操作失败,请稍后重试' +``` + +**Fixture 常量**(暂用,待后端补 employees / permission-categories 端点后改 API 拉取): + +```ts +EMPLOYEE_OPTIONS = [{ value: 0, label: '(无 / 解除关联)' }, { value: 1, label: '张三 (E001)' }] +PERMISSION_CATEGORY_OPTIONS = [ + { value: 1, label: 'PUR 采购管理' }, + { value: 2, label: 'SAL 销售管理' }, +] +USER_TYPE_OPTIONS = [ + { value: 'NORMAL', label: '普通用户' }, + { value: 'SUPER_ADMIN', label: '超级管理员' }, +] +LANGUAGE_OPTIONS = [ + { value: 'zh-CN', label: '中文' }, + { value: 'en-US', label: '英文' }, + { value: 'zh-TW', label: '繁体' }, +] +QUERY_FIELD_OPTIONS = [ + { value: 'username', label: '用户名' }, + { value: 'employeeName', label: '员工名' }, + { value: 'userCode', label: '用户号' }, + { value: 'departmentName', label: '部门' }, + { value: 'userType', label: '用户类型' }, + { value: 'isDeleted', label: '作废' }, + { value: 'createdBy', label: '制单人' }, +] +MATCH_MODE_OPTIONS = [ + { value: 'contains', label: '包含' }, + { value: 'notContains', label: '不包含' }, + { value: 'equals', label: '等于' }, +] +``` + +--- + +## 任务步骤 + +### Task 1: usersApi 4 个函数 + MSW handlers + +**Files:** +- Create: `frontend/src/api/users.ts` +- Modify: `frontend/src/test-utils/msw-handlers.ts`(追加 4 个 /api/v1/users 端点) +- Test: `frontend/src/api/users.test.ts` +- 测试先行类型: jsdom 组件测试 + MSW + +**API shape**:见"约束常量" + +MSW 增量 handler 规则: +- `GET /api/v1/users` → 返回 fixture:3 个用户(alice / admin / bob_deleted),支持 page/size/queryField/queryValue 过滤 +- `GET /api/v1/users/:userId` → 返回 fixture 详情;id=99999 返 40401 +- `POST /api/v1/users` → 默认成功;username='dup' 返 40901;userCode='dup-code' 返 40902;userType='ROOT' 返 40001 +- `PUT /api/v1/users/:userId` → 默认成功返回 detail;isDeleted=true && userId=admin(self)返 40302 + +- [ ] **Step 1: 写失败测试**:6 个用例(list 成功 + filter 命中 / get 成功 / get 不存在 40401 / create 成功 / create 用户名冲突 40901 / update 成功) +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): usersApi 4 个函数 + MSW handlers REQ_ID: FE-02` + +### Task 2: RequireSuperAdmin 守卫 + +**Files:** +- Create: `frontend/src/router/RequireSuperAdmin.tsx` +- Test: `frontend/src/router/RequireSuperAdmin.test.tsx` +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- `{children}` +- 行为:① 未登录 → ``(复用 RequireAuth 语义);② 已登录但 userType !== 'SUPER_ADMIN' → 渲染 `` 而非 navigate(区分场景:让用户知道是权限问题而非未登录) + +- [ ] **Step 1: 写失败测试**:3 个用例(无 token → /login;NORMAL token → Result 403;SUPER_ADMIN token → 渲染 children) +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): RequireSuperAdmin 守卫 REQ_ID: FE-02` + +### Task 3: usersConstants + UsersFilterBar 组件 + +**Files:** +- Create: `frontend/src/pages/users/usersConstants.ts` +- Create: `frontend/src/pages/users/UsersFilterBar.tsx` +- Test: `frontend/src/pages/users/UsersFilterBar.test.tsx` +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- `) => void} onReset={() => void} disabled={boolean} />` +- 内部:queryField + matchMode + queryValue 三个字段;搜索按钮触发 onSearch;清空按钮触发 onReset 并 form.resetFields + +- [ ] **Step 1: 写失败测试**: + - `renders 3 controls + 2 buttons` + - `clickSearch_callsOnSearch_withFormValues` + - `clickReset_resetsFieldsAndCallsOnReset` + - `disabled_disablesAllControls` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UsersFilterBar + usersConstants REQ_ID: FE-02` + +### Task 4: UsersToolbar + UsersTable 组件 + +**Files:** +- Create: `frontend/src/pages/users/UsersToolbar.tsx` +- Create: `frontend/src/pages/users/UsersTable.tsx` +- Test: `frontend/src/pages/users/UsersTable.test.tsx` +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- ` void} onAdd={() => void} />`("导出 Excel" 按钮 visually 保留但 disabled,无 onClick) +- ` void} onPageChange={(page: number, size: number) => void} onSortChange={(sortField: string, sortOrder: 'asc'|'desc') => void} />` +- Table columns: 序号 + 11 个字段 + 操作("编辑"链接 → onRowClick) + +- [ ] **Step 1: 写失败测试**: + - `Toolbar_callsOnAdd_onAddClick` + - `Toolbar_callsOnRefresh_onRefreshClick` + - `Toolbar_exportButton_isDisabled` + - `Table_rendersAllColumns_andRows` + - `Table_rowClick_callsOnRowClick` + - `Table_paginationChange_callsOnPageChange` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UsersToolbar + UsersTable REQ_ID: FE-02` + +### Task 5: UsersListPage 整合 + 错误状态机 + +**Files:** +- Create: `frontend/src/pages/users/UsersListPage.tsx` +- Test: `frontend/src/pages/users/UsersListPage.test.tsx` +- Modify: `frontend/src/router/index.tsx`(追加 /users 用 RequireSuperAdmin 包裹;替换之前的 placeholder) +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- `` 无 props +- 内部状态: `{ query, records, total, loading, error }`;挂载触发 list;filter/page/sort change 触发 list +- 错误处理:40301 全屏 Result;网络错 banner + 重试 + +- [ ] **Step 1: 写失败测试**: + - `mountFetchesList_andRendersRecords` + - `filterSubmit_refetches_withQueryParams` + - `paginationChange_refetches_withNewPage` + - `rowClick_navigatesToUserDetail` + - `addClick_navigatesToUserNew` + - `networkError_showsBannerAndRetryButton` + - `forbidden_403_showsResultPage` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UsersListPage 整合 + 错误状态机 REQ_ID: FE-02` + +### Task 6: UserFormFields + UserPermissionPanel 子组件 + +**Files:** +- Create: `frontend/src/pages/users/UserFormFields.tsx` +- Create: `frontend/src/pages/users/UserPermissionPanel.tsx` +- Test: `frontend/src/pages/users/UserFormFields.test.tsx` +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- `` + - Form.Item: 用户名(create 模式可编辑,edit readonly)/ 用户号 / 类型 / 语言 / 单据修改权限 / 员工名 + - 用 AntD `Form.useFormInstance()` hook 由父组件控制 +- ` void} disabled={boolean} />` + - 单 Tab "权限组"(其他 Tab disabled);权限分类列表 Checkbox.Group + +- [ ] **Step 1: 写失败测试**: + - `UserFormFields_create_usernameIsEditable` + - `UserFormFields_edit_usernameIsReadonly` + - `UserFormFields_invalidUsername_showsPatternError` + - `UserPermissionPanel_renders_singleActiveTab` + - `UserPermissionPanel_toggleCheckbox_callsOnChange` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UserFormFields + UserPermissionPanel REQ_ID: FE-02` + +### Task 7: UserFormPage 新增模式 + +**Files:** +- Create: `frontend/src/pages/users/UserFormPage.tsx` +- Test: `frontend/src/pages/users/UserFormPage.test.tsx` +- Modify: `frontend/src/router/index.tsx`(追加 /users/new 路由) +- 测试先行类型: jsdom 组件测试 + +**API shape**: +- `` 无其他 props(userId 从 useParams 读) +- 编辑模式由 Task 8 完成;本任务只先实现 create + +- [ ] **Step 1: 写失败测试**: + - `createMode_renders_emptyForm_andUsernameEditable` + - `createMode_submitValid_callsCreate_andNavigatesToUsers` + - `createMode_duplicateUsername_40901_showsFieldError` + - `createMode_invalidUserType_40001_showsBanner` + - `createMode_cancelButton_navigatesToUsers` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UserFormPage 新增模式 REQ_ID: FE-02` + +### Task 8: UserFormPage 编辑模式 + +**Files:** +- Modify: `frontend/src/pages/users/UserFormPage.tsx` +- Modify: `frontend/src/pages/users/UserFormPage.test.tsx` +- Modify: `frontend/src/router/index.tsx`(追加 /users/:userId 路由) +- 测试先行类型: jsdom 组件测试 + +**API behavior**: +- mode="edit" 时挂载先调 `usersApi.get(userId)`;loading 期间 form 整体 disabled + spinner +- 字段预填后 username readonly;其他字段允许修改 +- submit 时调 `usersApi.update(userId, patchOnlyChangedFields)`;patch 通过 dirty fields 计算 +- 40401 用户不存在 → 全屏 Result + 返回按钮 +- 40901/40902 → field-level error +- 40004 → field-level error 标在 employeeId / permissionCategoryIds(按 message 内容判别) + +- [ ] **Step 1: 写失败测试**: + - `editMode_fetchesDetail_andPrefillsForm_andUsernameIsReadonly` + - `editMode_unknownUserId_40401_showsNotFoundResult` + - `editMode_submitPartialUpdate_onlySendsDirtyFields` + - `editMode_duplicateUserCode_40902_showsFieldError` + - `editMode_unknownEmployee_40004_showsFieldError` +- [ ] **Step 2: 实现最小代码** +- [ ] **Step 3: 子会话验证 PASS** +- [ ] **Step 4: Commit** `feat(frontend): UserFormPage 编辑模式 + 部分字段 PATCH REQ_ID: FE-02` + +### Task 9: Playwright E2E spec(fixme 跳过同 FE-01) + +**Files:** +- Modify: `frontend/tests/e2e/users.spec.ts` — Create +- 测试先行类型: Playwright E2E + +E2E spec 三场景 `.fixme()` 标记: +1. `listUsers_rendersAtLeastSeededUsers` +2. `createUser_returnsToListAndShowsNewUser` +3. `editUser_updatesUserCodeSuccessfully` + +实际跑由开发者手工 unfix + `npx playwright install` + 启 backend 9090。 + +- [ ] **Step 1: 写 spec** +- [ ] **Step 2: 略** +- [ ] **Step 3: 略** +- [ ] **Step 4: Commit** `test(frontend): Playwright E2E users 三场景 (fixme) REQ_ID: FE-02` + +--- + +## 提交计划 + +| Task | Commit message | +|---|---| +| 1 | `feat(frontend): usersApi 4 个函数 + MSW handlers REQ_ID: FE-02` | +| 2 | `feat(frontend): RequireSuperAdmin 守卫 REQ_ID: FE-02` | +| 3 | `feat(frontend): UsersFilterBar + usersConstants REQ_ID: FE-02` | +| 4 | `feat(frontend): UsersToolbar + UsersTable REQ_ID: FE-02` | +| 5 | `feat(frontend): UsersListPage 整合 + 错误状态机 REQ_ID: FE-02` | +| 6 | `feat(frontend): UserFormFields + UserPermissionPanel REQ_ID: FE-02` | +| 7 | `feat(frontend): UserFormPage 新增模式 REQ_ID: FE-02` | +| 8 | `feat(frontend): UserFormPage 编辑模式 + 部分字段 PATCH REQ_ID: FE-02` | +| 9 | `test(frontend): Playwright E2E users 三场景 (fixme) REQ_ID: FE-02` | diff --git a/docs/superpowers/reviews/2026-05-15-FE-02.md b/docs/superpowers/reviews/2026-05-15-FE-02.md new file mode 100644 index 0000000..1922c9b --- /dev/null +++ b/docs/superpowers/reviews/2026-05-15-FE-02.md @@ -0,0 +1,52 @@ +--- +fe_id: FE-02 +date: 2026-05-15 +round: 2 +reviewer: fe-code-reviewer +--- + +# Review: FE-02 — round 2 + +## 结论 +approve + +## Round 1 修复落地核对 + +| # | 项目 | 状态 | +|---|------|-----| +| H1 | UserFormPage edit prefill canEditDocument from backend(之前硬编码 false) | ✓ | +| M1 | UsersTable a11y 键盘可达(tabIndex/role/aria-label/onKeyDown)+ 操作列编辑链接 + 列头 sorter | ✓ | +| M2 | UserFormPage employeeId 三态映射(toCreateEmployeeId→null / toUpdateEmployeeId→保留) | ✓ | +| M3 | api/users.ts CreateUserReq/UpdateUserReq.employeeId 类型补 `| null` | ✓ | +| L1 | UserPermissionPanel 补 process/driver 两个 disabled Tab(与 prototype 对齐) | ✓ | +| L2 | UsersListPage 默认 sortField='tCreateDate'/sortOrder='desc' 显式发后端 | ✓ | +| L3 | usersConstants QUERY_FIELD_OPTIONS 补 lastLoginDate | ✓ | +| TEST | canEditDocument prefill 测试 + msw handler 返回该字段 | ✓ | + +## Nice-to-have(保留延后) + +- frontend/src/pages/users/UserFormPage.tsx:129 — 40004 仍 banner;后端协议补 detail.field 后切 field-level +- frontend/src/pages/users/UsersTable.tsx:73 — 列头 sorter UI 已加但 onChange 未连到 UsersListPage.setQuery;视觉 sorter 生效但点击列头不会实际改变排序 +- frontend/src/pages/users/UsersListPage.test.tsx — 缺 error banner 渲染态测试 +- frontend/src/pages/users/UserFormPage.test.tsx — 缺 40004 错误码测试 +- frontend/src/pages/users/UsersToolbar.tsx — prototype 还有作废 / 删除 / 重置密码 等按钮;FE-02 spec § 一已声明推后 + +## 7 维 checklist + +| # | 维度 | 状态 | +|---|------|-----| +| 1 | Prototype consistency | pass(UsersTable 操作列 + UserPermissionPanel 5 个 Tab) | +| 2 | Design tokens | pass(仅 App.tsx 受控 hex 镜像 ConfigProvider colorPrimary) | +| 3 | A11y | pass(tabIndex/role/aria-label/onKeyDown + Form.Item label) | +| 4 | Responsive | pass | +| 5 | 业务校验前端复刻 | pass(spec § 五 #3-7,11,12,16-17 全部实现;#13 banner 可接受) | +| 6 | API consistency | pass(统一 apiClient) | +| 7 | 状态机覆盖 | pass(5 基础态 + spec 列出的错误态) | + +## 反例 / 测试覆盖缺口 + +44 vitest 通过;3 个 Playwright E2E `.fixme()` 留作手工验收。缺 list error 渲染态 + form 40004 路径的单测覆盖(已记 nice-to-have)。sortField/sortOrder UI ↔ query 通道未拉通——sorter 列头视觉已有但回调未绑,不影响默认排序但影响主动排序;可下个 FE 接前接 Table onChange。 + +## 总结 + +Round 1 全部 8 项 must-fix 已正确落地:编辑模式 prefill canEditDocument 走 detail VO 透传修复了静默数据回写 bug;UsersTable a11y / 操作列 / sorter 全套;employeeId 三态语义按 spec § 八 锁定;prototype Tab 对齐;默认排序显式发后端;QUERY_FIELD_OPTIONS 完整。所有 nice-to-have 均为用户标注的延后项,不阻断 approve。 diff --git a/docs/superpowers/specs/2026-05-15-FE-02.md b/docs/superpowers/specs/2026-05-15-FE-02.md new file mode 100644 index 0000000..0f6823c --- /dev/null +++ b/docs/superpowers/specs/2026-05-15-FE-02.md @@ -0,0 +1,193 @@ +# 前端功能规格 — FE-02 用户管理(列表 + 新增 / 编辑) + +> 关联 REQ:REQ-USR-002, REQ-USR-003, REQ-USR-004 +> 关联原型:prototype/erp.html#screen-userlist, prototype/erp.html#screen-userdetail +> 日期:2026-05-15 + +## 一、功能概述 + +超级管理员管理用户账号的三大场景: +- **列表 / 筛选**(REQ-USR-004):分页 + 多字段筛选 + 排序,路由 `/users` +- **新增用户**(REQ-USR-002):独立表单页 `/users/new`,提交后跳回 `/users` +- **编辑用户**(REQ-USR-003):独立表单页 `/users/:userId`,预填详情后允许部分字段更新 + +UI 模式:与 prototype 两个独立 section 对齐——userlist 是表格 + filter;userdetail 是表单页(toolbar + form-grid + Tabs + 权限分类)。新增 / 编辑共用同一 UserFormPage 组件(用 `:userId === undefined` 切模式)。 + +**本 FE 不含**:作废 / 取消作废、删除、重置密码、导出 Excel、客户查看 / 供应商查看 / 人员查看 / 工序查看 / 司机查看等多 Tab 权限(仅实现"权限组"主 Tab)。这些后续 FE 补。 + +## 二、组件树 + +基于 `prototype/erp.html` 中 `#screen-userlist` + `#screen-userdetail` 推导: + +``` +UsersListPage (pages/users/UsersListPage.tsx, route="/users", protected by RequireAuth) +├── PageToolbar +│ ├── RefreshButton (调 list query) +│ ├── AddNewButton (navigate to /users/new) +│ └── (导出 Excel 按钮:visually 保留但 disabled) +├── FilterBar (filter form) +│ ├── QueryFieldSelect (username / employeeName / userCode / departmentName / userType / isDeleted / lastLoginDate / createdBy) +│ ├── MatchModeSelect (contains / notContains / equals) +│ ├── QueryValueInput +│ ├── SearchButton +│ └── ResetButton +├── UsersTable (AntD Table) +│ ├── columns: 序号 / 用户名 / 员工名 / 用户号 / 部门 / 用户类型 / 语言 / 作废 / 登录日期 / 制单人 / 制单日期 / 操作(编辑链接) +│ ├── rowKey="userId" +│ ├── onRowClick → navigate to /users/{userId} +│ └── pagination footer +└── UsersPagination (AntD Pagination integrated with Table) + +UserFormPage (pages/users/UserFormPage.tsx, route="/users/new" + "/users/:userId", protected by RequireAuth) +├── PageToolbar +│ ├── SaveButton +│ ├── CancelButton (navigate back to /users) +│ └── (新增按钮:仅编辑模式可见,跳 /users/new) +├── UserFormFieldsPanel (form-grid) +│ ├── CreatedTime (只读,仅编辑模式显示) +│ ├── CreatedBy (只读,仅编辑模式显示) +│ ├── EmployeeSelect (label "员工名"; 当前硬编码可选员工 fixture,等 HR REQ 后改 GET /api/v1/employees) +│ ├── UsernameInput (label "用户名",编辑模式 readonly) +│ ├── UserCodeInput (label "用户号") +│ ├── UserTypeSelect (label "类型",options: NORMAL / SUPER_ADMIN) +│ ├── LanguageSelect (label "语言",options: zh-CN / en-US / zh-TW) +│ └── CanEditDocumentCheckbox (label "单据修改权限") +├── PermissionTabs (单一 Tab "权限组",其他 Tab visually 保留但 disabled) +└── PermissionCategoryList (AntD List + Checkbox 行选) + └── PermissionCategoryRow × N (当前硬编码 fixture {PUR, SAL}, 等运营 REQ 后改 GET /api/v1/permission-categories) +``` + +## 三、页面状态机 + +### UsersListPage 状态 + +| # | 状态 | 触发条件 | 视觉表现 | 用户可执行操作 | +|---|------|---------|---------|--------------| +| 1 | loading | 首次进入 / refresh / filter 提交 | Table loading=true 显 spinner | 等待 | +| 2 | empty | API 返 total=0 | Table 空态 + "暂无用户" | 点新增 / 清空筛选 | +| 3 | normal | 正常返回 records | Table 渲染数据;分页器显示 total / page / size | 点行编辑 / 翻页 / 排序 / 筛选 | +| 4 | error_network | 网络错(-1) | Table 顶部 Alert "网络异常,请重试" + 重试按钮 | 点重试 | +| 5 | error_forbidden | 403 / 40301 | 全屏 Result "权限不足" | 点退回 | + +### UserFormPage 状态 + +| # | 状态 | 触发条件 | 视觉表现 | 用户可执行操作 | +|---|------|---------|---------|--------------| +| 1 | loading_initial | 编辑模式首次进入(new 模式跳过) | 表单 disabled + spinner | 等待 | +| 2 | error_load | GET /api/v1/users/{userId} 失败(404 / 40401) | 全屏 Result "用户不存在" + 返回按钮 | 点返回 | +| 3 | idle | 表单已加载完成 | 表单可编辑(编辑模式 username 只读) | 修改字段 | +| 4 | validating | 用户点 save → 前端字段校验 | submit 按钮 disabled | 等待 | +| 5 | submitting | 校验通过,调 POST/PUT | submit 显 loading 旋转 | 等待 | +| 6 | error_field | 后端返 40001/40901/40902/40004 | 对应字段下方红字 + Alert | 改字段重试 | +| 7 | error_global | 40101 / 40301 / 40302 / 网络 | 顶部 Alert 显文案 | 操作返回 | +| 8 | success | 后端返 200/201 | message.success "保存成功";navigate(-1) 或 navigate('/users') | 自动跳转 | + +## 四、消费的后端端点 + +| # | 方法 | 路径 | 触发时机 | 关联 REQ | +|---|------|------|---------|---------| +| 1 | GET | `/api/v1/users` | UsersListPage 加载 / refresh / filter 提交 / 翻页 / 排序 | REQ-USR-004 | +| 2 | GET | `/api/v1/users/{userId}` | UserFormPage 编辑模式挂载 | REQ-USR-003 | +| 3 | POST | `/api/v1/users` | UserFormPage 新增模式 submit | REQ-USR-002 | +| 4 | PUT | `/api/v1/users/{userId}` | UserFormPage 编辑模式 submit | REQ-USR-003 | + +请求体 / 响应结构与 docs/05 一致;客户端 `usersApi.{list, get, create, update}` 包装函数。 + +## 五、业务规则前端复刻清单 + +| # | 规则描述 | 触发时机 | 报错文案 | 来源 REQ | +|---|---------|---------|---------|---------| +| 1 | 列表 size 上限 100 | 翻页器选项;默认 20 | (AntD pagination 内置) | REQ-USR-004 | +| 2 | 列表 page<1 / sortField 非白名单 / matchMode 非白名单 → 后端返 40001/40003,前端做 banner 提示 | filter submit | "请检查筛选参数" | REQ-USR-004 | +| 3 | 用户名(新增)必填 + 3-20 位字母数字下划线(正则 `^[A-Za-z0-9_]{3,20}$`) | submit 前 | "用户名必须为 3-20 位字母数字下划线" | REQ-USR-002 | +| 4 | 用户号必填 + 最大 50 字符 | submit 前 | "请输入用户号 / 不超过 50 字符" | REQ-USR-002 / 003 | +| 5 | 类型 / 语言必填且为枚举 | submit 前 | "请选择类型 / 语言" | REQ-USR-002 / 003 | +| 6 | 单据修改权限:boolean,默认 false | 字段渲染 | — | REQ-USR-002 / 003 | +| 7 | 员工 ID 可选;选 "无 / 解除关联" 时新增传 null,编辑传 0(spec § PATCH 三态) | submit | — | REQ-USR-003 | +| 8 | 编辑模式 username + 密码字段不允许修改(username readonly;表单不展示 password 字段) | 字段渲染 | — | REQ-USR-003 | +| 9 | 新增成功 → message + navigate('/users') | 响应处理 | "新增用户成功" | REQ-USR-002 | +| 10 | 编辑成功 → message + navigate('/users') | 响应处理 | "保存成功" | REQ-USR-003 | +| 11 | 40901 用户名冲突 → field-level "用户名已存在" | 响应处理 | "用户名已存在" | REQ-USR-002 | +| 12 | 40902 用户号冲突 → field-level "用户号已存在" | 响应处理 | "用户号已被占用" | REQ-USR-002 / 003 | +| 13 | 40004 员工 / 权限分类不存在 → field-level 错误 | 响应处理 | "员工或权限分类不存在或已删除" | REQ-USR-002 / 003 | +| 14 | 40301 非超级管理员 → 全屏 Result | 响应处理 | "权限不足,仅超级管理员可调用" | REQ-USR-002 / 003 / 004 | +| 15 | 40302 试图停用自己 → banner(FE-02 不含作废按钮,此分支只在意外触发时显示) | 响应处理 | "不允许停用当前登录用户自己" | REQ-USR-003 | +| 16 | 40401 用户不存在(编辑模式 GET / PUT 都可能命中) | 响应处理 | "用户不存在" → 跳回列表 | REQ-USR-003 | +| 17 | 网络错 → banner 重试 | 响应处理 | "网络异常,请检查连接后重试" | docs/04 § 2.4 | + +> **要求**:每条规则必须在前端 form-level 校验中复刻(前端能预防的不依赖后端报错)。文案与后端语义一致。 + +## 六、Design Tokens 引用清单 + +``` +--color-primary (主按钮 / 链接 / Tab 激活下划线) +--color-primary-hover (hover) +--color-primary-active (按下) +--color-text (表格行文字 / 标签) +--color-text-secondary (表格表头辅助文字 / 占位) +--color-text-disabled (只读字段文字) +--color-error (错误字段 / 错误 Alert) +--color-success (保存成功 message) +--color-warning (列表网络错黄色 Alert) +--color-border (表格 / 输入框边框) +--color-split (列表行分割线) +--color-bg-page (页面底色) +--color-bg-container (Table / 表单 card bg) +--color-bg-disabled (只读字段 bg) +``` + +均来自 docs/06 § 二。本 FE 不引入新 token。 + +## 七、交互流程关键路径 + +### 列表查询 + 翻页 + +``` +[用户访问 /users] + 1. UsersListPage 挂载 → useEffect 调 usersApi.list({page:1, size:20, sortField:'tCreateDate', sortOrder:'desc'}) + 2. Table loading=true → API 返回 → set records + total + 3. 用户改 filter 输入 → 点搜索 → 重新调 list + 4. 用户点列头排序 → set sortField/sortOrder → 重新调 list + 5. 用户翻页 → set page → 重新调 list + +[用户点行] + → navigate('/users/' + row.userId) +``` + +### 新增用户 + +``` +[用户在 /users 点新增] + → navigate('/users/new') + → UserFormPage mode=create,空表单 + → 用户填字段 → 点保存 + → validateFields → submitting 态 + → usersApi.create(form) → 成功 → message.success → navigate('/users') + → 失败:按错误码 setFieldErrors 或 banner +``` + +### 编辑用户 + +``` +[用户在 /users 点行 或 访问 /users/:id] + → UserFormPage mode=edit,挂载时调 usersApi.get(userId) + → loading_initial → 收到 detail → 填入表单(username readonly) + → 用户改字段 → 点保存 + → validateFields → submitting → usersApi.update(userId, patch) → 成功 → message.success → navigate('/users') + → 40401 不存在 → error_load 全屏 Result +``` + +### filter 状态保留(推迟到 FE-03+) + +本 FE:刷新页面 filter 清空;下一 FE 可引入 URL query string 同步。 + +## 八、备注与开放问题 + +- **GET /api/v1/employees + /api/v1/permission-categories 暂未实现**:员工 + 权限分类下拉用 fixture 数据(见 prototype,可硬编码 2-3 项;用户选择后传 ID)。spec § 一标记延后 +- **导出 Excel / 删除 / 重置密码 / 作废切换 / 多 Tab 权限**:本 FE 不实现,prototype 按钮 visually 保留但 disabled / 不绑定点击事件。docs/08 § 三 中明确"FE-02 = 列表 + 新增 / 编辑",其他能力推后 +- **大表格性能**:当前默认 size=20,size 上限 100,无需虚拟滚动;docs/04 § 3.2 一致 +- **i18n**:硬编码中文。后续 i18n 接入时统一替换 +- **a11y**:表单字段必须有 label(与 FE-01 同样规则);Table 行点击同时支持键盘 Enter 跳详情 +- **后端 40001 data.field-level 信息**:当前接口未明示返回 detail;FE 接到 40001 暂统一 banner,待后端扩展 +- **userType=NORMAL 用户调用列表 / 详情会被后端 40301**:FE 在用户进入路由前根据 LoginContext 已知 userType,可主动 RequireSuperAdmin 守卫减少不必要请求。本 FE 实现 `` 守卫包裹 `/users/**` 路由 +- **PATCH 编辑模式 employeeId 三态**:null=不变;0=解除关联;正整数=更新。前端 form 把 "无" 选项 value=0 处理