# @univerjs/protocol

> Shared protocol types, generated service interfaces, and data contracts for Univer.

Latest version **1.0.2** (published 2026-09-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @univerjs/protocol
pnpm add @univerjs/protocol
yarn add @univerjs/protocol
bun add @univerjs/protocol
```

## Health

**Score 80/100 (A)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2026-09-24 |
| First published | 2024-02-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 170.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 14368 |
| Author | DreamNum Co., Ltd. <developer@univer.ai> |
| Maintainers | jikkai, wbfsa, mengshukeji |
| Keywords | univer, protocol, types, grpc, contracts |

## Links

- npm: https://www.npmjs.com/package/@univerjs/protocol
- Repository: https://github.com/dream-num/univer
- Homepage: https://univer.ai
- Issues: https://github.com/dream-num/univer/issues
- Funding: https://opencollective.com/univer
- npm.io page: https://npm.io/package/@univerjs/protocol

## Dependencies (1)

- [@grpc/grpc-js](https://npm.io/package/@grpc/grpc-js.md) ^1.14.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2026-09-24
- 1.0.0-rc.0 (rc) — 2026-09-10
- 1.0.0-beta.2 (beta) — 2026-08-22
- 1.0.0-insiders.20260813-7c9aa50 (insiders) — 2026-08-13
- 1.0.0-alpha.8 (alpha) — 2026-07-29
- 0.1.47-alpha.0 (nightly) — 2025-05-24
- 1.0.1 — 2026-09-24
- 1.0.0 — 2026-09-23
- 0.25.2 — 2026-09-17
- 1.0.0-beta.1 — 2026-08-15
- 1.0.0-insiders.20260809-70eefdd — 2026-08-09
- 1.0.0-insiders.20260808-70eefdd — 2026-08-08
- 1.0.0-beta.0 — 2026-08-05
- 1.0.0-insiders.20260805-b15e7f3 — 2026-08-05
- 1.0.0-insiders.20260804-bf9a7c5 — 2026-08-04
- … 249 more at https://npm.io/package/@univerjs/protocol/versions

## README

# @univerjs/protocol

[![npm version](https://img.shields.io/npm/v/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)
[![license](https://img.shields.io/npm/l/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)
[![downloads](https://img.shields.io/npm/dm/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)

`@univerjs/protocol` contains shared protocol types, generated service interfaces, and data contracts used across Univer packages.

## Package Overview

| Package | UMD global | CSS | Locales | Facade entry |
| --- | --- | :---: | :---: | :---: |
| `@univerjs/protocol` | `UniverProtocol` | No | No | No |

## Installation

```sh
pnpm add @univerjs/protocol
# or
npm install @univerjs/protocol
```

Keep all `@univerjs/*` packages on the same version.

## Usage

```ts
import type { IWorkbookMeta } from '@univerjs/protocol';
```

## Resources

- [Documentation](https://docs.univer.ai)
- [NPM package](https://npmjs.com/package/@univerjs/protocol)
- [GitHub repository](https://github.com/dream-num/univer)

---
_Source: https://npm.io/package/@univerjs/protocol · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._