@dxos/react-ui-editor 0.3.11-main.baa8c4d → 0.3.11-main.bc6b68b

package/src/hooks/awareness-provider.ts

@@ -0,0 +1,124 @@
+//
+// 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;
+};
+
+/**
+ * Receives and broadcasts profile and cursor position.
+ */
+export class SpaceAwarenessProvider implements AwarenessProvider {
+  private readonly _remoteStates = new Map<string, AwarenessState>();
+
+  private readonly _space: Space;
+  private readonly _channel: string;
+  private readonly _peerId: string;
+  private readonly _info: AwarenessInfo;
+
+  private _ctx?: Context;
+  private _postTask?: DeferredTask;
+  private _localState?: AwarenessState;
+
+  public readonly remoteStateChange = new Event<void>();
+
+  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);
+      }
+    });
+
+    this._ctx.onDispose(
+      this._space.listen(this._channel, (message: GossipMessage) => {
+        switch (message.payload.kind) {
+          case 'query': {
+            this._handleQueryMessage();
+            break;
+          }
+          case 'post': {
+            this._handlePostMessage(message.payload);
+            break;
+          }
+        }
+      }),
+    );
+
+    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;
+  }
+
+  getRemoteStates(): AwarenessState[] {
+    return Array.from(this._remoteStates.values());
+  }
+
+  update(position: AwarenessPosition | undefined): void {
+    invariant(this._postTask);
+    this._localState = {
+      peerId: this._peerId,
+      position,
+      info: this._info,
+    };
+
+    this._postTask.schedule();
+  }
+
+  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/defs.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Extension, StateField } from '@codemirror/state';
+
+import { type DocAccessor } from '@dxos/echo-schema';
+
+// Runtime data structure.
+export type Range = {
+  from: number;
+  to: number;
+};
+
+// Persistent data structure.
+export type Comment = {
+  id: string;
+  cursor?: string;
+};
+
+export type EditorModel = {
+  id: string;
+  text: () => string;
+  extension?: Extension;
+
+  // TODO(burdon): Remove.
+  content: string | DocAccessor;
+
+  // TODO(burdon): Remove.
+  peer?: {
+    id: string;
+    name?: string;
+  };
+};
+
+/**
+ * State field makes the model available to other extensions.
+ */
+export const modelState = StateField.define<EditorModel | undefined>({
+  create: () => undefined,
+  update: (model) => model,
+});

package/src/hooks/index.ts

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

package/src/hooks/useTextEditor.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type EditorView } from '@codemirror/view';
+import { type RefCallback, useState } from 'react';
+
+/**
+ * Hook for accessing the editor view.
+ *
+ * ```tsx
+ * const Test = () => {
+ *   const [editorRef, editorView] = useTextEditor();
+ *   useEffect(() => {
+ *     editorView?.focus();
+ *   }, [editorView]);
+ *   return <TextEditor ref={editorRef} />;
+ * };
+ * ```
+ */
+export const useTextEditor = (): [RefCallback<EditorView | null>, EditorView | null] => {
+  const [view, setView] = useState<EditorView | null>(null);
+  return [
+    (ref: EditorView | null) => {
+      setView(ref);
+    },
+    view,
+  ];
+};

package/src/hooks/useTextModel.ts

@@ -2,67 +2,20 @@
 // Copyright 2023 DXOS.org
 //
 
