@dxos/react-ui-editor 0.3.11-main.00a28cb → 0.3.11-main.0999ea0

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) => (
@@ -148,13 +150,13 @@ const Thread: FC<{
         </div>
       ))}
 
-      <div ref={containerRef} onClick={() => onSelect()} className='flex'>
+      <div ref={containerRef} className='flex' onClick={() => onSelect()}>
         <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/components/Toolbar/Toolbar.stories.tsx

@@ -0,0 +1,86 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import '@dxosTheme';
+
+import { faker } from '@faker-js/faker';
+import React, { type FC, useMemo, useState } from 'react';
+
+import { TextObject } from '@dxos/echo-schema';
+import { PublicKey } from '@dxos/keys';
+import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { Toolbar } from './Toolbar';
+import { code, comments, formatting, heading, image, table, tasklist, useComments } from '../../extensions';
+import { type Comment, useActionHandler, useTextEditor, useTextModel } from '../../hooks';
+import { MarkdownEditor } from '../TextEditor';
+
+faker.seed(101);
+
+const Story: FC<{ content: string }> = ({ content }) => {
+  const [item] = useState({ text: new TextObject(content) });
+  const [_comments, setComments] = useState<Comment[]>([]);
+  const [editorRef, editorView] = useTextEditor();
+  const model = useTextModel({ text: item.text });
+  const extensions = useMemo(
+    () => [
+      code(),
+      comments({
+        onCreate: (cursor) => {
+          const id = PublicKey.random().toHex();
+          setComments((comments) => [...comments, { id, cursor }]);
+          return id;
+        },
+      }),
+      formatting(),
+      heading(),
+      image(),
+      table(),
+      tasklist(),
+    ],
+    [],
+  );
+
+  useComments(editorView, _comments);
+  const handleAction = useActionHandler(editorView);
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+      <div className='flex h-full justify-center'>
+        <div className='flex flex-col h-full w-[800px]'>
+          <Toolbar onAction={handleAction} />
+          <MarkdownEditor ref={editorRef} model={model} extensions={extensions} />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/Toolbar',
+  component: Toolbar,
+  render: (args: any) => <Story {...args} />,
+  decorators: [withTheme],
+};
+
+const content = [
+  'Demo',
+  '',
+  'The editor supports **Markdown** styles.',
+  '',
+  faker.lorem.paragraph({ min: 5, max: 8 }),
+  '',
+  '',
+].join('\n');
+
+export const Default = {
+  args: {
+    content,
+  },
+};

package/src/components/Toolbar/Toolbar.tsx

