@dxos/plugin-thread 0.8.3-staging.0fa589b → 0.8.4-main.03d5cd7b56

package/src/components/Chat.stories.tsx

@@ -1,88 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react';
-import React, { useEffect, useState } from 'react';
-
-import { Capabilities, contributes, createSurface, IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Ref } from '@dxos/echo';
-import { faker } from '@dxos/random';
-import { useClient } from '@dxos/react-client';
-import { type Space } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { withClientProvider } from '@dxos/react-client/testing';
-import { Thread } from '@dxos/react-ui-thread';
-import { DataType } from '@dxos/schema';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { ChatContainer } from './ChatContainer';
-import translations from '../translations';
-import { ChannelType, ThreadType } from '../types';
-
-faker.seed(1);
-
-const Story = () => {
-  const client = useClient();
-  const identity = useIdentity();
-  const [space, setSpace] = useState<Space>();
-  const [channel, setChannel] = useState<ChannelType | null>();
-
-  useEffect(() => {
-    if (identity) {
-      setTimeout(async () => {
-        const space = await client.spaces.create();
-        const channel = space.db.add(
-          Obj.make(ChannelType, {
-            defaultThread: Ref.make(Obj.make(ThreadType, { messages: [], status: 'active' })),
-            threads: [],
-          }),
-        );
-        setSpace(space);
-        setChannel(channel);
-      });
-    }
-  }, [identity]);
-
-  if (!identity || !channel || !space || !channel.defaultThread.target) {
-    return null;
-  }
-
-  return (
-    <main className='max-is-prose mli-auto bs-dvh overflow-hidden'>
-      <ChatContainer space={space} thread={channel.defaultThread.target} />
-    </main>
-  );
-};
-
-export const Default = {};
-
-const meta: Meta = {
-  title: 'plugins/plugin-thread/Chat',
-  component: Thread,
-  render: () => <Story />,
-  decorators: [
-    withPluginManager({
-      plugins: [IntentPlugin()],
-      capabilities: [
-        contributes(
-          Capabilities.ReactSurface,
-          createSurface({
-            id: 'test',
-            role: 'card',
-            component: ({ role }) => <span>{JSON.stringify({ role })}</span>,
-          }),
-        ),
-      ],
-    }),
-    withTheme,
-    withLayout({ fullscreen: true }),
-    withClientProvider({ createSpace: true, types: [ThreadType, DataType.Message] }),
-  ],
-  parameters: { translations },
-};
-
-export default meta;

package/src/components/ChatContainer.tsx

