# @awarevue/agent-sdk 中文文档

规范地址：https://npmcn.com/package/%40awarevue/agent-sdk/

版本：2\.0\.155
npm 元数据更新时间：2026-10-31T11:54:29.876Z
中文译文更新时间：2026-11-09T21:24:21.973Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40awarevue/agent-sdk
原文对照：https://npmcn.com/package/%40awarevue/agent-sdk/?lang=original
项目主页：https://github.com/Linc-Security-Systems/aware-essentials#readme
源码仓库：https://github.com/Linc-Security-Systems/aware-essentials

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

- 包体积（解压后）：83.2 kB，45 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：ws ^8，zod 4\.4\.3，rxjs ^7\.8\.2，@awarevue/api-types 2\.0\.155
- 首次发布：2025-05-05T10:25:34.227Z
- 最新版本发布：2026-10-31T11:54:29.590Z
- 近 30 天下载量：1719（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：287（近 12 个月 140 个）

## 中文简介

SDK用于构建说代理协议的代理执行.

## 安装

```sh
npm install @awarevue/agent-sdk
```

也可以使用：`pnpm add @awarevue/agent-sdk`、`yarn add @awarevue/agent-sdk`、`bun add @awarevue/agent-sdk`

## README

# 代理打字符 SDK

SDK帮助在Javascript / Typescript中构建代理. 代理是一个用任何编程语言书写的流程,负责连接周边安全领域的伙伴技术设备.

# 代理责任和准则

AWARE平台是一个一站式商店,用于监测和控制周边安全设备,包括但不限于闭路电视相机、电子门锁、运动传感器、IO板等。 这都是通过代理实现的,每个代理都专门从事一种技术,并与该技术的设备连接到源状态更新,事件和运行命令,由AWARE平台传输. 此外,它还负责根据AWARE确定的总政策更新出入控制政策.

## 状态、事件和命令

AWARE中一个设备的一般精神模型/抽象涉及三个概念:

-   状态更新(State Updates):对于每个设备,有一个具有一定形状的物体来描述一个设备的当前状态. 特工们要不断发布最新消息
-   活动 : 对于每个设备来说,可以发生的事件有类型,代理的职责是将低延迟的事件通知AWARE,每个设备类型都坚持这些标准事件的结构
-   命令:根据设备类型(相机,门等),平台用户可以发布命令以运行在设备上. 这些命令由负责该特定构造/伙伴系统的代理人执行.

## 访问控制

代理人处理的另一个领域是出入控制政策。 访问控制政策是指在什么时候可以访问哪个资源。 这些访问政策在AWARE平台中被定义,但通过代理向伙伴系统分发. 当用户更改访问策略时. 访问控制政策按照以下对象模式存储和管理: 1

-   人员:指预计与设施有关的人
-   附表:列明时间范围的每周时间表。 通常,当集合人群可以访问集合资源(devices)时,访问规则会使用调度设置
-   访问规则:每条访问规则都载有信息,说明收集哪些人可以访问在特定时间时间内收集哪些资源
-   区:区是资源非重叠的物理组合

AWARE平台将在两个阶段向代理人宣传这些变化:

-   验证阶段:AWARE会发出一条消息,提及访问控制对象的所有更改(更改). 变异是合并还是删除
-   应用相(Phase):在验证成功后,代理将发出消息,将更改应用到伙伴系统上. 应用更改 MUST 是一能的 。 这包括增加、更新或删除。 如果伙伴系统访问对象在AWARE平台外被操纵,操作必须始终能够恢复. 塔赫特包括一些案例,例如向一个在伙伴系统上被指定给另一个人的人分配一个指使,或者更新一个在伙伴系统中已经不存在的对象.

无论是在验证阶段还是在应用阶段,平台都会随同更改描述中提到的所有对象发送所有参考翻译. 预计代理人会检查共享的参考文献,以确保这些参考文献仍然有效,如果存在不需要参考的物件,则会投诉.

## 常见问题

### @awarevue/agent-sdk 是什么？

SDK用于构建说代理协议的代理执行\.

### 如何安装 @awarevue/agent-sdk？

在项目目录运行 npm install @awarevue/agent-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（4\.4\.3）、rxjs（^7\.8\.2）、@awarevue/api-types（2\.0\.155）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @awarevue/agent-sdk 支持 TypeScript 吗？

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

### @awarevue/agent-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @awarevue/agent-sdk 可以商用吗？

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

### @awarevue/agent-sdk 的下载量有多少？

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

### @awarevue/agent-sdk 还在维护吗？

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