@univerjs-pro/collaboration-client

Client-side collaboration plugin for Web SDK.

import type { IUniverCollaborationClientConfig } from '@univerjs-pro/collaboration-client'import { UniverCollaborationClientPlugin } from '@univerjs-pro/collaboration-client'import { BrowserCollaborationSocketService } from '@univerjs-pro/collaboration-client-ui'const config: IUniverCollaborationClientConfig = {  socketService: BrowserCollaborationSocketService,}univer.registerPlugin(UniverCollaborationClientPlugin, config)

socketService is required. Browser clients can use BrowserCollaborationSocketService; other hosts must provide their own ICollaborationSocketService implementation.

Entry Points

• Facade: @univerjs-pro/collaboration-client/facade
• Locale: @univerjs-pro/collaboration-client/locale/*

The Facade entry exposes host-specific loaders for Sheets, Docs, Bases, Slides, Boards, and PDFs, including loadPdfAsync(unitId, context?).

IUniverCollaborationClientConfig

import type { IAttachmentUploadOptions, ICollaborationSocketService } from '@univerjs-pro/collaboration-client'import type { Ctor, DependencyOverride } from '@univerjs/core'import type { UnitObject } from '@univerjs/protocol'export interface IUniverCollaborationClientConfig {  socketService: Ctor<ICollaborationSocketService>  enableCollaboration?: boolean  enableOfflineEditing?: boolean  enableSingleActiveInstanceLock?: boolean  enableAuthServer?: boolean  override?: DependencyOverride  sendChangesetTimeout?: number  changesetAckTimeout?: number  maxChangesetAckTimeout?: number  snapshotServerUrl?: string  collabSubmitChangesetUrl?: string  collabWebSocketUrl?: string  wsSessionTicketUrl?: string  loginUrlKey?: string  retryConnectingInterval?: number  authzUrl?: string  objectPermissionTypes?: UnitObject[]  downloadEndpointUrl?: string  uploadFileServerUrl?: string  signUrlServerUrl?: string  attachment?: IAttachmentUploadOptions  customHeaders?: Record<string, string>}

enableCollaboration defaults to true; enableOfflineEditing defaults to false. objectPermissionTypes opts into stable-ID object permissions supported by your Authz server; the backend must authorize every binding change. attachment controls shared upload restrictions and an optional custom uploader.

Batching and acknowledgement timeouts

The Sheets and Docs collaboration presets use a 200 ms batching delay and do not expose acknowledgement timeout options. Configure the client plugin directly when you need to change those options.

FCollaboration.hasWritePending(unitId?) includes queued, awaiting-acknowledgement, and offline edits. CollaborationStatusChanged reports existing units' current status when the listener is registered and suppresses consecutive identical statuses. CollaborationChangesetResend reports retries; CollaborationConflict carries the conflict reason and unacknowledged edits after the cache-cleanup attempt. See synchronization and recovery.