@dxos/react-ui-editor 0.3.11-main.42059c4 → 0.3.11-main.47875f3

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

@@ -6,12 +6,11 @@ import '@dxosTheme';
 
 import { type EditorView, keymap } from '@codemirror/view';
 import { faker } from '@faker-js/faker';
-import { Check, Trash } from '@phosphor-icons/react';
+import { Check } from '@phosphor-icons/react';
 import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
 
-import { getTextContent, TextObject } from '@dxos/echo-schema';
+import { TextObject } from '@dxos/echo-schema';
 import { PublicKey } from '@dxos/keys';
-import { log } from '@dxos/log';
 import { Button, DensityProvider } from '@dxos/react-ui';
 import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
@@ -31,10 +30,9 @@ const Editor: FC<{
   commentSelected?: string;
   commentRanges: CommentRange[];
   onCreateComment: CommentsOptions['onCreate'];
-  onDeleteComment: CommentsOptions['onDelete'];
-  onUpdateComment: CommentsOptions['onUpdate'];
+  onMoveComment: CommentsOptions['onMove'];
   onSelectComment: CommentsOptions['onSelect'];
-}> = ({ item, commentSelected, commentRanges, onCreateComment, onDeleteComment, onUpdateComment, onSelectComment }) => {
+}> = ({ item, commentSelected, commentRanges, onCreateComment, onMoveComment, onSelectComment }) => {
   const model = useTextModel({ text: item.text });
   const editorRef = useRef<EditorView>(null);
   const [selected, setSelected] = useState<string>();
@@ -58,8 +56,7 @@ const Editor: FC<{
     return [
       comments({
         onCreate: onCreateComment,
-        onDelete: onDeleteComment,
-        onUpdate: onUpdateComment,
+        onMove: onMoveComment,
         onSelect: onSelectComment,
       }),
     ];
@@ -87,7 +84,6 @@ type CommentThread = {
   yPos?: number;
   selection?: Range;
   messages: TextObject[];
-  deleted?: boolean;
 };
 
 const Thread: FC<{
@@ -96,17 +92,23 @@ const Thread: FC<{
   onSelect: () => void;
   onResolve: () => void;
 }> = ({ thread, selected, onSelect, onResolve }) => {
-  const [focus, setFocus] = useState(false);
   const [item, setItem] = useState({ text: new TextObject() });
   const model = useTextModel({ text: item.text });
   const editorRef = useRef<EditorView>(null);
 
+  // TODO(burdon): Hack to focus (view is recreated when text object changes).
+  const focus = () => {
+    setTimeout(() => {
+      editorRef.current?.focus();
+    }, 100);
+  };
+
   const containerRef = useRef<HTMLDivElement>(null);
   useEffect(() => {
     if (selected) {
       containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
       if (thread.messages.length === 0) {
-        setFocus(true);
+        focus();
       }
     }
   }, [selected]);
@@ -116,7 +118,7 @@ const Thread: FC<{
     if (text?.length) {
       thread.messages.push(item.text);
       setItem({ text: new TextObject() });
-      setFocus(true);
+      focus();
     }
   };
 
@@ -125,49 +127,41 @@ const Thread: FC<{
   }
 
   return (
-    <div
-      className={mx(
-        'flex flex-col m-1 rounded shadow divide-y bg-white',
-        selected && 'ring',
-        thread.deleted && 'opacity-50',
-      )}
-    >
-      <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
+    <div className={mx('flex flex-col m-1 rounded shadow divide-y bg-white', selected && 'ring')}>
+      <div className='flex p-2 text-xs font-mono gap-2 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>y:{thread.yPos}</span>
-        <span className='grow' />
-        {thread.deleted && <Trash />}
       </div>
 
       {thread.messages.map((message, i) => (
         // TODO(burdon): Fix default editor padding so content doesn't jump on creating message.
         <div key={i} className='p-2' onClick={() => onSelect()}>
-          {getTextContent(message)}
+          {message.text}
         </div>
       ))}
 
-      <div ref={containerRef} onClick={() => onSelect()} className='flex'>
-        <TextEditor
-          ref={editorRef}
-          autofocus={focus}
-          model={model}
-          placeholder={'Enter comment...'}
-          slots={{ root: { className: 'grow p-2 rounded-b' } }}
-          extensions={[
-            keymap.of([
-              {
-                key: 'Enter',
-                run: () => {
-                  handleCreateMessage();
-                  return true;
+      <div ref={containerRef} onClick={() => onSelect()} className='flex py-1'>
+        <div className='grow'>
+          <TextEditor
+            ref={editorRef}
+            model={model}
+            placeholder={'Enter comment...'}
+            extensions={[
+              keymap.of([
+                {
+                  key: 'Enter',
+                  run: () => {
+                    handleCreateMessage();
+                    return true;
+                  },
                 },
-              },
-            ]),
-          ]}
-        />
-        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
+              ]),
+            ]}
+          />
+        </div>
+        <Button variant='ghost' classNames='px-1 mr-1' title='Resolve' onClick={onResolve}>
           <Check />
         </Button>
       </div>
@@ -191,7 +185,7 @@ const Sidebar: FC<{
 
   return (
     <DensityProvider density='fine'>
-      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
+      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4 pr-4'>
         {sortedThreads.map((thread) => (
           <Thread
             key={thread.id}
@@ -226,7 +220,6 @@ const Story = ({ text, autoCreate }: StoryProps) => {
 
   const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
     const id = PublicKey.random().toHex();
-    log.info('create', { id: id.slice(0, 4), cursor });
     setThreads((threads) => [
       ...threads,
       {
@@ -234,7 +227,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
         range: { id, cursor },
         yPos: location ? Math.floor(location.top) : undefined,
         messages: autoCreate
-          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
+          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 2, max: 5 } })
           : [],
       },
     ]);
@@ -242,50 +235,32 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     return id;
   };
 
-  const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
-    log.info('delete', { id: id.slice(0, 4) });
+  // TODO(burdon): Scroll sidebar on select.
+  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
     setThreads((threads) =>
       threads.map((thread) => {
-        if (thread.id === id) {
-          thread.deleted = true;
+        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 };
         }
 
         return thread;
       }),
     );
 
-    setSelected((selected) => (selected === id ? undefined : selected));
+    setSelected(active ?? closest);
   };
 
-  const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
-    log.info('update', { id: id.slice(0, 4), cursor });
+  const handleMoveComment: CommentsOptions['onMove'] = (id, cursor) => {
     setThreads((threads) =>
       threads.map((thread) => {
         if (thread.id === id) {
           thread.range.cursor = cursor;
-          delete thread.deleted;
-        }
-
-        return thread;
-      }),
-    );
-  };
-
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
-    log.info('select', { active: active?.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 };
         }
-
         return thread;
       }),
     );
-
-    setSelected(active ?? closest);
   };
 
   const handleSelectThread = (id: string) => {
@@ -306,8 +281,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
             commentSelected={selected}
             commentRanges={commentRanges}
             onCreateComment={handleCreateComment}
-            onDeleteComment={handleDeleteComment}
-            onUpdateComment={handleUpdateComment}
+            onMoveComment={handleMoveComment}
             onSelectComment={handleSelectComment}
           />
         </div>
@@ -347,7 +321,7 @@ export const Default = {
   },
 };
 
-export const Testing = {
+export const Demo = {
   args: {
     text: document,
     autoCreate: true,

package/src/extensions/automerge/automerge.ts

@@ -4,37 +4,40 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { StateField, type Extension, type Transaction } from '@codemirror/state';
+import { Facet, 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, semaphoreFacet, type Value } from './defs';
+import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
 import { PatchSemaphore } from './semaphore';
 import { Cursor } from '../cursor';
 
+const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
+  combine: (values) => values.at(-1)!, // Take last.
+});
+
 export type AutomergeOptions = {
   handle: IDocHandle;
   path: Prop[];
 };
 
 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)) {
@@ -42,7 +45,6 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           clearUnreconciled = true;
         }
       }
