feat: 系统配置
Some checks failed
构建并部署前端到测试环境 / build-and-deploy (push) Has been cancelled

This commit is contained in:
luo
2026-07-25 14:13:49 +08:00
parent ee508c3e1e
commit dd6bceeeb7
20 changed files with 805 additions and 41 deletions

View File

@@ -0,0 +1,26 @@
## Context
系统配置由后端注册,前端不能假设固定字段。列表接口返回控件提示、值类型、枚举和范围,更新接口要求配置 Key 与路径一致且值字符串化。
## Goals / Non-Goals
- Goals:
- 在设置管理提供统一的模块筛选、分页和配置编辑入口。
- 动态遵循后端配置元数据进行展示和校验。
- 防止误修改只读配置和敏感配置脱敏值。
- Non-Goals:
- 不在前端维护配置 Key 白名单或复制后端注册规则。
- 不对 JSON 配置做业务语义解析。
- 不绕过后端对已注册配置、范围和枚举的最终校验。
## Decisions
- 列表数据读取 `data.list`,分页使用 `page``page_size``total`
- 编辑控件优先根据 `control` 渲染,`value_type` 作为值转换和校验兜底。
- `bool` 以开关展示并提交 `true`/`false` 字符串;`int` 以数字输入展示并提交十进制字符串;其他类型以输入框或文本域提交字符串。
- `readonly=true` 的配置不显示可编辑操作;`sensitive=true` 的值仅显示接口返回值,只有用户主动输入新值时才提交更新。
## Risks / Trade-offs
- 未知控件提示可能无法映射到专用控件,使用文本输入作为安全兜底,并仍由后端校验。
- 脱敏敏感值无法判断是否为完整原值,因此禁止把未修改的脱敏值再次提交。

View File

@@ -0,0 +1,18 @@
# Change: 增加系统配置管理
## Why
系统配置接口已经提供受控配置的注册信息、控件提示和校验范围,设置管理需要提供统一入口,避免为每个配置模块单独维护页面和字段。
## What Changes
- 在设置管理下新增系统配置页面和路由。
- 接入系统配置列表查询和按配置 Key 更新接口。
- 按后端返回的 `control``value_type`、枚举值及范围动态渲染编辑控件。
- 只读配置不可编辑,更新请求统一提交 `{ key, value }`,其中 `value` 为字符串。
- 敏感配置按接口脱敏值展示,保存时不覆盖未重新输入的脱敏值。
## Impact
- Affected specs: `system-config-management`
- Affected code: `src/api/modules/systemConfig.ts`, `src/types/api/systemConfig.ts`, `src/views/settings/system-configs/index.vue`, `src/router/routesAlias.ts`, `src/router/routes/asyncRoutes.ts`

View File

@@ -0,0 +1,56 @@
## ADDED Requirements
### Requirement: 受控系统配置列表
系统 SHALL 在设置管理提供受控系统配置列表,支持按 `module` 筛选和分页,并展示后端返回的配置元数据及当前值。
#### Scenario: 查询系统配置
- **WHEN** 用户进入系统配置页面或执行刷新
- **THEN** 前端调用 `GET /api/admin/system-configs`
- **AND** 使用响应中的 `data.list``data.page``data.page_size``data.total` 渲染列表
- **AND** 展示配置 Key、模块、说明、值、控件提示、注册状态、只读状态、敏感状态和更新时间
#### Scenario: 按模块筛选
- **WHEN** 用户选择 `carrier_callback``c2b.payment`
- **THEN** 查询请求携带对应的 `module` 参数
- **AND** 页面从第一页展示筛选后的配置
### Requirement: 动态配置编辑
系统 SHALL 根据配置返回的 `control``value_type``enum_values``min``max` 元数据渲染编辑控件并进行前端基础校验;更新请求 SHALL 统一提交字符串形式的 `value`
#### Scenario: 更新可编辑配置
- **WHEN** 用户修改非只读配置并提交
- **THEN** 前端调用 `PUT /api/admin/system-configs/{key}`
- **AND** 请求体为 `{ "key": "配置Key", "value": "字符串化配置值" }`
- **AND** 成功后使用接口返回的配置数据更新列表
#### Scenario: bool 和 int 配置
- **WHEN** 配置类型分别为 `bool``int`
- **THEN** 页面分别使用开关或数字输入控件
- **AND** bool 提交 `true`/`false` 字符串int 提交十进制数字字符串
- **AND** int 值违反 `min``max` 时阻止提交
#### Scenario: 枚举配置
- **WHEN** 配置返回非空 `enum_values`
- **THEN** 页面使用枚举选择控件
- **AND** 只能提交允许的枚举值
### Requirement: 只读和敏感配置保护
系统 SHALL 禁止前端编辑只读配置;敏感配置 SHALL 展示接口返回的脱敏值,用户未主动输入新值时不得将该脱敏值再次提交。
#### Scenario: 只读配置
- **WHEN** 配置的 `readonly``true`
- **THEN** 页面禁用编辑控件和保存操作
#### Scenario: 敏感配置未修改
- **WHEN** 敏感配置仅展示脱敏值且用户未输入新值
- **THEN** 页面不提交该配置的更新请求

