Skip to content

docs(server): describe one License across Web SDK, Collaboration SDK and Exchange - #145

Draft
hexf00 wants to merge 11 commits into
devfrom
feat/office-sdk-license-final
Draft

hexf00 wants to merge 11 commits into
devfrom
feat/office-sdk-license-final

Conversation

@hexf00

@hexf00 hexf00 commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Background

Add License documentation for Collaboration SDK and for Exchange export configuration, next to the existing Web SDK License page.

Changes

License overview (server/license)

  • A table of where the License runs, which files each place needs, and what applies without a License.
  • Explicit configuration for Web SDK (plugin / preset), Collaboration SDK (UniverCollabService) and Exchange (configureExchange), each followed by the UNIVER_LICENSE / UNIVER_LICENSE_KEY fallback. The #in-plugin-mode / #in-preset-mode anchors used across the guides are kept.

Collaboration SDK License (server/collaboration/license, new)

  • What the License decides: collaborative editing connections (120-second rule), authorized domains, collaboration nodes (single-node vs multi-node License), document types.
  • The full collabService.license / endpoint.license API with types, and the editingConnectionsExceeded / nodesStatusChanged events.

Exchange License (server/import-export/license)

  • Retitled License to match the Collaboration SDK page; drops the pre-release note and the cross-references to the other SDKs.
  • Configuration, per-operation credentials, PDF, quota query and accounting as before.
  • The error example wraps an export, and the error table is ordered by how often each code occurs.

Other pages

  • Quick Start: set both variables before running the example.
  • Deployment: every collaboration node uses the same License, which covers the node count.
  • Collaboration integration: adds license_editing_connections_exceeded (resend) and license_unit_type_rejected (conflict) to the reason lists.
  • Examples: Multi-node needs a License that covers two nodes.

Before merging

  • Collaboration SDK 1.3.0 and the matching Exchange / native packages are published.
  • univer-collaboration-examples#34 merges at the same time (Quick Start and Examples describe its License setup).
  • es-ES, fr-FR, ja-JP, ko-KR, ru-RU and zh-TW are translated; until then those locales fall back to English.

Verification

  • Every changed page renders in next dev in zh-CN and en-US; the new anchors (#collaboration-sdk, #exchange, #editing-connections, #nodes, #unit-types, #多协同节点 / #multiple-collaboration-nodes) resolve.
  • The Collaboration SDK API listing matches the declarations on univer-collaboration-sdk main.
  • git diff --check and commitlint pass.

🤖 Generated with Claude Code

@hexf00
hexf00 force-pushed the feat/office-sdk-license-final branch 6 times, most recently from dd12a5a to 52ee602 Compare October 21, 2026 12:23
@hexf00
hexf00 force-pushed the feat/office-sdk-license-final branch from 52ee602 to 9a16464 Compare October 21, 2026 13:07
@hexf00 hexf00 changed the title docs(exchange): document export licensing, quota APIs and deployment requirements docs(exchange): explain export licensing and quota query errors Oct 26, 2026
OTime-Coder and others added 2 commits October 27, 2026 20:27
…and Exchange

The License page now explains the one License that Web SDK, Collaboration
SDK and Exchange read, shows the explicit configuration for each and the
environment variables the servers fall back to. A new Collaboration SDK
License page covers editing connections, authorized domains, nodes and
document types, and the API for observing them. The Exchange page is
retitled License, drops the pre-release note, shows export errors and
orders the error table by how often each code occurs. Quick Start,
Deployment, Collaboration integration and Examples link to the new pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ion pages

Drop the export authorization paragraph from the Office file page and list
the License reasons alongside the other resend and conflict reasons without
extra wording or links.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@OTime-Coder OTime-Coder changed the title docs(exchange): explain export licensing and quota query errors docs(server): describe one License across Web SDK, Collaboration SDK and Exchange Oct 27, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants