@dxos/react-ui-editor 0.3.11-main.7e75884 → 0.3.11-main.800163e

package/src/components/Toolbar/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './Toolbar';

package/src/components/index.ts

@@ -3,3 +3,4 @@
 //
 
 export * from './TextEditor';
+export * from './Toolbar';

package/src/extensions/autocomplete.ts

@@ -13,6 +13,7 @@ import {
   type CompletionContext,
   type CompletionResult,
 } from '@codemirror/autocomplete';
+import { markdownLanguage } from '@codemirror/lang-markdown';
 import { keymap } from '@codemirror/view';
 
 export type AutocompleteResult = Completion;
@@ -28,32 +29,35 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
   return [
     // https://codemirror.net/docs/ref/#view.keymap
     // https://discuss.codemirror.net/t/how-can-i-replace-the-default-autocompletion-keymap-v6/3322
+    // TODO(burdon): Set custom keymap.
     keymap.of(completionKeymap),
 
     // https://codemirror.net/examples/autocompletion
     // https://codemirror.net/docs/ref/#autocomplete.autocompletion
     autocompletion({
-      // TODO(burdon): Set custom keymap.
+      activateOnTyping: true,
+
+      // closeOnBlur: false,
       // defaultKeymap: false,
 
-      // Don't start unless key press.
-      activateOnTyping: false,
-
-      // TODO(burdon): Option to create new page?
-      // TODO(burdon): Optional decoration via addToOptions
-      override: [
-        (context: CompletionContext): CompletionResult | null => {
-          const match = context.matchBefore(/\w*/);
-          if (!match || (match.from === match.to && !context.explicit)) {
-            return null;
-          }
-
-          return {
-            from: match.from,
-            options: onSearch(match.text.toLowerCase()),
-          };
-        },
-      ],
+      // TODO(burdon): Styles/fragments.
+      tooltipClass: () => 'shadow rounded',
+    }),
+
+    // TODO(burdon): Option to create new page?
+    // TODO(burdon): Optional decoration via addToOptions
+    markdownLanguage.data.of({
+      autocomplete: (context: CompletionContext): CompletionResult | null => {
+        const match = context.matchBefore(/\w*/);
+        if (!match || (match.from === match.to && !context.explicit)) {
+          return null;
+        }
+
+        return {
+          from: match.from,
+          options: onSearch(match.text.toLowerCase()),
+        };
+      },
     }),
   ];
 };

package/src/extensions/automerge/automerge.spec.tsx

@@ -0,0 +1,76 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { EditorState } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+import { render, screen } from '@testing-library/react';
+import chai, { expect } from 'chai';
+import chaiDom from 'chai-dom';
+import get from 'lodash.get';
+import React, { type FC, useEffect, useRef, useState } from 'react';
+import { describe, test } from 'vitest';
+
+import { type DocHandle, Repo } from '@dxos/automerge/automerge-repo';
+
+import { automerge } from './automerge';
+
+type TestObject = {
+  text: string;
+};
+
+const path = ['text'];
+
+class Generator {
+  constructor(private readonly _handle: DocHandle<TestObject>) {}
+  update(text: string) {
+    this._handle.change((doc: TestObject) => {
+      doc.text = text;
+    });
+  }
+}
+
+const Test: FC<{ handle: DocHandle<TestObject>; generator: Generator }> = ({ handle, generator }) => {
+  const ref = useRef<HTMLDivElement>(null);
+  const [view, setView] = useState<EditorView>();
+  useEffect(() => {
+    const extensions = [
+      automerge({ handle, path }),
+      EditorView.updateListener.of((update) => {
+        if (view.state.doc.toString() === 'hello!') {
+          // Update editor.
+          update.view.dispatch({ changes: { from: view.state.doc.length - 1, insert: ' world' } });
+        }
+      }),
+    ];
+
+    const view = new EditorView({
+      state: EditorState.create({ doc: get(handle.docSync()!, path), extensions }),
+      parent: ref.current!,
+    });
+
+    setView(view);
+  }, []);
+
+  useEffect(() => {}, [view]);
+
+  return <div ref={ref} />;
+};
+
+chai.use(chaiDom);
+
+describe('Automerge', () => {
+  test('basic sync', () => {
+    const repo = new Repo({ network: [] });
+    const handle = repo.create<TestObject>();
+    const generator = new Generator(handle);
+    render(<Test handle={handle} generator={generator} />);
+    expect(screen.getByRole('textbox')).to.have.text('');
+
+    generator.update('hello!');
+    expect(screen.getByRole('textbox')).to.have.text('hello world!');
+  });
+
+  // TODO(burdon): Test history/undo.
+  // TODO(burdon): https://testing-library.com/docs/react-testing-library/example-intro/
+});

