@dxos/react-ui-editor 0.8.4-main.ead640a → 0.8.4-main.ef1bc66f44

package/src/extensions/autocomplete/autocomplete.ts

@@ -1,220 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Extension, Prec } from '@codemirror/state';
-import {
-  Decoration,
-  type DecorationSet,
-  EditorView,
-  ViewPlugin,
-  type ViewUpdate,
-  WidgetType,
-  keymap,
-} from '@codemirror/view';
-
-export type AutocompleteOptions = {
-  fireIfEmpty?: boolean;
-
-  /**
-   * Callback triggered when Enter is pressed.
-   * @param text The current text in the editor
-   * @returns true if the editor should reset the document.
-   */
-  onSubmit?: (text: string) => boolean | void;
-
-  /**
-   * Function that returns a list of suggestions based on the current text.
-   * @param text The current text before the cursor
-   * @returns Array of suggestion strings
-   */
-  onSuggest?: (text: string) => string[];
-
-  /**
-   * ESC pressed.
-   */
-  onCancel?: () => void;
-};
-
-/**
- * Creates an autocomplete extension that shows inline suggestions.
- * Pressing Tab will complete the suggestion.
- */
-// TODO(burdon): Reconcile with typeahead.
-export const autocomplete = ({ fireIfEmpty, onSubmit, onSuggest, onCancel }: AutocompleteOptions = {}): Extension => {
-  const suggest = ViewPlugin.fromClass(
-    class {
-      _decorations: DecorationSet;
-      _currentSuggestion: string | null = null;
-
-      constructor(view: EditorView) {
-        this._decorations = this.computeDecorations(view);
-      }
-
-      update(update: ViewUpdate) {
-        if (update.docChanged || update.selectionSet) {
-          this._decorations = this.computeDecorations(update.view);
-        }
-      }
-
-      private computeDecorations(view: EditorView): DecorationSet {
-        const text = view.state.doc.toString();
-        const suggestions = onSuggest?.(text) ?? [];
-        if (!suggestions.length) {
-          this._currentSuggestion = null;
-          return Decoration.none;
-        }
-
-        // Get the first suggestion.
-        this._currentSuggestion = suggestions[0];
-        const suffix = this._currentSuggestion.slice(text.length);
-        if (!suffix) {
-          return Decoration.none;
-        }
-
-        // Always show ghost text at the end of the document.
-        return Decoration.set([
-          Decoration.widget({
-            widget: new InlineSuggestionWidget(suffix),
-            side: 1,
-          }).range(view.state.doc.length),
-        ]);
-      }
-
-      completeSuggestion(view: EditorView): boolean {
-        if (!this._currentSuggestion) {
-          return false;
-        }
-
-        const text = view.state.doc.toString();
-        const suffix = this._currentSuggestion.slice(text.length);
-        if (!suffix) {
-          return false;
-        }
-
-        view.dispatch({
-          changes: {
-            from: view.state.doc.length,
-            insert: suffix,
-          },
-          selection: {
-            anchor: view.state.doc.length + suffix.length,
-          },
-        });
-
-        return true;
-      }
-    },
-    {
-      decorations: (v) => v._decorations,
-    },
-  );
-
-  return [
-    suggest,
-    EditorView.theme({
-      '.cm-inline-suggestion': {
-        opacity: 0.4,
-      },
-    }),
-
-    Prec.highest(
-      keymap.of([
-        {
-          key: 'Tab',
-          preventDefault: true,
-          run: (view) => {
-            const plugin = view.plugin(suggest);
-            return plugin?.completeSuggestion(view) ?? false;
-          },
-        },
-        {
-          key: 'ArrowRight',
-          preventDefault: true,
-          run: (view) => {
-            // Only complete if cursor is at the end
-            if (view.state.selection.main.head !== view.state.doc.length) {
-              return false;
-            }
-
-            const plugin = view.plugin(suggest);
-            return plugin?.completeSuggestion(view) ?? false;
-          },
-        },
-        {
-          key: 'Enter',
-          preventDefault: true,
-          run: (view) => {
-            const text = view.state.doc.toString().trim();
-            if (onSubmit && (fireIfEmpty || text.length > 0)) {
-              const reset = onSubmit(text);
-
-              // Clear the document after calling onEnter.
-              if (reset) {
-                view.dispatch({
-                  changes: {
-                    from: 0,
-                    to: view.state.doc.length,
-                    insert: '',
-                  },
-                });
-              }
-            }
-
-            return true;
-          },
-        },
-        {
-          key: 'Shift-Enter',
-          preventDefault: true,
-          run: (view) => {
-            view.dispatch({
-              changes: {
-                from: view.state.selection.main.head,
-                insert: '\n',
-              },
-              selection: {
-                anchor: view.state.selection.main.head + 1,
-                head: view.state.selection.main.head + 1,
-              },
-            });
-            return true;
-          },
-        },
-        {
-          key: 'Escape',
-          preventDefault: true,
-          run: (view) => {
-            // Clear the entire document.
-            view.dispatch({
-              changes: {
-                from: 0,
-                to: view.state.doc.length,
-                insert: '',
-              },
-            });
-            onCancel?.();
-            return true;
-          },
-        },
-      ]),
-    ),
-  ];
-};
-
-class InlineSuggestionWidget extends WidgetType {
-  constructor(private suffix: string) {
-    super();
-  }
-
-  override toDOM(): HTMLSpanElement {
-    const span = document.createElement('span');
-    span.textContent = this.suffix;
-    span.className = 'cm-inline-suggestion';
-    return span;
-  }
-
-  override eq(other: InlineSuggestionWidget): boolean {
-    return other.suffix === this.suffix;
-  }
-}

