@dxos/react-ui-editor 0.3.10 → 0.3.11-main.008b7c6

package/src/{components/TextEditor/extensions → extensions}/markdown/highlight.ts

@@ -8,21 +8,18 @@ import { tags, styleTags, Tag } from '@lezer/highlight';
 import { type MarkdownConfig, Table } from '@lezer/markdown';
 import get from 'lodash.get';
 
-import { mx } from '@dxos/react-ui-theme';
-
 import {
   blockquote,
   bold,
   code,
   codeMark,
   heading,
-  horizontalRule,
   inlineUrl,
   italic,
   mark,
   strikethrough,
   tokens,
-} from '../../../../styles';
+} from '../../styles';
 
 /**
  * Custom tags defined and processed by the GFM lezer extension.
@@ -35,7 +32,7 @@ export const markdownTags = {
   CodeText: Tag.define(),
   EmphasisMark: Tag.define(),
   HeaderMark: Tag.define(),
-  HorizontalRule: Tag.define(),
+  // HorizontalRule: Tag.define(),
   InlineCode: Tag.define(),
   LinkLabel: Tag.define(),
   LinkReference: Tag.define(),
@@ -182,10 +179,10 @@ export const markdownHighlightStyle = (readonly?: boolean) => {
       },
 
       // TODO(burdon): Replace with extension.
-      {
-        tag: [markdownTags.HorizontalRule],
-        class: mx(horizontalRule, readonly && '-indent-[100rem]'),
-      },
+      // {
+      //   tag: [markdownTags.HorizontalRule],
+      //   class: mx(horizontalRule, readonly && '-indent-[100rem]'),
+      // },
 
       // TODO(burdon): Only if being edited.
       {

package/src/extensions/mermaid.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Extension } from '@codemirror/state';
+
+// TODO(burdon): How will this interact with the code extension?
+// TODO(burdon): Move to mermaid-plugin (which should contribute this extension).
+export const mermaid = (): Extension => {
+  return [];
+};

package/src/{components/TextEditor/extensions → extensions}/table.ts

@@ -9,6 +9,9 @@ import { Decoration, EditorView, WidgetType } from '@codemirror/view';
 // TODO(burdon): Snippet to create basic table.
 //  https://codemirror.net/docs/ref/#autocomplete.snippet
 
+// TODO(burdon): Advanced formatting (left/right/center).
+// TODO(burdon): Editor to auto balance columns.
+
 export type TableOptions = {};
 
 /**
@@ -73,7 +76,17 @@ const update = (state: EditorState, options: TableOptions) => {
 
   tables.forEach((table) => {
     const hide = state.readOnly || cursor < table.from || cursor > table.to;
-    hide && builder.add(table.from, table.to, Decoration.replace({ widget: new TableWidget(table) }));
+    hide &&
+      builder.add(
+        table.from,
+        table.to,
+        Decoration.replace({
+          block: true,
+          widget: new TableWidget(table),
+        }),
+      );
+
+    // Add class for styling.
     builder.add(table.from, table.to, Decoration.mark({ class: 'cm-table' }));
   });
 

package/src/{components/TextEditor/extensions/demo.ts → extensions/typewriter.ts}

@@ -15,12 +15,11 @@ export type DemoOptions = {
 const defaultItems = ['hello world!', 'this is a test.', 'this is [DXOS](https://dxos.org)'];
 
 /**
- * Demo script.
  * Configurable plugin that let's user cycle through pre-configured input script.
  */
