@dxos/plugin-assistant 0.8.4-main.67995b8 → 0.8.4-main.6fa680abb7

package/src/hooks/useChatToolbarActions.ts

@@ -0,0 +1,122 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+import { useMemo } from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { Chat } from '@dxos/assistant-toolkit';
+import { Filter, Obj, Query } from '@dxos/echo';
+import { runAndForwardErrors } from '@dxos/effect';
+import { invariant } from '@dxos/invariant';
+import { useQuery } from '@dxos/react-client/echo';
+import { MenuBuilder, useMenuActions } from '@dxos/react-ui-menu';
+
+import { useChatContext } from '../components';
+import { meta } from '../meta';
+import { AssistantOperation } from '../types';
+
+export type ChatToolbarActionsProps = {
+  chat?: Chat.Chat;
+  companionTo?: Obj.Unknown;
+};
+
+export const useChatToolbarActions = ({ chat, companionTo }: ChatToolbarActionsProps) => {
+  const { invoke } = useOperationInvoker();
+  const { db } = useChatContext('useChatToolbarActions');
+  const query = companionTo
+    ? Query.select(Filter.id(companionTo.id)).targetOf(Chat.CompanionTo).source()
+    : Query.select(Filter.nothing());
+
+  // TODO(wittjosiah): Query in react vs query in atom?
+  const chats = useQuery(db, query);
+
+  // Create stable reference for dependency array to avoid circular reference issues.
+  return useMenuActions(
+    useMemo(() => {
+      return Atom.make(() => {
+        const builder = MenuBuilder.make()
+          .root({
+            label: ['chat toolbar title', { ns: meta.id }],
+          })
+          .action(
+            'new',
+            {
+              label: ['new thread button', { ns: meta.id }],
+              icon: 'ph--plus--regular',
+              type: 'new',
+              disabled: !companionTo,
+            },
+            () => {
+              invariant(companionTo);
+              return invoke(AssistantOperation.SetCurrentChat, {
+                companionTo,
+                chat: undefined,
+              }).pipe(runAndForwardErrors);
+            },
+          )
+          .action(
+            'rename',
+            {
+              label: ['rename thread button', { ns: meta.id }],
+              icon: 'ph--magic-wand--regular',
+              type: 'rename',
+              disabled: !chat,
+            },
+            () =>
+              Effect.gen(function* () {
+                invariant(chat);
+                yield* invoke(AssistantOperation.UpdateChatName, { chat });
+              }).pipe(runAndForwardErrors),
+          )
+          .action(
+            'branch',
+            {
+              label: ['button branch thread', { ns: meta.id }],
+              icon: 'ph--git-branch--regular',
+              type: 'branch',
+              disabled: true,
+            },
+            () => {},
+          );
+
+        if (chats.length > 0) {
+          builder.group(
+            'chats',
+            {
+              label: ['chat history label', { ns: meta.id }],
+              icon: 'ph--clock-counter-clockwise--regular',
+              selectCardinality: 'single',
+              variant: 'dropdownMenu',
+            },
+            (builder) => {
+              chats
+                // TODO(wittjosiah): This should be the default sort order.
+                .toSorted((a, b) => a.id.localeCompare(b.id))
+                .forEach((chat) => {
+                  builder.action(
+                    chat.id,
+                    {
+                      label: Obj.getLabel(chat) ?? ['object name placeholder', { ns: Chat.Chat.typename }],
+                    },
+                    () =>
+                      Effect.gen(function* () {
+                        invariant(companionTo);
+                        yield* invoke(AssistantOperation.SetCurrentChat, {
+                          companionTo,
+                          chat,
+                        });
+                      }).pipe(runAndForwardErrors),
+                  );
+                });
+            },
+          );
+        }
+
+        return builder.build();
+      });
+    }, [chats.length, db?.spaceId, companionTo?.id, chat?.id, invoke]),
+  );
+};

package/src/hooks/useContextBinder.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Registry, RegistryContext } from '@effect-atom/atom-react';
+import { useContext, useState } from 'react';
+
+import { AiContextBinder } from '@dxos/assistant';
+import { type Queue } from '@dxos/react-client/echo';
+import { useAsyncEffect } from '@dxos/react-ui';
+
+// NOTE: This takes a queue rather than a chat because the chat may not be in a space yet.
+export const useContextBinder = (queue: Queue | undefined): AiContextBinder | undefined => {
+  const registry = useContext(RegistryContext) as Registry.Registry;
+  const [binder, setBinder] = useState<AiContextBinder>();
+
+  useAsyncEffect(async () => {
+    if (!queue) {
+      return;
+    }
+
+    const binder = new AiContextBinder({ queue, registry });
+    await binder.open();
+    setBinder(binder);
+
+    return () => {
+      void binder.close();
+    };
+  }, [queue]);
+
+  return binder;
+};

