@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.008b7c6

package/src/extensions/automerge/automerge.ts

@@ -0,0 +1,94 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import { Facet, StateField, type Extension, type Transaction } from '@codemirror/state';
+import { ViewPlugin, type EditorView, type PluginValue, type ViewUpdate } from '@codemirror/view';
+
+import { next as A } from '@dxos/automerge/automerge';
+import { type Prop } from '@dxos/automerge/automerge';
+
+import { cursorConverter } from './cursor';
+import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
+import { PatchSemaphore } from './semaphore';
+import { CursorConverter } from '../../util';
+
+const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
+  combine: (values) => values.at(-1)!, // Take last.
+});
+
+export type AutomergeOptions = {
+  handle: IDocHandle;
+  path: Prop[];
+};
+
+export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
+  // TODO(burdon): Rename.
+  const stateField: StateField<Value> = StateField.define({
+    create: () => ({
+      lastHeads: A.getHeads(handle.docSync()!),
+      unreconciledTransactions: [],
+      path: path.slice(),
+    }),
+    update: (value: Value, tr: Transaction) => {
+      const result: Value = {
+        lastHeads: value.lastHeads,
+        unreconciledTransactions: value.unreconciledTransactions.slice(),
+        path: path.slice(),
+      };
+      let clearUnreconciled = false;
+      for (const effect of tr.effects) {
+        if (effect.is(effectType)) {
+          result.lastHeads = effect.value.newHeads;
+          clearUnreconciled = true;
+        }
+      }
+      if (clearUnreconciled) {
+        result.unreconciledTransactions = [];
+      } else {
+        if (!isReconcileTx(tr)) {
+          result.unreconciledTransactions.push(tr);
+        }
+      }
+      return result;
+    },
+  });
+
+  const semaphore = new PatchSemaphore(stateField);
+
+  const viewPlugin = ViewPlugin.fromClass(
+    class AutomergeCodemirrorViewPlugin implements PluginValue {
+      constructor(private readonly _view: EditorView) {
+        handle.addListener('change', this._handleChange);
+      }
+
+      update(update: ViewUpdate) {
+        if (update.transactions.length > 0 && update.transactions.some((tr) => !isReconcileTx(tr))) {
+          // TODO(burdon): This is a hack to ensure that the view is updated after the transaction is applied.
+          queueMicrotask(() => {
+            this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
+          });
+        }
+      }
+
+      destroy() {
+        handle.addListener('change', this._handleChange);
+      }
+
+      private _handleChange = () => {
+        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
+      };
+    },
+  );
+
+  return {
+    extension: [
+      CursorConverter.of(cursorConverter(handle, path)),
+      semaphoreFacet.of(semaphore),
+      stateField,
+      viewPlugin,
+    ],
+  };
+};

package/src/extensions/automerge/cursor.ts

@@ -0,0 +1,51 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import get from 'lodash.get';
+
+import type { Prop } from '@dxos/automerge/automerge';
+import { next as automerge } from '@dxos/automerge/automerge';
+
+import { type IDocHandle } from './defs';
+import { type CursorConverter } from '../../util';
+
+export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
+  // TODO(burdon): Handle assoc to associate with a previous character.
+  toCursor: (pos) => {
+    const doc = handle.docSync();
+    if (!doc) {
+      return '';
+    }
+
+    const value = get(doc, path);
+    if (typeof value === 'string' && value.length <= pos) {
+      return 'end';
+    }
+
+    // NOTE: Slice is needed because getCursor mutates the array.
+    return automerge.getCursor(doc, path.slice(), pos);
+  },
+  fromCursor: (cursor) => {
+    if (cursor === '') {
+      return 0;
+    }
+
+    const doc = handle.docSync();
+    if (!doc) {
+      return 0;
+    }
+
+    if (cursor === 'end') {
+      const value = get(doc, path);
+      if (typeof value === 'string') {
+        return value.length;
+      } else {
+        return 0;
+      }
+    }
+
+    // NOTE: Slice is needed because getCursor mutates the array.
+    return automerge.getCursorPosition(doc, path.slice(), cursor);
+  },
+});

package/src/extensions/automerge/defs.ts

