@dxos/react-ui-editor 0.8.4-main.c4373fc → 0.8.4-main.d05673bc65

package/src/defaults.ts

@@ -1,52 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EditorView } from '@codemirror/view';
-
-import { mx } from '@dxos/react-ui-theme';
-
-import { type ThemeExtensionsOptions } from './extensions';
-import { fontMono } from './styles';
-
-/**
- * CodeMirror content width.
- * 40rem = 640px. Corresponds to initial plank width (Google docs, Stashpad, etc.)
- * 50rem = 800px. Maximum content width for solo mode.
- * NOTE: Max width - 4rem = 2rem left/right margin (or 2rem gutter plus 1rem left/right margin).
- */
-export const editorWidth = '!mli-auto is-full max-is-[min(50rem,100%-4rem)]';
-
-export const editorSlots: ThemeExtensionsOptions['slots'] = {
-  scroll: {
-    className: 'pbs-2',
-  },
-  content: {
-    className: editorWidth,
-  },
-};
-
-export const editorGutter = EditorView.theme({
-  '.cm-gutters': {
-    // NOTE: Color required to cover content if scrolling horizontally.
-    // TODO(burdon): Non-transparent background clips the focus ring.
-    background: 'var(--dx-baseSurface) !important',
-    paddingRight: '1rem',
-  },
-});
-
-export const editorMonospace = EditorView.theme({
-  '.cm-content': {
-    fontFamily: fontMono,
-  },
-});
-
-export const editorWithToolbarLayout =
-  'grid grid-cols-1 grid-rows-[min-content_1fr] data-[toolbar=disabled]:grid-rows-[1fr] justify-center content-start overflow-hidden';
-
-// NOTE: Padding is added to the editor to account for the focus ring (since otherwise the CM gutter will clip it)
-export const stackItemContentEditorClassNames = (role?: string) =>
-  mx(
-    'p-0.5 dx-focus-ring-inset attention-surface data-[toolbar=disabled]:pbs-2',
-    role === 'section' ? '[&_.cm-scroller]:overflow-hidden [&_.cm-scroller]:min-bs-24' : 'min-bs-0',
-  );

package/src/extensions/annotations.ts

@@ -1,55 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension, RangeSetBuilder } from '@codemirror/state';
-import { Decoration, type DecorationSet, EditorView, ViewPlugin, type ViewUpdate } from '@codemirror/view';
-
-const annotationMark = Decoration.mark({ class: 'cm-annotation' });
-
-export type AnnotationOptions = {
-  match?: RegExp; // TODO(burdon): Update via hook (e.g., for search).
-};
-
-/**
- *
- */
-export const annotations = ({ match }: AnnotationOptions = {}): Extension => {
-  return [
-    ViewPlugin.fromClass(
-      class {
-        decorations: DecorationSet = Decoration.none;
-        update(update: ViewUpdate) {
-          const builder = new RangeSetBuilder<Decoration>();
-          if (match) {
-            // Only process visible lines.
-            const { from, to } = update.view.viewport;
-            const text = update.state.doc.sliceString(from, to);
-            const matches = text.matchAll(match);
-            for (const m of matches) {
-              if (m.index !== undefined) {
-                // Adjust match position relative to viewport.
-                const start = from + m.index;
-                const end = start + m[0].length;
-                builder.add(start, end, annotationMark);
-              }
-            }
-          }
-
-          this.decorations = builder.finish();
-        }
-      },
-      {
-        decorations: (v) => v.decorations,
-      },
-    ),
-
-    EditorView.theme({
-      '.cm-annotation': {
-        textDecoration: 'underline',
-        textDecorationStyle: 'wavy',
-        textDecorationColor: 'var(--dx-errorText)',
-      },
-    }),
-  ];
-};

package/src/extensions/autocomplete.ts

@@ -1,219 +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.
- */
-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/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/
-});

package/src/extensions/automerge/automerge.ts

