# @forgerock/ping-protect 中文文档

规范地址：https://npmcn.com/package/%40forgerock/ping-protect/

版本：4\.7\.1
npm 元数据更新时间：2026-05-06T14:21:33.566Z
中文译文更新时间：2026-11-15T07:47:01.094Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40forgerock/ping-protect
原文对照：https://npmcn.com/package/%40forgerock/ping-protect/?lang=original
项目主页：https://github.com/ForgeRock/forgerock-javascript-sdk#readme
源码仓库：https://github.com/ForgeRock/forgerock-javascript-sdk

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

- 包体积（解压后）：523 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-03-13T16:24:45.156Z
- 最新版本发布：2026-05-06T14:21:33.145Z
- 近 30 天下载量：84988（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 11 个）

## 中文简介

Ping保护模块打算与ForgeRock JavaScript SDK一起被使用,为我们现有的ForgeRock SDK客户提供Ping保护功能.

## 安装

```sh
npm install @forgerock/ping-protect
```

也可以使用：`pnpm add @forgerock/ping-protect`、`yarn add @forgerock/ping-protect`、`bun add @forgerock/ping-protect`

## README

# 小平保护

Ping保护模块打算与ForgeRock JavaScript SDK一起被使用,为我们现有的ForgeRock SDK客户提供Ping保护功能.

## 总体设计

服务器一侧有两个组件,客户端一侧有两个组件来启用这个功能. 你需要有以下内容:

1.  ForgeRock身份云(aka ID Cloud)平台或最新的ForgeRock访问管理(aka AM)
2.  启用有保护的 Ping One 租户
3.  在 ID Cloud 或 AM 中配置的 Ping 保护服务
4.  带适当保护节点的行程/树木
5.  客户端应用程序 `@forgerock/javascript-sdk` 财务报告和审定财务报表 `@forgerock/ping-protect` 已安装模块

## 客户端应用程序快速启动

安装两个模块及其最新版本:

```sh
npm install @forgerock/javascript-sdk @forgerock/ping-protect
```

```sh
pnpm add @forgerock/javascript-sdk @forgerock/ping-protect
```

平保护模块的两个主要职责是初始化剖面和数据收集以及完成并准备为服务器所收集的数据. 你可以找到两种方法 `PIProtect` 模块 `@forgerock/ping-protect` 模块.

-   `PIProtect.start()`
-   `PIProtect.getData()`

这个 `start` 方法可以在应用程序启动时或当收到时调用 `PingOneProtectInitializeCallback` 从服务器调用。 我们建议你打电话 `start` 以尽可能多地收集更准确的数据.

打电话时 `start`,您有许多不同的选项来配置数据是什么以及如何收集。 这些设置中最重要和最需要的是 `envId`。所有其他设置都是可选的.

```js
import { PIProtect } from '@forgerock/ping-protect';

// Call early in your application startup
PIProtect.start({ envId: '02fb1243-189a-4bc7-9d6c-a919edf6447' });
```

或者,您可以推迟初始化,直到您通过特殊调用从服务器收到指令: `PingOneProtectInitializeCallback`要做到这一点,你会打电话给 `start` 当回调值出现在行程中时.

```js
import { PIProtect } from '@forgerock/ping-protect';

if (step.getCallbacksOfType('PingOneProtectInitializeCallback')) {
  try {
    // Asynchronous call
    await PIProtect.start({ envId: '02fb1243-189a-4bc7-9d6c-a919edf6447' });
  } catch (err) {
    // handle error
  }
}
```

你打给 `FRAuth.next` 初始化后的方法,使用户在行程中前进.

```js
FRAuth.next(step);
```

在旅途的某个时刻,为了收集尽可能多的数据, 尽可能晚,你会遇到 `PingOneProtectEvaluationCallback`。这是当你叫 `getData` 用于包装已收集的供服务器评估的方法.

```js
import { PIProtect } from '@forgerock/ping-protect';

let data;

if (step.getCallbacksOfType('PingOneProtectEvaluationCallback')) {
  try {
    // Asynchronous call
    data = await PIProtect.getData();
  } catch (err) {
    // handle error
  }
}
```

既然我们有数据,就把它放在回调器上 以便在我们呼叫时发送到服务器 `next`。 。 。 .

```js
callback.setData(data);

FRAuth.next(step);
```

## 处理错误

当您在初始化或评估中遇到错误时, 请使用 `setClientError` 方法。 将信件设置在调用符上是它是如何被发送到服务器的 `FRAuth.next` 方法调用.

```js
if (step.getCallbacksOfType('PingOneProtectInitializeCallback')) {
  const callback = step.getCallbackOfType('PingOneProtectInitializeCallback');
  try {
    // Asynchronous call
    await PIProtect.start({ envId: '02fb1243-189a-4bc7-9d6c-a919edf6447' });
  } catch (err) {
    callback.setClientError(err.message);
  }
}
```

评价步骤也采用类似的程序.

```js
let data;

if (step.getCallbacksOfType('PingOneProtectEvaluationCallback')) {
  const callback = step.getCallbackOfType('PingOneProtectEvaluationCallback');
  try {
    // Asynchronous call
    data = await PIProtect.getData();
  } catch (err) {
    callback.setClientError(err.message);
  }
}
```

## 完整 API

```js
// PIProtect class methods
PIProtect.start();
PIProtect.getData();
PIProtect.pauseBehavioralData();
PIProtect.resumeBehavioralData();
```

```js
// PingOneProtectInitializeCallback class methods
callback.getConfig();
callback.setClientError();
```

```js
// PingOneProtectEvaluationCallback class methods
callback.setData();
callback.setClientError();
callback.getPauseBehavioralData();
```

## 常见问题

### @forgerock/ping-protect 是什么？

Ping保护模块打算与ForgeRock JavaScript SDK一起被使用,为我们现有的ForgeRock SDK客户提供Ping保护功能\.

### 如何安装 @forgerock/ping-protect？

在项目目录运行 npm install @forgerock/ping-protect，或使用 pnpm add / yarn add / bun add。

### @forgerock/ping-protect 支持 TypeScript 吗？

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

### @forgerock/ping-protect 支持 ESM 还是 CommonJS？

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

### @forgerock/ping-protect 可以商用吗？

@forgerock/ping-protect 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @forgerock/ping-protect 的下载量有多少？

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

### @forgerock/ping-protect 还在维护吗？

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