@@ -1,140 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useLayoutEffect, useMemo, useRef, useState } from 'react';
-
-import { Obj, Ref } from '@dxos/echo';
-import { fullyQualifiedId, type Space, useMembers } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { Icon, ScrollArea, useThemeContext, useTranslation } from '@dxos/react-ui';
-import { createBasicExtensions, createThemeExtensions, listener } from '@dxos/react-ui-editor';
-import { StackItem } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
-import {
-  MessageTextbox,
-  type MessageTextboxProps,
-  Thread,
-  ThreadFooter,
-  threadLayout,
-  type ThreadProps,
-} from '@dxos/react-ui-thread';
-import { DataType } from '@dxos/schema';
-import { isNonNullable } from '@dxos/util';
-
-import { MessageContainer } from './MessageContainer';
-import { command } from './command-extension';
-import { useStatus } from '../hooks';
-import { THREAD_PLUGIN } from '../meta';
-import { type ThreadType } from '../types';
-import { getMessageMetadata } from '../util';
-
-export const ChatHeading = ({ attendableId }: { attendableId?: string }) => {
-  const { t } = useTranslation(THREAD_PLUGIN);
-  return (
-    <div role='none' className='flex items-center'>
-      <StackItem.SigilButton attendableId={attendableId}>
-        <Icon icon='ph--chat--regular' size={5} />
-      </StackItem.SigilButton>
-      <StackItem.HeadingLabel attendableId={attendableId}>{t('chat heading')}</StackItem.HeadingLabel>
-    </div>
-  );
-};
-
-export type ChatContainerProps = {
-  space: Space;
-  thread: ThreadType;
-  context?: Obj.Any;
-  autoFocusTextbox?: boolean;
-} & Pick<ThreadProps, 'current'>;
-
-export const ChatContainer = ({ space, thread, context, current, autoFocusTextbox }: ChatContainerProps) => {
-  const id = fullyQualifiedId(thread);
-  const identity = useIdentity()!;
-  const members = useMembers(space?.key);
-  const activity = useStatus(space, id);
-  const { t } = useTranslation(THREAD_PLUGIN);
-  // 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 [autoFocus, setAutoFocus] = useState(autoFocusTextbox);
-  const threadScrollRef = useRef<HTMLDivElement | null>(null);
-  const { themeMode } = useThemeContext();
-
-  const textboxMetadata = getMessageMetadata(id, identity);
-  const messageRef = useRef('');
-  const extensions = useMemo(
-    () => [
-      createBasicExtensions({ placeholder: t('message placeholder') }),
-      createThemeExtensions({ themeMode }),
-      listener({ onChange: (text) => (messageRef.current = text) }),
-      command,
-    ],
-    [themeMode, _count],
-  );
-
-  // TODO(thure): Factor out.
-  // TODO(thure): `flex-col-reverse` does not work to start the container scrolled to the end while also using
-  //  `ScrollArea`. This is the least-bad way I found to scroll to the end on mount. Note that 0ms was insufficient
-  //  for the desired effect; this is likely hardware-dependent and should be reevaluated.
-  const scrollToEnd = (behavior: ScrollBehavior) =>
-    setTimeout(() => threadScrollRef.current?.scrollIntoView({ behavior, block: 'end' }), 10);
-
-  useLayoutEffect(() => {
-    scrollToEnd('instant');
-  }, []);
-
-  // TODO(burdon): Change to model.
-  const handleCreate: MessageTextboxProps['onSend'] = () => {
-    if (!messageRef.current?.length) {
-      return false;
-    }
-
-    thread.messages.push(
-      Ref.make(
-        Obj.make(DataType.Message, {
-          sender: { identityDid: identity.did },
-          created: new Date().toISOString(),
-          blocks: [{ type: 'text', text: messageRef.current }],
-          properties: context ? { context: Ref.make(context) } : undefined,
-        }),
-      ),
-    );
-
-    messageRef.current = '';
-    setAutoFocus(true);
-    scrollToEnd('smooth');
-    rerenderEditor();
-    return true;
-  };
-
-  return (
-    <Thread
-      current={current}
-      id={id}
-      classNames='bs-full grid-rows-[1fr_min-content_min-content] overflow-hidden transition-[padding-block-end] [[data-sidebar-inline-start-state=open]_&]:lg:pbe-0'
-    >
-      <ScrollArea.Root classNames='col-span-2'>
-        <ScrollArea.Viewport classNames='overflow-anchored after:overflow-anchor after:block after:bs-px after:-mbs-px [&>div]:min-bs-full [&>div]:!grid [&>div]:grid-rows-[1fr_0]'>
-          <div role='none' className={mx(threadLayout, 'place-self-end')}>
-            {thread.messages
-              .map((message) => message.target)
-              .filter(isNonNullable)
-              .map((message) => (
-                <MessageContainer key={message.id} message={message} members={members} />
-              ))}
-          </div>
-          {/* NOTE(thure): This can’t also be the `overflow-anchor` because `ScrollArea` injects an interceding node that contains this necessary ref’d element. */}
-          <div role='none' className='bs-px -mbs-px' ref={threadScrollRef} />
-          <ScrollArea.Scrollbar>
-            <ScrollArea.Thumb />
-          </ScrollArea.Scrollbar>
-        </ScrollArea.Viewport>
-      </ScrollArea.Root>
-      <MessageTextbox extensions={extensions} autoFocus={autoFocus} onSend={handleCreate} {...textboxMetadata} />
-      <ThreadFooter activity={activity}>{t('activity message')}</ThreadFooter>
-    </Thread>
-  );
-};
-
-export default ChatContainer;

package/src/components/CommentContainer.tsx

