@dxos/react-ui-editor 0.3.11-main.c95bc86 → 0.3.11-main.cb8120f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.3.11-main.c95bc86",
+  "version": "0.3.11-main.cb8120f",
   "description": "Document editing experience within a DXOS shell.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -35,53 +35,65 @@
     "lodash.pick": "^4.4.0",
     "lodash.sortby": "^4.7.0",
     "style-mod": "^4.1.0",
-    "@dxos/async": "0.3.11-main.c95bc86",
-    "@dxos/automerge": "0.3.11-main.c95bc86",
-    "@dxos/context": "0.3.11-main.c95bc86",
-    "@dxos/debug": "0.3.11-main.c95bc86",
-    "@dxos/display-name": "0.3.11-main.c95bc86",
-    "@dxos/log": "0.3.11-main.c95bc86",
-    "@dxos/echo-schema": "0.3.11-main.c95bc86",
-    "@dxos/invariant": "0.3.11-main.c95bc86",
-    "@dxos/react-async": "0.3.11-main.c95bc86",
-    "@dxos/react-ui": "0.3.11-main.c95bc86",
-    "@dxos/react-ui-theme": "0.3.11-main.c95bc86",
-    "@dxos/util": "0.3.11-main.c95bc86",
-    "@dxos/protocols": "0.3.11-main.c95bc86",
-    "@dxos/text-model": "0.3.11-main.c95bc86"
+    "@dxos/async": "0.3.11-main.cb8120f",
+    "@dxos/context": "0.3.11-main.cb8120f",
+    "@dxos/automerge": "0.3.11-main.cb8120f",
+    "@dxos/display-name": "0.3.11-main.cb8120f",
+    "@dxos/invariant": "0.3.11-main.cb8120f",
+    "@dxos/echo-schema": "0.3.11-main.cb8120f",
+    "@dxos/debug": "0.3.11-main.cb8120f",
+    "@dxos/log": "0.3.11-main.cb8120f",
+    "@dxos/protocols": "0.3.11-main.cb8120f",
+    "@dxos/react-async": "0.3.11-main.cb8120f",
+    "@dxos/react-ui": "0.3.11-main.cb8120f",
+    "@dxos/util": "0.3.11-main.cb8120f",
+    "@dxos/text-model": "0.3.11-main.cb8120f",
+    "@dxos/react-ui-theme": "0.3.11-main.cb8120f"
   },
   "devDependencies": {
     "@automerge/automerge-repo-network-broadcastchannel": "^1.1.0",
     "@faker-js/faker": "^8.3.1",
     "@phosphor-icons/react": "^2.0.5",
     "@preact/signals-react": "^1.3.6",
+    "@testing-library/dom": "^8.17.1",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^14.4.3",
     "@types/lodash.defaultsdeep": "^4.6.6",
     "@types/lodash.get": "^4.4.7",
     "@types/lodash.pick": "^4.4.7",
     "@types/lodash.sortby": "^4.7.7",
     "@types/react": "^18.0.21",
     "@types/react-dom": "^18.0.6",
+    "@types/react-test-renderer": "^17.0.2",
+    "@vitest/ui": "^1.2.1",
     "deepsignal": "1.4.0-shallow.0",
+    "happy-dom": "^13.3.1",
+    "jsdom": "^20.0.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/echo-typegen": "0.3.11-main.c95bc86",
-    "@dxos/config": "0.3.11-main.c95bc86",
-    "@dxos/keyboard": "0.3.11-main.c95bc86",
-    "@dxos/echo-signals": "0.3.11-main.c95bc86",
-    "@dxos/react-ui": "0.3.11-main.c95bc86",
-    "@dxos/react-client": "0.3.11-main.c95bc86",
-    "@dxos/storybook-utils": "0.3.11-main.c95bc86"
+    "react-test-renderer": "^18.2.0",
+    "vite": "^5.0.12",
+    "vite-plugin-top-level-await": "^1.4.1",
+    "vite-plugin-wasm": "^3.3.0",
+    "vitest": "^1.2.1",
+    "@dxos/config": "0.3.11-main.cb8120f",
+    "@dxos/echo-signals": "0.3.11-main.cb8120f",
+    "@dxos/echo-typegen": "0.3.11-main.cb8120f",
+    "@dxos/keyboard": "0.3.11-main.cb8120f",
+    "@dxos/react-ui": "0.3.11-main.cb8120f",
+    "@dxos/react-client": "0.3.11-main.cb8120f",
+    "@dxos/storybook-utils": "0.3.11-main.cb8120f"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.0.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@dxos/react-client": "0.3.11-main.c95bc86"
+    "@dxos/react-client": "0.3.11-main.cb8120f"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "test": "true"
+    "vitest": "vitest --ui --dir ./src/extensions/automerge"
   }
 }

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

