@dxos/react-ui-editor 0.3.11-main.5a4849d → 0.3.11-main.5cbcf4e

package/src/components/TextEditor/codemirror.stories.ts

@@ -1,114 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
-import { EditorState } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-import { type StoryObj } from '@storybook/html';
-import { basicSetup } from 'codemirror';
-import { yCollab } from 'y-codemirror.next';
-
-import { EventSubscriptions } from '@dxos/async';
-import { generateName } from '@dxos/display-name';
-import { Client, type PublicKey } from '@dxos/react-client';
-import { type Space, TextObject } from '@dxos/react-client/echo';
-import { type Identity } from '@dxos/react-client/halo';
-import { joinCommonSpace, TestBuilder, textGenerator } from '@dxos/react-client/testing';
-import { YText } from '@dxos/text-model';
-
-import { cursorColor, SpaceAwarenessProvider } from '../../hooks';
-import { EditorDocument, types as schema } from '../../testing';
-
-export default {
-  title: 'CodeMirror',
-};
-
-const testBuilder = new TestBuilder();
-const views: Record<number, EditorView> = {};
-const subscriptions = new EventSubscriptions();
-
-const updateEditor = async (id: number, editor: HTMLDivElement, identity: Identity, space: Space, text: TextObject) => {
-  const doc = text.doc;
-  const ytext = text.content;
-  if (!(ytext instanceof YText) || !doc) {
-    return;
-  }
-
-  const { awareness } = new SpaceAwarenessProvider({ space, doc, channel: `yjs.awareness.${text.id}` });
-  awareness.setLocalStateField('user', {
-    name: identity.profile?.displayName ?? generateName(identity.identityKey.toHex()),
-    // TODO(wittjosiah): Pick colours from theme based on identity key.
-    color: cursorColor.color,
-    colorLight: cursorColor.light,
-  });
-
-  const state = EditorState.create({
-    doc: ytext.toString(),
-    extensions: [basicSetup, markdown({ base: markdownLanguage }), yCollab(ytext, awareness)],
-  });
-
-  const view = views[id];
-  if (view) {
-    view.setState(state);
-  } else {
-    views[id] = new EditorView({ state, parent: editor });
-  }
-
-  if (id === 0) {
-    subscriptions.clear();
-    subscriptions.add(textGenerator({ text: ytext }));
-  }
-};
-
-const setupEditor = async (id: number, client: Client, spaceKey: PublicKey, editor: HTMLDivElement) => {
-  const space = await client.spaces.get(spaceKey)!;
-  const query = space.db.query(EditorDocument.filter());
-  query.subscribe(({ objects }) => {
-    const text = objects[0]?.content;
-    void (text && updateEditor(id, editor, client.halo.identity.get()!, space, text));
-  });
-
-  const text = query.objects[0]?.content;
-  void (text && updateEditor(id, editor, client.halo.identity.get()!, space, text));
-};
-
-const setupSpace = async (count: number) => {
-  const clients = [...Array(count)].map(() => new Client({ services: testBuilder.createLocal() }));
-  await Promise.all(clients.map((client) => client.initialize()));
-  await Promise.all(clients.map((client) => client.halo.createIdentity()));
-  clients.map((client) => client.spaces.addSchema(schema));
-
-  const space = await clients[0].spaces.create();
-  const text = new TextObject('Hello, Storybook!');
-  const document = new EditorDocument({ content: text });
-  await space.db.add(document);
-
-  await joinCommonSpace(clients, space.key);
-
-  return { clients, spaceKey: space.key };
-};
-
-const count = 2;
-
-export const Default: StoryObj<{ id: number; client: Client; spaceKey: PublicKey }> = {
-  render: ({ id, client, spaceKey }) => {
-    const editor = document.createElement('div');
-    editor.setAttribute('style', 'min-width: 0; flex: 1; padding: 1rem;');
-    void setupEditor(id, client, spaceKey, editor);
-    return editor;
-  },
-  decorators: [
-    (story) => {
-      const container = document.createElement('div');
-      container.setAttribute('style', 'display: flex; justify-content: space-evenly');
-      void setupSpace(count).then(({ clients, spaceKey }) => {
-        clients.forEach((client, id) => {
-          // TODO(wittjosiah): According to the docs these types should be compatible.
-          container.appendChild(story({ args: { id, client, spaceKey } }) as HTMLElement);
-        });
-      });
-      return container;
-    },
-  ],
-};

package/src/extensions/code.ts

