Collaboration SDK の概要

Univer Collaboration SDK は、Univer のドキュメントモデル向けのサーバーサイド共同編集 SDK です。操作変換（OT¹）、リビジョン²、スナップショット、リアルタイム同期、永続化を提供し、複数の Univer クライアントが同じサーバー管理の Unit を編集できるようにします。

開発者は自身の Node.js アプリケーションに組み込み、Middleware で本人確認と認可を接続し、Middleware や Events でログなどのアプリケーションロジックを拡張します。Database Adapter は共同編集データをアプリケーションのデータベースに接続します。

解決する課題

Web SDK はブラウザーで Sheet、Doc、Slide、Board、Base の内容を表示・編集します。複数人で編集するには、内容の読み込み、並行変更の確定、リビジョンの更新、切断したクライアントの整合した状態への復帰を担うサーバーも必要です。

次のようなアプリケーションに適しています。

• Univer でエディターを構築済みで、リアルタイムの共同編集が必要；
• 共同編集データを自らホストし、データベースを選びたい；
• 既存の本人確認、認可、テナントルールを共同編集操作に接続したい；
• 基本的な共同編集に History、Thread Comment、Worktree を追加したい。

共同編集サービスの全体像

SDK が提供する機能

中核機能は次のとおりです。

• Sheet、Doc、Slide、Board、Base の Unit の作成、読み込み、削除、復元；
• スナップショット、変更セット、リビジョン、OT、送信の冪等性；
• HTTP による内容の読み込みと WebSocket の Session、Room、Presence、ACK、ブロードキャスト；
• Transport、Endpoint、Service 境界の Middleware；
• Unit 作成、変更セットのコミット、削除、復元に対応するプロセス内 Events；
• Memory、SQLite、カスタム Database Adapter の契約；
• 複数ノードへのデプロイによる水平スケーリング。ノード間は pub/sub アダプターと共有の Session Ticket ストアで連携し、SDK は Redis 実装を提供します。

基本経路が動作したら、バージョン履歴、スレッドコメント、Worktree の下書き、サーバーでの Office ファイル変換を追加できます。これらは独自の Service、Middleware、Events、Database Adapter を持ちます。

アプリケーションが担う機能

3 つの汎用拡張ポイント

本人確認と認可は Middleware で接続します。操作前の検証・制限には Middleware、状態確定後の変更記録や後続処理には Events を使います。どちらもログ、リクエスト追跡、メトリクス、派生状態の更新に使えます。実行境界は Middleware と Events を参照してください。

次のステップ

1. クイックスタートで、2 つのブラウザーから全体の動作を確認します。
2. モジュールの境界と関係で各パッケージの役割を理解します。
3. 統合する内容に応じて Middleware と Events、本人確認と認可、データベースアダプターに進みます。
4. History、コメント、Worktree、ファイル変換は共同編集の拡張モジュールを参照してください。

Footnotes

1. *操作変換（OT）*は、異なる文書リビジョンに対して同時に生成された操作を調整し、一貫して適用できるようにします。最後に届いたスナップショットで文書全体を置き換える方式ではありません。 ↩

2. リビジョンは Unit の確定済み編集履歴における位置です。changeset は送信する操作の集合で、その確定により履歴が進みます。SDK パッケージのバージョンやタイムスタンプではありません。 ↩