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

package/src/containers/ThreadContainer/ThreadContainer.tsx

@@ -0,0 +1,75 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useMemo } 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 { type ThemedClassName } from '@dxos/react-ui';
+import { type ThreadRootProps } from '@dxos/react-ui-thread';
+import { Message, type Thread } from '@dxos/types';
+import { composable, composableProps } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
+
+import { Chat } from '#components';
+import { useStatus } from '#hooks';
+
+export type ThreadContainerProps = ThemedClassName<
+  {
+    space: Space;
+    thread: Thread.Thread;
+    context?: Obj.Unknown;
+    autoFocusTextbox?: boolean;
+  } & Pick<ThreadRootProps, 'current'>
+>;
+
+/**
+ * Renders an AutoMerge {@link Thread} as a chat: appends new messages by pushing
+ * onto `thread.messages`. Used for comment threads and the meeting in-call chat.
+ */
+export const ThreadContainer = composable<HTMLDivElement, ThreadContainerProps>(
+  ({ space, thread, context, autoFocusTextbox, current, ...props }, forwardedRef) => {
+    const id = Obj.getDXN(thread).toString();
+    const identity = useIdentity()!;
+    const members = useMembers(space?.id);
+    const activity = useStatus(space, id);
+
+    const messages = useMemo(
+      () => thread.messages.map((message) => message.target).filter(isNonNullable),
+      [thread.messages],
+    );
+
+    const handleSend = (text: string) => {
+      Obj.update(thread, (thread) => {
+        thread.messages.push(
+          Ref.make(
+            Obj.make(Message.Message, {
+              created: new Date().toISOString(),
+              sender: { identityDid: identity.did },
+              blocks: [{ _tag: 'text', text }],
+              properties: context ? { context: Ref.make(context) } : undefined,
+            }),
+          ),
+        );
+      });
+      return true;
+    };
+
+    return (
+      <Chat
+        {...composableProps(props)}
+        id={id}
+        identity={identity}
+        members={members}
+        messages={messages}
+        activity={activity}
+        onSend={handleSend}
+        autoFocusTextbox={autoFocusTextbox}
+        current={current}
+        ref={forwardedRef}
+      />
+    );
+  },
+);

package/src/containers/ThreadContainer/index.ts

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

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 ChannelChat: ComponentType<any> = lazy(() => import('./ChannelChat'));
+export const ChannelContainer: ComponentType<any> = lazy(() => import('./ChannelContainer'));
+export const ThreadContainer: ComponentType<any> = lazy(() => import('./ThreadContainer'));
+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';

package/src/extensions/threads.ts

@@ -4,65 +4,78 @@
 
 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 { createIntent, type PromiseIntentDispatcher } from '@dxos/app-framework';
 import { Filter, Obj, Query, Relation } from '@dxos/echo';
-import { type DocumentType } from '@dxos/plugin-markdown/types';
-import { getSpace, getTextInRange, createDocAccessor, fullyQualifiedId, getSource } from '@dxos/react-client/echo';
-import { comments, createExternalCommentSync } from '@dxos/react-ui-editor';
-import { AnchoredTo } from '@dxos/schema';
+import { createDocAccessor, getTextInRange } from '@dxos/echo-db';
+import { OperationInvoker } from '@dxos/operation';
+import { type Markdown } from '@dxos/plugin-markdown/types';
+import { AnchoredTo, Thread } from '@dxos/types';
+import { comments, createExternalCommentSync } from '@dxos/ui-editor';
 
-import { ThreadAction, ThreadType, type ThreadState } from '../types';
+import { ThreadOperation } from '#operations';
+import { type ThreadState } from '#types';
 
 // TODO(burdon): Factor out.
-const getName = (doc: DocumentType, anchor: string): string | undefined => {
+const getName = (doc: Markdown.Document, anchor: string): string | undefined => {
   if (doc.content) {
     const [start, end] = anchor.split(':');
     return getTextInRange(createDocAccessor(doc.content.target!, ['content']), start, end);
   }
 };
 
+export type ThreadStore = {
+  registry: Registry.Registry;
+  stateAtom: Atom.Writable<ThreadState>;
+};
+
 /**
  * Construct plugins.
  */
-export const threads = (state: ThreadState, doc?: DocumentType, 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.update(thread, (thread) => {
+                thread.name = name;
+              });
             }
           }
         });
