@dxos/react-ui-editor 0.3.10-next.ef70620 → 0.3.11-main.0e40963

package/src/hooks/useTextModel.ts

@@ -2,9 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import { useMemo } from 'react';
+import { type Extension, StateField } from '@codemirror/state';
+import get from 'lodash.get';
+import { useEffect, useState } from 'react';
+import { yCollab } from 'y-codemirror.next';
 import type * as awarenessProtocol from 'y-protocols/awareness';
+import * as Y from 'yjs';
 
+import { invariant } from '@dxos/invariant';
 import {
   type DocAccessor,
   type Space,
@@ -15,78 +20,131 @@ import {
 } from '@dxos/react-client/echo';
 import { type Identity } from '@dxos/react-client/halo';
 import type { YText, YXmlFragment } from '@dxos/text-model';
+import { arrayToString, stringToArray } from '@dxos/util';
 
+import { automergePlugin } from './automerge';
 import { SpaceAwarenessProvider } from './yjs';
 
 // TODO(burdon): Move.
 type Awareness = awarenessProtocol.Awareness;
-type Provider = { awareness: Awareness };
+
+/**
+ * State field makes the model available to other extensions.
+ */
+// TODO(burdon): Use facet?
+export const modelState = StateField.define<EditorModel | undefined>({
+  create: () => undefined,
+  update: (model) => model,
+});
+
+export type Range = {
+  from: number;
+  to: number;
+};
+
+export type CommentRange = {
+  id: string;
+  // TODO(burdon): Split into begin/end?
+  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;
-  provider?: Provider;
+  text: () => string;
+  getCursorFromRange?: (value: Range) => string;
+  getRangeFromCursor?: (cursor: string) => Range | undefined;
+  extension?: Extension;
+  awareness?: Awareness;
   peer?: {
     id: string;
     name?: string;
   };
 };
 
-export type UseTextModelOptions = {
+// TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
+export type UseTextModelProps = {
   identity?: Identity | null;
   space?: Space;
   text?: TextObject;
 };
 
-// TODO(burdon): Don't support returning undefined (and remove checks from calling code).
-// TODO(burdon): Decouple space (make Editor less dependent on entire stack)?
+// 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 provider = useMemo(() => {
-    if (isActualAutomergeObject(text)) {
-      return undefined;
-    }
+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;
+};
 
-    if (!space || !text?.doc) {
+const createModel = (props: UseTextModelProps) => {
+  const { text } = props;
+  if (isActualAutomergeObject(text)) {
+    return createAutomergeModel(props);
+  } else {
+    if (!text?.doc) {
       return undefined;
     }
 
-    return new SpaceAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` });
-  }, [identity, space, text, text?.doc]);
-
-  const content = useMemo(() => {
-    if (isActualAutomergeObject(text)) {
-      const obj = text as any as AutomergeTextCompat;
-      return getRawDoc(obj, [obj.field]);
-    } else {
-      return text?.content;
-    }
-  }, [text]);
-
-  if (isActualAutomergeObject(text)) {
-    const obj = text as any as AutomergeTextCompat;
-    return {
-      id: obj.id,
-      content: content!,
-      provider: undefined,
-      peer: identity
-        ? {
-            id: identity.identityKey.toHex(),
-            name: identity.profile?.displayName,
-          }
-        : undefined,
-    };
+    return createYjsModel(props);
   }
+};
 
-  if (!text?.doc || !text?.content) {
-    return undefined;
-  }
+const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
+  invariant(text?.doc && text?.content);
+  const provider = space
+    ? new SpaceAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` })
+    : undefined;
 
-  return {
+  const model: EditorModel = {
     id: text.doc.guid,
     content: text.content,
-    provider,
+    text: () => text.content!.toString(),
+    // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
+    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: [yCollab(text.content as YText, provider?.awareness), modelState.init(() => model)],
+    awareness: provider?.awareness,
+    peer: identity
+      ? {
+          id: identity.identityKey.toHex(),
+          name: identity.profile?.displayName,
+        }
+      : undefined,
+  };
+
+  return model;
+};
+
+const createAutomergeModel = ({ identity, text }: UseTextModelProps): EditorModel => {
+  const obj = text as any as AutomergeTextCompat;
+  const doc = getRawDoc(obj, [obj.field]);
+
+  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: [automergePlugin(doc.handle, doc.path), modelState.init(() => model)],
     peer: identity
       ? {
           id: identity.identityKey.toHex(),
@@ -94,4 +152,6 @@ export const useTextModel = ({ identity, space, text }: UseTextModelOptions): Ed
         }
       : undefined,
   };
+
+  return model;
 };

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

@@ -12,10 +12,11 @@ import { ClientRepeater, textGenerator, useDataGenerator } from '@dxos/react-cli
 import { useId, Input } from '@dxos/react-ui';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { MarkdownEditor } from './TextEditor';
+import { MarkdownEditor } from '../../components';
 import { Replicator, useYjsModel } from '../../testing';
 
 export default {
+  title: 'react-ui-editor/YJS',
   component: MarkdownEditor,
   decorators: [withTheme],
 };

package/src/hooks/yjs/yjs.test.ts

@@ -0,0 +1,59 @@
+//
+// 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 { 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');
+    }
+  });
+
+  // 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/index.ts

@@ -4,6 +4,9 @@
 
 export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
 export { Doc, YText, YXmlFragment } from '@dxos/text-model';
+export { type Extension } from '@codemirror/state';
 
 export * from './components';
+export * from './extensions';
 export * from './hooks';
+export * from './themes';

