Skip to main content
Email sdk@revise.io. npm bugs @reviseio/editor opens the same route. Response times, escalation paths, and service commitments are set in your license agreement. Email us your requirements to include them.

​
What to include

Include the SDK version and build:
Add them to your error reporting so every report includes them. Also include:
  • Steps, in order. For example: “Opened a .docx with tracked changes, accepted the second one, exported.”
  • The document, if you can share it. Fidelity bugs are usually specific to a file. A redacted copy that still reproduces the bug is enough.
  • Browser and version, and whether it reproduces in another.
  • Anything in the console, including warnings before the error.

​
Common problems

Two copies of Yjs are loaded. Yjs identifies its types with instanceof, so a shared document rejects nodes built by the other copy. npm ls yjs must show exactly one. See collaboration.
The handle was used before a document existed. onReady fires before the first document opens. Subscriptions work there. Calls that act on a document need onDocumentReady or await editor.whenReady().
No currentUser was passed. Authorship is recorded when an edit is made, not at export, so existing edits cannot be reassigned. Set currentUser before anyone types.
Linked moves round-trip as moves. A complete moveFrom/moveTo pair imports as one move suggestion and exports as the same paired markup. A move whose halves are orphaned or mismatched in the source file falls back to an ordinary deletion and insertion. See tracked changes for what survives the round trip.
The SDK was published as revise through 2.2. From 2.3 it is @reviseio/editor. See migrate from revise.

​
Security

Report suspected vulnerabilities to sdk@revise.io with “security” in the subject. Do not report them publicly first.