@@ -1,99 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Range } from '@codemirror/state';
-import {
-  ViewPlugin,
-  type DecorationSet,
-  EditorView,
-  type ViewUpdate,
-  Decoration,
-  type BlockInfo,
-} from '@codemirror/view';
-import get from 'lodash.get';
-
-import { mx } from '@dxos/react-ui-theme';
-
-import { tokens } from '../styles';
-
-const CODE_REGEX = /```[\s\S]*?```/gs;
-
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-codeblock': {
-    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
-  },
-  '&light [aria-readonly="true"] .cm-codeblock': {
-    background: get(tokens, 'extend.colors.neutral.50'),
-  },
-  '&dark [aria-readonly="true"] .cm-codeblock': {
-    background: get(tokens, 'extend.colors.neutral.850'),
-  },
-  '& [aria-readonly="true"] .cm-codeblock': {
-    display: 'block',
-    paddingInline: '4px !important',
-  },
-  '& [aria-readonly="true"] .cm-codeblock-first': {
-    paddingTop: '4px !important',
-    borderTopLeftRadius: '4px',
-    borderTopRightRadius: '4px',
-  },
-  '& [aria-readonly="true"] .cm-codeblock-last': {
-    paddingBottom: '4px !important',
-    borderBottomLeftRadius: '4px',
-    borderBottomRightRadius: '4px',
-  },
-});
-
-// TODO(burdon): Start from EditorView.lineBlockAt(pos).
-const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
-  const start = lines.findIndex((line) => line.from >= from);
-  const end = lines.findIndex((line) => line.to >= to);
-  return [start, end];
-};
-
-export const code = () => {
-  const getDecorations = (view: EditorView) => {
-    const decorations: Range<Decoration>[] = [];
-    if (view.state.readOnly) {
-      const text = view.state.doc.sliceString(0);
-      const matches = text.matchAll(CODE_REGEX);
-      const blocks = view.viewportLineBlocks;
-      for (const match of matches) {
-        const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
-        for (let i = range[0]; i <= range[1]; i++) {
-          const block = blocks[i];
-          decorations.push(
-            Decoration.line({
-              class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
-            }).range(block.from),
-          );
-        }
-      }
-    }
-
-    return Decoration.set(decorations);
-  };
-
-  return [
-    ViewPlugin.fromClass(
-      class {
-        decorations: DecorationSet;
-        constructor(view: EditorView) {
-          this.decorations = getDecorations(view);
-        }
-
-        update(update: ViewUpdate) {
-          if (update.docChanged || update.viewportChanged) {
-            this.decorations = getDecorations(update.view);
-          }
-        }
-      },
-      {
-        decorations: (value) => value.decorations,
-      },
-    ),
-    styles,
-  ];
-};

package/src/extensions/hr.ts

@@ -1,74 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import {
-  Decoration,
-  type DecorationSet,
-  EditorView,
-  MatchDecorator,
-  ViewPlugin,
-  type ViewUpdate,
-  WidgetType,
-} from '@codemirror/view';
-import get from 'lodash.get';
-
-import { tokens } from '../styles';
-
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-hr': {
-    // TODO(burdon): ???
-    // Note that block-level decorations should not have vertical margins,
-    borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
-  },
-});
-
-class HorizontalRuleWidget extends WidgetType {
-  constructor(readonly _pos: number) {
-    super();
-  }
-
-  override eq(other: WidgetType) {
-    return this._pos === (other as any as HorizontalRuleWidget)._pos;
-  }
-
-  toDOM(view: EditorView) {
-    // TODO(burdon): Create <hr> element? Does this clash with markdown parser?
-    const el = document.createElement('div');
-    el.className = 'cm-hr';
-    return el;
-  }
-}
-
-const placeholderMatcher = new MatchDecorator({
-  regexp: /^---$/g,
-  decoration: (match, view, pos) =>
-    Decoration.replace({
-      widget: new HorizontalRuleWidget(pos),
-    }),
-});
-
-export const hr = () => [
-  styles,
-  ViewPlugin.fromClass(
-    class {
-      rules: DecorationSet;
-      constructor(view: EditorView) {
-        this.rules = placeholderMatcher.createDeco(view);
-      }
-
-      update(update: ViewUpdate) {
-        this.rules = placeholderMatcher.updateDeco(update, this.rules);
-      }
-    },
-    {
-      decorations: (instance) => instance.rules,
-      // TODO(burdon): Is this really atomic (cursor can move into ---).
-      provide: (plugin) =>
-        EditorView.atomicRanges.of((view) => {
-          return view.plugin(plugin)?.rules || Decoration.none;
-        }),
-    },
-  ),
-];