-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 { generateName } from '@dxos/display-name';
+import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
-import {
-  type DocAccessor,
-  type Space,
-  type TextObject,
-  type AutomergeTextCompat,
-  getRawDoc,
-  isActualAutomergeObject,
-} from '@dxos/react-client/echo';
+import { isAutomergeObject, 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 { arrayToString, stringToArray } from '@dxos/util';
+import { isNotNullOrUndefined } from '@dxos/util';
 
-import { automergePlugin } from './automerge';
-import { SpaceAwarenessProvider } from './yjs';
-
-// TODO(burdon): Move.
-type Awareness = awarenessProtocol.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;
-  text: () => string;
-  getCursorFromRange?: (value: Range) => string;
-  getRangeFromCursor?: (cursor: string) => Range;
-  extension?: Extension;
-  awareness?: Awareness;
-  peer?: {
-    id: string;
-    name?: string;
-  };
-};
+import { SpaceAwarenessProvider } from './awareness-provider';
+import { type EditorModel, modelState } from './defs';
+import { automerge, awareness, AwarenessProvider } from '../extensions';
+import { cursorColor } from '../styles';
 
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
 export type UseTextModelProps = {
@@ -71,79 +24,41 @@ export type UseTextModelProps = {
   text?: TextObject;
 };
 
-// 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 = (props: UseTextModelProps): EditorModel | undefined => {
   const { identity, space, text } = props;
-  const [model, setModel] = useState<EditorModel | undefined>(() => createModel(props));
+  const [model, setModel] = useState<EditorModel | undefined>();
   useEffect(() => setModel(createModel(props)), [identity, space, text]);
   return model;
 };
 
