@dxos/react-ui-editor 0.3.10 → 0.3.11-main.0ac3ef5

package/src/{hooks/automerge/translation/codemirror-to-automerge.ts → extensions/automerge/update-automerge.ts}

@@ -1,18 +1,17 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
-// TODO(burdon): Additional copyright?
-
-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 const codemirrorToAutomerge = (
-  field: Field,
+export const updateAutomerge = (
+  field: StateField<Value>,
   handle: IDocHandle,
   transactions: Transaction[],
   state: EditorState,

package/src/{hooks/automerge/translation/automerge-to-codemirror.ts → extensions/automerge/update-codemirror.ts}

@@ -1,9 +1,9 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
-// TODO(burdon): Additional copyright?
-
 import { ChangeSet, type ChangeSpec, type EditorSelection, type EditorState } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 
@@ -16,14 +16,9 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from '../plugin';
+import { reconcileAnnotationType } from './defs';
 
-export const automergeToCodemirror = (
-  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) {
@@ -61,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 }];
 };
@@ -70,6 +66,7 @@ const handleSplice = (target: Prop[], patch: SpliceTextPatch): Array<ChangeSpec>
   if (index == null) {
     return [];
   }
+
   return [{ from: index, insert: patch.value }];
 };
 
@@ -78,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 }];
 };
@@ -87,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;
 };

package/src/extensions/awareness.ts

