# @blackbaud/auth-client 中文文档

规范地址：https://npmcn.com/package/%40blackbaud/auth-client/

版本：2\.78\.0
npm 元数据更新时间：2024-03-14T19:08:38.946Z
中文译文更新时间：2026-11-08T05:43:40.553Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：1.4 MB，284 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2017-04-11T20:22:14.622Z
- 最新版本发布：2024-02-23T15:42:40.880Z
- 近 30 天下载量：8121（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：120（近 12 个月 0 个）

## 中文简介

提供从 Blackbaud 认证服务获取认证符的方法.

## 安装

```sh
npm install @blackbaud/auth-client
```

也可以使用：`pnpm add @blackbaud/auth-client`、`yarn add @blackbaud/auth-client`、`bun add @blackbaud/auth-client`

## README

# @blackbaud/auth-客户端

[![npm](https://img.shields.io/npm/v/@blackbaud/auth-client.svg)](https://www.npmjs.com/package/@blackbaud/auth-client) [![status](https://travis-ci.org/blackbaud/auth-client.svg?branch=master)](https://travis-ci.org/blackbaud/auth-client) [![coverage](https://codecov.io/github/blackbaud/auth-client/coverage.svg?branch=master)](https://codecov.io/github/blackbaud/auth-client/)

提供客户端库用于与 Blackbaud 认证交互.

## 安装

-   确保您拥有节点v6+和国家预防机制v3+。 要验证, 运行 `node -v` 财务报告和审定财务报表 `npm -v` 在命令线.
-   通过运行将库安装为您的项目的依赖性 `npm install @blackbaud/auth-client --save` 在您的项目文件夹中 .

## 使用量

### 先决条件

认证客户端库广泛使用 [ES6型承诺](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise),所以为了支持还没有本地支持“承诺”的浏览器(如Internet Explorer 11),您需要包含“承诺”的多填充,例如 [`es6-promise`](https://github.com/stefanpenner/es6-promise) 并使用 [自动填充特性](https://github.com/stefanpenner/es6-promise#auto-polyfill) 用于图书馆的 `Promise` 被添加到全球环境中。 这将需要在认证客户端库前加载到您的页面 .

### ES6/ 类型脚本

此套件中有两个类: `BBAuth` 财务报告和审定财务报表 `BBOmnibar`。 。 。 . `BBAuth` 允许您从 Blackbaud 认证服务中获取一个认证符,以及 `BBOmnibar` 允许您在页面的顶端制作 omnibar .

您可以组合使用这些来整合您的应用程序与 Blackbaud 认证 .

```ts
import { BBAuth, BBOmnibar } from '@blackbaud/auth-client';

// Make an initial attempt to get an auth token.  If the user is not currently logged in,
// this code will redirect the browser to Blackbaud's sign-in page.
BBAuth.getToken()
  .then(() => {
    // The user is logged in; load the omnibar.
    BBOmnibar.load({
      serviceName: 'Some service name'
    });

    // Add additional logic to bootstrap the rest of the application.
  });
```

要向您的网络服务端点发出授权请求, 您也会使用 `BBAuth.getToken()` 用于获取一个可以添加到您请求中作为信头的符号的方法。 由于获取一个符号是同步操作,此方法返回 a `Promise`,所以你应该等到"承诺"实现后,才发出你的网络请求.

```ts
import { BBAuth } from '@blackbaud/auth-client';

BBAuth.getToken()
  .then((token: string) => {
    const xhr = new XMLHttpRequest();

    xhr.open('GET', url, true);

    xhr.setRequestHeader('Authorization', 'Bearer ' + token);

    xhr.send();
  });
```

### 香草爪哇脚本/ES5

Auth客户端也作为UMD捆绑分发. 如果你使用ES5 带节点或者像浏览器这样的工具 `require()` 内容:

```js
var BBAuthClient = require('@blackbaud/auth-client');

BBAuthClient.BBOmnibar.load({
  serviceName: 'Some service name'
});
```

如果您不使用模块加载器, 或者更愿意通过 CDN 引用文件, 您可以通过 CDN 将文件加载到您的页面 `<script>` 标签.

如果使用国家预防机制,请添加提及 `dist/bundles/auth-client.umd.js` 或将该文件与您页面的其余 JavaScript 合并.

如果使用SKY UX CDN,请添加引用 `https://sky.blackbaudcdn.net/static/auth-client/[VERSION]/auth-client.global.min.js`时 `[VERSION]` 您想要使用的版本 。 所有向国家预防机制发布的版本也可通过CDN查阅。 也可以参考最新的主要版本. 示例版本:

-   `https://sky.blackbaudcdn.net/static/auth-client/2.24.0/auth-client.global.min.js`
-   `https://sky.blackbaudcdn.net/static/auth-client/2/auth-client.global.min.js`

你现在可以通过全球访问 `BBAuthClient` 变量 :

```js
// BBAuthClient is global here.
BBAuthClient.BBOmnibar.load({
  serviceName: 'Some service name'
});
```

## 常见问题

### @blackbaud/auth-client 是什么？

提供从 Blackbaud 认证服务获取认证符的方法\.注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @blackbaud/auth-client？

在项目目录运行 npm install @blackbaud/auth-client，或使用 pnpm add / yarn add / bun add。

### @blackbaud/auth-client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/blackbaud\_\_auth-client 是否存在。

### @blackbaud/auth-client 支持 ESM 还是 CommonJS？

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

### @blackbaud/auth-client 可以商用吗？

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

### @blackbaud/auth-client 的下载量有多少？

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

### @blackbaud/auth-client 还在维护吗？

最新版本 2\.78\.0 发布于 2024/02/23（2 年前）；至今共发布 120 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/04/12。作者已将其标记为弃用，新项目建议寻找替代方案。