@dxos/plugin-thread 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

package/src/components/ChannelContainer.stories.tsx

@@ -1,59 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { contributes } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { Query, useQuery, useSpace } from '@dxos/react-client/echo';
-import { withTheme } from '@dxos/react-ui/testing';
-import { DataType } from '@dxos/schema';
-import { render } from '@dxos/storybook-utils';
-
-import { createThreadPlugins } from '../testing';
-import { translations } from '../translations';
-import { ChannelType, ThreadType } from '../types';
-
-import { ChannelContainer, type ChannelContainerProps } from './ChannelContainer';
-
-// TODO(wittjosiah): Channel doesn't render full height.
-const DefaultStory = ({ roomId }: ChannelContainerProps) => {
-  const space = useSpace();
-  const [channel] = useQuery(space, Query.type(ChannelType));
-  if (!channel) {
-    return null;
-  }
-
-  return <ChannelContainer channel={channel} roomId={roomId} />;
-};
-
-const meta = {
-  title: 'plugins/plugin-thread/ChannelContainer',
-  component: ChannelContainer,
-  render: render(DefaultStory),
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [...(await createThreadPlugins())],
-      capabilities: [contributes(ClientCapabilities.Schema, [ChannelType, ThreadType, DataType.Message])],
-    }),
-  ],
-  parameters: {
-    layout: 'column',
-    translations,
-  },
-} satisfies Meta<typeof ChannelContainer>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    // Fixed room for testing.
-    roomId: '04a1d1911703b8e929d0649021a965',
-  },
-};

package/src/components/ChatContainer.tsx

@@ -1,145 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useLayoutEffect, useMemo, useRef, useState } from 'react';
-
-import { Obj, Ref } from '@dxos/echo';
-import { type Space, fullyQualifiedId, 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,
-  type ThreadRootProps,
-  threadLayout,
-} from '@dxos/react-ui-thread';
-import { DataType } from '@dxos/schema';
-import { isNonNullable } from '@dxos/util';
-
-import { useStatus } from '../hooks';
-import { meta } from '../meta';
-import { type ThreadType } from '../types';
-import { getMessageMetadata } from '../util';
-
-import { command } from './command-extension';
-import { MessageContainer } from './MessageContainer';
-
-export const ChatHeading = ({ attendableId }: { attendableId?: string }) => {
-  const { t } = useTranslation(meta.id);
-  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<ThreadRootProps, 'current'>;
-
-export const ChatContainer = ({ space, thread, context, current, autoFocusTextbox }: ChatContainerProps) => {
-  const { t } = useTranslation(meta.id);
-  const id = fullyQualifiedId(thread);
-  const identity = useIdentity()!;
-  const members = useMembers(space?.key);
-  const activity = useStatus(space, id);
-  // 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, {
-          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 (
-    <Thread.Root
-      current={current}
-      id={id}
-      classNames={[
-        'bs-full is-full max-is-prose mli-auto 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} />
-
-      <Thread.Status activity={activity}>{t('activity message')}</Thread.Status>
-    </Thread.Root>
-  );
-};
-
-export default ChatContainer;

package/src/components/Comments.stories.tsx

@@ -1,91 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Query, Relation, Type } from '@dxos/echo';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { faker } from '@dxos/random';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { useAsyncEffect } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
-import { AnchoredTo, DataType } from '@dxos/schema';
-import { render } from '@dxos/storybook-utils';
-
-import { translations } from '../translations';
-import { ThreadType } from '../types';
-
-import { CommentsContainer } from './CommentsContainer';
-import { createCommentThread, createProposalThread } from './testing';
-
-faker.seed(1);
-
-const DefaultStory = () => {
-  const identity = useIdentity();
-  const space = useSpace();
-  const anchors = useQuery(space, Query.type(AnchoredTo));
-
-  useAsyncEffect(async () => {
-    if (identity && space) {
-      const object = space.db.add(Obj.make(Type.Expando, {}));
-      const thread1 = space.db.add(createCommentThread(identity));
-      const thread2 = space.db.add(createProposalThread(identity));
-      space.db.add(
-        Relation.make(AnchoredTo, {
-          [Relation.Source]: thread1,
-          [Relation.Target]: object,
-          anchor: 'test',
-        }),
-      );
-      space.db.add(
-        Relation.make(AnchoredTo, {
-          [Relation.Source]: thread2,
-          [Relation.Target]: object,
-          anchor: 'test',
-        }),
-      );
-    }
-  }, [identity, space]);
-
-  if (!identity || !space || !anchors) {
-    return null;
-  }
-
-  return <CommentsContainer anchors={anchors} onThreadDelete={console.log} onAcceptProposal={console.log} />;
-};
-
-const meta = {
-  title: 'plugins/plugin-thread/Comments',
-  render: render(DefaultStory),
-  decorators: [
-    withTheme,
-    withLayout({ container: 'column', scroll: true }),
-    // TODO(wittjosiah): This shouldn't depend on app framework (use withClientProvider instead).
-    //  Currently this is required due to useOnEditAnalytics.
-    withPluginManager({
-      plugins: [
-        IntentPlugin(),
-        ClientPlugin({
-          types: [DataType.Message, ThreadType, AnchoredTo],
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-          },
-        }),
-      ],
-    }),
-  ],
-  parameters: {
-    translations,
-  },
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};

package/src/components/CommentsContainer.tsx

@@ -1,72 +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 { meta } from '../meta';
-import { type ThreadType } from '../types';
-
-import { CommentsThreadContainer, type CommentsThreadContainerProps } from './CommentsThreadContainer';
-
-export type CommentsContainerProps = Omit<CommentsThreadContainerProps, 'anchor' | 'current'> & {
-  anchors: AnchoredTo[];
-  currentId?: string;
-  showResolvedThreads?: boolean;
-};
-
-/**
- * Root container for collection of comment threads.
- */
-export const CommentsContainer = ({ anchors, currentId, showResolvedThreads, ...props }: CommentsContainerProps) => {
-  const { t } = useTranslation(meta.id);
-
-  // 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 (
-    <div>
-      {filteredAnchors.map((anchor) => {
-        const thread = Relation.getSource(anchor) as ThreadType;
-        const threadId = fullyQualifiedId(thread);
-        return <CommentsThreadContainer key={threadId} anchor={anchor} current={currentId === threadId} {...props} />;
-      })}
-    </div>
-  );
-};

