Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Break out Y.js support into its own addon #2114

Open
dfahlander opened this issue Jan 7, 2025 · 1 comment
Open

Break out Y.js support into its own addon #2114

dfahlander opened this issue Jan 7, 2025 · 1 comment

Comments

@dfahlander
Copy link
Collaborator

The Y.js support in Dexie.js is completed in PR #2045.

Dexie Cloud Server supports Y.js updates as of version 2.0 (in production since november 2024)

Pre-releases of client libraries have been released:

The support for Y.js was implemented natively in Dexie.js but it turned out to add a bit of too much weight into the library for users that do not require Y.js for their use cases. There is also an implicit dependency of yjs library even if we let the user pass yjs into Dexie via constructor option rather than having it as a peer-dependency.

Before releasing Y.js support into a stable dexie release, we have decided to break-out the Y.js support into a new add-on instead. This will affect how to npm install and import libraries when using dexie with yjs - install the new addon and pass it on to Dexie constructor instead of passing Y library itself into it.

We also support a new kind of Y.js trigger that enables computed properties containing the HTML version of the Y.Docs. This feature can be essential when dealing with multiple persisted Y.Docs that need to be pre-rendered in applications.

This task will be put into the current Dexie project to represent the work we have to do to complete the Y.js support in dexie, dexie-cloud-addon and the new addon (might be either "y-dexie" or "dexie-y").

@onuradsay
Copy link

I think moving Y.js support into a separate addon is a good architectural decision. Regarding the name, dexie-y or dexie-y-addon sounds better as it follows the existing naming convention of dexie-cloud-addon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

2 participants