@dxos/react-ui-editor 0.3.11-main.00a28cb → 0.3.11-main.08776d7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.3.11-main.00a28cb",
+  "version": "0.3.11-main.08776d7",
   "description": "Document editing experience within a DXOS shell.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -38,20 +38,20 @@
     "y-codemirror.next": "^0.3.2",
     "y-protocols": "^1.0.5",
     "yjs": "^13.6.10",
-    "@dxos/async": "0.3.11-main.00a28cb",
-    "@dxos/context": "0.3.11-main.00a28cb",
-    "@dxos/automerge": "0.3.11-main.00a28cb",
-    "@dxos/display-name": "0.3.11-main.00a28cb",
-    "@dxos/echo-schema": "0.3.11-main.00a28cb",
-    "@dxos/invariant": "0.3.11-main.00a28cb",
-    "@dxos/debug": "0.3.11-main.00a28cb",
-    "@dxos/log": "0.3.11-main.00a28cb",
-    "@dxos/protocols": "0.3.11-main.00a28cb",
-    "@dxos/react-async": "0.3.11-main.00a28cb",
-    "@dxos/react-ui": "0.3.11-main.00a28cb",
-    "@dxos/react-ui-theme": "0.3.11-main.00a28cb",
-    "@dxos/text-model": "0.3.11-main.00a28cb",
-    "@dxos/util": "0.3.11-main.00a28cb"
+    "@dxos/async": "0.3.11-main.08776d7",
+    "@dxos/context": "0.3.11-main.08776d7",
+    "@dxos/debug": "0.3.11-main.08776d7",
+    "@dxos/automerge": "0.3.11-main.08776d7",
+    "@dxos/display-name": "0.3.11-main.08776d7",
+    "@dxos/echo-schema": "0.3.11-main.08776d7",
+    "@dxos/invariant": "0.3.11-main.08776d7",
+    "@dxos/log": "0.3.11-main.08776d7",
+    "@dxos/protocols": "0.3.11-main.08776d7",
+    "@dxos/react-async": "0.3.11-main.08776d7",
+    "@dxos/text-model": "0.3.11-main.08776d7",
+    "@dxos/react-ui": "0.3.11-main.08776d7",
+    "@dxos/react-ui-theme": "0.3.11-main.08776d7",
+    "@dxos/util": "0.3.11-main.08776d7"
   },
   "devDependencies": {
     "@automerge/automerge-repo-network-broadcastchannel": "^1.0.19",
@@ -67,19 +67,19 @@
     "deepsignal": "1.4.0-shallow.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/config": "0.3.11-main.00a28cb",
-    "@dxos/echo-signals": "0.3.11-main.00a28cb",
-    "@dxos/echo-typegen": "0.3.11-main.00a28cb",
-    "@dxos/keyboard": "0.3.11-main.00a28cb",
-    "@dxos/react-client": "0.3.11-main.00a28cb",
-    "@dxos/react-ui": "0.3.11-main.00a28cb",
-    "@dxos/storybook-utils": "0.3.11-main.00a28cb"
+    "@dxos/config": "0.3.11-main.08776d7",
+    "@dxos/echo-signals": "0.3.11-main.08776d7",
+    "@dxos/echo-typegen": "0.3.11-main.08776d7",
+    "@dxos/react-ui": "0.3.11-main.08776d7",
+    "@dxos/react-client": "0.3.11-main.08776d7",
+    "@dxos/keyboard": "0.3.11-main.08776d7",
+    "@dxos/storybook-utils": "0.3.11-main.08776d7"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.0.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/react-client": "0.3.11-main.00a28cb"
+    "@dxos/react-client": "0.3.11-main.08776d7"
   },
   "publishConfig": {
     "access": "public"

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

@@ -35,7 +35,7 @@ import {
   type LinkOptions,
   outliner,
 } from '../../extensions';
-import { type CommentRange, useTextModel } from '../../hooks';
+import { type Comment, useTextModel } from '../../hooks';
 
 // Extensions:
 // TODO(burdon): Table of contents.
@@ -347,7 +347,7 @@ export const Mention = {
 
 export const Comments = {
   render: () => {
-    const [commentRanges, setCommentRanges] = useState<CommentRange[]>([]);
+    const [commentRanges, setCommentRanges] = useState<Comment[]>([]);
 
     return (
       <Story
@@ -367,9 +367,9 @@ export const Comments = {
                 console.log(
                   'update',
                   JSON.stringify({
-                    active: state.active?.slice(0, 8),
-                    closest: state.closest?.slice(0, 8),
-                    ranges: state.ranges.length,
+                    comments: state.comments.length,
+                    active: state.selection.active?.slice(0, 8),
+                    closest: state.selection.closest?.slice(0, 8),
                   }),
                 );
               }

package/src/components/TextEditor/TextEditor.tsx

@@ -22,8 +22,8 @@ import { generateName } from '@dxos/display-name';
 import { useThemeContext } from '@dxos/react-ui';
 import { getColorForValue, inputSurface, mx } from '@dxos/react-ui-theme';
 
-import { basicBundle, markdownBundle, setCommentRange } from '../../extensions';
-import { type CommentRange, type EditorModel } from '../../hooks';
+import { basicBundle, markdownBundle, setComments, syncFacet } from '../../extensions';
+import { type Comment, type EditorModel } from '../../hooks';
 import { type ThemeStyles } from '../../styles';
 import { defaultTheme, markdownTheme, textTheme } from '../../themes';
 
@@ -41,9 +41,6 @@ export type CursorInfo = {
 
 export type TextEditorSlots = {
   root?: Omit<ComponentProps<'div'>, 'ref'>;
-  // editor?: {
-  //   className?: string;
-  // };
 };
 
 // TODO(burdon): Spellcheck?
@@ -52,7 +49,7 @@ export type TextEditorProps = {
   autofocus?: boolean;
   readonly?: boolean; // TODO(burdon): Move into model.
   selection?: { anchor: number; head?: number };
-  comments?: CommentRange[]; // TODO(burdon): Move into extension?
+  comments?: Comment[]; // TODO(burdon): Move into extension?
   extensions?: Extension[];
   editorMode?: EditorMode;
   placeholder?: string;
@@ -60,6 +57,31 @@ export type TextEditorProps = {
   slots?: TextEditorSlots;
 };
 
+// TODO(burdon): Factor out?
+export const useComments = (view?: EditorView | null, comments?: Comment[]) => {
+  useEffect(() => {
+    if (view && comments !== undefined) {
+      view.dispatch({
+        effects: setComments.of(comments),
+      });
+    }
+  }, [view, comments]);
+};
+
+// TODO(burdon): Factor out?
+export const useAwareness = ({ awareness, peer }: EditorModel) => {
+  const { themeMode } = useThemeContext();
+  useEffect(() => {
+    if (awareness && peer) {
+      awareness.setLocalStateField('user', {
+        name: peer.name ?? generateName(peer.id),
+        color: getColorForValue({ value: peer.id, type: 'color' }),
+        colorLight: getColorForValue({ value: peer.id, themeMode, type: 'highlight' }),
+      });
+    }
+  }, [awareness, peer, themeMode]);
+};
+
 /**
  * Base text editor.
  */
@@ -77,32 +99,18 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
     // NOTE: This does not cause the parent to re-render, so the ref is not available immediately.
     useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => view, [view]);
 
+    // Focus.
     useEffect(() => {
       if (autofocus) {
         view?.focus();
       }
-    }, [autofocus, view]);
+    }, [view, autofocus]);
 
     // TODO(burdon): Factor out as extension/hook.
-    const { awareness, peer } = model;
-    useEffect(() => {
-      if (awareness && peer) {
-        awareness.setLocalStateField('user', {
-          name: peer.name ?? generateName(peer.id),
-          color: getColorForValue({ value: peer.id, type: 'color' }),
-          colorLight: getColorForValue({ value: peer.id, themeMode, type: 'highlight' }),
-        });
-      }
-    }, [awareness, peer, themeMode]);
+    useAwareness(model);
 
     // TODO(burdon): Factor out as extension/hook.
-    useEffect(() => {
-      if (view && comments !== undefined) {
-        view.dispatch({
-          effects: setCommentRange.of({ model, comments }),
-        });
-      }
-    }, [view, comments]);
+    useComments(view, comments);
 
     useEffect(() => {
       if (!model || !rootRef.current) {
@@ -117,16 +125,16 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
         extensions: [
           readonly && EditorState.readOnly.of(readonly),
 
-          // TODO(burdon): Factor out VIM mode? (manage via MarkdownPlugin).
-          editorMode === 'vim' && vim(),
-
           // Theme.
           // TODO(burdon): Make theme configurable.
           EditorView.baseTheme(defaultTheme),
           EditorView.theme(theme ?? {}),
           EditorView.darkTheme.of(themeMode === 'dark'),
 
-          // Storage and replication.
+          // TODO(burdon): Factor out VIM mode? (manage via MarkdownPlugin).
+          editorMode === 'vim' && vim(),
+
+          // Storage and replication (NOTE: must come before other extensions).
           model.extension,
 
           // Custom.
@@ -143,9 +151,12 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
         state,
         // NOTE: Uncomment to spy on all transactions.
         // https://codemirror.net/docs/ref/#view.EditorView.dispatch
-        // dispatch: (transaction, view) => {
-        //   view.update([transaction]);
-        // },
+        dispatch: (transaction, view) => {
+          view.update([transaction]);
+
+          // TODO(burdon): Is there a place to register this?
+          view.state.facet(syncFacet)?.reconcile(view);
+        },
       });
 
       setView(newView);
@@ -155,18 +166,15 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
       };
     }, [rootRef, model, readonly, editorMode, themeMode]);
 
+    // TODO(burdon): Replace with keymap?
     const handleKeyUp = useCallback(
       (event: KeyboardEvent) => {
         const { key, altKey, shiftKey, metaKey, ctrlKey } = event;
         switch (key) {
-          // TODO(burdon): Is this required (for vim mode?)
-          // case 'Enter': {
-          //   view?.contentDOM.focus();
-          //   break;
-          // }
-
           case 'Escape': {
-            editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && rootRef.current?.focus();
+            if (editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey)) {
+              rootRef.current?.focus();
+            }
             break;
           }
         }

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

@@ -18,7 +18,7 @@ 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 { type Comment, type Range, useTextModel } from '../../hooks';
 
 faker.seed(101);
 
@@ -28,31 +28,39 @@ 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 [selected, setSelected] = useState<string>();
   useEffect(() => {
-    if (!editorRef.current?.hasFocus && commentSelected !== selected) {
-      const thread = commentRanges.find((range) => range.id === commentSelected);
+    if (!editorRef.current?.hasFocus && selectedValue !== selected) {
+      const thread = commentRanges.find((range) => range.id === selectedValue);
       if (thread) {
         const { cursor } = thread;
-        const range = Cursor.getRangeFromCursor(editorRef.current!.state.facet(Cursor.converter), cursor);
+        const range = cursor && Cursor.getRangeFromCursor(editorRef.current!.state, cursor);
         if (range) {
           // TODO(burdon): Scroll selection to center of screen?
           editorRef.current?.dispatch({ selection: { anchor: range.from }, scrollIntoView: true });
         }
       }
 
-      setSelected(commentSelected);
+      setSelected(selectedValue);
     }
-  }, [selected, commentRanges, commentSelected]);
+  }, [selected, commentRanges, selectedValue]);
 
   const extensions = useMemo(() => {
     return [
@@ -83,11 +91,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 +136,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) => (
@@ -218,9 +225,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,7 +239,7 @@ 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 } })
@@ -247,7 +255,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 +270,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,14 +278,14 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     );
   };
 
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
+  const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { active, closest } }) => {
     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 };