package/src/extensions/image.ts

@@ -1,69 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { syntaxTree } from '@codemirror/language';
-import {
-  type EditorState,
-  type Extension,
-  type RangeSet,
-  RangeSetBuilder,
-  StateField,
-  type Transaction,
-} from '@codemirror/state';
-import { Decoration, EditorView, WidgetType } from '@codemirror/view';
-
-export type ImageOptions = {};
-
-export const image = (options: ImageOptions = {}): Extension => {
-  return StateField.define<RangeSet<any>>({
-    create: (state) => update(state, options),
-    update: (_: RangeSet<any>, tr: Transaction) => update(tr.state, options),
-    provide: (field) => EditorView.decorations.from(field),
-  });
-};
-
-const update = (state: EditorState, options: ImageOptions) => {
-  const builder = new RangeSetBuilder();
-  const cursor = state.selection.main.head;
-
-  syntaxTree(state).iterate({
-    enter: (node) => {
-      if (node.name === 'Image') {
-        const urlNode = node.node.getChild('URL');
-        if (urlNode) {
-          const hide = state.readOnly || cursor < node.from || cursor > node.to;
-          const url = state.sliceDoc(urlNode.from, urlNode.to);
-          builder.add(
-            hide ? node.from : node.to,
-            node.to,
-            Decoration.replace({
-              block: true, // Prevent cursor from entering.
-              widget: new ImageWidget(url),
-            }),
-          );
-        }
-      }
-    },
-  });
-
-  return builder.finish();
-};
-
-class ImageWidget extends WidgetType {
-  constructor(readonly _url: string) {
-    super();
-  }
-
-  // TODO(burdon): Does this need to be unique for each position?
-  override eq(other: WidgetType) {
-    return this._url === (other as any as ImageWidget)._url;
-  }
-
-  toDOM(view: EditorView) {
-    const img = document.createElement('img');
-    img.setAttribute('src', this._url);
-    img.setAttribute('class', 'cm-image');
-    return img;
-  }
-}

package/src/extensions/mermaid.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension } from '@codemirror/state';
-
-// TODO(burdon): How will this interact with the code extension?
-// TODO(burdon): Move to mermaid-plugin (which should contribute this extension).
-export const mermaid = (): Extension => {
-  return [];
-};

package/src/extensions/tasklist.ts

@@ -1,121 +0,0 @@
-//
-// 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',
-  },
-});
-
-class CheckboxWidget extends WidgetType {
-  constructor(
-    private readonly _pos: number,
-    private _checked: boolean,
-    private readonly _indent: number,
-    private readonly _onCheck?: (check: boolean) => void,
-  ) {
-    super();
-  }
-
-  override eq(other: CheckboxWidget) {
-    return this._pos === other._pos && this._checked === other._checked && this._indent === other._indent;
-  }
-
-  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'));
-    input.type = 'checkbox';
-    input.checked = this._checked;
-    if (!this._onCheck) {
-      input.setAttribute('disabled', 'true');
-    }
-    if (this._onCheck) {
-      input.onchange = (event: Event) => {
-        this._onCheck?.((event.target as any).checked);
-        return true;
-      };
-    }
-
-    return wrap;
-  }
-
-  override ignoreEvent() {
-    return 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(
-    class {
-      tasks: DecorationSet;
-      constructor(view: EditorView) {
-        this.tasks = taskMatcher.createDeco(view);
-      }
-
-      update(update: ViewUpdate) {
-        this.tasks = taskMatcher.updateDeco(update, this.tasks);
-      }
-    },
-    {
-      decorations: (value) => value.tasks,
-      provide: (plugin) =>
-        EditorView.atomicRanges.of((view) => {
-          return view.plugin(plugin)?.tasks || Decoration.none;
-        }),
-    },
-  );
-
-  return [tasks, styles];
-};

package/src/extensions/util.ts

@@ -1,18 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { log } from '@dxos/log';
-
-/**
- * CodeMirror callbacks swallow errors so wrap handlers.
- */
-// TODO(burdon): Figure out how to systematize this.
-export const callbackWrapper = <T extends Function>(fn: T): T =>
-  ((...args: any[]) => {
-    try {
-      return fn(...args);
-    } catch (error) {
-      log.catch(error);
-    }
-  }) as unknown as T;