@@ -19,11 +19,14 @@ import { withTheme } from '@dxos/storybook-utils';
 
 import { MarkdownEditor, type TextEditorProps } from './TextEditor';
 import {
+  type CommentsOptions,
+  type LinkOptions,
   autocomplete,
   blast,
   code,
   comments,
   defaultOptions,
+  heading,
   hr,
   image,
   link,
@@ -31,17 +34,11 @@ import {
   table,
   tasklist,
   typewriter,
-  type CommentsOptions,
-  type LinkOptions,
   useComments,
-  heading,
+  formatting,
 } from '../../extensions';
 import { type Comment, useTextModel } from '../../hooks';
 
-// Extensions:
-// TODO(burdon): Table of contents.
-// TODO(burdon): Front-matter
-
 faker.seed(101);
 
 const str = (...lines: string[]) => lines.join('\n');
@@ -249,13 +246,11 @@ const defaults = [
     onSearch: (text) => links.filter(({ label }) => label.toLowerCase().includes(text.toLowerCase())),
   }),
   code(),
+  formatting(),
   heading(),
   hr(),
   image(),
   link({ onRender: onRenderLink, onHover: onHoverLinkTooltip }),
-  // mention({
-  //   onSearch: (text) => names.filter((name) => name.toLowerCase().startsWith(text.toLowerCase())),
-  // }),
   table(),
   tasklist(),
 ];
@@ -347,18 +342,18 @@ export const Mention = {
 
 export const Comments = {
   render: () => {
-    const [commentRanges, setCommentRanges] = useState<Comment[]>([]);
+    const [_comments, setComments] = useState<Comment[]>([]);
 
     return (
       <Story
         text={str('# Comments', '', text.paragraphs, text.footer)}
-        comments={commentRanges}
+        comments={_comments}
         extensions={[
           comments({
             onHover: onCommentsHover,
             onCreate: (range) => {
               const id = PublicKey.random().toHex();
-              setCommentRanges((commentRanges) => [...commentRanges, { id, cursor: range }]);
+              setComments((commentRanges) => [...commentRanges, { id, cursor: range }]);
               return id;
             },
             onSelect: (state) => {

package/src/components/TextEditor/TextEditor.tsx

@@ -21,6 +21,7 @@ import React, {
 import { log } from '@dxos/log';
 import { useThemeContext } from '@dxos/react-ui';
 import { attentionSurface, mx } from '@dxos/react-ui-theme';
+import { nonNullable } from '@dxos/util';
 
 import { basicBundle, markdownBundle } from '../../extensions';
 import { type EditorModel } from '../../hooks';
@@ -132,6 +133,7 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
           EditorView.contentAttributes.of({ class: slots.content?.className ?? '' }),
 
           // State.
+          EditorView.editable.of(!readonly),
           EditorState.readOnly.of(!!readonly),
 
           // Storage and replication.
@@ -143,7 +145,7 @@ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
 
           // Custom.
           ...extensions,
-        ].filter(Boolean) as Extension[],
+        ].filter(nonNullable) as Extension[], // TODO(burdon): ???
       });
 
       //

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/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 } 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 { invariant } from '@dxos/invariant';
+import { next as A, type Prop } from '@dxos/automerge/automerge';
 
 import { cursorConverter } from './cursor';
-import { effectType, type IDocHandle, isReconcileTx, type State } from './defs';
+import { updateHeadsEffect, type IDocHandle, isReconcile, type State } from './defs';
 import { PatchSemaphore } from './semaphore';
 import { Cursor } from '../cursor';
 
@@ -21,7 +21,7 @@ export type AutomergeOptions = {
 };
 
 export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
-  const state = StateField.define<State>({
+  const syncState = StateField.define<State>({
     create: () => ({
       path: path.slice(),
       lastHeads: A.getHeads(handle.docSync()!),
@@ -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,15 +55,16 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
     },
   });
 
-  const semaphore = new PatchSemaphore(handle, state);
+  const semaphore = new PatchSemaphore(handle, syncState);
 
   return [
     Cursor.converter.of(cursorConverter(handle, path)),
+    syncState,
+
     // Reconcile external updates.
     ViewPlugin.fromClass(
       class {
         constructor(private readonly _view: EditorView) {
-          invariant(this._view);
           handle.addListener('change', this._handleChange.bind(this));
         }
 
@@ -76,13 +77,27 @@ export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
         }
       },
     ),
+
     // Reconcile local updates.
     EditorView.updateListener.of(({ view, changes }) => {
       if (!changes.empty) {
-        // TODO(burdon): Loses cursor position if auto closing brackets. Call explicitly?
         semaphore.reconcile(view);
       }
     }),
-    state,
+
+    // 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,28 +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.
 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 updateHeadsEffect = StateEffect.define<UpdateHeads>({});
 
-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 const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
 
-export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
+export const reconcileAnnotation = Annotation.define<boolean>();
 
-export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
+export const isReconcile = (tr: Transaction): boolean => {
+  return !!tr.annotation(reconcileAnnotation);
+};
 
 export type IDocHandle<T = any> = {
   docSync(): Doc<T> | undefined;