@dxos/plugin-thread 0.8.3 → 0.8.4-main.1c7ec43d41

package/src/containers/ChannelContainer/ChannelContainer.stories.tsx

@@ -0,0 +1,105 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capability } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { Feed } from '@dxos/echo';
+import { createFeedServiceLayer } from '@dxos/echo-db';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { SpacePlugin } from '@dxos/plugin-space';
+import { corePlugins } from '@dxos/plugin-testing';
+import { Config } from '@dxos/react-client';
+import { Query, useQuery, useSpaces } from '@dxos/react-client/echo';
+import { withLayout, withTheme, Loading } from '@dxos/react-ui/testing';
+import { Channel, Message, Thread } from '@dxos/types';
+
+import { translations } from '#translations';
+
+import { ThreadPlugin } from '../../ThreadPlugin';
+import { ChannelContainer, type ChannelContainerProps } from './ChannelContainer';
+
+// TODO(wittjosiah): Channel doesn't render full height.
+const DefaultStory = ({ roomId }: ChannelContainerProps) => {
+  const [space] = useSpaces();
+  const [channel] = useQuery(space?.db, Query.type(Channel.Channel));
+  if (!channel) {
+    return <Loading data={{ channel }} />;
+  }
+
+  return <ChannelContainer subject={channel} attendableId='story' roomId={roomId} role='article' />;
+};
+
+const meta = {
+  title: 'plugins/plugin-thread/containers/ChannelContainer',
+  component: ChannelContainer,
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withPluginManager({
+      capabilities: [
+        Capability.contributes(AppCapabilities.Schema, [Channel.Channel, Feed.Feed, Thread.Thread, Message.Message]),
+      ],
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          types: [Channel.Channel, Feed.Feed, Thread.Thread, Message.Message],
+          config: new Config({
+            runtime: {
+              services: {
+                edge: {
+                  url: 'https://edge.dxos.workers.dev/',
+                },
+                iceProviders: [
+                  {
+                    urls: 'https://edge.dxos.workers.dev/ice',
+                  },
+                ],
+              },
+            },
+          }),
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              const { personalSpace } = yield* initializeIdentity(client);
+              const channel = personalSpace.db.add(Channel.make({ name: 'general' }));
+              const feed = yield* Effect.promise(() => channel.feed.load());
+              const seed = [
+                Message.make({ sender: { role: 'user' }, blocks: [{ _tag: 'text', text: 'Hello, channel.' }] }),
+                Message.make({
+                  sender: { role: 'user' },
+                  blocks: [{ _tag: 'text', text: 'Messages are stored in the feed.' }],
+                }),
+              ];
+              yield* Feed.append(feed, seed).pipe(Effect.provide(createFeedServiceLayer(personalSpace.queues)));
+            }),
+        }),
+        SpacePlugin({}),
+        ThreadPlugin(),
+      ],
+    }),
+  ],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof ChannelContainer>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    // Fixed room for testing.
+    subject: undefined,
+    attendableId: 'story',
+    role: 'article',
+    roomId: '04a1d1911703b8e929d0649021a965',
+  },
+};

package/src/containers/ChannelContainer/ChannelContainer.tsx