package/src/extensions/autocomplete/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './autocomplete';
-export * from './match';
-export * from './placeholder';
-export * from './typeahead';

package/src/extensions/autocomplete/match.ts

@@ -1,46 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export type CompoetionContext = { line: string };
-
-export type CompletionOptions = {
-  default?: string;
-  minLength?: number;
-};
-
-/**
- * Util to match current line to a static list of completions.
- */
-export const staticCompletion =
-  (completions: string[], options: CompletionOptions = {}) =>
-  ({ line }: CompoetionContext) => {
-    if (line.length === 0 && options.default) {
-      return options.default;
-    }
-
-    const parts = line.split(/\s+/).filter(Boolean);
-    if (parts.length) {
-      const str = parts.at(-1)!;
-      if (str.length >= (options.minLength ?? 0)) {
-        for (const completion of completions) {
-          const match = matchCompletion(completion, str);
-          if (match) {
-            return match;
-          }
-        }
-      }
-    }
-  };
-
-export const matchCompletion = (completion: string, str: string, minLength = 0): string | undefined => {
-  if (
-    str.length >= minLength &&
-    completion.length > str.length &&
-    completion.startsWith(str)
-    // TODO(burdon): If case insensitive, need to replace existing chars.
-    // completion.toLowerCase().startsWith(str.toLowerCase())
-  ) {
-    return completion.slice(str.length);
-  }
-};

package/src/extensions/autocomplete/placeholder.ts

