# @atcx/contract 中文文档

规范地址：https://npmcn.com/package/%40atcx/contract/

版本：7\.7\.2
npm 元数据更新时间：2026-10-31T14:18:26.503Z
中文译文更新时间：2026-10-31T14:32:41.284Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：201 kB，68 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-10-23T10:37:26.947Z
- 最新版本发布：2026-10-31T14:18:26.111Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

Atc的公共契约：守护进程的请求契约、事件、会话记录、hello和配置模式、错误代码、会话环境名称、状态路径以及网关的路由和注册表模式

## 安装

```sh
npm install @atcx/contract
```

也可以使用：`pnpm add @atcx/contract`、`yarn add @atcx/contract`、`bun add @atcx/contract`

## README

# @atcx /合同

[![npm version](https://img.shields.io/npm/v/@atcx/contract)](https://www.npmjs.com/package/@atcx/contract) [![MIT license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.2/LICENSE)

[公布的合同](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.2/docs/architecture/protocol/contract.md) • [客户端协议](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.2/docs/architecture/protocol/protocol.md)

程序与atc守护进程通信并读取它所写内容所需的模式和常量。

Atc在守护进程中承载编码代理会话，这个包保存守护进程的 会话：oRPC请求契约、事件和会话记录模式、hello应答、会话 错误代码、会话环境名称以及守护进程的套接字和状态的路径。这个 守护进程和每个atc客户端构建在同一个包上，每个atc版本都以自己的方式发布它 的版本。首先，使用以下命令解析守护进程的socket `resolveAtcPaths`,发送 `daemon.hello`，并通过 的答案 `checkDaemon` 了解守护进程是否使用您的合同版本。

## 安装

该包附带了一个ES模块及其类型声明，用于Node或Bun。这取决于Zod 4和 oRPC的合约库。

```bash
bun add @atcx/contract
```

oRPC的声明导入 `@opentelemetry/api`， oRPC仅将其列为可选对等体。一个 对其依赖项的声明进行类型检查的项目 `skipLibCheck` 关闭，安装 包装旁边：

```bash
bun add -d @opentelemetry/api
```

## 功能

-   **请求契约。** `DAEMON_CONTRACT`，每个守护进程的oRPC契约，带有 每个输入和回答模式。
-   **事件和记录。** `DAEMON_EVENT_SCHEMA` 对于事件流，和 `PUBLISHED_RECORD_SCHEMA` 对于会话记录，会话的助手读取。
-   **检查守护进程。** `checkDaemon` 将hello应答中的主版本与 合同的，并列出不同的特性。
-   **网关。** `GATEWAY_PATHS`，路由atc网关服务分组为浏览器，机器和 探测路径，以及 `GATEWAY_REGISTRY_SCHEMA`，网关注册表文件的规则。
-   **光进入。** `@atcx/contract/light` 保存会话环境名称、状态路径 对于每个事件只启动一次的流程，没有请求契约的错误代码。

## 配置

`CONFIG_FILE_SCHEMA` 解析atc的顶级键 `config.json`，和 [配置指南](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.2/docs/guides/configuration.md) 描述每个键。

## 文档

[公布的合同](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.2/docs/architecture/protocol/contract.md) 覆盖包中所包含的内容 以及它的版本如何随着atc的变化而变化。

## 常见问题

### @atcx/contract 是什么？

Atc的公共契约：守护进程的请求契约、事件、会话记录、hello和配置模式、错误代码、会话环境名称、状态路径以及网关的路由和注册表模式

### 如何安装 @atcx/contract？

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

### @atcx/contract 支持 TypeScript 吗？

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

### @atcx/contract 支持 ESM 还是 CommonJS？

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

### @atcx/contract 可以商用吗？

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

### @atcx/contract 还在维护吗？

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