# @abgov/adsp-service-sdk 中文文档

规范地址：https://npmcn.com/package/%40abgov/adsp-service-sdk/

版本：2\.34\.1
npm 元数据更新时间：2026-11-06T19:15:07.001Z
中文译文更新时间：2026-11-06T13:40:37.526Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40abgov/adsp-service-sdk
原文对照：https://npmcn.com/package/%40abgov/adsp-service-sdk/?lang=original
项目主页：https://github.com/GovAlta/adsp-monorepo#readme
源码仓库：https://github.com/GovAlta/adsp-monorepo

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

- 包体积（解压后）：366 kB，212 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：23 个
- 首次发布：2022-09-09T14:34:45.809Z
- 最新版本发布：2026-11-06T19:15:06.695Z
- 近 30 天下载量：3087（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：66（近 12 个月 41 个）

## 中文简介

艾伯塔省政府 - SDK,用于ADSP平台和租户服务.

## 安装

```sh
npm install @abgov/adsp-service-sdk
```

也可以使用：`pnpm add @abgov/adsp-service-sdk`、`yarn add @abgov/adsp-service-sdk`、`bun add @abgov/adsp-service-sdk`

## README

# 服务- sdk

艾伯塔省数字服务平台的SDK.

利用这个图书馆为ADSP建造以节点为基础的平台和租户服务.

## 开始

初始化SDK,用于平台或租户服务.

```typescript
  import { AdspId, initializePlatform } from '@abgov/adsp-service-sdk';

  const serviceId = AdspId.parse(environment.CLIENT_ID);
  const {
    coreStrategy,
    tenantStrategy,
    ...sdkCapabilities,
  } = await initializePlatform(
    {
      displayName: 'My platform service',
      description: 'Example of a platform service.',
      serviceId,
      accessServiceUrl: new URL(environment.KEYCLOAK_ROOT_URL),
      clientSecret: environment.CLIENT_SECRET,
      directoryUrl: new URL(environment.DIRECTORY_URL),
      configurationSchema,
      events: [],
      roles: [],
      notifications: [],
    },
    { logger }
  );
```

见 [ADSP 发展指南](https://govalta.github.io/adsp-monorepo) 详细情况.

## 审计行动分类

在定义审计行动时使用共享常数 :

```typescript
import {
  AuditAction,
  AuditCategories,
  AuditSeverities,
  BuiltInRetentionClasses,
} from '@abgov/adsp-service-sdk';

const UPDATE_CASE: AuditAction = {
  name: 'case.update',
  version: 1,
  category: AuditCategories.Administrative,
  severity: AuditSeverities.Info,
  retentionClass: BuiltInRetentionClasses.Compliance,
};
```

`AuditCategory` 财务报告和审定财务报表 `AuditSeverity` 由常数产生的字符串结合,所以存在 字符串正文和序列目录值仍然兼容. `retentionClass` 现为a 字符串: 应用程序可能使用自定义类名称, 如 `case-history` 当一个相应的 保留期已配置。 内建类常数指定名称,而不是保留期.

## 审计服务客户端

注册行动 `auditActions` 并记录返回的事件 `auditService`数字 :

```typescript
const { auditService } = await initializeService(
  { serviceId, displayName: 'Case service', description: 'Case management', auditActions: [UPDATE_CASE] },
  { logger },
);

const outcome = await auditService.record(UPDATE_CASE, { actor: { id: user.id, type: 'user' } });
if (outcome.status !== 'recorded') {
  logger.warn(`Audit event ${outcome.eventId} was not recorded: ${outcome.reason}`);
}
```

默认情况下,每个事件都会在自己的HTTP请求中立即发送. 等着 `record()` 检查它的 结果:它绝不拒绝 `recorded` 是指服务确认的存储器或同位素 重复,不只是在记忆中排队接收。 一旦所有电话结算,就不再单独审计 `flush()` 这是需要的。 正常的应用程序关闭必须等待飞行中的请求和任务. 立即发送并不能使火灾和遗忘的呼叫安全防止过程终止.

对于高通量工作量,选择客户端分批通过 `audit` 选项 `initializeService` 或者说 `initializePlatform`数字 :

```typescript
const { auditService } = await initializeService(
  {
    ...serviceOptions,
    auditActions: [UPDATE_CASE],
    audit: { batchSize: 100, batchIntervalMs: 500 },
  },
  { logger },
);
```

通过设置启用了夹击 `batchSize` 大于 1; 部分批次等待至 `batchIntervalMs` (默认为500毫秒). 关机前,打电话 `await auditService.flush()` 如果批号 或未等待的记录。 此配置保留了先前的100个事件/ 500-ms的行为; 新默认会增加 HTTP 请求量 。 审计处仍然在数据库上批发 服务器,独立于客户端批量.

两种模式都保留有限制的飞行/重试内存,瞬间重试相同 `eventId`,以及 页:1 `audit.client.dropped_events` 标准。 失败的交付如果 响应已丢失; 以相同方式重发送 `eventId`。 。 。 . `AuditClientOptions` 导出为已键入 配置,包括请求超时和重试延迟. 见 [审计事务文件](https://govalta.github.io/adsp-monorepo/services/audit-service.html)。 。 。 .

## 常见问题

### @abgov/adsp-service-sdk 是什么？

艾伯塔省政府 - SDK,用于ADSP平台和租户服务\.

### 如何安装 @abgov/adsp-service-sdk？

在项目目录运行 npm install @abgov/adsp-service-sdk，或使用 pnpm add / yarn add / bun add。

### @abgov/adsp-service-sdk 支持 TypeScript 吗？

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

### @abgov/adsp-service-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @abgov/adsp-service-sdk 可以商用吗？

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

### @abgov/adsp-service-sdk 的下载量有多少？

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

### @abgov/adsp-service-sdk 还在维护吗？

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