@dxos/react-ui-editor 0.3.11-main.870164f → 0.3.11-main.8be6c8a

package/src/extensions/index.ts

@@ -3,6 +3,8 @@
 //
 
 export * from './autocomplete';
+export * from './automerge';
+export * from './awareness';
 export * from './basic';
 export * from './blast';
 export * from './code';
@@ -13,7 +15,7 @@ export * from './link';
 export * from './listener';
 export * from './markdown';
 export * from './mention';
-export * from './mermaid';
 export * from './table';
 export * from './tasklist';
 export * from './typewriter';
+export * from './yjs';

package/src/extensions/link.ts

@@ -4,20 +4,20 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
+import { type Extension, RangeSetBuilder } from '@codemirror/state';
 import {
-  type EditorState,
-  type Extension,
-  type RangeSet,
-  RangeSetBuilder,
-  StateField,
-  type Transaction,
-} from '@codemirror/state';
-import { Decoration, EditorView, WidgetType, hoverTooltip } from '@codemirror/view';
+  Decoration,
+  type EditorView,
+  WidgetType,
+  hoverTooltip,
+  ViewPlugin,
+  type ViewUpdate,
+  type DecorationSet,
+} from '@codemirror/view';
+import { type SyntaxNode } from '@lezer/common';
 
 import { tooltipContent } from '@dxos/react-ui-theme';
 
-const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
-
 // Adapted from:
 // https://codemirror.net/try/?c=aW1wb3J0IHsgYmFzaWNTZXR1cCwgRWRpdG9yVmlldyB9IGZyb20gImNvZGVtaXJyb3IiCmltcG9ydCB7IG1hcmtkb3duIH0gZnJvbSAiQGNvZGVtaXJyb3IvbGFuZy1tYXJrZG93biIKaW1wb3J0IHsgc3ludGF4VHJlZSB9IGZyb20gIkBjb2RlbWlycm9yL2xhbmd1YWdlIjsKaW1wb3J0IHsgRWRpdG9yU3RhdGUsIFJhbmdlU2V0QnVpbGRlciwgU3RhdGVGaWVsZCB9IGZyb20gIkBjb2RlbWlycm9yL3N0YXRlIjsKaW1wb3J0IHsgRGVjb3JhdGlvbiwgV2lkZ2V0VHlwZSB9IGZyb20gIkBjb2RlbWlycm9yL3ZpZXciOwoKY2xhc3MgTGluayBleHRlbmRzIFdpZGdldFR5cGUgewogIGNvbnN0cnVjdG9yKHRleHQsIHVybCkgewogICAgc3VwZXIoKQogICAgdGhpcy50ZXh0ID0gdGV4dAogICAgdGhpcy51cmwgPSB1cmwKICB9CiAgZXEob3RoZXIpIHsgcmV0dXJuIHRoaXMudGV4dCA9PSBvdGhlci50ZXh0ICYmIHRoaXMudXJsID09IG90aGVyLnVybCB9CiAgdG9ET00oKSB7CiAgICBsZXQgbGluayA9IGRvY3VtZW50LmNyZWF0ZUVsZW1lbnQoImEiKQogICAgbGluay50ZXh0Q29udGVudCA9IHRoaXMudGV4dAogICAgbGluay5ocmVmID0gdGhpcy51cmwKICAgIHJldHVybiBsaW5rOwogIH0KfQoKbGV0IGRlY29yYXRpb25zRmllbGQgPSBTdGF0ZUZpZWxkLmRlZmluZSh7CiAgY3JlYXRlKCkgewogICAgcmV0dXJuIERlY29yYXRpb24ubm9uZTsKICB9LAogIHVwZGF0ZShfLCB0cikgewogICAgY29uc3QgYnVpbGRlciA9IG5ldyBSYW5nZVNldEJ1aWxkZXIoKTsKICAgIGxldCBjdXJzb3IgPSB0ci5zdGF0ZS5zZWxlY3Rpb24ubWFpbi5oZWFkOwogICAgc3ludGF4VHJlZSh0ci5zdGF0ZSkuaXRlcmF0ZSh7CiAgICAgIGVudGVyOiAobm9kZSkgPT4gewogICAgICAgIGlmICgoY3Vyc29yIDwgbm9kZS5mcm9tIHx8IGN1cnNvciA+IG5vZGUudG8pICYmIG5vZGUubmFtZSA9PSAiTGluayIpIHsKICAgICAgICAgIGxldCBtYXJrcyA9IG5vZGUubm9kZS5nZXRDaGlsZHJlbigiTGlua01hcmsiKTsKICAgICAgICAgIGxldCB0ZXh0ID0gbWFya3MubGVuZ3RoID49IDIgPyB0ci5zdGF0ZS5zbGljZURvYyhtYXJrc1swXS50bywgbWFya3NbMV0uZnJvbSkgOiAiIgoKICAgICAgICAgIGxldCB1cmxOb2RlID0gbm9kZS5ub2RlLmdldENoaWxkKCJVUkwiKTsKICAgICAgICAgIGxldCB1cmwgPSB1cmxOb2RlID8gdHIuc3RhdGUuc2xpY2VEb2ModXJsTm9kZS5mcm9tLCB1cmxOb2RlLnRvKSA6ICIiCiAgICAgICAgICBidWlsZGVyLmFkZChub2RlLmZyb20sIG5vZGUudG8sIERlY29yYXRpb24ucmVwbGFjZSh7CiAgICAgICAgICAgIHdpZGdldDogbmV3IExpbmsodGV4dCwgdXJsKSwKICAgICAgICAgIH0pLAogICAgICAgICAgICAgICAgICAgICApOwogICAgICAgICAgcmV0dXJuIGZhbHNlOwogICAgICAgIH0KICAgICAgICByZXR1cm4gdHJ1ZTsKICAgICAgfSwKICAgIH0pOwogICAgcmV0dXJuIGJ1aWxkZXIuZmluaXNoKCk7CiAgfSwKICBwcm92aWRlOiAoZikgPT4gRWRpdG9yVmlldy5kZWNvcmF0aW9ucy5mcm9tKGYpLAp9KTsKCmxldCB2aWV3ID0gbmV3IEVkaXRvclZpZXcoewogIGRvYzogIiMgSGVsbG8gV29ybGRcblxuW1Rlc3RdKGh0dHBzOi8vZXhhbXBsZS5jb20pXG5cblxuIiwKICBleHRlbnNpb25zOiBbZGVjb3JhdGlvbnNGaWVsZCwgbWFya2Rvd24oKV0sCiAgcGFyZW50OiBkb2N1bWVudC5ib2R5LAp9KTsKCnZpZXcuZm9jdXMoKTs=
 // https://discuss.codemirror.net/t/link-widget-is-clicked-only-if-editor-is-out-of-focus/7433
