@dxos/react-ui-editor 0.3.11-main.68db74e → 0.3.11-main.69484a6

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/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

@@ -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 }];

package/src/extensions/awareness.ts

@@ -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,11 +34,11 @@ const dummyProvider: AwarenessProvider = {
   open: () => {},
   close: () => {},
 
-  update: () => {},
   getRemoteStates: () => [],
+  update: () => {},
 };
 
-export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
+export const awarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
   combine: (providers) => providers[0] ?? dummyProvider,
 });
 
@@ -66,10 +66,9 @@ 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),
+    awarenessProvider.of(provider),
     ViewPlugin.fromClass(RemoteSelectionsDecorator, {
       decorations: (value) => value.decorations,
     }),
@@ -92,7 +91,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
 
   constructor(view: EditorView) {
     this._cursorConverter = view.state.facet(Cursor.converter);
-    this._provider = view.state.facet(AwarenessProvider);
+    this._provider = view.state.facet(awarenessProvider);
     this._provider.open();
     this._provider.remoteStateChange.on(this._ctx, () => {
       view.dispatch({ annotations: [RemoteSelectionChangedAnnotation.of([])] });
@@ -265,39 +264,41 @@ const styles = EditorView.baseTheme({
     marginRight: '-1px',
     boxSizing: 'border-box',
     display: 'inline',
+    cursor: 'pointer',
   },
   '.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-collab-selectionCaret:hover > .cm-collab-selectionCaretDot': {
-    transformOrigin: 'bottom center',
     transform: 'scale(0)',
+    transformOrigin: 'center',
   },
   '.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',

package/src/extensions/basic.ts

@@ -3,30 +3,37 @@
 //
 
 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 { isNotFalsy } from '@dxos/util';
+
+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[] =>
+export const createBasicBundle = ({
+  themeMode,
+  placeholder: _placeholder,
+  lineWrapping = true,
+}: BasicBundleOptions = {}): Extension[] =>
   [
-    EditorView.lineWrapping,
+    lineWrapping && EditorView.lineWrapping,
 
-    // TODO(burdon): Compare with minimalSetup.
     // https://codemirror.net/docs/ref/#codemirror.minimalSetup
     bracketMatching(),
     closeBrackets(),
     drawSelection(),
+    highlightActiveLine(),
+    history(),
     _placeholder && placeholder(_placeholder),
 
-    // TODO(burdon): Is this required?
+    // https://github.com/codemirror/theme-one-dark
     themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
-  ].filter(Boolean) as Extension[];
+  ].filter(isNotFalsy);