@dxos/react-ui-editor 0.3.11-main.668f0ff → 0.3.11-main.674a7f9

package/src/components/TextEditor/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/components/TextEditor/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/components/TextEditor/extensions/listener.ts

@@ -1,39 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Extension, StateField } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-
-import { nonNullable } from '@dxos/util';
-
-export type ListenerOptions = {
-  onFocus?: (focused: boolean) => void;
-  onChange?: (text: string) => void;
-};
-
-/**
- * Event listener.
- */
-export const listener = ({ onFocus, onChange }: ListenerOptions): Extension =>
-  [
-    onFocus
-      ? EditorView.focusChangeEffect.of((view, focused) => {
-          onFocus(focused);
-          return null;
-        })
-      : undefined,
-
-    onChange
-      ? StateField.define({
-          create: () => null,
-          update: (_value, transaction) => {
-            if (transaction.docChanged) {
-              onChange(transaction.newDoc.toString());
-            }
-
-            return null;
-          },
-        })
-      : undefined,
-  ].filter(nonNullable);

package/src/components/TextEditor/extensions/markdown/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './bundle';
-export * from './highlight';

package/src/components/TextEditor/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/components/TextEditor/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/components/TextEditor/extensions/tooltip.ts

@@ -1,61 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Extension } from '@codemirror/state';
-import { hoverTooltip } from '@codemirror/view';
-
-import { tooltipContent } from '@dxos/react-ui-theme';
-
-const markdownLinkRegexp = /\[([^\]]+)]\(([^)]+)\)/;
-
-export type TooltipOptions = {
-  onHover: (el: Element, url: string) => void;
-  regexp?: RegExp;
-};
-
-/**
- * https://codemirror.net/examples/tooltip
- * https://codemirror.net/docs/ref/#view.hoverTooltip
- * https://github.com/codemirror/view/blob/main/src/tooltip.ts
- */
-export const tooltip = ({ onHover, regexp = markdownLinkRegexp }: TooltipOptions): Extension =>
-  hoverTooltip((view, pos) => {
-    const { from, text } = view.state.doc.lineAt(pos);
-    const p = pos - from;
-
-    let idx = 0;
-    let match;
-    do {
-      match = text.substring(idx).match(regexp);
-      if (!match) {
-        match = undefined;
-        break;
-      }
-
-      idx = text.indexOf(match[0]);
-      if (p >= idx && p < idx + match[0].length) {
-        break;
-      }
-
-      idx += match[0].length;
-    } while (true);
-
-    if (!match) {
-      return null;
-    }
-
-    const [, , url] = match ?? [];
-
-    return {
-      pos: idx + from,
-      end: idx + from + match[0].length,
-      above: true,
-      create: () => {
-        const el = document.createElement('div');
-        el.className = tooltipContent({}, 'pli-2 plb-1');
-        onHover(el, url);
-        return { dom: el, offset: { x: 0, y: 4 } };
-      },
-    };
-  });

