Hocuspocus Versions Save

The CRDT Yjs WebSocket backend for conflict-free real-time collaboration in your app.

v2.8.0

6 months ago

We've added graceful shutdown (#747). By default, Hocuspocus will listen for SIGINT, SIGTERM and SIGQUIT, and react accordingly (save all documents & shutdown). If you don't want that, you can turn it off by passing stopOnSignals:false to Hocuspocus.

What's Changed

implements graceful shutdown by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/747
Add missing hooks to config-hooks-extension. by @shincurry in https://github.com/ueberdosis/hocuspocus/pull/736
Minor optimizations (logging, isConnected, cleanup) by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/734
build(deps): bump axios from 1.3.4 to 1.6.0 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/746
build(deps): bump actions/setup-node from 3 to 4 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/735

New Contributors

@shincurry made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/736

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.7.1...v2.8.0

v2.7.1

7 months ago

What's Changed

fixes #730: extension-redis: This reverts an unintended breaking change causing hocuspocus instances to call onStoreDocument hooks even if the update was received on another instance: https://github.com/ueberdosis/hocuspocus/pull/733. This could create issues in certain situations if you are relying on the context.

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.7.0...v2.7.1

v2.7.0

7 months ago

What's Changed

Add context to onAuthenticatePayload by @haines in https://github.com/ueberdosis/hocuspocus/pull/719
Fix return type of database extension store method by @haines in https://github.com/ueberdosis/hocuspocus/pull/715
fixes #718: replace arraybuffer by nodebuffer by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/721
Handle errors thrown by provider token function by @haines in https://github.com/ueberdosis/hocuspocus/pull/722
Removing the console log messages by @websiddu in https://github.com/ueberdosis/hocuspocus/pull/726
Efficiently route messages through HocuspocusProviderWebsocket by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/727
fixes #709: unload document when there is no other connection left af… by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/723
adds Document.isDestroyed by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/728
build(deps): bump postcss from 8.4.23 to 8.4.31 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/712
build(deps): bump ws from 7.5.9 to 8.14.2 in /packages/provider by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/705

New Contributors

@websiddu made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/726

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.6.1...v2.7.0

v2.6.1

7 months ago

What's Changed

fix: add documentName into broadcast message by @xcfox in https://github.com/ueberdosis/hocuspocus/pull/713

New Contributors

@xcfox made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/713

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.6.0...v2.6.1

v2.6.0

7 months ago

What's Changed

throw error in onStoreDocument to prevent afterStoreDocument from releasing lock by @ralphiee22 in https://github.com/ueberdosis/hocuspocus/pull/669
Stop listening to messages once the websocket closes by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/702
Fix multiple sockets on reconnection by @talhazubairbutt in https://github.com/ueberdosis/hocuspocus/pull/698
server/examples.md: Remove outdated documentName references by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/706
Update extensions.md by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/701
Fix payload types for after load/unload document hooks by @haines in https://github.com/ueberdosis/hocuspocus/pull/710

New Contributors

@talhazubairbutt made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/698
@haines made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/710

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.5.0...v2.6.0

v2.5.0

8 months ago

Possible breaking change: extension-redis will now use channels instead of redis patterns, so if you are manually subscribing to redis messages, make sure to check out the changes (related PR)

What's Changed

make immediate unload optional by @georeith in https://github.com/ueberdosis/hocuspocus/pull/683
attach ydoc origin to onChange, onStoreDocument payloads by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/688
Reset last message received when creating new socket by @TalhaASiddiqi in https://github.com/ueberdosis/hocuspocus/pull/689
extension-redis: Subscribe to channels instead of patterns by @EugeneZ in https://github.com/ueberdosis/hocuspocus/pull/679
extension-redis: fixes a bug that caused document updates to cause another sync by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/696

Documentation / Misc:

Fix typos and unnecessary gendered language by @12joan in https://github.com/ueberdosis/hocuspocus/pull/694
Update custom-extensions.md by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/693
Update Redis extension docs by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/692
moves debounce to utils by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/695
build(deps): bump actions/checkout from 3 to 4 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/697

