@dxos/react-ui-editor 0.3.11-main.3f845e1 → 0.3.11-main.463e5cd

package/src/components/Toolbar/Toolbar.tsx

@@ -0,0 +1,166 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import {
+  type Icon,
+  At,
+  CaretRight,
+  ChatText,
+  Code,
+  Image,
+  Link,
+  ListBullets,
+  ListChecks,
+  ListNumbers,
+  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 } from '@dxos/react-ui-theme';
+
+// TODO(burdon): Revert to string to make extensible?
+export type ActionType =
+  | 'blockquote'
+  | 'bold'
+  | 'codeblock'
+  | 'comment'
+  | 'heading'
+  | 'image'
+  | 'italic'
+  | 'link'
+  | 'list'
+  | 'list-ordered'
+  | 'list-tasks'
+  | 'mention'
+  | 'prompt'
+  | 'strikethrough'
+  | 'table';
+
+export type Action = {
+  type: ActionType;
+  data?: any;
+};
+
+export type ToolbarProps = PropsWithChildren<{
+  onAction?: (action: Action) => void;
+}>;
+
+const [ToolbarContextProvider, useToolbarContext] = createContext<ToolbarProps>('Toolbar');
+
+const ToolbarRoot = ({ children, onAction }: ToolbarProps) => {
+  return (
+    <ToolbarContextProvider onAction={onAction}>
+      <DensityProvider density='fine'>
+        <div role='toolbar' className='flex w-full shrink-0 p-2 gap-4 items-center whitespace-nowrap overflow-hidden'>
+          {children}
+        </div>
+      </DensityProvider>
+    </ToolbarContextProvider>
+  );
+};
+
+type ToolbarButtonProps = {
+  Icon: Icon;
+  onClick: () => Action | undefined;
+} & NonNullable<Pick<ButtonProps, 'title'>>;
+
+const ToolbarButton = ({ Icon, onClick, title }: ToolbarButtonProps) => {
+  const { onAction } = useToolbarContext('ToolbarButton');
+  const handleClick = () => {
+    const action = onClick();
+    if (action) {
+      onAction?.(action);
+    }
+  };
+
+  return (
+    <Button variant='ghost' classNames='p-2' onClick={handleClick} title={title}>
+      <Icon className={getSize(5)} />
+    </Button>
+  );
+};
+
+const ToolbarSeparator = () => <div className='grow' />;
+
+const MarkdownHeading = () => {
+  const { onAction } = useToolbarContext('MarkdownFormatting');
+  return (
+    <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>
+  );
+};
+
+const MarkdownStyles = () => (
+  <div role='none'>
+    <ToolbarButton Icon={TextB} title='Bold' onClick={() => ({ type: 'bold' })} />
+    <ToolbarButton Icon={TextItalic} title='Italic' onClick={() => ({ type: 'italic' })} />
+    <ToolbarButton Icon={TextStrikethrough} title='Strike-through' onClick={() => ({ type: 'strikethrough' })} />
+  </div>
+);
+
+const MarkdownLists = () => (
+  <div role='none'>
+    <ToolbarButton Icon={ListBullets} title='Bullet list' onClick={() => ({ type: 'list' })} />
+    <ToolbarButton Icon={ListNumbers} title='Numbered list' onClick={() => ({ type: 'list-ordered' })} />
+    <ToolbarButton Icon={ListChecks} title='Task list' onClick={() => ({ type: 'list-tasks' })} />
+  </div>
+);
+
+const MarkdownBlocks = () => (
+  <div role='none'>
+    <ToolbarButton Icon={CaretRight} title='Block quite' onClick={() => ({ type: 'blockquote' })} />
+    <ToolbarButton Icon={Code} title='Code block' onClick={() => ({ type: 'codeblock' })} />
+    <ToolbarButton Icon={Table} title='Table' onClick={() => ({ type: 'table' })} />
+  </div>
+);
+
+const MarkdownLinks = () => (
+  <div role='none'>
+    <ToolbarButton Icon={Link} title='Link' onClick={() => ({ type: 'link' })} />
+    <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/{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,35 @@ 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.
+      activateOnTyping: true,
+
+      // closeOnBlur: 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): Styles/fragments.
+      tooltipClass: () => 'shadow rounded',
+    }),
+
+    // 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.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

@@ -0,0 +1,103 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import { invertedEffects } from '@codemirror/commands';
+import { StateField, type Extension, type StateEffect } from '@codemirror/state';
+import { EditorView, ViewPlugin } from '@codemirror/view';
+
+import { next as A, type Prop } from '@dxos/automerge/automerge';
+
+import { cursorConverter } from './cursor';
+import { updateHeadsEffect, type IDocHandle, isReconcile, type State } 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 syncState = StateField.define<State>({
+    create: () => ({
+      path: path.slice(),
+      lastHeads: A.getHeads(handle.docSync()!),
+      unreconciledTransactions: [],
+    }),
+
+    update: (value, tr) => {
+      const result: State = {
+        path: path.slice(),
+        lastHeads: value.lastHeads,
+        unreconciledTransactions: value.unreconciledTransactions.slice(),
+      };
+
+      let clearUnreconciled = false;
+      for (const effect of tr.effects) {
+        if (effect.is(updateHeadsEffect)) {
+          result.lastHeads = effect.value.newHeads;
+          clearUnreconciled = true;
+        }
+      }
+
+      if (clearUnreconciled) {
+        result.unreconciledTransactions = [];
+      } else {
+        if (!isReconcile(tr)) {
+          result.unreconciledTransactions.push(tr);
+        }
+      }
+
+      return result;
+    },
+  });
+
+  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) {
+          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

@@ -0,0 +1,52 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import get from 'lodash.get';
+
+import type { Prop } from '@dxos/automerge/automerge';
+import { next as A } 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 A.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 A.getCursorPosition(doc, path.slice(), cursor);
+  },
+});

