@dxos/react-ui-thread 0.8.4-main.b97322e → 0.8.4-main.bc2380dfbc

package/package.json

@@ -1,55 +1,65 @@
 {
   "name": "@dxos/react-ui-thread",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.bc2380dfbc",
   "description": "A set of components to use with threads, including comments and messages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
+  "imports": {
+    "#translations": "./src/translations.ts"
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "browser": "./dist/lib/browser/translations.mjs",
+      "node": "./dist/lib/node-esm/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/react-primitive": "2.0.2",
-    "date-fns": "^3.3.1",
-    "@dxos/react-ui-editor": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e"
+    "date-fns": "^3.6.0",
+    "@dxos/react-ui-editor": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-editor": "0.8.4-main.bc2380dfbc",
+    "@dxos/util": "0.8.4-main.bc2380dfbc"
   },
   "devDependencies": {
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/echo-db": "0.8.4-main.b97322e",
-    "@dxos/keys": "0.8.4-main.b97322e",
-    "@dxos/live-object": "0.8.4-main.b97322e",
-    "@dxos/echo-schema": "0.8.4-main.b97322e",
-    "@dxos/random": "0.8.4-main.b97322e",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/log": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e",
-    "@dxos/storybook-utils": "0.8.4-main.b97322e"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^8.0.13",
+    "@dxos/echo-db": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo": "0.8.4-main.bc2380dfbc",
+    "@dxos/keys": "0.8.4-main.bc2380dfbc",
+    "@dxos/log": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/random": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc",
+    "@dxos/storybook-utils": "0.8.4-main.bc2380dfbc"
   },
   "peerDependencies": {
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc"
   },
   "publishConfig": {
     "access": "public"

package/src/Message/Message.stories.tsx

@@ -2,18 +2,18 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { PublicKey } from '@dxos/keys';
-import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/ui-theme';
 
-import { MessageRoot } from './Message';
+import { translations } from '#translations';
+
+import { type MessageEntity, MessageStoryText } from '../testing';
 import { Thread } from '../Thread';
-import { MessageStoryText, type MessageEntity } from '../testing';
-import { translations } from '../translations';
+import { MessageRoot } from './Message';
 
 const DefaultStory = () => {
   const [identityKey] = useState(PublicKey.random());
@@ -25,7 +25,7 @@ const DefaultStory = () => {
   });
 
   return (
-    <div className='mli-auto is-96 overflow-y-auto'>
+    <div className='mx-auto w-96 overflow-y-auto'>
       <Thread.Root id='t1'>
         <MessageRoot {...message} classNames={[hoverableControls, hoverableFocusedWithinControls]}>
           <MessageStoryText {...message} onDelete={() => console.log('delete')} />
@@ -35,12 +35,19 @@ const DefaultStory = () => {
   );
 };
 
-export default {
+const meta = {
   title: 'ui/react-ui-thread/Message',
-  component: MessageRoot,
+  component: MessageRoot as any,
   render: DefaultStory,
-  decorators: [withTheme, withLayout({ fullscreen: true })],
-  parameters: { translations },
-};
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
 
-export const Default = {};
+export const Default: Story = {};

package/src/Message/Message.tsx

@@ -3,50 +3,49 @@
 //
 
 import { formatDistanceToNow } from 'date-fns/formatDistanceToNow';
-import React, { type ComponentPropsWithRef, forwardRef, type ComponentPropsWithoutRef } from 'react';
+import React, { type ComponentPropsWithRef, type ComponentPropsWithoutRef, forwardRef } from 'react';
 
-// TODO(burdon): Remove dep.
 import { Avatar, type ThemedClassName, useTranslation } from '@dxos/react-ui';
-import { type UseTextEditorProps, keymap, listener, useTextEditor } from '@dxos/react-ui-editor';
-import { focusRing, mx } from '@dxos/react-ui-theme';
-import { hexToEmoji, hexToHue, isNotFalsy } from '@dxos/util';
+import { type UseTextEditorProps, useTextEditor } from '@dxos/react-ui-editor';
+import { keymap, listener } from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
+import { hexToEmoji, hexToHue, isTruthy } from '@dxos/util';
+
+import { translationKey } from '#translations';
 
-import { translationKey } from '../translations';
 import { type MessageMetadata } from '../types';
 
 const avatarSize = 7;
 
-export type MessageRootProps = ThemedClassName<ComponentPropsWithRef<'div'>> &
-  MessageMetadata &
-  Partial<{ continues: boolean }>;
+export type MessageRootProps = ThemedClassName<
+  ComponentPropsWithRef<'div'> & MessageMetadata & Partial<{ continues: boolean }>
+>;
 
+// TODO(burdon): Show authorName on tooltip.
 export const MessageRoot = forwardRef<HTMLDivElement, MessageRootProps>(
   (
     { authorImgSrc, authorId, authorName, authorAvatarProps, continues = true, children, classNames, ...rootProps },
     forwardedRef,
   ) => {
+    // Must wrap the message since Avatar.Label may be used in the content.
     return (
-      // Must wrap the message since Avatar.Label may be used in the content.
       <Avatar.Root>
         <div
-          role='none'
           data-testid='thread.message'
           {...rootProps}
           className={mx('grid grid-cols-subgrid col-span-2', classNames)}
           ref={forwardedRef}
         >
-          <div role='none' className='flex flex-col items-center gap-2 pbs-2'>
+          <div className='flex flex-col items-center gap-2 pt-1'>
             <Avatar.Content
               size={avatarSize}
               hue={authorAvatarProps?.hue || hexToHue(authorId ?? '0')}
               fallback={authorAvatarProps?.emoji || hexToEmoji(authorId ?? '0')}
               {...(authorImgSrc && { imgSrc: authorImgSrc })}
             />
-            {continues && <div role='none' className='is-px grow bg-separator' />}
-          </div>
-          <div role='none' className='plb-1 min-is-0'>
-            {children}
+            {continues && <div className='w-px grow bg-separator' />}
           </div>
+          <div className='py-1 min-w-0'>{children}</div>
         </div>
       </Avatar.Root>
     );
@@ -58,7 +57,7 @@ export type MessageHeadingProps = ThemedClassName<ComponentPropsWithoutRef<'div'
 
 export const MessageHeading = ({ children, classNames, timestamp, authorName, ...props }: MessageHeadingProps) => {
   return (
-    <div role='none' {...props} className={mx('flex gap-2 items-start', classNames)}>
+    <div {...props} className={mx('flex gap-2 items-start', classNames)}>
       <p className='grow'>
         <MessageAuthorName authorName={authorName} />
         {timestamp && <MessageTime timestamp={timestamp} />}
@@ -73,7 +72,7 @@ export type MessageAuthorNameProps = Pick<MessageMetadata, 'authorName'>;
 export const MessageAuthorName = ({ authorName }: MessageAuthorNameProps) => {
   const { t } = useTranslation(translationKey);
   return (
-    <Avatar.Label classNames='block truncate text-sm text-subdued'>{authorName ?? t('anonymous label')}</Avatar.Label>
+    <Avatar.Label classNames='block truncate text-sm text-subdued'>{authorName ?? t('anonymous.label')}</Avatar.Label>
   );
 };
 
@@ -83,7 +82,7 @@ export const MessageTime = ({ timestamp }: MessageTimeProps) => {
   const { dtLocale } = useTranslation(translationKey);
   const dt = timestamp ? new Date(timestamp) : undefined;
   return (
-    <time className='block text-subdued text-xs pbe-0.5' dateTime={dt?.toISOString()}>
+    <time className='block text-subdued text-xs pb-0.5' dateTime={dt?.toISOString()}>
       {dt ? formatDistanceToNow(dt, { locale: dtLocale, addSuffix: true }) : ''}
     </time>
   );
@@ -148,14 +147,14 @@ export const MessageTextbox = ({
       extensions: [
         keymap.of(keyBindings({ onSend, onClear })),
         listener({
-          onFocus: (focusing) => {
+          onFocus: ({ focusing }) => {
             if (focusing) {
               onEditorFocus?.();
             }
           },
         }),
         extensions,
-      ].filter(isNotFalsy),
+      ].filter(isTruthy),
       ...editorProps,
     }),
     [id, extensions],
@@ -164,9 +163,8 @@ export const MessageTextbox = ({
   return (
     <MessageRoot {...{ id, authorId, authorName, authorImgSrc, authorAvatarProps }} continues={false}>
       <div
-        role='none'
         ref={parentRef}
-        className={mx('plb-0.5 mie-1 rounded-sm', focusRing, disabled && 'opacity-50')}
+        className={mx('py-0.5 me-1 rounded-xs dx-focus-ring', disabled && 'opacity-50')}
         {...focusAttributes}
       />
     </MessageRoot>

package/src/Thread/Comments.stories.tsx

@@ -2,49 +2,66 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
 
-import { createDocAccessor, createObject } from '@dxos/echo-db';
-import { Expando } from '@dxos/echo-schema';
+import { Obj } from '@dxos/echo';
+import { TestSchema } from '@dxos/echo/testing';
 import { PublicKey } from '@dxos/keys';
-import { live } from '@dxos/live-object';
 import { log } from '@dxos/log';
-import { faker } from '@dxos/random';
-import { Button, Icon, useThemeContext } from '@dxos/react-ui';
+import { random } from '@dxos/random';
+import { Icon, IconButton, useThemeContext } from '@dxos/react-ui';
+import { useTextEditor } from '@dxos/react-ui-editor';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 import {
-  type Comment,
   type CommentsOptions,
-  type Range,
-  automerge,
+  type EditorView,
   comments,
   createBasicExtensions,
   createThemeExtensions,
+  documentId,
   listener,
   scrollThreadIntoView,
-  useComments,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
-import { withTheme } from '@dxos/storybook-utils';
+  setComments,
+} from '@dxos/ui-editor';
+import { type Comment, type Range } from '@dxos/ui-editor/types';
+import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/ui-theme';
+
+import { translations } from '#translations';
 
-import { Thread } from './Thread';
 import { MessageBody, MessageHeading, MessageRoot, MessageTextbox } from '../Message';
 import { type MessageEntity } from '../testing';
-import { translations } from '../translations';
+import { Thread } from './Thread';
 
-faker.seed(101);
+random.seed(101);
 
 const authorId = PublicKey.random().toHex();
 
+/**
+ * @deprecated This hook will be removed in future versions. Use the new comment sync extension instead.
+ * Update comments state field.
+ */
+const useComments = (view: EditorView | null | undefined, id: string, comments?: Comment[]) => {
+  useEffect(() => {
+    if (view) {
+      // Check same document.
+      // NOTE: Hook might be called before editor state is updated.
+      if (id === view.state.facet(documentId)) {
+        view.dispatch({
+          effects: setComments.of({ id, comments: comments ?? [] }),
+        });
+      }
+    }
+  });
+};
+
 //
 // Editor
 //
 
 const Editor: FC<{
   id?: string;
-  item: Expando;
+  initialValue: string;
   comments: Comment[];
   selected?: string;
   onCreateComment: CommentsOptions['onCreate'];
@@ -53,7 +70,7 @@ const Editor: FC<{
   onSelectComment: CommentsOptions['onSelect'];
 }> = ({
   id = 'test',
-  item,
+  initialValue,
   selected: selectedValue,
   comments: commentRanges,
   onCreateComment,
@@ -67,11 +84,10 @@ const Editor: FC<{
   const { parentRef, view } = useTextEditor(
     () => ({
       id,
-      initialValue: item.content,
+      initialValue: initialValue,
       extensions: [
         createBasicExtensions(),
         createThemeExtensions({ themeMode }),
-        automerge(createDocAccessor(item, ['content'])),
         comments({
           id,
           onCreate: onCreateComment,
@@ -81,7 +97,7 @@ const Editor: FC<{
         }),
       ],
     }),
-    [id, item, themeMode],
+    [id, initialValue, themeMode],
   );
   useComments(view, id, commentRanges);
   useEffect(() => {
@@ -114,19 +130,21 @@ const StoryThread: FC<{
   onSelect: () => void;
   onResolve: () => void;
 }> = ({ thread, selected, onSelect, onResolve }) => {
-  const containerRef = useRef<HTMLDivElement>(null);
   const { themeMode } = useThemeContext();
+  const containerRef = useRef<HTMLDivElement>(null);
+
   // TODO(wittjosiah): This is a hack to reset the editor after a message is sent.
-  const [_count, _setCount] = useState(0);
-  const rerenderEditor = () => _setCount((count) => count + 1);
+  const [state, setState] = useState({});
   const messageRef = useRef('');
   const extensions = useMemo(
     () => [
       createBasicExtensions({ placeholder: 'Enter comment' }),
       createThemeExtensions({ themeMode }),
-      listener({ onChange: (text) => (messageRef.current = text) }),
+      listener({
+        onChange: ({ text }) => (messageRef.current = text),
+      }),
     ],
-    [themeMode, _count],
+    [themeMode, state],
   );
 
   const [autoFocus, setAutoFocus] = useState(false);
@@ -142,7 +160,7 @@ const StoryThread: FC<{
 
   const handleCreateMessage = () => {
     if (messageRef.current?.length) {
-      const message = live(Expando, {
+      const message = Obj.make(TestSchema.Expando, {
         timestamp: new Date().toISOString(),
         sender: { identityKey: authorId },
         text: messageRef.current,
@@ -151,7 +169,7 @@ const StoryThread: FC<{
 
       messageRef.current = '';
       setAutoFocus(true);
-      rerenderEditor();
+      setState({});
     }
   };
 
@@ -185,20 +203,27 @@ const StoryThread: FC<{
           onSend={handleCreateMessage}
         />
         <Thread.Status />
-        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
-          <Icon icon='ph--check--regular' />
-        </Button>
+        <IconButton
+          variant='ghost'
+          icon='ph--check--regular'
+          iconOnly
+          classNames='px-1'
+          label='Resolve'
+          onClick={onResolve}
+        />
       </div>
     </Thread.Root>
   );
 };
 
-const Sidebar: FC<{
+type SidebarProps = {
   threads: StoryCommentThread[];
   selected?: string;
   onSelect: (thread: string) => void;
   onResolve: (thread: string) => void;
-}> = ({ threads, selected, onSelect, onResolve }) => {
+};
+
+const Sidebar = ({ threads, selected, onSelect, onResolve }: SidebarProps) => {
   // Sort by y-position.
   const sortedThreads = useMemo(() => {
     const sorted = [...threads];
@@ -226,13 +251,13 @@ const Sidebar: FC<{
 // Story container.
 //
 
-type StoryProps = {
+type DefaultStoryProps = {
   text?: string;
   autoCreate?: boolean;
 };
 
-const Story = ({ text, autoCreate }: StoryProps) => {
-  const [item] = useState(createObject(live(Expando, { content: text ?? '' })));
+const DefaultStory = ({ text, autoCreate }: DefaultStoryProps) => {
+  const [item] = useState(() => Obj.make(TestSchema.Expando, { content: text ?? '' }));
   const [threads, setThreads] = useState<StoryCommentThread[]>([]);
   const [selected, setSelected] = useState<string>();
 
@@ -251,12 +276,12 @@ const Story = ({ text, autoCreate }: StoryProps) => {
         cursor,
         yPos: location ? Math.floor(location.top) : undefined,
         messages: autoCreate
-          ? faker.helpers.multiple(
+          ? random.helpers.multiple(
               () => ({
                 id: PublicKey.random().toHex(),
                 timestamp: new Date().toISOString(),
                 authorId: PublicKey.random().toHex(),
-                text: faker.lorem.sentence(),
+                text: random.lorem.sentence(),
               }),
               { count: { min: 1, max: 3 } },
             )
@@ -324,9 +349,9 @@ const Story = ({ text, autoCreate }: StoryProps) => {
 
   return (
     <main className='fixed inset-0 grid grid-cols-[1fr_24rem]'>
-      <div role='none' className='max-bs-full overflow-y-auto p-4'>
+      <div className='max-h-full overflow-y-auto p-4'>
         <Editor
-          item={item}
+          initialValue={item.content}
           selected={selected}
           comments={comments}
           onCreateComment={handleCreateComment}
@@ -336,7 +361,7 @@ const Story = ({ text, autoCreate }: StoryProps) => {
         />
       </div>
 
-      <div role='none' className='max-bs-full overflow-y-auto p-4'>
+      <div className='max-h-full overflow-y-auto p-4'>
         <Sidebar
           threads={visibleThreads}
           selected={selected}
@@ -348,22 +373,29 @@ const Story = ({ text, autoCreate }: StoryProps) => {
   );
 };
 
-export default {
+const meta = {
   title: 'ui/react-ui-thread/Comments',
-  component: StoryThread,
-  decorators: [withTheme],
-  render: (args: StoryProps) => <Story {...args} />,
-  parameters: { translations, layout: 'fullscreen' },
-};
+  component: StoryThread as any,
+  render: DefaultStory,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    translations,
+    layout: 'fullscreen',
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
 
 const str = (...lines: string[]) => lines.join('\n');
 
-export const Default = {
+export const Default: Story = {
   args: {
     text: str(
       '# Comments',
       '',
-      str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
+      str(...random.helpers.multiple(() => [random.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
       '',
     ),
   },

package/src/Thread/Thread.stories.tsx

@@ -2,22 +2,22 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo, useRef, useState } from 'react';
 
 import { PublicKey } from '@dxos/keys';
-import { faker } from '@dxos/random';
-import { createBasicExtensions, createThemeExtensions } from '@dxos/react-ui-editor';
-import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
-import { type Meta, withLayout, withTheme } from '@dxos/storybook-utils';
+import { random } from '@dxos/random';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { createBasicExtensions, createThemeExtensions } from '@dxos/ui-editor';
+import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/ui-theme';
+
+import { translations } from '#translations';
 
-import { Thread } from './Thread';
 import { MessageRoot, MessageTextbox } from '../Message';
-import { MessageStoryText, type MessageEntity } from '../testing';
-import { translations } from '../translations';
+import { type MessageEntity, MessageStoryText } from '../testing';
+import { Thread } from './Thread';
 
-faker.seed(1);
+random.seed(1);
 
 const DefaultStory = () => {
   const [pending, setPending] = useState(false);
@@ -28,7 +28,7 @@ const DefaultStory = () => {
       id: `m${i + 1}`,
       timestamp: new Date().toISOString(),
       authorId: [identityKey1.toHex(), identityKey2.toHex()][i % 2],
-      text: faker.lorem.paragraph(),
+      text: random.lorem.paragraph(),
     })),
   );
 
@@ -59,7 +59,7 @@ const DefaultStory = () => {
   };
 
   return (
-    <div className='mli-auto is-96 overflow-y-auto'>
+    <div className='mx-auto w-96 overflow-y-auto'>
       <Thread.Root id='t1'>
         {messages.map((message) => (
           <MessageRoot key={message.id} classNames={[hoverableControls, hoverableFocusedWithinControls]} {...message}>
@@ -81,14 +81,19 @@ const DefaultStory = () => {
   );
 };
 
-const meta: Meta<typeof Thread.Root> = {
+const meta = {
   title: 'ui/react-ui-thread/Thread',
   component: Thread.Root,
   render: DefaultStory,
-  decorators: [withTheme, withLayout({ fullscreen: true })],
-  parameters: { translations },
-};
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof Thread.Root>;
 
 export default meta;
 
-export const Default = {};
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};