New Contributors

@12joan made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/694
@TalhaASiddiqi made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/689
@EugeneZ made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/679

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.4.0...v2.5.0

v2.4.0

9 months ago

Possible breaking change: With this release, a failed auth won't anymore terminate the connection (and thus not call onClose) but just trigger onAuthenticateFailed.

What's Changed

Lazily createEncoder for IncomingMessage by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/672
Always clean up connection listeners by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/670
fix: check if ymap is empty by @linspw in https://github.com/ueberdosis/hocuspocus/pull/666
Allow provider awareness to be disabled by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/675
don't close when auth fails by @YousefED in https://github.com/ueberdosis/hocuspocus/pull/615
this allows giving extensions a custom name, that takes priority over the class name by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/677
Linear time mux by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/671
Started with seperation of server from hocuspocus by @timoisik in https://github.com/ueberdosis/hocuspocus/pull/678
Fixed link for sqlite section by @timoisik in https://github.com/ueberdosis/hocuspocus/pull/684
Improve introducing examples in the documentation by @lode in https://github.com/ueberdosis/hocuspocus/pull/681

New Contributors

@lode made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/681

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.3.1...v2.4.0

v2.4.0-rc.1

9 months ago

Breaking change: With this release, a failed auth won't anymore terminate the connection (and thus not call onClose) but just trigger onAuthenticateFailed.

What's Changed

Lazily createEncoder for IncomingMessage by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/672
Always clean up connection listeners by @canadaduane in https://github.com/ueberdosis/hocuspocus/pull/670
fix: check if ymap is empty by @linspw in https://github.com/ueberdosis/hocuspocus/pull/666
Allow provider awareness to be disabled by @raineorshine in https://github.com/ueberdosis/hocuspocus/pull/675
don't close when auth fails by @YousefED in https://github.com/ueberdosis/hocuspocus/pull/615
this allows giving extensions a custom name, that takes priority over the class name by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/677

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.3.1...v2.4.0-rc.1

v2.3.1

9 months ago

What's Changed

Force-Close the websocket state after trying to gracefully close the websocket twice, refs #661 by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/665

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.3.0...v2.3.1

v2.3.0

9 months ago

This adds an improved way of figuring out if the document is fully synced with the server.

WARNING: You should update @hocuspocus/server before upgrading the client. "hasUnsyncedChanges" of @hocuspocus/provider 2.3.0 is NOT compatible with @hocuspocus/server <2.3.0. If you upgrade the server while running provider <2.2.3, the provider will show errors in the browser, which can be safely ignored. If you dont want to see errors, upgrade the provider to v2.2.3 first, then upgrade the server to 2.3.0, and then upgrade the provider again. Or just upgrade everything simultaneously to 2.3.0.

What's Changed

Fix/unsyncedchanges (#635) by @YousefED in https://github.com/ueberdosis/hocuspocus/pull/654
build(deps): bump semver from 5.7.1 to 5.7.2 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/653
refs #566: force-reconnect the websocket (if disconnected) on attach of provider by @janthurau in https://github.com/ueberdosis/hocuspocus/pull/652
afterUnloadDocument hook by @georeith in https://github.com/ueberdosis/hocuspocus/pull/656
build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in https://github.com/ueberdosis/hocuspocus/pull/655
fix: remove awareness stats on page unload instead of beforeunload by @iowxy in https://github.com/ueberdosis/hocuspocus/pull/658
Fix/doc links by @patrickbaber in https://github.com/ueberdosis/hocuspocus/pull/664
fix: hocuspocus provider auto connect and disconnect behavior by @linspw in https://github.com/ueberdosis/hocuspocus/pull/663

New Contributors

@georeith made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/656
@iowxy made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/658
@linspw made their first contribution in https://github.com/ueberdosis/hocuspocus/pull/663

Full Changelog: https://github.com/ueberdosis/hocuspocus/compare/v2.2.3...v2.3.0