@@ -1,198 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { CheckCircle, X } from '@phosphor-icons/react';
-import React, { useCallback, useMemo, useRef, useState } from 'react';
-
-import { Relation } from '@dxos/echo';
-import { RefArray } from '@dxos/live-object';
-import { fullyQualifiedId, getSpace, useMembers } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { Button, Tag, Tooltip, useThemeContext, useTranslation } from '@dxos/react-ui';
-import { createBasicExtensions, createThemeExtensions, listener } from '@dxos/react-ui-editor';
-import {
-  getSize,
-  hoverableControlItem,
-  hoverableControls,
-  hoverableFocusedWithinControls,
-  mx,
-} from '@dxos/react-ui-theme';
-import {
-  MessageTextbox,
-  type MessageTextboxProps,
-  Thread,
-  ThreadFooter,
-  ThreadHeading,
-  type ThreadProps,
-} from '@dxos/react-ui-thread';
-import { type AnchoredTo } from '@dxos/schema';
-import { isNonNullable } from '@dxos/util';
-
-import { MessageContainer } from './MessageContainer';
-import { command } from './command-extension';
-import { useStatus } from '../hooks';
-import { THREAD_PLUGIN } from '../meta';
-import { type ThreadType } from '../types';
-import { getMessageMetadata } from '../util';
-
-const sizeClass = getSize(4);
-
-// TODO(thure): #8149
-const commentControlClassNames = '!p-1 !min-bs-0 transition-opacity';
-
-const ToggleResolvedButton = ({
-  isResolved,
-  onResolve,
-}: {
-  isResolved: boolean | undefined;
-  onResolve: () => void;
-}) => {
-  const { t } = useTranslation(THREAD_PLUGIN);
-  const label = t(isResolved ? 'mark as unresolved label' : 'mark as resolved label');
-  return (
-    <Tooltip.Trigger asChild content={label}>
-      <Button
-        variant='ghost'
-        data-testid='thread.toggle-resolved'
-        onClick={onResolve}
-        classNames={[commentControlClassNames, !isResolved && hoverableControlItem]}
-      >
-        <span className='sr-only'>{label}</span>
-        {isResolved ? <CheckCircle className={sizeClass} weight='fill' /> : <CheckCircle className={sizeClass} />}
-      </Button>
-    </Tooltip.Trigger>
-  );
-};
-
-const DeleteThreadButton = ({ onDelete }: { onDelete: () => void }) => {
-  const { t } = useTranslation(THREAD_PLUGIN);
-  const label = t('delete thread label');
-  return (
-    <Tooltip.Trigger asChild content={label}>
-      <Button
-        variant='ghost'
-        data-testid='thread.delete'
-        onClick={onDelete}
-        classNames={[commentControlClassNames, hoverableControlItem]}
-      >
-        <span className='sr-only'>{label}</span>
-        <X className={sizeClass} />
-      </Button>
-    </Tooltip.Trigger>
-  );
-};
-
-export type CommentContainerProps = {
-  anchor: AnchoredTo;
-  onAttend?: (anchor: AnchoredTo) => void;
-  onComment?: (anchor: AnchoredTo, message: string) => void;
-  onResolve?: (anchor: AnchoredTo) => void;
-  onMessageDelete?: (anchor: AnchoredTo, messageId: string) => void;
-  onThreadDelete?: (anchor: AnchoredTo) => void;
-} & Pick<ThreadProps, 'current'>;
-
-export const CommentContainer = ({
-  anchor,
-  current,
-  onAttend,
-  onComment,
-  onResolve,
-  onMessageDelete,
-  onThreadDelete,
-}: CommentContainerProps) => {
-  const identity = useIdentity()!;
-  const space = getSpace(anchor);
-  const members = useMembers(space?.key);
-  const detached = !anchor.anchor;
-  const thread = Relation.getSource(anchor) as ThreadType;
-  const activity = useStatus(space, fullyQualifiedId(thread));
-  const { t } = useTranslation(THREAD_PLUGIN);
-  const threadScrollRef = useRef<HTMLDivElement | null>(null);
-  const { themeMode } = useThemeContext();
-
-  const textboxMetadata = getMessageMetadata(fullyQualifiedId(thread), identity);
-  // 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: t('message placeholder') }),
-      createThemeExtensions({ themeMode }),
-      listener({ onChange: (text) => (messageRef.current = text) }),
-      command,
-    ],
-    [_count],
-  );
-
-  // TODO(thure): Factor out.
-  const scrollToEnd = (behavior: ScrollBehavior) =>
-    setTimeout(() => threadScrollRef.current?.scrollIntoView({ behavior, block: 'end' }), 10);
-
-  const handleAttend = useCallback(() => onAttend?.(anchor), [onAttend, anchor]);
-  const handleResolve = useCallback(() => onResolve?.(anchor), [onResolve, anchor]);
-  const handleMessageDelete = useCallback((id: string) => onMessageDelete?.(anchor, id), [onMessageDelete, anchor]);
-  const handleThreadDelete = useCallback(() => onThreadDelete?.(anchor), [onThreadDelete, anchor]);
-
-  const handleComment: MessageTextboxProps['onSend'] = useCallback(() => {
-    if (!messageRef.current) {
-      return false;
-    }
-
-    onComment?.(anchor, messageRef.current);
-    messageRef.current = '';
-    scrollToEnd('instant');
-    rerenderEditor();
-
-    return true;
-  }, [anchor, identity]);
-
-  return (
-    <Thread onClickCapture={handleAttend} onFocusCapture={handleAttend} current={current} id={fullyQualifiedId(thread)}>
-      <div
-        role='none'
-        className={mx(
-          'col-span-2 grid grid-cols-[var(--rail-size)_1fr_min-content]',
-          hoverableControls,
-          hoverableFocusedWithinControls,
-        )}
-      >
-        {detached ? (
-          <Tooltip.Trigger asChild content={t('detached thread label')} side='top'>
-            <ThreadHeading detached>{thread.name}</ThreadHeading>
-          </Tooltip.Trigger>
-        ) : (
-          <ThreadHeading>{thread.name}</ThreadHeading>
-        )}
-        <div className='flex flex-row items-center pli-1'>
-          {thread.status === 'staged' && <Tag palette='neutral'>{t('draft button')}</Tag>}
-          {onResolve && !(thread?.status === 'staged') && (
-            <ToggleResolvedButton isResolved={thread?.status === 'resolved'} onResolve={handleResolve} />
-          )}
-          {onThreadDelete && <DeleteThreadButton onDelete={handleThreadDelete} />}
-        </div>
-      </div>
-      {/** TODO(dmaretskyi): How's `thread.messages` undefined? */}
-      {RefArray.targets(thread.messages?.filter(isNonNullable) ?? []).map((message) => (
-        <MessageContainer
-          key={message.id}
-          editable
-          message={message}
-          members={members}
-          onDelete={handleMessageDelete}
-        />
-      ))}
-      {/*
-        TODO(wittjosiah): Can't autofocus this generally.
-          There can be multiple threads with inputs and they can't all be focused.
-          Also, it steals focus from documents when first rendered.
-          Need to find a way to autofocus in one scenario only: when a new thread is created.
-      */}
-      <MessageTextbox extensions={extensions} onSend={handleComment} {...textboxMetadata} />
-      <ThreadFooter activity={activity}>{t('activity message')}</ThreadFooter>
-      {/* NOTE(thure): This can’t also be the `overflow-anchor` because `ScrollArea` injects an interceding node that contains this necessary ref’d element. */}
-      <div role='none' className='bs-px -mbs-px' ref={threadScrollRef} />
-    </Thread>
-  );
-};