View File

@@ -0,0 +1,20 @@
## 1. API And Types
- [x] 1.1 新增系统配置字段、查询参数和分页响应类型。
- [x] 1.2 新增 `GET /api/admin/system-configs` 服务方法,读取 `data.list`
- [x] 1.3 新增 `PUT /api/admin/system-configs/{key}` 服务方法,提交 `{ key, value }`
## 2. Settings Management Page
- [x] 2.1 在设置管理下新增系统配置路由和菜单入口。
- [x] 2.2 实现模块筛选、分页、刷新和配置列表展示。
- [x] 2.3 根据配置元数据动态渲染开关、数字、枚举、文本和 JSON 控件。
- [x] 2.4 实现只读配置禁用编辑、敏感值脱敏保护和字符串化提交。
- [x] 2.5 展示配置注册状态、更新时间、范围和校验提示。
## 3. Verification
- [x] 3.1 验证两个模块筛选和分页参数正确传递。
- [x] 3.2 验证 bool、int、enum、string 和 json 配置的展示及提交值。
- [x] 3.3 验证只读配置不能提交,敏感配置未修改时不会回传脱敏值。
- [x] 3.4 运行类型检查、lint 和构建。

View File

@@ -0,0 +1,36 @@
## Context
代理系列授权详情返回完整的 `packages[]`,套餐列表接口返回可选套餐候选。前端创建授权时需要从候选套餐中选择初始套餐,详情和套餐管理页面则需要同时展示候选套餐信息与已授权状态。
## Goals / Non-Goals
- Goals:
-`package_id` 为唯一键合并套餐候选和授权详情。
- 在创建前校验初始套餐数量为 1100 且不重复。
- 使用 `remove=true` 表达后续删除,保持接口响应结构不变。
- Non-Goals:
- 不修改后端接口路径或响应字段结构。
- 不在前端复制后端的成本价、生效条件或套餐状态计算规则。
- 不新增独立的套餐删除 API 调用。
## Decisions
- 套餐候选状态以 `package_id` 合并:详情返回的套餐标记为已授权,候选列表中不存在于详情的套餐标记为未授权。
- 创建请求始终携带 `packages`,数量范围为 1100每个 `package_id` 只能出现一次。
- 后续新增或调价沿用 `PUT /api/admin/shop-series-grants/{id}/packages`,删除项只提交 `{ package_id, remove: true }`
- 成功响应直接按后端返回的完整授权详情刷新页面,不根据请求内容自行拼装最终响应。
## Risks / Trade-offs
- 套餐候选接口分页或搜索结果可能不包含已授权套餐,合并时必须保留详情中的已授权项,避免误显示为未授权。
- 用户一次选择超过 100 个套餐时前端应提前阻止提交,同时仍依赖后端校验作为最终约束。
## Migration Plan
1. 更新类型和 API 请求约束。
2. 更新创建页、授权详情页和套餐列表页的候选合并及套餐操作逻辑。
3. 使用接口响应重新加载授权详情,验证创建、调价、删除和空候选场景。
## Open Questions
- 套餐候选接口的分页大小是否允许一次返回全部候选;若不允许,页面需要继续使用远程搜索加载候选。

View File

@@ -0,0 +1,18 @@
# Change: 更新代理系列授权套餐管理契约
## Why
代理系列授权接口已更新为创建时必须一次提交初始套餐,后续通过套餐批量管理接口维护套餐。前端需要将套餐列表作为候选集合、授权详情作为已授权状态来源进行合并,避免新增、编辑和删除时状态不一致。
## What Changes
- 套餐列表页和授权详情页统一按 `package_id` 合并套餐候选数据与已授权数据。
- 创建代理系列授权时强制提交 1100 个不重复套餐。
- 后续套餐管理继续通过 `packages[]` 提交新增、调价和 `remove=true` 删除操作。
- 保持创建、详情、更新和套餐管理接口的完整授权详情响应结构不变。
- 更新 API 类型、表单校验和页面状态管理,禁止通过空套餐列表创建授权或使用独立删除接口删除授权套餐。
## Impact
- Affected specs: `package-series-allocation`
- Affected code: `src/api/modules/shopSeriesGrant.ts`, `src/types/api/packageManagement.ts`, `src/views/package-management/series-grants/index.vue`, `src/views/package-management/series-grants/detail.vue`, `src/views/package-management/series-grants/packages.vue`

View File