package/src/extensions/automerge/defs.ts

@@ -0,0 +1,41 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import { Annotation, StateEffect, type StateField, type EditorState, type Transaction } from '@codemirror/state';
+
+import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
+
+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 updateHeadsEffect = StateEffect.define<UpdateHeads>({});
+
+export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
+
+export const reconcileAnnotation = Annotation.define<boolean>();
+
+export const isReconcile = (tr: Transaction): boolean => {
+  return !!tr.annotation(reconcileAnnotation);
+};
+
+export type IDocHandle<T = any> = {
+  docSync(): Doc<T> | undefined;
+  change(callback: ChangeFn<T>, options?: ChangeOptions<T>): void;
+  changeAt(heads: Heads, callback: ChangeFn<T>, options?: ChangeOptions<T>): string[] | undefined;
+
+  addListener(event: 'change', listener: () => void): void;
+  removeListener(event: 'change', listener: () => void): void;
+};

package/src/extensions/automerge/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { automerge } from './automerge';
+export { type IDocHandle } from './defs';

package/src/extensions/automerge/semaphore.ts

@@ -0,0 +1,81 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import { type StateField } from '@codemirror/state';
+import { type EditorView } from '@codemirror/view';
+
+import { next as A } from '@dxos/automerge/automerge';
+
+import {
+  getLastHeads,
+  getPath,
+  isReconcile,
+  reconcileAnnotation,
+  updateHeads,
+  type IDocHandle,
+  type State,
+} from './defs';
+import { updateAutomerge } from './update-automerge';
+import { updateCodeMirror } from './update-codemirror';
+
+/**
+ * Implements three-way merge (on each mutation).
+ */
+export class PatchSemaphore {
+  private _inReconcile = false;
+
+  // prettier-ignore
+  constructor(
+    private readonly _handle: IDocHandle,
+    private readonly _state: StateField<State>
+  ) {}
+
+  reconcile(view: EditorView) {
+    if (!this._inReconcile) {
+      this._inReconcile = true;
+      this.doReconcile(view);
+      this._inReconcile = false;
+    }
+  }
+
+  private doReconcile(view: EditorView) {
+    const path = getPath(view.state, this._state);
+
+    // Get the heads before the unreconciled transactions are applied.
+    const oldHeads = getLastHeads(view.state, this._state);
+    let selection = view.state.selection;
+
+    // First undo all the unreconciled transactions.
+    const transactions = view.state.field(this._state).unreconciledTransactions.filter((tx) => !isReconcile(tx));
+    const toInvert = transactions.slice().reverse();
+    for (const tr of toInvert) {
+      const inverted = tr.changes.invert(tr.startState.doc);
+      selection = selection.map(inverted);
+      view.dispatch({
+        changes: inverted,
+        annotations: reconcileAnnotation.of(true),
+      });
+    }
+
+    // Apply the unreconciled transactions to the document.
+    // NOTE: null and undefined each come from automerge and repo respectively.
+    let newHeads = updateAutomerge(this._state, this._handle, transactions, view.state);
+    if (newHeads === null || newHeads === undefined) {
+      // TODO(alexjg): this is the call that's resetting the editor state on click.
+      newHeads = A.getHeads(this._handle.docSync()!);
+    }
+
+    // Now get the diff between the updated state of the document and the heads and apply that to the codemirror doc.
+    const diff = A.equals(oldHeads, newHeads) ? [] : A.diff(this._handle.docSync()!, oldHeads, newHeads);
+    updateCodeMirror(view, selection, path, diff);
+
+    // Update automerge state.
+    view.dispatch({
+      effects: updateHeads(newHeads),
+      annotations: reconcileAnnotation.of(false),
+    });
+  }
+}

package/src/extensions/automerge/update-automerge.ts

@@ -0,0 +1,49 @@
+//
+// Copyright 2023 DXOS.org
+// Copyright 2024 Automerge
+// Ref: https://github.com/automerge/automerge-codemirror
+//
+
+import { type EditorState, type StateField, type Transaction, type Text } from '@codemirror/state';
+
+import { next as A, type Heads } from '@dxos/automerge/automerge';
+
+import { type IDocHandle, type State } from './defs';
+
+export const updateAutomerge = (
+  field: StateField<State>,
+  handle: IDocHandle,
+  transactions: Transaction[],
+  state: EditorState, // TODO(burdon): Just pass in the state field value?
+): Heads | undefined => {
+  const { lastHeads, path } = state.field(field);
+
+  // We don't want to call `automerge.updateAt` if there are no changes.
+  // Otherwise, later on `automerge.diff` will return empty patches that result in a no-op but still mess up the selection.
+  let hasChanges = false;
+  for (const tr of transactions) {
+    tr.changes.iterChanges(() => {
+      hasChanges = true;
+    });
+  }
+
+  if (!hasChanges) {
+    return undefined;
+  }
+
+  const newHeads = handle.changeAt(lastHeads, (doc: A.Doc<unknown>) => {
+    const invertedTransactions: { from: number; del: number; insert: Text }[] = [];
+    for (const tr of transactions) {
+      tr.changes.iterChanges((fromA, toA, _fromB, _toB, insert) => {
+        invertedTransactions.push({ from: fromA, del: toA - fromA, insert });
+      });
+    }
+
+    // TODO(burdon): Hack to apply in reverse order to properly apply range.
+    invertedTransactions.reverse().forEach(({ from, del, insert }) => {
+      A.splice(doc, path.slice(), from, del, insert.toString());
+    });
+  });
+
+  return newHeads ?? undefined;
+};