@@ -1,117 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-// Based on https://github.com/codemirror/view/blob/main/src/placeholder.ts
-//
-
-import { type Extension } from '@codemirror/state';
-import { Decoration, EditorView, ViewPlugin, type ViewUpdate, WidgetType } from '@codemirror/view';
-
-import { clientRectsFor, flattenRect } from '../../util';
-
-type Content = string | HTMLElement | ((view: EditorView) => HTMLElement);
-
-export type PlaceholderOptions = {
-  content: Content;
-  delay?: number;
-};
-
-/**
- * Shows a transient placeholder at the current cursor position.
- */
-export const placeholder = ({ content, delay = 3_000 }: PlaceholderOptions): Extension => {
-  const plugin = ViewPlugin.fromClass(
-    class {
-      _timeout: ReturnType<typeof setTimeout> | undefined;
-      _decorations = Decoration.none;
-
-      update(update: ViewUpdate) {
-        if (this._timeout) {
-          window.clearTimeout(this._timeout);
-          this._timeout = undefined;
-        }
-
-        // 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);
-        }
-
-        this._decorations = Decoration.none;
-      }
-
-      destroy() {
-        if (this._timeout) {
-          clearTimeout(this._timeout);
-        }
-      }
-    },
-    {
-      provide: (plugin) => {
-        return [EditorView.decorations.of((view) => view.plugin(plugin)?._decorations ?? Decoration.none)];
-      },
-    },
-  );
-
-  return typeof content === 'string'
-    ? [plugin, EditorView.contentAttributes.of({ 'aria-placeholder': content })]
-    : plugin;
-};
-
-export class PlaceholderWidget extends WidgetType {
-  constructor(readonly content: Content) {
-    super();
-  }
-
-  toDOM(view: EditorView) {
-    const wrap = document.createElement('span');
-    wrap.className = 'cm-placeholder';
-    wrap.style.pointerEvents = 'none';
-    wrap.setAttribute('aria-hidden', 'true');
-    wrap.appendChild(
-      typeof this.content === 'string'
-        ? document.createTextNode(this.content)
-        : typeof this.content === 'function'
-          ? this.content(view)
-          : this.content.cloneNode(true),
-    );
-
-    return wrap;
-  }
-
-  override coordsAt(dom: HTMLElement) {
-    const rects = dom.firstChild ? clientRectsFor(dom.firstChild) : [];
-    if (!rects.length) {
-      return null;
-    }
-
-    const style = getComputedStyle(dom.parentNode as HTMLElement);
-    const rect = flattenRect(rects[0], style.direction !== 'rtl');
-    const lineHeight = parseInt(style.lineHeight);
-    if (rect.bottom - rect.top > lineHeight * 1.5) {
-      return {
-        left: rect.left,
-        right: rect.right,
-        top: rect.top,
-        bottom: rect.top + lineHeight,
-      };
-    }
-
-    return rect;
-  }
-
-  override ignoreEvent() {
-    return false;
-  }
-}

package/src/extensions/autocomplete/typeahead.ts

@@ -1,87 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { EditorSelection, type Extension, Prec, RangeSetBuilder } from '@codemirror/state';
-import {
-  type Command,
-  Decoration,
-  type DecorationSet,
-  type EditorView,
-  ViewPlugin,
-  type ViewUpdate,
-  keymap,
-} from '@codemirror/view';
-
-import { type CompoetionContext } from './match';
-import { PlaceholderWidget } from './placeholder';
-
-// TODO(burdon): Option to complete only at end of line.
-export type TypeaheadOptions = {
-  onComplete?: (context: CompoetionContext) => string | undefined;
-};
-
-/**
- * Shows a completion placeholder.
- */
-export const typeahead = ({ onComplete }: TypeaheadOptions = {}): Extension => {
-  let hint: string | undefined;
-
-  const complete: Command = (view: EditorView) => {
-    if (!hint) {
-      return false;
-    }
-
-    const selection = view.state.selection.main;
-    view.dispatch({
-      changes: [{ from: selection.from, to: selection.to, insert: hint }],
-      selection: EditorSelection.cursor(selection.from + hint.length),
-    });
-
-    return true;
-  };
-
-  return [
-    ViewPlugin.fromClass(
-      class {
-        decorations: DecorationSet = Decoration.none;
-        update(update: ViewUpdate) {
-          const builder = new RangeSetBuilder<Decoration>();
-          const selection = update.view.state.selection.main;
-          const line = update.view.state.doc.lineAt(selection.from);
-
-          // TODO(burdon): Check at end of line and matches start of previous word.
-          // TODO(burdon): Context grammar.
-          if (selection.from === selection.to && selection.from === line.to) {
-            const str = update.state.sliceDoc(line.from, selection.from);
-            hint = onComplete?.({ line: str });
-            if (hint) {
-              builder.add(selection.from, selection.to, Decoration.widget({ widget: new PlaceholderWidget(hint) }));
-            }
-          }
-
-          this.decorations = builder.finish();
-        }
-      },
-      {
-        decorations: (v) => v.decorations,
-      },
-    ),
-
-    // Keys.
-    Prec.highest(
-      keymap.of([
-        {
-          key: 'Tab',
-          preventDefault: true,
-          run: complete,
-        },
-        {
-          key: 'ArrowRight',
-          preventDefault: true,
-          run: complete,
-        },
-      ]),
-    ),
-  ];
-};

