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

package/src/hooks/useTextModel.ts

@@ -2,96 +2,82 @@
 // Copyright 2023 DXOS.org
 //
 
-import { useMemo } from 'react';
-import type * as awarenessProtocol from 'y-protocols/awareness';
+import { StateField, type Extension } from '@codemirror/state';
+import { useEffect, useState } from 'react';
+import type * as YP from 'y-protocols/awareness';
 
-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 { SpaceAwarenessProvider } from './yjs';
+import { createAutomergeModel } from './automerge';
+import { createYjsModel } from './yjs';
 
-// TODO(burdon): Move.
-type Awareness = awarenessProtocol.Awareness;
-type Provider = { awareness: Awareness };
+// TODO(burdon): Factor out defs.
+
+/**
+ * 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;
+  text: () => string;
+  extension?: Extension;
+
+  // TODO(burdon): Remove.
   content: string | YText | YXmlFragment | DocAccessor;
-  provider?: Provider;
+  /**
+   * @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;
   };
 };
 
-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;
-    }
-
-    if (!space || !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,
-    };
-  }
+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 (!text?.doc || !text?.content) {
+const createModel = (props: UseTextModelProps) => {
+  const { text } = props;
+  if (isAutomergeObject(text)) {
+    return createAutomergeModel(props);
+  } else if (text?.doc) {
+    return createYjsModel(props);
+  } else {
     return undefined;
   }
-
-  return {
-    id: text.doc.guid,
-    content: text.content,
-    provider,
-    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');
   }
 }

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/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './cursors';
 export * from './markdown';
 export * from './tokens';

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

@@ -7,7 +7,7 @@ import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import { Observable } from 'lib0/observable';
 import { useMemo } from 'react';
-import * as awarenessProtocol from 'y-protocols/awareness';
+import * as YP from 'y-protocols/awareness';
 import * as syncProtocol from 'y-protocols/sync';
 import { Doc } from 'yjs';
 
@@ -15,9 +15,10 @@ import { Event } from '@dxos/async';
 import { log } from '@dxos/log';
 import { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
 
-import { cursorColor, type EditorModel } from '../hooks';
+import { type EditorModel } from '../hooks';
+import { cursorColor } from '../styles';
 
-type Awareness = awarenessProtocol.Awareness;
+type Awareness = YP.Awareness;
 
 const messageSync = 0;
 const messageAwareness = 1;
@@ -35,7 +36,7 @@ export class AwarenessProvider extends Observable<any> {
     super();
     this._remoteUpdate = update;
     this._doc = doc;
-    this._awareness = awareness ?? new awarenessProtocol.Awareness(doc);
+    this._awareness = awareness ?? new YP.Awareness(doc);
 
     this._doc.on('update', this._handleDocUpdate.bind(this));
     this._awareness.on('update', this._handleAwarenessUpdate.bind(this));
@@ -55,10 +56,7 @@ export class AwarenessProvider extends Observable<any> {
     // Post local awareness state.
     const encoderAwarenessState = encoding.createEncoder();
     encoding.writeVarUint(encoderAwarenessState, messageAwareness);
-    encoding.writeVarUint8Array(
-      encoderAwarenessState,
-      awarenessProtocol.encodeAwarenessUpdate(this.awareness, [this._doc.clientID]),
-    );
+    encoding.writeVarUint8Array(encoderAwarenessState, YP.encodeAwarenessUpdate(this.awareness, [this._doc.clientID]));
     void this._remoteUpdate.emit(encoding.toUint8Array(encoderAwarenessState));
   }
 
@@ -79,10 +77,7 @@ export class AwarenessProvider 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));
     this._remoteUpdate.emit(encoding.toUint8Array(encoderAwareness));
   }
 
@@ -109,7 +104,7 @@ export class AwarenessProvider extends Observable<any> {
       }
 
       case messageAwareness: {
-        awarenessProtocol.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
+        YP.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
         break;
       }
 
@@ -117,7 +112,7 @@ export class AwarenessProvider 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;
@@ -138,7 +133,7 @@ export class AwarenessProvider extends Observable<any> {
   }
 
   private _handleBeforeUnload() {
-    awarenessProtocol.removeAwarenessStates(this._awareness, [this._doc.clientID], 'window unload');
+    YP.removeAwarenessStates(this._awareness, [this._doc.clientID], 'window unload');
   }
 }
 
@@ -163,16 +158,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 +180,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]);
 };