# @distilled\.cloud/onepassword 中文文档

规范地址：https://npmcn.com/package/%40distilled.cloud/onepassword/

版本：1\.0\.0-rc\.20
npm 元数据更新时间：2026-11-12T21:39:57.998Z
中文译文更新时间：2026-11-14T07:49:44.586Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40distilled.cloud/onepassword
原文对照：https://npmcn.com/package/%40distilled.cloud/onepassword/?lang=original
源码仓库：https://github.com/alchemy-run/distilled

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

- 包体积（解压后）：345 kB，72 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：effect ^4\.1\.2
- 首次发布：2026-09-09T22:05:04.355Z
- 最新版本发布：2026-11-12T21:39:57.582Z
- 近 30 天下载量：2123（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @distilled.cloud/onepassword
```

也可以使用：`pnpm add @distilled.cloud/onepassword`、`yarn add @distilled.cloud/onepassword`、`bun add @distilled.cloud/onepassword`

## README

# @ distilled.cloud/单词

效果-内生 1 Password SDK,由 1Password 所出版的 OpenAPI 规格所产生 : [连接](https://github.com/1Password/connect/blob/main/docs/openapi/spec.yaml), (中文(简体) ), [活动](https://www.1password.dev/openapi/events_api.yaml), (中文(简体) ), [用户](https://www.1password.dev/openapi/users_api.yaml), (中文(简体) ), [奥奥特](https://www.1password.dev/openapi/oauth_api.yaml) 财务报告和审定财务报表 [伙伴关系](https://www.1password.dev/openapi/partnership_api.yaml)。 。 。 .

## 安装

```bash
npm install @distilled.cloud/onepassword effect
```

## APIs 密码

每个API是一个服务命名空间,有自己的证书层和协议. 服务本身也可进口,例如:. `@distilled.cloud/onepassword/connect`。 。 。 .

| API 密码 | 业务 | 全权证书 | 议定书 |
| --- | --- | --- | --- |
| 连接 | `Onepassword.connect.getVaults`,, , , , , , , , | `ConnectCredentialsFromEnv` | `ConnectProtocol` |
| 活动 | `Onepassword.events.getAuditEventsV2`,, , , , , , , , | `EventsCredentialsFromEnv` | `EventsProtocol` |
| 用户 | `Onepassword.users.listUsers`,, , , , , , , , | `UsersCredentialsFromEnv` | `UsersProtocol` |
| 奥奥特 | `Onepassword.oauth.requestAccessToken`,, , , , , , , , | `OAuthCredentialsFromEnv` | `OAuthProtocol` |
| 伙伴关系 | `Onepassword.partnership.createPartnerAccount`,, , , , , , , , | `PartnershipCredentialsFromEnv` | `PartnershipProtocol` |

## 快开始

连接( 自托管的连接服务器) :

```ts
import { Effect, Layer } from "effect";
import * as FetchHttpClient from "effect/http/FetchHttpClient";
import * as Onepassword from "@distilled.cloud/onepassword";

const program = Effect.gen(function* () {
  const vaults = yield* Onepassword.connect.getVaults({});
  return vaults;
});

const Live = Layer.mergeAll(
  FetchHttpClient.layer,
  Onepassword.ConnectCredentialsFromEnv,
  Onepassword.ConnectProtocol,
);

program.pipe(Effect.provide(Live), Effect.runPromise);
```

事件(审计活动从一个报告综合处获得):

```ts
import { Effect, Layer } from "effect";
import * as FetchHttpClient from "effect/http/FetchHttpClient";
import * as Onepassword from "@distilled.cloud/onepassword";

const program = Effect.gen(function* () {
  // Start a cursor with a page size and a start time, then pass the returned
  // `cursor` back as `{ body: { cursor } }` to continue.
  const page = yield* Onepassword.events.getAuditEventsV2({
    body: { limit: 100, start_time: "2026-10-01T00:00:00Z" },
  });
  return page.items;
});

const Live = Layer.mergeAll(
  FetchHttpClient.layer,
  Onepassword.EventsCredentialsFromEnv,
  Onepassword.EventsProtocol,
);

program.pipe(Effect.provide(Live), Effect.runPromise);
```

用户( 暂停一个用户; 请求访问令牌并为您刷新):

```ts
import { Effect, Layer } from "effect";
import * as FetchHttpClient from "effect/http/FetchHttpClient";
import * as Onepassword from "@distilled.cloud/onepassword";

const program = Onepassword.users.suspendUser({
  account: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  user: "ZYXWVUTSRQPONMLKJIHGFEDCBA",
});

const Live = Layer.mergeAll(
  FetchHttpClient.layer,
  Onepassword.UsersCredentialsFromEnv,
  Onepassword.UsersProtocol,
);

program.pipe(Effect.provide(Live), Effect.runPromise);
```

## 认证

| API 密码 | 需求 | 可选 | 发送为 |
| --- | --- | --- | --- |
| 连接 | `OP_CONNECT_TOKEN` | `OP_CONNECT_HOST` 或者说 `OP_CONNECT_API_BASE_URL` (默认) `http://localhost:8080/v1`(中文(简体) ) | `Authorization: Bearer` |
| 活动 | `OP_EVENTS_API_TOKEN` | `OP_EVENTS_API_BASE_URL` (默认) `https://events.1password.com`(中文(简体) ) | `Authorization: Bearer` |
| 用户 | `OP_USERS_API_CLIENT_ID`, (中文(简体) ), `OP_USERS_API_CLIENT_SECRET` | `OP_USERS_API_BASE_URL` (默认) `https://api.1password.com`(中文(简体) ) | `Authorization: Bearer <access token>` |
| 奥奥特 | `OP_USERS_API_CLIENT_ID`, (中文(简体) ), `OP_USERS_API_CLIENT_SECRET` | `OP_USERS_API_BASE_URL` (默认) `https://api.1password.com`(中文(简体) ) | `Authorization: Basic` |
| 伙伴关系 | `OP_PARTNERSHIP_API_TOKEN` | `OP_PARTNERSHIP_API_BASE_URL` (默认) `https://billing.1password.com`(中文(简体) ) | `Authorization: Bearer` |

1Password 不为事件、用户或 伙伴API;以上名称为SDK. 美国境外账户使用a 区域东道主: `*.1password.ca`, (中文(简体) ), `*.1password.eu` 或者说 `*.ent.1password.com`。 。 。 .

用户证书交换 OAuth 应用程序的客户端ID 和秘密 15分钟的出入证 `POST /v1/oauth/token`并请求 新的,在它到期前不久。 要直接传递值, 请使用 `connectCredentials({ token })`, (中文(简体) ), `eventsCredentials({ token })`, (中文(简体) ), `usersCredentials({ clientId, clientSecret })`, (中文(简体) ), `usersCredentialsFromAccessToken({ accessToken })`, (中文(简体) ), `oauthCredentials(...)` 或者说 `partnershipCredentials({ token })`; 秘密为 `Redacted<string>`。 。 。 .

## 常见问题

### 如何安装 @distilled\.cloud/onepassword？

在项目目录运行 npm install @distilled\.cloud/onepassword，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（^4\.1\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @distilled\.cloud/onepassword 支持 TypeScript 吗？

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

### @distilled\.cloud/onepassword 支持 ESM 还是 CommonJS？

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

### @distilled\.cloud/onepassword 可以商用吗？

@distilled\.cloud/onepassword 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @distilled\.cloud/onepassword 的下载量有多少？

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

### @distilled\.cloud/onepassword 还在维护吗？

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