@dxos/plugin-thread 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/src/containers/ThreadCompanion/ThreadCompanion.tsx

@@ -0,0 +1,197 @@
+//
+// 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 { 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 { useAttended } from '@dxos/react-ui-attention';
+import { Tabs } from '@dxos/react-ui-tabs';
+import { AnchoredTo, Thread } from '@dxos/types';
+
+import { CommentsContainer, type CommentsContainerProps } from '../../components';
+import { meta } from '../../meta';
+import { ThreadCapabilities, ThreadOperation, type ViewState } from '../../types';
+
+const initialViewState: ViewState = { showResolvedThreads: false };
+
+export const ThreadCompanion = ({ subject }: { subject: any }) => {
+  const { t } = useTranslation(meta.id);
+  const { invokePromise } = useOperationInvoker();
+  const identity = useIdentity();
+  const subjectId = Obj.getDXN(subject).toString();
+  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 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) {
+        registry.set(stateAtom, { ...registry.get(stateAtom), 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 invokePromise(LayoutOperation.ScrollIntoView, {
+          subject: Obj.getDXN(subject).toString(),
+          cursor: anchor.anchor,
+          ref: threadId,
+        });
+      }
+    },
+    [state.current, invokePromise, subject, registry, stateAtom],
+  );
+
+  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<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 invokePromise(CollaborationOperation.AcceptProposal, {
+        subject,
+        anchor: anchor.anchor,
+        proposal,
+      });
+      await invokePromise(ThreadOperation.ToggleResolved, { thread });
+    },
+    [invokePromise, 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}
+    />
+  );
+
+  // TODO(burdon): Root should be headless.
+  return (
+    <Tabs.Root
+      value={showResolvedThreads ? 'all' : 'unresolved'}
+      orientation='horizontal'
+      onValueChange={onChangeViewState}
+    >
+      <Panel.Root>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            <Tabs.Tablist>
+              <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>
+          </Toolbar.Root>
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <ScrollArea.Root thin>
+            <ScrollArea.Viewport>
+              <Tabs.Tabpanel value='all'>{showResolvedThreads && comments}</Tabs.Tabpanel>
+              <Tabs.Tabpanel value='unresolved'>{!showResolvedThreads && comments}</Tabs.Tabpanel>
+            </ScrollArea.Viewport>
+          </ScrollArea.Root>
+        </Panel.Content>
+      </Panel.Root>
+    </Tabs.Root>
+  );
+};

package/src/containers/ThreadCompanion/index.ts

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

package/src/containers/ThreadSettings/ThreadSettings.tsx

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '../../meta';
+import type { ThreadSettingsProps } from '../../types';
+
+export type ThreadSettingsComponentProps = {
+  settings: ThreadSettingsProps;
+  onSettingsChange: (fn: (current: ThreadSettingsProps) => ThreadSettingsProps) => void;
+};
+
+// TODO(burdon): Settings.
+export const ThreadSettings = ({ settings: _settings }: ThreadSettingsComponentProps) => {
+  const { t: _t } = useTranslation(meta.id);
+  return <Settings.Root></Settings.Root>;
+};

package/src/containers/ThreadSettings/index.ts

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

package/src/containers/index.ts

@@ -0,0 +1,12 @@
+//
+// 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'));
+export const ThreadSettings: ComponentType<any> = lazy(() => import('./ThreadSettings'));

package/src/extensions/threads.ts

@@ -4,16 +4,16 @@
 
 import { type Extension } from '@codemirror/state';
 import { EditorView } from '@codemirror/view';
-import { computed, effect } from '@preact/signals-core';
+import { type Atom, type Registry } from '@effect-atom/atom-react';
 
-import { type PromiseIntentDispatcher, createIntent } from '@dxos/app-framework';
 import { Filter, Obj, Query, Relation } from '@dxos/echo';
+import { createDocAccessor, getTextInRange } from '@dxos/echo-db';
+import { type OperationInvoker } from '@dxos/operation';
 import { type Markdown } from '@dxos/plugin-markdown/types';
