DREAMNUM.md

dream-num/univer

The open-source, isomorphic office SDK for building embeddable spreadsheet, document, and presentation experiences in browsers and Node.js.

Responsibilities

Owns

• The open-source Univer runtime, plugin system, command and service infrastructure, Facade API, formula engine, and Canvas rendering engine. See the repository overview.
• Open-source models, editing capabilities, and UI plugins for Sheets, Docs, and Slides, including shared drawing, commenting, validation, formatting, and localization infrastructure. See the open-source capability boundary.
• Browser, Node.js, and Web Worker integration paths, plus React-based UI and Vue 3 and Web Component adapters. See the compatibility and integration overview.
• First-party open-source package presets and the examples and test projects used to exercise the SDK. See the workspace definition and repository guide.
• Public API compatibility rules for stable, experimental, internal, and deprecated interfaces. See the API Stability Policy.

The repository does not own Univer Pro's commercial collaboration, import/export, server, or enterprise capabilities; those are a separate extension layer described in the open-source and Pro boundary.

Provides

• @univerjs/core, @univerjs/engine-formula, and @univerjs/engine-render — Core runtime and data models, Facade APIs, formula calculation, and shared rendering. Contract: package manifests and API reference.
• @univerjs/sheets, @univerjs/docs, @univerjs/slides, and their UI and feature packages — Composable office models, plugins, and editing interfaces. Contract: package directory and API stability rules.
• @univerjs/presets and @univerjs/preset-* — Curated plugin collections for browser and Node.js integrations. Contract: preset packages and preset-mode guide.
• @univerjs/ui-adapter-vue3 and @univerjs/ui-adapter-web-component — Framework adapters for integrating Univer UI services. Contract: Vue 3 adapter and Web Component adapter.
• sync-univer repository-dispatch event — Notifies the separate Univer Pro repository after changes reach dev. Contract: dispatch workflow.

Depends on

• dream-num/univer-icons — Owns the React icon components and SVG assets consumed by Univer UI packages. Contract: @univerjs/ui manifest and SVG asset dependency.
• jikkai/verso — Owns the workspace release CLI used to version and tag Univer packages. Contract: root package manifest.

Authoritative sources

• Product documentation: docs.univer.ai.
• API reference: Univer Facade API.
• Development guidance: README.md and CONTRIBUTING.md.
• Package contracts: packages/, presets/, and API Stability Policy.
• Package release source: npm release workflow.
• Security policy: SECURITY.md.

Update contract

Update this file in the same change when any of these facts change:

• repository responsibilities or boundaries;
• outgoing cross-repository dependencies;
• public packages, APIs, protocols, events, images, or data contracts;
• deployment source, runbook, or data classification.