# @digitalbazaar/di-sd-primitives 中文文档

规范地址：https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/

版本：3\.3\.0
npm 元数据更新时间：2026-04-27T20:52:14.269Z
中文译文更新时间：2026-11-12T08:38:51.791Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40digitalbazaar/di-sd-primitives
原文对照：https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/?lang=original
项目主页：https://github.com/digitalbazaar/di-sd-primitives
源码仓库：https://github.com/digitalbazaar/di-sd-primitives

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

- 包体积（解压后）：29.3 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：4 个
- 首次发布：2023-05-19T20:15:30.632Z
- 最新版本发布：2026-04-27T20:52:14.027Z
- 近 30 天下载量：25753（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 2 个）

## 中文简介

数据完整性 选择性披露

## 安装

```sh
npm install @digitalbazaar/di-sd-primitives
```

也可以使用：`pnpm add @digitalbazaar/di-sd-primitives`、`yarn add @digitalbazaar/di-sd-primitives`、`bun add @digitalbazaar/di-sd-primitives`

## README

# 数据完整性 选择性披露 _(@digitalbazaar/di-sd-primitives) (中文(简体) )_

[![Build Status](https://img.shields.io/github/actions/workflow/status/digitalbazaar/di-sd-primitives/main.yaml)](https://github.com/digitalbazaar/di-sd-primitives/actions/workflow/main.yaml) [![Coverage Status](https://img.shields.io/codecov/c/github/digitalbazaar/di-sd-primitives)](https://codecov.io/gh/digitalbazaar/di-sd-primitives) [![NPM Version](https://img.shields.io/npm/v/@digitalbazaar/di-sd-primitives.svg)](https://npm.im/@digitalbazaar/di-sd-primitives)

> DI-SD(发布"DICED")(数据完整性选择披露) 与数据完整性选择性披露密码套件和jsonld签名.

## 目录

-   [背景情况](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-background)
-   [警卫](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-security)
-   [安装](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-install)
-   [使用量](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-usage)
-   [贡献](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-contribute)
-   [商业支助](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-commercial-support)
-   [许可证](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/#readme-license)

## 背景情况

用于与 [https://github.com/digitalbazaar/jsonld-signers (中文(简体) )](https://github.com/digitalbazaar/jsonld-signatures) v11.2及以上编.

另见相关的规格:

-   [可验证的可信数据完整性](https://w3c.github.io/vc-data-integrity/)

## 警卫

传统发展

## 安装

该软件需要并支持维持的最近版本的Node.js和 浏览器. 更新可能会去除对旧的未维护的平台版本的支持. 请使用依赖性版本锁文件和测试以确保兼容性 与这个软件.

从国家预防机制安装:

```sh
npm install @digitalbazaar/di-sd-primitives
```

在当地安装(用于开发):

```sh
git clone https://github.com/digitalbazaar/di-sd-primitives.git
cd di-sd-primitives
npm install
```

## 使用量

以下代码片段提供了一个完整的数字签名示例 使用此库的可核查证书:

```javascript
import * as primitives from '@digitalbazaar/di-sd-primitives';

// canonize a document (e.g., Verifiable Credential (VC)) and replace blank
// node IDs that are informationally decoupled from the data in the document
const hmac = await primitives.createHmac({key: hmacKey});
const labelMapFactoryFunction =
  primitives.createHmacIdLabelMapFunction({hmac});
// returns an array of nquads
const result = await primitives.labelReplacementCanonicalizeJsonLd(
  {document: credential, labelMapFactoryFunction, options: {documentLoader}});

// canonize a document (e.g., VC) and replace blank node IDs with any
// values; most useful for verifiers to use a label map provided in a
// selectively disclosed proof (verifiers do not get the HMAC key, so they
// cannot generate *any* HMAC'd ID, they only get the disclosed labels)
const labelMap = new Map([
  ['c14n0', 'uSomeBase64UrlHMACDigest1'],
  ['c14n1', 'uSomeBase64UrlHMACDigest2'],
  ['c14n2', 'uSomeBase64UrlHMACDigest3']
]);
const labelMapFactoryFunction = primitives.createLabelMapFunction({labelMap});
// returns an array of nquads
const result = await primitives.labelReplacementCanonicalizeJsonLd(
  {document: credential, labelMapFactoryFunction, options: {documentLoader}});

// skolemize a document (e.g., VC), which replaces blank node IDs with stable
// URL IDs; most useful for performing selecting portions of a JSON-LD document
// and finding the matching selected N-Quads;
// `result` has `{expanded, compact}` for both expanded and compact forms of
// the skolemized JSON-LD document; the expanded form is often deskolemized to
// N-Quads and then canonicalized to produce canonical N-Quads and a mapping
// from the deskolemized blank node IDs to the canonical IDs; the compact form
// can then have N-many selection operations performed on it with the selection
// outputs too being converted to deskolemized N-Quads which can be mapped to
// matching canonical N-Quads
const result = await skolemizeCompactJsonLd({document, options});

// get deskolemized N-Quads from a document; most useful for converting
// previously skolemized expanded JSON-LD documents to canonicalize and
// generate a map of stable identifiers or for converting previously skolemized
// compact JSON-LD documents after selecting a portion of them for selective
// disclosure; see `selectCanonicalNQuads` primitive
const deskolemizedNQuads = await toDeskolemizedNQuads(
  {document: skolemizedExpandedOrCompactJsonLd, options});

// canonize N-Quads and replace blank node IDs and get a label mapping from
// the original blank node IDs to the new ones; most useful for canonizing
// deskolemized N-Quads to produce a
const hmac = await primitives.createHmac({key: hmacKey});
const labelMapFactoryFunction =
  primitives.createHmacIdLabelMapFunction({hmac});
// returns an object with `{nquads, labelMap}`, the array of nquads and the
// mapping from input blank node IDs to output blank node IDs (after the
// canonical IDs have been replaced using the given replacement label map)
const result = await primitives.labelReplacementCanonicalizeNQuads(
  {nquads, labelMapFactoryFunction, options: {documentLoader}});

// use JSON pointers to select a specific part of a JSON-LD document
// (e.g., VC); can be used on a regular or skolemized compact JSON-LD document
const pointers = [
  '/credentialSubject/driverLicense/dateOfBirth',
  '/credentialSubject/driverLicense/expirationDate'
];
const result = await primitives.selectJsonLd(
  {document: credential, pointers});
```

## 贡献

见 [贡献文件](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)来啊!

公关接受.

请遵照 [标准读取](https://github.com/RichardLitt/standard-readme) 规格.

## 商业支助

该图书馆的商务支助可应下列请求提供: 数字集市: [支持@ digitalbazaar.com](mailto:support@digitalbazaar.com)

## 许可证

[新建 BSD 许可证( 3- clause)](https://npmcn.com/package/%40digitalbazaar/di-sd-primitives/LICENSE) 2023年数字集市

## 常见问题

### @digitalbazaar/di-sd-primitives 是什么？

数据完整性 选择性披露

### 如何安装 @digitalbazaar/di-sd-primitives？

在项目目录运行 npm install @digitalbazaar/di-sd-primitives，或使用 pnpm add / yarn add / bun add。

### @digitalbazaar/di-sd-primitives 支持 TypeScript 吗？

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

### @digitalbazaar/di-sd-primitives 支持 ESM 还是 CommonJS？

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

### @digitalbazaar/di-sd-primitives 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @digitalbazaar/di-sd-primitives 可以商用吗？

@digitalbazaar/di-sd-primitives 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @digitalbazaar/di-sd-primitives 的下载量有多少？

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

### @digitalbazaar/di-sd-primitives 还在维护吗？

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

