rootandClaude Fable 5.1
cc8b3a7df4
- migrations 0002-0012 split by domain (foundation/instances/content/identity/ sources/assets/policy/execution/agent/ops/organization): 41 tables, uuid pk, created_at/updated_at + touch trigger, text+CHECK status sets, pgcrypto/pg_trgm - key constraints: source_release(site_id, site_release_id), observation(feed_id, guid), external_identity accepted partial unique, download_task(instance_id, torrent_hash), one active acquisition_plan per slot, one active path_binding per entity/season, asset_location root+path uniqueness, organization_record change_seq/change_xid cursor - secret table (ciphertext/nonce/kdf) + secret_ref columns; outbox dispatch fields (ADR-002) - src/types.ts generated from the migrated schema (scripts/gen-types.ts), drift-checked in tests; int8 -> number, date -> string parsers; migrator accepts migrationTableSchema - contracts: Row/Create/Update schemas per domain, public organization-record API (changeSeq cursor), GlobalSettings, CapabilityDescriptor + 14 capability IO schemas, typed SSE events, Api endpoint table - tests: migration up/down round trip on real PG in an isolated schema, constraint checks, contracts<->db column/enum sync, positive/negative parse for every exported schema Co-Authored-By: Claude Fable 5.1 <[email protected]>
123 lines
3.6 KiB
TypeScript
123 lines
3.6 KiB
TypeScript
import { z } from "zod";
|
|
|
|
/** 本地实体 ID 一律 UUID */
|
|
export const Id = z.uuid();
|
|
export type Id = z.infer<typeof Id>;
|
|
|
|
/** ISO 8601 时间串 */
|
|
export const Timestamp = z.iso.datetime({ offset: true });
|
|
export type Timestamp = z.infer<typeof Timestamp>;
|
|
|
|
/** 游标分页请求:cursor 为不透明字符串,由服务端编码 */
|
|
export const CursorQuery = z.object({
|
|
cursor: z.string().min(1).optional(),
|
|
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
});
|
|
export type CursorQuery = z.infer<typeof CursorQuery>;
|
|
|
|
/** 游标分页结果:nextCursor 为 null 表示已到末尾 */
|
|
export const cursorPage = <T extends z.ZodType>(item: T) =>
|
|
z.object({
|
|
items: z.array(item),
|
|
nextCursor: z.string().nullable(),
|
|
});
|
|
export type CursorPage<T> = { items: T[]; nextCursor: string | null };
|
|
|
|
/** 错误码表:新增错误码只在这里加 */
|
|
export const ApiErrorCode = z.enum([
|
|
"bad_request",
|
|
"validation_failed",
|
|
"unauthorized",
|
|
"forbidden",
|
|
"not_found",
|
|
"conflict",
|
|
"precondition_failed",
|
|
"rate_limited",
|
|
"automation_disabled",
|
|
"upstream_unavailable",
|
|
"internal",
|
|
]);
|
|
export type ApiErrorCode = z.infer<typeof ApiErrorCode>;
|
|
|
|
/** 错误码对应的 HTTP 状态 */
|
|
export const API_ERROR_STATUS = {
|
|
bad_request: 400,
|
|
validation_failed: 422,
|
|
unauthorized: 401,
|
|
forbidden: 403,
|
|
not_found: 404,
|
|
conflict: 409,
|
|
precondition_failed: 412,
|
|
rate_limited: 429,
|
|
automation_disabled: 423,
|
|
upstream_unavailable: 502,
|
|
internal: 500,
|
|
} as const satisfies Record<ApiErrorCode, number>;
|
|
|
|
export const ApiError = z.object({
|
|
code: ApiErrorCode,
|
|
message: z.string(),
|
|
});
|
|
export type ApiError = z.infer<typeof ApiError>;
|
|
|
|
/** 统一响应信封 */
|
|
export const apiResponse = <T extends z.ZodType>(data: T) =>
|
|
z.object({
|
|
ok: z.boolean(),
|
|
data: data.optional(),
|
|
error: ApiError.optional(),
|
|
});
|
|
export type ApiResponse<T> =
|
|
| { ok: true; data: T; error?: undefined }
|
|
| { ok: false; data?: undefined; error: ApiError };
|
|
|
|
/** 没有 data 的失败响应 schema(OpenAPI 错误分支用) */
|
|
export const ApiErrorResponse = z.object({
|
|
ok: z.literal(false),
|
|
error: ApiError,
|
|
});
|
|
|
|
/** API Key 权限范围 */
|
|
export const ApiScope = z.enum(["read", "organize.read", "organize.execute", "admin"]);
|
|
export type ApiScope = z.infer<typeof ApiScope>;
|
|
|
|
/** 健康检查 */
|
|
export const HealthStatus = z.object({
|
|
status: z.enum(["ok", "degraded"]),
|
|
version: z.string(),
|
|
role: z.enum(["api", "worker", "all"]),
|
|
uptimeSec: z.number(),
|
|
db: z.enum(["ok", "down", "unknown"]),
|
|
time: Timestamp,
|
|
});
|
|
export type HealthStatus = z.infer<typeof HealthStatus>;
|
|
|
|
/** 日期(无时区),如 air_date:YYYY-MM-DD */
|
|
export const DateOnly = z.iso.date();
|
|
export type DateOnly = z.infer<typeof DateOnly>;
|
|
|
|
/** JSONB 对象列(证据、规则参数、原文快照等)的 API 表示 */
|
|
export const JsonObject = z.record(z.string(), z.unknown());
|
|
export type JsonObject = z.infer<typeof JsonObject>;
|
|
|
|
/** 字节数、计数等非负整数(DB 为 bigint,客户端按 number 解析,上限 2^53) */
|
|
export const NonNegInt = z.number().int().nonnegative();
|
|
|
|
/** 操作者类型:与 DB 中 actor_type 列一致 */
|
|
export const ActorType = z.enum(["user", "agent", "system", "api_key"]);
|
|
export type ActorType = z.infer<typeof ActorType>;
|
|
|
|
/** 实体行的公共字段 */
|
|
export const EntityBase = z.object({
|
|
id: Id,
|
|
createdAt: Timestamp,
|
|
updatedAt: Timestamp,
|
|
});
|
|
|
|
/** 所有实体 Create 输入都要剔除的服务端字段 */
|
|
export const SERVER_MANAGED = { id: true, createdAt: true, updatedAt: true } as const;
|
|
|
|
/** 路径参数 `{id}` */
|
|
export const IdParam = z.object({ id: Id });
|
|
export type IdParam = z.infer<typeof IdParam>;
|