-
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
@@ -50,15 +52,14 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           result.unreconciledTransactions.push(tr);
         }
       }
-
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(handle, stateField);
+  const semaphore = new PatchSemaphore(stateField);
 
   const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeViewPlugin implements PluginValue {
+    class AutomergeCodemirrorViewPlugin implements PluginValue {
       constructor(private readonly _view: EditorView) {
         handle.addListener('change', this._handleChange);
       }
@@ -66,9 +67,8 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
       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.
-          //  Cannot trigger update while update is in progress.
           queueMicrotask(() => {
-            this._view.state.facet(semaphoreFacet).reconcile(this._view);
+            this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
           });
         }
       }
@@ -78,7 +78,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
       }
 
       private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(this._view);
+        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
       };
     },
   );

package/src/extensions/automerge/defs.ts

@@ -1,22 +1,26 @@
 //
 // Copyright 2023 DXOS.org
-// Copyright 2024 Automerge
 // 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,
+  type TransactionSpec,
+} 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[];
 };
 
-export type UpdateHeads = {
+type UpdateHeads = {
   newHeads: Heads;
 };
 
@@ -32,12 +36,6 @@ 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) {
@@ -48,13 +46,11 @@ 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,23 +21,27 @@ 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;
+
 /**
- * Implements three-way merge (on each mutation/key-stroke).
+ * TODO(burdon): Comment.
  */
 export class PatchSemaphore {
   _inReconcile = false;
+  _queue: Array<ChangeFn> = [];
 
-  constructor(private readonly _handle: IDocHandle, private readonly _field: StateField<Value>) {}
+  constructor(private readonly _field: StateField<Value>) {}
 
-  reconcile = (view: EditorView) => {
+  reconcile = (handle: IDocHandle, 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;
 
@@ -54,18 +58,16 @@ export class PatchSemaphore {
     }
 
     // Apply the unreconciled transactions to the document.
-    let newHeads = updateAutomerge(this._field, this._handle, transactions, view.state);
+    let newHeads = updateAutomerge(this._field, 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(this._handle.docSync()!);
+      newHeads = automerge.getHeads(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(this._handle.docSync()!, oldHeads, newHeads);
+    const diff = automerge.equals(oldHeads, newHeads) ? [] : automerge.diff(handle.docSync()!, oldHeads, newHeads);
     updateCodeMirror(view, selection, path, diff);
 
     view.dispatch({