@dxos/react-ui-editor 0.3.11-main.008b7c6 → 0.3.11-main.08776d7

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

@@ -0,0 +1,362 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { type EditorView, keymap } from '@codemirror/view';
+import { faker } from '@faker-js/faker';
+import { Check, Trash } from '@phosphor-icons/react';
+import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
+
+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';
+
+import { MarkdownEditor, TextEditor } from './TextEditor';
+import { comments, type CommentsOptions, Cursor } from '../../extensions';
+import { type Comment, type Range, useTextModel } from '../../hooks';
+
+faker.seed(101);
+
+//
+// Editor
+//
+
+const Editor: FC<{
+  item: { text: TextObject };
+  comments: Comment[];
+  selected?: string;
+  onCreateComment: CommentsOptions['onCreate'];
+  onDeleteComment: CommentsOptions['onDelete'];
+  onUpdateComment: CommentsOptions['onUpdate'];
+  onSelectComment: CommentsOptions['onSelect'];
+}> = ({
+  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 && selectedValue !== selected) {
+      const thread = commentRanges.find((range) => range.id === selectedValue);
+      if (thread) {
+        const { cursor } = thread;
+        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(selectedValue);
+    }
+  }, [selected, commentRanges, selectedValue]);
+
+  const extensions = useMemo(() => {
+    return [
+      comments({
+        onCreate: onCreateComment,
+        onDelete: onDeleteComment,
+        onUpdate: onUpdateComment,
+        onSelect: onSelectComment,
+      }),
+    ];
+  }, []);
+
+  if (!model) {
+    return null;
+  }
+
+  // TODO(burdon): Highlight currently selected comment.
+  return (
+    <div className='flex grow overflow-y-scroll'>
+      <MarkdownEditor ref={editorRef} model={model} comments={commentRanges} extensions={extensions} />
+    </div>
+  );
+};
+
+//
+// Comments thread
+//
+
+type CommentThread = {
+  id: string;
+  cursor?: string;
+  range?: Range;
+  yPos?: number;
+  messages: TextObject[];
+};
+
+const Thread: FC<{
+  thread: CommentThread;
+  selected: boolean;
+  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);
+
+  const containerRef = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    if (selected) {
+      containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
+      if (thread.messages.length === 0) {
+        setFocus(true);
+      }
+    }
+  }, [selected]);
+
+  const handleCreateMessage = () => {
+    const text = model?.text().trim();
+    if (text?.length) {
+      thread.messages.push(item.text);
+      setItem({ text: new TextObject() });
+      setFocus(true);
+    }
+  };
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div
+      className={mx(
+        'flex flex-col m-1 rounded shadow divide-y bg-white',
+        selected && 'ring',
+        !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.range?.from}</span>
+        <span>to:{thread.range?.to}</span>
+        <span>y:{thread.yPos}</span>
+        <span className='grow' />
+        {!thread.cursor && <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)}
+        </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;
+                },
+              },
+            ]),
+          ]}
+        />
+        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
+          <Check />
+        </Button>
+      </div>
+    </div>
+  );
+};
+
+const Sidebar: FC<{
+  threads: CommentThread[];
+  selected?: string;
+  onSelect: (thread: string) => void;
+  onResolve: (thread: string) => void;
+}> = ({ threads, selected, onSelect, onResolve }) => {
+  // Sort by y-position.
+  const sortedThreads = useMemo(() => {
+    const sorted = [...threads];
+    return sorted.sort(({ yPos: a = Infinity }, { yPos: b = Infinity }) => {
+      return a < b ? -1 : a > b ? 1 : 0;
+    });
+  }, [threads]);
+
+  return (
+    <DensityProvider density='fine'>
+      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
+        {sortedThreads.map((thread) => (
+          <Thread
+            key={thread.id}
+            thread={thread}
+            selected={thread.id === selected}
+            onSelect={() => onSelect(thread.id)}
+            onResolve={() => onResolve(thread.id)}
+          />
+        ))}
+      </div>
+    </DensityProvider>
+  );
+};
+
+//
+// Story container.
+//
+
+type StoryProps = {
+  text?: string;
+  autoCreate?: boolean;
+};
+
+const Story = ({ text, autoCreate }: StoryProps) => {
+  const [item] = useState({ text: new TextObject(text) });
+  const [threads, setThreads] = useState<CommentThread[]>([]);
+  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]);
+
+  const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
+    const id = PublicKey.random().toHex();
+    log.info('create', { id: id.slice(0, 4), cursor });
+    setThreads((threads) => [
+      ...threads,
+      {
+        id,
+        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);
+    return id;
+  };
+
+  const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
+    log.info('delete', { id: id.slice(0, 4) });
+    setThreads((threads) =>
+      threads.map((thread) => {
+        if (thread.id === id) {
+          thread.cursor = undefined;
+        }
+
+        return thread;
+      }),
+    );
+
+    setSelected((selected) => (selected === id ? undefined : selected));
+  };
+
+  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.cursor = cursor;
+        }
+
+        return thread;
+      }),
+    );
+  };
+
+  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 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);
+  };
+
+  const handleSelectThread = (id: string) => {
+    setSelected(id);
+  };
+
+  const handleResolveThread = (id: string) => {
+    setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
+    setSelected(undefined);
+  };
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, 'bg-neutral-100')}>
+      <div className='flex justify-center h-full gap-8'>
+        <div className='flex flex-col h-full w-[600px]'>
+          <Editor
+            item={item}
+            selected={selected}
+            comments={comments}
+            onCreateComment={handleCreateComment}
+            onDeleteComment={handleDeleteComment}
+            onUpdateComment={handleUpdateComment}
+            onSelectComment={handleSelectComment}
+          />
+        </div>
+
+        <div className='flex flex-col h-full w-[300px]'>
+          <Sidebar
+            threads={visibleThreads}
+            selected={selected}
+            onSelect={handleSelectThread}
+            onResolve={handleResolveThread}
+          />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/comments',
+  component: MarkdownEditor,
+  decorators: [withTheme],
+  render: (args: StoryProps) => <Story {...args} />,
+};
+
+const str = (...lines: string[]) => lines.join('\n');
+
+const document = str(
+  '# Comments',
+  '',
+  str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
+  '',
+);
+
+export const Default = {
+  args: {
+    text: document,
+  },
+};
+
+export const Testing = {
+  args: {
+    text: document,
+    autoCreate: true,
+  },
+};

