@dxos/ui-editor 0.8.4-main.9be5663bfe → 0.8.4-main.bc2380dfbc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/ui-editor",
-  "version": "0.8.4-main.9be5663bfe",
+  "version": "0.8.4-main.bc2380dfbc",
   "description": "Text editor components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/dxos/dxos"
   },
-  "license": "MIT",
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": false,
   "type": "module",
@@ -27,15 +27,12 @@
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@automerge/automerge": "3.2.3",
+    "@automerge/automerge": "3.2.6",
     "@codemirror/autocomplete": "^6.19.0",
     "@codemirror/commands": "^6.8.1",
     "@codemirror/lang-html": "^6.4.11",
@@ -50,7 +47,7 @@
     "@codemirror/search": "^6.5.11",
     "@codemirror/state": "^6.5.2",
     "@codemirror/theme-one-dark": "^6.1.3",
-    "@codemirror/view": "^6.38.4",
+    "@codemirror/view": "^6.38.5",
     "@lezer/common": "^1.2.2",
     "@lezer/generator": "^1.7.1",
     "@lezer/highlight": "^1.2.1",
@@ -65,27 +62,27 @@
     "lodash.merge": "^4.6.2",
     "lodash.sortby": "^4.7.0",
     "style-mod": "^4.1.0",