@@ -70,55 +83,87 @@ export const threads = (state: ThreadState, doc?: DocumentType, dispatch?: Promi
     }),
 
     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.update(thread, (thread) => {
+            thread.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.update(thread, (thread) => {
+            thread.name = getName(doc, cursor);
+          });
+          Relation.update(draft, (draft) => {
+            draft.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.update(thread, (thread) => {
+              thread.name = getName(doc, cursor);
+            });
+            Relation.update(relation, (relation) => {
+              relation.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/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/operations';
 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,5 +3,9 @@
 //
 
 export * from './analytics';
+
+export * from './useBlackCanvasStreamTrack';
 export * from './useDebugMode';
+export * from './useInaudibleAudioStreamTrack';
 export * from './useStatus';
+export * from './useVideoStreamTrack';

package/src/hooks/useBlackCanvasStreamTrack.tsx

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useState } from 'react';
+
+import { scheduleTask } from '@dxos/async';
+import { Context } from '@dxos/context';
+
+import { createBlackCanvasStreamTrack } from '../calls/util/stub-media-streams';
+
+export const useBlackCanvasStreamTrack = () => {
+  const [blackCanvasStreamTrack, setBlackCanvasStreamTrack] = useState<MediaStreamTrack | undefined>(undefined);
+  useEffect(() => {
+    const ctx = new Context();
+    scheduleTask(ctx, async () => {
+      const blackCanvasStreamTrack = await createBlackCanvasStreamTrack({ ctx, width: 720, height: 480 });
+      setBlackCanvasStreamTrack(blackCanvasStreamTrack);
+    });
+
+    return () => {
+      void ctx.dispose();
+    };
+  }, []);
+
+  return blackCanvasStreamTrack;
+};

package/src/hooks/useDebugMode.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useState, useEffect } from 'react';
+import { useEffect, useState } from 'react';
 
 // TODO(burdon): Standardize across plugins/composer.
 export const useDebugMode = () => {

package/src/hooks/useInaudibleAudioStreamTrack.tsx

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useState } from 'react';
+
+import { scheduleTask } from '@dxos/async';
+import { Context } from '@dxos/context';
+
+import { createInaudibleAudioStreamTrack } from '../calls/util/stub-media-streams';
+
+export const useInaudibleAudioStreamTrack = () => {
+  const [audioStreamTrack, setAudioStreamTrack] = useState<MediaStreamTrack | undefined>(undefined);
+  useEffect(() => {
+    const ctx = new Context();
+    scheduleTask(ctx, async () => {
+      const audioStreamTrack = await createInaudibleAudioStreamTrack({ ctx });
+      setAudioStreamTrack(audioStreamTrack);
+    });
+
+    return () => {
+      void ctx.dispose();
+    };
+  }, []);
+
+  return audioStreamTrack;
+};

package/src/hooks/useVideoStreamTrack.tsx

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type RefObject, useEffect, useRef, useState } from 'react';
+
+export const useVideoStreamTrack = (videoElement: RefObject<HTMLVideoElement | null>, videoSrc: string) => {
+  // Get video stream track.
+  const [videoStreamTrack, setVideoStreamTrack] = useState<MediaStreamTrack | undefined>(undefined);
+  const hadRun = useRef(false);
+  useEffect(() => {
+    // This is done to capture only one video stream.
+    if (!videoElement.current || hadRun.current || !videoSrc) {
+      return;
+    }
+    hadRun.current = true;
+    videoElement.current.addEventListener('playing', () => {
+      if (videoStreamTrack) {
+        return;
+      }
+      const stream = (videoElement.current as any).captureStream();
+      const track = stream.getTracks()[0];
+      if (track && !videoStreamTrack) {
+        setVideoStreamTrack(track);
+      }
+      stream.onaddtrack = (event: MediaStreamTrackEvent) => {
+        if (event.track.kind === 'video' && !videoStreamTrack) {
+          setVideoStreamTrack(event.track);
+        }
+      };
+    });
+    videoElement.current.src = videoSrc;
+  }, [videoElement.current, videoSrc]);
+
+  return videoStreamTrack;
+};

package/src/index.ts

@@ -2,9 +2,16 @@
 // Copyright 2023 DXOS.org
 //
 
-export { ThreadCapabilities } from './capabilities';
-export * from './calls';
-export * from './hooks';
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const ThreadPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
 export * from './meta';
 
-export * from './ThreadPlugin';
+export { ThreadCapabilities } from './types';
+export * from './calls';
+// TODO(wittjosiah): Hooks should not be exported from the plugin package at all.
+//   Either refactor callers to not need them or factor them out to a shared package.
+export * from './hooks';

package/src/meta.ts

@@ -2,16 +2,20 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
-
-export const THREAD_PLUGIN = 'dxos.org/plugin/thread';
-export const THREAD_ITEM = `${THREAD_PLUGIN}/item`;
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
 // TODO(wittjosiah): Needs screenshots.
-export const meta: PluginMeta = {
-  id: THREAD_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.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',
 };
+
+export const THREAD_ITEM = `${meta.id}.item`;

package/src/operations/add-message.ts

@@ -0,0 +1,81 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { Obj, Ref, Relation } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { SpaceOperation } from '@dxos/plugin-space/operations';
+import { AnchoredTo, Message, Thread } from '@dxos/types';
+
+import { ThreadCapabilities } from '../types';
+import { AddMessage } from './definitions';
+
+const handler: Operation.WithHandler<typeof AddMessage> = AddMessage.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ anchor, subject, sender, text }) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const stateAtom = yield* Capability.get(ThreadCapabilities.State);
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const subjectId = Obj.getDXN(subject).toString();
+      const db = Obj.getDatabase(subject);
+      invariant(db, 'Database not found');
+
+      const message = Obj.make(Message.Message, {
+        created: new Date().toISOString(),
+        sender,
+        blocks: [{ _tag: 'text', text }],
+      });
+      Obj.update(thread, (thread) => {
+        thread.messages.push(Ref.make(message));
+      });
+
+      const state = registry.get(stateAtom);
+      const draft = state.drafts[subjectId]?.find((a: { id: string }) => a.id === anchor.id);
+      if (draft) {
+        Obj.update(thread, (thread) => {
+          thread.status = 'active';
+        });
+        registry.set(stateAtom, {
+          ...state,
+          drafts: {
+            ...state.drafts,
+            [subjectId]: state.drafts[subjectId]?.filter((a: { id: string }) => a.id !== anchor.id),
+          },
+        });
+        yield* Operation.invoke(SpaceOperation.AddObject, { object: thread, target: db, hidden: true });
+        yield* Operation.invoke(SpaceOperation.AddRelation, {
+          db,
+          schema: AnchoredTo.AnchoredTo,
+          source: thread,
+          target: subject,
+          fields: { anchor: draft.anchor },
+        });
+        yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+          name: 'threads.create',
+          properties: {
+            spaceId: db.spaceId,
+            threadId: thread.id,
+          },
+        });
+      }
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.message.add',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+          threadLength: thread.messages.length,
+          messageId: message.id,
+          messageLength: text.length,
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;