package/src/styles/markdown.ts

@@ -6,41 +6,50 @@ import { mx } from '@dxos/react-ui-theme';
 
 export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
 
-export const heading: Record<HeadingLevel, string> = {
-  1: 'mbs-4 mbe-2 text-4xl font-semibold text-inherit no-underline',
-  2: 'mbs-4 mbe-2 text-3xl font-bold text-inherit no-underline',
-  3: 'mbs-4 mbe-2 text-2xl font-bold text-inherit no-underline',
-  4: 'mbs-4 mbe-2 text-xl font-extrabold text-inherit no-underline',
-  5: 'mbs-4 mbe-2 text-lg font-extrabold text-inherit no-underline',
-  6: 'mbs-4 mbe-2 font-black text-inherit no-underline',
+// TODO(burdon): Better way to align vertically than negative margin? Font-specific?
+// https://tailwindcss.com/docs/font-weight
+export const headings: Record<HeadingLevel, string[]> = {
+  1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-[10px]'],
+  2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-[8px]'],
+  3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-[7px]'],
+  4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[6px]'],
+  5: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-lg', '-ml-[5px]'],
+  6: ['mbs-4 mbe-2 font-medium text-inherit no-underline', '-ml-[4px]'],
 };
 
-export const blockquote = 'mlb-2 border-is-4 border-neutral-500/50 pis-5';
-
-// TODO(thure): Tailwind was not seeing `[&>li:before]:content-["•"]` as a utility class, but it would work if instead of `"•"` it was `"X"`… why?
-export const unorderedList =
-  'mlb-2 grid grid-cols-[min-content_1fr] [&>li:before]:content-[attr(marker)] [&>li:before]:mlb-1 [&>li:before]:mie-2';
-export const orderedList =
-  'mlb-2 grid grid-cols-[min-content_1fr]  [&>li:before]:content-[counters(section,_".")_"._"] [counter-reset:section] [&>li:before]:mlb-1';
+export const heading = (level: HeadingLevel, readonly?: boolean) => {
+  const [style, offset] = headings[level];
+  return mx(style, readonly && offset);
+};
 
-export const listItem = 'contents before:[counter-increment:section]';
+export const text = 'text-neutral-800 dark:text-neutral-200';
+export const light = 'text-neutral-200 dark:text-neutral-800';
 
-export const codeBlock = 'mlb-2 font-mono bg-neutral-500/10 p-3 rounded';
-
-export const horizontalRule = 'mlb-4 border-neutral-500/50';
+export const mark = mx('!font-normal !no-underline !text-inherit opacity-40', light);
 
 export const paragraph = 'mlb-1';
 
 export const bold = 'font-bold';
+export const italic = 'italic';
+export const strikethrough = 'line-through';
 
-export const code = 'font-mono bg-neutral-500/10 rounded pli-0.5 plb-0.5 -mlb-0.5';
+export const code = 'font-mono !no-underline text-neutral-700 dark:text-neutral-300';
+export const codeMark = 'font-mono text-primary-500';
+export const codeBlock = 'mlb-2 font-mono bg-neutral-500/10 p-3 rounded';
 
-export const placeholder = 'font-mono';
+export const inlineUrl = mx(code, 'px-1');
 
-export const codeWithoutMarks = mx(code, 'pli-1.5 mli-0.5');
+// TODO(burdon): Replace with widget.
+export const blockquote = mx('pl-1 mr-1 border-is-4 border-primary-500/70 dark:border-primary-500/30', light);
 
-export const italic = 'italic';
+// TODO(burdon): Replace with widget.
+export const horizontalRule =
+  'flex mlb-4 border-b text-neutral-100 dark:text-neutral-900 border-neutral-200 dark:border-neutral-800';
 
-export const strikethrough = 'line-through';
+// TODO(thure): Tailwind was not seeing `[&>li:before]:content-["•"]` as a utility class, but it would work if instead of `"•"` it was `"X"`… why?
+export const unorderedList =
+  'mlb-2 grid grid-cols-[min-content_1fr] [&>li:before]:content-[attr(marker)] [&>li:before]:mlb-1 [&>li:before]:mie-2';
+export const orderedList =
+  'mlb-2 grid grid-cols-[min-content_1fr] [&>li:before]:content-[counters(section,_".")_"._"] [counter-reset:section] [&>li:before]:mlb-1';
 
-export const mark = '!font-normal !no-underline !text-inherit opacity-40';
+export const listItem = 'contents before:[counter-increment:section]';

package/src/testing/replicator.ts

@@ -163,16 +163,17 @@ export class Replicator {
       colorLight: cursorColor.light,
     });
 
-    // TODO(burdon): Create concrete class that implements SyncModel?
+    const field = 'content';
+    const content = this._kind === TextKind.PLAIN ? doc.getText(field) : doc.getXmlFragment(field);
     const model: EditorModel = {
       id: doc.guid,
-      content: this._kind === TextKind.PLAIN ? doc.getText('content') : doc.getXmlFragment('content'),
-      provider,
+      text: () => content.toString(),
+      content,
+      awareness: provider.awareness,
       peer: { id },
     };
 
     this._peers.push(model);
-
     return model;
   };
 }
@@ -184,6 +185,5 @@ export type UseYjsModelOptions = {
 };
 
 export const useYjsModel = ({ replicator, id, doc }: UseYjsModelOptions): EditorModel => {
-  const peer = useMemo(() => replicator.createPeer(id, doc), [doc]);
-  return peer;
+  return useMemo(() => replicator.createPeer(id, doc), [doc]);
 };