@dxos/react-ui-editor 0.3.11-main.9c729f3 → 0.3.11-main.9de2c34

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/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/yjs/cursor.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Y from 'yjs';
-
-import { arrayToString, stringToArray } from '@dxos/util';
-
-import { type CursorConverter } from '../../util';
-
-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('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 { CursorConverter } from '../../util';
-
-export const yjs = (content: YText, awareness?: YP.Awareness) => [
-  CursorConverter.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,178 +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 * as Y from 'yjs';
-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 { arrayToString, stringToArray } from '@dxos/util';
-
-import { type EditorModel, modelState, type Range, 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(),
-    // https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
-    // TODO(dmaretskyi): Refactor as cursor-converter.
-    getCursorFromRange: (range: Range) => {
-      const from = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.from));
-      const to = Y.encodeRelativePosition(Y.createRelativePositionFromTypeIndex(text.content as YText, range.to, -1));
-      return [arrayToString(from), arrayToString(to)].join(':');
-    },
-    getRangeFromCursor: (cursor: string) => {
-      invariant(text.doc);
-      const parts = cursor.split(':');
-      const from = Y.createAbsolutePositionFromRelativePosition(
-        Y.decodeRelativePosition(stringToArray(parts[0])),
-        text.doc,
-      );
-      const to = Y.createAbsolutePositionFromRelativePosition(
-        Y.decodeRelativePosition(stringToArray(parts[1])),
-        text.doc,
-      );
-      return from && to ? { from: from.index, to: to.index } : undefined;
-    },
-    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';

package/src/testing/proto/gen/schema.ts

@@ -1,49 +0,0 @@
-/**
- * @generated @dxos/echo-typegen src/testing/proto/schema.proto
- **/
-
-import * as dxos_echo_schema from "@dxos/echo-schema";
-
-export const types = new dxos_echo_schema.TypeCollection();
-
-export type EditorDocumentProps = {
-  content: dxos_echo_schema.Text;
-};
-
-export class EditorDocument extends dxos_echo_schema.TypedObject<EditorDocumentProps> {
-  declare static readonly schema: dxos_echo_schema.Schema;
-
-  static filter(
-    filter?:
-      | Partial<EditorDocumentProps>
-      | dxos_echo_schema.OperatorFilter<EditorDocument>
-  ): dxos_echo_schema.Filter<EditorDocument> {
-    return dxos_echo_schema.Filter.typename(
-      "dxos.testing.editor.EditorDocument",
-      filter
-    );
-  }
-
-  constructor(
-    initValues?: Partial<EditorDocumentProps>,
-    opts?: dxos_echo_schema.TypedObjectOptions
-  ) {
-    super({ ...initValues }, { schema: EditorDocument.schema, ...opts });
-  }
-  declare content: dxos_echo_schema.Text;
-}
-
-types.registerPrototype(EditorDocument, {
-  typename: "dxos.testing.editor.EditorDocument",
-  props: [
-    {
-      id: "content",
-      type: 5,
-      repeated: false,
-      refName: "dxos.schema.Text",
-      refModelType: "dxos.org/model/text",
-    },
-  ],
-});
-
-types.link();

package/src/testing/proto/index.ts

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

package/src/testing/proto/schema.proto

@@ -1,15 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-syntax = "proto3";
-
-import "dxos/schema.proto";
-
-package dxos.testing.editor;
-
-message EditorDocument {
-  option (object) = true;
-
-  dxos.schema.Text content = 1;
-}

package/src/testing/replicator.ts

@@ -1,184 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-// TODO(wittjosiah): Remove. Use DXOS protocols to reduce duplicate functionality weighing down apps.
-import * as decoding from 'lib0/decoding';
-import * as encoding from 'lib0/encoding';
-import { Observable } from 'lib0/observable';
-import { useMemo } from 'react';
-import * as YP from 'y-protocols/awareness';
-import * as syncProtocol from 'y-protocols/sync';
-import { Doc } from 'yjs';
-
-import { Event } from '@dxos/async';
-import { log } from '@dxos/log';
-import { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
-
-import { type EditorModel } from '../hooks';
-import { cursorColor } from '../styles';
-
-type Awareness = YP.Awareness;
-
-const messageSync = 0;
-const messageAwareness = 1;
-const messageQueryAwareness = 3;
-
-/**
- * Yjs awareness provider in-memory.
- */
-export class AwarenessProvider extends Observable<any> {
-  private readonly _remoteUpdate: Event<Uint8Array>;
-  private readonly _awareness: Awareness;
-  private readonly _doc: Doc;
-
-  constructor({ update, doc, awareness }: { update: Event<Uint8Array>; doc: Doc; awareness?: Awareness }) {
-    super();
-    this._remoteUpdate = update;
-    this._doc = doc;
-    this._awareness = awareness ?? new YP.Awareness(doc);
-
-    this._doc.on('update', this._handleDocUpdate.bind(this));
-    this._awareness.on('update', this._handleAwarenessUpdate.bind(this));
-    this._remoteUpdate.on(this._handleRemoteUpdate.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._remoteUpdate.emit(encoding.toUint8Array(encoderAwarenessQuery));
-
-    // Post local awareness state.
-    const encoderAwarenessState = encoding.createEncoder();
-    encoding.writeVarUint(encoderAwarenessState, messageAwareness);
-    encoding.writeVarUint8Array(encoderAwarenessState, YP.encodeAwarenessUpdate(this.awareness, [this._doc.clientID]));
-    void this._remoteUpdate.emit(encoding.toUint8Array(encoderAwarenessState));
-  }
-
-  get awareness(): Awareness {
-    return this._awareness;
-  }
-
-  private _handleDocUpdate(update: Uint8Array, origin: any) {
-    log('doc update', { update, origin });
-    const encoder = encoding.createEncoder();
-    encoding.writeVarUint(encoder, messageSync);
-    syncProtocol.writeUpdate(encoder, update);
-    this._remoteUpdate.emit(encoding.toUint8Array(encoder));
-  }
-
-  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));
-    this._remoteUpdate.emit(encoding.toUint8Array(encoderAwareness));
-  }
-
-  private _handleRemoteUpdate(payload: Uint8Array) {
-    log('remote update', { payload });
-    const data = new Uint8Array(Array.from(Object.values(payload)));
-    const encoder = this._readMessage(data);
-    if (encoder) {
-      this._remoteUpdate.emit(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 messageSync: {
-        encoding.writeVarUint(encoder, messageSync);
-        syncProtocol.readSyncMessage(decoder, encoder, this._doc, this);
-        break;
-      }
-
-      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._doc.clientID], 'window unload');
-  }
-}
-
-/**
- * This mocks the replication across the swarm.
- */
-export class Replicator {
-  private readonly _update = new Event<Uint8Array>();
-  private _peers: EditorModel[] = [];
-
-  constructor(private readonly _kind: TextKind) {}
-
-  setPeers(peers: EditorModel[]) {
-    this._peers = peers;
-  }
-
-  createPeer = (id: string, doc: Doc = new Doc()): EditorModel => {
-    const provider = new AwarenessProvider({ update: this._update, doc });
-    provider.awareness.setLocalStateField('user', {
-      name: 'Anonymous ' + Math.floor(Math.random() * 100),
-      color: cursorColor.color,
-      colorLight: cursorColor.light,
-    });
-
-    const field = 'content';
-    const content = this._kind === TextKind.PLAIN ? doc.getText(field) : doc.getXmlFragment(field);
-    const model: EditorModel = {
-      id: doc.guid,
-      text: () => content.toString(),
-      content,
-      awareness: provider.awareness,
-      peer: { id },
-    };
-
-    this._peers.push(model);
-    return model;
-  };
-}
-
-export type UseYjsModelOptions = {
-  replicator: Replicator;
-  id: string;
-  doc?: Doc;
-};
-
-export const useYjsModel = ({ replicator, id, doc }: UseYjsModelOptions): EditorModel => {
-  return useMemo(() => replicator.createPeer(id, doc), [doc]);
-};

package/src/util/cursor.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Facet } from '@codemirror/state';
-
-/**
- * Converts indexes into the text document into stable peer-independent cursors.
- *
- * See:
- *  - https://automerge.org/automerge/api-docs/js/functions/next.getCursor.html
- *  - https://github.com/yjs/yjs?tab=readme-ov-file#relative-positions
- *
- * @param {assoc} number Negative values will associate the cursor with the previous character
- *                       while positive - with the next one.
- */
-export interface CursorConverter {
-  toCursor(position: number, assoc?: -1 | 1 | undefined): string;
-  fromCursor(cursor: string): number;
-}
-
-const DEFAULT_CURSOR_CONVERTER: CursorConverter = {
-  toCursor: (position) => position.toString(),
-  fromCursor: (cursor) => parseInt(cursor),
-};
-
-export const CursorConverter = Facet.define<CursorConverter, CursorConverter>({
-  combine: (providers) => providers[0] ?? DEFAULT_CURSOR_CONVERTER,
-});

package/src/util/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './cursor';
-export * from './util';