# @blockprotocol/service 中文文档

规范地址：https://npmcn.com/package/%40blockprotocol/service/

版本：0\.1\.5
npm 元数据更新时间：2024-06-30T15:26:47.767Z
中文译文更新时间：2026-11-08T07:28:20.981Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：389 kB，32 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.0\.0
- 首次发布：2023-02-10T22:43:58.364Z
- 最新版本发布：2024-03-19T12:56:01.005Z
- 近 30 天下载量：23168（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 0 个）

## 中文简介

实施区块议定书服务模块规格和嵌入应用

## 安装

```sh
npm install @blockprotocol/service
```

也可以使用：`pnpm add @blockprotocol/service`、`yarn add @blockprotocol/service`、`bun add @blockprotocol/service`

## README

## 区块协议-服务单元

这个软件包为块和嵌入应用程序执行块协议服务模块.

要开始 :

1.  `yarn add @blockprotocol/service` 或者说 `npm install @blockprotocol/service`
2.  遵循使用服务模块作为工具的指令 [块](https://npmcn.com/package/%40blockprotocol/service/#readme-blocks) 或一个 [嵌入应用程序](https://npmcn.com/package/%40blockprotocol/service/#readme-embedding-applications)

## 块

创建 `ServiceBlockHandler`中,将构造器传递到您块中的元素,以及您想要注册的用于处理来信的任何调用.

### 反应示例

对于反应,我们提供 `useServiceBlockModule` 钩子,它接受 `ref` 对一个元素,可选择任意 `callbacks` 您希望提供初始化服务.

### 自定义元素

创建一个 `ServiceBlockHandler` 在你体内。 如果您正在使用我们的模板, 您可以在构建的 Callback 实例法中添加此内容([公升文件](https://lit.dev/docs/components/lifecycle/#connectedcallback)),并可供您元素使用.

```ts
  ...
  connectedCallback() {
    super.connectedCallback();
    if (!this.serviceModule || this.serviceModule.destroyed) {
      this.serviceModule = new ServiceBlockHandler({
        element: this,
      });
    }
  }

  retrieveDirections(data) {
    if (!this.serviceModule) {
      throw new Error("Service module not available");
    }
    this.serviceModule.mapboxRetrieveDirections(args).then(() => { ... });
  }

  ...
```

## 嵌入应用程序

你应该建造一个 `ServiceEmbedderHandler` 每块.

目前无法用单一的处理器来包裹多个块.

创建 `ServiceEmbedderHandler`,通过构造器:

1.  一个 `element` 包装您的块
2.  `callbacks` 以响应块中的信息

```typescript
import { ServiceEmbedderHandler } from "@blockprotocol/service";

const serviceModule = new ServiceEmbedderHandler({
  callbacks: { ... },
  element: elementWrappingTheBlock,
});
```

### 反应

对于反应嵌入应用程序,我们提供一个 `useServiceEmbedderModule` 钩子,它接受 `ref` ,以及您想要通过的任何附加构造参数.

```tsx
import { useServiceEmbedderModule } from "@blockprotocol/service";
import { useRef } from "react";

export const App = () => {
  const wrappingRef = useRef<HTMLDivElement>(null);

  const { serviceModule } = useServiceEmbedderModule(blockRef);

  return (
    <div ref={wrappingRef}>
      <Block />
    </div>
  );
};
```

## 常见问题

### @blockprotocol/service 是什么？

实施区块议定书服务模块规格和嵌入应用

### 如何安装 @blockprotocol/service？

在项目目录运行 npm install @blockprotocol/service，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blockprotocol/service 支持 TypeScript 吗？

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

### @blockprotocol/service 支持 ESM 还是 CommonJS？

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

### @blockprotocol/service 可以商用吗？

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

### @blockprotocol/service 的下载量有多少？

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

### @blockprotocol/service 还在维护吗？

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