-    "@dxos/context": "0.8.4-main.9be5663bfe",
-    "@dxos/app-graph": "0.8.4-main.9be5663bfe",
-    "@dxos/debug": "0.8.4-main.9be5663bfe",
-    "@dxos/client": "0.8.4-main.9be5663bfe",
-    "@dxos/display-name": "0.8.4-main.9be5663bfe",
-    "@dxos/echo": "0.8.4-main.9be5663bfe",
-    "@dxos/echo-db": "0.8.4-main.9be5663bfe",
-    "@dxos/invariant": "0.8.4-main.9be5663bfe",
-    "@dxos/async": "0.8.4-main.9be5663bfe",
-    "@dxos/lit-ui": "0.8.4-main.9be5663bfe",
-    "@dxos/ui": "0.8.4-main.9be5663bfe",
-    "@dxos/ui-theme": "0.8.4-main.9be5663bfe",
-    "@dxos/protocols": "0.8.4-main.9be5663bfe",
-    "@dxos/util": "0.8.4-main.9be5663bfe",
-    "@dxos/log": "0.8.4-main.9be5663bfe",
-    "@dxos/ui-types": "0.8.4-main.9be5663bfe"
+    "@dxos/app-graph": "0.8.4-main.bc2380dfbc",
+    "@dxos/async": "0.8.4-main.bc2380dfbc",
+    "@dxos/client": "0.8.4-main.bc2380dfbc",
+    "@dxos/debug": "0.8.4-main.bc2380dfbc",
+    "@dxos/context": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo": "0.8.4-main.bc2380dfbc",
+    "@dxos/display-name": "0.8.4-main.bc2380dfbc",
+    "@dxos/invariant": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo-db": "0.8.4-main.bc2380dfbc",
+    "@dxos/log": "0.8.4-main.bc2380dfbc",
+    "@dxos/lit-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/protocols": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-types": "0.8.4-main.bc2380dfbc",
+    "@dxos/util": "0.8.4-main.bc2380dfbc"
   },
   "devDependencies": {
-    "@automerge/automerge": "3.2.3",
-    "@automerge/automerge-repo": "2.5.1",
-    "@automerge/automerge-repo-network-broadcastchannel": "2.5.1",
+    "@automerge/automerge": "3.2.6",
+    "@automerge/automerge-repo": "2.6.0-subduction.17",
+    "@automerge/automerge-repo-network-broadcastchannel": "2.6.0-subduction.17",
     "@effect/platform": "0.94.4",
     "@types/chai": "^4.2.15",
     "@types/chai-dom": "^1.11.0",
@@ -98,21 +95,21 @@
     "happy-dom": "^20.0.0",
     "jsdom": "^27.0.0",
     "mocha": "^10.6.0",
-    "vite": "^7.1.11",
+    "vite": "^8.0.13",
     "vite-plugin-top-level-await": "^1.6.0",
-    "vite-plugin-wasm": "^3.5.0",
-    "@dxos/echo": "0.8.4-main.9be5663bfe",
-    "@dxos/keyboard": "0.8.4-main.9be5663bfe",
-    "@dxos/config": "0.8.4-main.9be5663bfe",
-    "@dxos/schema": "0.8.4-main.9be5663bfe",
-    "@dxos/storybook-utils": "0.8.4-main.9be5663bfe",
-    "@dxos/ui-theme": "0.8.4-main.9be5663bfe",
-    "@dxos/random": "0.8.4-main.9be5663bfe"
+    "vite-plugin-wasm": "^3.6.0",
+    "@dxos/echo": "0.8.4-main.bc2380dfbc",
+    "@dxos/config": "0.8.4-main.bc2380dfbc",
+    "@dxos/random": "0.8.4-main.bc2380dfbc",
+    "@dxos/schema": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc",
+    "@dxos/keyboard": "0.8.4-main.bc2380dfbc",
+    "@dxos/storybook-utils": "0.8.4-main.bc2380dfbc"
   },
   "peerDependencies": {
     "@effect/platform": "0.94.4",
     "effect": "3.20.0",
-    "@dxos/ui-theme": "0.8.4-main.9be5663bfe"
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc"
   },
   "publishConfig": {
     "access": "public"

package/src/defaults.ts

@@ -22,8 +22,11 @@ export const documentSlots: ThemeExtensionsOptions['slots'] = {
      * NOTE: Max width - 4rem = 2rem left/right margin (or 2rem gutter plus 1rem left/right margin).
      */
     className: mx(
-      // NOTE: Container for widget sizing (must have `max-w-[100cqi]`).
-      'dx-size-container',
+      // Inline-size container for widget sizing (children use `max-w-[100cqi]`).
+      // NOTE: Use inline-size, not full size containment — `container-type: size` on the
+      // editor content breaks CodeMirror's viewport measurement, leaving blank gaps during
+      // scroll until a click forces a re-measure.
+      'dx-inline-size-container',
       // Wider margin for web (vs. mobile).
       'pointer-fine:max-w-[min(50rem,100%-4rem)] pointer-coarse:max-w-[min(50rem,100%-2rem)]',
       'mx-auto! w-full',
@@ -33,6 +36,12 @@ export const documentSlots: ThemeExtensionsOptions['slots'] = {
 
 export const compactSlots: ThemeExtensionsOptions['slots'] = {
   content: {
-    className: 'mx-2! w-full',
+    className: 'mx-2!',
+  },
+};
+
+export const mobileSlots: ThemeExtensionsOptions['slots'] = {
+  content: {
+    className: 'mx-2!',
   },
 };

package/src/extensions/autocomplete/placeholder.ts

@@ -13,42 +13,61 @@ type Content = string | HTMLElement | ((view: EditorView) => HTMLElement);
 export type PlaceholderOptions = {
   content: Content;
   delay?: number;
+  focusOnly?: boolean;
 };
 
 /**
- * Shows a transient placeholder at the current cursor position.
+ * Shows a transient placeholder at the current cursor position. When
+ * `focusOnly` is set the placeholder is suppressed unless the editor has DOM
+ * focus, and is hidden again when focus is lost.
  */
-export const placeholder = ({ content, delay = 3_000 }: PlaceholderOptions): Extension => {
+export const placeholder = ({ content, delay = 3_000, focusOnly = false }: PlaceholderOptions): Extension => {
   const plugin = ViewPlugin.fromClass(
     class {
       _timeout: ReturnType<typeof setTimeout> | undefined;
       _decorations = Decoration.none;
 
       update(update: ViewUpdate) {
+        // React to actual user activity only. The empty `view.update([])`
+        // dispatched from the timeout below carries no doc/selection/focus
+        // change, so it falls through here as a no-op — that's how the
+        // freshly-set widget survives long enough for the decoration
+        // provider to read it. Without this gate, the unconditional reset
+        // would clobber the decoration in the same tick and the placeholder
+        // would never visibly render.
+        if (!update.docChanged && !update.selectionSet && !update.focusChanged) {
+          return;
+        }
+
         if (this._timeout) {
           window.clearTimeout(this._timeout);
           this._timeout = undefined;
         }
+        this._decorations = Decoration.none;
+
+        // Honour `focusOnly`: when the option is set and the editor isn't
+        // focused, leave the placeholder hidden and skip rescheduling. The
+        // next `focusChanged` update reschedules once focus returns.
+        if (focusOnly && !update.view.hasFocus) {
+          return;
+        }
 
-        // Check if the active line (where cursor is) is empty.
         const activeLine = update.view.state.doc.lineAt(update.view.state.selection.main.head);
-        const isEmpty = activeLine.text.trim() === '';
-        if (isEmpty) {
-          // Create widget decoration at the start of the current line.
-          const lineStart = activeLine.from;
-          this._timeout = setTimeout(() => {
-            this._decorations = Decoration.set([
-              Decoration.widget({
-                widget: new PlaceholderWidget(content),
-                side: 1,
-              }).range(lineStart),
-            ]);
-
-            update.view.update([]);
-          }, delay);
+        if (activeLine.text.trim() !== '') {
+          return;
         }
 
-        this._decorations = Decoration.none;
+        const lineStart = activeLine.from;
+        const view = update.view;
+        this._timeout = setTimeout(() => {
+          this._decorations = Decoration.set([
+            Decoration.widget({
+              widget: new PlaceholderWidget(content),
+              side: 1,
+            }).range(lineStart),
+          ]);
+          view.update([]);
+        }, delay);
       }
 
       destroy() {

package/src/extensions/automerge/automerge.test.tsx

@@ -2,23 +2,43 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type DocHandle, Repo } from '@automerge/automerge-repo';
+import { type ChangeFn, type ChangeOptions, type Doc, type Heads } from '@automerge/automerge';
+import { type DocHandle, Repo, decodeHeads, encodeHeads, initSubduction } from '@automerge/automerge-repo';
 import { EditorState } from '@codemirror/state';
 import { EditorView } from '@codemirror/view';
 import { render, screen } from '@testing-library/react';
 import React, { type FC, useEffect, useRef, useState } from 'react';
-import { describe, test } from 'vitest';
+import { beforeAll, describe, test } from 'vitest';
 
+import { type IDocHandle } from '@dxos/echo-db';
 import { getDeep } from '@dxos/util';
 
 import { automerge } from './automerge';
 
+// Adapter: `IDocHandle` (used by `DocHandleProxy` in production) takes raw `Heads` (hex)
+// at `changeAt`, but automerge-repo's `DocHandle.changeAt` expects bs58check-encoded
+// `UrlHeads`. Encode on the way in, decode on the way out so the test's repo-backed
+// handle satisfies the extension's `IDocHandle` contract.
+const adaptRepoHandle = <T,>(handle: DocHandle<T>): IDocHandle<T> => ({
+  doc: () => handle.doc() as Doc<T> | undefined,
+  change: (callback: ChangeFn<T>, options?: ChangeOptions<T>) =>
+    options ? handle.change(callback, options) : handle.change(callback),
+  changeAt: (heads: Heads, callback: ChangeFn<T>, options?: ChangeOptions<T>): Heads | undefined => {
+    const encoded = options
+      ? handle.changeAt(encodeHeads(heads), callback, options)
+      : handle.changeAt(encodeHeads(heads), callback);
+    return encoded ? decodeHeads(encoded) : undefined;
+  },
+  addListener: (event, listener) => handle.on(event, listener),
+  removeListener: (event, listener) => handle.off(event, listener),
+});
+
+const path = ['text'];
+
 type TestObject = {
   text: string;
 };
 
-const path = ['text'];
-
 class Generator {
   constructor(private readonly _handle: DocHandle<TestObject>) {}
   update(text: string): void {
@@ -33,8 +53,7 @@ const Test: FC<{ handle: DocHandle<TestObject>; generator: Generator }> = ({ han
   const [view, setView] = useState<EditorView>();
   useEffect(() => {
     const extensions = [
-      // TODO(mykola): Fix types.
-      automerge({ handle: handle as any, path }),
+      automerge({ handle: adaptRepoHandle(handle), path }),
       EditorView.updateListener.of((update) => {
         if (view.state.doc.toString() === 'hello!') {
           // Update editor.
@@ -58,19 +77,26 @@ const Test: FC<{ handle: DocHandle<TestObject>; generator: Generator }> = ({ han
   return <div ref={ref} data-testid='editor' />;
 };
 
+// TODO(burdon): Test history/undo.
+// TODO(burdon): https://testing-library.com/docs/react-testing-library/example-intro/
+
 describe('Automerge', () => {
+  // Subduction-fork `Repo` constructs a `MemorySigner` internally; WASM must be
+  // initialized first or the constructor throws `'set_subduction_logger' of undefined`.
+  beforeAll(async () => {
+    await initSubduction();
+  });
+
   test('basic sync', ({ expect }) => {
     const repo = new Repo({ network: [] });
     const handle = repo.create<TestObject>();
     const generator = new Generator(handle);
     render(<Test handle={handle} generator={generator} />);
+
     const editor = screen.getByTestId('editor');
     expect(editor.textContent).toBe('');
 
     generator.update('hello!');
     expect(editor.textContent).toBe('hello world!');
   });
-
-  // TODO(burdon): Test history/undo.
-  // TODO(burdon): https://testing-library.com/docs/react-testing-library/example-intro/
 });

package/src/extensions/automerge/automerge.ts

@@ -13,7 +13,7 @@ import { DocAccessor } from '@dxos/echo-db';
 import { Cursor } from '../../util';
 import { initialSync } from '../state';
 import { cursorConverter } from './cursor';
-import { type State, isReconcile, updateHeadsEffect } from './defs';
+import { type State, isReconcile, reconcileAnnotation, updateHeadsEffect } from './defs';
 import { Syncer } from './sync';
 
 export const automerge = (accessor: DocAccessor): Extension => {
@@ -71,11 +71,9 @@ export const automerge = (accessor: DocAccessor): Extension => {
             const value = DocAccessor.getValue<string>(accessor);
             const current = this._view.state.doc.toString();
             if (value !== current) {
-              // TODO(burdon): This attempts to set the initial state.
-              console.warn('ENABLING INITIAL SYNC -- THIS MAY BE A REGRESSION');
               this._view.dispatch({
                 changes: { from: 0, to: this._view.state.doc.length, insert: value },
-                annotations: initialSync,
+                annotations: [initialSync, reconcileAnnotation.of(true)],
               });
             }
           });

package/src/extensions/factories.test.ts

@@ -0,0 +1,88 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { markdown, markdownLanguage, insertNewlineContinueMarkup } from '@codemirror/lang-markdown';
+import { EditorSelection, EditorState } from '@codemirror/state';
+import { describe, test } from 'vitest';
+
+import { createBasicExtensions } from './factories';
+
+describe('createBasicExtensions readOnly', () => {
+  test('drops user-initiated edits when readOnly is true', ({ expect }) => {
+    const state = EditorState.create({
+      doc: 'hello',
+      extensions: [createBasicExtensions({ readOnly: true })],
+    });
+    const tr = state.update({
+      changes: { from: state.doc.length, insert: ' world' },
+      userEvent: 'input.type',
+    });
+    expect(tr.state.doc.toString()).toBe('hello');
+  });
+
+  for (const userEvent of ['delete.forward', 'undo', 'redo']) {
+    test(`drops '${userEvent}' user events when readOnly is true`, ({ expect }) => {
+      const state = EditorState.create({
+        doc: 'hello',
+        extensions: [createBasicExtensions({ readOnly: true })],
+      });
+      const tr = state.update({
+        changes: { from: state.doc.length, insert: ' world' },
+        userEvent,
+      });
+      expect(tr.state.doc.toString()).toBe('hello');
+    });
+  }
+
+  test('allows programmatic dispatches (no userEvent) when readOnly is true', ({ expect }) => {
+    // Streaming consumers (e.g. MarkdownStream) populate the doc programmatically — those
+    // transactions must pass even though the editor is read-only to the user.
+    const state = EditorState.create({
+      doc: 'hello',
+      extensions: [createBasicExtensions({ readOnly: true })],
+    });
+    const tr = state.update({ changes: { from: state.doc.length, insert: ' world' } });
+    expect(tr.state.doc.toString()).toBe('hello world');
+  });
+
+  test('selection-only transactions still apply when readOnly', ({ expect }) => {
+    const state = EditorState.create({
+      doc: 'hello',
+      extensions: [createBasicExtensions({ readOnly: true })],
+    });
+    const tr = state.update({ selection: EditorSelection.cursor(2) });
+    expect(tr.state.selection.main.head).toBe(2);
+  });
+
+  test('doc-changing transactions apply normally when readOnly is false', ({ expect }) => {
+    const state = EditorState.create({
+      doc: 'hello',
+      extensions: [createBasicExtensions({ readOnly: false })],
+    });
+    const tr = state.update({ changes: { from: state.doc.length, insert: ' world' } });
+    expect(tr.state.doc.toString()).toBe('hello world');
+  });
+
+  // Regression: in MarkdownStream `readOnly: true` must also block the markdown extension's
+  // Enter handler (`insertNewlineContinueMarkup`), which programmatically dispatches a list
+  // continuation regardless of the readOnly facet.
+  test('markdown insertNewlineContinueMarkup is suppressed when readOnly', ({ expect }) => {
+    const doc = '- one\n- two';
+    const state = EditorState.create({
+      doc,
+      selection: EditorSelection.cursor(doc.length),
+      extensions: [createBasicExtensions({ readOnly: true }), markdown({ base: markdownLanguage })],
+    });
+    let dispatched: any;
+    insertNewlineContinueMarkup({
+      state,
+      dispatch: (tr) => {
+        dispatched = tr;
+      },
+    });
+    if (dispatched) {
+      expect(dispatched.state.doc.toString()).toBe(doc);
+    }
+  });
+});

package/src/extensions/factories.ts

@@ -33,7 +33,7 @@ import { baseTheme, createFontTheme, editorGutter } from '../styles';
 import { automerge } from './automerge';
 import { SpaceAwarenessProvider, awareness } from './awareness';
 import { focus } from './focus';
-import { scrollPastEnd } from './scroll-past-end';
+import { scrollPastEnd } from './scrolling';
 
 //
 // Basic
@@ -143,6 +143,19 @@ export const createBasicExtensions = (propsProp?: BasicExtensionsOptions): Exten
     props.lineWrapping && EditorView.lineWrapping,
     props.placeholder && placeholder(props.placeholder),
     props.readOnly !== undefined && EditorState.readOnly.of(props.readOnly),
+    // `EditorState.readOnly` is advisory — CodeMirror doesn't auto-reject doc-changing
+    // transactions. Some extensions (e.g. `@codemirror/lang-markdown`'s Enter handler that
+    // continues a list) dispatch programmatic edits regardless. Drop user-initiated edits
+    // (`input` / `delete` keymap dispatches plus `undo` / `redo` from the history extension)
+    // but pass programmatic dispatches — streaming `MarkdownStream` and similar consumers
+    // depend on being able to populate the doc themselves.
+    props.readOnly &&
+      EditorState.transactionFilter.of((tr) =>
+        tr.docChanged &&
+        (tr.isUserEvent('input') || tr.isUserEvent('delete') || tr.isUserEvent('undo') || tr.isUserEvent('redo'))
+          ? []
+          : tr,
+      ),
     props.scrollPastEnd && scrollPastEnd(),
     props.tabbable && tabbable,
     props.tabSize && EditorState.tabSize.of(props.tabSize),
@@ -179,12 +192,12 @@ export const createBasicExtensions = (propsProp?: BasicExtensionsOptions): Exten
 export type ThemeExtensionsOptions = {
   monospace?: boolean;
   themeMode?: ThemeMode;
+  scrollbarThin?: boolean;
   slots?: {
     editor?: {
       className?: string;
     };
     scroller?: {
-      // NOTE: Do not apply vertical padding to scroll container.
       className?: string;
     };
     content?: {
@@ -218,11 +231,12 @@ export const defaultStyles = {
  */
 export const createThemeExtensions = ({
   monospace,
-  themeMode,
+  scrollbarThin,
   slots: slotsProp,
   syntaxHighlighting: syntaxHighlightingProp,
+  themeMode,
 }: ThemeExtensionsOptions = {}): Extension => {
-  const slots = defaultsDeep({}, slotsProp, defaultThemeSlots);
+  const slots: NonNullable<ThemeExtensionsOptions['slots']> = defaultsDeep({}, slotsProp, defaultThemeSlots);
   return [
     baseTheme,
     EditorView.darkTheme.of(themeMode === 'dark'),
@@ -231,11 +245,16 @@ export const createThemeExtensions = ({
       syntaxHighlighting(HighlightStyle.define(themeMode === 'dark' ? defaultStyles.dark : defaultStyles.light)),
     slots.editor?.className && EditorView.editorAttributes.of({ class: slots.editor.className }),
     slots.content?.className && EditorView.contentAttributes.of({ class: slots.content.className }),
-    slots.scroll?.className &&
+    (slots.scroller?.className || scrollbarThin) &&
       ViewPlugin.fromClass(
         class {
           constructor(view: EditorView) {
-            view.scrollDOM.classList.add(...slots.scroll.className.split(/\s+/));
+            if (slots.scroller?.className) {
+              view.scrollDOM.classList.add(...slots.scroller.className.split(/\s+/));
+            }
+            if (scrollbarThin) {
+              view.scrollDOM.style.setProperty('--scrollbar-size', '4px');
+            }
           }
         },
       ),

package/src/extensions/index.ts

@@ -4,7 +4,6 @@
 
 export * from './annotations';
 export * from './autocomplete';
-export * from './auto-scroll';
 export * from './automerge';
 export * from './awareness';
 export * from './blast';
@@ -26,10 +25,9 @@ export * from './modes';
 export * from './outliner';
 export * from './preview';
 export * from './replacer';
-export * from './scroll-past-end';
-export * from './scroller';
+export * from './scrolling';
 export * from './selection';
+export * from './snippets';
 export * from './state';
 export * from './submit';
 export * from './tags';
-export * from './typewriter';

package/src/extensions/outliner/outliner.ts

@@ -156,7 +156,7 @@ const decorations = () => [
       },
 
       '.cm-list-item-focused': {
-        borderColor: 'var(--color-neutral-focus-indicator)',
+        borderColor: 'var(--color-focus-ring-subtle)',
       },
       '&:focus-within .cm-list-item-selected': {
         borderColor: 'var(--color-separator)',