契约:三个端与路由归属(access 必填)、Principal / 角色→端 / 名册同步 schema、退役路由标 @deprecated(ADR-012)

- packages/contracts/src/api/http.ts:新增 SURFACES / surfaceSchema / Surface / SURFACE_LABEL /
  RouteAccess;RouteContract.access 必填;API_ERROR_CODES 增 'gone'。
- packages/contracts/src/org.ts:staffSchema 补 email? / roles(realm 角色快照);新增
  principalSchema/Principal、roleAccessSchema/RoleAccess、rosterSyncOutcomeSchema/RosterSyncOutcome、
  inFlightWorkSchema/InFlightWork;旧岗位授权(grant* / governanceFunction*)与 sessionSchema/Session
  全部标 @deprecated 留一轮(web 编译不受影响,下个迭代删)。
- workbench.ts / governance.ts / ingest.ts:每条既有路由补 access(按所属端/两端共用/退役 public);
  新增 meRoute、authTicketRoute(access:'any')与 syncStaffRoute、setStaffPositionRoute、
  staffInFlightRoute、listRoleAccessRoute、setRoleAccessRoute、deleteRoleAccessRoute(access:'ops')。
- apps/api 的 org-service.ts 两处 staff.insert 补 roles: [](staffSchema 新必填字段,该文件下个
  迭代会整份替换,这里只是让本次 typecheck 过)。
