@vcp-test/contracts
v0.7.0
Published
VCP 对外共享的 TypeScript 合同包,承载站点编辑、render document、patch plan、Agent / Workspace 相关 schema 与事件类型。
Readme
@vcp-test/contracts
VCP 对外共享的 TypeScript 合同包,承载站点编辑、render document、patch plan、Agent / Workspace 相关 schema 与事件类型。
环境要求
- Node.js
>=24
安装
npm install @vcp-test/contracts适用场景
- 校验 site edit operation / patch plan 输入输出
- 复用 site edit runtime fallback 标签集合与能力 fallback helper
- 复用
site_id、snapshot_id、tenant_id等稳定边界字段 - 复用 FORM_SPEC、表单模板、CMS 字段投影、canonical hash 与保存 operation 合同
- 在服务端、工具链或外部集成中共享 Zod schema 与推导类型
示例
import {
SiteEditOperationRequestSchema,
type SiteEditOperationRequest,
} from "@vcp-test/contracts";
const request: SiteEditOperationRequest = SiteEditOperationRequestSchema.parse({
id: "op_123",
siteId: "018f6f4d-a9b8-7401-8401-0123456789ab",
baseSnapshotId: "018f6f4d-a9b8-7402-8402-0123456789ab",
kind: "update-text",
target: { kind: "node", key: "hero-title" },
documentVersion: 3,
params: { kind: "update-text", segmentIndex: 0, value: "Hello VCP" },
});非目标
@vcp-test/contracts 只提供合同、schema 与共享类型,不负责:
- 执行源码编辑
- 管理 snapshot 持久化
- 启动 preview / sandbox
- 触发站点发布
