@dxos/react-ui-editor 0.3.11-main.008b7c6 → 0.3.11-main.00a28cb

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 { 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 { effectType, type IDocHandle, isReconcileTx, semaphoreFacet, 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.
-});
+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({
     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)) {
@@ -45,6 +42,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           clearUnreconciled = true;
         }
       }
+
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
@@ -52,23 +50,23 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           result.unreconciledTransactions.push(tr);
         }
       }
+
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(stateField);
+  const semaphore = new PatchSemaphore(handle, stateField);
 
   const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeCodemirrorViewPlugin implements PluginValue {
+    class AutomergeViewPlugin 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);
+            this._view.state.facet(semaphoreFacet).reconcile(this._view);
           });
         }
       }
@@ -78,14 +76,14 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
       }
 
       private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
+        this._view.state.facet(semaphoreFacet).reconcile(this._view);
       };
     },
   );
 
   return {
     extension: [
-      CursorConverter.of(cursorConverter(handle, path)),
+      Cursor.converter.of(cursorConverter(handle, path)),
       semaphoreFacet.of(semaphore),
       stateField,
       viewPlugin,

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,26 +1,22 @@
 //
 // 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, Facet } from '@codemirror/state';
 
 import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
 
+import { type PatchSemaphore } from './semaphore';
+
 export type Value = {
   lastHeads: Heads;
   path: Prop[];
   unreconciledTransactions: Transaction[];
 };
 
-type UpdateHeads = {
+export type UpdateHeads = {
   newHeads: Heads;
 };
 
@@ -36,6 +32,12 @@ export const reconcileAnnotationType = Annotation.define<unknown>();
 
 export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
 
+// TODO(burdon): Rename sync/create generic def (like cursor) to decouple automerge deps.
+export const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
+  combine: (values) => values.at(-1)!, // Take last.
+});
+
+/*
 export const makeReconcile = (tr: TransactionSpec) => {
   if (tr.annotations != null) {
     if (tr.annotations instanceof Array) {
@@ -46,11 +48,13 @@ export const makeReconcile = (tr: TransactionSpec) => {
   } else {
     tr.annotations = [reconcileAnnotationType.of({})];
   }
+
   // return {
   //   ...tr,
   //   annotations: reconcileAnnotationType.of({})
   // }
 };
+*/
 
 export type IDocHandle<T = any> = {
   docSync(): Doc<T> | undefined;

package/src/extensions/automerge/semaphore.ts

@@ -21,27 +21,23 @@ import {
 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/key-stroke).
  */
 export class PatchSemaphore {
   _inReconcile = false;
-  _queue: Array<ChangeFn> = [];
 
-  constructor(private readonly _field: StateField<Value>) {}
+  constructor(private readonly _handle: IDocHandle, private readonly _field: StateField<Value>) {}
 
-  reconcile = (handle: IDocHandle, view: EditorView) => {
+  reconcile = (view: EditorView) => {
     if (this._inReconcile) {
       return;
     }
     this._inReconcile = true;
 
     const path = getPath(view.state, this._field);
+
+    // Get the heads before the unreconciled transactions are applied.
     const oldHeads = getLastHeads(view.state, this._field);
     let selection = view.state.selection;
 
@@ -58,16 +54,18 @@ export class PatchSemaphore {
     }
 
     // Apply the unreconciled transactions to the document.
-    let newHeads = updateAutomerge(this._field, handle, transactions, view.state);
+    let newHeads = updateAutomerge(this._field, this._handle, transactions, view.state);
 
     // 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()!);
+      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);
 
     view.dispatch({

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>;
@@ -91,7 +91,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 +156,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 +166,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 +176,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 +186,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 +208,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 +234,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 +251,14 @@ class RemoteCaretWidget extends WidgetType {
   }
 }
 
-// TODO(burdon): Rename prefix (y for yjs?)
+// TODO(burdon): Mixed case?
 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',
@@ -273,7 +267,7 @@ const styles = EditorView.baseTheme({
     boxSizing: 'border-box',
     display: 'inline',
   },
-  '.cm-ySelectionCaretDot': {
+  '.cm-collab-selectionCaretDot': {
     borderRadius: '50%',
     position: 'absolute',
     width: '.4em',
@@ -284,11 +278,11 @@ const styles = EditorView.baseTheme({
     transition: 'transform .3s ease-in-out',
     boxSizing: 'border-box',
   },
-  '.cm-ySelectionCaret:hover > .cm-ySelectionCaretDot': {
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionCaretDot': {
     transformOrigin: 'bottom center',
     transform: 'scale(0)',
   },
-  '.cm-ySelectionInfo': {
+  '.cm-collab-selectionInfo': {
     position: 'absolute',
     top: '-1.05em',
     left: '-1px',
@@ -304,12 +298,12 @@ const styles = EditorView.baseTheme({
     zIndex: 101,
     transition: 'opacity .3s ease-in-out',
     backgroundColor: 'inherit',
-    // these should be separate
+    // 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/code.ts

@@ -11,24 +11,23 @@ import {
   Decoration,
   type BlockInfo,
 } from '@codemirror/view';
-import get from 'lodash.get';
 
 import { mx } from '@dxos/react-ui-theme';
 
-import { tokens } from '../styles';
+import { getToken } from '../styles';
 
 const CODE_REGEX = /```[\s\S]*?```/gs;
 
 // TODO(burdon): Reconcile with theme.
 const styles = EditorView.baseTheme({
   '& .cm-codeblock': {
-    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
+    fontFamily: getToken('fontFamily.mono', []).join(','),
   },
   '&light [aria-readonly="true"] .cm-codeblock': {
-    background: get(tokens, 'extend.colors.neutral.50'),
+    background: getToken('extend.colors.neutral.50'),
   },
   '&dark [aria-readonly="true"] .cm-codeblock': {
-    background: get(tokens, 'extend.colors.neutral.850'),
+    background: getToken('extend.colors.neutral.850'),
   },
   '& [aria-readonly="true"] .cm-codeblock': {
     display: 'block',
@@ -54,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),
+        );
       }
     }
 
@@ -79,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);
           }
         }
       },