package/src/components/ThreadComplementary.tsx

@@ -1,181 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useMemo } from 'react';
-
-import {
-  Capabilities,
-  CollaborationActions,
-  LayoutAction,
-  createIntent,
-  useCapabilities,
-  useCapability,
-  useIntentDispatcher,
-} from '@dxos/app-framework';
-import { Filter, Obj, Query, Relation } from '@dxos/echo';
-import { Ref, fullyQualifiedId, getSpace, useQuery } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { useThemeContext, useTranslation } from '@dxos/react-ui';
-import { useAttended } from '@dxos/react-ui-attention';
-import { StackItem } from '@dxos/react-ui-stack';
-import { Tabs } from '@dxos/react-ui-tabs';
-import { mx } from '@dxos/react-ui-theme';
-import { AnchoredTo } from '@dxos/schema';
-
-import { ThreadCapabilities } from '../capabilities';
-import { CommentsContainer, type CommentsContainerProps } from '../components';
-import { meta } from '../meta';
-import { ThreadAction, ThreadType } from '../types';
-
-export const ThreadComplementary = ({ subject }: { subject: any }) => {
-  const { t } = useTranslation(meta.id);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const identity = useIdentity();
-  const { tx } = useThemeContext();
-  const subjectId = fullyQualifiedId(subject);
-
-  const { state, getViewState } = useCapability(ThreadCapabilities.MutableState);
-  const drafts = state.drafts[subjectId];
-  const viewState = useMemo(() => getViewState(subjectId), [getViewState, subjectId]);
-  const { showResolvedThreads } = viewState;
-  const onChangeViewState = useCallback(
-    (nextValue: string) => {
-      viewState.showResolvedThreads = nextValue === 'all';
-    },
-    [viewState],
-  );
-
-  const anchorSorts = useCapabilities(Capabilities.AnchorSort);
-  const sort = useMemo(
-    () => anchorSorts.find(({ key }) => key === Obj.getTypename(subject))?.sort,
-    [anchorSorts, subject],
-  );
-
-  const space = getSpace(subject);
-  const objectsAnchoredTo = useQuery(space, Query.select(Filter.ids(subject.id)).targetOf(AnchoredTo));
-  const anchors = objectsAnchoredTo
-    .toSorted((a, b) => sort?.(a, b) ?? 0)
-    .filter((anchor) => Obj.instanceOf(ThreadType, Relation.getSource(anchor)))
-    .concat(drafts ?? []);
-
-  const attended = useAttended();
-
-  const handleAttend = useCallback(
-    (anchor: AnchoredTo) => {
-      const thread = Relation.getSource(anchor) as ThreadType;
-      const threadId = fullyQualifiedId(thread);
-
-      if (state.current !== threadId) {
-        state.current = threadId;
-
-        // TODO(wittjosiah): Should this be a thread-specific intent?
-        //  The layout doesn't know about threads and this working depends on other plugins conditionally handling it.
-        //  This may be overloading this intent or highjacking its intended purpose.
-        void dispatch(
-          createIntent(LayoutAction.ScrollIntoView, {
-            part: 'current',
-            subject: fullyQualifiedId(subject),
-            options: {
-              cursor: anchor.anchor,
-              ref: threadId,
-            },
-          }),
-        );
-      }
-    },
-    [state.current, dispatch, subject],
-  );
-
-  const handleComment = useCallback(
-    async (anchor: AnchoredTo, text: string) => {
-      await dispatch(
-        createIntent(ThreadAction.AddMessage, { anchor, subject, sender: { identityDid: identity?.did }, text }),
-      );
-
-      const thread = Relation.getSource(anchor) as ThreadType;
-      state.current = fullyQualifiedId(thread);
-    },
-    [dispatch, identity, subject],
-  );
-
-  const handleResolve = useCallback(
-    (anchor: AnchoredTo) =>
-      dispatch(createIntent(ThreadAction.ToggleResolved, { thread: Relation.getSource(anchor) as ThreadType })),
-    [dispatch],
-  );
-
-  const handleThreadDelete = useCallback(
-    (anchor: AnchoredTo) => dispatch(createIntent(ThreadAction.Delete, { anchor, subject })),
-    [dispatch, subject],
-  );
-
-  const handleMessageDelete = useCallback(
-    (anchor: AnchoredTo, messageId: string) =>
-      dispatch(createIntent(ThreadAction.DeleteMessage, { anchor, subject, messageId })),
-    [dispatch, subject],
-  );
-
-  const handleAcceptProposal = useCallback<NonNullable<CommentsContainerProps['onAcceptProposal']>>(
-    async (anchor, messageId) => {
-      const thread = Relation.getSource(anchor) as ThreadType;
-      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 dispatch(
-        createIntent(CollaborationActions.AcceptProposal, {
-          subject,
-          anchor: anchor.anchor,
-          proposal,
-        }),
-      );
-      await dispatch(createIntent(ThreadAction.ToggleResolved, { thread }));
-    },
-    [dispatch, subject],
-  );
-
-  const comments = (
-    <CommentsContainer
-      anchors={anchors}
-      currentId={attended.includes(subjectId) ? state.current : undefined}
-      showResolvedThreads={showResolvedThreads}
-      onAttend={handleAttend}
-      onComment={handleComment}
-      onResolve={handleResolve}
-      onMessageDelete={handleMessageDelete}
-      onThreadDelete={handleThreadDelete}
-      onAcceptProposal={handleAcceptProposal}
-    />
-  );
-
-  return (
-    <StackItem.Content toolbar>
-      <Tabs.Root
-        value={showResolvedThreads ? 'all' : 'unresolved'}
-        orientation='horizontal'
-        classNames={[
-          'contents [&_[role="tabpanel"]]:min-bs-0 [&_[role="tabpanel"]]:overflow-y-auto [&_[role="tabpanel"]]:scrollbar-thin',
-        ]}
-        onValueChange={onChangeViewState}
-      >
-        {/* TODO(burdon): Standardize (like Tollbar). */}
-        <Tabs.Tablist classNames={mx('bg-toolbarSurface border-b border-subduedSeparator')}>
-          <Tabs.Tab value='unresolved' classNames='text-sm'>
-            {t('show unresolved label')}
-          </Tabs.Tab>
-          <Tabs.Tab value='all' classNames='text-sm'>
-            {t('show all label')}
-          </Tabs.Tab>
-        </Tabs.Tablist>
-        <div className='overflow-y-auto'>
-          <Tabs.Tabpanel value='all'>{showResolvedThreads && comments}</Tabs.Tabpanel>
-          <Tabs.Tabpanel value='unresolved'>{!showResolvedThreads && comments}</Tabs.Tabpanel>
-        </div>
-      </Tabs.Root>
-    </StackItem.Content>
-  );
-};

