@dxos/react-ui-editor 0.3.11-main.b929e1d → 0.3.11-main.bc6b68b

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 { StateField, type Extension } 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 { type Prop, next as A } from '@dxos/automerge/automerge';
+import { invariant } from '@dxos/invariant';
 
 import { cursorConverter } from './cursor';
-import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
+import { effectType, type IDocHandle, isReconcileTx, 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,19 +21,20 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  // TODO(burdon): Rename.
-  const stateField: StateField<Value> = StateField.define({
+  const state = 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)) {
@@ -45,6 +42,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           clearUnreconciled = true;
         }
       }
+
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
@@ -52,43 +50,39 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           result.unreconciledTransactions.push(tr);
         }
       }
+
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(stateField);
+  const semaphore = new PatchSemaphore(handle, state);
 
-  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)),
+    // Reconcile external updates.
+    ViewPlugin.fromClass(
+      class {
+        constructor(private readonly _view: EditorView) {
+          invariant(this._view);
+          handle.addListener('change', this._handleChange.bind(this));
+        }
 
-      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.removeListener('change', this._handleChange.bind(this));
         }
-      }
 
-      destroy() {
-        handle.addListener('change', this._handleChange);
+        _handleChange() {
+          semaphore.reconcile(this._view);
+        }
+      },
+    ),
+    // Reconcile local updates.
+    EditorView.updateListener.of(({ view, changes }) => {
+      if (!changes.empty) {
+        // TODO(burdon): Loses cursor position if auto closing brackets. Call explicitly?
+        semaphore.reconcile(view);
       }
-
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
-      };
-    },
-  );
-
-  return {
-    extension: [
-      CursorConverter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
-  };
+    }),
+    state,
+  ];
 };

package/src/extensions/automerge/cursor.ts

@@ -8,7 +8,7 @@ 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';
+import { type CursorConverter } from '../cursor';
 
 export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
   // TODO(burdon): Handle assoc to associate with a previous character.
@@ -26,6 +26,7 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     // NOTE: Slice is needed because getCursor mutates the array.
     return automerge.getCursor(doc, path.slice(), pos);
   },
