Export `updateYFragment`

[gabriel-peracio]

What this does

• exports updateYFragment

Why?

• This allows using updateYFragment outside of the context of the plugin

But why?

My usecase is to allow a server to apply prosemirror transactions to a yDoc by using prosemirror transactions, instead of yJS transactions. I do this by:

1. Obtain a direct connection to the yDoc from the server
2. Derive the pmDoc from the yDoc using the existing utilities
3. Creating my transactions (tr.doThing())
4. I cannot (and don't need to) dispatch(tr), because I never mount the prosemirror view, therefore I just get the resulting document with the modifications applied by reading from tr.doc
5. call updateYFragment

This results in code like this (I'm using tiptap/hocuspocus):

const docConnection = await hocusPocusServer.openDirectConnection("my-document", {});

await docConnection.transact((yDoc) => {
  const pmDocJSON = TiptapTransformer.fromYdoc(yDoc, "default");
  const docNode = schema.nodeFromJSON(pmDocJSON);
  const editorState = EditorState.create({ schema, doc: docNode });
  const { tr } = editorState;

  tr.doThing();
  tr.doThing2();
  tr.doThing3();

  const yDocNode = yDoc.getXmlFragment("default");
  updateYFragment(yDoc, yDocNode, tr.doc, new Map());
})

[WilixLead]

@dmonad I also really need this PR. At this moment I use local package fork only for 1 line change :)

[dmonad]

I merged this and published the changes in y-prosemirror@v1.2.3. However, use it at your own peril! This function is designed to reflect change when performing real-time editing. It is not well suited for larger amounts of edits.

[mikkorantalainen]

This function is designed to reflect change when performing real-time editing. It is not well suited for larger amounts of edits.

What kind of problems one might expect to see? Does this potentially cause data corruption or just performance issues?