@@ -34,11 +34,24 @@ export type LinkOptions = {
  */
 export const link = (options: LinkOptions = {}): Extension => {
   const extensions: Extension[] = [
-    StateField.define<RangeSet<any>>({
-      create: (state) => update(state, options),
-      update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
-      provide: (field) => EditorView.decorations.from(field),
-    }),
+    ViewPlugin.fromClass(
+      class {
+        decorations: DecorationSet;
+
+        constructor(view: EditorView) {
+          this.decorations = buildDecorations(view, options);
+        }
+
+        update(update: ViewUpdate) {
+          if (update.docChanged || update.viewportChanged || update.selectionSet) {
+            this.decorations = buildDecorations(update.view, options);
+          }
+        }
+      },
+      {
+        decorations: (v) => v.decorations,
+      },
+    ),
   ];
 
   if (options.onHover) {
@@ -46,41 +59,25 @@ export const link = (options: LinkOptions = {}): Extension => {
       // https://codemirror.net/examples/tooltip
       // https://codemirror.net/docs/ref/#view.hoverTooltip
       // https://github.com/codemirror/view/blob/main/src/tooltip.ts
-      hoverTooltip((view, pos) => {
-        const { from, text } = view.state.doc.lineAt(pos);
-        const p = pos - from;
-
-        let idx = 0;
-        let match;
-        do {
-          match = text.substring(idx).match(markdownLinkRegexp);
-          if (!match) {
-            match = undefined;
-            break;
-          }
-
-          idx = text.indexOf(match[0]);
-          if (p >= idx && p < idx + match[0].length) {
-            break;
-          }
-
-          idx += match[0].length;
-        } while (true);
-
-        if (!match) {
+      hoverTooltip((view, pos, side) => {
+        const syntax = syntaxTree(view.state).resolveInner(pos, side);
+        let link = null;
+        for (let i = 0, node: SyntaxNode | null = syntax; !link && node && i < 5; node = node.parent, i++) {
+          link = node.name === 'Link' ? node : null;
+        }
+        const url = link && link.getChild('URL');
+        if (!url || !link) {
           return null;
         }
-
-        const [, , url] = match ?? [];
-
+        const urlText = view.state.sliceDoc(url.from, url.to);
         return {
-          pos: idx + from,
-          end: idx + from + match[0].length,
+          pos: link.from,
+          end: link.to,
           above: true,
           create: () => {
             const el = document.createElement('div');
             el.className = tooltipContent({}, 'pli-2 plb-1');
-            options.onHover!(el, url);
+            options.onHover!(el, urlText);
             return { dom: el, offset: { x: 0, y: 4 } };
           },
         };
@@ -92,16 +89,12 @@ export const link = (options: LinkOptions = {}): Extension => {
 };
 
 class LinkButton extends WidgetType {
-  constructor(
-    private readonly _pos: number,
-    private readonly _url: string,
-    private readonly _onAttach: LinkOptions['onRender'],
-  ) {
+  constructor(private readonly _url: string, private readonly _onAttach: LinkOptions['onRender']) {
     super();
   }
 
   override eq(other: LinkButton) {
-    return this._pos === other._pos && this._url === other._url;
+    return this._url === other._url;
   }
 
   toDOM(view: EditorView) {
@@ -147,46 +140,51 @@ class LinkText extends WidgetType {
  * possibly overlapping ranges in such a way that they can efficiently be mapped though document changes.
  * https://codemirror.net/docs/ref/#state
  */
-const update = (state: EditorState, options: LinkOptions) => {
-  const builder = new RangeSetBuilder();
+const buildDecorations = (view: EditorView, options: LinkOptions): DecorationSet => {
+  const builder = new RangeSetBuilder<Decoration>();
+  const { state } = view;
   const cursor = state.selection.main.head;
 
-  syntaxTree(state).iterate({
-    enter: (node) => {
-      // Check if cursor is inside text.
-      if (node.name === 'Link') {
-        const marks = node.node.getChildren('LinkMark');
-        const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
-        const urlNode = node.node.getChild('URL');
-        const url = urlNode ? state.sliceDoc(urlNode.from, urlNode.to) : '';
-        if (!url) {
-          return false;
-        }
+  for (const { from, to } of view.visibleRanges) {
+    syntaxTree(state).iterate({
+      enter: (node) => {
+        // Check if cursor is inside text.
+        if (node.name === 'Link') {
+          const marks = node.node.getChildren('LinkMark');
+          const text = marks.length >= 2 ? state.sliceDoc(marks[0].to, marks[1].from) : '';
+          const urlNode = node.node.getChild('URL');
+          const url = urlNode ? state.sliceDoc(urlNode.from, urlNode.to) : '';
+          if (!url) {
+            return false;
+          }
 
-        if (state.readOnly || cursor < node.from || cursor > node.to) {
-          builder.add(
-            node.from,
-            node.to,
-            Decoration.replace({
-              widget: new LinkText(text, options.link ? url : undefined),
-            }),
-          );
-        }
+          if (!view.hasFocus || state.readOnly || cursor < node.from || cursor > node.to) {
+            builder.add(
+              node.from,
+              node.to,
+              Decoration.replace({
+                widget: new LinkText(text, options.link ? url : undefined),
+              }),
+            );
+          }
 
-        if (options.onRender) {
-          builder.add(
-            node.to,
-            node.to,
-            Decoration.replace({
-              widget: new LinkButton(node.from, url, options.onRender),
-            }),
-          );
-        }
+          if (options.onRender) {
+            builder.add(
+              node.to,
+              node.to,
+              Decoration.replace({
+                widget: new LinkButton(url, options.onRender),
+              }),
+            );
+          }
 
-        return false;
-      }
-    },
-  });
+          return false;
+        }
+      },
+      from,
+      to,
+    });
+  }
 
   return builder.finish();
 };

package/src/extensions/markdown/highlight.ts

@@ -6,19 +6,18 @@ import { markdownLanguage } from '@codemirror/lang-markdown';
 import { HighlightStyle } from '@codemirror/language';
 import { tags, styleTags, Tag } from '@lezer/highlight';
 import { type MarkdownConfig, Table } from '@lezer/markdown';
-import get from 'lodash.get';
 
 import {
   blockquote,
   bold,
   code,
   codeMark,
+  getToken,
   heading,
   inlineUrl,
   italic,
   mark,
   strikethrough,
-  tokens,
 } from '../../styles';
 
 /**
@@ -193,12 +192,12 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
       // Main content, paragraphs, etc.
       // {
       //   tag: [tags.content],
-      //   fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+      //   fontFamily: getToken('fontFamily.body', []).join(','),
       // },
     ],
     {
       scope: markdownLanguage,
-      all: { fontFamily: get(tokens, 'fontFamily.body', []).join(',') },
+      all: { fontFamily: getToken('fontFamily.body', []).join(',') },
     },
   );
 };

package/src/extensions/table.ts

@@ -81,7 +81,6 @@ const update = (state: EditorState, options: TableOptions) => {
         table.from,
         table.to,
         Decoration.replace({
-          block: true,
           widget: new TableWidget(table),
         }),
       );
@@ -98,8 +97,11 @@ class TableWidget extends WidgetType {
     super();
   }
 
-  override eq(other: WidgetType) {
-    return this._table.from === (other as any as TableWidget)?._table?.from;
+  override eq(other: TableWidget) {
+    return (
+      this._table.header?.join() === other._table.header?.join() &&
+      this._table.rows?.join() === other._table.rows?.join()
+    );
   }
 
   toDOM(view: EditorView) {
@@ -129,4 +131,8 @@ class TableWidget extends WidgetType {
 
     return table;
   }
+
+  override ignoreEvent(e: Event) {
+    return !/^mouse/.test(e.type);
+  }
 }

package/src/extensions/tasklist.ts

@@ -22,7 +22,6 @@ const styles = EditorView.baseTheme({
 
 class CheckboxWidget extends WidgetType {
   constructor(
-    private readonly _pos: number,
     private _checked: boolean,
     private readonly _indent: number,
     private readonly _onCheck?: (check: boolean) => void,
@@ -31,7 +30,7 @@ class CheckboxWidget extends WidgetType {
   }
 
   override eq(other: CheckboxWidget) {
-    return this._pos === other._pos && this._checked === other._checked && this._indent === other._indent;
+    return this._checked === other._checked && this._indent === other._indent;
   }
 
   toDOM(view: EditorView) {
@@ -73,7 +72,6 @@ export const tasklist = (options: TasklistOptions = {}) => {
       const checked = match[2] === 'x' || match[2] === 'X';
       return Decoration.replace({
         widget: new CheckboxWidget(
-          pos,
           checked,
           indent,
           view.state.readOnly

package/src/extensions/yjs/cursor.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Y from 'yjs';
+
+import { arrayToString, stringToArray } from '@dxos/util';
+
+import { type CursorConverter } from '../../util';
+
+export const cursorConverter = (text: Y.Text): CursorConverter => ({
+  toCursor: (index, assoc) => {
+    return arrayToString(Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text, index, assoc)));
+  },
+  fromCursor: (cursor) => {
+    return (
+      Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(stringToArray(cursor)), text.doc!)?.index ??
+      0
+    );
+  },
+});

package/src/extensions/yjs/index.ts

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

package/src/{hooks → extensions}/yjs/yjs.test.ts

@@ -2,13 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-import { effect } from '@preact/signals-react';
 import { expect } from 'chai';
 import * as Y from 'yjs';
 
-import { Trigger } from '@dxos/async';
-import { Expando, setGlobalAutomergePreference, TextObject } from '@dxos/echo-schema';
-import { registerSignalFactory } from '@dxos/echo-signals';
+import { TextObject } from '@dxos/echo-schema';
 import { describe, test } from '@dxos/test';
 import { type YText } from '@dxos/text-model';
 
@@ -35,25 +32,4 @@ describe('YJS', () => {
       expect(obj.text.substring(cursor!.index)).to.equal('world');
     }
   });
-
-  // TODO(burdon): Test deleting end character.
-
-  test.skip('effect', async () => {
-    setGlobalAutomergePreference(true);
-    registerSignalFactory();
-    const obj = new Expando({ comments: [] });
-
-    const trigger = new Trigger();
-    const unsubscribe = effect(() => {
-      // TODO(burdon): BUG: doesn't work with YJS.
-      console.log(obj.comments);
-      if (obj.comments.length > 0) {
-        trigger.wake();
-      }
-    });
-
-    obj.comments.push({ message: 'hello' });
-    await trigger.wait();
-    unsubscribe();
-  });
 });

package/src/extensions/yjs/yjs.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { yCollab } from 'y-codemirror.next';
+import type * as YP from 'y-protocols/awareness';
+
+import type { YText } from '@dxos/text-model';
+
+import { cursorConverter } from './cursor';
+import { CursorConverter } from '../../util';
+
+export const yjs = (content: YText, awareness?: YP.Awareness) => [
+  CursorConverter.of(cursorConverter(content)),
+  yCollab(content, awareness),
+];

package/src/hooks/automerge.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import get from 'lodash.get';
+
+import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
+import { isNotNullOrUndefined } from '@dxos/util';
+
+import { SpaceAwarenessProvider } from './awareness-provider';
+import { type EditorModel, modelState, type UseTextModelProps } from './useTextModel';
+import { automerge, awareness, AwarenessProvider } from '../extensions';
+import { cursorColor } from '../styles';
+
+export const createAutomergeModel = ({ space, identity, text }: UseTextModelProps): EditorModel => {
+  const obj = text as any as AutomergeTextCompat;
+  const doc = getRawDoc(obj, [obj.field]);
+
+  const awarenessProvider =
+    space &&
+    new SpaceAwarenessProvider({
+      space,
+      channel: `automerge.awareness.${obj.id}`,
+      info: {
+        displayName: identity?.profile?.displayName ?? '',
+        color: cursorColor.color,
+        lightColor: cursorColor.light,
+      },
+      peerId: identity?.identityKey.toHex() ?? 'Anonymous',
+    });
+
+  const model: EditorModel = {
+    id: obj.id,
+    content: doc,
+    text: () => get(doc.handle.docSync(), doc.path),
+    // TODO(burdon): https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
+    extension: [
+      modelState.init(() => model),
+      automerge({ handle: doc.handle, path: doc.path }),
+      awarenessProvider && AwarenessProvider.of(awarenessProvider),
+      awareness(),
+    ].filter(isNotNullOrUndefined),
+    peer: identity
+      ? {
+          id: identity.identityKey.toHex(),
+          name: identity.profile?.displayName,
+        }
+      : undefined,
+  };
+
+  return model;
+};

package/src/hooks/awareness-provider.ts

@@ -0,0 +1,120 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { DeferredTask, Event, sleep } from '@dxos/async';
+import { Context } from '@dxos/context';
+import { invariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+import { type Space } from '@dxos/react-client/echo';
+import { type GossipMessage } from '@dxos/react-client/mesh';
+
+import { type AwarenessInfo, type AwarenessPosition, type AwarenessProvider, type AwarenessState } from '../extensions';
+
+type ProtocolMessage =
+  | {
+      kind: 'query';
+    }
+  | {
+      kind: 'post';
+      state: AwarenessState;
+    };
+
+const DEBOUNCE_INTERVAL = 100; // ms
+
+export type AwarenessProviderParams = {
+  space: Space;
+  channel: string;
+  peerId: string;
+  info: AwarenessInfo;
+};
+
+export class SpaceAwarenessProvider implements AwarenessProvider {
+  public readonly remoteStateChange = new Event<void>();
+
+  private readonly _remoteStates = new Map<string, AwarenessState>();
+
+  private readonly _space: Space;
+  private readonly _channel: string;
+  private readonly _peerId: string;
+  private readonly _info: AwarenessInfo;
+
+  private _localState?: AwarenessState;
+  private _postTask?: DeferredTask;
+  private _ctx?: Context;
+
+  constructor(params: AwarenessProviderParams) {
+    this._space = params.space;
+    this._channel = params.channel;
+    this._peerId = params.peerId;
+    this._info = params.info;
+  }
+
+  open() {
+    this._ctx = new Context();
+    this._postTask = new DeferredTask(this._ctx, async () => {
+      if (this._localState) {
+        await this._space.postMessage(this._channel, {
+          kind: 'post',
+          state: this._localState,
+        } satisfies ProtocolMessage);
+
+        await sleep(DEBOUNCE_INTERVAL);
+      }
+    });
+
+    const unsubscribe = this._space.listen(this._channel, (message: GossipMessage) => {
+      switch (message.payload.kind) {
+        case 'query': {
+          this._handleQueryMessage();
+          break;
+        }
+        case 'post': {
+          this._handlePostMessage(message.payload);
+          break;
+        }
+      }
+    });
+    this._ctx.onDispose(unsubscribe);
+
+    void this._space
+      .postMessage(this._channel, {
+        kind: 'query',
+      } satisfies ProtocolMessage)
+      .catch((err) => {
+        log.debug('failed to query awareness', { err });
+      });
+  }
+
+  close() {
+    void this._ctx?.dispose();
+    this._ctx = undefined;
+    this._postTask = undefined;
+  }
+
+  update(position: AwarenessPosition | undefined): void {
+    invariant(this._postTask);
+    this._localState = {
+      peerId: this._peerId,
+      position,
+      info: this._info,
+    };
+
+    this._postTask.schedule();
+  }
+
+  getRemoteStates(): AwarenessState[] {
+    return Array.from(this._remoteStates.values());
+  }
+
+  private _handleQueryMessage() {
+    invariant(this._postTask);
+    this._postTask.schedule();
+  }
+
+  private _handlePostMessage(message: ProtocolMessage) {
+    invariant(message.kind === 'post');
+    this._remoteStates.set(message.state.peerId, message.state);
+    this.remoteStateChange.emit();
+  }
+}

package/src/hooks/index.ts

@@ -2,5 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './automerge';
+export * from './awareness-provider';
 export * from './useTextModel';
 export * from './yjs';