# @clarity\.surf/sdk 中文文档

规范地址：https://npmcn.com/package/%40clarity.surf/sdk/

版本：0\.12\.0
npm 元数据更新时间：2026-11-04T05:46:45.488Z
中文译文更新时间：2026-11-09T23:38:31.248Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：105 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-09-09T00:15:26.133Z
- 最新版本发布：2026-11-04T05:46:45.089Z
- 近 30 天下载量：40309（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

清晰搜索、工作、索引和新闻的通用SDK

## 安装

```sh
npm install @clarity.surf/sdk
```

也可以使用：`pnpm add @clarity.surf/sdk`、`yarn add @clarity.surf/sdk`、`bun add @clarity.surf/sdk`

## README

# 清晰的 SDK

外部客户使用 `new ClarityClient({ apiKey })` 带有瞄准Oxy API键. API密钥即使在为Oxy应用发布时仍保留其外部范围和配额.

自有后端集成使用共享的工作量运输:

```ts
import { clarityForOxyService } from '@clarity.surf/sdk/server';

const clarity = clarityForOxyService(oxyServer);
await clarity.search({ query: 'public information' });
```

`oxyServer` 呼叫者已经存在 `OxyServer`。工厂选择克莱蒂的 听众, `oxy-service:01a0648b-8d73-70ad-8e67-1c07ddc5eb6e`。 。 。 . Oxy拥有工作量证明,无记名刷新,来源限制和回想. 此整合中没有密钥或范围列表.

前端集成使用当前提供者的 `oxyServices`数字 :

```ts
import { clarityForOxySession } from '@clarity.surf/sdk';

const clarity = clarityForOxySession(oxyServices);
await clarity.experience.list(profileAccountId);
// On the owning component/client's disposal:
clarity.dispose();
```

链接的传输保留会话切换和刷新. 不读取或复制 `http.getAccessToken()` 或者用应用程序本地授权逻辑来包装获取. 个人经验书写仍需要经过认证的账号;工作量 身份不选择一个人的账户。 公共和外部客户 API 继续通过 `ClarityClient`。 。 。 .

工厂是源变更 等待释放。 部署匹配的清晰度 接收器和氧气管理局 API 在使用呼叫器前.

公众阅读完全不需要证书。 发现者的消息每一次都一样 阅读器,所以一个屏幕 没有理由识别任何人(一个相框,一个亭) 与一个客户端一起读取, 构建为无:

```ts
import { ClarityClient } from '@clarity.surf/sdk';

const stories = await new ClarityClient().publicNews({ languages: ['es', 'en'], limit: 10 });
const [article] = stories[0]?.articles ?? [];
// article.imageUrl is Clarity's copy of the image; article.imageSeeds, once
// known, are its seed colours (`#rrggbb`, best first) to theme a card with.
```

## 常见问题

### @clarity\.surf/sdk 是什么？

清晰搜索、工作、索引和新闻的通用SDK

### 如何安装 @clarity\.surf/sdk？

在项目目录运行 npm install @clarity\.surf/sdk，或使用 pnpm add / yarn add / bun add。

### @clarity\.surf/sdk 支持 TypeScript 吗？

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

### @clarity\.surf/sdk 支持 ESM 还是 CommonJS？

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

### @clarity\.surf/sdk 可以商用吗？

@clarity\.surf/sdk 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @clarity\.surf/sdk 的下载量有多少？

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

### @clarity\.surf/sdk 还在维护吗？

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