- 新增 packages/contracts/src/__tests__/route-access.test.ts:95 条路由的 access 归属断言。

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015kAzS35kMnZNt4YGgJXtfw
This commit is contained in:
xcs
2026-08-25 15:54:20 +08:00
co-authored by Claude Opus 5
parent 61f96d5ab2
commit a5c8d4786d
13 changed files with 771 additions and 65 deletions
+135 -1
View File
@@ -4,7 +4,17 @@
*/
import { z } from 'zod';
import type { RouteContract } from './http.ts';
import { disableCheckSchema, grantSchema, positionSchema, staffSchema, workGroupSchema } from '../org.ts';
import {
disableCheckSchema,
grantSchema,
inFlightWorkSchema,
positionSchema,
roleAccessSchema,
rosterSyncOutcomeSchema,
staffSchema,
workGroupSchema,
} from '../org.ts';
import { surfaceSchema } from './http.ts';
import { positionIdSchema, staffIdSchema, taskIdSchema } from '../id.ts';
import { ledgerObjectKindSchema } from '../ledger.ts';
import { approvalTemplateSchema, closureReportSchema, processPackageSchema, triggerConfigSchema } from '../process-package.ts';
@@ -17,15 +27,18 @@ import { reportMetricsSchema, reportPeriodSchema } from './workbench.ts';
export const listStaffRoute = {
method: 'GET',
path: '/api/gov/staff',
access: ['design', 'ops'],
output: z.object({
staff: z.array(staffSchema.extend({ position: positionSchema })),
positions: z.array(positionSchema),
}),
} as const satisfies RouteContract;
/** @deprecated 随 ADR-012 退役,后端回 410;人来自 Keycloak,改用 syncStaffRoute */
export const createStaffRoute = {
method: 'POST',
path: '/api/gov/staff',
access: 'public',
body: z.object({
account: z.string().min(1),
name: z.string().min(1),
@@ -34,35 +47,103 @@ export const createStaffRoute = {
output: staffSchema,
} as const satisfies RouteContract;
/** @deprecated 随 ADR-012 退役,后端回 410;改用 staffInFlightRoute */
export const disableStaffCheckRoute = {
method: 'GET',
path: '/api/gov/staff/:staffId/disable-check',
access: 'public',
params: z.object({ staffId: staffIdSchema }),
output: disableCheckSchema,
} as const satisfies RouteContract;
/** @deprecated 随 ADR-012 退役,后端回 410;停用改在 Keycloak 做,名册同步据此落 disabled */
export const disableStaffRoute = {
method: 'POST',
path: '/api/gov/staff/:staffId/disable',
access: 'public',
params: z.object({ staffId: staffIdSchema }),
output: z.object({ ok: z.boolean(), check: disableCheckSchema }),
} as const satisfies RouteContract;
/** @deprecated 随 ADR-012 退役,后端回 410;权限只到端,改用 listRoleAccessRoute */
export const listGrantsRoute = {
method: 'GET',
path: '/api/gov/positions/:positionId/grants',
access: 'public',
params: z.object({ positionId: positionIdSchema }),
output: z.object({ grants: z.array(grantSchema) }),
} as const satisfies RouteContract;
/** @deprecated 随 ADR-012 退役,后端回 410;权限只到端,改用 setRoleAccessRoute */
export const setGrantsRoute = {
method: 'POST',
path: '/api/gov/positions/:positionId/grants',
access: 'public',
params: z.object({ positionId: positionIdSchema }),
body: z.object({ grants: z.array(grantSchema) }),
output: z.object({ grants: z.array(grantSchema) }),
} as const satisfies RouteContract;
/* ── 员工管理 · 名册与岗位(ADR-012:人来自鉴权中心,岗位本地指派) ────── */
/** 从 Keycloak Admin API 同步名册;没配 provisioning 服务账号就如实回 configured:false */
export const syncStaffRoute = {
method: 'POST',
path: '/api/gov/staff/sync',
access: 'ops',
output: rosterSyncOutcomeSchema,
} as const satisfies RouteContract;
/** 指派岗位;指回哨兵岗 NONE = 取消指派 */
export const setStaffPositionRoute = {
method: 'PUT',
path: '/api/gov/staff/:staffId/position',
access: 'ops',
params: z.object({ staffId: staffIdSchema }),
body: z.object({ positionId: positionIdSchema }),
output: staffSchema.extend({ position: positionSchema }),
} as const satisfies RouteContract;
/** 此人身上还挂着什么(只读)—— 原「停用前置检查」;停用本身在 Keycloak 做 */
export const staffInFlightRoute = {
method: 'GET',
path: '/api/gov/staff/:staffId/in-flight',
access: 'ops',
params: z.object({ staffId: staffIdSchema }),
output: inFlightWorkSchema,
} as const satisfies RouteContract;
/* ── 角色 → 端(ADR-012:权限只到端,这张表运营中心可改) ─────────────── */
export const listRoleAccessRoute = {
method: 'GET',
path: '/api/gov/access/roles',
access: 'ops',
output: z.object({
roles: z.array(roleAccessSchema),
/** 名册上见过的角色 ∪ 已配置的角色 —— 配置前它等于「无端可进」 */
knownRoles: z.array(z.string()),
}),
} as const satisfies RouteContract;
/** 锁死不变量不过(改完没人能进运营中心)→ 409 conflict */
export const setRoleAccessRoute = {
method: 'PUT',
path: '/api/gov/access/roles/:role',
access: 'ops',
params: z.object({ role: z.string().min(1) }),
body: z.object({ ends: z.array(surfaceSchema) }),
output: roleAccessSchema,
} as const satisfies RouteContract;
export const deleteRoleAccessRoute = {
method: 'DELETE',
path: '/api/gov/access/roles/:role',
access: 'ops',
params: z.object({ role: z.string().min(1) }),
output: z.object({ ok: z.boolean() }),
} as const satisfies RouteContract;
/* ── 系统管理 · LLM 实例(四元绑定) ────────────────────────────────── */
export const LLM_PROVIDERS = ['openai-compatible', 'openai', 'deepseek', 'anthropic', 'qwen'] as const;
@@ -92,6 +173,7 @@ export type LlmInstanceView = z.infer<typeof llmInstanceViewSchema>;
export const listLlmProvidersRoute = {
method: 'GET',
path: '/api/gov/llm/providers',
access: 'design',
output: z.object({
providers: z.array(
z.object({
@@ -109,12 +191,14 @@ export const listLlmProvidersRoute = {
export const listLlmInstancesRoute = {
method: 'GET',
path: '/api/gov/llm',
access: 'design',
output: z.object({ instances: z.array(llmInstanceViewSchema) }),
} as const satisfies RouteContract;
export const upsertLlmInstanceRoute = {
method: 'POST',
path: '/api/gov/llm',
access: 'design',
body: z.object({
id: z.string().optional(),
name: z.string().min(1),
@@ -142,6 +226,7 @@ export const upsertLlmInstanceRoute = {
export const deleteLlmInstanceRoute = {
method: 'DELETE',
path: '/api/gov/llm/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ ok: z.boolean() }),
} as const satisfies RouteContract;
@@ -149,6 +234,7 @@ export const deleteLlmInstanceRoute = {
export const probeLlmDraftRoute = {
method: 'POST',
path: '/api/gov/llm/probe',
access: 'design',
body: z.object({
id: z.string().optional(),
name: z.string().optional(),
@@ -163,6 +249,7 @@ export const probeLlmDraftRoute = {
export const probeLlmInstanceRoute = {
method: 'POST',
path: '/api/gov/llm/:id/probe',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ ok: z.boolean(), latencyMs: z.number().int().optional(), error: z.string().optional() }),
} as const satisfies RouteContract;
@@ -186,6 +273,7 @@ export type GovTaskRow = z.infer<typeof govTaskRowSchema>;
export const listGovTasksRoute = {
method: 'GET',
path: '/api/gov/tasks',
access: 'ops',
output: z.object({
tasks: z.array(govTaskRowSchema),
workflows: z.array(
@@ -204,6 +292,7 @@ export const listGovTasksRoute = {
export const controlTaskRoute = {
method: 'POST',
path: '/api/gov/tasks/:taskId/control',
access: 'ops',
params: z.object({ taskId: taskIdSchema }),
body: z.object({ semantic: controlSemanticSchema, reason: z.string().optional() }),
output: z.object({ ok: z.boolean(), resumable: z.boolean() }),
@@ -212,6 +301,7 @@ export const controlTaskRoute = {
export const resumeTaskRoute = {
method: 'POST',
path: '/api/gov/tasks/:taskId/resume',
access: 'ops',
params: z.object({ taskId: taskIdSchema }),
output: z.object({ ok: z.boolean(), runtime: taskRuntimeStateSchema }),
} as const satisfies RouteContract;
@@ -220,6 +310,7 @@ export const resumeTaskRoute = {
export const reassignTaskRoute = {
method: 'POST',
path: '/api/gov/tasks/:taskId/reassign',
access: 'ops',
params: z.object({ taskId: taskIdSchema }),
body: z.object({ to: staffIdSchema }),
output: z.object({ ok: z.boolean(), ownerId: staffIdSchema }),
@@ -229,6 +320,7 @@ export const reassignTaskRoute = {
export const govTaskLogRoute = {
method: 'GET',
path: '/api/gov/tasks/:taskId/log',
access: 'ops',
params: z.object({ taskId: taskIdSchema }),
output: z.object({
// 与工作台同一份日志:章是四字动作,内容带主语(见 workbench 的 log 项)
@@ -243,6 +335,7 @@ export const govTaskLogRoute = {
export const listProcessPackagesRoute = {
method: 'GET',
path: '/api/gov/process',
access: ['design', 'ops'],
output: z.object({ packages: z.array(processPackageSchema) }),
} as const satisfies RouteContract;
@@ -257,6 +350,7 @@ export const listProcessPackagesRoute = {
export const saveProcessRoute = {
method: 'PUT',
path: '/api/gov/process',
access: 'design',
/**
* 编辑即其身:pkg.version 已存在 → 就地写回该版(号不变)。
* `asNew: true`(或版本不存在,如新流程首版)→ 产生新版本号(服务端算,不生效)。
@@ -275,6 +369,7 @@ export const saveProcessRoute = {
export const setProcessStateRoute = {
method: 'POST',
path: '/api/gov/process/:id/:version/state',
access: 'design',
params: z.object({ id: z.string(), version: z.string() }),
body: z.object({ state: z.enum(['active', 'retired']) }),
output: z.object({ packages: z.array(processPackageSchema) }),
@@ -288,6 +383,7 @@ export const setProcessStateRoute = {
export const deleteProcessVersionRoute = {
method: 'DELETE',
path: '/api/gov/process/:id/:version',
access: 'design',
params: z.object({ id: z.string(), version: z.string() }),
output: z.object({ packages: z.array(processPackageSchema) }),
} as const satisfies RouteContract;
@@ -298,6 +394,7 @@ export const deleteProcessVersionRoute = {
export const listApprovalTemplatesRoute = {
method: 'GET',
path: '/api/gov/approval-templates',
access: 'design',
output: z.object({
templates: z.array(
approvalTemplateSchema.extend({
@@ -312,6 +409,7 @@ export const listApprovalTemplatesRoute = {
export const upsertApprovalTemplateRoute = {
method: 'PUT',
path: '/api/gov/approval-templates',
access: 'design',
body: z.object({ template: approvalTemplateSchema }),
output: z.object({ template: approvalTemplateSchema }),
} as const satisfies RouteContract;
@@ -320,6 +418,7 @@ export const upsertApprovalTemplateRoute = {
export const deleteApprovalTemplateRoute = {
method: 'DELETE',
path: '/api/gov/approval-templates/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ ok: z.boolean() }),
} as const satisfies RouteContract;
@@ -332,6 +431,7 @@ export const deleteApprovalTemplateRoute = {
export const deleteProcessFlowRoute = {
method: 'DELETE',
path: '/api/gov/process/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ packages: z.array(processPackageSchema) }),
} as const satisfies RouteContract;
@@ -347,6 +447,7 @@ export const deleteProcessFlowRoute = {
export const editProcessVersionRoute = {
method: 'POST',
path: '/api/gov/process/:id/:version/edit',
access: 'design',
params: z.object({ id: z.string(), version: z.string() }),
body: z.object({
version: z.number().int().min(1).max(9999).optional(),
@@ -360,6 +461,7 @@ export const editProcessVersionRoute = {
export const validateProcessRoute = {
method: 'POST',
path: '/api/gov/process/validate',
access: 'design',
body: z.object({ pkg: processPackageSchema }),
output: closureReportSchema,
} as const satisfies RouteContract;
@@ -369,12 +471,14 @@ export const validateProcessRoute = {
export const listTriggersRoute = {
method: 'GET',
path: '/api/gov/triggers',
access: ['design', 'ops'],
output: z.object({ triggers: z.array(triggerConfigSchema) }),
} as const satisfies RouteContract;
export const toggleTriggerRoute = {
method: 'POST',
path: '/api/gov/triggers/:id/toggle',
access: 'ops',
params: z.object({ id: z.string() }),
body: z.object({ enabled: z.boolean() }),
output: z.object({ ok: z.boolean() }),
@@ -390,6 +494,7 @@ export const toggleTriggerRoute = {
export const upsertTriggerRoute = {
method: 'PUT',
path: '/api/gov/triggers',
access: 'design',
body: z.object({ trigger: triggerConfigSchema }),
output: z.object({ trigger: triggerConfigSchema }),
} as const satisfies RouteContract;
@@ -405,6 +510,7 @@ export const upsertTriggerRoute = {
export const listWorkGroupsRoute = {
method: 'GET',
path: '/api/gov/work-groups',
access: 'ops',
/** `ownerName` 是组长姓名的呈现补充,读表时一并带出,免得前端再对一次 id */
output: z.object({ groups: z.array(workGroupSchema.extend({ ownerName: z.string() })) }),
} as const satisfies RouteContract;
@@ -413,6 +519,7 @@ export const listWorkGroupsRoute = {
export const saveWorkGroupRoute = {
method: 'PUT',
path: '/api/gov/work-groups',
access: 'ops',
body: z.object({
ownerId: staffIdSchema,
name: z.string().min(1),
@@ -434,6 +541,7 @@ export const saveWorkGroupRoute = {
export const installActivityRoute = {
method: 'POST',
path: '/api/gov/activities',
access: 'design',
body: z.object({
/** 清单六区:身份 / 七件契约 / 声明 / 资产初始版 / 样例集 / 代码入口 */
manifest: activityManifestSchema,
@@ -465,6 +573,7 @@ export const installActivityRoute = {
export const registerToolRoute = {
method: 'POST',
path: '/api/gov/tools',
access: 'design',
body: z.object({
contract: z.object({
name: z.string().min(1),
@@ -500,6 +609,7 @@ export const registerToolRoute = {
export const listActivitiesRoute = {
method: 'GET',
path: '/api/gov/activities',
access: 'design',
output: z.object({
activities: z.array(
z.object({
@@ -562,6 +672,7 @@ export const listActivitiesRoute = {
export const listToolsRoute = {
method: 'GET',
path: '/api/gov/tools',
access: 'design',
output: z.object({
tools: z.array(
z.object({
@@ -583,6 +694,7 @@ export const listToolsRoute = {
export const listLedgerObjectsRoute = {
method: 'GET',
path: '/api/gov/data/objects',
access: ['design', 'ops'],
/** `label` 是人读名(落在表注释上);缺省即没登记,呈现退回对象键 */
output: z.object({
objects: z.array(
@@ -623,6 +735,7 @@ export const listLedgerObjectsRoute = {
export const ledgerByActivityRoute = {
method: 'GET',
path: '/api/gov/data/by-activity',
access: ['design', 'ops'],
output: z.object({
activities: z.array(
z.object({
@@ -667,6 +780,7 @@ export const ledgerByActivityRoute = {
export const browseLedgerRoute = {
method: 'GET',
path: '/api/gov/data/:domain/:object',
access: ['design', 'ops'],
params: z.object({ domain: z.string(), object: z.string() }),
output: z.object({
label: z.string().optional(),
@@ -682,6 +796,7 @@ export const browseLedgerRoute = {
export const listActivityMemoryRoute = {
method: 'GET',
path: '/api/gov/memory/:activityId',
access: 'design',
params: z.object({ activityId: z.string() }),
output: z.object({
entries: z.array(
@@ -703,6 +818,7 @@ export const listActivityMemoryRoute = {
export const listChannelsRoute = {
method: 'GET',
path: '/api/gov/channels',
access: ['design', 'ops'],
output: z.object({
channels: z.array(
z.object({
@@ -733,6 +849,7 @@ export const listChannelsRoute = {
export const listApprovalsRoute = {
method: 'GET',
path: '/api/gov/approvals',
access: 'ops',
output: z.object({
approvals: z.array(
z.object({
@@ -763,6 +880,7 @@ export const listApprovalsRoute = {
export const setTriggerConfirmRoute = {
method: 'POST',
path: '/api/gov/triggers/:id/confirm',
access: 'ops',
params: z.object({ id: z.string() }),
body: z.object({ required: z.boolean(), staffId: z.string().optional() }),
output: z.object({ ok: z.boolean() }),
@@ -772,6 +890,7 @@ export const setTriggerConfirmRoute = {
export const listNodeOwnersRoute = {
method: 'GET',
path: '/api/gov/packages/:id/owners',
access: 'ops',
params: z.object({ id: z.string() }),
output: z.object({ owners: z.array(z.object({ nodeId: z.string(), staffId: z.string() })) }),
} as const satisfies RouteContract;
@@ -779,6 +898,7 @@ export const listNodeOwnersRoute = {
export const setNodeOwnerRoute = {
method: 'PUT',
path: '/api/gov/packages/:id/owners/:nodeId',
access: 'ops',
params: z.object({ id: z.string(), nodeId: z.string() }),
/** null = 撤掉运营指定,回到轮值 */
body: z.object({ staffId: z.string().nullable() }),
@@ -788,6 +908,7 @@ export const setNodeOwnerRoute = {
export const testRunRoute = {
method: 'POST',
path: '/api/gov/testbed/run',
access: 'design',
body: z.object({
packageId: z.string(),
/**
@@ -827,6 +948,7 @@ export const testRunRoute = {
export const testRunActivityRoute = {
method: 'POST',
path: '/api/gov/testbed/run-activity',
access: 'design',
body: z.object({
activityId: z.string().min(1),
/** 起单入参 —— 按该活动契约的 `input.data` 填;可用包自带样例预填 */
@@ -860,6 +982,7 @@ export const testRunActivityRoute = {
export const testStopRoute = {
method: 'POST',
path: '/api/gov/testbed/stop',
access: 'design',
/** 两种试法各有其拔法:流程包给 workflowId,单活动给 taskId;都不给 = 拔掉所有试跑残留 */
body: z.object({ workflowId: z.string().default(''), taskId: z.string().default('') }),
output: z.object({ destroyed: z.boolean(), tasks: z.number().int() }),
@@ -877,6 +1000,7 @@ export const testStopRoute = {
export const testCurrentRoute = {
method: 'GET',
path: '/api/gov/testbed/current',
access: 'design',
output: z.object({
workflowId: z.string().optional(),
subject: z.string().optional(),
@@ -900,6 +1024,7 @@ export const testCurrentRoute = {
export const testActivityStateRoute = {
method: 'GET',
path: '/api/gov/testbed/activity/:taskId',
access: 'design',
params: z.object({ taskId: z.string() }),
output: z.object({
taskId: z.string(),
@@ -954,6 +1079,7 @@ export const testActivityStateRoute = {
export const uploadFileRoute = {
method: 'POST',
path: '/api/gov/upload',
access: 'design',
body: z.object({
name: z.string().min(1),
contentType: z.string().default(''),
@@ -976,6 +1102,7 @@ export type UploadedFile = z.infer<typeof uploadFileRoute.output>;
export const downloadFileRoute = {
method: 'GET',
path: '/api/gov/upload/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ name: z.string(), contentType: z.string(), dataBase64: z.string() }),
} as const satisfies RouteContract;
@@ -1013,6 +1140,7 @@ export type TestLogRow = z.infer<typeof testLogRowSchema>;
export const listTestLogsRoute = {
method: 'GET',
path: '/api/gov/testbed/logs',
access: 'design',
output: z.object({ runs: z.array(testLogRowSchema) }),
} as const satisfies RouteContract;
@@ -1020,6 +1148,7 @@ export const listTestLogsRoute = {
export const testLogDetailRoute = {
method: 'GET',
path: '/api/gov/testbed/logs/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: testLogRowSchema.extend({
trail: z.array(
@@ -1053,6 +1182,7 @@ export const testLogDetailRoute = {
export const deleteTestLogRoute = {
method: 'DELETE',
path: '/api/gov/testbed/logs/:id',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({ deleted: z.number().int() }),
} as const satisfies RouteContract;
@@ -1060,6 +1190,7 @@ export const deleteTestLogRoute = {
export const clearTestLogsRoute = {
method: 'DELETE',
path: '/api/gov/testbed/logs',
access: 'design',
output: z.object({ deleted: z.number().int() }),
} as const satisfies RouteContract;
@@ -1067,6 +1198,7 @@ export const clearTestLogsRoute = {
export const traceOfWorkflowRoute = {
method: 'GET',
path: '/api/gov/workflows/:id/trace',
access: 'design',
params: z.object({ id: z.string() }),
output: z.object({
spans: z.array(
@@ -1092,6 +1224,7 @@ export const traceOfWorkflowRoute = {
export const govWorkflowRoute = {
method: 'GET',
path: '/api/gov/workflows/:id',
access: ['design', 'ops'],
params: z.object({ id: z.string() }),
output: z.object({
workflow: z.object({
@@ -1131,6 +1264,7 @@ export const govWorkflowRoute = {
export const govMetricsRoute = {
method: 'GET',
path: '/api/gov/metrics',
access: 'ops',
/** 统计窗口 —— 不传按月;驾驶舱可切日/周/月/年 */
query: z.object({ period: reportPeriodSchema.optional() }),
/** `period` 原样回声:客户端不传时,由它知道服务端用的是哪个窗口 */