@dxos/react-ui-editor 0.3.11-main.3f845e1 → 0.3.11-main.42059c4

package/src/{hooks/automerge → components/TextEditor}/automerge.stories.tsx

@@ -2,19 +2,29 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@preact/signals-react'; // Register react integration
+import '@dxosTheme';
+
 import { BroadcastChannelNetworkAdapter } from '@automerge/automerge-repo-network-broadcastchannel';
 import { EditorView } from '@codemirror/view';
+import '@preact/signals-react'; // Register react integration
 import { basicSetup } from 'codemirror';
 import get from 'lodash.get';
 import React, { useEffect, useRef, useState } from 'react';
 
-// TODO(burdon): Why separate imports?
 import { type Prop } from '@dxos/automerge/automerge';
-import { type DocHandle, Repo } from '@dxos/automerge/automerge-repo';
+import { Repo, type DocHandle } from '@dxos/automerge/automerge-repo';
+import { Filter, setGlobalAutomergePreference } from '@dxos/echo-schema';
+import { type PublicKey } from '@dxos/keys';
+import { Expando, TextObject, useSpace } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { ClientRepeater } from '@dxos/react-client/testing';
+import { withTheme } from '@dxos/storybook-utils';
 
-import { type IDocHandle } from './handle';
-import { automergePlugin } from './plugin';
+import { MarkdownEditor } from './TextEditor';
+import { type IDocHandle, automerge, awareness } from '../../extensions';
+import { useTextModel } from '../../hooks';
+
+// TODO(burdon): Move to components.
 
 type EditorProps = {
   handle: IDocHandle;
@@ -28,7 +38,7 @@ const Editor = ({ handle, path }: EditorProps) => {
   useEffect(() => {
     const view = (editorRoot.current = new EditorView({
       doc: get(handle.docSync()!, path),
-      extensions: [basicSetup, automergePlugin(handle, path)],
+      extensions: [basicSetup, automerge({ handle, path }), awareness()],
       parent: containerRef.current as any,
     }));
 
@@ -89,3 +99,53 @@ export default {
 };
 
 export const Default = {};
+
+const EchoStory = ({ id, spaceKey }: { id: number; spaceKey: PublicKey }) => {
+  const identity = useIdentity();
+  const space = useSpace(spaceKey);
+  // TODO(dmaretskyi): useQuery doesn't work.
+  const [obj] = space?.db.query(Filter.from({ type: 'test' })).objects ?? [];
+
+  const model = useTextModel({
+    text: obj?.content,
+    identity,
+    space,
+  });
+
+  if (!model) {
+    return null;
+  }
+
+  return (
+    // <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+    <div className='flex justify-center overflow-y-scroll'>
+      <div className='flex flex-col w-[800px] py-16'>
+        <MarkdownEditor model={model} />
+        <div className='flex shrink-0 h-[300px]'></div>
+      </div>
+    </div>
+    // </div>
+  );
+};
+
+export const WithEcho = {
+  render: () => {
+    setGlobalAutomergePreference(true);
+    return (
+      <ClientRepeater
+        count={2}
+        createSpace
+        onCreateSpace={async (space) => {
+          space.db.add(
+            new Expando({
+              type: 'test',
+              content: new TextObject('Hello world!'),
+            }),
+          );
+        }}
+        Component={EchoStory}
+      />
+    );
+  },
+  decorators: [withTheme],
+};

package/src/components/TextEditor/codemirror.stories.ts

@@ -17,7 +17,8 @@ import { type Identity } from '@dxos/react-client/halo';
 import { joinCommonSpace, TestBuilder, textGenerator } from '@dxos/react-client/testing';
 import { YText } from '@dxos/text-model';
 
-import { cursorColor, SpaceAwarenessProvider } from '../../hooks';
+import { YAwarenessProvider } from '../../hooks';
+import { cursorColor } from '../../styles';
 import { EditorDocument, types as schema } from '../../testing';
 
 export default {
@@ -35,7 +36,7 @@ const updateEditor = async (id: number, editor: HTMLDivElement, identity: Identi
     return;
   }
 
-  const { awareness } = new SpaceAwarenessProvider({ space, doc, channel: `yjs.awareness.${text.id}` });
+  const { awareness } = new YAwarenessProvider({ space, doc, channel: `yjs.awareness.${text.id}` });
   awareness.setLocalStateField('user', {
     name: identity.profile?.displayName ?? generateName(identity.identityKey.toHex()),
     // TODO(wittjosiah): Pick colours from theme based on identity key.

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

@@ -0,0 +1,355 @@
+//
+// 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 CommentRange, type Range, useTextModel } from '../../hooks';
+
+faker.seed(101);
+
+//
+// Editor
+//
+
+const Editor: FC<{
+  item: { text: TextObject };
+  commentSelected?: string;
+  commentRanges: CommentRange[];
+  onCreateComment: CommentsOptions['onCreate'];
+  onDeleteComment: CommentsOptions['onDelete'];
+  onUpdateComment: CommentsOptions['onUpdate'];
+  onSelectComment: CommentsOptions['onSelect'];
+}> = ({ item, commentSelected, 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 && 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 });
+        }
+      }
+
+      setSelected(commentSelected);
+    }
+  }, [selected, commentRanges, commentSelected]);
+
+  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;
+  range: CommentRange;
+  yPos?: number;
+  selection?: Range;
+  messages: TextObject[];
+  deleted?: boolean;
+};
+
+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.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()}>
+          {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 commentRanges = useMemo(() => threads.map((thread) => thread.range), [threads]);
+  const [selected, setSelected] = useState<string>();
+
+  // 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,
+        range: { 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.deleted = true;
+        }
+
+        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.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) => {
+    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}
+            commentSelected={selected}
+            commentRanges={commentRanges}
+            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/components/TextEditor/index.ts