package/src/extensions/autocomplete.ts

@@ -13,6 +13,7 @@ import {
   type CompletionContext,
   type CompletionResult,
 } from '@codemirror/autocomplete';
+import { markdownLanguage } from '@codemirror/lang-markdown';
 import { keymap } from '@codemirror/view';
 
 export type AutocompleteResult = Completion;
@@ -28,32 +29,32 @@ export const autocomplete = ({ onSearch }: AutocompleteOptions) => {
   return [
     // https://codemirror.net/docs/ref/#view.keymap
     // https://discuss.codemirror.net/t/how-can-i-replace-the-default-autocompletion-keymap-v6/3322
+    // TODO(burdon): Set custom keymap.
     keymap.of(completionKeymap),
 
     // https://codemirror.net/examples/autocompletion
     // https://codemirror.net/docs/ref/#autocomplete.autocompletion
     autocompletion({
-      // TODO(burdon): Set custom keymap.
-      // defaultKeymap: false,
+      defaultKeymap: false,
 
       // Don't start unless key press.
       activateOnTyping: false,
+    }),
 
-      // TODO(burdon): Option to create new page?
-      // TODO(burdon): Optional decoration via addToOptions
-      override: [
-        (context: CompletionContext): CompletionResult | null => {
-          const match = context.matchBefore(/\w*/);
-          if (!match || (match.from === match.to && !context.explicit)) {
-            return null;
-          }
-
-          return {
-            from: match.from,
-            options: onSearch(match.text.toLowerCase()),
-          };
-        },
-      ],
+    // TODO(burdon): Option to create new page?
+    // TODO(burdon): Optional decoration via addToOptions
+    markdownLanguage.data.of({
+      autocomplete: (context: CompletionContext): CompletionResult | null => {
+        const match = context.matchBefore(/\w*/);
+        if (!match || (match.from === match.to && !context.explicit)) {
+          return null;
+        }
+
+        return {
+          from: match.from,
+          options: onSearch(match.text.toLowerCase()),
+        };
+      },
     }),
   ];
 };