package/src/hooks/automerge/handle.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import type * as A from '@dxos/automerge/automerge';
-
-export type IDocHandle<T = any> = {
-  docSync(): A.Doc<T> | undefined;
-  change(callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): void;
-  changeAt(heads: A.Heads, callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): string[] | undefined;
-
-  addListener(event: 'change', listener: () => void): void;
-  removeListener(event: 'change', listener: () => void): void;
-};

package/src/hooks/automerge/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export { type IDocHandle } from './handle';
-export { automergePlugin, type AutomergePlugin } from './plugin';

package/src/hooks/automerge/plugin.ts

@@ -1,132 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import {
-  Annotation,
-  type EditorState,
-  type Extension,
-  Facet,
-  StateEffect,
-  StateField,
-  type Transaction,
-  type TransactionSpec,
-} from '@codemirror/state';
-import { ViewPlugin, type EditorView, type PluginValue, type ViewUpdate } from '@codemirror/view';
-
-import * as automerge from '@dxos/automerge/automerge';
-import { type Heads, type Prop } from '@dxos/automerge/automerge';
-
-import { type IDocHandle } from './handle';
-import { PatchSemaphore } from './semaphore';
-
-export type Value = {
-  lastHeads: Heads;
-  path: Prop[];
-  unreconciledTransactions: Transaction[];
-};
-
-type UpdateHeads = {
-  newHeads: Heads;
-};
-
-export const effectType = StateEffect.define<UpdateHeads>({});
-
-export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
-
-export const getLastHeads = (state: EditorState, field: Field): Heads => state.field(field).lastHeads;
-
-export const getPath = (state: EditorState, field: Field): Prop[] => state.field(field).path;
-
-export type Field = StateField<Value>;
-
-const semaphoreFacet = Facet.define<PatchSemaphore, PatchSemaphore>({
-  combine: (values) => values.at(-1)!, // Take last.
-});
-
-export type AutomergePlugin = {
-  extension: Extension;
-};
-
-export const automergePlugin = (handle: IDocHandle, path: Prop[]): AutomergePlugin => {
-  const stateField: StateField<Value> = StateField.define({
-    create: () => ({
-      lastHeads: automerge.getHeads(handle.docSync()!),
-      unreconciledTransactions: [],
-      path: path.slice(),
-    }),
-    update: (value: Value, tr: Transaction) => {
-      const result: Value = {
-        lastHeads: value.lastHeads,
-        unreconciledTransactions: value.unreconciledTransactions.slice(),
-        path: path.slice(),
-      };
-      let clearUnreconciled = false;
-      for (const effect of tr.effects) {
-        if (effect.is(effectType)) {
-          result.lastHeads = effect.value.newHeads;
-          clearUnreconciled = true;
-        }
-      }
-      if (clearUnreconciled) {
-        result.unreconciledTransactions = [];
-      } else {
-        if (!isReconcileTx(tr)) {
-          result.unreconciledTransactions.push(tr);
-        }
-      }
-      return result;
-    },
-  });
-
-  const semaphore = new PatchSemaphore(stateField);
-
-  const viewPlugin = ViewPlugin.fromClass(
-    class AutomergeCodemirrorViewPlugin implements PluginValue {
-      constructor(private readonly _view: EditorView) {
-        handle.addListener('change', this._handleChange);
-      }
-
-      update(update: ViewUpdate) {
-        if (update.transactions.length > 0 && update.transactions.some((tr) => !isReconcileTx(tr))) {
-          // TODO(burdon): This is a hack to ensure that the view is updated after the transaction is applied.
-          queueMicrotask(() => {
-            this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
-          });
-        }
-      }
-
-      destroy() {
-        handle.addListener('change', this._handleChange);
-      }
-
-      private _handleChange = () => {
-        this._view.state.facet(semaphoreFacet).reconcile(handle, this._view);
-      };
-    },
-  );
-
-  return {
-    extension: [stateField, semaphoreFacet.of(semaphore), viewPlugin],
-  };
-};
-
-export const reconcileAnnotationType = Annotation.define<unknown>();
-
-export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
-
-export const makeReconcile = (tr: TransactionSpec) => {
-  if (tr.annotations != null) {
-    if (tr.annotations instanceof Array) {
-      tr.annotations = [...tr.annotations, reconcileAnnotationType.of({})];
-    } else {
-      tr.annotations = [tr.annotations, reconcileAnnotationType.of({})];
-    }
-  } else {
-    tr.annotations = [reconcileAnnotationType.of({})];
-  }
-  // return {
-  // ...tr,
-  // annotations: reconcileAnnotationType.of({})
-  // }
-};