-export const demo = ({ delay = 75, items = defaultItems }: DemoOptions = {}): Extension => {
+export const typewriter = ({ delay = 75, items = defaultItems }: DemoOptions = {}): Extension => {
   let t: any;
-  let idx = 0;
+  let idx = 0; // TODO(burdon): Make global.
 
   return [
     keymap.of([

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/extensions/yjs/yjs.test.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+import * as Y from 'yjs';
+
+import { TextObject } from '@dxos/echo-schema';
+import { describe, test } from '@dxos/test';
+import { type YText } from '@dxos/text-model';
+
+describe('YJS', () => {
+  // https://docs.yjs.dev/api/shared-types/y.text
+  // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
+  test('absolute position', () => {
+    const obj = new TextObject('hello world');
+    const index = obj.text.indexOf('world');
+    const relPos = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(obj.content as YText, index));
+
+    {
+      const cursor = Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(relPos), obj.doc!);
+      expect(cursor!.index).to.equal(index);
+      expect(obj.text.substring(cursor!.index)).to.equal('world');
+    }
+
+    (obj.content as YText).insert(index, 'cruel ');
+    expect(obj.text).to.equal('hello cruel world');
+
+    {
+      const cursor = Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(relPos), obj.doc!);
+      expect(cursor!.index).not.to.equal(index);
+      expect(obj.text.substring(cursor!.index)).to.equal('world');
+    }
+  });
+});

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';

package/src/hooks/useTextModel.ts

@@ -2,45 +2,53 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Extension } from '@codemirror/state';
-import get from 'lodash.get';
+import { StateField, type Extension } from '@codemirror/state';
 import { useEffect, useState } from 'react';
-import { yCollab } from 'y-codemirror.next';
-import type * as awarenessProtocol from 'y-protocols/awareness';
+import type * as YP from 'y-protocols/awareness';
 
-import { invariant } from '@dxos/invariant';
-import {
-  type DocAccessor,
-  type Space,
-  type TextObject,
-  type AutomergeTextCompat,
-  getRawDoc,
-  isActualAutomergeObject,
-} from '@dxos/react-client/echo';
+import { isAutomergeObject, type DocAccessor, type Space, type TextObject } from '@dxos/react-client/echo';
 import { type Identity } from '@dxos/react-client/halo';
 import type { YText, YXmlFragment } from '@dxos/text-model';
 
-import { automergePlugin } from './automerge';
-import { SpaceAwarenessProvider } from './yjs';
+import { createAutomergeModel } from './automerge';
+import { createYjsModel } from './yjs';
 
-// TODO(burdon): Move.
-type Awareness = awarenessProtocol.Awareness;
+// TODO(burdon): Factor out defs.
 
-export type DocumentRange = {
-  id: string;
+/**
+ * State field makes the model available to other extensions.
+ */
+export const modelState = StateField.define<EditorModel | undefined>({
+  create: () => undefined,
+  update: (model) => model,
+});
+
+export type Range = {
   from: number;
   to: number;
 };
 
+export type CommentRange = {
+  id: string;
+  cursor: string;
+};
+
 // TODO(wittjosiah): Factor out to common package? @dxos/react-client?
 export type EditorModel = {
   id: string;
-  // TODO(burdon): Remove.
-  content: string | YText | YXmlFragment | DocAccessor;
   text: () => string;
-  ranges: DocumentRange[];
   extension?: Extension;
-  awareness?: Awareness;
+
+  // TODO(burdon): Remove.
+  content: string | YText | YXmlFragment | DocAccessor;
+  /**
+   * @deprecated Use CursorConverter.
+   */
+  getCursorFromRange?: (value: Range) => string;
+  getRangeFromCursor?: (cursor: string) => Range | undefined;
+  // TODO(burdon): Move into extension.
+  awareness?: YP.Awareness;
+  // TODO(burdon): Remove.
   peer?: {
     id: string;
     name?: string;
@@ -48,7 +56,7 @@ export type EditorModel = {
 };
 
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
-export type UseTextModelOptions = {
+export type UseTextModelProps = {
   identity?: Identity | null;
   space?: Space;
   text?: TextObject;
@@ -56,64 +64,20 @@ export type UseTextModelOptions = {
 
 // TODO(burdon): Remove YJS/Automerge deps (from UI component -- create abstraction; incl. all ECHO/Space deps).
 // TODO(wittjosiah): Factor out to common package? @dxos/react-client?
-export const useTextModel = ({ identity, space, text }: UseTextModelOptions): EditorModel | undefined => {
-  const [model, setModel] = useState<EditorModel | undefined>(() => createModel({ identity, space, text }));
-  useEffect(() => {
-    setModel(createModel({ identity, space, text }));
-  }, [identity, space, text]);
+export const useTextModel = (props: UseTextModelProps): EditorModel | undefined => {
+  const { identity, space, text } = props;
+  const [model, setModel] = useState<EditorModel | undefined>(() => createModel(props));
+  useEffect(() => setModel(createModel(props)), [identity, space, text]);
   return model;
 };
 
-const createModel = (options: UseTextModelOptions) => {
-  const { text } = options;
-  if (isActualAutomergeObject(text)) {
-    return createAutomergeModel(options);
+const createModel = (props: UseTextModelProps) => {
+  const { text } = props;
+  if (isAutomergeObject(text)) {
+    return createAutomergeModel(props);
+  } else if (text?.doc) {
+    return createYjsModel(props);
   } else {
-    if (!text?.doc) {
-      return undefined;
-    }
-
-    return createYjsModel(options);
+    return undefined;
   }
 };
-
-const createYjsModel = ({ identity, space, text }: UseTextModelOptions): EditorModel => {
-  invariant(text?.doc && text?.content);
-  const provider = space
-    ? new SpaceAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` })
-    : undefined;
-
-  return {
-    id: text.doc.guid,
-    content: text.content,
-    text: () => text.content!.toString(),
-    ranges: [],
-    extension: yCollab(text.content as YText, provider?.awareness),
-    awareness: provider?.awareness,
-    peer: identity
-      ? {
-          id: identity.identityKey.toHex(),
-          name: identity.profile?.displayName,
-        }
-      : undefined,
-  };
-};
-
-const createAutomergeModel = ({ identity, text }: UseTextModelOptions): EditorModel => {
-  const obj = text as any as AutomergeTextCompat;
-  const doc = getRawDoc(obj, [obj.field]);
-
-  return {
-    id: obj.id,
-    content: doc,
-    text: () => get(doc.handle.docSync(), doc.path),
-    ranges: [],
-    extension: automergePlugin(doc.handle, doc.path),
-    peer: identity
-      ? {
-          id: identity.identityKey.toHex(),
-          name: identity.profile?.displayName,
-        }
-      : undefined,
-  };
-};

package/src/hooks/{yjs/space-provider.ts → yjs.ts}

@@ -5,14 +5,62 @@
 import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import { Observable } from 'lib0/observable';
-import * as awarenessProtocol from 'y-protocols/awareness';
+import * as YP from 'y-protocols/awareness';
+import * as Y from 'yjs';
 import { type Doc } from 'yjs';
 
+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';
-
-type Awareness = awarenessProtocol.Awareness;
+import type { YText } from '@dxos/text-model';
+import { arrayToString, stringToArray } from '@dxos/util';
+
+import { type EditorModel, modelState, type Range, type UseTextModelProps } from './useTextModel';
+import { yjs } from '../extensions';
+
+export const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
+  invariant(text?.doc && text?.content);
+  const provider = space
+    ? new YAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` })
+    : undefined;
+
+  const model: EditorModel = {
+    id: text.doc.guid,
+    content: text.content,
+    text: () => text.content!.toString(),
+    // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
+    // TODO(dmaretskyi): Refactor as cursor-converter.
+    getCursorFromRange: (range: Range) => {
+      const from = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.from));
+      const to = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.to, -1));
+      return [arrayToString(from), arrayToString(to)].join(':');
+    },
+    getRangeFromCursor: (cursor: string) => {
+      invariant(text.doc);
+      const parts = cursor.split(':');
+      const from = Y.createAbsolutePositionFromRelativePosition(
+        Y.decodeRelativePosition(stringToArray(parts[0])),
+        text.doc,
+      );
+      const to = Y.createAbsolutePositionFromRelativePosition(
+        Y.decodeRelativePosition(stringToArray(parts[1])),
+        text.doc,
+      );
+      return from && to ? { from: from.index, to: to.index } : undefined;
+    },
+    extension: [modelState.init(() => model), yjs(text.content as YText, provider?.awareness)],
+    awareness: provider?.awareness,
+    peer: identity
+      ? {
+          id: identity.identityKey.toHex(),
+          name: identity.profile?.displayName,
+        }
+      : undefined,
+  };
+
+  return model;
+};
 
 // Based on https://github.com/yjs/y-webrtc/blob/88baab2/src/y-webrtc.js.
 
@@ -22,16 +70,26 @@ const messageQueryAwareness = 3;
 /**
  * Yjs awareness provider on top of a DXOS space.
  */
-export class SpaceAwarenessProvider extends Observable<any> {
+export class YAwarenessProvider extends Observable<any> {
   private readonly _space: Space;
-  private readonly _awareness: Awareness;
+  private readonly _awareness: YP.Awareness;
   private readonly _clientId: number;
   private readonly _channel: string;
 
-  constructor({ space, doc, channel, awareness }: { space: Space; doc: Doc; channel: string; awareness?: Awareness }) {
+  constructor({
+    space,
+    doc,
+    channel,
+    awareness,
+  }: {
+    space: Space;
+    doc: Doc;
+    channel: string;
+    awareness?: YP.Awareness;
+  }) {
     super();
     this._space = space;
-    this._awareness = awareness ?? new awarenessProtocol.Awareness(doc);
+    this._awareness = awareness ?? new YP.Awareness(doc);
     this._channel = channel;
     this._clientId = doc.clientID;
 
@@ -52,14 +110,11 @@ export class SpaceAwarenessProvider extends Observable<any> {
     // Post local awareness state.
     const encoderAwarenessState = encoding.createEncoder();
     encoding.writeVarUint(encoderAwarenessState, messageAwareness);
-    encoding.writeVarUint8Array(
-      encoderAwarenessState,
-      awarenessProtocol.encodeAwarenessUpdate(this.awareness, [this._clientId]),
-    );
+    encoding.writeVarUint8Array(encoderAwarenessState, YP.encodeAwarenessUpdate(this.awareness, [this._clientId]));
     void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwarenessState));
   }
 
-  get awareness(): Awareness {
+  get awareness(): YP.Awareness {
     return this._awareness;
   }
 
@@ -68,10 +123,7 @@ export class SpaceAwarenessProvider extends Observable<any> {
     const changedClients = added.concat(updated).concat(removed);
     const encoderAwareness = encoding.createEncoder();
     encoding.writeVarUint(encoderAwareness, messageAwareness);
-    encoding.writeVarUint8Array(
-      encoderAwareness,
-      awarenessProtocol.encodeAwarenessUpdate(this._awareness, changedClients),
-    );
+    encoding.writeVarUint8Array(encoderAwareness, YP.encodeAwarenessUpdate(this._awareness, changedClients));
     void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwareness));
   }
 
@@ -92,7 +144,7 @@ export class SpaceAwarenessProvider extends Observable<any> {
     let sendReply = false;
     switch (messageType) {
       case messageAwareness: {
-        awarenessProtocol.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
+        YP.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
         break;
       }
 
@@ -100,7 +152,7 @@ export class SpaceAwarenessProvider extends Observable<any> {
         encoding.writeVarUint(encoder, messageAwareness);
         encoding.writeVarUint8Array(
           encoder,
-          awarenessProtocol.encodeAwarenessUpdate(this._awareness, Array.from(this._awareness.getStates().keys())),
+          YP.encodeAwarenessUpdate(this._awareness, Array.from(this._awareness.getStates().keys())),
         );
         sendReply = true;
         break;
@@ -121,6 +173,6 @@ export class SpaceAwarenessProvider extends Observable<any> {
   }
 
   private _handleBeforeUnload() {
-    awarenessProtocol.removeAwarenessStates(this._awareness, [this._clientId], 'window unload');
+    YP.removeAwarenessStates(this._awareness, [this._clientId], 'window unload');
   }
 }