@@ -0,0 +1,115 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  type Icon,
+  At,
+  Brain,
+  CaretRight,
+  ChatText,
+  Code,
+  Image,
+  Link,
+  ListBullets,
+  ListChecks,
+  ListNumbers,
+  TextStrikethrough,
+  Table,
+  TextB,
+  TextItalic,
+} from '@phosphor-icons/react';
+import React, { type FC } from 'react';
+
+import { Button, type ButtonProps, DensityProvider, Select } from '@dxos/react-ui';
+import { getSize } from '@dxos/react-ui-theme';
+
+export type Action =
+  | 'blockquote'
+  | 'bold'
+  | 'code'
+  | 'comment'
+  | 'heading'
+  | 'image'
+  | 'italic'
+  | 'link'
+  | 'list'
+  | 'list-ordered'
+  | 'list-tasks'
+  | 'mention'
+  | 'prompt'
+  | 'strikethrough'
+  | 'table';
+
+export type ToolbarProps = {
+  onAction?: (action: { type: Action; data?: any }) => void;
+};
+
+const IconButton: FC<{ Icon: Icon; title: string } & NonNullable<Pick<ButtonProps, 'onClick'>>> = ({
+  Icon,
+  title,
+  onClick,
+}) => (
+  <Button variant='ghost' classNames='p-2' onClick={onClick} title={title}>
+    <Icon className={getSize(5)} />
+  </Button>
+);
+
+// TODO(burdon): Update state based on current selection?
+export const Toolbar = ({ onAction }: ToolbarProps) => {
+  return (
+    <DensityProvider density='fine'>
+      <div role='toolbar' className='flex w-full p-2 items-center gap-4'>
+        <div>
+          <Select.Root
+            defaultValue='0'
+            onValueChange={(value) => onAction?.({ type: 'heading', data: parseInt(value) })}
+          >
+            <Select.TriggerButton classNames='w-[8rem]' />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  <Select.Option value='0'>Paragraph</Select.Option>
+                  {[1, 2, 3, 4, 5, 6].map((level) => (
+                    <Select.Option key={level} value={String(level)}>
+                      Heading {level}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </div>
+        <div>
+          <IconButton Icon={TextB} title='Bold' onClick={() => onAction?.({ type: 'bold' })} />
+          <IconButton Icon={TextItalic} title='Italic' onClick={() => onAction?.({ type: 'italic' })} />
+          <IconButton
+            Icon={TextStrikethrough}
+            title='Strike-through'
+            onClick={() => onAction?.({ type: 'strikethrough' })}
+          />
+        </div>
+        <div>
+          <IconButton Icon={ListBullets} title='Bullet list' onClick={() => onAction?.({ type: 'list' })} />
+          <IconButton Icon={ListNumbers} title='Numbered list' onClick={() => onAction?.({ type: 'list-ordered' })} />
+          <IconButton Icon={ListChecks} title='Task list' onClick={() => onAction?.({ type: 'list-tasks' })} />
+        </div>
+        <div>
+          <IconButton Icon={CaretRight} title='Block quite' onClick={() => onAction?.({ type: 'blockquote' })} />
+          <IconButton Icon={Code} title='Code block' onClick={() => onAction?.({ type: 'code' })} />
+          <IconButton Icon={Table} title='Table' onClick={() => onAction?.({ type: 'table' })} />
+        </div>
+        <div>
+          <IconButton Icon={Link} title='Link' onClick={() => onAction?.({ type: 'link' })} />
+          <IconButton Icon={At} title='Mention' onClick={() => onAction?.({ type: 'mention' })} />
+          <IconButton Icon={Image} title='Image' onClick={() => onAction?.({ type: 'image' })} />
+        </div>
+        <div className='grow' />
+        <div>
+          <IconButton Icon={Brain} title='AI prompt' onClick={() => onAction?.({ type: 'prompt' })} />
+          <IconButton Icon={ChatText} title='Create comment' onClick={() => onAction?.({ type: 'comment' })} />
+        </div>
+      </div>
+    </DensityProvider>
+  );
+};

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.spec.tsx

@@ -0,0 +1,76 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { EditorState } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+import { render, screen } from '@testing-library/react';
+import chai, { expect } from 'chai';
+import chaiDom from 'chai-dom';
+import get from 'lodash.get';
+import React, { type FC, useEffect, useRef, useState } from 'react';
+import { describe, test } from 'vitest';
+
+import { type DocHandle, Repo } from '@dxos/automerge/automerge-repo';
+
+import { automerge } from './automerge';
+
+type TestObject = {
+  text: string;
+};
+
+const path = ['text'];
+
+class Generator {
+  constructor(private readonly _handle: DocHandle<TestObject>) {}
+  update(text: string) {
+    this._handle.change((doc: TestObject) => {
+      doc.text = text;
+    });
+  }
+}
+
+const Test: FC<{ handle: DocHandle<TestObject>; generator: Generator }> = ({ handle, generator }) => {
+  const ref = useRef<HTMLDivElement>(null);
+  const [view, setView] = useState<EditorView>();
+  useEffect(() => {
+    const extensions = [
+      automerge({ handle, path }),
+      EditorView.updateListener.of((update) => {
+        if (view.state.doc.toString() === 'hello!') {
+          // Update editor.
+          update.view.dispatch({ changes: { from: view.state.doc.length - 1, insert: ' world' } });
+        }
+      }),
+    ];
+
+    const view = new EditorView({
+      state: EditorState.create({ doc: get(handle.docSync()!, path), extensions }),
+      parent: ref.current!,
+    });
+
+    setView(view);
+  }, []);
+
+  useEffect(() => {}, [view]);
+
+  return <div ref={ref} />;
+};
+
+chai.use(chaiDom);
+
+describe('Automerge', () => {
+  test('basic sync', () => {
+    const repo = new Repo({ network: [] });
+    const handle = repo.create<TestObject>();
+    const generator = new Generator(handle);
+    render(<Test handle={handle} generator={generator} />);
+    expect(screen.getByRole('textbox')).to.have.text('');
+
+    generator.update('hello!');
+    expect(screen.getByRole('textbox')).to.have.text('hello world!');
+  });
+
+  // TODO(burdon): Test history/undo.
+  // TODO(burdon): https://testing-library.com/docs/react-testing-library/example-intro/
+});

package/src/extensions/automerge/automerge.test.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { describe, test } from '@dxos/test';
+
+describe('Test', () => {
+  test('checks sanity', async () => {
+    expect(true).to.be.true;
+  });
+});

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 { invertedEffects } from '@codemirror/commands';
+import { StateField, type Extension, type StateEffect } 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 { next as A, type Prop } from '@dxos/automerge/automerge';
 
 import { cursorConverter } from './cursor';
-import { effectType, type IDocHandle, isReconcileTx, semaphoreFacet, type Value } from './defs';
+import { updateHeadsEffect, type IDocHandle, isReconcile, type State } from './defs';
 import { PatchSemaphore } from './semaphore';
 import { Cursor } from '../cursor';
 
@@ -21,23 +21,23 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  const stateField: StateField<Value> = StateField.define({
+  const syncState = 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;
       for (const effect of tr.effects) {
-        if (effect.is(effectType)) {
+        if (effect.is(updateHeadsEffect)) {
           result.lastHeads = effect.value.newHeads;
           clearUnreconciled = true;
         }
@@ -46,7 +46,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
       if (clearUnreconciled) {
         result.unreconciledTransactions = [];
       } else {
-        if (!isReconcileTx(tr)) {
+        if (!isReconcile(tr)) {
           result.unreconciledTransactions.push(tr);
         }
       }
@@ -55,38 +55,49 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
     },
   });
 
-  const semaphore = new PatchSemaphore(handle, stateField);
+  const semaphore = new PatchSemaphore(handle, syncState);
 
-  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)),
+    syncState,
+
+    // Reconcile external updates.
+    ViewPlugin.fromClass(
+      class {
+        constructor(private readonly _view: EditorView) {
+          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));
         }
+
+        _handleChange() {
+          semaphore.reconcile(this._view);
+        }
+      },
+    ),
+
+    // Reconcile local updates.
+    EditorView.updateListener.of(({ view, changes }) => {
+      if (!changes.empty) {
+        semaphore.reconcile(view);
       }
+    }),
 
-      destroy() {
-        handle.addListener('change', this._handleChange);
+    // TODO(burdon): Record undo transactions.
+    //  See https://github.com/yjs/y-codemirror.next/tree/main
+    // https://codemirror.net/examples/inverted-effect
+    invertedEffects.of((tr) => {
+      // Each change results it three transactions: insert, delete, insert.
+      const effects: StateEffect<any>[] = [];
+      if (!tr.changes.empty) {
+        tr.changes.iterChanges((fromA, toA, fromB, toB, inserted) => {
+          // effects.push(effectType.of({});
+        });
       }
 
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(this._view);
-      };
-    },
-  );
-
-  return {
-    extension: [
-      Cursor.converter.of(cursorConverter(handle, path)),
-      semaphoreFacet.of(semaphore),
-      stateField,
-      viewPlugin,
-    ],
-  };
+      return effects;
+    }),
+  ];
 };

package/src/extensions/automerge/cursor.ts

@@ -5,7 +5,7 @@
 import get from 'lodash.get';
 
 import type { Prop } from '@dxos/automerge/automerge';
-import { next as automerge } from '@dxos/automerge/automerge';
+import { next as A } from '@dxos/automerge/automerge';
 
 import { type IDocHandle } from './defs';
 import { type CursorConverter } from '../cursor';
@@ -24,7 +24,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);
+    return A.getCursor(doc, path.slice(), pos);
   },
 
   fromCursor: (cursor) => {
@@ -47,6 +47,6 @@ export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConvert
     }
 
     // NOTE: Slice is needed because getCursor mutates the array.
-    return automerge.getCursorPosition(doc, path.slice(), cursor);
+    return A.getCursorPosition(doc, path.slice(), cursor);
   },
 });