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

package/src/extensions/tasklist.ts

@@ -2,58 +2,39 @@
 // Copyright 2023 DXOS.org
 //
 
-import {
-  EditorView,
-  Decoration,
-  WidgetType,
-  MatchDecorator,
-  ViewPlugin,
-  type DecorationSet,
-  type ViewUpdate,
-} from '@codemirror/view';
-
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-task-item': {
-    paddingLeft: '4px',
-    paddingRight: '8px',
-  },
-});
+import { syntaxTree } from '@codemirror/language';
+import { RangeSetBuilder } from '@codemirror/state';
+import { EditorView, Decoration, WidgetType, ViewPlugin, type DecorationSet, type ViewUpdate } from '@codemirror/view';
 
 class CheckboxWidget extends WidgetType {
-  constructor(
-    private readonly _pos: number,
-    private _checked: boolean,
-    private readonly _indent: number,
-    private readonly _onCheck?: (check: boolean) => void,
-  ) {
+  constructor(private _checked: boolean) {
     super();
   }
 
-  override eq(other: CheckboxWidget) {
-    return this._pos === other._pos && this._checked === other._checked && this._indent === other._indent;
+  override eq(other: this) {
+    return this._checked === other._checked;
   }
 
-  toDOM(view: EditorView) {
-    const wrap = document.createElement('span');
-    wrap.className = 'cm-task-item';
-    wrap.setAttribute('aria-hidden', 'true');
-    wrap.style.setProperty('margin-left', this._indent * 24 + 'px');
-
-    const input = wrap.appendChild(document.createElement('input'));
+  override toDOM(view: EditorView) {
+    const input = document.createElement('input');
     input.type = 'checkbox';
     input.checked = this._checked;
-    if (!this._onCheck) {
+    if (view.state.readOnly) {
       input.setAttribute('disabled', 'true');
-    }
-    if (this._onCheck) {
-      input.onchange = (event: Event) => {
-        this._onCheck?.((event.target as any).checked);
-        return true;
+    } else {
+      input.onmousedown = (event: Event) => {
+        const pos = view.posAtDOM(input);
+        const text = view.state.sliceDoc(pos, pos + 3);
+        if (text === (this._checked ? '[x]' : '[ ]')) {
+          view.dispatch({
+            changes: { from: pos + 1, to: pos + 2, insert: this._checked ? ' ' : 'x' },
+          });
+          event.preventDefault();
+        }
       };
     }
 
-    return wrap;
+    return input;
   }
 
   override ignoreEvent() {
@@ -61,61 +42,55 @@ class CheckboxWidget extends WidgetType {
   }
 }
 
+const checkedDeco = Decoration.replace({ widget: new CheckboxWidget(true) });
+const uncheckedDeco = Decoration.replace({ widget: new CheckboxWidget(false) });
+
 export type TasklistOptions = {};
 
 export const tasklist = (options: TasklistOptions = {}) => {
-  // TODO(burdon): Matcher isn't as precise as syntax tree.
-  //  Allows for indents to be greater than AST would allow.
-  const taskMatcher = new MatchDecorator({
-    regexp: /^(\s*)- \[([ xX])\]\s/g,
-    decoration: (match, view, pos) => {
-      const indent = Math.floor(match[1].length / 2);
-      const checked = match[2] === 'x' || match[2] === 'X';
-      return Decoration.replace({
-        widget: new CheckboxWidget(
-          pos,
-          checked,
-          indent,
-          view.state.readOnly
-            ? undefined
-            : (checked) => {
-                const idx = pos + match[0].indexOf('[') + 1;
-                view.dispatch({
-                  changes: {
-                    from: idx,
-                    to: idx + 1,
-                    insert: checked ? 'x' : ' ',
-                  },
-                  // TODO(burdon): Restore cursor position? More useful to move to end of line (can indent).
-                  selection: {
-                    anchor: idx + 3,
-                  },
-                });
-              },
-        ),
-      });
-    },
-  });
-
-  const tasks = ViewPlugin.fromClass(
+  return ViewPlugin.fromClass(
     class {
-      tasks: DecorationSet;
+      decorations: DecorationSet;
+
       constructor(view: EditorView) {
-        this.tasks = taskMatcher.createDeco(view);
+        this.decorations = buildDecorations(view);
       }
 
       update(update: ViewUpdate) {
-        this.tasks = taskMatcher.updateDeco(update, this.tasks);
+        if (update.docChanged || update.viewportChanged || update.selectionSet) {
+          this.decorations = buildDecorations(update.view);
+        }
       }
     },
     {
-      decorations: (value) => value.tasks,
+      decorations: (v) => v.decorations,
+      // TODO(burdon): Is this still required?
       provide: (plugin) =>
         EditorView.atomicRanges.of((view) => {
-          return view.plugin(plugin)?.tasks || Decoration.none;
+          return view.plugin(plugin)?.decorations || Decoration.none;
         }),
     },
   );
+};
+
+const buildDecorations = (view: EditorView): DecorationSet => {
+  const builder = new RangeSetBuilder<Decoration>();
+  const { state } = view;
+  const cursor = state.selection.main.head;
+
+  for (const { from, to } of view.visibleRanges) {
+    syntaxTree(state).iterate({
+      enter: (node) => {
+        // Check if cursor is inside text.
+        if (node.name === 'TaskMarker' && (cursor < node.from || cursor > node.to)) {
+          const checked = state.doc.sliceString(node.from + 1, node.to - 1) === 'x';
+          builder.add(node.from, node.to, checked ? checkedDeco : uncheckedDeco);
+        }
+      },
+      from,
+      to,
+    });
+  }
 
-  return [tasks, styles];
+  return builder.finish();
 };

package/src/extensions/yjs/cursor.ts

@@ -6,12 +6,13 @@ import * as Y from 'yjs';
 
 import { arrayToString, stringToArray } from '@dxos/util';
 
-import { type CursorConverter } from '../../util';
+import { type CursorConverter } from '../cursor';
 
 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 ??

package/src/extensions/yjs/yjs.test.ts

@@ -12,7 +12,7 @@ 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', () => {
+  test.skip('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));

package/src/extensions/yjs/yjs.ts

@@ -8,9 +8,9 @@ import type * as YP from 'y-protocols/awareness';
 import type { YText } from '@dxos/text-model';
 
 import { cursorConverter } from './cursor';
-import { CursorConverter } from '../../util';
+import { Cursor } from '../cursor';
 
 export const yjs = (content: YText, awareness?: YP.Awareness) => [
-  CursorConverter.of(cursorConverter(content)),
+  Cursor.converter.of(cursorConverter(content)),
   yCollab(content, awareness),
 ];

package/src/hooks/automerge.ts

@@ -8,7 +8,8 @@ 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 { type EditorModel, modelState } from './defs';
+import { type UseTextModelProps } from './useTextModel';
 import { automerge, awareness, AwarenessProvider } from '../extensions';
 import { cursorColor } from '../styles';
 

package/src/hooks/defs.ts

@@ -0,0 +1,47 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Extension, StateField } from '@codemirror/state';
+import type * as YP from 'y-protocols/awareness';
+
+import { type DocAccessor } from '@dxos/echo-schema';
+import type { YText, YXmlFragment } from '@dxos/text-model';
+
+// 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 | YText | YXmlFragment | DocAccessor;
+
+  // TODO(burdon): Move into extension.
+  awareness?: YP.Awareness;
+
+  // 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

@@ -4,5 +4,7 @@
 
 export * from './automerge';
 export * from './awareness-provider';
-export * from './useTextModel';
+export * from './defs';
 export * from './yjs';
+
+export * from './useTextModel';

package/src/hooks/useTextModel.ts

@@ -2,59 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import { StateField, type Extension } from '@codemirror/state';
 import { useEffect, useState } from 'react';
-import type * as YP from 'y-protocols/awareness';
 
-import { isAutomergeObject, type DocAccessor, type Space, type TextObject } 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 { createAutomergeModel } from './automerge';
+import { type EditorModel } from './defs';
 import { createYjsModel } from './yjs';
 
-// 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;
-  /**
-   * @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;
-  };
-};
-
 // TODO(burdon): Remove space/identity dependency. Define interface for the framework re content and presence.
 export type UseTextModelProps = {
   identity?: Identity | null;
@@ -62,11 +18,9 @@ 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;
 };

package/src/hooks/yjs.ts

@@ -6,7 +6,6 @@ import * as decoding from 'lib0/decoding';
 import * as encoding from 'lib0/encoding';
 import { Observable } from 'lib0/observable';
 import * as YP from 'y-protocols/awareness';
-import * as Y from 'yjs';
 import { type Doc } from 'yjs';
 
 import { invariant } from '@dxos/invariant';
@@ -14,9 +13,9 @@ import { log } from '@dxos/log';
 import { type Space } from '@dxos/react-client/echo';
 import { type GossipMessage } from '@dxos/react-client/mesh';
 import type { YText } from '@dxos/text-model';
-import { arrayToString, stringToArray } from '@dxos/util';
 
-import { type EditorModel, modelState, type Range, type UseTextModelProps } from './useTextModel';
+import { type EditorModel, modelState } from './defs';
+import { type UseTextModelProps } from './useTextModel';
 import { yjs } from '../extensions';
 
 export const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
@@ -29,26 +28,6 @@ export const createYjsModel = ({ identity, space, text }: UseTextModelProps): Ed
     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

package/src/index.ts

@@ -5,8 +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/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);