@dxos/plugin-thread 0.8.4-main.72ec0f3 → 0.8.4-main.7996785055

package/src/components/ChatContainer.tsx

@@ -1,154 +0,0 @@
-//
-// 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 { Icon, ScrollArea, type ThemedClassName, 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 as ThreadComponent,
-  type ThreadRootProps,
-  threadLayout,
-} from '@dxos/react-ui-thread';
-import { Message } from '@dxos/types';
-import { isNonNullable } from '@dxos/util';
-
-import { useStatus } from '../hooks';
-import { meta } from '../meta';
-import { type Thread } 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 = ThemedClassName<
-  {
-    space: Space;
-    thread: Thread.Thread;
-    context?: Obj.Any;
-    autoFocusTextbox?: boolean;
-  } & Pick<ThreadRootProps, 'current'>
->;
-
-export const ChatContainer = ({
-  classNames,
-  space,
-  thread,
-  context,
-  current,
-  autoFocusTextbox,
-}: ChatContainerProps) => {
-  const { t } = useTranslation(meta.id);
-  const id = Obj.getDXN(thread).toString();
-  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(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
-      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',
-        classNames,
-      ]}
-    >
-      <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} />
-      <ThreadComponent.Status activity={activity}>{t('activity message')}</ThreadComponent.Status>
-    </ThreadComponent.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 { render } from '@dxos/storybook-utils';
-import { AnchoredTo, Message } from '@dxos/types';
-
-import { translations } from '../translations';
-import { Thread } 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.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.AnchoredTo, {
-          [Relation.Source]: thread1,
-          [Relation.Target]: object,
-          anchor: 'test',
-        }),
-      );
-      space.db.add(
-        Relation.make(AnchoredTo.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: [Message.Message, Thread.Thread, AnchoredTo.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/ThreadCompanion.tsx

@@ -1,188 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useMemo } from 'react';
-
-import { Capabilities, CollaborationActions, LayoutAction, createIntent } from '@dxos/app-framework';
-import { useCapabilities, useCapability, useIntentDispatcher } from '@dxos/app-framework/react';
-import { Filter, Obj, Query, Relation } from '@dxos/echo';
-import { Ref, getSpace, useQuery } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { 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/types';
-
-import { ThreadCapabilities } from '../capabilities';
-import { CommentsContainer, type CommentsContainerProps } from '../components';
-import { meta } from '../meta';
-import { Thread, ThreadAction } from '../types';
-
-export const ThreadCompanion = ({ subject }: { subject: any }) => {
-  const { t } = useTranslation(meta.id);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const identity = useIdentity();
-  const subjectId = Obj.getDXN(subject).toString();
-
-  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.AnchoredTo));
-  const anchors = objectsAnchoredTo
-    .toSorted((a, b) => sort?.(a, b) ?? 0)
-    .filter((anchor) => Obj.instanceOf(Thread.Thread, Relation.getSource(anchor)))
-    .concat(drafts ?? []);
-
-  const attended = useAttended();
-
-  const handleAttend = useCallback(
-    (anchor: AnchoredTo.AnchoredTo) => {
-      const thread = Relation.getSource(anchor) as Thread.Thread;
-      const threadId = Obj.getDXN(thread).toString();
-
-      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: Obj.getDXN(subject).toString(),
-            options: {
-              cursor: anchor.anchor,
-              ref: threadId,
-            },
-          }),
-        );
-      }
-    },
-    [state.current, dispatch, subject],
-  );
-
-  const handleComment = useCallback(
-    async (anchor: AnchoredTo.AnchoredTo, text: string) => {
-      await dispatch(
-        createIntent(ThreadAction.AddMessage, {
-          anchor,
-          subject,
-          sender: { identityDid: identity?.did },
-          text,
-        }),
-      );
-
-      const thread = Relation.getSource(anchor) as Thread.Thread;
-      state.current = Obj.getDXN(thread).toString();
-    },
-    [dispatch, identity, subject],
-  );
-
-  const handleResolve = useCallback(
-    (anchor: AnchoredTo.AnchoredTo) =>
-      dispatch(
-        createIntent(ThreadAction.ToggleResolved, {
-          thread: Relation.getSource(anchor) as Thread.Thread,
-        }),
-      ),
-    [dispatch],
-  );
-
-  const handleThreadDelete = useCallback(
-    (anchor: AnchoredTo.AnchoredTo) => dispatch(createIntent(ThreadAction.Delete, { anchor, subject })),
-    [dispatch, subject],
-  );
-
-  const handleMessageDelete = useCallback(
-    (anchor: AnchoredTo.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 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 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-be 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/functions/create-proposals.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Array from 'effect/Array';
-import * as Effect from 'effect/Effect';
-import * as Function from 'effect/Function';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId, computeDiffsWithCursors } from '@dxos/assistant';
-import { Obj, Ref, Relation } from '@dxos/echo';
-import { createDocAccessor } from '@dxos/echo-db';
-import { DatabaseService, defineFunction } from '@dxos/functions';
-import { DXN } from '@dxos/keys';
-import { Markdown } from '@dxos/plugin-markdown/types';
-import { AnchoredTo, Message } from '@dxos/types';
-
-import { Thread } from '../types';
-
-export default defineFunction({
-  key: 'dxos.org/function/thread/create-proposals',
-  name: 'Create Proposals',
-  description: 'Proposes a set of changes to a document.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId,
-    diffs: Schema.Array(Schema.String).annotations({
-      description: 'The diffs to propose for the document.',
-    }),
-  }),
-  outputSchema: Schema.Void,
-  handler: Effect.fn(function* ({ data: { id, diffs: _diffs } }) {
-    const object = yield* DatabaseService.resolve(DXN.parse(id), Markdown.Document);
-    const content = yield* Effect.promise(() => object.content.load());
-    const accessor = createDocAccessor(content, ['content']);
-
-    yield* Function.pipe(
-      computeDiffsWithCursors(accessor, _diffs),
-      Array.map(
-        Effect.fnUntraced(function* ({ cursor, text }) {
-          const proposal = Obj.make(Message.Message, {
-            created: new Date().toISOString(),
-            sender: { role: 'assistant' },
-            blocks: [{ _tag: 'proposal', text }],
-          });
-          const thread = Thread.make({ name: 'Proposal', messages: [Ref.make(proposal)], status: 'active' });
-          const relation = Relation.make(AnchoredTo.AnchoredTo, {
-            [Relation.Source]: thread,
-            [Relation.Target]: object,
-            anchor: cursor,
-          });
-          yield* DatabaseService.add(thread);
-          yield* DatabaseService.add(relation);
-        }),
-      ),
-      Effect.allWith({ concurrency: 'unbounded' }),
-    );
-  }),
-});

package/src/functions/index.ts

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

package/src/types/Thread.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Obj, Type } from '@dxos/echo';
-import { Message } from '@dxos/types';
-
-export const ThreadStatus = Schema.Union(
-  Schema.Literal('staged'),
-  Schema.Literal('active'),
-  Schema.Literal('resolved'),
-);
-
-const _Thread = Schema.Struct({
-  name: Schema.String.pipe(Schema.optional),
-  status: ThreadStatus.pipe(Schema.optional),
-  messages: Schema.mutable(Schema.Array(Type.Ref(Message.Message))),
-}).pipe(Type.Obj({ typename: 'dxos.org/type/Thread', version: '0.1.0' }));
-export interface Thread extends Schema.Schema.Type<typeof _Thread> {}
-export interface ThreadEncoded extends Schema.Schema.Encoded<typeof _Thread> {}
-export const Thread: Schema.Schema<Thread, ThreadEncoded> = _Thread;
-
-export const make = ({ status = 'staged', messages = [], ...props }: Partial<Obj.MakeProps<typeof Thread>> = {}) =>
-  Obj.make(Thread, { status, messages, ...props });