@@ -0,0 +1,62 @@
+//
+// Copyright 2023 DXOS.org
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import {
+  Annotation,
+  StateEffect,
+  type StateField,
+  type EditorState,
+  type Transaction,
+  type TransactionSpec,
+} from '@codemirror/state';
+
+import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
+
+export type Value = {
+  lastHeads: Heads;
+  path: Prop[];
+  unreconciledTransactions: Transaction[];
+};
+
+type UpdateHeads = {
+  newHeads: Heads;
+};
+
+export const effectType = StateEffect.define<UpdateHeads>({});
+
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
+
+export const getLastHeads = (state: EditorState, field: StateField<Value>): Heads => state.field(field).lastHeads;
+
+export const getPath = (state: EditorState, field: StateField<Value>): Prop[] => state.field(field).path;
+
+export const reconcileAnnotationType = Annotation.define<unknown>();
+
+export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
+
+export const makeReconcile = (tr: TransactionSpec) => {
+  if (tr.annotations != null) {
+    if (tr.annotations instanceof Array) {
+      tr.annotations = [...tr.annotations, reconcileAnnotationType.of({})];
+    } else {
+      tr.annotations = [tr.annotations, reconcileAnnotationType.of({})];
+    }
+  } else {
+    tr.annotations = [reconcileAnnotationType.of({})];
+  }
+  // return {
+  //   ...tr,
+  //   annotations: reconcileAnnotationType.of({})
+  // }
+};
+
+export type IDocHandle<T = any> = {
+  docSync(): Doc<T> | undefined;
+  change(callback: ChangeFn<T>, options?: ChangeOptions<T>): void;
+  changeAt(heads: Heads, callback: ChangeFn<T>, options?: ChangeOptions<T>): string[] | undefined;
+
+  addListener(event: 'change', listener: () => void): void;
+  removeListener(event: 'change', listener: () => void): void;
+};

package/src/extensions/automerge/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { automerge } from './automerge';
+export { type IDocHandle } from './defs';

package/src/{automerge/automerge-plugin/PatchSemaphore.ts → extensions/automerge/semaphore.ts}

@@ -1,31 +1,39 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
+import { type StateField } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 
 import { next as automerge } from '@dxos/automerge/automerge';
 
-import amToCodemirror from './amToCodemirror';
-import codeMirrorToAm from './codeMirrorToAm';
-import { type IDocHandle } from './handle';
-import { type Field, isReconcileTx, getPath, reconcileAnnotationType, updateHeads, getLastHeads } from './plugin';
+import {
+  getLastHeads,
+  getPath,
+  isReconcileTx,
+  reconcileAnnotationType,
+  updateHeads,
+  type IDocHandle,
+  type Value,
+} from './defs';
+import { updateAutomerge } from './update-automerge';
+import { updateCodeMirror } from './update-codemirror';
 
 type Doc<T> = automerge.Doc<T>;
 type Heads = automerge.Heads;
 
 type ChangeFn = (atHeads: Heads, change: (doc: Doc<unknown>) => void) => Heads | undefined;
 