package/src/components/Comments.stories.tsx

@@ -1,85 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react';
-import React, { useEffect } from 'react';
-
-import { IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Query, Relation, Type } from '@dxos/echo';
-import { faker } from '@dxos/random';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { type ClientRepeatedComponentProps, ClientRepeater } from '@dxos/react-client/testing';
-import { AnchoredTo, DataType } from '@dxos/schema';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { CommentsContainer } from './CommentsContainer';
-import { createCommentThread } from './testing';
-import translations from '../translations';
-import { ThreadType } from '../types';
-
-faker.seed(1);
-
-const Story = ({ spaceKey }: ClientRepeatedComponentProps) => {
-  const identity = useIdentity();
-  const space = useSpace(spaceKey);
-  const anchors = useQuery(space, Query.type(AnchoredTo));
-
-  useEffect(() => {
-    if (identity && space) {
-      const t = setTimeout(async () => {
-        const object = space.db.add(Obj.make(Type.Expando, {}));
-        const thread1 = space.db.add(createCommentThread(identity));
-        const thread2 = space.db.add(createCommentThread(identity));
-        space.db.add(
-          Relation.make(AnchoredTo, {
-            [Relation.Source]: thread1,
-            [Relation.Target]: object,
-          }),
-        );
-        space.db.add(
-          Relation.make(AnchoredTo, {
-            [Relation.Source]: thread2,
-            [Relation.Target]: object,
-          }),
-        );
-      });
-
-      return () => clearTimeout(t);
-    }
-  }, [identity, space]);
-
-  if (!identity || !space || !anchors) {
-    return null;
-  }
-
-  return (
-    <div className='flex justify-center overflow-y-auto bg-white dark:bg-black'>
-      <div className='flex flex-col w-[30rem]'>
-        <CommentsContainer anchors={anchors} onThreadDelete={console.log} />
-      </div>
-    </div>
-  );
-};
-
-const meta: Meta = {
-  title: 'plugins/plugin-thread/Comments',
-  // TODO(wittjosiah): Use decorator.
-  render: () => <ClientRepeater component={Story} createIdentity createSpace types={[ThreadType, DataType.Message]} />,
-  decorators: [
-    withTheme,
-    withLayout({ fullscreen: true }),
-    withPluginManager({
-      plugins: [IntentPlugin()],
-    }),
-  ],
-  parameters: { translations },
-};
-
-export default meta;
-
-export const Default = {};

