@dxos/react-ui-editor 0.3.11-main.c86e105 → 0.3.11-main.cd64fe0

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

@@ -26,7 +26,6 @@ import {
   defaultOptions,
   hr,
   image,
-  listener,
   link,
   mention,
   table,
@@ -34,6 +33,7 @@ import {
   typewriter,
   type CommentsOptions,
   type LinkOptions,
+  outliner,
 } from '../../extensions';
 import { type CommentRange, useTextModel } from '../../hooks';
 
@@ -304,17 +304,14 @@ export const Image = {
 };
 
 export const Tasklist = {
+  render: () => <Story text={str(text.tasks, '', text.list, text.footer)} extensions={[tasklist()]} />,
+};
+
+export const Outliner = {
   render: () => (
     <Story
-      text={str(text.tasks, '', text.list, text.footer)}
-      extensions={[
-        tasklist(),
-        listener({
-          onChange: (text) => {
-            console.log(text);
-          },
-        }),
-      ]}
+      text={str('# Outliner', '', 'Block', ': this is a block', ': with multiple lines', text.footer)}
+      extensions={[outliner()]}
     />
   ),
 };
@@ -384,8 +381,15 @@ export const Comments = {
   },
 };
 
+const typewriterItems = localStorage.getItem('dxos.org/plugin/markdown/typewriter')?.split(',');
+
 export const Typewriter = {
-  render: () => <Story text={str('# Typewriter', '', text.paragraphs, text.footer)} extensions={[typewriter()]} />,
+  render: () => (
+    <Story
+      text={str('# Typewriter', '', text.paragraphs, text.footer)}
+      extensions={[typewriter({ items: typewriterItems })]}
+    />
+  ),
 };
 
 export const Blast = {
@@ -393,9 +397,7 @@ export const Blast = {
     <Story
       text={str('# Blast', '', text.paragraphs, text.code, text.paragraphs)}
       extensions={[
-        typewriter({
-          items: localStorage.getItem('dxos.composer.extension.demo')?.split(','),
-        }),
+        typewriter({ items: typewriterItems }),
         blast(
           defaultsDeep(
             {

package/src/components/TextEditor/TextEditor.tsx

@@ -49,10 +49,10 @@ export type TextEditorSlots = {
 // TODO(burdon): Spellcheck?
 export type TextEditorProps = {
   model: EditorModel;
-  focus?: boolean;
-  selection?: { anchor: number; head?: number };
+  autofocus?: boolean;
   readonly?: boolean; // TODO(burdon): Move into model.
-  comments?: CommentRange[]; // TODO(burdon): Move into extension.
+  selection?: { anchor: number; head?: number };
+  comments?: CommentRange[]; // TODO(burdon): Move into extension?
   extensions?: Extension[];
   editorMode?: EditorMode;
   placeholder?: string;
@@ -65,7 +65,7 @@ export type TextEditorProps = {
  */
 export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
   (
-    { model, focus, selection, readonly, comments, extensions = [], editorMode, theme, slots = defaultSlots },
+    { model, autofocus, readonly, selection, comments, extensions = [], editorMode, theme, slots = defaultSlots },
     forwardedRef,
   ) => {
     const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
@@ -74,16 +74,16 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
     // The editor view ref should only be used as an escape hatch.
     const rootRef = useRef<HTMLDivElement>(null);
     const [view, setView] = useState<EditorView | null>(null);
+    // 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 (view && focus) {
-        view.focus();
+      if (autofocus) {
+        view?.focus();
       }
-    }, [view, focus]);
+    }, [autofocus, view]);
 
-    // TODO(burdon): Factor out as extension.
+    // TODO(burdon): Factor out as extension/hook.
     const { awareness, peer } = model;
     useEffect(() => {
       if (awareness && peer) {
@@ -95,7 +95,7 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
       }
     }, [awareness, peer, themeMode]);
 
-    // TODO(burdon): Factor out as extension.
+    // TODO(burdon): Factor out as extension/hook.
     useEffect(() => {
       if (view && comments !== undefined) {
         view.dispatch({
@@ -178,11 +178,11 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
       <div
         key={model.id}
         role='none'
-        ref={rootRef}
         tabIndex={0}
         onKeyUp={handleKeyUp}
         {...slots.root}
         {...(editorMode !== 'vim' && tabsterDOMAttribute)}
+        ref={rootRef}
       />
     );
   },
@@ -225,7 +225,7 @@ export const MarkdownEditor = forwardRef<EditorView, TextEditorProps>(
 
 export const defaultSlots: TextEditorSlots = {
   root: {
-    className: mx('p-2 overflow-y-auto', inputSurface),
+    className: mx('w-full p-2 overflow-y-auto', inputSurface),
   },
 };
 

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

@@ -6,11 +6,12 @@ import '@dxosTheme';
 
 import { type EditorView, keymap } from '@codemirror/view';
 import { faker } from '@faker-js/faker';
-import { Check } from '@phosphor-icons/react';
+import { Check, Trash } from '@phosphor-icons/react';
 import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
 
-import { TextObject } from '@dxos/echo-schema';
+import { getTextContent, 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';
@@ -30,9 +31,10 @@ const Editor: FC<{
   commentSelected?: string;
   commentRanges: CommentRange[];
   onCreateComment: CommentsOptions['onCreate'];
-  onMoveComment: CommentsOptions['onMove'];
+  onDeleteComment: CommentsOptions['onDelete'];
+  onUpdateComment: CommentsOptions['onUpdate'];
   onSelectComment: CommentsOptions['onSelect'];
-}> = ({ item, commentSelected, commentRanges, onCreateComment, onMoveComment, onSelectComment }) => {
+}> = ({ item, commentSelected, commentRanges, onCreateComment, onDeleteComment, onUpdateComment, onSelectComment }) => {
   const model = useTextModel({ text: item.text });
   const editorRef = useRef<EditorView>(null);
   const [selected, setSelected] = useState<string>();
@@ -56,7 +58,8 @@ const Editor: FC<{
     return [
       comments({
         onCreate: onCreateComment,
-        onMove: onMoveComment,
+        onDelete: onDeleteComment,
+        onUpdate: onUpdateComment,
         onSelect: onSelectComment,
       }),
     ];
@@ -84,6 +87,7 @@ type CommentThread = {
   yPos?: number;
   selection?: Range;
   messages: TextObject[];
+  deleted?: boolean;
 };
 
 const Thread: FC<{
@@ -92,23 +96,17 @@ 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) {
-        focus();
+        setFocus(true);
       }
     }
   }, [selected]);
@@ -118,7 +116,7 @@ const Thread: FC<{
     if (text?.length) {
       thread.messages.push(item.text);
       setItem({ text: new TextObject() });
-      focus();
+      setFocus(true);
     }
   };
 
@@ -127,41 +125,49 @@ const Thread: FC<{
   }
 
   return (
-    <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'>
+    <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'>
         <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()}>
-          {message.text}
+          {getTextContent(message)}
         </div>
       ))}
 
-      <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;
-                  },
+      <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>
-        <Button variant='ghost' classNames='px-1 mr-1' title='Resolve' onClick={onResolve}>
+              },
+            ]),
+          ]}
+        />
+        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
           <Check />
         </Button>
       </div>
@@ -185,7 +191,7 @@ const Sidebar: FC<{
 
   return (
     <DensityProvider density='fine'>
-      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4 pr-4'>
+      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
         {sortedThreads.map((thread) => (
           <Thread
             key={thread.id}
@@ -220,6 +226,7 @@ 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,
       {
@@ -227,7 +234,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: 2, max: 5 } })
+          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
           : [],
       },
     ]);
@@ -235,32 +242,50 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     return id;
   };
 
-  // TODO(burdon): Scroll sidebar on select.
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ active, closest, ranges }) => {
+  const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
+    log.info('delete', { id: id.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 };
+        if (thread.id === id) {
+          thread.deleted = true;
         }
 
         return thread;
       }),
     );
 
