# @auditaur/api 中文文档

规范地址：https://npmcn.com/package/%40auditaur/api/

版本：0\.15\.1
npm 元数据更新时间：2026-10-30T22:03:56.627Z
中文译文更新时间：2026-11-07T04:36:36.384Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40auditaur/api
原文对照：https://npmcn.com/package/%40auditaur/api/?lang=original
项目主页：https://github.com/sethjuarez/auditaur#readme
源码仓库：https://github.com/sethjuarez/auditaur

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

- 包体积（解压后）：183 kB，48 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@opentelemetry/api ^1\.9\.0，@opentelemetry/sdk-trace-base ^2\.7\.0
- 首次发布：2026-06-06T05:52:04.610Z
- 最新版本发布：2026-10-30T22:03:56.235Z
- 近 30 天下载量：3700（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

前端遥测API用于Auditaur启用的Tauriapps.

## 安装

```sh
npm install @auditaur/api
```

也可以使用：`pnpm add @auditaur/api`、`yarn add @auditaur/api`、`bun add @auditaur/api`

## README

# @ auditaur/ api (英语)

前端遥测辅助器,用于Auditaur启用的Tauriapps.

在 Tauri 网页视图中使用这个软件包来捕捉前端控制台日志,出错,包裹 Tauri IPC 的电话, Tauri 事件,以及可选的 OpenTeleometry JS 跨度. 遥测被发送到 `tauri-plugin-auditaur` 后端插件,该插件将它存储在 Auditaur 本地 SQLite 会话数据库中.

## 安装

```powershell
npm install @auditaur/api
```

## 快开始

```ts
import { initAuditaur } from '@auditaur/api';

const auditaur = await initAuditaur({
  serviceName: 'my-tauri-app',
  onExportError(failure) {
    console.warn('Auditaur export failed', failure.error);
  },
});

export const invoke = auditaur.invoke;
```

默认情况下, Auditaur 仪器控制台日志, 前端错误, Tauri 引用, Tauri 事件, 以及 W3C 微量上下文传播用于包裹引用 。 全部有效载荷捕获默认被禁用.

## 除错驱动桥

对于本地/调试UI自动化,应用程序可以明确选择进入Auditaur in-app驱动桥. 桥让 `auditaur drive` 从每个平台的 WebView 内部执行 Tauri 本地选择器操作 :

```ts
await initAuditaur({
  serviceName: 'my-tauri-app',
  driveBridge: {
    windowLabel: 'main',
    pollIntervalMs: 100,
  },
});
```

该桥默认已禁用, 需要允许的 Auditaur Tauri 插件命令 `auditaur:default`,并且只有在开发/试验建设中才能进行。 它支持 `wait`, (中文(简体) ), `exists`, (中文(简体) ), `text`, (中文(简体) ), `click`, (中文(简体) ), `fill`, (中文(简体) ), `type`, (中文(简体) ), `press`, (中文(简体) ), `hover`, (中文(简体) ), `select`, (中文(简体) ), `check`, (中文(简体) ), `uncheck`, (中文(简体) ), `evaluate`, (中文(简体) ), `snapshot`,以及 `screenshot`;动作遥测会被记录,而不记录已填充,打入,或选定的文本值. Bridge 截图首先尝试本地的 WebView 抓取没有封禁的 WebView 像素 ; 选择者截图可以截取 WebView 图像并包含 `screenshotScope=selector` 加号 `selectorRect`。如果 WebView 抓取失败,当 OS 权限或窗口匹配防止抓取时, Auditaur 返回到本地窗口抓取,然后返回到 DOM 文本摘要 PNG . `evaluate` 在WebView中运行任意的JavaScript,因此将桥限制在开发/测试会话. 该桥目前是有意的单一窗口: 允许在每届审计会话中精确使用一次WebView, 通常使用 `windowLabel: 'main'`。如果多个窗口在同一会话中允许它,则目标选择是不支持的,可能模糊不清.

## 自定义引用包装符

如果您创建了自己的 Tauri 引用包, 请使用导出的微量上下文帮助符, 这样后端命令附加注释 `#[tauri_plugin_auditaur::instrument_ipc]` 能够继续前端跟踪 :

```ts
import { AUDITAUR_TRACE_CONTEXT_ARG, createAuditaurTraceContext } from '@auditaur/api';

const args = {
  id: 'user-1',
  [AUDITAUR_TRACE_CONTEXT_ARG]: createAuditaurTraceContext(),
};
```

## OpenTeleometry JS 跨度

将审计师的出口商添加到现有的 OpenTelemetery JS Tracker 供应商中:

```ts
import { BasicTracerProvider, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { initAuditaur } from '@auditaur/api';

const auditaur = await initAuditaur({ serviceName: 'my-tauri-app' });

const provider = new BasicTracerProvider({
  spanProcessors: [
    new SimpleSpanProcessor(auditaur.createOpenTelemetrySpanExporter()),
  ],
});
```

使用 Rust Tauri 插件和 CLI 的完整设置请参见 Auditaur 文件 .

## 常见问题

### @auditaur/api 是什么？

前端遥测API用于Auditaur启用的Tauriapps\.

### 如何安装 @auditaur/api？

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

### @auditaur/api 支持 TypeScript 吗？

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

### @auditaur/api 支持 ESM 还是 CommonJS？

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

### @auditaur/api 可以商用吗？

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

### @auditaur/api 的下载量有多少？

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

### @auditaur/api 还在维护吗？

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