@dxos/react-ui-thread 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/src/testing.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Obj } from '@dxos/echo';
+import { random } from '@dxos/random';
+import { type ValueGenerator, createGenerator } from '@dxos/schema/testing';
+import { Message } from '@dxos/types';
+import { hexToFallback } from '@dxos/util';
+
+import { type MessageMetadata } from './types';
+
+const generator: ValueGenerator = random as any;
+
+const authors = [
+  { did: 'did:key:alice', name: 'Alice' },
+  { did: 'did:key:bob', name: 'Bob' },
+];
+
+/**
+ * Generate sample `Message` objects (real `@dxos/types` schema) with text
+ * blocks for stories, using the `@dxos/schema/testing` generator for base
+ * fields and `@dxos/random` for content.
+ */
+export const createMessages = (count = 8): Message.Message[] => {
+  const objectGenerator = createGenerator(generator, Message.Message);
+  return objectGenerator.createObjects(count).map((message, index) => {
+    const author = authors[index % authors.length];
+    Obj.update(message, (message) => {
+      message.sender = { role: 'user', identityDid: author.did, name: author.name };
+      message.blocks = [{ _tag: 'text', text: random.lorem.paragraph() }];
+    });
+    return message;
+  });
+};
+
+/** Story metadata resolver mapping a message's sender to presentational fields. */
+export const getStoryMetadata = (message: Message.Message): MessageMetadata => {
+  const did = message.sender.identityDid ?? '0';
+  const fallback = hexToFallback(did);
+  return {
+    id: Obj.getURI(message),
+    timestamp: message.created,
+    authorId: did,
+    authorName: message.sender.name,
+    authorAvatarProps: { hue: fallback.hue, emoji: fallback.emoji },
+  };
+};

package/src/translations.ts

@@ -4,22 +4,27 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-export const translationKey = 'react-ui-thread';
+export const translationKey = '@dxos/react-ui-thread';
 
 export const translations = [
   {
     'en-US': {
       [translationKey]: {
-        'plugin name': 'Threads',
-        'thread title placeholder': 'New thread',
-        'thread title label': 'Title',
-        'delete thread label': 'Delete',
-        'create thread label': 'Create thread',
-        'message placeholder': 'Enter message...',
-        'comment placeholder': 'Enter comment...',
-        'settings standalone label': 'Enable standalone thread creation',
-        'anonymous label': 'Anonymous',
-        'enter to send message': 'Enter to add ⏎',
+        'plugin.name': 'Threads',
+        'thread-title.placeholder': 'New thread',
+        'thread-title.label': 'Title',
+        'delete-thread.label': 'Delete',
+        'select-thread.label': 'Select comment',
+        'create-thread.label': 'Create thread',
+        'message.placeholder': 'Enter message...',
+        'comment.placeholder': 'Enter comment...',
+        'settings-standalone.label': 'Enable standalone thread creation',
+        'anonymous.label': 'Anonymous',
+        'enter-to-send.message': 'Enter to add ⏎',
+        'edit-message.label': 'Edit',
+        'save-message.label': 'Save',
+        'delete-message.label': 'Delete',
+        'accept-proposal.label': 'Accept proposal',
       },
     },
   },

package/src/types.ts

@@ -2,10 +2,17 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type FallbackValue } from '@dxos/util';
+import { type ComponentType } from 'react';
 
-// TODO(burdon): Move ThreadType Schema.Schema type here.
+import { type Obj } from '@dxos/echo';
+import { type Message } from '@dxos/types';
+import { type FallbackValue } from '@dxos/util';
 