@@ -0,0 +1,61 @@
## MODIFIED Requirements
### Requirement: 创建代理系列授权时提交初始套餐
系统 SHALL 在创建代理系列授权时要求提交 `packages`,且 `packages` 必须包含 1100 个套餐项;套餐 ID 不得重复。创建成功响应 SHALL 保持完整授权详情结构不变。
#### Scenario: 创建授权并提交有效初始套餐
- **WHEN** 用户提交 `shop_id``series_id` 和包含 1100 个不重复套餐项的 `packages`
- **THEN** 前端提交 `POST /api/admin/shop-series-grants`
- **AND** 每个套餐项携带必要的 `package_id`,新增或调价时携带 `cost_price`
- **AND** 页面按接口返回的完整授权详情刷新授权信息
#### Scenario: 创建授权未选择套餐
- **WHEN** 用户未选择任何初始套餐
- **THEN** 前端阻止提交并提示至少选择 1 个套餐
#### Scenario: 创建授权超过套餐数量上限或包含重复套餐
- **WHEN** 用户选择超过 100 个套餐或同一 `package_id` 重复出现
- **THEN** 前端阻止提交并提示套餐数量或重复项错误
### Requirement: 合并套餐候选与授权状态
系统 SHALL 在套餐列表和授权详情相关页面以 `package_id` 为唯一键合并套餐候选数据与授权详情中的 `packages[]`。已授权套餐即使不在当前候选搜索结果中,也 SHALL 保留并标记为已授权。
#### Scenario: 候选套餐与已授权套餐合并
- **WHEN** 套餐候选列表和授权详情均加载成功
- **THEN** 页面按 `package_id` 合并两者
- **AND** 详情中的套餐显示为已授权并保留其成本价、生效条件和状态字段
- **AND** 仅出现在候选列表中的套餐显示为未授权候选
#### Scenario: 候选搜索结果不包含已授权套餐
- **WHEN** 当前候选搜索结果缺少某个已授权套餐
- **THEN** 页面仍从授权详情保留该套餐
- **AND** 不将其误判为未授权或从当前编辑状态中删除
### Requirement: 后续套餐管理使用批量操作删除
系统 SHALL 使用 `PUT /api/admin/shop-series-grants/{id}/packages` 管理既有授权套餐。新增和调价提交套餐项,删除套餐授权 SHALL 提交对应套餐项的 `remove: true`;操作成功后 SHALL 按接口返回的完整授权详情刷新页面。
#### Scenario: 新增或调整授权套餐
- **WHEN** 用户在已有授权中新增套餐或调整成本价
- **THEN** 前端提交 `packages[]` 中对应的套餐项及成本价
- **AND** 不调用独立删除接口
#### Scenario: 删除授权套餐
- **WHEN** 用户删除已有授权套餐
- **THEN** 前端提交 `{ package_id, remove: true }`
- **AND** 页面使用接口返回的完整授权详情刷新套餐列表
#### Scenario: 套餐管理响应结构保持不变
- **WHEN** 套餐批量管理接口成功
- **THEN** 前端按详情响应读取授权基本信息、佣金配置、强充配置、`packages[]`、状态和时间字段
- **AND** 不要求后端返回新的响应包装结构

View File

@@ -0,0 +1,26 @@
## 1. API And Types
- [x] 1.1 按 21 号接口文档核对代理系列授权列表、创建、详情、更新和套餐管理的请求响应类型。
- [x] 1.2 将创建请求的 `packages` 定义为必填,并补充套餐 1100 项及套餐 ID 不重复的约束说明。
- [x] 1.3 明确 `GrantPackageItem.remove` 仅用于后续套餐删除,保留完整授权详情响应类型。
## 2. Candidate State Merge
- [x] 2.1 在创建授权页面按 `package_id` 合并套餐候选列表和当前选择状态。
- [x] 2.2 在授权详情页面按 `package_id` 合并套餐列表候选和详情中的已授权套餐,已授权套餐必须保留在合并结果中。
- [x] 2.3 在独立授权套餐列表页面复用同一状态规则,避免候选套餐和已授权套餐重复或丢失。
## 3. Create And Manage Packages
- [x] 3.1 创建授权提交前校验套餐数量为 1100且套餐 ID 不重复。
- [x] 3.2 创建授权始终提交 `packages[]`,禁止空数组或缺失套餐列表提交。
- [x] 3.3 新增或调价继续提交套餐项和成本价;删除只提交 `remove: true`,不调用独立删除接口。
- [x] 3.4 套餐管理成功后使用后端返回的完整授权详情刷新页面,不前端重算响应结构。
## 4. Verification
- [x] 4.1 验证创建 1 个套餐成功,创建 0 个、101 个和重复套餐被阻止。
- [x] 4.2 验证套餐候选与授权详情合并后,已授权状态、成本价和生效条件展示正确。
- [x] 4.3 验证新增、调价和 `remove=true` 删除均使用套餐管理接口。
- [x] 4.4 验证接口成功响应仍按完整授权详情结构处理。
- [x] 4.5 运行类型检查、lint 和构建。