-const createModel = (props: UseTextModelProps) => {
-  const { text } = props;
-  if (isActualAutomergeObject(text)) {
-    return createAutomergeModel(props);
-  } else {
-    if (!text?.doc) {
-      return undefined;
-    }
-
-    return createYjsModel(props);
-  }
-};
-
-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;
-
-  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
-    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) => {
-      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: from!.index, to: to!.index };
-    },
-    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 createModel = ({ space, identity, text }: UseTextModelProps) => {
+  invariant(isAutomergeObject(text));
   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 ? identity.profile?.displayName ?? generateName(identity.identityKey.toHex()) : undefined,
+        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: [automergePlugin(doc.handle, doc.path), modelState.init(() => model)],
+    extension: [
+      modelState.init(() => model),
+      automerge({ handle: doc.handle, path: doc.path }),
+      awarenessProvider && AwarenessProvider.of(awarenessProvider),
+      awareness(),
+    ].filter(isNotNullOrUndefined),
     peer: identity
       ? {
           id: identity.identityKey.toHex(),

package/src/index.ts

@@ -5,6 +5,11 @@
 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 { type EditorView } from '@codemirror/view';
 
 export * from './components';
+export * from './extensions';
 export * from './hooks';
+export { getToken } from './styles';
+export * from './themes';
+export * from './util';

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

@@ -39,10 +39,8 @@ export const codeBlock = 'mlb-2 font-mono bg-neutral-500/10 p-3 rounded';
 
 export const inlineUrl = mx(code, 'px-1');
 
-// 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);
 
-// 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';
 

package/src/styles/tokens.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+import get from 'lodash.get';
 import type { StyleSpec } from 'style-mod';
 
 import { tailwindConfig, type TailwindConfig } from '@dxos/react-ui-theme';
@@ -12,3 +13,5 @@ export type ThemeStyles = {
 
 // TODO(thure): Why export the whole theme? Can this be done differently?
 export const tokens: TailwindConfig['theme'] = tailwindConfig({}).theme;
+
+export const getToken = (path: string, defaultValue: any = undefined) => get(tokens, path, defaultValue);

package/src/{components/TextEditor/themes → themes}/default.ts

@@ -4,10 +4,10 @@
 
 import get from 'lodash.get';
 
-import { type ThemeStyles, tokens } from '../../../styles';
+import { type ThemeStyles, tokens } from '../styles';
 
-// TODO(burdon): Can we erase All of the default CM styles?
-// TODO(burdon): Theme styles seem to be added multiple times?
+// TODO(burdon): Can we use @apply and import css file?
+//  https://tailwindcss.com/docs/reusing-styles#extracting-classes-with-apply?
 
 /**
  * Minimal styles.
@@ -49,12 +49,12 @@ export const defaultTheme: ThemeStyles = {
   '&.cm-focused': {
     outline: 'none',
   },
-  '& .cm-scroller': {
+  '.cm-scroller': {
     overflow: 'visible',
     fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
   },
 
-  '& .cm-content': {
+  '.cm-content': {
     padding: 0,
     // NOTE: Base font size (otherwise defined by HTML tag, which might be different for storybook).
     fontSize: '16px',
@@ -77,17 +77,19 @@ export const defaultTheme: ThemeStyles = {
   '&dark .cm-cursor, &dark .cm-dropCursor': {
     borderLeft: '2px solid white',
   },
-  '& .cm-placeholder': {
+  '.cm-placeholder': {
     fontWeight: 100,
   },
 
   //
   // line
   //
-  '& .cm-line': {
+  '.cm-line': {
     paddingInline: 0,
+    // TODO(burdon): Other values leave gaps between lines when highlighted.
+    // lineHeight: 'normal',
   },
-  '& .cm-activeLine': {
+  '.cm-activeLine': {
     background: 'inherit',
   },
 
@@ -119,40 +121,10 @@ export const defaultTheme: ThemeStyles = {
     backgroundColor: get(tokens, 'extend.colors.yellow.700'),
   },
 
-  //
-  // collaboration
-  // TODO(burdon): Review classnames (YJS dependent?) Note: e2e tests depend on this class.
-  //
-
-  '&light .cm-ySelection, &light .cm-yLineSelection': {
-    mixBlendMode: 'multiply',
-  },
-  '&dark .cm-ySelection, &dark .cm-yLineSelection': {
-    mixBlendMode: 'screen',
-  },
-
-  '& .cm-ySelectionInfo': {
-    padding: '2px 4px',
-    marginBlockStart: '-4px',
-  },
-  '& .cm-ySelection, & .cm-selectionMatch': {
-    paddingBlockStart: '.15em',
-    paddingBlockEnd: '.15em',
-  },
-  '& .cm-ySelectionCaret': {
-    display: 'inline-block',
-    insetBlockStart: '.1em',
-    blockSize: '1.4em',
-    verticalAlign: 'top',
-  },
-  '& .cm-yLineSelection': {
-    margin: 0,
-  },
-
   //
   // link
   //
-  '& .cm-link': {
+  '.cm-link': {
     color: get(tokens, 'extend.colors.primary.500'),
     textDecorationLine: 'underline',
     textDecorationThickness: '1px',
@@ -164,75 +136,74 @@ export const defaultTheme: ThemeStyles = {
   //
   // tooltip
   //
-  '& .cm-tooltip': {
+  '.cm-tooltip': {
     border: 'none',
   },
-  '& .cm-tooltip-below': {},
+  '.cm-tooltip-below': {},
 
   //
   // autocomplete
   //
-  '& .cm-tooltip-autocomplete': {
+  '.cm-tooltip-autocomplete': {
     marginTop: '4px',
     marginLeft: '-3px',
   },
-  '& .cm-tooltip-autocomplete ul li': {},
-  '& .cm-tooltip-autocomplete ul li[aria-selected]': {},
-  '& .cm-completionIcon': {
+  '.cm-tooltip-autocomplete ul li': {},
+  '.cm-tooltip-autocomplete ul li[aria-selected]': {},
+  '.cm-completionIcon': {
     display: 'none',
   },
-  '& .cm-completionLabel': {
+  '.cm-completionLabel': {
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },
-  '& .cm-completionMatchedText': {
+  '.cm-completionMatchedText': {
     textDecoration: 'none',
   },
 
-  //
-  // widgets
-  //
-  '& .cm-widgetBuffer': {
-    display: 'none',
-    height: 0,
-  },
-
   //
   // table
   //
-  '& .cm-table *': {
+  '.cm-table *': {
     fontFamily: `${get(tokens, 'fontFamily.mono', []).join(',')} !important`,
     textDecoration: 'none !important',
   },
-  '& .cm-table-head': {
+  '.cm-table-head': {
     padding: '2px 16px 2px 0px',
     borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.500')}`,
     fontWeight: 100,
     textAlign: 'left',
     color: get(tokens, 'extend.colors.neutral.500'),
   },
-  '& .cm-table-cell': {
+  '.cm-table-cell': {
     padding: '2px 16px 2px 0px',
   },
 
   //
   // image
   //
-  '& .cm-image': {
-    margin: '0.5rem 0',
+  '.cm-image': {
+    display: 'block',
+    height: '0',
+  },
+  '.cm-image.cm-loaded-image': {
+    height: 'auto',
+    borderTop: '0.5rem solid transparent',
+    borderBottom: '0.5rem solid transparent',
   },
 
   //
   // font size
-  // TODO(thure): This appears to be the best or only way to set selection caret heights, but it's far more verbose than it needs to be.
+  // TODO(thure): This appears to be the best or only way to set selection caret heights,
+  //  but it's far more verbose than it needs to be.
   //
-  ...Object.keys(get(tokens, 'extend.fontSize', {})).reduce((acc: Record<string, any>, fontSize) => {
-    const height = get(tokens, ['extend', 'fontSize', fontSize, 1, 'lineHeight']);
-
-    acc[`& .text-${fontSize} + .cm-ySelectionCaret`] = { height };
-    acc[`& .text-${fontSize} + .cm-ySelection + .cm-ySelectionCaret`] = { height };
-    acc[`& .text-${fontSize} + .cm-widgetBuffer + .cm-ySelectionCaret`] = { height };
-    return acc;
-  }, {}),
+  // ...Object.keys(get(tokens, 'extend.fontSize', {})).reduce((acc: Record<string, any>, fontSize) => {
+  //   const height = get(tokens, ['extend', 'fontSize', fontSize, 1, 'lineHeight']);
+  //
+  //   acc[`& .text-${fontSize} + .cm-ySelectionCaret`] = { height };
+  //   acc[`& .text-${fontSize} + .cm-ySelection + .cm-ySelectionCaret`] = { height };
+  //   acc[`& .text-${fontSize} + .cm-widgetBuffer + .cm-ySelectionCaret`] = { height };
+  //   return acc;
+  // }, {}),
 
   /**
    * Panels
@@ -250,14 +221,14 @@ export const defaultTheme: ThemeStyles = {
    *   </div>
    * </div
    */
-  '& .cm-panels': {
+  '.cm-panels': {
     border: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
   },
-  '& .cm-panel': {
+  '.cm-panel': {
     background: get(tokens, 'extend.colors.neutral.50'),
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },
-  '& .cm-button': {
+  '.cm-button': {
     margin: '4px',
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
     background: get(tokens, 'extend.colors.neutral.100'),
@@ -271,32 +242,34 @@ export const defaultTheme: ThemeStyles = {
       backgroundImage: 'none',
     },
   },
-  '& .cm-panel input[type=checkbox]': {
+  '.cm-panel input[type=checkbox]': {
     marginRight: '0.4rem !important',
   },
 };
 
 export const textTheme: ThemeStyles = {
-  '& .cm-scroller': {
+  '.cm-scroller': {
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },
-  '& .cm-placeholder': {
+  '.cm-placeholder': {
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },
 };
 
 export const markdownTheme: ThemeStyles = {
-  // NOTE: Must leave base font family as is (i.e., monospace) due to fenced code blocks.
-  '& .cm-placeholder': {
+  '.cm-scroller': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '.cm-placeholder': {
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },
 };
 
 export const codeTheme: ThemeStyles = {
-  '& .cm-scroller': {
+  '.cm-scroller': {
     fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
   },
-  '& .cm-placeholder': {
+  '.cm-placeholder': {
     fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
   },
 };