+/**
+ * Presentational metadata for a message author, resolved by the host (e.g. from
+ * space members / identity) and supplied to the UI layer — keeps this package
+ * free of `@dxos/react-client`.
+ */
 export type MessageMetadata = {
   id: string;
   timestamp?: string;
@@ -15,7 +22,33 @@ export type MessageMetadata = {
   authorAvatarProps?: FallbackValue;
 };
 
-export type ThreadEntity = {
-  topicId?: string;
-  topicTitle?: string;
+/**
+ * Renders an object/reference message block. Injected by the host plugin
+ * (typically backed by an app-framework `Surface`) so this package stays free
+ * of `@dxos/app-framework`.
+ */
+export type ObjectTileComponent = ComponentType<{ subject: Obj.Unknown }>;
+
+export type ThreadComponents = {
+  Object?: ObjectTileComponent;
+};
+
+/** Callbacks raised by message tiles, handled by the host. */
+export type MessageCallbacks = {
+  /** Delete a message by id (omit to hide the affordance). */
+  onMessageDelete?: (messageId: string) => void;
+  /** Accept an assistant proposal block on a message (omit to hide the affordance). */
+  onAcceptProposal?: (messageId: string) => void;
 };
+
+/** Shared context provided by `Thread.Root` to its message tiles. */
+export type ThreadContextValue = {
+  /** Resolve presentational metadata for a message. */
+  getMetadata: (message: Message.Message) => MessageMetadata;
+  /** Injected renderers (e.g. object/reference tiles). */
+  components: ThreadComponents;
+  /** DID of the local identity; used to decide message editability. */
+  identityDid?: string;
+  /** When true, the author may edit their own text messages in place. */
+  editable?: boolean;
+} & MessageCallbacks;

package/dist/types/src/Thread/Comments.stories.d.ts

@@ -1,52 +0,0 @@
-import '@dxos-theme';
-import React from 'react';
-import { type Range } from '@dxos/react-ui-editor';
-import { type MessageEntity } from '../testing';
-type StoryCommentThread = {
-    id: string;
-    cursor?: string;
-    range?: Range;
-    yPos?: number;
-    messages: MessageEntity[];
-};
-type StoryProps = {
-    text?: string;
-    autoCreate?: boolean;
-};
-declare const _default: {
-    title: string;
-    component: React.FC<{
-        thread: StoryCommentThread;
-        selected: boolean;
-        onSelect: () => void;
-        onResolve: () => void;
-    }>;
-    decorators: import("@storybook/react").Decorator[];
-    render: (args: StoryProps) => React.JSX.Element;
-    parameters: {
-        translations: [{
-            readonly 'en-US': {
-                readonly "react-ui-thread": {
-                    readonly 'plugin name': "Threads";
-                    readonly 'thread title placeholder': "New thread";
-                    readonly 'thread title label': "Title";
-                    readonly 'delete thread label': "Delete";
-                    readonly 'create thread label': "Create thread";
-                    readonly 'message placeholder': "Enter message...";
-                    readonly 'comment placeholder': "Enter comment...";
-                    readonly 'settings standalone label': "Enable standalone thread creation";
-                    readonly 'anonymous label': "Anonymous";
-                    readonly 'enter to send message': "Enter to add ⏎";
-                };
-            };
-        }];
-        layout: string;
-    };
-};
-export default _default;
-export declare const Default: {
-    args: {
-        text: string;
-    };
-};
-//# sourceMappingURL=Comments.stories.d.ts.map

package/dist/types/src/Thread/Comments.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Comments.stories.d.ts","sourceRoot":"","sources":["../../../../src/Thread/Comments.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAwD,MAAM,OAAO,CAAC;AAS7E,OAAO,EAGL,KAAK,KAAK,EASX,MAAM,uBAAuB,CAAC;AAK/B,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAuEhD,KAAK,kBAAkB,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B,CAAC;AAwHF,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;;;;gBAxHQ,kBAAkB;kBAChB,OAAO;kBACP,MAAM,IAAI;mBACT,MAAM,IAAI;;;mBAgPN,UAAU;;;;;;;;;;;;;;;;;;;;;AAJ3B,wBAME;AAIF,eAAO,MAAM,OAAO;;;;CASnB,CAAC"}

package/src/Thread/Comments.stories.tsx

@@ -1,371 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
-
-import { createDocAccessor, createObject } from '@dxos/echo-db';
-import { Expando } from '@dxos/echo-schema';
-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 {
-  type Comment,
-  type CommentsOptions,
-  type Range,
-  automerge,
-  comments,
-  createBasicExtensions,
-  createThemeExtensions,
-  listener,
-  scrollThreadIntoView,
-  useComments,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
-import { withTheme } from '@dxos/storybook-utils';
-
-import { MessageBody, MessageHeading, MessageRoot, MessageTextbox } from '../Message';
-import { type MessageEntity } from '../testing';
-import { translations } from '../translations';
-
-import { Thread } from './Thread';
-
-faker.seed(101);
-
-const authorId = PublicKey.random().toHex();
-
-//
-// Editor
-//
-
-const Editor: FC<{
-  id?: string;
-  item: Expando;
-  comments: Comment[];
-  selected?: string;
-  onCreateComment: CommentsOptions['onCreate'];
-  onDeleteComment: CommentsOptions['onDelete'];
-  onUpdateComment: CommentsOptions['onUpdate'];
-  onSelectComment: CommentsOptions['onSelect'];
-}> = ({
-  id = 'test',
-  item,
-  selected: selectedValue,
-  comments: commentRanges,
-  onCreateComment,
-  onDeleteComment,
-  onUpdateComment,
-  onSelectComment,
-}) => {
-  const [selected, setSelected] = useState<string>();
-
-  const { themeMode } = useThemeContext();
-  const { parentRef, view } = useTextEditor(
-    () => ({
-      id,
-      initialValue: item.content,
-      extensions: [
-        createBasicExtensions(),
-        createThemeExtensions({ themeMode }),
-        automerge(createDocAccessor(item, ['content'])),
-        comments({
-          id,
-          onCreate: onCreateComment,
-          onDelete: onDeleteComment,
-          onUpdate: onUpdateComment,
-          onSelect: onSelectComment,
-        }),
-      ],
-    }),
-    [id, item, themeMode],
-  );
-  useComments(view, id, commentRanges);
-  useEffect(() => {
-    if (view && !view.hasFocus && selectedValue !== selected) {
-      setSelected(selectedValue);
-      if (selectedValue) {
-        scrollThreadIntoView(view, selectedValue);
-      }
-    }
-  }, [view, selected, commentRanges, selectedValue]);
-
-  return <div ref={parentRef} />;
-};
-
-//
-// Comments thread
-//
-
-type StoryCommentThread = {
-  id: string;
-  cursor?: string;
-  range?: Range;
-  yPos?: number;
-  messages: MessageEntity[];
-};
-
-const StoryThread: FC<{
-  thread: StoryCommentThread;
-  selected: boolean;
-  onSelect: () => void;
-  onResolve: () => void;
-}> = ({ thread, selected, onSelect, onResolve }) => {
-  const containerRef = useRef<HTMLDivElement>(null);
-  const { themeMode } = useThemeContext();
-  // 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 messageRef = useRef('');
-  const extensions = useMemo(
-    () => [
-      createBasicExtensions({ placeholder: 'Enter comment' }),
-      createThemeExtensions({ themeMode }),
-      listener({ onChange: (text) => (messageRef.current = text) }),
-    ],
-    [themeMode, _count],
-  );
-
-  const [autoFocus, setAutoFocus] = useState(false);
-  useEffect(() => {
-    if (selected) {
-      containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
-      if (thread.messages.length === 0) {
-        // TODO(burdon): Causes thread to be reselected when loses focus.
-        setAutoFocus(true);
-      }
-    }
-  }, [selected]);
-
-  const handleCreateMessage = () => {
-    if (messageRef.current?.length) {
-      const message = live(Expando, {
-        timestamp: new Date().toISOString(),
-        sender: { identityKey: authorId },
-        text: messageRef.current,
-      });
-      thread.messages.push(message as any);
-
-      messageRef.current = '';
-      setAutoFocus(true);
-      rerenderEditor();
-    }
-  };
-
-  return (
-    <Thread.Root current={selected} onClickCapture={onSelect}>
-      <div className='col-start-2 flex gap-1 text-xs text-description'>
-        <span>id:{thread.id.slice(0, 4)}</span>
-        <span>y:{thread.yPos}</span>
-        <span className='grow' />
-        {!thread.cursor && <Icon icon='ph--trash--regular' />}
-      </div>
-
-      <Thread.Header>
-        {thread.range?.from} &ndash; {thread.range?.to}
-      </Thread.Header>
-
-      {thread.messages.map((message) => (
-        <MessageRoot key={message.id} classNames={[hoverableControls, hoverableFocusedWithinControls]} {...message}>
-          <MessageHeading authorName={message.authorName} timestamp={message.timestamp} />
-          <MessageBody>{message.text}</MessageBody>
-        </MessageRoot>
-      ))}
-
-      <div ref={containerRef} className='contents'>
-        <MessageTextbox
-          id={thread.id}
-          authorId={authorId}
-          autoFocus={autoFocus}
-          extensions={extensions}
-          onEditorFocus={onSelect}
-          onSend={handleCreateMessage}
-        />
-        <Thread.Status />
-        <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
-          <Icon icon='ph--check--regular' />
-        </Button>
-      </div>
-    </Thread.Root>
-  );
-};
-
-const Sidebar: FC<{
-  threads: StoryCommentThread[];
-  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 (
-    <>
-      {sortedThreads.map((thread) => (
-        <StoryThread
-          key={thread.id}
-          thread={thread}
-          selected={thread.id === selected}
-          onSelect={() => onSelect(thread.id)}
-          onResolve={() => onResolve(thread.id)}
-        />
-      ))}
-    </>
-  );
-};
-
-//
-// Story container.
-//
-
-type StoryProps = {
-  text?: string;
-  autoCreate?: boolean;
-};
-
-const Story = ({ text, autoCreate }: StoryProps) => {
-  const [item] = useState(createObject(live(Expando, { content: text ?? '' })));
-  const [threads, setThreads] = useState<StoryCommentThread[]>([]);
-  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(
-              () => ({
-                id: PublicKey.random().toHex(),
-                timestamp: new Date().toISOString(),
-                authorId: PublicKey.random().toHex(),
-                text: faker.lorem.sentence(),
-              }),
-              { count: { min: 1, max: 3 } },
-            )
-          : [],
-      },
-    ]);
-
-    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: { current, closest } }) => {
-    log.info('select', { active: current?.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(current);
-  };
-
-  // TODO(burdon): Focus switches to other thread.
-  const handleSelectThread = (id: string) => {
-    setSelected(id);
-  };
-
-  const handleResolveThread = (id: string) => {
-    setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
-    setSelected(undefined);
-  };
-
-  return (
-    <main className='fixed inset-0 grid grid-cols-[1fr_24rem]'>
-      <div role='none' className='max-bs-full overflow-y-auto p-4'>
-        <Editor
-          item={item}
-          selected={selected}
-          comments={comments}
-          onCreateComment={handleCreateComment}
-          onDeleteComment={handleDeleteComment}
-          onUpdateComment={handleUpdateComment}
-          onSelectComment={handleSelectComment}
-        />
-      </div>
-
-      <div role='none' className='max-bs-full overflow-y-auto p-4'>
-        <Sidebar
-          threads={visibleThreads}
-          selected={selected}
-          onSelect={handleSelectThread}
-          onResolve={handleResolveThread}
-        />
-      </div>
-    </main>
-  );
-};
-
-export default {
-  title: 'ui/react-ui-thread/Comments',
-  component: StoryThread,
-  decorators: [withTheme],
-  render: (args: StoryProps) => <Story {...args} />,
-  parameters: { translations, layout: 'fullscreen' },
-};
-
-const str = (...lines: string[]) => lines.join('\n');
-
-export const Default = {
-  args: {
-    text: str(
-      '# Comments',
-      '',
-      str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
-      '',
-    ),
-  },
-};

package/src/testing.tsx

@@ -1,57 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React from 'react';
-
-import { Button, Icon } from '@dxos/react-ui';
-import { hoverableControlItem, hoverableControls, hoverableFocusedWithinControls, mx } from '@dxos/react-ui-theme';
-
-import { MessageBody, MessageHeading } from './Message';
-import { type MessageMetadata } from './types';
-
-export type MessageEntity<PartValue = any> = MessageMetadata & {
-  text: string;
-  parts?: PartValue[];
-};
-
-export type MessageTextProps = MessageMetadata & {
-  text: string;
-  onDelete?: () => void;
-};
-
-export const MessageStoryText = ({ text, onDelete, authorName, timestamp }: MessageTextProps) => {
-  return (
-    <>
-      <MessageHeading authorName={authorName} timestamp={timestamp}>
-        {onDelete && (
-          <Button
-            variant='ghost'
-            classNames={['p-1.5 min-bs-0 mie-1 items-start transition-opacity', hoverableControlItem]}
-            onClick={() => onDelete()}
-          >
-            <Icon icon='ph--x--regular' />
-          </Button>
-        )}
-      </MessageHeading>
-      <MessageBody>{text}</MessageBody>
-    </>
-  );
-};
-
-export type MessagePartProps<PartValue> = {
-  part: PartValue;
-};
-
-export const MessageStoryBlock = <PartValue,>({ part }: MessagePartProps<PartValue>) => {
-  return (
-    <div
-      role='none'
-      className={mx('grid grid-cols-subgrid col-span-3', hoverableControls, hoverableFocusedWithinControls)}
-    >
-      <pre className='font-mono max-is-full overflow-x-auto col-span-3'>
-        <code>{JSON.stringify(part, undefined, 2)}</code>
-      </pre>
-    </div>
-  );
-};