package/src/extensions/automerge/automerge.stories.tsx

@@ -1,149 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@preact/signals-react';
-
-import { Repo } from '@automerge/automerge-repo';
-import { BroadcastChannelNetworkAdapter } from '@automerge/automerge-repo-network-broadcastchannel';
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useEffect, useState } from 'react';
-
-import { Obj, Ref, Type } from '@dxos/echo';
-import { DocAccessor, Query, type Space, createDocAccessor, useQuery, useSpace } from '@dxos/react-client/echo';
-import { type Identity, useIdentity } from '@dxos/react-client/halo';
-import { type ClientRepeatedComponentProps, ClientRepeater } from '@dxos/react-client/testing';
-import { useThemeContext } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { render } from '@dxos/storybook-utils';
-
-import { editorSlots } from '../../defaults';
-import { useTextEditor } from '../../hooks';
-import { translations } from '../../translations';
-import { createBasicExtensions, createDataExtensions, createThemeExtensions } from '../factories';
-
-const initialContent = 'Hello world!';
-
-type TestObject = {
-  text: string;
-};
-
-type EditorProps = {
-  source: DocAccessor;
-  autoFocus?: boolean;
-  space?: Space;
-  identity?: Identity;
-};
-
-const Editor = ({ source, autoFocus, space, identity }: EditorProps) => {
-  const { themeMode } = useThemeContext();
-  const { parentRef } = useTextEditor(
-    () => ({
-      initialValue: DocAccessor.getValue(source),
-      extensions: [
-        createBasicExtensions({ placeholder: 'Type here...', search: true }),
-        createThemeExtensions({ themeMode, slots: editorSlots }),
-        createDataExtensions({ id: 'test', text: source, space, identity }),
-      ],
-      autoFocus,
-    }),
-    [source, themeMode],
-  );
-
-  return <div ref={parentRef} className='flex w-full' />;
-};
-
-const DefaultStory = () => {
-  const [object1, setObject1] = useState<DocAccessor<TestObject>>();
-  const [object2, setObject2] = useState<DocAccessor<TestObject>>();
-
-  useEffect(() => {
-    queueMicrotask(async () => {
-      const repo1 = new Repo({ network: [new BroadcastChannelNetworkAdapter()] });
-      const repo2 = new Repo({ network: [new BroadcastChannelNetworkAdapter()] });
-
-      const object1 = repo1.create<TestObject>();
-      object1.change((doc: TestObject) => {
-        doc.text = initialContent;
-      });
-
-      const object2 = await repo2.find<TestObject>(object1.url);
-      await object2.whenReady();
-
-      // TODO(mykola): Fix types.
-      setObject1({ handle: object1 as any, path: ['text'] });
-      setObject2({ handle: object2 as any, path: ['text'] });
-    });
-  }, []);
-
-  if (!object1 || !object2) {
-    return null;
-  }
-
-  return (
-    <div role='none' className='grid grid-cols-2 bs-full is-full divide-x divide-neutral-500'>
-      <Editor source={object1} autoFocus />
-      <Editor source={object2} />
-    </div>
-  );
-};
-
-const EchoStory = ({ spaceKey }: ClientRepeatedComponentProps) => {
-  const identity = useIdentity();
-  const space = useSpace(spaceKey);
-  const [source, setSource] = useState<DocAccessor>();
-  const objects = useQuery(space, Query.type(Type.Expando, { type: 'test' }));
-
-  useEffect(() => {
-    const content = objects[0]?.content.target;
-    if (!source && content) {
-      const source = createDocAccessor(content, ['content']);
-      setSource(source);
-    }
-  }, [objects, source]);
-
-  if (!source) {
-    return null;
-  }
-
-  return <Editor source={source} space={space} identity={identity ?? undefined} />;
-};
-
-const meta = {
-  title: 'ui/react-ui-editor/Automerge',
-  component: Editor as any,
-  render: render(DefaultStory),
-  decorators: [withTheme],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {},
-};
-
-export const WithEcho: Story = {
-  render: () => {
-    return (
-      <ClientRepeater
-        count={2}
-        component={EchoStory}
-        createSpace
-        onCreateSpace={async ({ space }) => {
-          space.db.add(
-            Obj.make(Type.Expando, {
-              type: 'test',
-              content: Ref.make(Obj.make(Type.Expando, { content: initialContent })),
-            }),
-          );
-        }}
-      />
-    );
-  },
-};

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