@@ -1,86 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-// Copyright 2024 Automerge
-// Ref: https://github.com/automerge/automerge-codemirror
-//
-
-import { next as A } from '@automerge/automerge';
-import { type Extension, StateField } from '@codemirror/state';
-import { EditorView, ViewPlugin } from '@codemirror/view';
-
-import { type DocAccessor } from '@dxos/react-client/echo';
-
-import { Cursor } from '../../util';
-
-import { cursorConverter } from './cursor';
-import { type State, isReconcile, updateHeadsEffect } from './defs';
-import { Syncer } from './sync';
-
-export const automerge = (accessor: DocAccessor): Extension => {
-  const syncState = StateField.define<State>({
-    create: () => ({
-      path: accessor.path.slice(),
-      lastHeads: A.getHeads(accessor.handle.doc()!),
-      unreconciledTransactions: [],
-    }),
-
-    update: (value, tr) => {
-      const result: State = {
-        path: accessor.path.slice(),
-        lastHeads: value.lastHeads,
-        unreconciledTransactions: value.unreconciledTransactions.slice(),
-      };
-
-      let clearUnreconciled = false;
-      for (const effect of tr.effects) {
-        if (effect.is(updateHeadsEffect)) {
-          result.lastHeads = effect.value.newHeads;
-          clearUnreconciled = true;
-        }
-      }
-
-      if (clearUnreconciled) {
-        result.unreconciledTransactions = [];
-      } else {
-        if (!isReconcile(tr)) {
-          result.unreconciledTransactions.push(tr);
-        }
-      }
-
-      return result;
-    },
-  });
-
-  const syncer = new Syncer(accessor.handle, syncState);
-
-  return [
-    Cursor.converter.of(cursorConverter(accessor)),
-
-    // Track heads.
-    syncState,
-
-    // Reconcile external updates.
-    ViewPlugin.fromClass(
-      class {
-        constructor(private readonly _view: EditorView) {
-          accessor.handle.addListener('change', this._handleChange);
-        }
-
-        destroy() {
-          accessor.handle.removeListener('change', this._handleChange);
-        }
-
-        readonly _handleChange = () => {
-          syncer.reconcile(this._view, false);
-        };
-      },
-    ),
-
-    // Reconcile local updates.
-    EditorView.updateListener.of(({ view, changes }) => {
-      if (!changes.empty) {
-        syncer.reconcile(view, true);
-      }
-    }),
-  ];
-};

package/src/extensions/automerge/cursor.ts

@@ -1,28 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { log } from '@dxos/log';
-import { type DocAccessor, fromCursor, toCursor } from '@dxos/react-client/echo';
-
-import { type CursorConverter } from '../../util';
-
-export const cursorConverter = (accessor: DocAccessor): CursorConverter => ({
-  toCursor: (pos, assoc) => {
-    try {
-      return toCursor(accessor, pos, assoc);
-    } catch (err) {
-      log.catch(err);
-      return ''; // In case of invalid request (e.g., wrong document).
-    }
-  },
-
-  fromCursor: (cursor) => {
-    try {
-      return fromCursor(accessor, cursor);
-    } catch (err) {
-      log.catch(err);
-      return 0; // In case of invalid request (e.g., wrong document).
-    }
-  },
-});

package/src/extensions/automerge/defs.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-// Copyright 2024 Automerge
-// Ref: https://github.com/automerge/automerge-codemirror
-//
-
-import { type Heads, type Prop } from '@automerge/automerge';
-import { Annotation, type EditorState, StateEffect, type StateField, type Transaction } from '@codemirror/state';
-
-export type State = {
-  path: Prop[];
-  lastHeads: Heads;
-  unreconciledTransactions: Transaction[];
-};
-
-export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
-export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
-
-export type UpdateHeads = {
-  newHeads: Heads;
-};
-
-export const updateHeadsEffect = StateEffect.define<UpdateHeads>({});
-
-export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
-
-export const reconcileAnnotation = Annotation.define<boolean>();
-
-export const isReconcile = (tr: Transaction): boolean => {
-  return !!tr.annotation(reconcileAnnotation);
-};

package/src/extensions/automerge/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export { automerge } from './automerge';