@dxos/react-ui-editor 0.3.11-main.8a2cfe6 → 0.3.11-main.8a9dd1e

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

@@ -30,7 +30,7 @@ export type Range = {
 
 export type CommentRange = {
   id: string;
-  cursor: string;
+  cursor: string; // TODO(burdon): Rename range.
 };
 
 // TODO(wittjosiah): Factor out to common package? @dxos/react-client?
@@ -41,13 +41,10 @@ export type EditorModel = {
 
   // 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;
@@ -66,7 +63,7 @@ export type UseTextModelProps = {
 // 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,8 @@ 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, type UseTextModelProps } from './useTextModel';
 import { yjs } from '../extensions';
 
 export const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
@@ -29,26 +27,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,9 +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/themes/default.ts

@@ -6,8 +6,8 @@ import get from 'lodash.get';
 
 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.
@@ -86,6 +86,8 @@ export const defaultTheme: ThemeStyles = {
   //
   '.cm-line': {
     paddingInline: 0,
+    // TODO(burdon): Other values leave gaps between lines when highlighted.
+    // lineHeight: 'normal',
   },
   '.cm-activeLine': {
     background: 'inherit',
@@ -119,36 +121,6 @@ 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
   //
@@ -188,14 +160,6 @@ export const defaultTheme: ThemeStyles = {
     textDecoration: 'none',
   },
 
-  //
-  // widgets
-  //
-  '.cm-widgetBuffer': {
-    display: 'none',
-    height: 0,
-  },
-
   //
   // table
   //
@@ -229,16 +193,17 @@ export const defaultTheme: ThemeStyles = {
 
   //
   // 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
@@ -292,7 +257,9 @@ export const textTheme: ThemeStyles = {
 };
 
 export const markdownTheme: ThemeStyles = {
-  // NOTE: Must leave base font family as is (i.e., monospace) due to fenced code blocks.
+  '.cm-scroller': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
   '.cm-placeholder': {
     fontFamily: get(tokens, 'fontFamily.body', []).join(','),
   },

package/dist/types/src/util/cursor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../../src/util/cursor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC;IAC/D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;CACpC;AAOD,eAAO,MAAM,eAAe,yCAE1B,CAAC"}

package/dist/types/src/util/index.d.ts

@@ -1,3 +0,0 @@
-export * from './cursor';
-export * from './util';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/util/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}

package/dist/types/src/util/util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/util/util.ts"],"names":[],"mappings":"AAMA;;GAEG;AAEH,eAAO,MAAM,eAAe,kCAOR,CAAC"}

package/src/util/cursor.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Facet } from '@codemirror/state';
-
-/**
- * Converts indexes into the text document into stable peer-independent cursors.
- *
- * See:
- *  - https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
- *  - https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
- *
- * @param {assoc} number Negative values will associate the cursor with the previous character
- *                       while positive - with the next one.
- */
-export interface CursorConverter {
-  toCursor(position: number, assoc?: -1 | 1 | undefined): string;
-  fromCursor(cursor: string): number;
-}
-
-const DEFAULT_CURSOR_CONVERTER: CursorConverter = {
-  toCursor: (position) => position.toString(),
-  fromCursor: (cursor) => parseInt(cursor),
-};
-
-export const CursorConverter = Facet.define<CursorConverter, CursorConverter>({
-  combine: (providers) => providers[0] ?? DEFAULT_CURSOR_CONVERTER,
-});

package/src/util/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './cursor';
-export * from './util';