package/src/components/ThreadSettings.tsx

@@ -1,16 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { ControlPage } from '@dxos/react-ui-form';
-
-import { meta } from '../meta';
-import type { ThreadSettingsProps } from '../types';
-
-export const ThreadSettings = ({ settings: _settings }: { settings: ThreadSettingsProps }) => {
-  const { t: _t } = useTranslation(meta.id);
-  return <ControlPage></ControlPage>;
-};

package/src/components/testing.ts

@@ -1,51 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Obj, Ref } from '@dxos/echo';
-import { IdentityDid } from '@dxos/keys';
-import { faker } from '@dxos/random';
-import { type Identity } from '@dxos/react-client/halo';
-import { DataType } from '@dxos/schema';
-
-import { ThreadType } from '../types';
-
-export const createCommentThread = (identity: Identity): ThreadType => {
-  return Obj.make(ThreadType, {
-    name: 'Comment',
-    messages: faker.helpers.multiple(
-      () =>
-        Ref.make(
-          Obj.make(DataType.Message, {
-            created: new Date().toISOString(),
-            sender: {
-              identityDid: faker.datatype.boolean() ? identity.did : IdentityDid.random(),
-            },
-            blocks: [{ _tag: 'text', text: faker.lorem.sentences(3) }],
-          }),
-        ),
-      { count: { min: 2, max: 3 } },
-    ),
-    status: 'active',
-  });
-};
-
-export const createProposalThread = (identity: Identity): ThreadType => {
-  return Obj.make(ThreadType, {
-    name: 'Proposal',
-    messages: faker.helpers.multiple(
-      () =>
-        Ref.make(
-          Obj.make(DataType.Message, {
-            created: new Date().toISOString(),
-            sender: {
-              identityDid: faker.datatype.boolean() ? identity.did : IdentityDid.random(),
-            },
-            blocks: [{ _tag: 'proposal', text: faker.lorem.sentences(3) }],
-          }),
-        ),
-      { count: { min: 1, max: 1 } },
-    ),
-    status: 'active',
-  });
-};

