feat(contracts): site center schemas, endpoints and migration 0031
Site health/proxy, SiteAccount login state (challenge, lastLoginAt, lastError, userData), SiteUserData history table, SiteCredentialsBody by kind, refresh-login/health-check/user-data/delete endpoints, SitesSettings defaults. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
rootandClaude Opus 5.5 committed
1 parent
381791cd64
commit
e2d1e21968
7 files changed
+458
-31
No files matched your search
@@ -1,5 +1,5 @@
|
||||
import { z } from "zod";
|
||||
import { EntityBase, Id, JsonObject, NonNegInt, SERVER_MANAGED, Timestamp } from "./common.ts";
|
||||
import { CursorQuery, DateOnly, EntityBase, Id, JsonObject, NonNegInt, SERVER_MANAGED, Timestamp } from "./common.ts";
|
||||
|
||||
// 来源域:站点、站点账号、Feed、站点资源、观察(REQ §4)
|
||||
// 含 passkey 的 Feed URL 只以 urlSecretRef 保存,对外只给脱敏的 urlDisplay。
|
||||
@@ -20,6 +20,16 @@ export const SiteRateLimit = z.object({
|
||||
});
|
||||
export type SiteRateLimit = z.infer<typeof SiteRateLimit>;
|
||||
|
||||
/** 站点行 last_health:最近一次健康检测结果 */
|
||||
export const SiteLastHealth = z.object({
|
||||
ok: z.boolean(),
|
||||
/** ok / auth_missing / auth_expired / auth_invalid / rate_limited / unreachable / site_maintenance / parse_error */
|
||||
status: z.string(),
|
||||
latencyMs: z.number().int().nonnegative().nullable(),
|
||||
message: z.string().nullable(),
|
||||
});
|
||||
export type SiteLastHealth = z.infer<typeof SiteLastHealth>;
|
||||
|
||||
export const Site = EntityBase.extend({
|
||||
key: z.string().regex(/^[a-z][a-z0-9_-]*$/),
|
||||
name: z.string().min(1),
|
||||
@@ -35,6 +45,11 @@ export const Site = EntityBase.extend({
|
||||
snapshotIntervalSec: z.number().int().positive().nullable(),
|
||||
lastSnapshotAt: Timestamp.nullable(),
|
||||
snapshotCursor: JsonObject,
|
||||
/** 最近一次健康检测(手动或定时 sites.healthCheck);从未检测为 null */
|
||||
lastHealth: SiteLastHealth.nullable(),
|
||||
lastHealthAt: Timestamp.nullable(),
|
||||
/** 使用全局代理(settings.sites.proxyUrl) */
|
||||
proxy: z.boolean(),
|
||||
});
|
||||
export type Site = z.infer<typeof Site>;
|
||||
export const SiteCreate = Site.pick({
|
||||
@@ -47,34 +62,235 @@ export const SiteCreate = Site.pick({
|
||||
config: true,
|
||||
snapshotEnabled: true,
|
||||
snapshotIntervalSec: true,
|
||||
}).partial({ enabled: true, rateLimit: true, config: true, snapshotEnabled: true, snapshotIntervalSec: true });
|
||||
proxy: true,
|
||||
}).partial({
|
||||
enabled: true,
|
||||
rateLimit: true,
|
||||
config: true,
|
||||
snapshotEnabled: true,
|
||||
snapshotIntervalSec: true,
|
||||
proxy: true,
|
||||
});
|
||||
export type SiteCreate = z.infer<typeof SiteCreate>;
|
||||
export const SiteUpdate = SiteCreate.omit({ key: true }).partial();
|
||||
export type SiteUpdate = z.infer<typeof SiteUpdate>;
|
||||
|
||||
export const SiteAuthKind = z.enum(["cookie", "passkey", "api_key", "password"]);
|
||||
export type SiteAuthKind = z.infer<typeof SiteAuthKind>;
|
||||
export const SiteAccountStatus = z.enum(["unknown", "active", "invalid", "expired"]);
|
||||
/**
|
||||
* 账号登录状态(site-center §4.6):unknown 未验证 → active 正常;expired 失效(自动重登也失败);
|
||||
* invalid 密码错 / 封禁;challenge 需人工验证(验证码 / 二次验证 / Cloudflare)。
|
||||
*/
|
||||
export const SiteAccountStatus = z.enum(["unknown", "active", "invalid", "expired", "challenge"]);
|
||||
export type SiteAccountStatus = z.infer<typeof SiteAccountStatus>;
|
||||
|
||||
/** 登录 / 校验失败的分类(NexusPHP takelogin、Cookie / API Key 校验) */
|
||||
export const SiteLoginFailureReason = z.enum([
|
||||
"captcha",
|
||||
"two_factor",
|
||||
"bad_credentials",
|
||||
"account_blocked",
|
||||
"challenge",
|
||||
"auth_expired",
|
||||
"network",
|
||||
"unsupported",
|
||||
"unknown",
|
||||
]);
|
||||
export type SiteLoginFailureReason = z.infer<typeof SiteLoginFailureReason>;
|
||||
|
||||
export const SiteAccountError = z.object({
|
||||
reason: SiteLoginFailureReason,
|
||||
/** 中文一句;站点原文截 200 字 */
|
||||
message: z.string(),
|
||||
at: Timestamp,
|
||||
});
|
||||
export type SiteAccountError = z.infer<typeof SiteAccountError>;
|
||||
|
||||
/**
|
||||
* 站点用户数据(refreshSiteUserData 的 SiteUserInfo 去掉 raw / 消息正文 / 做种明细)。
|
||||
* 字节数为 number;ratio null = 站点未给且无法计算;download=0 时前端显示 ∞。
|
||||
* bonus null = 站点不提供魔力;vip null = 无法判定(不显示)。
|
||||
*/
|
||||
export const SiteAccountUserData = z.object({
|
||||
schema: z.string().nullable(),
|
||||
userId: z.string().nullable(),
|
||||
username: z.string().nullable(),
|
||||
userLevel: z.string().nullable(),
|
||||
vip: z.boolean().nullable(),
|
||||
joinAt: z.string().nullable(),
|
||||
upload: z.number().nonnegative(),
|
||||
download: z.number().nonnegative(),
|
||||
ratio: z.number().nullable(),
|
||||
bonus: z.number().nullable(),
|
||||
seeding: NonNegInt,
|
||||
seedingSize: z.number().nonnegative(),
|
||||
leeching: NonNegInt,
|
||||
leechingSize: z.number().nonnegative(),
|
||||
messageUnread: NonNegInt,
|
||||
});
|
||||
export type SiteAccountUserData = z.infer<typeof SiteAccountUserData>;
|
||||
|
||||
export const SiteAccount = EntityBase.extend({
|
||||
siteId: Id,
|
||||
label: z.string().min(1),
|
||||
/** 主凭证类型;passkey 另见 hasPasskey */
|
||||
authKind: SiteAuthKind,
|
||||
secretRef: Id.nullable(),
|
||||
enabled: z.boolean(),
|
||||
status: SiteAccountStatus,
|
||||
lastVerifiedAt: Timestamp.nullable(),
|
||||
/** @deprecated 只读兼容一版;登录名见 loginName,用户数据见 userData */
|
||||
userInfo: JsonObject,
|
||||
/** 账密登录名 */
|
||||
loginName: z.string().nullable(),
|
||||
/** 空 = 全局默认 UA(settings.sites.userAgent) */
|
||||
userAgent: z.string().nullable(),
|
||||
/** 最近一次登录 / 校验成功(Cookie、API Key 校验成功也算) */
|
||||
lastLoginAt: Timestamp.nullable(),
|
||||
lastError: SiteAccountError.nullable(),
|
||||
/** 最近一次成功的用户数据;从未成功为 null */
|
||||
userData: SiteAccountUserData.nullable(),
|
||||
userDataAt: Timestamp.nullable(),
|
||||
hasTotp: z.boolean(),
|
||||
/** 账密登录得到的会话 Cookie 已保存 */
|
||||
hasSession: z.boolean(),
|
||||
hasPasskey: z.boolean(),
|
||||
});
|
||||
export type SiteAccount = z.infer<typeof SiteAccount>;
|
||||
/** @deprecated 新客户端用 PUT /sites/{id}/credentials(SiteCredentialsBody) */
|
||||
export const SiteAccountCreate = SiteAccount.pick({ siteId: true, label: true, authKind: true, enabled: true })
|
||||
.partial({ enabled: true })
|
||||
.extend({ credential: z.string().min(1).max(16384) });
|
||||
export type SiteAccountCreate = z.infer<typeof SiteAccountCreate>;
|
||||
/** @deprecated 凭证部分改走 PUT /sites/{id}/credentials;label / enabled 仍可用 */
|
||||
export const SiteAccountUpdate = SiteAccountCreate.omit({ siteId: true }).partial();
|
||||
export type SiteAccountUpdate = z.infer<typeof SiteAccountUpdate>;
|
||||
|
||||
// ── W9-A 站点中心(docs/design/site-center.md) ──
|
||||
|
||||
/** POST /sites/{id}/health-check:首页连通 + 登录态 */
|
||||
export const SiteHealthResult = SiteLastHealth.extend({
|
||||
siteId: Id,
|
||||
checkedAt: Timestamp,
|
||||
/** 登录态:true 已登录;false 未登录 / 失效;null 未能判定(网络失败、无凭证) */
|
||||
loggedIn: z.boolean().nullable(),
|
||||
/** 写回后的站点健康 */
|
||||
healthStatus: SiteHealth,
|
||||
});
|
||||
export type SiteHealthResult = z.infer<typeof SiteHealthResult>;
|
||||
|
||||
const CredLabel = z.string().min(1).max(80).default("default");
|
||||
const CredSecret = z.string().min(1).max(16384);
|
||||
const CredUa = z.string().min(1).max(500);
|
||||
/**
|
||||
* PUT /sites/{id}/credentials 新格式(按 kind 判别)。按 (siteId, label) 建立或更新账号;明文加密为 secret,不回显。
|
||||
* 更新凭证:账号回到 unknown,关闭该站 site-auth / site-login 待处理。
|
||||
*/
|
||||
export const SiteCredentialsBody = z.discriminatedUnion("kind", [
|
||||
z.object({
|
||||
kind: z.literal("password"),
|
||||
label: CredLabel,
|
||||
username: z.string().min(1).max(200),
|
||||
password: CredSecret,
|
||||
/** TOTP 密钥(base32);表单有二次验证字段时自动填当前 6 位码 */
|
||||
totpSecret: z.string().min(1).max(200).optional(),
|
||||
/** 只换 Cookie:登录成功后凭证类型落为 cookie,密码与 TOTP 丢弃 */
|
||||
saveCookieOnly: z.boolean().optional(),
|
||||
userAgent: CredUa.optional(),
|
||||
enabled: z.boolean().optional(),
|
||||
}),
|
||||
z.object({
|
||||
kind: z.literal("cookie"),
|
||||
label: CredLabel,
|
||||
cookie: CredSecret,
|
||||
userAgent: CredUa.optional(),
|
||||
enabled: z.boolean().optional(),
|
||||
}),
|
||||
z.object({ kind: z.literal("api_key"), label: CredLabel, apiKey: CredSecret, enabled: z.boolean().optional() }),
|
||||
/** passkey 附加到同账号(RSS / 下载用,不参与登录);账号不存在时新建 passkey 型账号 */
|
||||
z.object({ kind: z.literal("passkey"), label: CredLabel, passkey: CredSecret, enabled: z.boolean().optional() }),
|
||||
]);
|
||||
export type SiteCredentialsBody = z.infer<typeof SiteCredentialsBody>;
|
||||
|
||||
/** POST /sites/{id}/refresh-login */
|
||||
export const SiteRefreshLoginInput = z.object({
|
||||
/** 缺省:该站第一个启用账号 */
|
||||
accountId: Id.optional(),
|
||||
/** true:同步执行并返回结果(≤ 30 s,添加站点第 ③ 步用);缺省异步入队返回 taskId */
|
||||
wait: z.boolean().optional(),
|
||||
});
|
||||
export type SiteRefreshLoginInput = z.infer<typeof SiteRefreshLoginInput>;
|
||||
|
||||
export const SiteLoginResult = z.object({
|
||||
siteId: Id,
|
||||
accountId: Id,
|
||||
ok: z.boolean(),
|
||||
/** 处理后的账号状态;网络失败时不变 */
|
||||
status: SiteAccountStatus,
|
||||
reason: SiteLoginFailureReason.nullable(),
|
||||
message: z.string().nullable(),
|
||||
/** 成功时的用户数据(拉取失败为 null,不影响登录结果) */
|
||||
userData: SiteAccountUserData.nullable(),
|
||||
/** 失败时开出的待处理事项 */
|
||||
decisionId: Id.nullable(),
|
||||
});
|
||||
export type SiteLoginResult = z.infer<typeof SiteLoginResult>;
|
||||
export const SiteRefreshLoginAccepted = z.object({
|
||||
/** 异步时的引擎任务 ID;wait=true 为 null */
|
||||
taskId: Id.nullable(),
|
||||
/** wait=true 时的结果 */
|
||||
result: SiteLoginResult.nullable(),
|
||||
});
|
||||
export type SiteRefreshLoginAccepted = z.infer<typeof SiteRefreshLoginAccepted>;
|
||||
|
||||
/** site_user_data 表行:用户数据按天一行(同日 upsert 取最新),随账号删除 */
|
||||
export const SiteUserData = EntityBase.extend({
|
||||
siteAccountId: Id,
|
||||
day: DateOnly,
|
||||
upload: z.number().nonnegative(),
|
||||
download: z.number().nonnegative(),
|
||||
ratio: z.number().nullable(),
|
||||
bonus: z.number().nullable(),
|
||||
seeding: NonNegInt,
|
||||
seedingSize: z.number().nonnegative(),
|
||||
leeching: NonNegInt,
|
||||
userLevel: z.string().nullable(),
|
||||
vip: z.boolean().nullable(),
|
||||
messageUnread: NonNegInt,
|
||||
joinAt: z.string().nullable(),
|
||||
/** SiteUserInfo 其余字段(不含凭据、消息正文、做种明细) */
|
||||
raw: JsonObject,
|
||||
capturedAt: Timestamp,
|
||||
});
|
||||
export type SiteUserData = z.infer<typeof SiteUserData>;
|
||||
/** GET /sites/{id}/user-data 的一点 */
|
||||
export const SiteUserDataPoint = SiteUserData.omit({
|
||||
id: true,
|
||||
createdAt: true,
|
||||
updatedAt: true,
|
||||
raw: true,
|
||||
joinAt: true,
|
||||
});
|
||||
export type SiteUserDataPoint = z.infer<typeof SiteUserDataPoint>;
|
||||
export const SiteUserDataQuery = z.object({
|
||||
accountId: Id.optional(),
|
||||
days: z.coerce.number().int().min(1).max(400).default(30),
|
||||
});
|
||||
export type SiteUserDataQuery = z.infer<typeof SiteUserDataQuery>;
|
||||
|
||||
/** 站点整体账号状态:多账号取最差;无启用账号 = unconfigured */
|
||||
export const SiteAccountOverall = z.enum(["unconfigured", ...SiteAccountStatus.options]);
|
||||
export type SiteAccountOverall = z.infer<typeof SiteAccountOverall>;
|
||||
|
||||
/** GET /sites?include=accounts 的条目(不带 include 时两个附加字段缺省) */
|
||||
export const SiteListItem = Site.extend({
|
||||
accounts: z.array(SiteAccount).optional(),
|
||||
accountStatus: SiteAccountOverall.optional(),
|
||||
});
|
||||
export type SiteListItem = z.infer<typeof SiteListItem>;
|
||||
export const SiteListQuery = CursorQuery.extend({ include: z.enum(["accounts"]).optional() });
|
||||
export type SiteListQuery = z.infer<typeof SiteListQuery>;
|
||||
|
||||
export const FeedPurpose = z.enum(["movie", "series", "variety", "promotion", "search", "generic"]);
|
||||
export type FeedPurpose = z.infer<typeof FeedPurpose>;
|
||||
export const FeedKind = z.enum(["rss", "atom", "list", "query"]);
|
||||
|
||||
Reference in new issue
Block a user