# @codelitdev/platform-conformance 中文文档

规范地址：https://npmcn.com/package/%40codelitdev/platform-conformance/

版本：0\.8\.2
npm 元数据更新时间：2026-11-09T11:08:50.847Z
中文译文更新时间：2026-11-10T07:07:34.159Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40codelitdev/platform-conformance
原文对照：https://npmcn.com/package/%40codelitdev/platform-conformance/?lang=original
项目主页：https://github.com/codelitdev/platform/tree/main/packages/platform-conformance#readme
源码仓库：https://github.com/codelitdev/platform

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：27.9 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@codelitdev/platform \>=0\.8\.2
- 首次发布：2026-09-04T21:59:18.516Z
- 最新版本发布：2026-11-09T11:08:50.346Z
- 近 30 天下载量：2885（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

用于CodeLit平台产品的共享HTTP兼容套件

## 安装

```sh
npm install @codelitdev/platform-conformance
```

也可以使用：`pnpm add @codelitdev/platform-conformance`、`yarn add @codelitdev/platform-conformance`、`bun add @codelitdev/platform-conformance`

## README

# @ codelitdev/ platform- 符合

使用CodeLit建立的产品共享整合检查 [平台](https://github.com/codelitdev/platform) 软件包. 符合性测试一个产品在用它编程包后的行为 它自己的路线、证书、租户、政策、数据库和工人。 软件包 单位测试和产品域测试仍然有自己的工作.

产品提供固定装置和适配器,称为它使用的套房,以及 声称,每个返回 `failures` 数组为空 。 安装此软件包 不运行测试或创建 CI 门.

## 范围

这个 [平台架构](https://npmcn.com/package/docs/architecture.md) 要求这些 产品级检查。 最后一栏区分了工作检查和空白; 参考跑道还不是每个产品的一般适配器.

| 区域 | 产品一级无变体 | 今天报道 |
| --- | --- | --- |
| 全权证书 | 会话, OAuth 令牌, 和 API 密钥解析到正确的主机; 模糊或无效的证书失败而不倒置; 运输客户端不能显示一个可信任的系统身份 . | 参考赛跑者中的一些案例. |
| OAuth 整合 | 广告发行商,授权和令牌端点,资源元数据,并宣布DCR/CIMD支持与运行的产品相匹配. | MCP保护资源发现有一个独立的套房;授权服务器和客户端注册检查仍然需要一个套房. |
| 租赁和身份生命周期 | 重新检查会员资格,将API密钥固定在一名租户手中,拒绝交叉租户进入,以及取消密钥、邀请和最后所有者保障工作. | 参照跑道基本隔离;生命周期病例仍是产品测试. |
| REST 和 OpenAPI 数据 | 运行时间验证,稳定安全出错,生成OpenAPI与产品合同一致. | 具体检查 `/v1/notes` 及其业务. |
| MCP 运输和平等 | 匿名请求接受OAuth公司的挑战;经认证的工具遵循产品政策并匹配相应的REST能力;破坏性行动需要明确的证明. | 独立发现套件和特定参考工具检查. 静态对等验证 `@codelitdev/mcp-server-kit`。 。 。 . |
| 观察性 | 被禁用的遥测是安全的,秘密被修改,一个失败的可选槽不会失败请求或工作. | 参考吊钩;仍然需要独立的组合套件. |
| 计费组成 | 产品计划、行动补助、审计钩、假供货商流动以及维修均正确接通. | 参考跑车钩. 供应商和工作流程合同 `@codelitdev/billing/testing`。 。 。 . |
| 生命周期 | 健康和准备状态反映状况;停工停止了新工作并关闭了资源. | 查询员检查固定终点;仍然需要独立的套房. |
| 版本兼容性 | 已解析的软件包满足了支持的和最低安全性的版本. | 拥有者 `platform-cli doctor` 和预置的船; 产品CI应该运行检查. |

遵义属于产品分界线. 一个模拟的捏造反应 适配器无法确定真实的认证中间软件、路由或工人有效. 新套房应接受产品界定的路径、操作、证书和 fixture 设置,而不是假设参考产品的注解资源. 他们 应重新使用包拥有的协议或供应商合同,而不应复制 他们.

## 可用跑道

`runPlatformConformance(adapter, capabilities)` 练习引用 产品所有者/成员/用户和双租户情况。 它涵盖了部分 认证、租赁、REST、MCP、OpenAPI、可观察性、计费、准备以及 关闭。 其现有要求假定 `/v1/notes`, (中文(简体) ), `notes.*` MCP工具,以及 参考计费路线。 现有收养人可以继续使用;产品与 其他域名模型不应制造说明反应使其通过. 见 [引用适配器](https://npmcn.com/package/examples/reference-product/apps/api/src/conformance-adapter.ts) 它的固定和HTTP形状.

`runMcpDiscoveryConformance(adapter, { resourceUrl })` 是一个独立的 HTTP 套间。 它接受该产品的公共MCP资源URL和a `request` 适配器 返回状态,信头,和解析的身体。 它检查匿名者 `401`, (中文(简体) ), 资源元数据挑战、保护资源元数据 广告授权服务器。 它没有工具名称,租户 模型、框架或计费设置。 见其 [HTTP 测试](https://npmcn.com/package/%40codelitdev/platform-conformance/src/mcp-discovery.test.ts) 是一个用电平听器的适配器.

```ts
import {
  runMcpDiscoveryConformance,
  runPlatformConformance,
} from "@codelitdev/platform-conformance";

// Use the composition runner only if your adapter implements its reference scenario.
const composition = await runPlatformConformance(referenceAdapter, {
  mcp: true,
  billing: true,
  observability: true,
  openapi: true,
  shutdown: true,
});
expect(composition.failures).toEqual([]);

// Any MCP product can use its real HTTP route for this independent suite.
const discovery = await runMcpDiscoveryConformance(
  { request: productHttpRequest },
  { resourceUrl: "http://127.0.0.1:8000/mcp" },
);
expect(discovery.failures).toEqual([]);
```

只运行适用于产品的套件,但不处理省略的 套房作为通行证。 产品应在其 测试设置, 并保持选中的套件在审查中可见 。 一个需要的套房 HTTP必须行使真实的路径,包括认证和发现中间软件.

## 产品 CI

创建可支配固定装置, 启动本地 API 听器或等同的测试 例如,运行选定的套房,并关闭听众、数据库和 之后的工人们。 测试应该是 API 软件包正常测试的一部分 命令。 在拉动请求中冷冻后运行,并让CI工作成为 需要进行分支保护检查。 仅限推力的工作流程无法守护拉力 请求。 运行 `platform-cli doctor` 在同一门内安装的版本和 管理配置;它不证明行为符合性.

## 常见问题

### @codelitdev/platform-conformance 是什么？

用于CodeLit平台产品的共享HTTP兼容套件

### 如何安装 @codelitdev/platform-conformance？

在项目目录运行 npm install @codelitdev/platform-conformance，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@codelitdev/platform（\>=0\.8\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @codelitdev/platform-conformance 支持 TypeScript 吗？

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

### @codelitdev/platform-conformance 支持 ESM 还是 CommonJS？

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

### @codelitdev/platform-conformance 可以商用吗？

@codelitdev/platform-conformance 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @codelitdev/platform-conformance 的下载量有多少？

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

### @codelitdev/platform-conformance 还在维护吗？

最新版本 0\.8\.2 发布于 2026/11/09（今天）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/09/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。