package/src/types/schema.ts

@@ -1,33 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Type } from '@dxos/echo';
-import { DataType } from '@dxos/schema';
-
-export const ThreadStatus = Schema.Union(
-  Schema.Literal('staged'),
-  Schema.Literal('active'),
-  Schema.Literal('resolved'),
-);
-
-const _ThreadType = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  status: Schema.optional(ThreadStatus),
-  messages: Schema.mutable(Schema.Array(Type.Ref(DataType.Message))),
-}).pipe(Type.Obj({ typename: 'dxos.org/type/Thread', version: '0.1.0' }));
-export interface ThreadType extends Schema.Schema.Type<typeof _ThreadType> {}
-export const ThreadType: Type.obj<Schema.Schema<ThreadType, Schema.Schema.Encoded<typeof _ThreadType>, never>> =
-  _ThreadType;
-
-const _ChannelType = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  defaultThread: Type.Ref(ThreadType),
-  // TODO(wittjosiah): Should be an "ordered collection".
-  threads: Schema.mutable(Schema.Array(Type.Ref(ThreadType))),
-}).pipe(Type.Obj({ typename: 'dxos.org/type/Channel', version: '0.1.0' }));
-export interface ChannelType extends Schema.Schema.Type<typeof _ChannelType> {}
-export const ChannelType: Type.obj<Schema.Schema<ChannelType, Schema.Schema.Encoded<typeof _ChannelType>, never>> =
-  _ChannelType;