@dxos/plugin-thread 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

package/src/containers/ChatContainer/ChatContainer.stories.tsx

@@ -0,0 +1,87 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useState } from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Surface } from '@dxos/app-framework/ui';
+import { corePlugins } from '@dxos/plugin-testing';
+import { random } 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 { useAsyncEffect } from '@dxos/react-ui';
+import { Thread as ThreadComponent } from '@dxos/react-ui-thread';
+import { withLayout, Loading } from '@dxos/react-ui/testing';
+import { Message, Thread } from '@dxos/types';
+
+import { Channel } from '#types';
+
+import { translations } from '../../translations';
+import { ChatContainer } from './ChatContainer';
+
+random.seed(1);
+
+const DefaultStory = () => {
+  const client = useClient();
+  const identity = useIdentity();
+  const [space, setSpace] = useState<Space>();
+  const [channel, setChannel] = useState<Channel.Channel | null>();
+
+  useAsyncEffect(async () => {
+    if (identity) {
+      const space = await client.spaces.create();
+      const channel = space.db.add(Channel.make());
+      setSpace(space);
+      setChannel(channel);
+    }
+  }, [identity]);
+
+  if (!identity || !channel || !space || !channel.defaultThread.target) {
+    return <Loading data={{ identity: !!identity, space: !!space, channel: !!channel }} />;
+  }
+
+  return <ChatContainer space={space} thread={channel.defaultThread.target} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-thread/containers/ChatContainer',
+  component: ThreadComponent.Root as any,
+  render: DefaultStory,
+  decorators: [
+    withLayout({ layout: 'column' }),
+    // TODO(wittjosiah): This shouldn't depend on app framework (use withClientProvider instead).
+    //  Currently this is required due to useOnEditAnalytics.
+    withPluginManager({
+      plugins: corePlugins(),
+      capabilities: [
+        Capability.contributes(
+          Capabilities.ReactSurface,
+          Surface.create({
+            id: 'test',
+            role: 'card',
+            component: ({ role }) => <span>{JSON.stringify({ role })}</span>,
+          }),
+        ),
+      ],
+    }),
+    withClientProvider({
+      createSpace: true,
+      types: [Thread.Thread, Channel.Channel, Message.Message],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/ChatContainer/ChatContainer.tsx

@@ -0,0 +1,131 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useLayoutEffect, useMemo, useRef, useState } from 'react';
+
+import { Obj, Ref } from '@dxos/echo';
+import { type Space, useMembers } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { ScrollArea, type ThemedClassName, useThemeContext, useTranslation } from '@dxos/react-ui';
+import {
+  MessageTextbox,
+  type MessageTextboxProps,
+  Thread as ThreadComponent,
+  type ThreadRootProps,
+  threadLayout,
+} from '@dxos/react-ui-thread';
+import { Message, type Thread } from '@dxos/types';
+import { createBasicExtensions, createThemeExtensions, listener } from '@dxos/ui-editor';
+import { composable, composableProps, mx } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
+
+import { MessagePanel } from '#components';
+import { useStatus } from '#hooks';
+import { meta } from '#meta';
+
+import { command } from '../../extensions';
+import { getMessageMetadata } from '../../util';
+
+export type ChatContainerProps = ThemedClassName<
+  {
+    space: Space;
+    thread: Thread.Thread;
+    context?: Obj.Unknown;
+    autoFocusTextbox?: boolean;
+  } & Pick<ThreadRootProps, 'current'>
+>;
+
+export const ChatContainer = composable<HTMLDivElement, ChatContainerProps>(
+  ({ space, thread, context, autoFocusTextbox, current, ...props }, forwardedRef) => {
+    const { t } = useTranslation(meta.id);
+    const { themeMode } = useThemeContext();
+
+    const id = Obj.getDXN(thread).toString();
+    const identity = useIdentity()!;
+    const members = useMembers(space?.id);
+    const activity = useStatus(space, id);
+    const [autoFocus, setAutoFocus] = useState(autoFocusTextbox);
+    const threadScrollRef = useRef<HTMLDivElement | null>(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 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;
+      }
+
+      Obj.change(thread, (thread) => {
+        thread.messages.push(
+          Ref.make(
+            Obj.make(Message.Message, {
+              created: new Date().toISOString(),
+              sender: { identityDid: identity.did },
+              blocks: [{ _tag: 'text', text: messageRef.current }],
+              properties: context ? { context: Ref.make(context) } : undefined,
+            }),
+          ),
+        );
+      });
+
+      messageRef.current = '';
+      setAutoFocus(true);
+      scrollToEnd('smooth');
+      rerenderEditor();
+      return true;
+    };
+
+    return (
+      <ThreadComponent.Root
+        {...composableProps(props, {
+          classNames: 'dx-container grid-rows-[1fr_min-content_min-content]',
+        })}
+        id={id}
+        current={current}
+        ref={forwardedRef}
+      >
+        <ScrollArea.Root classNames='col-span-2' orientation='vertical'>
+          <ScrollArea.Viewport ref={threadScrollRef}>
+            <div role='none' className={mx(threadLayout, 'place-self-end')}>
+              {thread.messages
+                .map((message) => message.target)
+                .filter(isNonNullable)
+                .map((message) => (
+                  <MessagePanel key={message.id} message={message} members={members} />
+                ))}
+            </div>
+          </ScrollArea.Viewport>
+        </ScrollArea.Root>
+
+        <MessageTextbox extensions={extensions} autoFocus={autoFocus} onSend={handleCreate} {...textboxMetadata} />
+        <ThreadComponent.Status activity={activity}>{t('activity.message')}</ThreadComponent.Status>
+      </ThreadComponent.Root>
+    );
+  },
+);

package/src/containers/ChatContainer/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { ChatContainer } from './ChatContainer';
+
+export { ChatContainer };
+export default ChatContainer;

package/src/containers/ThreadCompanion/ThreadCompanion.tsx

@@ -0,0 +1,217 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { useAtomValue } from '@effect-atom/atom-react';
+import React, { useCallback, useMemo } from 'react';
+
+import { Capabilities } from '@dxos/app-framework';
+import { useCapabilities, useCapability, useOperationInvoker, usePluginManager } from '@dxos/app-framework/ui';
+import { AppCapabilities, CollaborationOperation, LayoutOperation } from '@dxos/app-toolkit';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Filter, Obj, Query, Relation } from '@dxos/echo';
+import { Ref, useQuery } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Panel, ScrollArea, Toolbar, useTranslation } from '@dxos/react-ui';
+import { getParentId, useAttention } from '@dxos/react-ui-attention';
+import { Tabs } from '@dxos/react-ui-tabs';
+import { AnchoredTo, Thread } from '@dxos/types';
+
+import { CommentsPanel, type CommentsPanelProps } from '#components';
+import { meta } from '#meta';
+import { ThreadOperation } from '#operations';
+import { ThreadCapabilities, type ViewState } from '#types';
+
+const initialViewState: ViewState = { showResolvedThreads: false };
+
+export type ThreadCompanionProps = AppSurface.ObjectArticleProps<
+  Thread.Thread,
+  {
+    attendableId?: string;
+  }
+>;
+
+export const ThreadCompanion = ({ attendableId, subject }: ThreadCompanionProps) => {
+  const { t } = useTranslation(meta.id);
+  const manager = usePluginManager();
+  const { invokePromise } = useOperationInvoker();
+  const identity = useIdentity();
+  const subjectId = Obj.getDXN(subject).toString();
+  const parentId = attendableId ? getParentId(attendableId) : undefined;
+  const registry = useCapability(Capabilities.AtomRegistry);
+
+  const stateAtom = useCapability(ThreadCapabilities.State);
+  const viewStoreAtom = useCapability(ThreadCapabilities.ViewState);
+  const state = useAtomValue(stateAtom);
+  const viewStore = useAtomValue(viewStoreAtom);
+  const drafts = state.drafts[subjectId];
+
+  // Get or initialize view state for this subject.
+  const viewState = useMemo(() => {
+    if (!viewStore[subjectId]) {
+      registry.set(viewStoreAtom, { ...viewStore, [subjectId]: { ...initialViewState } });
+      return initialViewState;
+    }
+    return viewStore[subjectId];
+  }, [viewStore, subjectId, registry, viewStoreAtom]);
+  const { showResolvedThreads } = viewState;
+
+  const onChangeViewState = useCallback(
+    (nextValue: string) => {
+      registry.set(viewStoreAtom, {
+        ...registry.get(viewStoreAtom),
+        [subjectId]: { ...registry.get(viewStoreAtom)[subjectId], showResolvedThreads: nextValue === 'all' },
+      });
+    },
+    [registry, viewStoreAtom, subjectId],
+  );
+
+  const anchorSorts = useCapabilities(AppCapabilities.AnchorSort);
+  const sort = useMemo(
+    () => anchorSorts.find(({ key }) => key === Obj.getTypename(subject))?.sort,
+    [anchorSorts, subject],
+  );
+
+  const db = Obj.getDatabase(subject);
+  const objectsAnchoredTo = useQuery(db, Query.select(Filter.id(subject.id)).targetOf(AnchoredTo.AnchoredTo));
+  const anchors = objectsAnchoredTo
+    .toSorted((a, b) => sort?.(a, b) ?? 0)
+    .filter((anchor) => Obj.instanceOf(Thread.Thread, Relation.getSource(anchor)))
+    .concat(drafts ?? []);
+
+  const { hasAttention, isAncestor, isRelated } = useAttention(parentId);
+  const isAttended = hasAttention || isAncestor || isRelated;
+
+  const handleAttend = useCallback(
+    (anchor: AnchoredTo.AnchoredTo) => {
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const threadId = Obj.getDXN(thread).toString();
+
+      if (state.current !== threadId) {
+        registry.set(stateAtom, { ...registry.get(stateAtom), current: threadId });
+
+        // Scroll plank into view (deck handler).
+        void invokePromise(LayoutOperation.ScrollIntoView, { subject: parentId });
+
+        // Scroll within content to anchor (metadata-driven, per typename).
+        if (anchor.anchor && parentId) {
+          const typename = Obj.getTypename(subject);
+          const metadata = manager.capabilities
+            .getAll(AppCapabilities.Metadata)
+            .find(({ id }) => id === typename)?.metadata;
+          if (metadata?.scrollToAnchor) {
+            void invokePromise(metadata.scrollToAnchor, {
+              subject: parentId,
+              cursor: anchor.anchor,
+              ref: threadId,
+            });
+          }
+        }
+      }
+    },
+    [state.current, invokePromise, registry, stateAtom, parentId, subject, manager],
+  );
+
+  const handleComment = useCallback(
+    async (anchor: AnchoredTo.AnchoredTo, text: string) => {
+      await invokePromise(ThreadOperation.AddMessage, {
+        anchor,
+        subject,
+        sender: { identityDid: identity?.did },
+        text,
+      });
+
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      registry.set(stateAtom, { ...registry.get(stateAtom), current: Obj.getDXN(thread).toString() });
+    },
+    [invokePromise, identity, subject, registry, stateAtom],
+  );
+
+  const handleResolve = useCallback(
+    (anchor: AnchoredTo.AnchoredTo) =>
+      invokePromise(ThreadOperation.ToggleResolved, {
+        thread: Relation.getSource(anchor) as Thread.Thread,
+      }),
+    [invokePromise],
+  );
+
+  const handleThreadDelete = useCallback(
+    (anchor: AnchoredTo.AnchoredTo) => invokePromise(ThreadOperation.Delete, { anchor, subject }),
+    [invokePromise, subject],
+  );
+
+  const handleMessageDelete = useCallback(
+    (anchor: AnchoredTo.AnchoredTo, messageId: string) =>
+      invokePromise(ThreadOperation.DeleteMessage, {
+        anchor,
+        subject,
+        messageId,
+      }),
+    [invokePromise, subject],
+  );
+
+  const handleAcceptProposal = useCallback<NonNullable<CommentsPanelProps['onAcceptProposal']>>(
+    async (anchor, messageId) => {
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const messageIndex = thread.messages.findIndex(Ref.hasObjectId(messageId));
+      const message = thread.messages[messageIndex]?.target;
+      const proposal = message?.blocks.find((block) => block._tag === 'proposal');
+      if (!proposal || !anchor.anchor) {
+        return;
+      }
+
+      await invokePromise(CollaborationOperation.AcceptProposal, {
+        subject,
+        anchor: anchor.anchor,
+        proposal,
+      });
+      await invokePromise(ThreadOperation.ToggleResolved, { thread });
+    },
+    [invokePromise, subject],
+  );
+
+  const comments = (
+    <CommentsPanel
+      anchors={anchors}
+      currentId={isAttended ? state.current : undefined}
+      showResolvedThreads={showResolvedThreads}
+      onAttend={handleAttend}
+      onComment={handleComment}
+      onResolve={handleResolve}
+      onMessageDelete={handleMessageDelete}
+      onThreadDelete={handleThreadDelete}
+      onAcceptProposal={handleAcceptProposal}
+    />
+  );
+
+  return (
+    <Tabs.Root
+      orientation='horizontal'
+      value={showResolvedThreads ? 'all' : 'unresolved'}
+      onValueChange={onChangeViewState}
+    >
+      <Panel.Root>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            <Tabs.Tablist classNames='p-0'>
+              <Tabs.Tab classNames='text-sm' value='unresolved'>
+                {t('show-unresolved.label')}
+              </Tabs.Tab>
+              <Tabs.Tab classNames='text-sm' value='all'>
+                {t('show-all.label')}
+              </Tabs.Tab>
+            </Tabs.Tablist>
+          </Toolbar.Root>
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <ScrollArea.Root thin>
+            <ScrollArea.Viewport>
+              <Tabs.Panel value='all'>{showResolvedThreads && comments}</Tabs.Panel>
+              <Tabs.Panel value='unresolved'>{!showResolvedThreads && comments}</Tabs.Panel>
+            </ScrollArea.Viewport>
+          </ScrollArea.Root>
+        </Panel.Content>
+      </Panel.Root>
+    </Tabs.Root>
+  );
+};

