Resumen de paquetes
Conoce los paquetes públicos de Core, History, Thread Comment, Worktree, File y Office Exchange.
Esta página guía la selección. Compón primero Core Collaboration y añade las extensiones necesarias. No necesitas instalar todos los paquetes.
Los paquetes de servidor de Database Adapter, File y Office Exchange son de código abierto bajo Apache-2.0; el código está en univer-collaboration-sdk-community. Comparten el prefijo de paquete y la versión del resto de paquetes y se instalan igual.
Core Collaboration
Core Collaboration proporciona el flujo principal de colaboración en navegador, protocolo de servidor, OT, revisiones y persistencia.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | @univerjs-pro/collaboration | Registra las capacidades básicas de colaboración del navegador |
| Navegador | @univerjs-pro/collaboration-client | Carga Units, envía cambios y mantiene sincronización en tiempo real |
| Navegador | @univerjs-pro/collaboration-client-ui | Proporciona UI y estilos de estado colaborativo |
| Server | @univerjs-pro/collaboration-transport-node | Recibe tráfico HTTP y WebSocket de Node.js |
| Server | @univerjs-pro/collaboration-endpoint | Implementa protocolo Client, Sessions, Rooms y Presence |
| Server | @univerjs-pro/collaboration-service | Gestiona Units, OT, revisiones y API centrales |
| Base de datos | @univerjs-pro/collaboration-database-memory | Almacenamiento en proceso para pruebas, ejemplos y desarrollo temporal |
| Base de datos | @univerjs-pro/collaboration-database-sqlite | Persistencia SQLite para desarrollo, pruebas, uso local y pequeña escala |
| Base de datos | @univerjs-pro/collaboration-database-postgres | Persistencia PostgreSQL compartida por varios nodos |
| Multi-node | @univerjs-pro/collaboration-cluster-redis | Adaptador pub/sub y almacén de session tickets sobre Redis para el despliegue en varios nodos |
Core Server necesita Transport, Endpoint, Service y un Database Adapter. Memory, SQLite y PostgreSQL cumplen el mismo contrato; normalmente se elige uno. Un despliegue en varios nodos necesita además un adaptador pub/sub y un almacén de session tickets compartido. El Endpoint define ambos contratos (IPubSubAdapter, ISessionTicketStore); el SDK ofrece una implementación sobre Redis.
History
History construye un índice de versiones con eventos de creación de Unit y commit del Core.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | Reutiliza Core Client/UI | Muestra y lee entradas del historial |
| Server | @univerjs-pro/collaboration-history-service | Construye y consulta el índice del historial |
| Server | @univerjs-pro/collaboration-history-endpoint | Proporciona el protocolo History al Client |
| Base de datos | @univerjs-pro/collaboration-history-database-memory | Almacenamiento en proceso del índice History |
| Base de datos | @univerjs-pro/collaboration-history-database-sqlite | Guarda el índice derivado de History |
El historial es un índice derivado reconstruible. Los cambios Core siguen siendo la referencia del contenido.
Thread Comment
Thread Comment gestiona textos, respuestas y estado resuelto en Sheets y Docs.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | Reutiliza paquetes Core Collaboration | Usa Comment Client y UI |
| Server | @univerjs-pro/collaboration-comment-service | Gestiona comentarios y el evento commentCommitted |
| Server | @univerjs-pro/collaboration-comment-endpoint | Proporciona el protocolo y publica cambios en Unit Rooms |
| Base de datos | @univerjs-pro/collaboration-comment-database-memory | Almacenamiento de comentarios en proceso |
| Base de datos | @univerjs-pro/collaboration-comment-database-sqlite | Persistencia de comentarios en SQLite |
Comment Adapter guarda los comentarios. Los anclajes que se mueven con el contenido siguen en instantáneas y cambios Core.
Worktree
Worktree ofrece borradores aislados, transiciones y fusión por Unit.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | @univerjs-pro/collaboration-worktree-client | Conecta borradores, estados y fusión Worktree |
| Server | @univerjs-pro/collaboration-worktree-service | Gestiona cambios del borrador, estado y fusión |
| Server | @univerjs-pro/collaboration-worktree-endpoint | Proporciona el protocolo a Worktree Client |
| Base de datos | @univerjs-pro/collaboration-worktree-database-memory | Almacenamiento Worktree en proceso |
| Base de datos | @univerjs-pro/collaboration-worktree-database-sqlite | Persistencia Worktree en SQLite |
Worktree Service fusiona en trunk mediante Core Service; configura Middleware en ambas fronteras.
File
File almacena los archivos binarios que suben los clientes Univer: imágenes y adjuntos insertados en una Unit, además de los archivos de origen y resultado de la importación y exportación. Los datos de la Unit solo registran el ID del archivo.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | Reutiliza el Core Collaboration Client | Sube imágenes y adjuntos y resuelve los ID de archivo a URL |
| Server | @univerjs-pro/collaboration-file-service | Aplica las reglas de propiedad, el Middleware y la limpieza de archivos temporales |
| Server | @univerjs-pro/collaboration-file-endpoint | Proporciona las rutas de subida, sign-url y descarga |
| Base de datos | @univerjs-pro/collaboration-file-memory | Almacenamiento en proceso de metadatos y contenido |
| Base de datos | @univerjs-pro/collaboration-file-database-sqlite | Persistencia SQLite de los metadatos de archivo |
| Base de datos | @univerjs-pro/collaboration-file-database-postgres | Persistencia PostgreSQL de los metadatos de archivo |
| Almacenamiento | @univerjs-pro/collaboration-file-blob-local | Guarda el contenido en un directorio local |
| Almacenamiento | @univerjs-pro/collaboration-file-blob-s3 | Guarda el contenido en un almacenamiento de objetos compatible con S3, con enlaces directos firmados |
Metadatos y contenido son dos contratos independientes, así que cada uno puede seguir el almacenamiento que ya usa la aplicación, por ejemplo metadatos en la base de datos y contenido en el almacenamiento de objetos.
Office Exchange
Office Exchange importa archivos Office como Units colaborativas y exporta Units como archivos. File guarda los archivos de origen y resultado.
| Entorno | Paquete | Responsabilidad principal |
|---|---|---|
| Navegador | @univerjs-pro/exchange-client | Proporciona intercambio básico de archivos del navegador |
| Navegador | @univerjs-pro/sheets-exchange-client | Proporciona importación y exportación Sheet |
| Server | @univerjs-pro/collaboration-exchange-service | Gestiona las task de importación y exportación, el Middleware y la creación y lectura de Units |
| Server | @univerjs-pro/collaboration-exchange-endpoint | Proporciona las rutas de importación, exportación y task |
| Server | @univerjs-pro/exchange-node | Convierte Office y datos Univer en Node.js |
Exchange Service crea y lee Units a través de Core Service y lee y escribe archivos a través de File Service, por lo que se compone junto con Core y File.
Reglas de selección
- Empieza por los paquetes Core de Inicio rápido.
- Elige un Core Database Adapter: Memory, SQLite, PostgreSQL o propio.
- Para un despliegue en varios nodos, añade el adaptador pub/sub y el almacén de session tickets sobre Redis.
- Instala solo las extensiones que use el producto.
- Para imágenes, adjuntos o importación y exportación, compón primero File y añade Office Exchange si hace falta.
- Crea Adapters separados por módulo aunque compartan una base de datos.
Consulta Extensiones de colaboración para relaciones e Índice de ejemplos para composiciones ejecutables.
¿Cómo es esta guía?