package/src/hooks/useContextObjects.ts

@@ -0,0 +1,46 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback } from 'react';
+
+import { type AiContextBinder } from '@dxos/assistant';
+import { type DXN, type Database, type Obj, Ref } from '@dxos/echo';
+
+export type UseContextObjectsProps = {
+  db?: Database.Database;
+  context?: AiContextBinder;
+};
+
+export type UseContextObjects = {
+  objects: Obj.Unknown[];
+  onUpdateObject: (dxn: DXN, checked: boolean) => Promise<void>;
+};
+
+/**
+ * Create reactive map of active object references (by DXN string).
+ */
+export const useContextObjects = ({ db, context }: UseContextObjectsProps): UseContextObjects => {
+  const handleUpdateObject = useCallback<UseContextObjects['onUpdateObject']>(
+    async (dxn: DXN, checked: boolean) => {
+      if (!db || !context) {
+        return;
+      }
+
+      // Load the object by DXN from the current space.
+      const ref = Ref.fromDXN(dxn);
+      await ref.load();
+      if (checked) {
+        await context.bind({ objects: [ref] });
+      } else {
+        await context.unbind({ objects: [ref] });
+      }
+    },
+    [db, context],
+  );
+
+  return {
+    objects: context?.getObjects() ?? [],
+    onUpdateObject: handleUpdateObject,
+  };
+};

package/src/hooks/useFilteredTypes.ts

@@ -0,0 +1,37 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Option from 'effect/Option';
+import { useEffect, useState } from 'react';
+
+import { type Database, type Type } from '@dxos/echo';
+import { EntityKind, SystemTypeAnnotation, getTypeAnnotation } from '@dxos/echo/internal';
+
+// TODO(burdon): Pass in filter.
+// TODO(wittjosiah): Factor out.
+export const useFilteredTypes = (db?: Database.Database): Type.AnyEntity[] => {
+  const [types, setTypes] = useState<Type.AnyEntity[]>([]);
+  useEffect(() => {
+    if (!db) {
+      return;
+    }
+
+    return db.schemaRegistry.query({ location: ['database', 'runtime'] }).subscribe(
+      (query) => {
+        const types = Array.from(
+          new Set(
+            query.results
+              .filter((schema) => getTypeAnnotation(schema)?.kind !== EntityKind.Relation)
+              .filter((schema) => SystemTypeAnnotation.get(schema).pipe(Option.getOrElse(() => false))),
+          ),
+        );
+
+        setTypes(types);
+      },
+      { fire: true },
+    );
+  }, [db]);
+
+  return types;
+};

package/src/hooks/useFlush.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback, useRef, useState } from 'react';
+
+import { type Space } from '@dxos/client/echo';
+
+export const useFlush = (space?: Space) => {
+  const [state, setState] = useState<'idle' | 'flushing' | 'flushed'>('idle');
+  const resetTimer = useRef<NodeJS.Timeout | null>(null);
+
+  const handleFlush = useCallback(() => {
+    if (!space) {
+      return;
+    }
+
+    queueMicrotask(async () => {
+      if (resetTimer.current) {
+        clearTimeout(resetTimer.current);
+      }
+
+      setState('flushing');
+      await space.db.flush();
+      setState('flushed');
+
+      resetTimer.current = setTimeout(() => {
+        setState('idle');
+        resetTimer.current = null;
+      }, 1_000);
+    });
+  }, [space]);
+
+  return { state, handleFlush };
+};

package/src/hooks/useOnline.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Dispatch, type SetStateAction, useState } from 'react';
+
+export const useOnline = (): [boolean, Dispatch<SetStateAction<boolean>>] => {
+  const [online, setOnline] = useState(true);
+  return [online, setOnline];
+};

package/src/hooks/usePresets.ts

@@ -0,0 +1,44 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback, useEffect, useMemo, useState } from 'react';
+
+import { type ChatPromptProps } from '../components';
+import { type AiServicePreset, AiServicePresets } from '../processor';
+
+export type UsePresets = {
+  preset: AiServicePreset | undefined;
+} & Pick<ChatPromptProps, 'presets' | 'onPresetChange'>;
+
+export const usePresets = (online: boolean): UsePresets => {
+  // TODO(burdon): Memo preset for provider.
+  const [preset, setPreset] = useState<AiServicePreset>();
+  const presets = useMemo(
+    () => AiServicePresets.filter((preset) => online === (preset.provider === 'dxos-remote')),
+    [online],
+  );
+  const presetOptions = useMemo(
+    () => presets.map(({ id, model, label }) => ({ id, label: label ?? model })),
+    [presets],
+  );
+  useEffect(() => {
+    setPreset(presets[0]);
+  }, [presets]);
+
+  const handlePresetChange = useCallback<NonNullable<ChatPromptProps['onPresetChange']>>(
+    (id) => {
+      const preset = presets.find((preset) => preset.id === id);
+      if (preset) {
+        setPreset(preset);
+      }
+    },
+    [presets],
+  );
+
+  return {
+    preset: preset,
+    presets: presetOptions,
+    onPresetChange: handlePresetChange,
+  };
+};