@@ -0,0 +1,223 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom, useAtomValue } from '@effect-atom/atom-react';
+import React, { type ChangeEvent, useCallback, useEffect, useMemo, useState } from 'react';
+
+import { useCapabilities, useCapability } from '@dxos/app-framework/ui';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Context } from '@dxos/context';
+import { failUndefined } from '@dxos/debug';
+import { log } from '@dxos/log';
+import { useClient } from '@dxos/react-client';
+import { getSpace } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Button, ElevationProvider, Input, Panel, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+import { Menu, MenuRootProps, createMenuAction, createMenuItemGroup, useMenuActions } from '@dxos/react-ui-menu';
+import { useSoundEffect } from '@dxos/react-ui-sfx';
+import { type Channel } from '@dxos/types';
+import { composable, composableProps } from '@dxos/ui-theme';
+
+import { Call } from '#components';
+import { meta } from '#meta';
+import { ThreadCapabilities } from '#types';
+
+import { ChannelChat } from '../ChannelChat';
+
+export type ChannelContainerProps = AppSurface.ObjectArticleProps<
+  Channel.Channel | undefined,
+  {
+    roomId?: string;
+    fullscreen?: boolean;
+  }
+>;
+
+/**
+ * Renders a call when active, otherwise renders the channel chat.
+ */
+// TODO(burdon): Create Radix style layout.
+export const ChannelContainer = ({
+  role,
+  subject: channel,
+  attendableId,
+  roomId: roomIdProp,
+  fullscreen,
+}: ChannelContainerProps) => {
+  const space = getSpace(channel);
+  const callManager = useCapability(ThreadCapabilities.CallManager);
+  const extensions = useCapabilities(ThreadCapabilities.CallExtension);
+  const joined = useAtomValue(callManager.joinedAtom);
+  const currentRoomId = useAtomValue(callManager.roomIdAtom);
+  const roomId = roomIdProp ?? attendableId ?? failUndefined();
+  const identity = useIdentity();
+  const isNamed = !!identity?.profile?.displayName;
+  const joinSound = useSoundEffect('JoinCall');
+  const leaveSound = useSoundEffect('LeaveCall');
+
+  useEffect(() => {
+    const ctx = new Context();
+    callManager.left.on(ctx, (roomId) => {
+      extensions.forEach((extension) => {
+        void extension.onLeave?.(roomId);
+      });
+    });
+
+    callManager.callStateUpdated.on(ctx, (state) => {
+      extensions.forEach((extension) => {
+        void extension.onCallStateUpdated?.(state);
+      });
+    });
+
+    callManager.mediaStateUpdated.on(ctx, (state) => {
+      extensions.forEach((extension) => {
+        void extension.onMediaStateUpdated?.(state);
+      });
+    });
+
+    return () => {
+      void ctx.dispose();
+    };
+  }, [callManager, extensions]);
+
+  /**
+   * Join the call.
+   */
+  // TODO(wittjosiah): Show preview before joining?
+  const handleJoin = useCallback(async () => {
+    if (!roomId || !channel) {
+      return;
+    }
+
+    if (joined) {
+      await callManager.leave();
+    }
+
+    try {
+      void joinSound.play();
+      callManager.setRoomId(roomId);
+      await callManager.join();
+      await Promise.all(extensions.map((extension) => extension.onJoin?.({ channel, roomId })));
+    } catch (err) {
+      // TODO(burdon): Error sound.
+      log.catch(err);
+    }
+  }, [extensions, channel, roomId, joined]);
+
+  /**
+   * Leave the call.
+   */
+  const handleLeave = useCallback(async () => {
+    try {
+      void leaveSound.play();
+    } catch (err) {
+      // TODO(burdon): Error sound.
+      log.catch(err);
+    } finally {
+      void callManager.turnAudioOff();
+      void callManager.turnVideoOff();
+      void callManager.turnScreenshareOff();
+      void callManager.leave();
+    }
+  }, [extensions, roomId]);
+
+  const isJoined = joined && currentRoomId === roomId;
+  if (isJoined) {
+    return (
+      <Panel.Root>
+        <Panel.Content>
+          {isNamed ? (
+            <Call.Root>
+              <Call.Grid fullscreen={fullscreen} />
+              <Call.Toolbar channel={channel} onLeave={handleLeave} />
+            </Call.Root>
+          ) : (
+            <DisplayNameMissing />
+          )}
+        </Panel.Content>
+      </Panel.Root>
+    );
+  }
+
+  if (channel && space) {
+    return (
+      <Panel.Root classNames='dx-document'>
+        <Panel.Toolbar asChild>
+          <ChannelToolbar attendableId={attendableId} role={role} onJoinCall={handleJoin} />
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <ChannelChat space={space} channel={channel} />
+        </Panel.Content>
+      </Panel.Root>
+    );
+  }
+
+  return null;
+};
+
+const DisplayNameMissing = () => {
+  const { t } = useTranslation(meta.id);
+  const client = useClient();
+  const [displayName, setDisplayName] = useState('');
+  const handleChange = useCallback((event: ChangeEvent<HTMLInputElement>) => setDisplayName(event.target.value), []);
+  const handleSave = useCallback(() => client.halo.updateProfile({ displayName }), [client, displayName]);
+
+  return (
+    <div className='space-y-trim-md p-4 place-content-center'>
+      <Settings.Item title={t('display-name.label')} description={t('display-name.description')}>
+        <Input.TextInput
+          value={displayName}
+          onChange={handleChange}
+          placeholder={t('display-name-input.placeholder')}
+          classNames='md:min-w-64'
+        />
+      </Settings.Item>
+      <Button classNames='md:col-span-2' disabled={!displayName} onClick={handleSave}>
+        {t('set-display-name.label')}
+      </Button>
+    </div>
+  );
+};
+
+const useChannelToolbarActions = (onJoinCall?: () => void) => {
+  const creator = useMemo(
+    () =>
+      Atom.make(() => {
+        return {
+          nodes: [
+            createMenuItemGroup('root', {
+              label: ['channel-toolbar.title', { ns: meta.id }],
+            }),
+            createMenuAction('video-call', () => onJoinCall?.(), {
+              label: ['start-video-call.menu', { ns: meta.id }],
+              icon: 'ph--video-camera--regular',
+              type: 'video-call',
+            }),
+          ],
+          edges: [{ source: 'root', target: 'video-call', relation: 'child' }],
+        };
+      }),
+    [],
+  );
+
+  return useMenuActions(creator);
+};
+
+type ChannelToolbarProps = Pick<MenuRootProps, 'attendableId'> & {
+  onJoinCall?: () => void;
+};
+
+const ChannelToolbar = composable<HTMLDivElement, ChannelToolbarProps>(
+  ({ attendableId, role, onJoinCall, ...props }, forwardedRef) => {
+    const menuActions = useChannelToolbarActions(onJoinCall);
+
+    return (
+      <ElevationProvider elevation={role === 'section' ? 'positioned' : 'base'}>
+        <Menu.Root {...menuActions} attendableId={attendableId}>
+          <Menu.Toolbar {...composableProps(props)} ref={forwardedRef} />
+        </Menu.Root>
+      </ElevationProvider>
+    );
+  },
+);