package/src/extensions/automerge/automerge.test.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { describe, test } from '@dxos/test';
+
+describe('Test', () => {
+  test('checks sanity', async () => {
+    expect(true).to.be.true;
+  });
+});

package/src/extensions/automerge/automerge.ts

@@ -4,20 +4,16 @@
 // 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 { invertedEffects } from '@codemirror/commands';
+import { StateField, type Extension, type StateEffect } from '@codemirror/state';
+import { EditorView, ViewPlugin } from '@codemirror/view';
 
-import { next as A } from '@dxos/automerge/automerge';
-import { type Prop } from '@dxos/automerge/automerge';
+import { next as A, type Prop } from '@dxos/automerge/automerge';
 
 import { cursorConverter } from './cursor';
-import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
+import { updateHeadsEffect, type IDocHandle, isReconcile, type State } from './defs';
 import { PatchSemaphore } from './semaphore';
-import { CursorConverter } from '../../util';
-
-const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
-  combine: (values) => values.at(-1)!, // Take last.
-});
+import { Cursor } from '../cursor';
 
 export type AutomergeOptions = {
   handle: IDocHandle;
@@ -25,70 +21,83 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  // TODO(burdon): Rename.
-  const stateField: StateField<Value> = StateField.define({
+  const syncState = StateField.define<State>({
     create: () => ({
+      path: path.slice(),
       lastHeads: A.getHeads(handle.docSync()!),
       unreconciledTransactions: [],
-      path: path.slice(),
     }),
-    update: (value: Value, tr: Transaction) => {
-      const result: Value = {
+
+    update: (value, tr) => {
+      const result: State = {
+        path: path.slice(),
         lastHeads: value.lastHeads,
         unreconciledTransactions: value.unreconciledTransactions.slice(),
-        path: path.slice(),
       };
+
       let clearUnreconciled = false;
       for (const effect of tr.effects) {
-        if (effect.is(effectType)) {
+        if (effect.is(updateHeadsEffect)) {
           result.lastHeads = effect.value.newHeads;
           clearUnreconciled = true;
         }
       }
+
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
-        if (!isReconcileTx(tr)) {
+        if (!isReconcile(tr)) {
           result.unreconciledTransactions.push(tr);
         }
       }
+
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(stateField);
+  const semaphore = new PatchSemaphore(handle, syncState);
 
-  const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeCodemirrorViewPlugin implements PluginValue {
-      constructor(private readonly _view: EditorView) {
-        handle.addListener('change', this._handleChange);
-      }
+  return [
+    Cursor.converter.of(cursorConverter(handle, path)),
+    syncState,
 
-      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);
-          });
+    // Reconcile external updates.
+    ViewPlugin.fromClass(
+      class {
+        constructor(private readonly _view: EditorView) {
+          handle.addListener('change', this._handleChange.bind(this));
         }
+
+        destroy() {
+          handle.removeListener('change', this._handleChange.bind(this));
+        }
+
+        _handleChange() {
+          semaphore.reconcile(this._view);
+        }
+      },
+    ),
+
+    // Reconcile local updates.
+    EditorView.updateListener.of(({ view, changes }) => {
+      if (!changes.empty) {
+        semaphore.reconcile(view);
       }
+    }),
 
-      destroy() {
-        handle.addListener('change', this._handleChange);
+    // TODO(burdon): Record undo transactions.
+    //  See https://github.com/yjs/y-codemirror.next/tree/main
+    // https://codemirror.net/examples/inverted-effect
+    invertedEffects.of((tr) => {
+      // Each change results it three transactions: insert, delete, insert.
+      const effects: StateEffect<any>[] = [];
+      if (!tr.changes.empty) {
+        tr.changes.iterChanges((fromA, toA, fromB, toB, inserted) => {
+          // effects.push(effectType.of({});
+        });
       }
 
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
-      };
-    },
-  );
-
-  return {
-    extension: [
-      CursorConverter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
-  };
+      return effects;
+    }),
+  ];
 };

package/src/extensions/automerge/cursor.ts

@@ -5,10 +5,10 @@
 import get from 'lodash.get';
 
 import type { Prop } from '@dxos/automerge/automerge';
-import { next as automerge } from '@dxos/automerge/automerge';
+import { next as A } from '@dxos/automerge/automerge';
 
 import { type IDocHandle } from './defs';
-import { type CursorConverter } from '../../util';
+import { type CursorConverter } from '../cursor';
 
 export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
   // TODO(burdon): Handle assoc to associate with a previous character.
@@ -24,8 +24,9 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     }
 
     // NOTE: Slice is needed because getCursor mutates the array.
-    return automerge.getCursor(doc, path.slice(), pos);
+    return A.getCursor(doc, path.slice(), pos);
   },
+
   fromCursor: (cursor) => {
     if (cursor === '') {
       return 0;
@@ -46,6 +47,6 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     }
 
     // NOTE: Slice is needed because getCursor mutates the array.
-    return automerge.getCursorPosition(doc, path.slice(), cursor);
+    return A.getCursorPosition(doc, path.slice(), cursor);
   },
 });

package/src/extensions/automerge/defs.ts

@@ -1,55 +1,34 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import {
-  Annotation,
-  StateEffect,
-  type StateField,
-  type EditorState,
-  type Transaction,
-  type TransactionSpec,
-} from '@codemirror/state';
+import { Annotation, StateEffect, type StateField, type EditorState, type Transaction } from '@codemirror/state';
 
 import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
 
-export type Value = {
-  lastHeads: Heads;
+export type State = {
   path: Prop[];
+  lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
-type UpdateHeads = {
+export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
+export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
+
+export 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 updateHeadsEffect = StateEffect.define<UpdateHeads>({});
 
-export const reconcileAnnotationType = Annotation.define<unknown>();
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
 
-export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
+export const reconcileAnnotation = Annotation.define<boolean>();
 
-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 const isReconcile = (tr: Transaction): boolean => {
+  return !!tr.annotation(reconcileAnnotation);
 };
 
 export type IDocHandle<T = any> = {

package/src/extensions/automerge/semaphore.ts

@@ -7,74 +7,75 @@
 import { type StateField } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 
-import { next as automerge } from '@dxos/automerge/automerge';
+import { next as A } from '@dxos/automerge/automerge';
 
 import {
   getLastHeads,
   getPath,
-  isReconcileTx,
-  reconcileAnnotationType,
+  isReconcile,
+  reconcileAnnotation,
   updateHeads,
   type IDocHandle,
-  type Value,
+  type State,
 } 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.
+ * Implements three-way merge (on each mutation).
  */
 export class PatchSemaphore {
-  _inReconcile = false;
-  _queue: Array<ChangeFn> = [];
+  private _inReconcile = false;
 
-  constructor(private readonly _field: StateField<Value>) {}
+  // prettier-ignore
+  constructor(
+    private readonly _handle: IDocHandle,
+    private readonly _state: StateField<State>
+  ) {}
 
-  reconcile = (handle: IDocHandle, view: EditorView) => {
-    if (this._inReconcile) {
-      return;
+  reconcile(view: EditorView) {
+    if (!this._inReconcile) {
+      this._inReconcile = true;
+      this.doReconcile(view);
+      this._inReconcile = false;
     }
-    this._inReconcile = true;
+  }
+
+  private doReconcile(view: EditorView) {
+    const path = getPath(view.state, this._state);
 
-    const path = getPath(view.state, this._field);
-    const oldHeads = getLastHeads(view.state, this._field);
+    // Get the heads before the unreconciled transactions are applied.
+    const oldHeads = getLastHeads(view.state, this._state);
     let selection = view.state.selection;
 
     // First undo all the unreconciled transactions.
-    const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
+    const transactions = view.state.field(this._state).unreconciledTransactions.filter((tx) => !isReconcile(tx));
     const toInvert = transactions.slice().reverse();
-    for (const tx of toInvert) {
-      const inverted = tx.changes.invert(tx.startState.doc);
+    for (const tr of toInvert) {
+      const inverted = tr.changes.invert(tr.startState.doc);
       selection = selection.map(inverted);
       view.dispatch({
         changes: inverted,
-        annotations: reconcileAnnotationType.of(true),
+        annotations: reconcileAnnotation.of(true),
       });
     }
 
     // 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.
+    let newHeads = updateAutomerge(this._state, this._handle, transactions, view.state);
     if (newHeads === null || newHeads === undefined) {
-      // TODO: @alexjg this is the call that's resetting the editor state on click
-      newHeads = automerge.getHeads(handle.docSync()!);
+      // TODO(alexjg): this is the call that's resetting the editor state on click.
+      newHeads = A.getHeads(this._handle.docSync()!);
     }
 
     // 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);
+    const diff = A.equals(oldHeads, newHeads) ? [] : A.diff(this._handle.docSync()!, oldHeads, newHeads);
     updateCodeMirror(view, selection, path, diff);
 
+    // Update automerge state.
     view.dispatch({
       effects: updateHeads(newHeads),
-      annotations: reconcileAnnotationType.of({}),
+      annotations: reconcileAnnotation.of(false),
     });
-
-    this._inReconcile = false;
-  };
+  }
 }

package/src/extensions/automerge/update-automerge.ts

@@ -4,17 +4,17 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { type EditorState, type StateField, type Text, type Transaction } from '@codemirror/state';
+import { type EditorState, type StateField, type Transaction, type Text } from '@codemirror/state';
 
-import { next as am, type Heads } from '@dxos/automerge/automerge';
+import { next as A, type Heads } from '@dxos/automerge/automerge';
 
-import { type IDocHandle, type Value } from './defs';
+import { type IDocHandle, type State } from './defs';
 
 export const updateAutomerge = (
-  field: StateField<Value>,
+  field: StateField<State>,
   handle: IDocHandle,
   transactions: Transaction[],
-  state: EditorState,
+  state: EditorState, // TODO(burdon): Just pass in the state field value?
 ): Heads | undefined => {
   const { lastHeads, path } = state.field(field);
 
@@ -31,12 +31,18 @@ export const updateAutomerge = (
     return undefined;
   }
 
-  const newHeads = handle.changeAt(lastHeads, (doc: am.Doc<unknown>) => {
+  const newHeads = handle.changeAt(lastHeads, (doc: A.Doc<unknown>) => {
+    const invertedTransactions: { from: number; del: number; insert: Text }[] = [];
     for (const tr of transactions) {
-      tr.changes.iterChanges((fromA: number, toA: number, _fromB: number, _toB: number, inserted: Text) => {
-        am.splice(doc, path, fromA, toA - fromA, inserted.toString());
+      tr.changes.iterChanges((fromA, toA, _fromB, _toB, insert) => {
+        invertedTransactions.push({ from: fromA, del: toA - fromA, insert });
       });
     }
+
+    // TODO(burdon): Hack to apply in reverse order to properly apply range.
+    invertedTransactions.reverse().forEach(({ from, del, insert }) => {
+      A.splice(doc, path.slice(), from, del, insert.toString());
+    });
   });
 
   return newHeads ?? undefined;

package/src/extensions/automerge/update-codemirror.ts

@@ -16,7 +16,7 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from './defs';
+import { reconcileAnnotation } from './defs';
 
 export const updateCodeMirror = (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
   for (const patch of patches) {
@@ -26,14 +26,14 @@ export const updateCodeMirror = (view: EditorView, selection: EditorSelection, t
       selection = selection.map(changeSet, 1);
       view.dispatch({
         changes: changeSet,
-        annotations: reconcileAnnotationType.of({}),
+        annotations: reconcileAnnotation.of(false),
       });
     }
   }
 
   view.dispatch({
     selection,
-    annotations: reconcileAnnotationType.of({}),
+    annotations: reconcileAnnotation.of(false),
   });
 };
 
@@ -57,7 +57,7 @@ const handleInsert = (target: Prop[], patch: InsertPatch): Array<ChangeSpec> =>
     return [];
   }
 
-  const text = patch.values.map((v) => (v ? v.toString() : '')).join('');
+  const text = patch.values.map((value) => (value ? value.toString() : '')).join('');
   return [{ from: index, to: index, insert: text }];
 };
 
@@ -88,7 +88,7 @@ const handlePut = (target: Prop[], patch: PutPatch, state: EditorState): Array<C
 
   const length = state.doc.length;
   if (typeof patch.value !== 'string') {
-    return []; // TODO(dmaretskyi): How to handle non string values?
+    return []; // TODO(dmaretskyi): How to handle non-string values?
   }
 
   return [{ from: 0, to: length, insert: patch.value as any }];