README.md

Collaboration Kit (Alpha Preview)

Monorepo for packages that facilitate working with arbitrary JSON structures in Yjs.

• @sanalabs/y-redux Two-way sync of Redux and Yjs
• @sanalabs/y-json Utility functions to mutate Yjs types according to a target JSON object
• @sanalabs/json Utility functions to mutate, validate and diff JSON objects

Documentation

See each package for documentation 👆

Notes

No excessive package dependencies

Collaboration Kit is split into multiple smaller packages so that excessive package dependencies can be avoided. You probably don't want to install React on your backend.

Peer dependencies

A number of dependencies (React, Redux, Yjs) are peer dependencies. Otherwise, runtime bugs will occur due to version incompatibilities.

Prior art

• https://github.com/YousefED/reactive-crdt
• https://github.com/tandem-pt/zustand-yjs
• https://github.com/joebobmiles/zustand-middleware-yjs