@distilled.cloud/onepassword

中文文档
1.0.0-rc.20发布于 2026/11/13Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 2123
中文使用文档
文档目录4 节
  1. 安装
  2. APIs 密码
  3. 快开始
  4. 认证

@ distilled.cloud/单词

效果-内生 1 Password SDK,由 1Password 所出版的 OpenAPI 规格所产生 : 连接, (中文(简体) ), 活动, (中文(简体) ), 用户, (中文(简体) ), 奥奥特 财务报告和审定财务报表 伙伴关系。 。 。 .

安装

npm install @distilled.cloud/onepassword effect

APIs 密码

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

API 密码业务全权证书议定书
连接Onepassword.connect.getVaults,, , , , , , , , ConnectCredentialsFromEnvConnectProtocol
活动Onepassword.events.getAuditEventsV2,, , , , , , , , EventsCredentialsFromEnvEventsProtocol
用户Onepassword.users.listUsers,, , , , , , , , UsersCredentialsFromEnvUsersProtocol
奥奥特Onepassword.oauth.requestAccessToken,, , , , , , , , OAuthCredentialsFromEnvOAuthProtocol
伙伴关系Onepassword.partnership.createPartnerAccount,, , , , , , , , PartnershipCredentialsFromEnvPartnershipProtocol

快开始

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

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);

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

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);

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

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_TOKENOP_CONNECT_HOST 或者说 OP_CONNECT_API_BASE_URL (默认) http://localhost:8080/v1(中文(简体) )Authorization: Bearer
活动OP_EVENTS_API_TOKENOP_EVENTS_API_BASE_URL (默认) https://events.1password.com(中文(简体) )Authorization: Bearer
用户OP_USERS_API_CLIENT_ID, (中文(简体) ), OP_USERS_API_CLIENT_SECRETOP_USERS_API_BASE_URL (默认) https://api.1password.com(中文(简体) )Authorization: Bearer <access token>
奥奥特OP_USERS_API_CLIENT_ID, (中文(简体) ), OP_USERS_API_CLIENT_SECRETOP_USERS_API_BASE_URL (默认) https://api.1password.com(中文(简体) )Authorization: Basic
伙伴关系OP_PARTNERSHIP_API_TOKENOP_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 共发布 13 个版本,首次发布于 2026/09/10;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.0-rc.20latest2026/11/131 天前
1.0.0-rc.192026/11/122 天前
1.0.0-rc.182026/11/0311 天前
1.0.0-rc.172026/10/2421 天前
1.0.0-rc.162026/10/2322 天前
1.0.0-rc.152026/10/131 个月前

关于 @distilled.cloud/onepassword 的常见问题

如何安装 @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 和提交记录判断。