-    setSelected(active ?? closest);
+    setSelected((selected) => (selected === id ? undefined : selected));
   };
 
-  const handleMoveComment: CommentsOptions['onMove'] = (id, cursor) => {
+  const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
+    log.info('update', { id: id.slice(0, 4), 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) => {
@@ -281,7 +306,8 @@ const Story = ({ text, autoCreate }: StoryProps) => {
             commentSelected={selected}
             commentRanges={commentRanges}
             onCreateComment={handleCreateComment}
-            onMoveComment={handleMoveComment}
+            onDeleteComment={handleDeleteComment}
+            onUpdateComment={handleUpdateComment}
             onSelectComment={handleSelectComment}
           />
         </div>
@@ -321,7 +347,7 @@ export const Default = {
   },
 };
 
-export const Demo = {
+export const Testing = {
   args: {
     text: document,
     autoCreate: true,

package/src/extensions/automerge/automerge.ts

@@ -4,40 +4,37 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { Facet, StateField, type Extension, type Transaction } from '@codemirror/state';
+import { 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, type Value } from './defs';
+import { effectType, type IDocHandle, isReconcileTx, semaphoreFacet, 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)) {
@@ -45,6 +42,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           clearUnreconciled = true;
         }
       }
+
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
@@ -52,23 +50,23 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           result.unreconciledTransactions.push(tr);
         }
       }
+
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(stateField);
+  const semaphore = new PatchSemaphore(handle, stateField);
 
   const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeCodemirrorViewPlugin implements PluginValue {
+    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))) {
-          // TODO(burdon): This is a hack to ensure that the view is updated after the transaction is applied.
           queueMicrotask(() => {
-            this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
+            this._view.state.facet(semaphoreFacet).reconcile(this._view);
           });
         }
       }