@@ -0,0 +1,309 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Annotation, Facet, type Extension, RangeSet, type Range } from '@codemirror/state';
+import {
+  Decoration,
+  type DecorationSet,
+  EditorView,
+  type PluginValue,
+  ViewPlugin,
+  type ViewUpdate,
+  WidgetType,
+} from '@codemirror/view';
+
+import { Event } from '@dxos/async';
+import { Context } from '@dxos/context';
+
+import { Cursor, type CursorConverter } from './cursor';
+
+export interface AwarenessProvider {
+  remoteStateChange: Event<void>;
+
+  open(): void;
+  close(): void;
+
+  update(position: AwarenessPosition | undefined): void;
+  getRemoteStates(): AwarenessState[];
+}
+
+const dummyProvider: AwarenessProvider = {
+  remoteStateChange: new Event(),
+
+  open: () => {},
+  close: () => {},
+
+  update: () => {},
+  getRemoteStates: () => [],
+};
+
+export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
+  combine: (providers) => providers[0] ?? dummyProvider,
+});
+
+// TODO(dmaretskyi): Specify the users that actually changed. Currently, we recalculate positions for every user.
+const RemoteSelectionChangedAnnotation = Annotation.define();
+
+export type AwarenessPosition = {
+  anchor?: string;
+  head?: string;
+};
+
+export type AwarenessInfo = {
+  displayName?: string;
+  // TODO(burdon): Rename light/dark.
+  color?: string;
+  lightColor?: string;
+};
+
+export type AwarenessState = {
+  position?: AwarenessPosition;
+  peerId: string;
+  info: AwarenessInfo;
+};
+
+/**
+ * Extension provides presence information about other peers.
+ */
+// TODO(burdon): Why provide default?
+export const awareness = (provider = dummyProvider): Extension => {
+  return [
+    AwarenessProvider.of(provider),
+    ViewPlugin.fromClass(RemoteSelectionsDecorator, {
+      decorations: (value) => value.decorations,
+    }),
+    styles,
+  ];
+};
+
+/**
+ * Generates selection decorations from remote peers.
+ */
+export class RemoteSelectionsDecorator implements PluginValue {
+  public decorations: DecorationSet = RangeSet.of([]);
+
+  private readonly _ctx = new Context();
+
+  private _cursorConverter: CursorConverter;
+  private _provider: AwarenessProvider;
+  private _lastAnchor?: number = undefined;
+  private _lastHead?: number = undefined;
+
+  constructor(view: EditorView) {
+    this._cursorConverter = view.state.facet(Cursor.converter);
+    this._provider = view.state.facet(AwarenessProvider);
+    this._provider.open();
+    this._provider.remoteStateChange.on(this._ctx, () => {
+      view.dispatch({ annotations: [RemoteSelectionChangedAnnotation.of([])] });
+    });
+  }
+
+  destroy() {
+    void this._ctx.dispose();
+    this._provider.close();
+  }
+
+  update(update: ViewUpdate) {
+    this._updateLocalSelection(update);
+    this._updateRemoteSelections(update);
+  }
+
+  private _updateLocalSelection(update: ViewUpdate) {
+    const hasFocus = update.view.hasFocus && update.view.dom.ownerDocument.hasFocus();
+    const { anchor = undefined, head = undefined } = hasFocus ? update.state.selection.main : {};
+    if (this._lastAnchor === anchor && this._lastHead === head) {
+      return;
+    }
+
+    this._lastAnchor = anchor;
+    this._lastHead = head;
+
+    this._provider.update(
+      anchor !== undefined && head !== undefined
+        ? {
+            anchor: this._cursorConverter.toCursor(anchor),
+            head: this._cursorConverter.toCursor(head),
+          }
+        : undefined,
+    );
+  }
+
+  private _updateRemoteSelections(update: ViewUpdate) {
+    const decorations: Range<Decoration>[] = [];
+    const awarenessStates = this._provider.getRemoteStates();
+    for (const state of awarenessStates) {
+      const anchor = state.position?.anchor ? this._cursorConverter.fromCursor(state.position.anchor) : null;
+      const head = state.position?.head ? this._cursorConverter.fromCursor(state.position.head) : null;
+      if (anchor == null || head == null) {
+        continue;
+      }
+
+      const start = Math.min(Math.min(anchor, head), update.view.state.doc.length);
+      const end = Math.min(Math.max(anchor, head), update.view.state.doc.length);
+
+      const startLine = update.view.state.doc.lineAt(start);
+      const endLine = update.view.state.doc.lineAt(end);
+
+      // TODO(burdon): Factor out styles.
+      const color = state.info.color ?? '#30bced';
+      const lightColor = state.info.lightColor ?? color + '33';
+
+      if (startLine.number === endLine.number) {
+        // Selected content in a single line.
+        decorations.push({
+          from: start,
+          to: end,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${lightColor}` },
+            class: 'cm-collab-selection',
+          }),
+        });
+      } else {
+        // Selected content in multiple lines; first, render text-selection in the first line.
+        decorations.push({
+          from: start,
+          to: startLine.from + startLine.length,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${color}` },
+            class: 'cm-collab-selection',
+          }),
+        });
+
+        // Render text-selection in the last line.
+        decorations.push({
+          from: endLine.from,
+          to: end,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${color}` },
+            class: 'cm-collab-selection',
+          }),
+        });
+
+        for (let i = startLine.number + 1; i < endLine.number; i++) {
+          const linePos = update.view.state.doc.line(i).from;
+          decorations.push({
+            from: linePos,
+            to: linePos,
+            value: Decoration.line({
+              attributes: { style: `background-color: ${color}`, class: 'cm-collab-selectionLine' },
+            }),
+          });
+        }
+      }
+
+      decorations.push({
+        from: head,
+        to: head,
+        value: Decoration.widget({
+          side: head - anchor > 0 ? -1 : 1, // The local cursor should be rendered outside the remote selection.
+          block: false,
+          widget: new RemoteCaretWidget(state.info.displayName ?? 'Anonymous', color),
+        }),
+      });
+    }
+
+    this.decorations = Decoration.set(decorations, true);
+  }
+}
+
+class RemoteCaretWidget extends WidgetType {
+  constructor(private readonly _name: string, private readonly _color: string) {
+    super();
+  }
+
+  override toDOM(): HTMLElement {
+    const span = document.createElement('span');
+    span.className = 'cm-collab-selectionCaret';
+    span.style.backgroundColor = this._color;
+    span.style.borderColor = this._color;
+
+    const dot = document.createElement('div');
+    dot.className = 'cm-collab-selectionCaretDot';
+
+    const info = document.createElement('div');
+    info.className = 'cm-collab-selectionInfo';
+    info.innerText = this._name;
+
+    span.appendChild(document.createTextNode('\u2060'));
+    span.appendChild(dot);
+    span.appendChild(document.createTextNode('\u2060'));
+    span.appendChild(info);
+    span.appendChild(document.createTextNode('\u2060'));
+
+    return span;
+  }
+
+  override updateDOM() {
+    return false;
+  }
+
+  override eq(widget: this) {
+    return widget._color === this._color;
+  }
+
+  override get estimatedHeight() {
+    return -1;
+  }
+
+  override ignoreEvent() {
+    return true;
+  }
+}
+
+const styles = EditorView.baseTheme({
+  '.cm-collab-selection': {},
+  '.cm-collab-selectionLine': {
+    padding: 0,
+    margin: '0px 2px 0px 4px',
+  },
+  '.cm-collab-selectionCaret': {
+    position: 'relative',
+    borderLeft: '1px solid black',
+    borderRight: '1px solid black',
+    marginLeft: '-1px',
+    marginRight: '-1px',
+    boxSizing: 'border-box',
+    display: 'inline',
+  },
+  '.cm-collab-selectionCaretDot': {
+    borderRadius: '50%',
+    position: 'absolute',
+    width: '.4em',
+    height: '.4em',
+    top: '-.2em',
+    left: '-.2em',
+    backgroundColor: 'inherit',
+    transition: 'transform .3s ease-in-out',
+    boxSizing: 'border-box',
+  },
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionCaretDot': {
+    transformOrigin: 'bottom center',
+    transform: 'scale(0)',
+  },
+  '.cm-collab-selectionInfo': {
+    position: 'absolute',
+    top: '-1.05em',
+    left: '-1px',
+    fontSize: '.75em',
+    fontFamily: 'serif',
+    fontStyle: 'normal',
+    fontWeight: 'normal',
+    lineHeight: 'normal',
+    userSelect: 'none',
+    color: 'white',
+    paddingLeft: '2px',
+    paddingRight: '2px',
+    zIndex: 101,
+    transition: 'opacity .3s ease-in-out',
+    backgroundColor: 'inherit',
+    // these should be separate
+    opacity: 0,
+    transitionDelay: '0s',
+    whiteSpace: 'nowrap',
+  },
+  '.cm-collab-selectionCaret:hover > .cm-collab-selectionInfo': {
+    opacity: 1,
+    transitionDelay: '0s',
+  },
+});

package/src/{components/TextEditor/extensions → extensions}/code.ts

@@ -11,38 +11,41 @@ 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-code-block': {
-    display: 'block',
-    paddingInline: '4px !important',
+  '& .cm-codeblock': {
+    fontFamily: getToken('fontFamily.mono', []).join(','),
+  },
+  '&light [aria-readonly="true"] .cm-codeblock': {
+    background: getToken('extend.colors.neutral.50'),
   },
-  '&light .cm-code-block': {
-    background: get(tokens, 'extend.colors.neutral.50'),
+  '&dark [aria-readonly="true"] .cm-codeblock': {
+    background: getToken('extend.colors.neutral.850'),
   },
-  '&dark .cm-code-block': {
-    background: get(tokens, 'extend.colors.neutral.850'),
+  '& [aria-readonly="true"] .cm-codeblock': {
+    display: 'block',
+    paddingInline: '4px !important',
   },
-  '& .cm-code-block-first': {
+  '& [aria-readonly="true"] .cm-codeblock-first': {
     paddingTop: '4px !important',
     borderTopLeftRadius: '4px',
     borderTopRightRadius: '4px',
   },
-  '& .cm-code-block-last': {
+  '& [aria-readonly="true"] .cm-codeblock-last': {
     paddingBottom: '4px !important',
     borderBottomLeftRadius: '4px',
     borderBottomRightRadius: '4px',
   },
 });
 
+// TODO(burdon): Start from EditorView.lineBlockAt(pos).
 const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
   const start = lines.findIndex((line) => line.from >= from);
   const end = lines.findIndex((line) => line.to >= to);
@@ -52,7 +55,7 @@ const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
 export const code = () => {
   const getDecorations = (view: EditorView) => {
     const decorations: Range<Decoration>[] = [];
-    if (view.state.readOnly) {
+    if (!view.hasFocus || view.state.readOnly) {
       const text = view.state.doc.sliceString(0);
       const matches = text.matchAll(CODE_REGEX);
       const blocks = view.viewportLineBlocks;
@@ -62,11 +65,7 @@ export const code = () => {
           const block = blocks[i];
           decorations.push(
             Decoration.line({
-              class: mx(
-                'cm-code-block',
-                i === range[0] && 'cm-code-block-first',
-                i === range[1] && 'cm-code-block-last',
-              ),
+              class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
             }).range(block.from),
           );
         }
@@ -79,13 +78,21 @@ export const code = () => {
   return [
     ViewPlugin.fromClass(
       class {
+        hasFocus = false;
         decorations: DecorationSet;
         constructor(view: EditorView) {
           this.decorations = getDecorations(view);
         }
 
         update(update: ViewUpdate) {
-          if (update.docChanged || update.viewportChanged) {
+          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 = getDecorations(update.view);
           }
         }