@@ -5,7 +5,4 @@
 export { tags } from '@lezer/highlight';
 export { type Extension } from '@codemirror/state';
 
-export * from './extensions';
-export * from './themes';
-
 export * from './TextEditor';

package/src/{hooks/yjs → components/TextEditor}/yjs.stories.tsx

@@ -12,7 +12,7 @@ import { ClientRepeater, textGenerator, useDataGenerator } from '@dxos/react-cli
 import { useId, Input } from '@dxos/react-ui';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { MarkdownEditor } from '../../components';
+import { MarkdownEditor } from './TextEditor';
 import { Replicator, useYjsModel } from '../../testing';
 
 export default {

package/src/{components/TextEditor/extensions → 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

@@ -0,0 +1,94 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// 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 { next as A } from '@dxos/automerge/automerge';
+import { type Prop } from '@dxos/automerge/automerge';
+
+import { cursorConverter } from './cursor';
+import { effectType, type IDocHandle, isReconcileTx, semaphoreFacet, type Value } from './defs';
+import { PatchSemaphore } from './semaphore';
+import { Cursor } from '../cursor';
+
+export type AutomergeOptions = {
+  handle: IDocHandle;
+  path: Prop[];
+};
+
+export const automerge = ({ handle, path }: AutomergeOptions): Extension => {
+  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)) {
+          result.lastHeads = effect.value.newHeads;
+          clearUnreconciled = true;
+        }
+      }
+
+      if (clearUnreconciled) {
+        result.unreconciledTransactions = [];
+      } else {
+        if (!isReconcileTx(tr)) {
+          result.unreconciledTransactions.push(tr);
+        }
+      }
+
+      return result;
+    },
+  });
+
+  const semaphore = new PatchSemaphore(handle, stateField);
+
+  const viewPlugin = ViewPlugin.fromClass(
+    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.
+          //  Cannot trigger update while update is in progress.
+          queueMicrotask(() => {
+            this._view.state.facet(semaphoreFacet).reconcile(this._view);
+          });
+        }
+      }
+
+      destroy() {
+        handle.addListener('change', this._handleChange);
+      }
+
+      private _handleChange = () => {
+        this._view.state.facet(semaphoreFacet).reconcile(this._view);
+      };
+    },
+  );
+
+  return {
+    extension: [
+      Cursor.converter.of(cursorConverter(handle, path)),
+      semaphoreFacet.of(semaphore),
+      stateField,
+      viewPlugin,
+    ],
+  };
+};

package/src/extensions/automerge/cursor.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import get from 'lodash.get';
+
+import type { Prop } from '@dxos/automerge/automerge';
+import { next as automerge } from '@dxos/automerge/automerge';
+
+import { type IDocHandle } from './defs';
+import { type CursorConverter } from '../cursor';
+
+export const cursorConverter = (handle: IDocHandle, path: Prop[]): CursorConverter => ({
+  // TODO(burdon): Handle assoc to associate with a previous character.
+  toCursor: (pos) => {
+    const doc = handle.docSync();
+    if (!doc) {
+      return '';
+    }
+
+    const value = get(doc, path);
+    if (typeof value === 'string' && value.length <= pos) {
+      return 'end';
+    }
+
+    // NOTE: Slice is needed because getCursor mutates the array.
+    return automerge.getCursor(doc, path.slice(), pos);
+  },
+
+  fromCursor: (cursor) => {
+    if (cursor === '') {
+      return 0;
+    }
+
+    const doc = handle.docSync();
+    if (!doc) {
+      return 0;
+    }
+
+    if (cursor === 'end') {
+      const value = get(doc, path);
+      if (typeof value === 'string') {
+        return value.length;
+      } else {
+        return 0;
+      }
+    }
+
+    // NOTE: Slice is needed because getCursor mutates the array.
+    return automerge.getCursorPosition(doc, path.slice(), cursor);
+  },
+});