package/src/components/CommentsContainer.tsx

@@ -1,66 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useEffect } from 'react';
-
-import { Relation } from '@dxos/echo';
-import { fullyQualifiedId } from '@dxos/react-client/echo';
-import { Callout, Icon, Trans, useTranslation } from '@dxos/react-ui';
-import { type AnchoredTo } from '@dxos/schema';
-
-import { CommentContainer, type CommentContainerProps } from './CommentContainer';
-import { THREAD_PLUGIN } from '../meta';
-import { type ThreadType } from '../types';
-
-export type ThreadsContainerProps = Omit<CommentContainerProps, 'anchor' | 'current'> & {
-  anchors: AnchoredTo[];
-  currentId?: string;
-  showResolvedThreads?: boolean;
-};
-
-/**
- * Comment threads.
- */
-export const CommentsContainer = ({ anchors, currentId, showResolvedThreads, ...props }: ThreadsContainerProps) => {
-  const { t } = useTranslation(THREAD_PLUGIN);
-  // TODO(wittjosiah): There seems to be a race between thread and anchor being deleted.
-  const filteredAnchors = showResolvedThreads
-    ? anchors.filter((anchor) => !!Relation.getSource(anchor))
-    : anchors.filter((anchor) => {
-        const thread = Relation.getSource(anchor);
-        return thread && thread.status !== 'resolved';
-      });
-
-  useEffect(() => {
-    if (currentId) {
-      document.getElementById(currentId)?.scrollIntoView({ behavior: 'smooth', block: 'end' });
-    }
-  }, [currentId]);
-
-  if (filteredAnchors.length === 0) {
-    return (
-      <div role='none' className='plb-cardSpacingBlock pli-cardSpacingInline'>
-        <Callout.Root>
-          <Callout.Title>
-            <Trans
-              {...{
-                t,
-                i18nKey: 'no comments message',
-                components: {
-                  commentIcon: <Icon icon='ph--chat-text--regular' size={4} classNames='inline-block' />,
-                },
-              }}
-            />
-          </Callout.Title>
-        </Callout.Root>
-      </div>
-    );
-  }
-
-  return filteredAnchors.map((anchor) => {
-    const thread = Relation.getSource(anchor) as ThreadType;
-    const threadId = fullyQualifiedId(thread);
-    return <CommentContainer key={threadId} anchor={anchor} current={currentId === threadId} {...props} />;
-  });
-};