package/src/containers/ThreadCompanion/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { ThreadCompanion as default } from './ThreadCompanion';

package/src/containers/index.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const CallDebugPanel: ComponentType<any> = lazy(() => import('./CallDebugPanel'));
+export const CallSidebar: ComponentType<any> = lazy(() => import('./CallSidebar'));
+export const ChannelContainer: ComponentType<any> = lazy(() => import('./ChannelContainer'));
+export const ChatContainer: ComponentType<any> = lazy(() => import('./ChatContainer'));
+export const ThreadCompanion: ComponentType<any> = lazy(() => import('./ThreadCompanion'));

package/src/{components/command-extension.ts → extensions/command.ts}

@@ -2,11 +2,11 @@
 // Copyright 2024 DXOS.org
 //
 
-import { StreamLanguage, HighlightStyle, syntaxHighlighting } from '@codemirror/language';
+import { HighlightStyle, StreamLanguage, syntaxHighlighting } from '@codemirror/language';
 import { type Extension } from '@codemirror/state';
 
-import { tags } from '@dxos/react-ui-editor';
-import { mx } from '@dxos/react-ui-theme';
+import { tags } from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
 
 /**
  * https://github.com/codemirror/stream-parser/blob/main/test/test-stream-parser.ts
@@ -27,7 +27,10 @@ const parser = StreamLanguage.define<{ count: number }>({
 });
 
 const styles = HighlightStyle.define([
-  { tag: tags.tagName, class: mx('dx-tag dx-tag--indigo text-baseText font-medium') },
+  {
+    tag: tags.tagName,
+    class: mx('dx-tag dx-tag--indigo text-base-surface-text font-medium'),
+  },
 ]);
 
 export const command: Extension = [parser, syntaxHighlighting(styles)];

package/src/extensions/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './command';
 export * from './threads';