+        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;
@@ -303,8 +310,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/automerge/automerge.ts

@@ -4,16 +4,15 @@
 // 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 { 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 { 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';
+import { syncFacet } from '../sync';
 
 export type AutomergeOptions = {
   handle: IDocHandle;
@@ -21,18 +20,19 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  const stateField: StateField<Value> = StateField.define({
+  // TODO(burdon): Rename and comment.
+  const stateField = StateField.define<Value>({
     create: () => ({
+      path: path.slice(),
       lastHeads: A.getHeads(handle.docSync()!),
       unreconciledTransactions: [],
-      path: path.slice(),
     }),
 
-    update: (value: Value, tr: Transaction) => {
+    update: (value, tr) => {
       const result: Value = {
+        path: path.slice(),
         lastHeads: value.lastHeads,
         unreconciledTransactions: value.unreconciledTransactions.slice(),
-        path: path.slice(),
       };
 
       let clearUnreconciled = false;
@@ -57,36 +57,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
 
   const semaphore = new PatchSemaphore(handle, stateField);
 
-  const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeViewPlugin implements PluginValue {
-      constructor(private readonly _view: EditorView) {
-        handle.addListener('change', this._handleChange);
-      }
-
-      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.addListener('change', this._handleChange);
-      }
-
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(this._view);
-      };
-    },
-  );
-
   return {
-    extension: [
-      Cursor.converter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
+    extension: [Cursor.converter.of(cursorConverter(handle, path)), syncFacet.of(semaphore), stateField],
   };
 };

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';
-
+// TODO(burdon): Rename and document.
 export type Value = {
-  lastHeads: Heads;
   path: Prop[];
+  lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
@@ -22,21 +21,17 @@ 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 reconcileAnnotationType = Annotation.define<unknown>();
 
 export const getPath = (state: EditorState, field: StateField<Value>): Prop[] => state.field(field).path;
 
-export const reconcileAnnotationType = Annotation.define<unknown>();
+export const getLastHeads = (state: EditorState, field: StateField<Value>): Heads => state.field(field).lastHeads;
 
-export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
 
-// 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 isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
 
+// TODO(burdon): Remove?
 /*
 export const makeReconcile = (tr: TransactionSpec) => {
   if (tr.annotations != null) {

package/src/extensions/automerge/semaphore.ts

@@ -20,16 +20,23 @@ import {
 } from './defs';
 import { updateAutomerge } from './update-automerge';
 import { updateCodeMirror } from './update-codemirror';
+import { type Syncer } from '../sync';
 
 /**
- * Implements three-way merge (on each mutation/key-stroke).
+ * Implements three-way merge (on each mutation/keystroke).
  */
-export class PatchSemaphore {
-  _inReconcile = false;
+export class PatchSemaphore implements Syncer {
+  private _inReconcile = false;
 
-  constructor(private readonly _handle: IDocHandle, private readonly _field: StateField<Value>) {}
+  // prettier-ignore
+  constructor(
+    private readonly _handle: IDocHandle,
+    // TODO(burdon): Rename.
+    private readonly _field: StateField<Value>
+  ) {}
 
-  reconcile = (view: EditorView) => {
+  // NOTE: Cannot destruct view.state.
+  reconcile(view: EditorView) {
     if (this._inReconcile) {
       return;
     }
@@ -58,7 +65,7 @@ export class PatchSemaphore {
 
     // 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
+      // TODO(alexjg): this is the call that's resetting the editor state on click.
       newHeads = automerge.getHeads(this._handle.docSync()!);
     }
 
@@ -74,5 +81,5 @@ export class PatchSemaphore {
     });
 
     this._inReconcile = false;
-  };
+  }
 }