@dxos/plugin-thread 0.8.4-main.f5c0578 → 0.8.4-main.fcfe5033a5

package/src/hooks/index.ts

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

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/useVideoStreamTrack.tsx

@@ -4,7 +4,7 @@
 
 import { type RefObject, useEffect, useRef, useState } from 'react';
 
-export const useVideoStreamTrack = (videoElement: RefObject<HTMLVideoElement>, videoSrc: string) => {
+export const useVideoStreamTrack = (videoElement: RefObject<HTMLVideoElement | null>, videoSrc: string) => {
   // Get video stream track.
   const [videoStreamTrack, setVideoStreamTrack] = useState<MediaStreamTrack | undefined>(undefined);
   const hadRun = useRef(false);
@@ -15,13 +15,16 @@ export const useVideoStreamTrack = (videoElement: RefObject<HTMLVideoElement>, v
     }
     hadRun.current = true;
     videoElement.current.addEventListener('playing', () => {
+      if (videoStreamTrack) {
+        return;
+      }
       const stream = (videoElement.current as any).captureStream();
       const track = stream.getTracks()[0];
-      if (track) {
+      if (track && !videoStreamTrack) {
         setVideoStreamTrack(track);
       }
       stream.onaddtrack = (event: MediaStreamTrackEvent) => {
-        if (event.track.kind === 'video') {
+        if (event.track.kind === 'video' && !videoStreamTrack) {
           setVideoStreamTrack(event.track);
         }
       };

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,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 { Obj, Ref, Relation } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+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.change(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.change(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;

package/src/operations/create-channel-thread.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Obj, Ref } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { Thread } from '@dxos/types';
+
+import { CreateChannelThread } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateChannelThread> = CreateChannelThread.pipe(
+  Operation.withHandler((input) =>
+    Effect.sync(() => {
+      const thread = Thread.make({ status: 'active' });
+      const threadRef = Ref.make(thread);
+      Obj.change(input.channel, (obj) => {
+        obj.threads.push(threadRef);
+      });
+      return { object: thread };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/create-channel.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/operation';
+
+import { Channel } from '../types';
+import { CreateChannel } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateChannel> = CreateChannel.pipe(
+  Operation.withHandler((input) =>
+    Effect.sync(() => ({
+      object: Channel.make({ name: input.name }),
+    })),
+  ),
+);
+
+export default handler;

package/src/operations/create-proposals.ts

@@ -0,0 +1,49 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Array from 'effect/Array';
+import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
+
+import { computeDiffsWithCursors } from '@dxos/assistant';
+import { Database, Obj, Ref, Relation } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-db';
+import { Operation } from '@dxos/operation';
+import { AnchoredTo, Message, Thread } from '@dxos/types';
+
+import { CreateProposals } from './definitions';
+
+const handler: Operation.WithHandler<typeof CreateProposals> = CreateProposals.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ doc, 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' }),
+      );
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/create.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Obj, Relation } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { DeckOperation } from '@dxos/plugin-deck/operations';
+import { linkedSegment } from '@dxos/react-ui-attention';
+import { AnchoredTo, Thread } from '@dxos/types';
+
+import { ThreadCapabilities } from '../types';
+import { Create, Select } from './definitions';
+
+const handler: Operation.WithHandler<typeof Create> = Create.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ name, anchor: _anchor, subject }) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const stateAtom = yield* Capability.get(ThreadCapabilities.State);
+      const subjectId = Obj.getDXN(subject).toString();
+      const thread = Thread.make({ name });
+      const anchor = Relation.make(AnchoredTo.AnchoredTo, {
+        [Relation.Source]: thread,
+        [Relation.Target]: subject,
+        anchor: _anchor,
+      });
+
+      const state = registry.get(stateAtom);
+      const existingDrafts = state.drafts[subjectId];
+      registry.set(stateAtom, {
+        ...state,
+        drafts: {
+          ...state.drafts,
+          [subjectId]: existingDrafts ? [...existingDrafts, anchor] : [anchor],
+        },
+      });
+
+      yield* Operation.invoke(Select, { current: Obj.getDXN(thread).toString() });
+      yield* Operation.invoke(DeckOperation.ChangeCompanion, {
+        companion: linkedSegment('comments'),
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/definitions.ts

@@ -0,0 +1,177 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Database, Key, Obj, Ref } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { SpaceSchema } from '@dxos/react-client/echo';
+import { Actor, AnchoredTo, Message, Thread } from '@dxos/types';
+
+import { meta } from '#meta';
+
+import { Channel } from '../types';
+
+const THREAD_OPERATION = `${meta.id}.operation`;
+
+export const OnCreateSpace = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.on-create-space`, name: 'On Create Space' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    space: SpaceSchema,
+    rootCollection: Collection.Collection,
+    isDefault: Schema.Boolean.pipe(Schema.optional),
+  }),
+  output: Schema.Void,
+});
+
+export const CreateChannel = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create-channel`, name: 'Create Channel' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    spaceId: Key.SpaceId,
+    name: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Channel.Channel,
+  }),
+});
+
+export const CreateChannelThread = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create-channel-thread`, name: 'Create Channel Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    channel: Channel.Channel,
+  }),
+  output: Schema.Struct({
+    object: Thread.Thread,
+  }),
+});
+
+export const Create = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create`, name: 'Create Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    name: Schema.optional(Schema.String),
+    anchor: Schema.optional(Schema.String),
+    subject: Obj.Unknown,
+  }),
+  output: Schema.Void,
+});
+
+export const DeleteOutput = Schema.Struct({
+  thread: Thread.Thread.annotations({ description: 'The deleted thread.' }),
+  anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The deleted anchor.' }),
+}).pipe(Schema.partial);
+
+export type DeleteOutput = Schema.Schema.Type<typeof DeleteOutput>;
+
+export const Delete = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.delete`, name: 'Delete Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo,
+    subject: Obj.Unknown,
+    thread: Schema.optional(Thread.Thread),
+  }),
+  output: DeleteOutput,
+});
+
+export const Select = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.select`, name: 'Select Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    current: Schema.String,
+  }),
+  output: Schema.Void,
+});
+
+export const ToggleResolved = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.toggle-resolved`, name: 'Toggle Resolved' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    thread: Thread.Thread,
+  }),
+  output: Schema.Void,
+});
+
+export const AddMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.add-message`, name: 'Add Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    subject: Obj.Unknown,
+    anchor: AnchoredTo.AnchoredTo,
+    sender: Actor.Actor,
+    text: Schema.String,
+  }),
+  output: Schema.Void,
+});
+
+export const DeleteMessageOutput = Schema.partial(
+  Schema.Struct({
+    message: Message.Message.annotations({ description: 'The deleted message.' }),
+    messageIndex: Schema.Number.annotations({ description: 'The index the message was at.' }),
+  }),
+);
+
+export type DeleteMessageOutput = Schema.Schema.Type<typeof DeleteMessageOutput>;
+
+export const DeleteMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.delete-message`, name: 'Delete Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo,
+    subject: Obj.Unknown,
+    messageId: Schema.String,
+  }),
+  output: DeleteMessageOutput,
+});
+
+/**
+ * Restore a deleted thread (inverse of Delete).
+ */
+export const Restore = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.restore`, name: 'Restore Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    thread: Thread.Thread.annotations({ description: 'The thread to restore.' }),
+    anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The anchor relation to restore.' }),
+  }),
+  output: Schema.Void,
+});
+
+/**
+ * Restore a deleted message (inverse of DeleteMessage).
+ */
+export const RestoreMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.restore-message`, name: 'Restore Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The anchor of the thread.' }),
+    message: Message.Message.annotations({ description: 'The message to restore.' }),
+    messageIndex: Schema.Number.annotations({ description: 'The index to restore the message at.' }),
+  }),
+  output: Schema.Void,
+});
+
+export const CreateProposals = Operation.make({
+  meta: {
+    key: 'org.dxos.function.thread.create-proposals',
+    name: 'Create Proposals',
+    description: 'Proposes a set of changes to a document.',
+  },
+  input: 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.',
+    }),
+  }),
+  output: Schema.Void,
+  services: [Database.Service],
+});

package/src/operations/delete-message.ts

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Obj, Relation } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { Thread } from '@dxos/types';
+
+import { Delete, DeleteMessage } from './definitions';
+
+const handler: Operation.WithHandler<typeof DeleteMessage> = DeleteMessage.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, anchor, messageId }) {
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const db = Obj.getDatabase(subject);
+      invariant(db, 'Database not found');
+
+      const msgIndex = thread.messages.findIndex((ref) => ref.target?.id === messageId);
+      const msg = thread.messages[msgIndex]?.target;
+      if (!msg) {
+        return { messageIndex: -1 };
+      }
+
+      if (msgIndex === 0 && thread.messages.length === 1) {
+        // TODO(wittjosiah): This doesn't support restoring the thread.
+        yield* Operation.invoke(Delete, { subject, anchor });
+        return { messageIndex: -1 };
+      }
+
+      Obj.change(thread, (thread) => {
+        thread.messages.splice(msgIndex, 1);
+      });
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.message.delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+          threadLength: thread.messages.length,
+          messageId,
+        },
+      });
+
+      return { message: msg, messageIndex: msgIndex };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/delete.ts

@@ -0,0 +1,63 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { sleep } from '@dxos/async';
+import { Obj, Relation } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { Thread } from '@dxos/types';
+
+import { ThreadCapabilities } from '../types';
+import { Delete } from './definitions';
+
+const handler: Operation.WithHandler<typeof Delete> = Delete.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, anchor, thread: _thread }) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const stateAtom = yield* Capability.get(ThreadCapabilities.State);
+      const thread = _thread ?? (Relation.getSource(anchor) as Thread.Thread);
+      const subjectId = Obj.getDXN(subject).toString();
+      const state = registry.get(stateAtom);
+      const draft = state.drafts[subjectId];
+      if (draft) {
+        const index = draft.findIndex((a: { id: string }) => a.id === anchor.id);
+        if (index !== -1) {
+          registry.set(stateAtom, {
+            ...state,
+            drafts: {
+              ...state.drafts,
+              [subjectId]: state.drafts[subjectId]?.filter((_, i) => i !== index),
+            },
+          });
+          return {};
+        }
+      }
+
+      const db = Obj.getDatabase(thread);
+      if (!db) {
+        return {};
+      }
+
+      // TODO(wittjosiah): Without sleep, rendering crashes at `Relation.setSource(anchor)`.
+      db.remove(anchor);
+      yield* Effect.promise(() => sleep(100));
+      db.remove(thread);
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+        },
+      });
+
+      return { thread, anchor };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/index.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * as ThreadOperation from './definitions';
+
+export const ThreadOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./add-message'),
+  () => import('./create'),
+  () => import('./create-channel'),
+  () => import('./create-channel-thread'),
+  () => import('./create-proposals'),
+  () => import('./delete'),
+  () => import('./delete-message'),
+  () => import('./on-create-space'),
+  () => import('./restore'),
+  () => import('./restore-message'),
+  () => import('./select'),
+  () => import('./toggle-resolved'),
+);

package/src/operations/on-create-space.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/operation';
+
+import { CreateChannel, OnCreateSpace } from './definitions';
+
+const handler: Operation.WithHandler<typeof OnCreateSpace> = OnCreateSpace.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ space, isDefault }) {
+      if (isDefault) {
+        return;
+      }
+
+      const { object: channel } = yield* Operation.invoke(CreateChannel, {
+        name: 'General',
+        spaceId: space.id,
+      });
+      space.db.add(channel);
+    }),
+  ),
+);
+
+export default handler;