@eraserlabs/protocol

中文文档
0.5.2发布于 2026/11/12MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 1.1万

Reference TypeScript contracts, schema vocabulary, and machine-readable schemas for the Model Diagramming Protocol (MDP).

原始使用文档
文档目录3 节
  1. Introduction
  2. Why
  3. Usage

@eraserlabs/protocol

Introduction

@eraserlabs/protocol is the TypeScript and JSON Schema distribution of the Model Diagramming Protocol (MDP). MDP describes diagram elements, their visual templates, and the contracts that carry them through resolution, measurement, layout, and rendering. The protocol is vocabulary-neutral; this package is the reference distribution, and @eraserlabs/diagrams ships one MDP profile on top of it.

The package contains no resolver, browser, layout, filesystem, or network implementation.

Why

Resolve, render, and layout need a shared document and schema vocabulary. Putting those contracts in the packages that implement them would couple every consumer to Node, Chromium, or a particular profile. MDP keeps the wire shapes and annotations in one place; implementations and profiles stay replaceable.

Usage

import type { ResolvedDocument } from '@eraserlabs/protocol';
import { entitySchema } from '@eraserlabs/protocol/schema';
ExportContents
@eraserlabs/protocolMDP identifiers, resolved document/template/font contracts, semantic DOM roles
@eraserlabs/protocol/schemaJSON Schema subset, x-schema-kind / x-is-container and property annotations, kind helpers
@eraserlabs/protocol/schemas/documentBase authored-document JSON Schema
@eraserlabs/protocol/schemas/tag-schemaMeta-schema for a profile tag against the MDP 0.1 subset

Authored TypeScript input shapes (DiagramInput and related) live in @eraserlabs/resolve, which owns the input grammar. The protocol text is SPEC.md.

版本与发布记录

@eraserlabs/protocol 共发布 11 个版本,首次发布于 2026/08/19;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.2latest2026/11/122 天前
0.5.12026/11/059 天前
0.5.02026/11/0311 天前
0.4.32026/10/2816 天前
0.4.22026/10/2817 天前
0.4.12026/10/2817 天前

关于 @eraserlabs/protocol 的常见问题

@eraserlabs/protocol 是什么?

Reference TypeScript contracts, schema vocabulary, and machine-readable schemas for the Model Diagramming Protocol (MDP).

如何安装 @eraserlabs/protocol?

在项目目录运行 npm install @eraserlabs/protocol,或使用 pnpm add / yarn add / bun add。

@eraserlabs/protocol 支持 TypeScript 吗?

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

@eraserlabs/protocol 支持 ESM 还是 CommonJS?

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

@eraserlabs/protocol 需要什么版本的 Node.js?

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

@eraserlabs/protocol 可以商用吗?

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

@eraserlabs/protocol 的下载量有多少?

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

@eraserlabs/protocol 还在维护吗?

最新版本 0.5.2 发布于 2026/11/12(2 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/08/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。