@dxos/plugin-thread 0.8.3 → 0.8.4-main.1068cf700f

package/src/components/testing.ts

@@ -6,24 +6,44 @@ 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 { Message, Thread } from '@dxos/types';
 
-import { ThreadType } from '../types';
-
-export const createCommentThread = (identity: Identity): ThreadType => {
-  return Obj.make(ThreadType, {
+export const createCommentThread = (identity: Identity): Thread.Thread => {
+  return Thread.make({
+    name: 'Comment',
     messages: faker.helpers.multiple(
       () =>
         Ref.make(
-          Obj.make(DataType.Message, {
+          Obj.make(Message.Message, {
+            created: new Date().toISOString(),
             sender: {
               identityDid: faker.datatype.boolean() ? identity.did : IdentityDid.random(),
             },
-            created: new Date().toISOString(),
-            blocks: [{ type: 'text', text: faker.lorem.sentences(3) }],
+            blocks: [{ _tag: 'text', text: faker.lorem.sentences(3) }],
           }),
         ),
       { count: { min: 2, max: 3 } },
     ),
+    status: 'active',
+  });
+};
+
+export const createProposalThread = (identity: Identity): Thread.Thread => {
+  return Thread.make({
+    name: 'Proposal',
+    messages: faker.helpers.multiple(
+      () =>
+        Ref.make(
+          Obj.make(Message.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/extensions/threads.ts

@@ -4,65 +4,77 @@
 
 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 { type 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, 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.change(thread, (t) => {
+                t.name = name;
+              });
             }
           }
         });
@@ -70,55 +82,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.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, Type } 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: Type.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,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { default as createProposals } from './create-proposals';

package/src/hooks/analytics.ts

@@ -4,37 +4,37 @@
 
 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;
+    }
+    const db = Obj.getDatabase(message);
+    if (!db) {
       return;
     }
 
-    void dispatch(
-      createIntent(ObservabilityAction.SendEvent, {
-        name: 'threads.message.update',
-        properties: {
-          spaceId: space.id,
-          messageId: message.id,
-          messageLength: textBlock?.text.length,
-        },
-      }),
-    );
-  }, [dispatch, message, textBlock]);
+    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,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: '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',
 };
+
+export const THREAD_ITEM = `${meta.id}/item`;

package/src/testing/stories.ts

@@ -2,33 +2,39 @@
 // Copyright 2023 DXOS.org
 //
 
-import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
+import * as Effect from 'effect/Effect';
+
+import { OperationPlugin, type Plugin } from '@dxos/app-framework';
 import { ClientPlugin } from '@dxos/plugin-client';
 import { GraphPlugin } from '@dxos/plugin-graph';
+import { SettingsPlugin } from '@dxos/plugin-settings';
 import { SpacePlugin } from '@dxos/plugin-space';
 import { ThemePlugin } from '@dxos/plugin-theme';
 import { Config } from '@dxos/react-client';
-import { Ref } from '@dxos/react-client/echo';
-import { defaultTx } from '@dxos/react-ui-theme';
+import { defaultTx } from '@dxos/ui-theme';
 
 import { ThreadPlugin } from '../ThreadPlugin';
-import { ChannelType, ThreadType } from '../types';
+import { Channel } from '../types';
 
-export const createThreadPlugins = async () => [
+export const createThreadPlugins = async (): Promise<Array<Plugin.Plugin>> => [
   ThemePlugin({ tx: defaultTx }),
   ClientPlugin({
-    onClientInitialized: async (_, client) => {
-      await client.halo.createIdentity({ displayName: 'Test User' });
-    },
-    onSpacesReady: async (_, client) => {
-      await client.spaces.default.waitUntilReady();
-      const thread = Obj.make(ThreadType, { messages: [] });
-      client.spaces.default.db.add(Obj.make(ChannelType, { defaultThread: Ref.make(thread), threads: [] }));
-    },
+    onClientInitialized: ({ client }) =>
+      Effect.gen(function* () {
+        yield* Effect.promise(() => client.halo.createIdentity({ displayName: 'Test User' }));
+      }),
+    onSpacesReady: ({ client }) =>
+      Effect.gen(function* () {
+        yield* Effect.promise(() => client.spaces.default.waitUntilReady());
+        client.spaces.default.db.add(Channel.make());
+      }),
     config: new Config({
       runtime: {
-        client: { edgeFeatures: { signaling: true } },
+        client: {
+          edgeFeatures: {
+            signaling: true,
+          },
+        },
         services: {
           edge: {
             url: 'https://edge.dxos.workers.dev/',
@@ -42,8 +48,8 @@ export const createThreadPlugins = async () => [
       },
     }),
   }),
-  SpacePlugin(),
-  IntentPlugin(),
+  SpacePlugin({}),
+  OperationPlugin(),
   SettingsPlugin(),
   GraphPlugin(),
   ThreadPlugin(),