package/src/components/TextEditor/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,134 +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 {
-      private _view: EditorView;
-
-      constructor(view: EditorView) {
-        this._view = view;
-        handle.addListener('change', this._handleChange);
-      }
-
-      update(update: ViewUpdate) {
-        if (update.transactions.length > 0 && update.transactions.some((t) => !isReconcileTx(t))) {
-          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({})
-  // }
-};

package/src/hooks/yjs/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './cursors';
-export * from './space-provider';

package/src/hooks/yjs/space-provider.ts

@@ -1,126 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as decoding from 'lib0/decoding';
-import * as encoding from 'lib0/encoding';
-import { Observable } from 'lib0/observable';
-import * as awarenessProtocol from 'y-protocols/awareness';
-import { type Doc } from 'yjs';
-
-import { log } from '@dxos/log';
-import { type Space } from '@dxos/react-client/echo';
-import { type GossipMessage } from '@dxos/react-client/mesh';
-
-type Awareness = awarenessProtocol.Awareness;
-
-// Based on https://github.com/yjs/y-webrtc/blob/88baab2/src/y-webrtc.js.
-
-const messageAwareness = 1;
-const messageQueryAwareness = 3;
-
-/**
- * Yjs awareness provider on top of a DXOS space.
- */
-export class SpaceAwarenessProvider extends Observable<any> {
-  private readonly _space: Space;
-  private readonly _awareness: Awareness;
-  private readonly _clientId: number;
-  private readonly _channel: string;
-
-  constructor({ space, doc, channel, awareness }: { space: Space; doc: Doc; channel: string; awareness?: Awareness }) {
-    super();
-    this._space = space;
-    this._awareness = awareness ?? new awarenessProtocol.Awareness(doc);
-    this._channel = channel;
-    this._clientId = doc.clientID;
-
-    this._awareness.on('update', this._handleAwarenessUpdate.bind(this));
-    this._space.listen(this._channel, this._handleSpaceMessage.bind(this));
-
-    if (typeof window !== 'undefined') {
-      window.addEventListener('beforeunload', this._handleBeforeUnload.bind(this));
-    } else if (typeof process !== 'undefined') {
-      process.on('exit', this._handleBeforeUnload.bind(this));
-    }
-
-    // Post queryAwareness.
-    const encoderAwarenessQuery = encoding.createEncoder();
-    encoding.writeVarUint(encoderAwarenessQuery, messageQueryAwareness);
-    void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwarenessQuery));
-
-    // Post local awareness state.
-    const encoderAwarenessState = encoding.createEncoder();
-    encoding.writeVarUint(encoderAwarenessState, messageAwareness);
-    encoding.writeVarUint8Array(
-      encoderAwarenessState,
-      awarenessProtocol.encodeAwarenessUpdate(this.awareness, [this._clientId]),
-    );
-    void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwarenessState));
-  }
-
-  get awareness(): Awareness {
-    return this._awareness;
-  }
-
-  private _handleAwarenessUpdate({ added, updated, removed }: any, origin: any) {
-    log('awareness update', { added, updated, removed, origin });
-    const changedClients = added.concat(updated).concat(removed);
-    const encoderAwareness = encoding.createEncoder();
-    encoding.writeVarUint(encoderAwareness, messageAwareness);
-    encoding.writeVarUint8Array(
-      encoderAwareness,
-      awarenessProtocol.encodeAwarenessUpdate(this._awareness, changedClients),
-    );
-    void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwareness));
-  }
-
-  private _handleSpaceMessage({ payload }: GossipMessage) {
-    log('space message', payload);
-    const data = new Uint8Array(Array.from(Object.values(payload)));
-    const encoder = this._readMessage(data);
-    if (encoder) {
-      void this._space.postMessage(this._channel, encoding.toUint8Array(encoder));
-    }
-  }
-
-  private _readMessage(message: Uint8Array) {
-    const decoder = decoding.createDecoder(message);
-    const encoder = encoding.createEncoder();
-    const messageType = decoding.readVarUint(decoder);
-
-    let sendReply = false;
-    switch (messageType) {
-      case messageAwareness: {
-        awarenessProtocol.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
-        break;
-      }
-
-      case messageQueryAwareness: {
-        encoding.writeVarUint(encoder, messageAwareness);
-        encoding.writeVarUint8Array(
-          encoder,
-          awarenessProtocol.encodeAwarenessUpdate(this._awareness, Array.from(this._awareness.getStates().keys())),
-        );
-        sendReply = true;
-        break;
-      }
-
-      default: {
-        console.error('Invalid message:', messageType);
-        return encoder;
-      }
-    }
-
-    if (!sendReply) {
-      // Nothing has been written, no answer created.
-      return null;
-    }
-
-    return encoder;
-  }
-
-  private _handleBeforeUnload() {
-    awarenessProtocol.removeAwarenessStates(this._awareness, [this._clientId], 'window unload');
-  }
-}