@dxos/react-ui-editor 0.3.11-main.514e6e4 → 0.3.11-main.525300b

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

@@ -13,7 +13,7 @@ import React, { useEffect, useRef, useState } from 'react';
 
 import { type Prop } from '@dxos/automerge/automerge';
 import { Repo, type DocHandle } from '@dxos/automerge/automerge-repo';
-import { Filter, setGlobalAutomergePreference } from '@dxos/echo-schema';
+import { Filter } 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';
@@ -130,7 +130,6 @@ const EchoStory = ({ id, spaceKey }: { id: number; spaceKey: PublicKey }) => {
 
 export const WithEcho = {
   render: () => {
-    setGlobalAutomergePreference(true);
     return (
       <ClientRepeater
         count={2}

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

@@ -0,0 +1,111 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import '@dxosTheme';
+
+import React from 'react';
+
+import { useThemeContext } from '@dxos/react-ui';
+import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
+import { withTheme } from '@dxos/storybook-utils';
+
+import { TextEditor } from './TextEditor';
+import {
+  code,
+  createMarkdownExtensions,
+  formatting,
+  heading,
+  hr,
+  image,
+  link,
+  table,
+  tasklist,
+  useFormattingState,
+} from '../../extensions';
+import { createDataExtensions, createThemeExtensions, useActionHandler, useTextEditor } from '../../hooks';
+import { markdownTheme } from '../../themes';
+import { Toolbar } from '../Toolbar';
+
+// TODO(burdon): Demo toolbar with hooks.
+// TODO(burdon): Build components from hooks and adapters for model/extensions, etc.
+// TODO(burdon): Remove BaseTextEditor.
+// TODO(burdon): Move scrolling container layout/logic into TextEditor/MarkdownEditor components.
+// TODO(burdon): Define keymap in composer framework format.
+
+type StoryProps = {
+  autoFocus?: boolean;
+  placeholder?: string;
+  doc?: string;
+  readonly?: boolean;
+};
+
+const Story = ({ autoFocus, placeholder, doc, readonly }: StoryProps) => {
+  const { themeMode } = useThemeContext();
+  const [formattingState, trackFormatting] = useFormattingState();
+  const { parentRef, view } = useTextEditor({
+    autoFocus,
+    doc,
+    extensions: [
+      //
+      createDataExtensions({ readonly }),
+      createThemeExtensions({
+        themeMode,
+        theme: markdownTheme,
+        slots: {
+          // TODO(burdon): Document classes re base theme.
+          //  Semantic tokens (e.g., replacement of input surface).
+          editor: {
+            className: 'h-full p-4 bg-white text-black dark:bg-black dark:text-white',
+          },
+        },
+      }),
+      // TODO(burdon): Move lineWrapping.
+      createMarkdownExtensions({ placeholder, lineWrapping: true }),
+      // TODO(burdon): Move into markdown bundle (with React callbacks).
+      code(),
+      formatting(),
+      heading(),
+      hr(),
+      image(),
+      link(),
+      table(),
+      tasklist(),
+      trackFormatting,
+    ],
+  });
+
+  const handleAction = useActionHandler(view);
+
+  // FIXME This doesn't update the state on view changes. Also not
+  // sure if view is even guaranteed to exist at this point.
+  return (
+    <div className={mx(fixedInsetFlexLayout, groupSurface)}>
+      <div className='flex h-full justify-center'>
+        <div className='flex flex-col h-full w-[800px]'>
+          <Toolbar.Root onAction={handleAction} state={formattingState}>
+            <Toolbar.Markdown />
+          </Toolbar.Root>
+
+          {/* TODO(burdon): Handle scrolling in component wrapper (like this). */}
+          <div role='none' className='h-full overflow-y-auto' ref={parentRef} />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'react-ui-editor/useTextEditor',
+  component: TextEditor,
+  decorators: [withTheme],
+  render: (args: StoryProps) => <Story {...args} />,
+};
+
+export const Default = {
+  args: {
+    autoFocus: true,
+    placeholder: 'Text...',
+    doc: '# Demo\n\nThis is a document.\n\n',
+  },
+};

package/src/components/Toolbar/Toolbar.stories.tsx

@@ -0,0 +1,102 @@
+//
+// 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,
+  useFormattingState,
+} from '../../extensions';
+import { type Comment, useActionHandler, useEditorView, 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] = useEditorView();
+  const model = useTextModel({ text: item.text });
+  const [formattingState, formattingObserver] = useFormattingState();
+  const extensions = useMemo(
+    () => [
+      code(),
+      comments({
+        onCreate: ({ cursor }) => {
+          const id = PublicKey.random().toHex();
+          setComments((comments) => [...comments, { id, cursor }]);
+          return id;
+        },
+      }),
+      formatting(),
+      heading(),
+      image(),
+      table(),
+      tasklist(),
+      formattingObserver,
+    ],
+    [],
+  );
+
+  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.Root onAction={handleAction} state={formattingState}>
+            <Toolbar.Markdown />
+            <Toolbar.Separator />
+            <Toolbar.Extended />
+          </Toolbar.Root>
+          <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,245 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  type Icon,
+  CaretRight,
+  ChatText,
+  Code,
+  Link,
+  ListBullets,
+  ListChecks,
+  ListNumbers,
+  Paragraph,
+  TextStrikethrough,
+  Table,
+  TextB,
+  TextItalic,
+} from '@phosphor-icons/react';
+import { createContext } from '@radix-ui/react-context';
+import React, { type PropsWithChildren } from 'react';
+
+import { Button, type ButtonProps, DensityProvider, Select } from '@dxos/react-ui';
+import { getSize, mx } from '@dxos/react-ui-theme';
+
+import { type Formatting } from '../../extensions';
+
+// TODO(burdon): Revert to string to make extensible?
+export type ActionType =
+  | 'blockquote'
+  | 'strong'
+  | 'codeblock'
+  | 'comment'
+  | 'heading'
+  | 'image'
+  | 'emphasis'
+  | 'code'
+  | 'link'
+  | 'list-bullet'
+  | 'list-ordered'
+  | 'list-tasks'
+  | 'mention'
+  | 'prompt'
+  | 'strikethrough'
+  | 'table';
+
+export type Action = {
+  type: ActionType;
+  data?: any;
+};
+
+export type ToolbarProps = PropsWithChildren<{
+  state: Formatting | null;
+  onAction?: (action: Action) => void;
+}>;
+
+const [ToolbarContextProvider, useToolbarContext] = createContext<ToolbarProps>('Toolbar');
+
+const ToolbarRoot = ({ children, onAction, state }: ToolbarProps) => {
+  return (
+    <ToolbarContextProvider onAction={onAction} state={state}>
+      <DensityProvider density='fine'>
+        <div role='toolbar' className='flex w-full shrink-0 p-1 gap-2 items-center whitespace-nowrap overflow-hidden'>
+          {children}
+        </div>
+      </DensityProvider>
+    </ToolbarContextProvider>
+  );
+};
+
+type ToolbarButtonProps = {
+  Icon: Icon;
+  disable?: (state: Formatting) => boolean;
+  getState?: (state: Formatting) => boolean;
+  onClick: (state: Formatting | null) => Action | undefined;
+} & NonNullable<Pick<ButtonProps, 'title'>>;
+
+const ToolbarButton = ({ Icon, onClick, title, getState, disable }: ToolbarButtonProps) => {
+  const { onAction, state } = useToolbarContext('ToolbarButton');
+  const active = getState && state ? getState(state) : false;
+  const disabled = disable && state ? disable(state) : false;
+
+  const handleClick = (event: React.MouseEvent) => {
+    const action = onClick(state);
+    if (action) {
+      onAction?.(action);
+      event.preventDefault();
+    }
+  };
+
+  return (
+    <Button
+      variant='ghost'
+      classNames={mx('p-2', active && 'ring-[1px]')}
+      onMouseDown={handleClick}
+      title={title}
+      disabled={disabled}
+    >
+      <Icon className={getSize(5)} />
+    </Button>
+  );
+};
+
+const ToolbarSeparator = () => <div className='grow' />;
+
+const MarkdownHeading = () => {
+  const { onAction, state } = useToolbarContext('MarkdownFormatting');
+  const blockType = state ? state.blockType : 'paragraph';
+  const header = blockType && /heading(\d)/.exec(blockType);
+  const value = header ? header[1] : blockType === 'paragraph' || !blockType ? '0' : null;
+  return (
+    <Select.Root
+      disabled={value === null}
+      value={value ?? '0'}
+      onValueChange={(value) => onAction?.({ type: 'heading', data: parseInt(value) })}
+    >
+      <Select.TriggerButton>
+        <Paragraph className={getSize(5)} />
+      </Select.TriggerButton>
+      <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>
+  );
+};
+
+const MarkdownStyles = () => (
+  <div role='none'>
+    <ToolbarButton
+      Icon={TextB}
+      title='String'
+      disable={(s) => s.blockType === 'codeblock'}
+      getState={(s) => s.strong}
+      onClick={(s) => ({ type: 'strong', data: s ? !s.strong : null })}
+    />
+    <ToolbarButton
+      Icon={TextItalic}
+      title='Emphasis'
+      disable={(s) => s.blockType === 'codeblock'}
+      getState={(s) => s.emphasis}
+      onClick={(s) => ({ type: 'emphasis', data: s ? !s.emphasis : null })}
+    />
+    <ToolbarButton
+      Icon={TextStrikethrough}
+      title='Strike-through'
+      disable={(s) => s.blockType === 'codeblock'}
+      getState={(s) => s.strikethrough}
+      onClick={(s) => ({ type: 'strikethrough', data: s ? !s.strikethrough : null })}
+    />
+    <ToolbarButton
+      Icon={Code}
+      title='Inline code'
+      disable={(s) => s.blockType === 'codeblock'}
+      getState={(s) => s.code}
+      onClick={(s) => ({ type: 'code', data: s ? !s.code : null })}
+    />
+  </div>
+);
+
+const MarkdownLists = () => (
+  <div role='none'>
+    <ToolbarButton
+      Icon={ListBullets}
+      title='Bullet list'
+      getState={(s) => s.listStyle === 'bullet'}
+      onClick={(s) => ({ type: 'list-bullet', data: s ? s.listStyle !== 'bullet' : null })}
+    />
+    <ToolbarButton
+      Icon={ListNumbers}
+      title='Numbered list'
+      getState={(s) => s.listStyle === 'ordered'}
+      onClick={(s) => ({ type: 'list-ordered', data: s ? s.listStyle !== 'ordered' : null })}
+    />
+    <ToolbarButton
+      Icon={ListChecks}
+      title='Task list'
+      getState={(s) => s.listStyle === 'task'}
+      onClick={(s) => ({ type: 'list-tasks', data: s ? s.listStyle !== 'task' : null })}
+    />
+  </div>
+);
+
+const MarkdownBlocks = () => (
+  <div role='none'>
+    <ToolbarButton
+      Icon={CaretRight}
+      title='Block quote'
+      getState={(s) => s.blockquote}
+      onClick={(s) => ({ type: 'blockquote', data: s ? !s.blockquote : null })}
+    />
+    <ToolbarButton
+      Icon={Code}
+      title='Code block'
+      getState={(s) => s.blockType === 'codeblock'}
+      onClick={(s) => ({ type: 'codeblock', data: s ? s.blockType !== 'codeblock' : null })}
+    />
+    <ToolbarButton Icon={Table} title='Table' onClick={() => ({ type: 'table' })} />
+  </div>
+);
+
+const MarkdownLinks = () => (
+  <div role='none'>
+    <ToolbarButton
+      Icon={Link}
+      title='Link'
+      getState={(s) => s.link}
+      onClick={(s) => ({ type: 'link', data: s ? !s.link : null })}
+    />
+    {/* <ToolbarButton Icon={At} title='Mention' onClick={() => ({ type: 'mention' })} /> */}
+    {/* <ToolbarButton Icon={Image} title='Image' onClick={() => ({ type: 'image' })} /> */}
+  </div>
+);
+
+const MarkdownStandard = () => (
+  <>
+    <MarkdownHeading />
+    <MarkdownStyles />
+    <MarkdownLists />
+    <MarkdownBlocks />
+    <MarkdownLinks />
+  </>
+);
+
+const MarkdownExtended = () => (
+  <Toolbar.Button Icon={ChatText} title='Create comment' onClick={() => ({ type: 'comment' })} />
+);
+
+export const Toolbar = {
+  Root: ToolbarRoot,
+  Button: ToolbarButton,
+  Separator: ToolbarSeparator,
+  Markdown: MarkdownStandard,
+  Extended: MarkdownExtended,
+};
+
+export { useToolbarContext };

package/src/components/Toolbar/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './Toolbar';

package/src/components/index.ts

@@ -3,3 +3,4 @@
 //
 
 export * from './TextEditor';
+export * from './Toolbar';

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);
   },
 });