package/src/extensions/automerge/automerge.ts

@@ -4,20 +4,15 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { Facet, 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, type Value } from './defs';
 import { PatchSemaphore } from './semaphore';
-import { CursorConverter } from '../../util';
-
-const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
-  combine: (values) => values.at(-1)!, // Take last.
-});
+import { Cursor } from '../cursor';
+import { syncFacet } from '../sync';
 
 export type AutomergeOptions = {
   handle: IDocHandle;
@@ -25,19 +20,21 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  // TODO(burdon): Rename.
-  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;
       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,43 +50,14 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
           result.unreconciledTransactions.push(tr);
         }
       }
+
       return result;
     },
   });
 
-  const semaphore = new PatchSemaphore(stateField);
-
-  const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeCodemirrorViewPlugin 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);
-          });
-        }
-      }
-
-      destroy() {
-        handle.addListener('change', this._handleChange);
-      }
-
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
-      };
-    },
-  );
+  const semaphore = new PatchSemaphore(handle, stateField);
 
   return {
-    extension: [
-      CursorConverter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
+    extension: [Cursor.converter.of(cursorConverter(handle, path)), syncFacet.of(semaphore), stateField],
   };
 };

package/src/extensions/automerge/cursor.ts

@@ -8,7 +8,7 @@ import type { Prop } from '@dxos/automerge/automerge';
 import { next as automerge } from '@dxos/automerge/automerge';
 
 import { type IDocHandle } from './defs';
-import { type CursorConverter } from '../../util';
+import { type CursorConverter } from '../cursor';
 
 export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
   // TODO(burdon): Handle assoc to associate with a previous character.
@@ -26,6 +26,7 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     // NOTE: Slice is needed because getCursor mutates the array.
     return automerge.getCursor(doc, path.slice(), pos);
   },
+
   fromCursor: (cursor) => {
     if (cursor === '') {
       return 0;

package/src/extensions/automerge/defs.ts

@@ -1,41 +1,38 @@
 //
 // 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';
 
+// TODO(burdon): Rename and document.
 export type Value = {
-  lastHeads: Heads;
   path: Prop[];
+  lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
-type UpdateHeads = {
+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 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 updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
 
 export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
 
+// TODO(burdon): Remove?
+/*
 export const makeReconcile = (tr: TransactionSpec) => {
   if (tr.annotations != null) {
     if (tr.annotations instanceof Array) {
@@ -46,11 +43,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

@@ -20,28 +20,31 @@ import {
 } 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;
+import { type Syncer } from '../sync';
 
 /**
- * TODO(burdon): Comment.
+ * Implements three-way merge (on each mutation/keystroke).
  */
-export class PatchSemaphore {
-  _inReconcile = false;
-  _queue: Array<ChangeFn> = [];
+export class PatchSemaphore implements Syncer {
+  private _inReconcile = false;
 
-  constructor(private readonly _field: StateField<Value>) {}
+  // prettier-ignore
+  constructor(
+    private readonly _handle: IDocHandle,
+    // TODO(burdon): Rename.
+    private readonly _field: StateField<Value>
+  ) {}
 
-  reconcile = (handle: IDocHandle, view: EditorView) => {
+  // NOTE: Cannot destruct view.state.
+  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 +61,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()!);
+      // TODO(alexjg): this is the call that's resetting the editor state on click.
+      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({
@@ -76,5 +81,5 @@ export class PatchSemaphore {
     });
 
     this._inReconcile = false;
-  };
+  }
 }