@dxos/react-ui-editor 0.3.11-main.7ff9773 → 0.3.11-main.80db41b

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/comments.stories.tsx

@@ -1,357 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxosTheme';
-
-import { type EditorView, keymap } from '@codemirror/view';
-import { faker } from '@faker-js/faker';
-import { Check, Trash } from '@phosphor-icons/react';
-import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
-
-import { getTextContent, TextObject } from '@dxos/echo-schema';
-import { PublicKey } from '@dxos/keys';
-import { log } from '@dxos/log';
-import { Button, DensityProvider } from '@dxos/react-ui';
-import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
-import { withTheme } from '@dxos/storybook-utils';
-
-import { MarkdownEditor, TextEditor } from './TextEditor';
-import { comments, type CommentsOptions, setFocus, useComments } from '../../extensions';
-import { type Comment, type Range, useTextModel } from '../../hooks';
-
-faker.seed(101);
-
-//
-// Editor
-//
-
-const Editor: FC<{
-  item: { text: TextObject };
-  comments: Comment[];
-  selected?: string;
-  onCreateComment: CommentsOptions['onCreate'];
-  onDeleteComment: CommentsOptions['onDelete'];
-  onUpdateComment: CommentsOptions['onUpdate'];
-  onSelectComment: CommentsOptions['onSelect'];
-}> = ({
-  item,
-  selected: selectedValue,
-  comments: commentRanges,
-  onCreateComment,
-  onDeleteComment,
-  onUpdateComment,
-  onSelectComment,
-}) => {
-  const model = useTextModel({ text: item.text });
-  const view = useRef<EditorView>(null);
-  const [selected, setSelected] = useState<string>();
-  useEffect(() => {
-    if (!view.current?.hasFocus && selectedValue !== selected) {
-      setSelected(selectedValue);
-      if (selectedValue) {
-        setFocus(view.current!, selectedValue);
-      }
-    }
-  }, [selected, commentRanges, selectedValue]);
-
-  useComments(view.current, commentRanges);
-
-  const extensions = useMemo(() => {
-    return [
-      comments({
-        onCreate: onCreateComment,
-        onDelete: onDeleteComment,
-        onUpdate: onUpdateComment,
-        onSelect: onSelectComment,
-      }),
-    ];
-  }, []);
-
-  if (!model) {
-    return null;
-  }
-
-  // TODO(burdon): Highlight currently selected comment.
-  return (
-    <div className='flex grow overflow-y-scroll'>
-      <MarkdownEditor ref={view} model={model} extensions={extensions} />
-    </div>
-  );
-};
-
-//
-// Comments thread
-//
-
-type CommentThread = {
-  id: string;
-  cursor?: string;
-  range?: Range;
-  yPos?: number;
-  messages: TextObject[];
-};
-
-const Thread: FC<{
-  thread: CommentThread;
-  selected: boolean;
-  onSelect: () => void;
-  onResolve: () => void;
-}> = ({ thread, selected, onSelect, onResolve }) => {
-  const [focus, setFocus] = useState(false);
-  const [item, setItem] = useState({ text: new TextObject() });
-  const model = useTextModel({ text: item.text });
-  const editorRef = useRef<EditorView>(null);
-
-  const containerRef = useRef<HTMLDivElement>(null);
-  useEffect(() => {
-    if (selected) {
-      containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
-      if (thread.messages.length === 0) {
-        setFocus(true);
-      }
-    }
-  }, [selected]);
-
-  const handleCreateMessage = () => {
-    const text = model?.text().trim();
-    if (text?.length) {
-      thread.messages.push(item.text);
-      setItem({ text: new TextObject() });
-      setFocus(true);
-    }
-  };
-
-  if (!model) {
-    return null;
-  }
-
-  return (
-    <div
-      className={mx(
-        'flex flex-col m-1 rounded shadow divide-y bg-white',
-        selected && 'ring',
-        !thread.cursor && 'opacity-50',
-      )}
-    >
-      <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
-        <span>id:{thread.id.slice(0, 4)}</span>
-        <span>from:{thread.range?.from}</span>
-        <span>to:{thread.range?.to}</span>
-        <span>y:{thread.yPos}</span>
-        <span className='grow' />
-        {!thread.cursor && <Trash />}
-      </div>
-
-      {thread.messages.map((message, i) => (
-        // TODO(burdon): Fix default editor padding so content doesn't jump on creating message.
-        <div key={i} className='p-2' onClick={() => onSelect()}>
-          {getTextContent(message)}
-        </div>
-      ))}
-
-      <div ref={containerRef} onClick={() => onSelect()} className='flex'>
-        <TextEditor
-          ref={editorRef}
-          autofocus={focus}
-          model={model}
-          placeholder={'Enter comment...'}
-          slots={{ root: { className: 'grow rounded-b' } }}
-          extensions={[
-            keymap.of([
-              {
-                key: 'Enter',
-                run: () => {
-                  handleCreateMessage();
-                  return true;
-                },
-              },
-            ]),
-          ]}
-        />
-        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
-          <Check />
-        </Button>
-      </div>
-    </div>
-  );
-};
-
-const Sidebar: FC<{
-  threads: CommentThread[];
-  selected?: string;
-  onSelect: (thread: string) => void;
-  onResolve: (thread: string) => void;
-}> = ({ threads, selected, onSelect, onResolve }) => {
-  // Sort by y-position.
-  const sortedThreads = useMemo(() => {
-    const sorted = [...threads];
-    return sorted.sort(({ yPos: a = Infinity }, { yPos: b = Infinity }) => {
-      return a < b ? -1 : a > b ? 1 : 0;
-    });
-  }, [threads]);
-
-  return (
-    <DensityProvider density='fine'>
-      <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
-        {sortedThreads.map((thread) => (
-          <Thread
-            key={thread.id}
-            thread={thread}
-            selected={thread.id === selected}
-            onSelect={() => onSelect(thread.id)}
-            onResolve={() => onResolve(thread.id)}
-          />
-        ))}
-      </div>
-    </DensityProvider>
-  );
-};
-
-//
-// Story container.
-//
-
-type StoryProps = {
-  text?: string;
-  autoCreate?: boolean;
-};
-
-const Story = ({ text, autoCreate }: StoryProps) => {
-  const [item] = useState({ text: new TextObject(text) });
-  const [threads, setThreads] = useState<CommentThread[]>([]);
-  const [selected, setSelected] = useState<string>();
-
-  const comments = useMemo<Comment[]>(() => threads.map(({ id, cursor }) => ({ id, cursor })), [threads]);
-
-  // Filter by visibility.
-  const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
-
-  const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
-    const id = PublicKey.random().toHex();
-    log.info('create', { id: id.slice(0, 4), cursor });
-    setThreads((threads) => [
-      ...threads,
-      {
-        id,
-        cursor,
-        yPos: location ? Math.floor(location.top) : undefined,
-        messages: autoCreate
-          ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
-          : [],
-      },
-    ]);
-    setSelected(id);
-    return id;
-  };
-
-  const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
-    log.info('delete', { id: id.slice(0, 4) });
-    setThreads((threads) =>
-      threads.map((thread) => {
-        if (thread.id === id) {
-          thread.cursor = undefined;
-        }
-
-        return thread;
-      }),
-    );
-
-    setSelected((selected) => (selected === id ? undefined : selected));
-  };
-
-  const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
-    log.info('update', { id: id.slice(0, 4), cursor });
-    setThreads((threads) =>
-      threads.map((thread) => {
-        if (thread.id === id) {
-          thread.cursor = cursor;
-        }
-
-        return thread;
-      }),
-    );
-  };
-
-  const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { active, closest } }) => {
-    log.info('select', { active: active?.slice(0, 4), closest: closest?.slice(0, 4) });
-    setThreads((threads) =>
-      threads.map((thread) => {
-        const comment = comments.find(({ comment }) => comment.id === thread.id);
-        if (comment) {
-          thread.yPos = comment.location ? Math.floor(comment.location.top) : undefined;
-          thread.range = { from: comment.range.from, to: comment.range.to };
-        }
-
-        return thread;
-      }),
-    );
-
-    setSelected(active ?? closest);
-  };
-
-  const handleSelectThread = (id: string) => {
-    setSelected(id);
-  };
-
-  const handleResolveThread = (id: string) => {
-    setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
-    setSelected(undefined);
-  };
-
-  return (
-    <div className={mx(fixedInsetFlexLayout, 'bg-neutral-100')}>
-      <div className='flex justify-center h-full gap-8'>
-        <div className='flex flex-col h-full w-[600px]'>
-          <Editor
-            item={item}
-            selected={selected}
-            comments={comments}
-            onCreateComment={handleCreateComment}
-            onDeleteComment={handleDeleteComment}
-            onUpdateComment={handleUpdateComment}
-            onSelectComment={handleSelectComment}
-          />
-        </div>
-
-        <div className='flex flex-col h-full w-[300px]'>
-          <Sidebar
-            threads={visibleThreads}
-            selected={selected}
-            onSelect={handleSelectThread}
-            onResolve={handleResolveThread}
-          />
-        </div>
-      </div>
-    </div>
-  );
-};
-
-export default {
-  title: 'react-ui-editor/comments',
-  component: MarkdownEditor,
-  decorators: [withTheme],
-  render: (args: StoryProps) => <Story {...args} />,
-};
-
-const str = (...lines: string[]) => lines.join('\n');
-
-const document = str(
-  '# Comments',
-  '',
-  str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
-  '',
-);
-
-export const Default = {
-  args: {
-    text: document,
-  },
-};
-
-export const Testing = {
-  args: {
-    text: document,
-    autoCreate: true,
-  },
-};

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,104 +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 buildDecorations = (view: EditorView) => {
-    const decorations: Range<Decoration>[] = [];
-    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 = buildDecorations(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 = buildDecorations(update.view);
-          }
-        }
-      },
-      {
-        decorations: (value) => value.decorations,
-      },
-    ),
-    styles,
-  ];
-};

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');
-    }
-  });
-});