@dxos/react-ui-editor 0.3.11-main.c86e105 → 0.3.11-main.cc2fe2c

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

@@ -1,115 +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 { YAwarenessProvider } from '../../hooks';
-import { cursorColor } from '../../styles';
-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 YAwarenessProvider({ 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/components/TextEditor/yjs.stories.tsx

@@ -1,56 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxosTheme';
-
-import React, { useState } from 'react';
-
-import { PublicKey } from '@dxos/react-client';
-import { TextKind } from '@dxos/react-client/echo';
-import { ClientRepeater, textGenerator, useDataGenerator } from '@dxos/react-client/testing';
-import { useId, Input } from '@dxos/react-ui';
-import { withTheme } from '@dxos/storybook-utils';
-
-import { MarkdownEditor } from './TextEditor';
-import { Replicator, useYjsModel } from '../../testing';
-
-export default {
-  title: 'react-ui-editor/YJS',
-  component: MarkdownEditor,
-  decorators: [withTheme],
-};
-
-const replicator = new Replicator(TextKind.PLAIN);
-
-const Story = () => {
-  const [generate, setGenerate] = useState(false);
-  const generateId = useId('generate');
-
-  const [id] = useState(PublicKey.random().toHex());
-  const model = useYjsModel({ id, replicator });
-
-  useDataGenerator({
-    generator: generate ? textGenerator : undefined,
-    options: { text: typeof model?.content !== 'string' ? (model?.content as any) : undefined },
-  });
-
-  return (
-    <main className='flex flex-col flex-1 p-4 gap-4'>
-      <div id={generateId} className='flex gap-2'>
-        <Input.Root>
-          <Input.Checkbox checked={generate} onCheckedChange={(checked) => setGenerate(!!checked)} />
-          <Input.Label>Start</Input.Label>
-        </Input.Root>
-      </div>
-      <div className='border'>
-        <MarkdownEditor model={model} />
-      </div>
-    </main>
-  );
-};
-
-export const Default = {
-  // TODO(wittjosiah): Decorator for doing this without clients being initialized?
-  render: () => <ClientRepeater count={2} Component={Story} />,
-};

package/src/extensions/code.ts

@@ -1,106 +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 { mx } from '@dxos/react-ui-theme';
-
-import { getToken } from '../styles';
-
-const CODE_REGEX = /```[\s\S]*?```/gs;
-
-// TODO(burdon): Reconcile with theme.
-const styles = EditorView.baseTheme({
-  '& .cm-codeblock': {
-    fontFamily: getToken('fontFamily.mono', []).join(','),
-  },
-  '&light [aria-readonly="true"] .cm-codeblock': {
-    background: getToken('extend.colors.neutral.50'),
-  },
-  '&dark [aria-readonly="true"] .cm-codeblock': {
-    background: getToken('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.hasFocus || 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 {
-        hasFocus = false;
-        decorations: DecorationSet;
-        constructor(view: EditorView) {
-          this.decorations = getDecorations(view);
-        }
-
-        update(update: ViewUpdate) {
-          if (
-            // TODO(burdon): Generalize for other extensions.
-            this.hasFocus !== update.view.hasFocus ||
-            update.startState.readOnly !== update.view.state.readOnly ||
-            update.docChanged ||
-            update.viewportChanged
-          ) {
-            this.hasFocus = update.view.hasFocus;
-            this.decorations = getDecorations(update.view);
-          }
-        }
-      },
-      {
-        decorations: (value) => value.decorations,
-      },
-    ),
-    styles,
-  ];
-};

package/src/extensions/hr.ts

@@ -1,73 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import {
-  Decoration,
-  type DecorationSet,
-  EditorView,
-  MatchDecorator,
-  ViewPlugin,
-  type ViewUpdate,
-  WidgetType,
-} from '@codemirror/view';
-
-import { getToken } 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 ${getToken('extend.colors.neutral.200')}`,
-  },
-});
-
-class HorizontalRuleWidget extends WidgetType {
-  constructor(readonly _pos: number) {
-    super();
-  }
-
-  override eq(other: this) {
-    return this._pos === (other as any as HorizontalRuleWidget)._pos;
-  }
-
-  override 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/yjs/cursor.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Y from 'yjs';
-
-import { arrayToString, stringToArray } from '@dxos/util';
-
-import { type CursorConverter } from '../cursor';
-
-export const cursorConverter = (text: Y.Text): CursorConverter => ({
-  toCursor: (index, assoc) => {
-    return arrayToString(Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text, index, assoc)));
-  },
-
-  fromCursor: (cursor) => {
-    return (
-      Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(stringToArray(cursor)), text.doc!)?.index ??
-      0
-    );
-  },
-});

package/src/extensions/yjs/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './yjs';

package/src/extensions/yjs/yjs.test.ts

@@ -1,35 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { expect } from 'chai';
-import * as Y from 'yjs';
-
-import { TextObject } from '@dxos/echo-schema';
-import { describe, test } from '@dxos/test';
-import { type YText } from '@dxos/text-model';
-
-describe('YJS', () => {
-  // https://docs.yjs.dev/api/shared-types/y.text
-  // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
-  test.skip('absolute position', () => {
-    const obj = new TextObject('hello world');
-    const index = obj.text.indexOf('world');
-    const relPos = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(obj.content as YText, index));
-
-    {
-      const cursor = Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(relPos), obj.doc!);
-      expect(cursor!.index).to.equal(index);
-      expect(obj.text.substring(cursor!.index)).to.equal('world');
-    }
-
-    (obj.content as YText).insert(index, 'cruel ');
-    expect(obj.text).to.equal('hello cruel world');
-
-    {
-      const cursor = Y.createAbsolutePositionFromRelativePosition(Y.decodeRelativePosition(relPos), obj.doc!);
-      expect(cursor!.index).not.to.equal(index);
-      expect(obj.text.substring(cursor!.index)).to.equal('world');
-    }
-  });
-});

package/src/extensions/yjs/yjs.ts

@@ -1,16 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { yCollab } from 'y-codemirror.next';
-import type * as YP from 'y-protocols/awareness';
-
-import type { YText } from '@dxos/text-model';
-
-import { cursorConverter } from './cursor';
-import { Cursor } from '../cursor';
-
-export const yjs = (content: YText, awareness?: YP.Awareness) => [
-  Cursor.converter.of(cursorConverter(content)),
-  yCollab(content, awareness),
-];

package/src/hooks/automerge.ts

@@ -1,52 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import get from 'lodash.get';
-
-import { type AutomergeTextCompat, getRawDoc } from '@dxos/echo-schema';
-import { isNotNullOrUndefined } from '@dxos/util';
-
-import { SpaceAwarenessProvider } from './awareness-provider';
-import { type EditorModel, modelState, type UseTextModelProps } from './useTextModel';
-import { automerge, awareness, AwarenessProvider } from '../extensions';
-import { cursorColor } from '../styles';
-
-export const createAutomergeModel = ({ space, identity, text }: UseTextModelProps): EditorModel => {
-  const obj = text as any as AutomergeTextCompat;
-  const doc = getRawDoc(obj, [obj.field]);
-
-  const awarenessProvider =
-    space &&
-    new SpaceAwarenessProvider({
-      space,
-      channel: `automerge.awareness.${obj.id}`,
-      info: {
-        displayName: identity?.profile?.displayName ?? '',
-        color: cursorColor.color,
-        lightColor: cursorColor.light,
-      },
-      peerId: identity?.identityKey.toHex() ?? 'Anonymous',
-    });
-
-  const model: EditorModel = {
-    id: obj.id,
-    content: doc,
-    text: () => get(doc.handle.docSync(), doc.path),
-    // TODO(burdon): https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
-    extension: [
-      modelState.init(() => model),
-      automerge({ handle: doc.handle, path: doc.path }),
-      awarenessProvider && AwarenessProvider.of(awarenessProvider),
-      awareness(),
-    ].filter(isNotNullOrUndefined),
-    peer: identity
-      ? {
-          id: identity.identityKey.toHex(),
-          name: identity.profile?.displayName,
-        }
-      : undefined,
-  };
-
-  return model;
-};

package/src/hooks/yjs.ts

@@ -1,156 +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 YP from 'y-protocols/awareness';
-import { type Doc } from 'yjs';
-
-import { invariant } from '@dxos/invariant';
-import { log } from '@dxos/log';
-import { type Space } from '@dxos/react-client/echo';
-import { type GossipMessage } from '@dxos/react-client/mesh';
-import type { YText } from '@dxos/text-model';
-
-import { type EditorModel, modelState, type UseTextModelProps } from './useTextModel';
-import { yjs } from '../extensions';
-
-export const createYjsModel = ({ identity, space, text }: UseTextModelProps): EditorModel => {
-  invariant(text?.doc && text?.content);
-  const provider = space
-    ? new YAwarenessProvider({ space, doc: text.doc, channel: `yjs.awareness.${text.id}` })
-    : undefined;
-
-  const model: EditorModel = {
-    id: text.doc.guid,
-    content: text.content,
-    text: () => text.content!.toString(),
-    extension: [modelState.init(() => model), yjs(text.content as YText, provider?.awareness)],
-    awareness: provider?.awareness,
-    peer: identity
-      ? {
-          id: identity.identityKey.toHex(),
-          name: identity.profile?.displayName,
-        }
-      : undefined,
-  };
-
-  return model;
-};
-
-// 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 YAwarenessProvider extends Observable<any> {
-  private readonly _space: Space;
-  private readonly _awareness: YP.Awareness;
-  private readonly _clientId: number;
-  private readonly _channel: string;
-
-  constructor({
-    space,
-    doc,
-    channel,
-    awareness,
-  }: {
-    space: Space;
-    doc: Doc;
-    channel: string;
-    awareness?: YP.Awareness;
-  }) {
-    super();
-    this._space = space;
-    this._awareness = awareness ?? new YP.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, YP.encodeAwarenessUpdate(this.awareness, [this._clientId]));
-    void this._space.postMessage(this._channel, encoding.toUint8Array(encoderAwarenessState));
-  }
-
-  get awareness(): YP.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, YP.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: {
-        YP.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
-        break;
-      }
-
-      case messageQueryAwareness: {
-        encoding.writeVarUint(encoder, messageAwareness);
-        encoding.writeVarUint8Array(
-          encoder,
-          YP.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() {
-    YP.removeAwarenessStates(this._awareness, [this._clientId], 'window unload');
-  }
-}

package/src/testing/index.ts

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