Comment highlights not restored on reload with custom ThreadStore

[hsingh-ds]

Is your feature request related to a problem? Please describe.
I'm using a custom ThreadStore implementation that communicates with a backend via REST APIs. In the collaboration options, I've passed undefined for the default provider and provided my custom ThreadStore in threadStore option. Comments are being saved and loaded correctly. However, after reloading the document, while the comments themselves appear, the highlighted portions of the document they refer to are not being restored.

Is there an additional step required to restore or reapply the comment highlights to the corresponding text ranges?

[nperez0111]

Comments are not persisted into the document currently. This was a specific decision because we aren't sure that they really should be modifying the document since they are about the document.

As such, the only way that they currently persist is if you are using something which does store that data (which is only available at the prosemirror-level), which currently is only the Y.js integration (technically you could probably persist the prosemirror document as JSON which is essentially the same level as the Y.js integration).

I understand that this can be somewhat annoying, but we just aren't completely ready with comments being stored within the document as we feel like they shouldn't be

[hsingh-ds]

@nperez0111 Thank you for the clarification.

[gsingh-ds]

@nperez0111 what are the possible solutions for this problem? and how does the Y.js integration work? We are using own db for storing threads/comments and custom implantation of ThreadStore

[YousefED]

Hi! For now see the example threadstores listed here: https://www.blocknotejs.org/docs/collaboration/comments#threadstores

We'll work on some documentation to go further into the internals / trade-offs, stay tuned!

[hsingh-ds]

@YousefED Any updates on this? How can I restore comments data from the saved blocks?

[YousefED]

@hsingh-ds not yet - at the moment this is only feasible with a yjs-based backend. are you using that?

[hsingh-ds]

@YousefED Not yet! I think Yjs would be my last resort for fixing this issue.