@dxos/react-ui-editor 0.3.11-main.870164f → 0.3.11-main.8a2cfe6

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/{hooks → extensions}/automerge/semaphore.ts

@@ -1,15 +1,23 @@
 //
 // Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
 //
 
-// TODO(burdon): Additional copyright?
-
+import { type StateField } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 
 import { next as automerge } from '@dxos/automerge/automerge';
 
-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';
 
@@ -22,15 +30,10 @@ type ChangeFn = (atHeads: Heads, change: (doc: Doc<unknown>) => void) => Heads |
  * 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) {
@@ -42,9 +45,8 @@ export class PatchSemaphore {
     const oldHeads = getLastHeads(view.state, this._field);
     let selection = view.state.selection;
 
-    const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
-
     // First undo all the unreconciled transactions.
+    const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
     const toInvert = transactions.slice().reverse();
     for (const tx of toInvert) {
       const inverted = tx.changes.invert(tx.startState.doc);

package/src/{hooks → 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 updateAutomerge = (
-  field: Field,
+  field: StateField<Value>,
   handle: IDocHandle,
   transactions: Transaction[],
   state: EditorState,

package/src/{hooks → 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,7 +16,7 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from './plugin';
+import { reconcileAnnotationType } from './defs';
 
 export const updateCodeMirror = (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
   for (const patch of patches) {
@@ -56,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 }];
 };
@@ -65,6 +66,7 @@ const handleSplice = (target: Prop[], patch: SpliceTextPatch): Array<ChangeSpec>
   if (index == null) {
     return [];
   }
+
   return [{ from: index, insert: patch.value }];
 };
 
@@ -73,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 }];
 };
@@ -82,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,316 @@
+//
+// 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 { CursorConverter } from '../util';
+
+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(CursorConverter);
+    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-ySelection',
+          }),
+        });
+      } 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-ySelection',
+          }),
+        });
+
+        // Render text-selection in the last line.
+        decorations.push({
+          from: endLine.from,
+          to: end,
+          value: Decoration.mark({
+            attributes: { style: `background-color: ${color}` },
+            class: 'cm-ySelection',
+          }),
+        });
+
+        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-yLineSelection' },
+            }),
+          });
+        }
+      }
+
+      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(public name: string, public color: string) {
+    super();
+    this.name = name;
+    this.color = color;
+  }
+
+  toDOM(): HTMLElement {
+    const span = document.createElement('span');
+    span.className = 'cm-ySelectionCaret';
+    span.style.backgroundColor = this.color;
+    span.style.borderColor = this.color;
+
+    const dot = document.createElement('div');
+    dot.className = 'cm-ySelectionCaretDot';
+
+    const info = document.createElement('div');
+    info.className = 'cm-ySelectionInfo';
+    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 eq(widget: this) {
+    return widget.color === this.color;
+  }
+
+  compare(widget: this) {
+    return widget.color === this.color;
+  }
+
+  override updateDOM() {
+    return false;
+  }
+
+  override get estimatedHeight() {
+    return -1;
+  }
+
+  override ignoreEvent() {
+    return true;
+  }
+}
+
+// TODO(burdon): Rename prefix (y for yjs?)
+const styles = EditorView.baseTheme({
+  '.cm-ySelection': {},
+  '.cm-yLineSelection': {
+    padding: 0,
+    margin: '0px 2px 0px 4px',
+  },
+  '.cm-ySelectionCaret': {
+    position: 'relative',
+    borderLeft: '1px solid black',
+    borderRight: '1px solid black',
+    marginLeft: '-1px',
+    marginRight: '-1px',
+    boxSizing: 'border-box',
+    display: 'inline',
+  },
+  '.cm-ySelectionCaretDot': {
+    borderRadius: '50%',
+    position: 'absolute',
+    width: '.4em',
+    height: '.4em',
+    top: '-.2em',
+    left: '-.2em',
+    backgroundColor: 'inherit',
+    transition: 'transform .3s ease-in-out',
+    boxSizing: 'border-box',
+  },
+  '.cm-ySelectionCaret:hover > .cm-ySelectionCaretDot': {
+    transformOrigin: 'bottom center',
+    transform: 'scale(0)',
+  },
+  '.cm-ySelectionInfo': {
+    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-ySelectionCaret:hover > .cm-ySelectionInfo': {
+    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',

package/src/extensions/comments.ts

@@ -16,7 +16,6 @@ import {
   WidgetType,
   type Rect,
 } from '@codemirror/view';
-import get from 'lodash.get';
 import sortBy from 'lodash.sortby';
 
 import { debounce } from '@dxos/async';
@@ -24,9 +23,9 @@ import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { nonNullable } from '@dxos/util';
 
-import { callbackWrapper } from './util';
-import { type CommentRange, type EditorModel, modelState, type Range } from '../hooks';
-import { tokens } from '../styles';
+import { type CommentRange, type EditorModel, type Range } from '../hooks';
+import { getToken } from '../styles';
+import { callbackWrapper, CursorConverter } from '../util';
 
 // TODO(burdon): Handle delete, cut, copy, and paste (separately) text that includes comment range.
 // TODO(burdon): Consider breaking into separate plugin (since not standalone)? Like mermaid?
@@ -43,10 +42,10 @@ const styles = EditorView.baseTheme({
     backgroundColor: 'orange',
   },
   '& .cm-comment': {
-    backgroundColor: get(tokens, 'extend.colors.yellow.50'),
+    backgroundColor: getToken('extend.colors.yellow.50'),
   },
   '& .cm-comment-active': {
-    backgroundColor: get(tokens, 'extend.colors.yellow.100'),
+    backgroundColor: getToken('extend.colors.yellow.100'),
   },
 });
 
@@ -99,6 +98,8 @@ const setCommentState = StateEffect.define<CommentsState>();
 const commentsStateField = StateField.define<CommentsState>({
   create: () => ({ ranges: [] }),
   update: (value, tr) => {
+    const cursorConverter = tr.state.facet(CursorConverter);
+
     for (const effect of tr.effects) {
       // Update selection.
       if (effect.is(setSelection)) {
@@ -107,10 +108,10 @@ const commentsStateField = StateField.define<CommentsState>({
 
       // Update range from store.
       if (effect.is(setCommentRange)) {
-        const { model, comments } = effect.value;
+        const { comments } = effect.value;
         const ranges: ExtendedCommentRange[] = comments
           .map((comment) => {
-            const range = model.getRangeFromCursor!(comment.cursor);
+            const range = getRangeFromCursor(cursorConverter, comment.cursor);
             return range && { ...comment, ...range };
           })
           .filter(nonNullable);
@@ -218,14 +219,15 @@ export const comments = (options: CommentsOptions = {}): Extension => {
    * Create comment thread action.
    */
   const createCommentThread: Command = (view) => {
+    const cursorConverter = view.state.facet(CursorConverter);
+
     invariant(options.onCreate);
     const { head, from, to } = view.state.selection.main;
     if (from === to) {
       return false;
     }
 
-    const model = view.state.field(modelState);
-    const relPos = model?.getCursorFromRange?.({ from, to });
+    const relPos = getCursorFromRange(cursorConverter, { from, to });
     if (relPos) {
       // Create thread via callback.
       const id = callbackWrapper(options.onCreate)(relPos);
@@ -338,19 +340,19 @@ export const comments = (options: CommentsOptions = {}): Extension => {
     // Monitor cursor movement and text updates.
     // TODO(burdon): Is there a better (finer grained) way to do this?
     //
-    EditorView.updateListener.of(({ view, state, startState, changes }) => {
+    EditorView.updateListener.of(({ view, state, changes }) => {
+      const cursorConverter = view.state.facet(CursorConverter);
+
       //
       // Test if need to recompute indexed range if document changes before the end of the range.
       //
       {
         let mod = false;
-        const model = state.field(modelState);
         const { active, ranges } = state.field(commentsStateField);
         changes.iterChanges((from, to, from2, to2) => {
-          invariant(model);
           ranges.forEach((range) => {
             if (from2 === to2) {
-              const newRange = model.getRangeFromCursor!(range.cursor);
+              const newRange = getRangeFromCursor(cursorConverter, range.cursor);
               if (!newRange || newRange.to - newRange.from === 0) {
                 // TODO(burdon): Delete range if empty.
                 log.info('deleted comment', { thread: range.id });
@@ -358,7 +360,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
             }
 
             if (from <= range.to) {
-              const newRange = model.getRangeFromCursor!(range.cursor);
+              const newRange = getRangeFromCursor(cursorConverter, range.cursor);
               Object.assign(range, newRange);
               mod = true;
             }
@@ -403,3 +405,16 @@ export const comments = (options: CommentsOptions = {}): Extension => {
     }),
   ];
 };
+
+const getCursorFromRange = (cursorConverter: CursorConverter, range: Range) => {
+  const from = cursorConverter.toCursor(range.from);
+  const to = cursorConverter.toCursor(range.to, -1);
+  return [from, to].join(':');
+};
+
+const getRangeFromCursor = (cursorConverter: CursorConverter, cursor: string) => {
+  const parts = cursor.split(':');
+  const from = cursorConverter.fromCursor(parts[0]);
+  const to = cursorConverter.fromCursor(parts[1]);
+  return from !== undefined && to !== undefined ? { from, to } : undefined;
+};