Proposal: new node transforms API to replace quill.on('text-change', fn)

[lawvs]

The quill on change API has the potential risk of breaking undo/redo or causing UI and YDoc to be inconsistent. (see #415)

I propose to create a new Text API to solve the problem.

Text.onUpdate((delta, context) => {
  // Do something
  // ...
  return newDelta;
})

Related code at

blocksuite/packages/store/src/text-adapter.ts

Lines 374 to 400 in 92c1d93

	private _quillObserver = (
	eventType: string,
	delta: any,
	state: any,
	origin: any
	) => {
	const { yText } = this;
	if (delta && delta.ops) {
	// update content
	const ops = delta.ops;
	ops.forEach((op: any) => {
	if (op.attributes !== undefined) {
	for (const key in op.attributes) {
	if (this._negatedUsedFormats[key] === undefined) {
	this._negatedUsedFormats[key] = false;
	}
	}
	}
	});
	if (origin === 'user') {
	this.space.transact(() => {
	yText.applyDelta(ops);
	});
	}
	}
	};

Related to #415 toeverything/AFFiNE#632

Reference to https://lexical.dev/docs/concepts/transforms

[Flrande]

Do you think we can fix it by replacing quill with virgo?

[lawvs]

Virgo has no transform API now, but it is also compatible with the proposal API.

[Flrande]

Virgo has no transform API by design, because it directly implement the synchronization between dom and Y.Text, which mean that Y.Text is the single truth. (It requires Y.Text data structure is expected, that's why I consider add zod to validate insert data.)