@dxos/react-ui-editor 0.3.11-main.c8e9429 → 0.3.11-main.cc2fe2c

package/src/components/TextEditor/comments.stories.tsx

@@ -17,8 +17,8 @@ import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
 import { MarkdownEditor, TextEditor } from './TextEditor';
-import { comments, type CommentsOptions, Cursor } from '../../extensions';
-import { type CommentRange, type Range, useTextModel } from '../../hooks';
+import { comments, type CommentsOptions, setFocus, useComments } from '../../extensions';
+import { type Comment, type Range, useTextModel } from '../../hooks';
 
 faker.seed(101);
 
@@ -28,31 +28,34 @@ faker.seed(101);
 
 const Editor: FC<{
   item: { text: TextObject };
-  commentSelected?: string;
-  commentRanges: CommentRange[];
+  comments: Comment[];
+  selected?: string;
   onCreateComment: CommentsOptions['onCreate'];
   onDeleteComment: CommentsOptions['onDelete'];
   onUpdateComment: CommentsOptions['onUpdate'];
   onSelectComment: CommentsOptions['onSelect'];
-}> = ({ item, commentSelected, commentRanges, onCreateComment, onDeleteComment, onUpdateComment, onSelectComment }) => {
+}> = ({
+  item,
+  selected: selectedValue,
+  comments: commentRanges,
+  onCreateComment,
+  onDeleteComment,
+  onUpdateComment,
+  onSelectComment,
+}) => {
   const model = useTextModel({ text: item.text });
-  const editorRef = useRef<EditorView>(null);
+  const view = useRef<EditorView>(null);
   const [selected, setSelected] = useState<string>();
   useEffect(() => {
-    if (!editorRef.current?.hasFocus && commentSelected !== selected) {
-      const thread = commentRanges.find((range) => range.id === commentSelected);
-      if (thread) {
-        const { cursor } = thread;
-        const range = Cursor.getRangeFromCursor(editorRef.current!.state.facet(Cursor.converter), cursor);
-        if (range) {
-          // TODO(burdon): Scroll selection to center of screen?
-          editorRef.current?.dispatch({ selection: { anchor: range.from }, scrollIntoView: true });
-        }
+    if (!view.current?.hasFocus && selectedValue !== selected) {
+      setSelected(selectedValue);
+      if (selectedValue) {
+        setFocus(view.current!, selectedValue);
       }
-
-      setSelected(commentSelected);
     }
-  }, [selected, commentRanges, commentSelected]);
+  }, [selected, commentRanges, selectedValue]);
+
+  useComments(view.current, commentRanges);
 
   const extensions = useMemo(() => {
     return [
@@ -72,7 +75,7 @@ const Editor: FC<{
   // TODO(burdon): Highlight currently selected comment.
   return (
     <div className='flex grow overflow-y-scroll'>
-      <MarkdownEditor ref={editorRef} model={model} comments={commentRanges} extensions={extensions} />
+      <MarkdownEditor ref={view} model={model} extensions={extensions} />
     </div>
   );
 };
@@ -83,11 +86,10 @@ const Editor: FC<{
 
 type CommentThread = {
   id: string;
-  range: CommentRange;
+  cursor?: string;
+  range?: Range;
   yPos?: number;
-  selection?: Range;
   messages: TextObject[];
-  deleted?: boolean;
 };
 
 const Thread: FC<{
@@ -129,16 +131,16 @@ const Thread: FC<{
       className={mx(
         'flex flex-col m-1 rounded shadow divide-y bg-white',
         selected && 'ring',
-        thread.deleted && 'opacity-50',
+        !thread.cursor && 'opacity-50',
       )}
     >
       <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
         <span>id:{thread.id.slice(0, 4)}</span>
-        <span>from:{thread.selection?.from}</span>
-        <span>to:{thread.selection?.to}</span>
+        <span>from:{thread.range?.from}</span>
+        <span>to:{thread.range?.to}</span>
         <span>y:{thread.yPos}</span>
         <span className='grow' />
-        {thread.deleted && <Trash />}
+        {!thread.cursor && <Trash />}
       </div>
 
       {thread.messages.map((message, i) => (
@@ -151,10 +153,10 @@ const Thread: FC<{
       <div ref={containerRef} onClick={() => onSelect()} className='flex'>
         <TextEditor
           ref={editorRef}
-          autofocus={focus}
+          autoFocus={focus}
           model={model}
           placeholder={'Enter comment...'}
-          slots={{ root: { className: 'grow p-2 rounded-b' } }}
+          slots={{ root: { className: 'grow rounded-b' } }}
           extensions={[
             keymap.of([
               {
@@ -218,9 +220,10 @@ type StoryProps = {
 const Story = ({ text, autoCreate }: StoryProps) => {
   const [item] = useState({ text: new TextObject(text) });
   const [threads, setThreads] = useState<CommentThread[]>([]);
-  const commentRanges = useMemo(() => threads.map((thread) => thread.range), [threads]);
   const [selected, setSelected] = useState<string>();
 
+  const comments = useMemo<Comment[]>(() => threads.map(({ id, cursor }) => ({ id, cursor })), [threads]);
+
   // Filter by visibility.
   const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
 
@@ -231,14 +234,14 @@ const Story = ({ text, autoCreate }: StoryProps) => {
       ...threads,
       {
         id,
-        range: { id, cursor },
+        cursor,
         yPos: location ? Math.floor(location.top) : undefined,
         messages: autoCreate
           ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
           : [],
       },
     ]);
-    setSelected(id);
+    setSelected(id); // TODO(burdon): Not required.
     return id;
   };
 
@@ -247,7 +250,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     setThreads((threads) =>
       threads.map((thread) => {
         if (thread.id === id) {
-          thread.deleted = true;
+          thread.cursor = undefined;
         }
 
         return thread;
@@ -262,8 +265,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     setThreads((threads) =>
       threads.map((thread) => {
         if (thread.id === id) {
-          thread.range.cursor = cursor;
-          delete thread.deleted;
+          thread.cursor = cursor;
         }
 
         return thread;
@@ -271,21 +273,21 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     );
   };
 
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
-    log.info('select', { active: active?.slice(0, 4), closest: closest?.slice(0, 4) });
+  const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { current, closest } }) => {
+    log.info('select', { active: current?.slice(0, 4), closest: closest?.slice(0, 4) });
     setThreads((threads) =>
       threads.map((thread) => {
-        const range = ranges.find((range) => range.id === thread.range.id);
-        if (range) {
-          thread.yPos = range.location ? Math.floor(range.location.top) : undefined;
-          thread.selection = { from: range.from, to: range.to };
+        const comment = comments.find(({ comment }) => comment.id === thread.id);
+        if (comment) {
+          thread.yPos = comment.location ? Math.floor(comment.location.top) : undefined;
+          thread.range = { from: comment.range.from, to: comment.range.to };
         }
 
         return thread;
       }),
     );
 
-    setSelected(active ?? closest);
+    setSelected(current ?? closest);
   };
 
   const handleSelectThread = (id: string) => {
@@ -303,8 +305,8 @@ const Story = ({ text, autoCreate }: StoryProps) => {
         <div className='flex flex-col h-full w-[600px]'>
           <Editor
             item={item}
-            commentSelected={selected}
-            commentRanges={commentRanges}
+            selected={selected}
+            comments={comments}
             onCreateComment={handleCreateComment}
             onDeleteComment={handleDeleteComment}
             onUpdateComment={handleUpdateComment}

package/src/extensions/autocomplete.ts

@@ -35,10 +35,13 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
     // https://codemirror.net/examples/autocompletion
     // https://codemirror.net/docs/ref/#autocomplete.autocompletion
     autocompletion({
-      defaultKeymap: false,
+      activateOnTyping: true,
 
-      // Don't start unless key press.
-      activateOnTyping: false,
+      // closeOnBlur: false,
+      // defaultKeymap: false,
+
+      // TODO(burdon): Styles/fragments.
+      tooltipClass: () => 'shadow rounded',
     }),
 
     // TODO(burdon): Option to create new page?

package/src/extensions/automerge/automerge.ts

@@ -4,14 +4,14 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { 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, semaphoreFacet, type Value } from './defs';
+import { effectType, type IDocHandle, isReconcileTx, type State } from './defs';
 import { PatchSemaphore } from './semaphore';
 import { Cursor } from '../cursor';
 
@@ -21,18 +21,18 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  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;
@@ -55,38 +55,34 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
     },
   });
 
-  const semaphore = new PatchSemaphore(handle, stateField);
+  const semaphore = new PatchSemaphore(handle, state);
 
-  const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeViewPlugin 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))) {
-          queueMicrotask(() => {
-            this._view.state.facet(semaphoreFacet).reconcile(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(this._view);
-      };
-    },
-  );
-
-  return {
-    extension: [
-      Cursor.converter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
-  };
+    }),
+    state,
+  ];
 };

package/src/extensions/automerge/defs.ts

@@ -4,15 +4,14 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { Annotation, StateEffect, type StateField, type EditorState, type Transaction, Facet } 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';
 
-import { type PatchSemaphore } from './semaphore';
-
-export type Value = {
-  lastHeads: Heads;
+// TODO(burdon): Rename.
+export type State = {
   path: Prop[];
+  lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
@@ -22,39 +21,15 @@ export type UpdateHeads = {
 
 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 getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
 
-// 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 getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
 
-/*
-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({})];
-  }
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
 
-  // return {
-  //   ...tr,
-  //   annotations: reconcileAnnotationType.of({})
-  // }
-};
-*/
+export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
 
 export type IDocHandle<T = any> = {
   docSync(): Doc<T> | undefined;

package/src/extensions/automerge/semaphore.ts

@@ -16,33 +16,38 @@ import {
   reconcileAnnotationType,
   updateHeads,
   type IDocHandle,
-  type Value,
+  type State,
 } from './defs';
 import { updateAutomerge } from './update-automerge';
 import { updateCodeMirror } from './update-codemirror';
 
 /**
- * Implements three-way merge (on each mutation/key-stroke).
+ * Implements three-way merge (on each mutation/keystroke).
  */
 export class PatchSemaphore {
-  _inReconcile = false;
+  private _inReconcile = false;
 
-  constructor(private readonly _handle: IDocHandle, private readonly _field: StateField<Value>) {}
+  // prettier-ignore
+  constructor(
+    private readonly _handle: IDocHandle,
+    private readonly _state: StateField<State>
+  ) {}
 
-  reconcile = (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 path = getPath(view.state, this._state);
 
     // Get the heads before the unreconciled transactions are applied.
-    const oldHeads = getLastHeads(view.state, this._field);
+    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);
@@ -54,11 +59,10 @@ export class PatchSemaphore {
     }
 
     // Apply the unreconciled transactions to the document.
-    let newHeads = updateAutomerge(this._field, this._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
+      // TODO(alexjg): this is the call that's resetting the editor state on click.
       newHeads = automerge.getHeads(this._handle.docSync()!);
     }
 
@@ -68,11 +72,12 @@ export class PatchSemaphore {
       : 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

@@ -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),
@@ -251,7 +250,6 @@ class RemoteCaretWidget extends WidgetType {
   }
 }
 
-// TODO(burdon): Mixed case?
 const styles = EditorView.baseTheme({
   '.cm-collab-selection': {},
   '.cm-collab-selectionLine': {
@@ -266,38 +264,40 @@ 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',
+    borderRadius: '2px',
     // These should be separate.
     opacity: 0,
     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),
+];