@dxos/react-ui-editor 0.3.11-main.08776d7 → 0.3.11-main.0999ea0

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

@@ -17,7 +17,7 @@ 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 { comments, type CommentsOptions, setFocus, useComments } from '../../extensions';
 import { type Comment, type Range, useTextModel } from '../../hooks';
 
 faker.seed(101);
@@ -44,24 +44,19 @@ const Editor: FC<{
   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 && 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 });
-        }
-      }
-
+    if (!view.current?.hasFocus && selectedValue !== selected) {
       setSelected(selectedValue);
+      if (selectedValue) {
+        setFocus(view.current!, selectedValue);
+      }
     }
   }, [selected, commentRanges, selectedValue]);
 
+  useComments(view.current, commentRanges);
+
   const extensions = useMemo(() => {
     return [
       comments({
@@ -80,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>
   );
 };
@@ -155,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([
               {
@@ -246,7 +241,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
           : [],
       },
     ]);
-    setSelected(id);
+    setSelected(id); // TODO(burdon): Not required.
     return id;
   };
 
@@ -278,8 +273,8 @@ const Story = ({ text, autoCreate }: StoryProps) => {
     );
   };
 
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { active, closest } }) => {
-    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 comment = comments.find(({ comment }) => comment.id === thread.id);
@@ -292,7 +287,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
       }),
     );
 
-    setSelected(active ?? closest);
+    setSelected(current ?? closest);
   };
 
   const handleSelectThread = (id: string) => {

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,15 +4,16 @@
 // Ref: https://github.com/automerge/automerge-codemirror
 //
 
-import { StateField, type Extension } from '@codemirror/state';
+import { invertedEffects } from '@codemirror/commands';
+import { StateField, type Extension, type StateEffect } from '@codemirror/state';
+import { EditorView, ViewPlugin } from '@codemirror/view';
 
-import { type Prop, next as A } from '@dxos/automerge/automerge';
+import { next as A, type Prop } from '@dxos/automerge/automerge';
 
 import { cursorConverter } from './cursor';
-import { effectType, type IDocHandle, isReconcileTx, type Value } from './defs';
+import { updateHeadsEffect, type IDocHandle, isReconcile, type State } from './defs';
 import { PatchSemaphore } from './semaphore';
 import { Cursor } from '../cursor';
-import { syncFacet } from '../sync';
 
 export type AutomergeOptions = {
   handle: IDocHandle;
@@ -20,8 +21,7 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  // TODO(burdon): Rename and comment.
-  const stateField = StateField.define<Value>({
+  const syncState = StateField.define<State>({
     create: () => ({
       path: path.slice(),
       lastHeads: A.getHeads(handle.docSync()!),
@@ -29,7 +29,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
     }),
 
     update: (value, tr) => {
-      const result: Value = {
+      const result: State = {
         path: path.slice(),
         lastHeads: value.lastHeads,
         unreconciledTransactions: value.unreconciledTransactions.slice(),
@@ -37,7 +37,7 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
 
       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,9 +55,49 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
     },
   });
 
-  const semaphore = new PatchSemaphore(handle, stateField);
+  const semaphore = new PatchSemaphore(handle, syncState);
 
-  return {
-    extension: [Cursor.converter.of(cursorConverter(handle, path)), syncFacet.of(semaphore), stateField],
-  };
+  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));
+        }
+
+        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);
+      }
+    }),
+
+    // 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({});
+        });
+      }
+
+      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);
   },
 });

package/src/extensions/automerge/defs.ts

@@ -8,48 +8,28 @@ import { Annotation, StateEffect, type StateField, type EditorState, type Transa
 
 import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
 
-// TODO(burdon): Rename and document.
-export type Value = {
+export type State = {
   path: Prop[];
   lastHeads: Heads;
   unreconciledTransactions: Transaction[];
 };
 
+export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
+export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
+
 export type UpdateHeads = {
   newHeads: Heads;
 };
 
-export const effectType = StateEffect.define<UpdateHeads>({});
-
-export const reconcileAnnotationType = Annotation.define<unknown>();
-
-export const getPath = (state: EditorState, field: StateField<Value>): Prop[] => state.field(field).path;
-
-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 updateHeadsEffect = StateEffect.define<UpdateHeads>({});
 
-export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
 
-// TODO(burdon): Remove?
-/*
-export const makeReconcile = (tr: TransactionSpec) => {
-  if (tr.annotations != null) {
-    if (tr.annotations instanceof Array) {
-      tr.annotations = [...tr.annotations, reconcileAnnotationType.of({})];
-    } else {
-      tr.annotations = [tr.annotations, reconcileAnnotationType.of({})];
-    }
-  } else {
-    tr.annotations = [reconcileAnnotationType.of({})];
-  }
+export const reconcileAnnotation = Annotation.define<boolean>();
 
-  // return {
-  //   ...tr,
-  //   annotations: reconcileAnnotationType.of({})
-  // }
+export const isReconcile = (tr: Transaction): boolean => {
+  return !!tr.annotation(reconcileAnnotation);
 };
-*/
 
 export type IDocHandle<T = any> = {
   docSync(): Doc<T> | undefined;