+
   fromCursor: (cursor) => {
     if (cursor === '') {
       return 0;

package/src/extensions/automerge/defs.ts

@@ -1,57 +1,36 @@
 //
 // 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;
+// TODO(burdon): Rename.
+export type State = {
   path: Prop[];
+  lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
-type UpdateHeads = {
+export type UpdateHeads = {
   newHeads: Heads;
 };
 
 export const effectType = StateEffect.define<UpdateHeads>({});
 
-export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
+export const reconcileAnnotationType = Annotation.define<unknown>();
 
-export const getLastHeads = (state: EditorState, field: StateField<Value>): Heads => state.field(field).lastHeads;
+export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
 
-export const getPath = (state: EditorState, field: StateField<Value>): Prop[] => state.field(field).path;
+export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
 
-export const reconcileAnnotationType = Annotation.define<unknown>();
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
 
 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;

package/src/extensions/automerge/index.ts

@@ -4,4 +4,3 @@
 
 export { automerge } from './automerge';
 export { type IDocHandle } from './defs';
-export { cursorConverter } from './cursor';

package/src/extensions/automerge/semaphore.ts

@@ -16,37 +16,38 @@ import {
   reconcileAnnotationType,
   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/keystroke).
  */
 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) => {
+  // NOTE: Cannot destruct view.state.
+  reconcile(view: EditorView) {
     if (this._inReconcile) {
       return;
     }
     this._inReconcile = true;
 
-    const path = getPath(view.state, this._field);
-    const oldHeads = getLastHeads(view.state, this._field);
+    const path = getPath(view.state, this._state);
+
+    // 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) => !isReconcileTx(tx));
     const toInvert = transactions.slice().reverse();
     for (const tx of toInvert) {
       const inverted = tx.changes.invert(tx.startState.doc);
@@ -58,23 +59,25 @@ export class PatchSemaphore {
     }
 
     // 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 = automerge.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 = automerge.equals(oldHeads, newHeads)
+      ? []
+      : automerge.diff(this._handle.docSync()!, oldHeads, newHeads);
     updateCodeMirror(view, selection, path, diff);
 
+    // Update automerge state.
     view.dispatch({
       effects: updateHeads(newHeads),
       annotations: reconcileAnnotationType.of({}),
     });
 
     this._inReconcile = false;
-  };
+  }
 }

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

@@ -8,10 +8,10 @@ import { type EditorState, type StateField, type Text, type Transaction } from '
 
 import { next as am, 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,

package/src/extensions/awareness.ts

@@ -16,7 +16,7 @@ import {
 import { Event } from '@dxos/async';
 import { Context } from '@dxos/context';
 
-import { CursorConverter } from '../util';
+import { Cursor, type CursorConverter } from './cursor';
 
 export interface AwarenessProvider {
   remoteStateChange: Event<void>;
@@ -24,8 +24,8 @@ export interface AwarenessProvider {
   open(): void;
   close(): void;
 
-  update(position: AwarenessPosition | undefined): void;
   getRemoteStates(): AwarenessState[];
+  update(position: AwarenessPosition | undefined): void;
 }
 
 const dummyProvider: AwarenessProvider = {
@@ -34,8 +34,8 @@ const dummyProvider: AwarenessProvider = {
   open: () => {},
   close: () => {},
 
-  update: () => {},
   getRemoteStates: () => [],
+  update: () => {},
 };
 
 export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
@@ -66,7 +66,6 @@ export type AwarenessState = {
 /**
  * Extension provides presence information about other peers.
  */
-// TODO(burdon): Why provide default?
 export const awareness = (provider = dummyProvider): Extension => {
   return [
     AwarenessProvider.of(provider),
@@ -91,7 +90,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
   private _lastHead?: number = undefined;
 
   constructor(view: EditorView) {
-    this._cursorConverter = view.state.facet(CursorConverter);
+    this._cursorConverter = view.state.facet(Cursor.converter);
     this._provider = view.state.facet(AwarenessProvider);
     this._provider.open();
     this._provider.remoteStateChange.on(this._ctx, () => {
@@ -156,7 +155,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: end,
           value: Decoration.mark({
             attributes: { style: `background-color: ${lightColor}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
       } else {
@@ -166,7 +165,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: startLine.from + startLine.length,
           value: Decoration.mark({
             attributes: { style: `background-color: ${color}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
 
@@ -176,7 +175,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
           to: end,
           value: Decoration.mark({
             attributes: { style: `background-color: ${color}` },
-            class: 'cm-ySelection',
+            class: 'cm-collab-selection',
           }),
         });
 
@@ -186,7 +185,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
             from: linePos,
             to: linePos,
             value: Decoration.line({
-              attributes: { style: `background-color: ${color}`, class: 'cm-yLineSelection' },
+              attributes: { style: `background-color: ${color}`, class: 'cm-collab-selectionLine' },
             }),
           });
         }
@@ -208,24 +207,22 @@ export class RemoteSelectionsDecorator implements PluginValue {
 }
 
 class RemoteCaretWidget extends WidgetType {
-  constructor(public name: string, public color: string) {
+  constructor(private readonly _name: string, private readonly _color: string) {
     super();
-    this.name = name;
-    this.color = color;
   }
 
-  toDOM(): HTMLElement {
+  override toDOM(): HTMLElement {
     const span = document.createElement('span');
-    span.className = 'cm-ySelectionCaret';
-    span.style.backgroundColor = this.color;
-    span.style.borderColor = this.color;
+    span.className = 'cm-collab-selectionCaret';
+    span.style.backgroundColor = this._color;
+    span.style.borderColor = this._color;
 
     const dot = document.createElement('div');
-    dot.className = 'cm-ySelectionCaretDot';
+    dot.className = 'cm-collab-selectionCaretDot';
 
     const info = document.createElement('div');
-    info.className = 'cm-ySelectionInfo';
-    info.innerText = this.name;
+    info.className = 'cm-collab-selectionInfo';
+    info.innerText = this._name;
 
     span.appendChild(document.createTextNode('\u2060'));
     span.appendChild(dot);
@@ -236,18 +233,14 @@ class RemoteCaretWidget extends WidgetType {
     return span;
   }
 
-  override eq(widget: this) {
-    return widget.color === this.color;
-  }
-
-  compare(widget: this) {
-    return widget.color === this.color;
-  }
-
   override updateDOM() {
     return false;
   }
 
+  override eq(widget: this) {
+    return widget._color === this._color;
+  }
+
   override get estimatedHeight() {
     return -1;
   }
@@ -257,14 +250,13 @@ class RemoteCaretWidget extends WidgetType {
   }
 }
 
-// TODO(burdon): Rename prefix (y for yjs?)
 const styles = EditorView.baseTheme({
-  '.cm-ySelection': {},
-  '.cm-yLineSelection': {
+  '.cm-collab-selection': {},
+  '.cm-collab-selectionLine': {
     padding: 0,
     margin: '0px 2px 0px 4px',
   },
-  '.cm-ySelectionCaret': {
+  '.cm-collab-selectionCaret': {
     position: 'relative',
     borderLeft: '1px solid black',
     borderRight: '1px solid black',
@@ -272,44 +264,46 @@ const styles = EditorView.baseTheme({
     marginRight: '-1px',
     boxSizing: 'border-box',
     display: 'inline',
+    cursor: 'pointer',
   },
-  '.cm-ySelectionCaretDot': {
+  '.cm-collab-selectionCaretDot': {
     borderRadius: '50%',
     position: 'absolute',
-    width: '.4em',
-    height: '.4em',
-    top: '-.2em',
-    left: '-.2em',
+    width: '.5em',
+    height: '.5em',
+    top: '-.25em',
+    left: '-.25em',
     backgroundColor: 'inherit',
     transition: 'transform .3s ease-in-out',
     boxSizing: 'border-box',
   },
-  '.cm-ySelectionCaret:hover > .cm-ySelectionCaretDot': {
-    transformOrigin: 'bottom center',
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionCaretDot': {
     transform: 'scale(0)',
+    transformOrigin: 'center',
   },
-  '.cm-ySelectionInfo': {
+  '.cm-collab-selectionInfo': {
     position: 'absolute',
-    top: '-1.05em',
-    left: '-1px',
+    transform: 'translate(-50%, 0)',
+    top: '-20px',
+    left: 0,
     fontSize: '.75em',
-    fontFamily: 'serif',
+    fontFamily: 'sans-serif',
     fontStyle: 'normal',
     fontWeight: 'normal',
     lineHeight: 'normal',
     userSelect: 'none',
     color: 'white',
-    paddingLeft: '2px',
-    paddingRight: '2px',
+    padding: '2px',
     zIndex: 101,
     transition: 'opacity .3s ease-in-out',
     backgroundColor: 'inherit',
-    // these should be separate
+    borderRadius: '2px',
+    // These should be separate.
     opacity: 0,
     transitionDelay: '0s',
     whiteSpace: 'nowrap',
   },
-  '.cm-ySelectionCaret:hover > .cm-ySelectionInfo': {
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionInfo': {
     opacity: 1,
     transitionDelay: '0s',
   },

package/src/extensions/basic.ts

@@ -3,30 +3,35 @@
 //
 
 import { closeBrackets } from '@codemirror/autocomplete';
+import { history } from '@codemirror/commands';
 import { bracketMatching, defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
 import { type Extension } from '@codemirror/state';
 import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
-import { drawSelection, EditorView, placeholder } from '@codemirror/view';
+import { drawSelection, EditorView, highlightActiveLine, placeholder } from '@codemirror/view';
 
-import type { ThemeMode } from '@dxos/react-ui';
+import { type ThemeMode } from '@dxos/react-ui';
+
+import { type TextEditorProps } from '../components';
 
 export type BasicBundleOptions = {
-  readonly?: boolean;
   themeMode?: ThemeMode;
-  placeholder?: string;
-};
+} & Pick<TextEditorProps, 'placeholder' | 'lineWrapping'>;
 
-export const basicBundle = ({ readonly, themeMode, placeholder: _placeholder }: BasicBundleOptions): Extension[] =>
-  [
-    EditorView.lineWrapping,
+export const basicBundle = ({
+  themeMode,
+  placeholder: _placeholder,
+  lineWrapping = true,
+}: BasicBundleOptions): Extension[] => [
+  lineWrapping ? EditorView.lineWrapping : [],
 
-    // TODO(burdon): Compare with minimalSetup.
-    // https://codemirror.net/docs/ref/#codemirror.minimalSetup
-    bracketMatching(),
-    closeBrackets(),
-    drawSelection(),
-    _placeholder && placeholder(_placeholder),
+  // https://codemirror.net/docs/ref/#codemirror.minimalSetup
+  bracketMatching(),
+  closeBrackets(),
+  drawSelection(),
+  highlightActiveLine(),
+  history(),
+  _placeholder ? placeholder(_placeholder) : [],
 
-    // TODO(burdon): Is this required?
-    themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
-  ].filter(Boolean) as Extension[];
+  // https://github.com/codemirror/theme-one-dark
+  themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
+];

package/src/extensions/code.ts

@@ -53,22 +53,20 @@ const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
 };
 
 export const code = () => {
-  const getDecorations = (view: EditorView) => {
+  const buildDecorations = (view: EditorView) => {
     const decorations: Range<Decoration>[] = [];
-    if (view.state.readOnly) {
-      const text = view.state.doc.sliceString(0);
-      const matches = text.matchAll(CODE_REGEX);
-      const blocks = view.viewportLineBlocks;
-      for (const match of matches) {
-        const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
-        for (let i = range[0]; i <= range[1]; i++) {
-          const block = blocks[i];
-          decorations.push(
-            Decoration.line({
-              class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
-            }).range(block.from),
-          );
-        }
+    const text = view.state.doc.sliceString(0);
+    const matches = text.matchAll(CODE_REGEX);
+    const blocks = view.viewportLineBlocks;
+    for (const match of matches) {
+      const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
+      for (let i = range[0]; i <= range[1]; i++) {
+        const block = blocks[i];
+        decorations.push(
+          Decoration.line({
+            class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
+          }).range(block.from),
+        );
       }
     }
 
@@ -78,14 +76,22 @@ export const code = () => {
   return [
     ViewPlugin.fromClass(
       class {
+        hasFocus = false;
         decorations: DecorationSet;
         constructor(view: EditorView) {
-          this.decorations = getDecorations(view);
+          this.decorations = buildDecorations(view);
         }
 
         update(update: ViewUpdate) {
-          if (update.docChanged || update.viewportChanged) {
-            this.decorations = getDecorations(update.view);
+          if (
+            // TODO(burdon): Generalize for other extensions.
+            this.hasFocus !== update.view.hasFocus ||
+            update.startState.readOnly !== update.view.state.readOnly ||
+            update.docChanged ||
+            update.viewportChanged
+          ) {
+            this.hasFocus = update.view.hasFocus;
+            this.decorations = buildDecorations(update.view);
           }
         }
       },