Ejemplos

Ejecuta ejemplos de Collaboration SDK por función y consulta sus guías y entradas de servidor y Web.

Todos los ejemplos están en univer-collaboration-examples. Usan la misma estructura mínima web/main.ts + server/main.ts y se ejecutan de forma independiente. Completa el inicio rápido y elige después según tu integración.

Ejemplo	Concepto principal	Comando
Inicio rápido	Circuito colaborativo principal	`pnpm example:quick-start`
Adaptador de base de datos	Adaptadores de base de datos	`pnpm example:database-adapter`
Permisos	Identidad y autorización	`pnpm example:permissions`
Historial	Historial derivado	`pnpm example:history`
Comentarios	Comentarios independientes	`pnpm example:comments`
Worktree	Edición aislada y fusión	`pnpm example:worktree`
Conversión de archivos	Conversión Office	`pnpm example:exchange`
Despliegue en varios nodos	Escalado horizontal	`pnpm example:multi-node`

Inicio rápido

Combina Collaboration Client, Transport, Endpoint, Service y Memory Adapter. Verifica en dos navegadores la carga HTTP, Sessions WebSocket, Room, ACK y difusión para la misma Sheet.

Bash

pnpm example:quick-start

Abre http://127.0.0.1:3010/?unit=quick-start-sheet.

Adaptador de base de datos

Este ejemplo muestra cómo usar el SQLite Adapter integrado e implementar un Database Adapter personalizado.

Bash

pnpm example:database-adapter

Abre http://127.0.0.1:3010/?unit=persistent-sheet.

Permisos

Crea una identidad fiable desde una cookie y protege por separado lectura HTTP Unit, JOIN en tiempo real y envío de cambios. La página alterna entre un Alice · Editor didáctico y un Bob · Viewer de solo lectura.

Bash

pnpm example:permissions

Abre http://127.0.0.1:3010.

Historial

Añade fuera del núcleo History Service, un Adapter separado, History Endpoint y la entrada de historial del navegador. Los Events de creación Unit y commit construyen un índice derivado reconstruible.

Bash

pnpm example:history

Abre http://127.0.0.1:3010/?unit=history-sheet, edita la Sheet y selecciona History arriba.

Comentarios

Añade Thread Comment Service, un Adapter separado, Comment Endpoint y la entrada frontend. Comment Endpoint reutiliza las Sessions y Rooms Unit del Endpoint principal.

Bash

pnpm example:comments

Abre http://127.0.0.1:3010/?unit=comments-sheet, selecciona una celda y usa la entrada de comentarios.

Worktree

Demuestra el ciclo completo de borrador aislado, Ready, Reopen y Merge por Unit. Alterna tronco y borrador para ver cómo los cambios del AI Agent quedan aislados antes de fusionar.

Bash

pnpm example:worktree

Abre http://127.0.0.1:3010/?unit=worktree-sheet&worktree=demo-worktree.

Conversión de archivos

Combina @univerjs-pro/exchange-node y Collaboration Service para importar/exportar Sheet en servidor, consultar tareas, importar instantáneas y exportar revisiones confirmadas.

Bash

pnpm example:exchange

Abre http://127.0.0.1:3010/?unit=exchange-sheet. Importa con File → Open (File) y exporta con File → Save As.

Despliegue en varios nodos

Ejecuta dos nodos de colaboración detrás de Nginx. Redis reenvía las actualizaciones en tiempo real entre nodos y comparte los session tickets, de modo que cualquier nodo puede atender cualquier solicitud. Requiere Docker Compose.

Bash

pnpm example:multi-node

Abre http://127.0.0.1:3010/ y haz clic en New Sheet para crear un archivo. Copia la URL completa en otra pestaña para verificar la edición colaborativa del mismo documento. Después, crea algunos archivos más para observar cómo se distribuyen entre los nodos.

Guía del ejemplo

Los ejemplos no son aplicaciones de producción

Usuarios fijos, autorización didáctica, Memory Adapters, secretos locales y almacenamiento de archivos y tareas en memoria son solo educativos. La aplicación gestiona identidad, autorización, persistencia, secretos, archivos, despliegue e interacción.

¿Cómo es esta guía?