package/src/hooks/useReferencesProvider.ts

@@ -4,18 +4,14 @@
 
 import { useMemo } from 'react';
 
-import { Capabilities, useCapabilities } from '@dxos/app-framework';
 import { type Space } from '@dxos/client/echo';
-import { Filter, Obj, type Type } from '@dxos/echo';
+import { Filter, Obj } from '@dxos/echo';
 import { type ReferencesProvider } from '@dxos/react-ui-chat';
 
 /**
  * Resolve references to objects in the space.
  */
 export const useReferencesProvider = (space?: Space): ReferencesProvider | undefined => {
-  // TODO(burdon): Pass in.
-  const artifactDefinitions = useCapabilities(Capabilities.ArtifactDefinition);
-
   return useMemo<ReferencesProvider | undefined>((): ReferencesProvider | undefined => {
     if (!space) {
       return undefined;
@@ -23,10 +19,13 @@ export const useReferencesProvider = (space?: Space): ReferencesProvider | undef
 
     return {
       getReferences: async ({ query }) => {
-        const schemas = artifactDefinitions.map((artifact) => artifact.schema);
-        const { objects } = await space.db
-          .query(Filter.or(...schemas.map((schema) => Filter.type(schema as Type.Schema))))
-          .run();
+        // TODO(burdon): Previously we filtered by types declared by the artifact definitions.
+        // const schemas = blueprints.map((blueprint) => blueprint.schema).flat();
+        // const objects = await space.db
+        //   .query(Filter.or(...schemas.map((schema) => Filter.type(schema as Type.Schema))))
+        //   .run();
+
+        const objects = await space.db.query(Filter.everything()).run();
 
         return (
           objects
@@ -37,19 +36,19 @@ export const useReferencesProvider = (space?: Space): ReferencesProvider | undef
             // })
             .filter((object) => stringMatch(query, Obj.getLabel(object as any) ?? ''))
             // TODO(dmaretskyi): `Type.getDXN` (at the point of writing) didn't work here as it was schema-only.
-            .filter((object) => !!Obj.getDXN(object as Obj.Any))
+            .filter((object) => !!Obj.getDXN(object as Obj.Unknown))
             .map((object) => ({
-              uri: Obj.getDXN(object as any)!.toString(),
+              uri: Obj.getDXN(object as any).toString(),
               label: Obj.getLabel(object as any) ?? '',
             }))
         );
       },
       resolveReference: async ({ uri }) => {
-        const object = await space.db.query(Filter.ids(uri)).first();
+        const object = await space.db.query(Filter.id(uri)).first();
         return { uri, label: Obj.getLabel(object) ?? '' };
       },
     } satisfies ReferencesProvider;
-  }, [space, artifactDefinitions]);
+  }, [space]);
 };
 
 const stringMatch = (query: string, label: string) => label.toLowerCase().startsWith(query.toLowerCase());

package/src/index.ts

@@ -2,10 +2,12 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './blueprints';
 export * from './capabilities';
 export * from './components';
-export * from './events';
+export * from './hooks';
 export * from './meta';
+export * from './translations';
 export * from './types';
 
 export * from './AssistantPlugin';

package/src/meta.ts

@@ -2,17 +2,20 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const ASSISTANT_PLUGIN = 'dxos.org/plugin/assistant';
-
-export const ASSISTANT_DIALOG = `${ASSISTANT_PLUGIN}/assistant/dialog`;
-
-export const meta: PluginMeta = {
-  id: ASSISTANT_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.assistant',
   name: 'Assistant',
-  description: 'The Assistant tab allows you to chat with your spaces inside of Composer.',
+  description: trim`
+    Intelligent AI assistant that can analyze and interact with objects across your spaces.
+    Chat naturally to get insights, search content, and perform actions using AI-powered context awareness.
+  `,
   icon: 'ph--atom--regular',
+  iconHue: 'sky',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-assistant',
   tags: ['labs'],
 };
+
+export const ASSISTANT_DIALOG = `${meta.id}.assistant.dialog`;

package/src/processor/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './presets';
+export * from './processor';
+export * from './update-name';

package/src/{hooks → processor}/presets.ts

