@cloudpdf/contract

中文文档
3.1.0发布于 2026/11/09Apache-2.0TypeScriptES Module近 30 天下载 1899

The CloudPDF engine contract: operation registry, Zod schemas, and OpenAPI emitter for every backend-callable surface — used by @cloudpdf/server and the generated @cloudpdf/sdk, and the source of the committed openapi.json.

原始使用文档

@cloudpdf/contract

The CloudPDF engine's contract: the operation registry, zod schemas, and OpenAPI emitter for every backend-callable surface — deployment and tenant administration plus the document operations (reads, annotations, forms, page operations, redaction, download).

The registry is executed, not merely described: @cloudpdf/server mounts its admin routes from these entries and validates with these schemas, the @cloudpdf/sdk protocol and workflow types its requests with them, and the committed openapi.json is generated from them (pnpm emit:openapi) — a freshness test fails CI whenever the two diverge.

Wire vocabulary (document shapes, capability scopes, doc-plane path templates, the engine error envelope) is imported from @embedpdf/engine-core, never restated: this package curates and annotates the protocol with credentials, scopes, and documentation metadata. The interactive viewer-session protocol (/v1/access, immutable @{version} reads, SSE) deliberately stays out — that transport belongs to the CloudPDF viewer SDKs and is free to evolve behind them.

License

Apache-2.0

版本与发布记录

@cloudpdf/contract 共发布 25 个版本,首次发布于 2026/08/09;过去 12 个月发布了 25 个版本。

版本发布日期距今
3.1.0latest2026/11/091 天前
3.0.02026/11/073 天前
3.0.0-next.23next2026/11/073 天前
3.0.0-next.222026/11/045 天前
3.0.0-next.212026/11/036 天前
3.0.0-next.202026/11/037 天前

关于 @cloudpdf/contract 的常见问题

@cloudpdf/contract 是什么?

The CloudPDF engine contract: operation registry, Zod schemas, and OpenAPI emitter for every backend-callable surface — used by @cloudpdf/server and the generated @cloudpdf/sdk, and the source of the committed openapi.json.

如何安装 @cloudpdf/contract?

在项目目录运行 npm install @cloudpdf/contract,或使用 pnpm add / yarn add / bun add。

@cloudpdf/contract 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cloudpdf/contract 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cloudpdf/contract 可以商用吗?

@cloudpdf/contract 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@cloudpdf/contract 的下载量有多少?

根据 npm 官方下载统计,@cloudpdf/contract 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,899 次,日均约 63 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cloudpdf/contract 还在维护吗?

最新版本 3.1.0 发布于 2026/11/09(1 天前);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/08/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。