+/**
+ * TODO(burdon): Comment.
+ */
 export class PatchSemaphore {
-  _field!: Field;
   _inReconcile = false;
   _queue: Array<ChangeFn> = [];
 
-  constructor(field?: Field) {
-    if (field !== undefined) {
-      this._field = field;
-    }
-  }
+  constructor(private readonly _field: StateField<Value>) {}
 
   reconcile = (handle: IDocHandle, view: EditorView) => {
     if (this._inReconcile) {
@@ -37,9 +45,8 @@ export class PatchSemaphore {
     const oldHeads = getLastHeads(view.state, this._field);
     let selection = view.state.selection;
 
+    // First undo all the unreconciled transactions.
     const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
-
-    // First undo all the unreconciled transactions
     const toInvert = transactions.slice().reverse();
     for (const tx of toInvert) {
       const inverted = tx.changes.invert(tx.startState.doc);
@@ -50,19 +57,18 @@ export class PatchSemaphore {
       });
     }
 
-    // now apply the unreconciled transactions to the document
-    let newHeads = codeMirrorToAm(this._field, handle, transactions, view.state);
+    // Apply the unreconciled transactions to the document.
+    let newHeads = updateAutomerge(this._field, handle, transactions, view.state);
 
-    // NOTE: null and undefined each come from automerge and repo respectively
+    // NOTE: null and undefined each come from automerge and repo respectively.
     if (newHeads === null || newHeads === undefined) {
       // TODO: @alexjg this is the call that's resetting the editor state on click
       newHeads = automerge.getHeads(handle.docSync()!);
     }
 
-    // now get the diff between the updated state of the document and the heads
-    // and apply that to the codemirror doc
+    // Now get the diff between the updated state of the document and the heads and apply that to the codemirror doc.
     const diff = automerge.equals(oldHeads, newHeads) ? [] : automerge.diff(handle.docSync()!, oldHeads, newHeads);
-    amToCodemirror(view, selection, path, diff);
+    updateCodeMirror(view, selection, path, diff);
 
     view.dispatch({
       effects: updateHeads(newHeads),

package/src/{automerge/automerge-plugin/codeMirrorToAm.ts → extensions/automerge/update-automerge.ts}

@@ -1,16 +1,17 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { type EditorState, type Text, type Transaction } from '@codemirror/state';
+import { type EditorState, type StateField, type Text, type Transaction } from '@codemirror/state';
 
 import { next as am, type Heads } from '@dxos/automerge/automerge';
 
-import { type IDocHandle } from './handle';
-import { type Field } from './plugin';
+import { type IDocHandle, type Value } from './defs';
 
-export default (
-  field: Field,
+export const updateAutomerge = (
+  field: StateField<Value>,
   handle: IDocHandle,
   transactions: Transaction[],
   state: EditorState,
@@ -18,7 +19,7 @@ export default (
   const { lastHeads, path } = state.field(field);
 
   // We don't want to call `automerge.updateAt` if there are no changes.
-  // Otherwise later on `automerge.diff` will return empty patches that result in a no-op but still mess up the selection.
+  // Otherwise, later on `automerge.diff` will return empty patches that result in a no-op but still mess up the selection.
   let hasChanges = false;
   for (const tr of transactions) {
     tr.changes.iterChanges(() => {
@@ -37,5 +38,6 @@ export default (
       });
     }
   });
+
   return newHeads ?? undefined;
 };

package/src/{automerge/automerge-plugin/amToCodemirror.ts → extensions/automerge/update-codemirror.ts}

@@ -1,5 +1,7 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
 import { ChangeSet, type ChangeSpec, type EditorSelection, type EditorState } from '@codemirror/state';
@@ -14,9 +16,9 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from './plugin';
+import { reconcileAnnotationType } from './defs';
 
-export default (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
+export const updateCodeMirror = (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
   for (const patch of patches) {
     const changeSpec = handlePatch(patch, target, view.state);
     if (changeSpec != null) {
@@ -28,6 +30,7 @@ export default (view: EditorView, selection: EditorSelection, target: Prop[], pa
       });
     }
   }
+
   view.dispatch({
     selection,
     annotations: reconcileAnnotationType.of({}),
@@ -53,6 +56,7 @@ const handleInsert = (target: Prop[], patch: InsertPatch): Array<ChangeSpec> =>
   if (index == null) {
     return [];
   }
+
   const text = patch.values.map((v) => (v ? v.toString() : '')).join('');
   return [{ from: index, to: index, insert: text }];
 };
@@ -62,6 +66,7 @@ const handleSplice = (target: Prop[], patch: SpliceTextPatch): Array<ChangeSpec>
   if (index == null) {
     return [];
   }
+
   return [{ from: index, insert: patch.value }];
 };
 
@@ -70,6 +75,7 @@ const handleDel = (target: Prop[], patch: DelPatch): Array<ChangeSpec> => {
   if (index == null) {
     return [];
   }
+
   const length = patch.length || 1;
   return [{ from: index, to: index + length }];
 };
@@ -79,27 +85,32 @@ const handlePut = (target: Prop[], patch: PutPatch, state: EditorState): Array<C
   if (index == null) {
     return [];
   }
+
   const length = state.doc.length;
   if (typeof patch.value !== 'string') {
     return []; // TODO(dmaretskyi): How to handle non string values?
   }
+
   return [{ from: 0, to: length, insert: patch.value as any }];
 };
 
-// If the path of the patch is of the form [path, <index>] then we know this is
-// a path to a character within the sequence given by path
+// If the path of the patch is of the form [path, <index>] then we know this is a path to a character
+// within the sequence given by path.
 const charPath = (textPath: Prop[], candidatePath: Prop[]): number | null => {
   if (candidatePath.length !== textPath.length + 1) {
     return null;
   }
+
   for (let i = 0; i < textPath.length; i++) {
     if (textPath[i] !== candidatePath[i]) {
       return null;
     }
   }
+
   const index = candidatePath[candidatePath.length - 1];
   if (typeof index === 'number') {
     return index;
   }
+
   return null;
 };