@@ -1,78 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type DocHandle, Repo } from '@automerge/automerge-repo';
-import { EditorState } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-import { render, screen } from '@testing-library/react';
-// TODO(wittjosiah): Move to vitest expect (and remove from package.json).
-import chai, { expect } from 'chai';
-import chaiDom from 'chai-dom';
-import React, { type FC, useEffect, useRef, useState } from 'react';
-import { describe, test } from 'vitest';
-
-import { get } from '@dxos/util';
-
-import { automerge } from './automerge';
-
-type TestObject = {
-  text: string;
-};
-
-const path = ['text'];
-
-class Generator {
-  constructor(private readonly _handle: DocHandle<TestObject>) {}
-  update(text: string): void {
-    this._handle.change((doc: TestObject) => {
-      doc.text = text;
-    });
-  }
-}
-
-const Test: FC<{ handle: DocHandle<TestObject>; generator: Generator }> = ({ handle, generator }) => {
-  const ref = useRef<HTMLDivElement>(null);
-  const [view, setView] = useState<EditorView>();
-  useEffect(() => {
-    const extensions = [
-      // TODO(mykola): Fix types.
-      automerge({ handle: handle as any, path }),
-      EditorView.updateListener.of((update) => {
-        if (view.state.doc.toString() === 'hello!') {
-          // Update editor.
-          update.view.dispatch({ changes: { from: view.state.doc.length - 1, insert: ' world' } });
-        }
-      }),
-    ];
-
-    const view = new EditorView({
-      state: EditorState.create({ doc: get(handle.doc()!, path), extensions }),
-      parent: ref.current!,
-    });
-
-    setView(view);
-  }, []);
-
-  useEffect(() => {}, [view]);
-
-  return <div ref={ref} />;
-};
-
-chai.use(chaiDom);
-
-describe('Automerge', () => {
-  test('basic sync', () => {
-    const repo = new Repo({ network: [] });
-    const handle = repo.create<TestObject>();
-    const generator = new Generator(handle);
-    render(<Test handle={handle} generator={generator} />);
-    expect(screen.getByRole('textbox')).to.have.text('');
-
-    generator.update('hello!');
-    expect(screen.getByRole('textbox')).to.have.text('hello world!');
-  });
-
-  // TODO(burdon): Test history/undo.
-  // TODO(burdon): https://testing-library.com/docs/react-testing-library/example-intro/
-});