@@ -2,9 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-import { type LLMModel } from '@dxos/ai';
+import { type ModelName } from '@dxos/ai';
 
 const ModelProviders = ['dxos-local', 'dxos-remote', 'lm-studio'] as const;
 
@@ -14,11 +14,11 @@ type ModelProvider = Schema.Schema.Type<typeof ModelProvider>;
 export type AiServicePreset = {
   id: string;
   provider: ModelProvider;
-  model: LLMModel;
+  model: ModelName;
   label?: string;
 };
 
-const createModelLabel = (model: LLMModel) => {
+const createModelLabel = (model: ModelName) => {
   const parts = model.split('/');
   return parts[parts.length - 1];
 };
@@ -27,19 +27,27 @@ const createModelLabel = (model: LLMModel) => {
 export const AiServicePresets: AiServicePreset[] = [
   {
     provider: 'dxos-remote' as const,
-    model: '@anthropic/claude-3-5-haiku-20241022' as const,
+    model: '@anthropic/claude-opus-4-0' as const,
   },
   {
     provider: 'dxos-remote' as const,
-    model: '@anthropic/claude-opus-4-0' as const,
+    model: '@anthropic/claude-sonnet-4-0' as const,
+  },
+  {
+    provider: 'dxos-remote' as const,
+    model: '@anthropic/claude-3-5-haiku-20241022' as const,
   },
   {
     provider: 'lm-studio' as const,
-    model: '@google/gemma-3-12b' as const,
+    model: '@google/gemma-3-27b' as const,
   },
   {
     provider: 'lm-studio' as const,
-    model: '@mlx-community/llama-3.2-3b-instruct' as const,
+    model: '@meta/llama-3.2-3b-instruct' as const,
+  },
+  {
+    model: 'deepseek-r1:latest' as const,
+    provider: 'dxos-local' as const,
   },
 ].map(
   ({ model, provider }, i) =>

package/src/processor/processor.test.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Tool from '@effect/ai/Tool';
+import * as Toolkit from '@effect/ai/Toolkit';
+import { describe, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Schema from 'effect/Schema';
+
+import { AiService } from '@dxos/ai';
+import { GenericToolkit } from '@dxos/ai';
+import { AiServiceTestingPreset } from '@dxos/ai/testing';
+import { AiConversation, ToolExecutionServices } from '@dxos/assistant';
+import { acquireReleaseResource } from '@dxos/effect';
+import { TestHelpers } from '@dxos/effect/testing';
+import { CredentialsService, QueueService, TracingService } from '@dxos/functions';
+import { FunctionInvocationServiceLayerTestMocked, TestDatabaseLayer } from '@dxos/functions-runtime/testing';
+import { type Message } from '@dxos/types';
+
+import { AiChatProcessor, type AiChatServices } from './processor';
+
+const TestToolkit = Toolkit.make(
+  Tool.make('random', {
+    description: 'Random number generator',
+    parameters: {},
+    success: Schema.Number,
+  }),
+);
+
+// TODO(burdon): Explain structure.
+const TestServicesLayer = Layer.mergeAll(
+  TracingService.layerNoop,
+  AiServiceTestingPreset('direct'),
+  TestDatabaseLayer({
+    // indexing: { vector: true },
+    // types: [],
+  }),
+  // CredentialsService.configuredLayer([{ service: 'exa.ai', apiKey: EXA_API_KEY }]),
+  FunctionInvocationServiceLayerTestMocked({ functions: [] }).pipe(Layer.provideMerge(TracingService.layerNoop)),
+);
+
+const TestLayer: Layer.Layer<AiChatServices, never, never> = Layer.mergeAll(
+  AiService.model('@anthropic/claude-opus-4-0'),
+  ToolExecutionServices,
+  CredentialsService.layerFromDatabase(),
+).pipe(
+  Layer.provideMerge(GenericToolkit.providerLayer(GenericToolkit.make(TestToolkit, TestToolkit.toLayer({} as any)))),
+  Layer.provideMerge(TestServicesLayer),
+  Layer.orDie,
+);
+
+// TODO(burdon): Create actual test with mock LLM.
+describe('Chat processor', () => {
+  it.scoped(
+    'basic',
+    Effect.fn(
+      function* ({ expect }) {
+        const services = yield* Effect.runtime<AiChatServices>();
+        const queue = yield* QueueService.createQueue<Message.Message>();
+        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue }));
+        const processor = new AiChatProcessor(conversation, async () => services);
+        const result = yield* Effect.promise(() => processor.request({ message: 'Hello' }));
+        void processor.cancel();
+        expect(processor.active).to.be.false;
+        expect(result).to.exist;
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.taggedTest('llm'),
+    ),
+  );
+});