-import { createDocAccessor, fullyQualifiedId, getSource, getSpace, getTextInRange } from '@dxos/react-client/echo';
-import { comments, createExternalCommentSync } from '@dxos/react-ui-editor';
-import { AnchoredTo } from '@dxos/schema';
+import { AnchoredTo, Thread } from '@dxos/types';
+import { comments, createExternalCommentSync } from '@dxos/ui-editor';
 
-import { ThreadAction, type ThreadState, ThreadType } from '../types';
+import { ThreadOperation, type ThreadState } from '../types';
 
 // TODO(burdon): Factor out.
 const getName = (doc: Markdown.Document, anchor: string): string | undefined => {
@@ -23,46 +23,58 @@ const getName = (doc: Markdown.Document, anchor: string): string | undefined =>
   }
 };
 
+export type ThreadStore = {
+  registry: Registry.Registry;
+  stateAtom: Atom.Writable<ThreadState>;
+};
+
 /**
  * Construct plugins.
  */
-export const threads = (state: ThreadState, doc?: Markdown.Document, dispatch?: PromiseIntentDispatcher): Extension => {
-  const space = doc && getSpace(doc);
-  if (!doc || !space || !dispatch) {
+export const threads = (
+  store: ThreadStore,
+  doc?: Markdown.Document,
+  invokePromise?: OperationInvoker.OperationInvoker['invokePromise'],
+): Extension => {
+  const db = doc && Obj.getDatabase(doc);
+  if (!doc || !db || !invokePromise) {
     // Include no-op comments extension here to ensure that the facets are always present when they are expected.
     // TODO(wittjosiah): The Editor should only look for these facets when comments are available.
     return [comments()];
   }
 
-  const query = space.db.query(Query.select(Filter.ids(doc.id)).targetOf(AnchoredTo));
-  const unsubscribe = query.subscribe();
+  const { registry, stateAtom } = store;
+  const objectId = Obj.getDXN(doc).toString();
+  const query = db.query(Query.select(Filter.id(doc.id)).targetOf(AnchoredTo.AnchoredTo));
 
-  const anchors = computed(() =>
-    query.objects
+  // Get current anchors by combining query results with store drafts.
+  const getAnchors = () =>
+    query.results
       .filter((anchor) => {
         const thread = Relation.getSource(anchor);
-        return Obj.instanceOf(ThreadType, thread) && thread.status !== 'resolved';
+        return Obj.instanceOf(Thread.Thread, thread) && thread.status !== 'resolved';
       })
-      .concat(state.drafts[fullyQualifiedId(doc)] ?? []),
-  );
+      .concat(registry.get(stateAtom).drafts[objectId] ?? []);
 
   return [
     EditorView.domEventHandlers({
       destroy: () => {
-        unsubscribe();
+        // Note: cleanup functions for subscriptions are handled by createExternalCommentSync.
       },
     }),
 
     EditorView.updateListener.of((update) => {
       if (update.docChanged) {
-        anchors.value.forEach((anchor) => {
+        getAnchors().forEach((anchor) => {
           if (anchor.anchor) {
             // Only update if the name has changed, otherwise this will cause an infinite loop.
             // Skip if the name is empty; this means comment text was deleted, but thread name should remain.
             const name = getName(doc, anchor.anchor);
-            const thread = Relation.getSource(anchor) as ThreadType;
+            const thread = Relation.getSource(anchor) as Thread.Thread;
             if (name && name !== thread.name) {
-              thread.name = name;
+              Obj.change(thread, (t) => {
+                t.name = name;
+              });
             }
           }
         });
@@ -70,55 +82,87 @@ export const threads = (state: ThreadState, doc?: Markdown.Document, dispatch?:
     }),
 
     createExternalCommentSync(
-      fullyQualifiedId(doc),
-      (sink) => effect(() => sink()),
+      objectId,
+      (sink) => {
+        // Subscribe to both query changes and store state changes.
+        const unsubQuery = query.subscribe(sink);
+        const unsubStore = registry.subscribe(stateAtom, sink);
+        return () => {
+          unsubQuery();
+          unsubStore();
+        };
+      },
       () =>
-        anchors.value
+        getAnchors()
           .filter((anchor) => anchor.anchor)
-          .map((anchor) => ({ id: fullyQualifiedId(Relation.getSource(anchor)), cursor: anchor.anchor })),
+          .map((anchor) => ({
+            id: Obj.getDXN(Relation.getSource(anchor)).toString(),
+            cursor: anchor.anchor,
+          })),
     ),
 
     comments({
-      id: fullyQualifiedId(doc),
+      id: objectId,
       onCreate: ({ cursor }) => {
         const name = getName(doc, cursor);
-        void dispatch(createIntent(ThreadAction.Create, { anchor: cursor, name, subject: doc }));
+        void invokePromise(ThreadOperation.Create, {
+          anchor: cursor,
+          name,
+          subject: doc,
+        });
       },
       onDelete: ({ id }) => {
-        const draft = state.drafts[fullyQualifiedId(doc)];
-        if (draft) {
-          const index = draft.findIndex((thread) => fullyQualifiedId(thread) === id);
+        const drafts = registry.get(stateAtom).drafts[objectId];
+        if (drafts) {
+          const index = drafts.findIndex((draft) => Relation.getDXN(draft).toString() === id);
           if (index !== -1) {
-            draft.splice(index, 1);
+            const current = registry.get(stateAtom);
+            registry.set(stateAtom, {
+              ...current,
+              drafts: {
+                ...current.drafts,
+                [objectId]: current.drafts[objectId]?.filter((_, i) => i !== index),
+              },
+            });
           }
         }
 
-        const thread = query.objects.find((object) => getSource(object).id === id);
+        const thread = query.results.find((object) => Relation.getSource(object).id === id);
         if (thread) {
-          thread.anchor = undefined;
+          Relation.change(thread, (t) => {
+            t.anchor = undefined;
+          });
         }
       },
       onUpdate: ({ id, cursor }) => {
-        const draft = state.drafts[fullyQualifiedId(doc)]?.find((thread) => fullyQualifiedId(thread) === id);
+        const draft = registry.get(stateAtom).drafts[objectId]?.find((d) => Relation.getDXN(d).toString() === id);
         if (draft) {
-          const thread = Relation.getSource(draft) as ThreadType;
-          thread.name = getName(doc, cursor);
-          draft.anchor = cursor;
+          const thread = Relation.getSource(draft) as Thread.Thread;
+          Obj.change(thread, (t) => {
+            t.name = getName(doc, cursor);
+          });
+          Relation.change(draft, (d) => {
+            d.anchor = cursor;
+          });
         }
 
-        const relation = query.objects.find((object) => getSource(object).id === id);
+        const relation = query.results.find((object) => Relation.getSource(object).id === id);
         if (relation) {
-          const thread = getSource(relation);
-          if (Obj.instanceOf(ThreadType, thread)) {
-            thread.name = getName(doc, cursor);
-            relation.anchor = cursor;
+          const thread = Relation.getSource(relation);
+          if (Obj.instanceOf(Thread.Thread, thread)) {
+            Obj.change(thread, (t) => {
+              t.name = getName(doc, cursor);
+            });
+            Relation.change(relation, (r) => {
+              r.anchor = cursor;
+            });
           }
         }
       },
       onSelect: ({ selection }) => {
         const current = selection.current ?? selection.closest;
         if (current) {
-          void dispatch(createIntent(ThreadAction.Select, { current }));
+          void invokePromise(ThreadOperation.Select, { current });
         }
       },
     }),

package/src/functions/create-proposals.ts

@@ -0,0 +1,57 @@
+//
+// 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 { computeDiffsWithCursors } from '@dxos/assistant';
+import { Database, Obj, Ref, Relation } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-db';
+import { defineFunction } from '@dxos/functions';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { AnchoredTo, Message, Thread } from '@dxos/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({
+    doc: Ref.Ref(Markdown.Document).annotations({
+      description: 'The ID of the document.',
+    }),
+    diffs: Schema.Array(Schema.String).annotations({
+      description: 'The diffs to propose for the document.',
+    }),
+  }),
+  outputSchema: Schema.Void,
+  handler: Effect.fn(function* ({ data: { doc, diffs: _diffs } }) {
+    const object = yield* Database.load(doc);
+    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* Database.add(thread);
+          yield* Database.add(relation);
+        }),
+      ),
+      Effect.allWith({ concurrency: 'unbounded' }),
+    );
+  }),
+});

package/src/functions/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import CreateProposals from './create-proposals';
+
+export const ThreadFunctions = {
+  CreateProposals,
+};

package/src/hooks/analytics.ts

@@ -4,37 +4,38 @@
 
 import { useCallback } from 'react';
 
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { type Live } from '@dxos/live-object';
-import { ObservabilityAction } from '@dxos/plugin-observability/types';
-import { getSpace } from '@dxos/react-client/echo';
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { Obj } from '@dxos/echo';
+import { ObservabilityOperation } from '@dxos/plugin-observability/types';
 import { useOnTransition } from '@dxos/react-ui';
-import { type DataType } from '@dxos/schema';
+import { type ContentBlock } from '@dxos/types';
 
 export const useOnEditAnalytics = (
-  message: Live<any>,
-  textBlock: DataType.MessageBlock.Text | undefined,
+  message: any | undefined,
+  textBlock: ContentBlock.Text | undefined,
   editing: boolean,
 ) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const { invokePromise } = useOperationInvoker();
 
   const onEdit = useCallback(() => {
-    const space = getSpace(message);
-    if (!space || !textBlock) {
+    if (!message || !textBlock) {
       return;
     }
 
-    void dispatch(
-      createIntent(ObservabilityAction.SendEvent, {
-        name: 'threads.message.update',
-        properties: {
-          spaceId: space.id,
-          messageId: message.id,
-          messageLength: textBlock?.text.length,
-        },
-      }),
-    );
-  }, [dispatch, message, textBlock]);
+    const db = Obj.getDatabase(message);
+    if (!db) {
+      return;
+    }
+
+    void invokePromise(ObservabilityOperation.SendEvent, {
+      name: 'threads.message.update',
+      properties: {
+        spaceId: db.spaceId,
+        messageId: message.id,
+        messageLength: textBlock?.text.length,
+      },
+    });
+  }, [invokePromise, message, textBlock]);
 
   useOnTransition(editing, true, false, onEdit);
 };

package/src/hooks/index.ts

@@ -3,8 +3,9 @@
 //
 
 export * from './analytics';
+
+export * from './useBlackCanvasStreamTrack';
 export * from './useDebugMode';
+export * from './useInaudibleAudioStreamTrack';
 export * from './useStatus';
 export * from './useVideoStreamTrack';
-export * from './useInaudibleAudioStreamTrack';
-export * from './useBlackCanvasStreamTrack';

package/src/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-export { ThreadCapabilities } from './capabilities';
+export { ThreadCapabilities } from './types';
 export * from './calls';
 export * from './hooks';
 export * from './meta';

package/src/meta.ts

@@ -2,14 +2,19 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
 // TODO(wittjosiah): Needs screenshots.
-export const meta: PluginMeta = {
+export const meta: Plugin.Meta = {
   id: 'dxos.org/plugin/thread',
   name: 'Chat',
-  description: 'Chat via text, voice, and video in channels or create comment threads on objects.',
+  description: trim`
+    Multi-modal communication platform supporting text chat, voice, and video conferencing.
+    Create threaded conversations and add contextual comments directly on any workspace object.
+  `,
   icon: 'ph--video-conference--regular',
+  iconHue: 'rose',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-thread',
 };