@@ -78,7 +76,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
       }
 
       private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
+        this._view.state.facet(semaphoreFacet).reconcile(this._view);
       };
     },
   );

package/src/extensions/automerge/defs.ts

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

package/src/extensions/awareness.ts

@@ -251,6 +251,7 @@ class RemoteCaretWidget extends WidgetType {
   }
 }
 
+// TODO(burdon): Mixed case?
 const styles = EditorView.baseTheme({
   '.cm-collab-selection': {},
   '.cm-collab-selectionLine': {
@@ -297,7 +298,7 @@ const styles = EditorView.baseTheme({
     zIndex: 101,
     transition: 'opacity .3s ease-in-out',
     backgroundColor: 'inherit',
-    // these should be separate
+    // These should be separate.
     opacity: 0,
     transitionDelay: '0s',
     whiteSpace: 'nowrap',

package/src/extensions/code.ts

@@ -53,22 +53,20 @@ const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
 };
 
 export const code = () => {
-  const getDecorations = (view: EditorView) => {
+  const buildDecorations = (view: EditorView) => {
     const decorations: Range<Decoration>[] = [];
-    if (!view.hasFocus || view.state.readOnly) {
-      const text = view.state.doc.sliceString(0);
-      const matches = text.matchAll(CODE_REGEX);
-      const blocks = view.viewportLineBlocks;
-      for (const match of matches) {
-        const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
-        for (let i = range[0]; i <= range[1]; i++) {
-          const block = blocks[i];
-          decorations.push(
-            Decoration.line({
-              class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
-            }).range(block.from),
-          );
-        }
+    const text = view.state.doc.sliceString(0);
+    const matches = text.matchAll(CODE_REGEX);
+    const blocks = view.viewportLineBlocks;
+    for (const match of matches) {
+      const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
+      for (let i = range[0]; i <= range[1]; i++) {
+        const block = blocks[i];
+        decorations.push(
+          Decoration.line({
+            class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
+          }).range(block.from),
+        );
       }
     }
 
@@ -81,7 +79,7 @@ export const code = () => {
         hasFocus = false;
         decorations: DecorationSet;
         constructor(view: EditorView) {
-          this.decorations = getDecorations(view);
+          this.decorations = buildDecorations(view);
         }
 
         update(update: ViewUpdate) {
@@ -93,7 +91,7 @@ export const code = () => {
             update.viewportChanged
           ) {
             this.hasFocus = update.view.hasFocus;
-            this.decorations = getDecorations(update.view);
+            this.decorations = buildDecorations(update.view);
           }
         }
       },