package/src/containers/ChannelContainer/index.ts

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

package/src/containers/ThreadCompanion/ThreadCompanion.tsx

@@ -0,0 +1,215 @@
+//
+// 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 } 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 { 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 commentConfigs = useCapabilities(AppCapabilities.CommentConfig);
+  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 (comment config per typename).
+        if (anchor.anchor && parentId) {
+          const typename = Obj.getTypename(subject);
+          const commentConfig = commentConfigs.find(({ id }) => id === typename);
+          if (commentConfig?.scrollToAnchor) {
+            void invokePromise(commentConfig.scrollToAnchor, {
+              subject: parentId,
+              cursor: anchor.anchor,
+              ref: threadId,
+            });
+          }
+        }
+      }
+    },
+    [state.current, invokePromise, registry, stateAtom, parentId, subject, commentConfigs],
+  );
+
+  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/ThreadContainer/ThreadContainer.stories.tsx

@@ -0,0 +1,86 @@
+//
+// 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 { translations } from '#translations';
+
+import { ThreadContainer } from './ThreadContainer';
+
+random.seed(1);
+
+const DefaultStory = () => {
+  const client = useClient();
+  const identity = useIdentity();
+  const [space, setSpace] = useState<Space>();
+  const [thread, setThread] = useState<Thread.Thread | null>();
+
+  useAsyncEffect(async () => {
+    if (identity) {
+      const space = await client.spaces.create();
+      const thread = space.db.add(Thread.make({ status: 'active' }));
+      setSpace(space);
+      setThread(thread);
+    }
+  }, [identity]);
+
+  if (!identity || !thread || !space) {
+    return <Loading data={{ identity: !!identity, space: !!space, thread: !!thread }} />;
+  }
+
+  return <ThreadContainer space={space} thread={thread} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-thread/containers/ThreadContainer',
+  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, Message.Message],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};