API:src/api/frontconfig/frontConfig.ts 新增 getInfo/saveInfo/getDomain/setDomain/checkDomain/getCert/saveCert 及类型、FRONT_DOMAIN_STATUS 常量;移除被取代的 setting.warehouse.getFrontConfig/saveFrontConfig/saveFrontCert 封装与类型。 页面:FrontConfigForm.vue 改为左菜单(域名设置 / HTTPS 证书 / 品牌配置)+ 右内容布局;域名段支持保存域名、TXT 主机名与记录值复制、校验 DNS、刷新状态;证书段 saveCert 不再提交 domain,按 getCert 的 can_set_cert/can_set_cert_reason 置灰上传并展示同步状态;品牌段展示 updated_at。 请求层:request.ts 新增请求级 silentError(静默失败不弹全局提示,token 失效逻辑不受影响);frontConfig.getByDomain 静默失败(未登记/未验证域名 404「域名未配置」属预期);frontBrand 失败改为仅开发环境 debug 日志,并新增并发去重。 文档:前端独立部署操作与部署说明、接口落实任务清单同步新口径(8 接口矩阵与 2026-09-24 流程更正章节)。
218 lines
9.2 KiB
TypeScript
218 lines
9.2 KiB
TypeScript
import request from '@/utils/request'
|
||
|
||
const v = '1.0'
|
||
|
||
/** 请求选项:silentError=true 时全局拦截器不弹错误提示(公共品牌拉取失败属预期分支) */
|
||
export type FrontConfigRequestOptions = { silentError?: boolean }
|
||
|
||
/** frontConfig.* 统一 POST 入口(系统标准入口 /system,method 经 params 下发) */
|
||
function postFrontConfig<T = Record<string, unknown>>(
|
||
method: string,
|
||
data: Record<string, unknown> = {},
|
||
options: FrontConfigRequestOptions = {}
|
||
): Promise<T & { code?: number; message?: string }> {
|
||
return request({
|
||
url: '/system',
|
||
method: 'post',
|
||
params: {
|
||
method,
|
||
v,
|
||
timestamp: new Date().getTime()
|
||
},
|
||
data,
|
||
isSystemApi: true,
|
||
...(options.silentError ? { silentError: true } : {})
|
||
} as any)
|
||
}
|
||
|
||
/** 域名验证状态:0 未验证 / 1 已验证 / 2 验证失败 */
|
||
export const FRONT_DOMAIN_STATUS = {
|
||
/** 未验证(已生成 TXT 校验记录,等待校验) */
|
||
unverified: 0,
|
||
/** 已验证(唯一可上传证书的状态) */
|
||
verified: 1,
|
||
/** 验证失败 */
|
||
failed: 2
|
||
} as const
|
||
|
||
/** frontConfig.getByDomain 响应:仓库前端公开品牌配置(不含证书/同步等内部字段) */
|
||
export type FrontConfigPublicItem = {
|
||
/** 仓库自持域名 */
|
||
domain?: string
|
||
/** 站点标题(未配置为空字符串) */
|
||
title?: string
|
||
/** Logo 地址(未配置为空字符串) */
|
||
logo_url?: string
|
||
/** 登录页背景图地址(未配置为空字符串) */
|
||
login_bg_url?: string
|
||
/** 站点 favicon 图标地址(未配置为空字符串) */
|
||
favicon_url?: string
|
||
/** 主题配置对象(未配置为 null) */
|
||
theme?: Record<string, unknown> | null
|
||
/** 未登记域名时为 false(并返回 404) */
|
||
configured?: boolean
|
||
[key: string]: unknown
|
||
}
|
||
|
||
/** frontConfig.getInfo / saveInfo 响应:当前仓库品牌配置(8 字段,不含证书/私钥/证书路径/同步等内部字段) */
|
||
export type FrontConfigInfo = {
|
||
warehouse_id?: number
|
||
/** 仓库自持域名(未设置为空字符串) */
|
||
domain?: string
|
||
/** 站点标题(未配置为空字符串) */
|
||
title?: string
|
||
logo_url?: string
|
||
login_bg_url?: string
|
||
favicon_url?: string
|
||
/** 主题配置对象(未配置为 null) */
|
||
theme?: Record<string, unknown> | string | null
|
||
updated_at?: string | null
|
||
[key: string]: unknown
|
||
}
|
||
|
||
/** frontConfig.saveInfo 入参:仅受理品牌字段,其余(domain/证书相关)由后端白名单静默忽略 */
|
||
export type FrontConfigSaveInfoParams = {
|
||
/** 站点标题(≤100,空值清空) */
|
||
title?: string
|
||
/** Logo 地址(≤255,空值清空) */
|
||
logo_url?: string
|
||
/** 站点 favicon 地址(≤255,空值清空) */
|
||
favicon_url?: string
|
||
/** 登录页背景图地址(≤255,空值清空) */
|
||
login_bg_url?: string
|
||
/** 主题配置(合法 JSON 对象或 JSON 字符串;空值清空) */
|
||
theme?: Record<string, unknown> | string | null
|
||
}
|
||
|
||
/** frontConfig.getDomain / setDomain 响应:域名与 DNS TXT 归属验证状态(9 字段) */
|
||
export type FrontConfigDomain = {
|
||
warehouse_id?: number
|
||
domain?: string
|
||
/** 0 未验证 / 1 已验证 / 2 验证失败 */
|
||
domain_status?: number
|
||
/** 待添加的 TXT 记录主机名(如 wmsv-xxxxxxxxxx.<domain>);domain_status=1 时返回空字符串 */
|
||
verify_host?: string
|
||
/** 待添加的 TXT 记录值(32 位 hex);domain_status=1 时返回空字符串 */
|
||
verify_value?: string
|
||
/** CNAME 目标(前端部署需解析到该地址,由后端配置下发) */
|
||
cname?: string
|
||
/** 验证通过时间(未验证为 null) */
|
||
verified_at?: string | null
|
||
/** 校验尝试次数 */
|
||
attempts?: number
|
||
/** 最近一次校验失败原因(脱敏截断;未失败为空字符串) */
|
||
last_error?: string
|
||
[key: string]: unknown
|
||
}
|
||
|
||
/** frontConfig.checkDomain 响应:getDomain 的 9 字段 + 本次校验结果 */
|
||
export type FrontConfigCheckDomainResult = FrontConfigDomain & {
|
||
/** 本次校验是否通过 */
|
||
verified?: boolean
|
||
/** 本次解析到的 TXT 值(最多 5 条,排障用) */
|
||
resolved_values?: string[]
|
||
}
|
||
|
||
/** frontConfig.getCert / saveCert 响应:证书与同步元信息(13 字段,不含 cert_path/key_path) */
|
||
export type FrontConfigCert = {
|
||
warehouse_id?: number
|
||
domain?: string
|
||
/** 证书 PEM 原文(未配置为空字符串;仅仓库主体 settings 页回显,公共接口 getByDomain 不返回) */
|
||
cert_pem?: string
|
||
/** 私钥 PEM 原文(读 cert_key 列;仅仓库主体 settings 页回显,禁止外泄或写入日志) */
|
||
key_pem?: string
|
||
/** 证书到期时间(按证书 validTo 权威写入;未上传为 null) */
|
||
cert_expire_at?: string | null
|
||
sync_status?: number
|
||
sync_attempts?: number
|
||
last_sync_error?: string
|
||
last_synced_at?: string | null
|
||
updated_at?: string | null
|
||
/** 是否允许上传证书:仅 domain 非空且 domain_status=1(已验证)时为 true */
|
||
can_set_cert?: boolean
|
||
/** 不可上传原因(无域名「请先设置域名」/ 未验证「域名待验证」/ 失败「域名验证失败」) */
|
||
can_set_cert_reason?: string
|
||
/** 域名验证状态(0 未验证 / 1 已验证 / 2 验证失败) */
|
||
domain_status?: number
|
||
[key: string]: unknown
|
||
}
|
||
|
||
/** frontConfig.saveCert 入参:域名不再作为入参(一律取库内已设置并验证通过的 domain) */
|
||
export type FrontConfigSaveCertParams = {
|
||
/** 证书 PEM 文本(必填 ≤65536,须可解析 X.509、未过期且 SAN/CN 覆盖库内 domain) */
|
||
pem: string
|
||
/** 私钥 PEM 文本(必填 ≤65536,须与 pem 成对,SPKI 公钥指纹比对) */
|
||
key: string
|
||
}
|
||
|
||
/**
|
||
* 按域名拉取仓库前端公开配置(公共接口:免登录、免鉴权、免权限)。
|
||
* 仅放行已验证域名(查库条件 domain + domain_status=1):未验证/验证失败的域名一律按未配置返回 404「域名未配置」。
|
||
* 未登记/未验证域名属预期分支,**静默失败**(silentError,不弹全局错误提示),由调用方回退默认品牌。
|
||
* Redis 缓存 front:config:domain:{domain},命中 TTL 600s;未登记域名写空缓存 60s 防穿透。
|
||
*/
|
||
export function frontConfigGetByDomain(data: {
|
||
/** 待查询域名(必填,≤100 字符) */
|
||
domain: string
|
||
}): Promise<FrontConfigPublicItem & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigPublicItem>('frontConfig.getByDomain', data, { silentError: true })
|
||
}
|
||
|
||
/** 查询当前仓库前端独立部署品牌配置(settings 页回显;需登录、仅仓库主体可调用;未配置返回默认空值,不 404) */
|
||
export function frontConfigGetInfo(): Promise<FrontConfigInfo & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigInfo>('frontConfig.getInfo')
|
||
}
|
||
|
||
/** 保存当前仓库品牌配置(upsert 部分更新;仅受理 title/logo_url/favicon_url/login_bg_url/theme;保存即重置同步状态并清公共缓存) */
|
||
export function frontConfigSaveInfo(
|
||
data: FrontConfigSaveInfoParams = {}
|
||
): Promise<FrontConfigInfo & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigInfo>('frontConfig.saveInfo', data)
|
||
}
|
||
|
||
/** 查询当前仓库域名与 DNS TXT 验证状态(settings 页回显;未设置过返回默认空值,不 404) */
|
||
export function frontConfigGetDomain(): Promise<FrontConfigDomain & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigDomain>('frontConfig.getDomain')
|
||
}
|
||
|
||
/**
|
||
* 设置或变更当前仓库域名并发起 DNS TXT 归属验证(生成 verify_host/verify_value,domain_status 置 0)。
|
||
* 注意:域名变更会同时清空既有证书并重置同步状态,需重新上传证书;域名全局唯一(被占用返回 409)。
|
||
*/
|
||
export function frontConfigSetDomain(data: {
|
||
/** 自持域名(必填 ≤100,统一转小写存储,全局唯一) */
|
||
domain: string
|
||
}): Promise<FrontConfigDomain & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigDomain>('frontConfig.setDomain', data)
|
||
}
|
||
|
||
/** 主动校验域名 DNS TXT 归属记录并回写库(成功→domain_status=1 并清理该域名公共缓存;失败→domain_status=2) */
|
||
export function frontConfigCheckDomain(): Promise<
|
||
FrontConfigCheckDomainResult & { code?: number; message?: string }
|
||
> {
|
||
return postFrontConfig<FrontConfigCheckDomainResult>('frontConfig.checkDomain')
|
||
}
|
||
|
||
/** 查询当前仓库证书配置(settings 页回显;含 cert_pem/key_pem 原文与 can_set_cert/can_set_cert_reason/domain_status) */
|
||
export function frontConfigGetCert(): Promise<FrontConfigCert & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigCert>('frontConfig.getCert')
|
||
}
|
||
|
||
/** 上传当前仓库证书(域名取库内已验证 domain,不再传参;无域名/未验证返回 400,证书不合法统一 400「证书不合法」) */
|
||
export function frontConfigSaveCert(
|
||
data: FrontConfigSaveCertParams
|
||
): Promise<FrontConfigCert & { code?: number; message?: string }> {
|
||
return postFrontConfig<FrontConfigCert>('frontConfig.saveCert', data)
|
||
}
|
||
|
||
export const frontConfig = {
|
||
getByDomain: frontConfigGetByDomain,
|
||
getInfo: frontConfigGetInfo,
|
||
saveInfo: frontConfigSaveInfo,
|
||
getDomain: frontConfigGetDomain,
|
||
setDomain: frontConfigSetDomain,
|
||
checkDomain: frontConfigCheckDomain,
|
||
getCert: frontConfigGetCert,
|
||
saveCert: frontConfigSaveCert
|
||
}
|