@dxos/plugin-assistant 0.8.3 → 0.8.4-main.1f223c7

package/src/hooks/useChatProcessor.ts

@@ -0,0 +1,66 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RegistryContext } from '@effect-rx/rx-react';
+import { type Runtime } from 'effect';
+import { useContext, useMemo } from 'react';
+
+import { AiConversation } from '@dxos/assistant';
+import { type Blueprint } from '@dxos/blueprints';
+import { log } from '@dxos/log';
+import { type Queue } from '@dxos/react-client/echo';
+
+import { AiChatProcessor, type AiChatServices, type AiServicePreset } from '../processor';
+import { type Assistant } from '../types';
+
+export type UseChatProcessorProps = {
+  chat?: Assistant.Chat;
+  preset?: AiServicePreset;
+  services?: () => Promise<Runtime.Runtime<AiChatServices>>;
+  blueprintRegistry?: Blueprint.Registry;
+  settings?: Assistant.Settings;
+};
+
+/**
+ * Configure and create AiChatProcessor.
+ */
+export const useChatProcessor = ({
+  chat,
+  preset,
+  services,
+  blueprintRegistry,
+  settings,
+}: UseChatProcessorProps): AiChatProcessor | undefined => {
+  const observableRegistry = useContext(RegistryContext);
+
+  // Create conversation from chat queue.
+  const conversation = useMemo(() => {
+    if (!chat?.queue.target) {
+      return;
+    }
+
+    return new AiConversation({ queue: chat.queue.target as Queue<any> });
+  }, [chat?.queue.target]);
+
+  // Create processor.
+  const processor = useMemo(() => {
+    if (!services || !conversation) {
+      return undefined;
+    }
+
+    log('creating processor', {
+      preset,
+      model: preset?.model,
+      settings,
+    });
+
+    return new AiChatProcessor(conversation, services, {
+      observableRegistry,
+      blueprintRegistry,
+      model: preset?.model,
+    });
+  }, [services, conversation, blueprintRegistry, preset]);
+
+  return processor;
+};

package/src/hooks/useChatServices.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Effect, type Runtime } from 'effect';
+import { useMemo } from 'react';
+
+import { useCapability } from '@dxos/app-framework';
+import { type Space } from '@dxos/client/echo';
+import { TracingService } from '@dxos/functions';
+import { useClient } from '@dxos/react-client';
+
+import { AssistantCapabilities } from '../capabilities';
+import { type AiChatServices } from '../processor';
+import { type Assistant } from '../types';
+
+export type UseChatServicesProps = {
+  space?: Space;
+  chat?: Assistant.Chat;
+};
+
+/**
+ * Construct service layer.
+ */
+// TODO(dmaretskyi): Better return type.
+export const useChatServices = ({
+  space,
+  chat,
+}: UseChatServicesProps): (() => Promise<Runtime.Runtime<AiChatServices>>) | undefined => {
+  const client = useClient();
+  space ??= client.spaces.default;
+
+  const computeRuntimeResolver = useCapability(AssistantCapabilities.ComputeRuntime);
+
+  return useMemo(() => {
+    const runtime = computeRuntimeResolver.getRuntime(space.id);
+    return () =>
+      runtime.runPromise(
+        Effect.gen(function* () {
+          return yield* Effect.runtime<AiChatServices>().pipe(
+            Effect.provide(
+              chat?.traceQueue?.target ? TracingService.layerQueue(chat.traceQueue?.target) : TracingService.layerNoop,
+            ),
+          );
+        }),
+      );
+  }, [space, chat?.traceQueue?.target]);
+};

package/src/hooks/useComputeRuntimeCallback.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type { Effect } from 'effect';
+import { useCallback } from 'react';
+
+import { useCapability } from '@dxos/app-framework';
+import type { Space } from '@dxos/client/echo';
+
+import { AssistantCapabilities } from '../capabilities';
+
+/**
+ * Create an effectful function that has access to compute services
+ */
+export const useComputeRuntimeCallback = <T>(
+  space: Space,
+  fn: () => Effect.Effect<T, any, AssistantCapabilities.ComputeServices>,
+  deps?: React.DependencyList,
+): (() => Promise<T>) => {
+  const computeRuntime = useCapability(AssistantCapabilities.ComputeRuntime);
+  const runtime = computeRuntime.getRuntime(space.id);
+
+  return useCallback(() => runtime.runPromise(fn()), [runtime, ...(deps ?? [])]);
+};

package/src/hooks/useContextBinder.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { AiContextBinder } from '@dxos/assistant';
+
+import { type Assistant } from '../types';
+
+export const useContextBinder = (chat: Assistant.Chat | undefined): AiContextBinder | undefined => {
+  const binder = useMemo(() => {
+    const queue = chat?.queue.target;
+    return queue && new AiContextBinder(queue);
+  }, [chat]);
+
+  return binder;
+};

package/src/hooks/useContextObjects.ts

@@ -0,0 +1,58 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback } from 'react';
+
+import { type AiContextBinder } from '@dxos/assistant';
+import { type DXN, type Obj, Ref } from '@dxos/echo';
+import { log } from '@dxos/log';
+import { type Space } from '@dxos/react-client/echo';
+import { isNonNullable } from '@dxos/util';
+
+export type UseContextObjects = {
+  objects: Obj.Any[];
+  onUpdateObject: (dxn: DXN, checked: boolean) => Promise<void>;
+};
+
+/**
+ * Create reactive map of active object references (by DXN string).
+ */
+export const useContextObjects = ({
+  space,
+  context,
+}: {
+  space?: Space;
+  context?: AiContextBinder;
+}): UseContextObjects => {
+  const objects = context?.objects.value.map((ref) => ref.target).filter(isNonNullable) ?? [];
+
+  const handleUpdateObject = useCallback<UseContextObjects['onUpdateObject']>(
+    async (dxn: DXN, checked: boolean) => {
+      if (!space || !context) {
+        return;
+      }
+
+      // Load the object by DXN/id from the current space.
+      const id = dxn.asEchoDXN();
+      const object = id && (await space.db.getObjectById(id.echoId));
+      if (!object) {
+        log.warn('Object not found', { dxn, id });
+        return;
+      }
+
+      const ref = Ref.fromDXN(dxn);
+      if (checked) {
+        await context.bind({ objects: [ref] });
+      } else {
+        await context.unbind({ objects: [ref] });
+      }
+    },
+    [space, context],
+  );
+
+  return {
+    objects,
+    onUpdateObject: handleUpdateObject,
+  };
+};

package/src/hooks/useExecutionGraph.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { type Queue } from '@dxos/client/echo';
+import { Obj } from '@dxos/echo';
+import { useQueue } from '@dxos/react-client/echo';
+
+import { ExecutionGraph } from '../execution-graph';
+
+export const useExecutionGraph = (queueRef?: Queue, lastRequest = false) => {
+  const queue = useQueue(queueRef?.dxn);
+  return useMemo(() => {
+    const graph = new ExecutionGraph();
+    graph.addEvents(queue?.objects.filter(Obj.isObject) ?? []);
+    return graph.getGraph(lastRequest);
+  }, [queue?.objects, lastRequest]);
+};

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/useItemTypes.ts

@@ -0,0 +1,37 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Option } from 'effect';
+import { useEffect, useState } from 'react';
+
+import { type Type } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+import { ItemAnnotation } from '@dxos/schema';
+
+// TODO(burdon): Pass in filter.
+export const useItemTypes = (space?: Space): Type.Obj.Any[] => {
+  const [types, setTypes] = useState<Type.Obj.Any[]>([]);
+  useEffect(() => {
+    if (!space) {
+      return;
+    }
+
+    return space.db.schemaRegistry.query().subscribe(
+      (query) => {
+        const types = Array.from(
+          new Set(
+            [...space.db.graph.schemaRegistry.schemas, ...query.results].filter((type) =>
+              Option.isSome(ItemAnnotation.get(type)),
+            ),
+          ),
+        );
+
+        setTypes(types);
+      },
+      { fire: true },
+    );
+  }, [space]);
+
+  return types;
+};

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/{useContextProvider.ts → useReferencesProvider.ts}

@@ -6,29 +6,29 @@ 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';
 
-export type ContextProvider = {
-  query: (params: { query: string }) => Promise<Array<{ uri: string; label: string }>>;
-  resolveMetadata: (params: { uri: string }) => Promise<{ uri: string; label: string }>;
-};
-
-const stringMatch = (query: string, label: string) => label.toLowerCase().startsWith(query.toLowerCase());
-
-export const useContextProvider = (space?: Space): ContextProvider | undefined => {
-  const artifactDefinitions = useCapabilities(Capabilities.ArtifactDefinition);
+/**
+ * Resolve references to objects in the space.
+ */
+export const useReferencesProvider = (space?: Space): ReferencesProvider | undefined => {
+  const blueprints = useCapabilities(Capabilities.BlueprintDefinition);
 
-  return useMemo<ContextProvider | undefined>((): ContextProvider | undefined => {
+  return useMemo<ReferencesProvider | undefined>((): ReferencesProvider | undefined => {
     if (!space) {
       return undefined;
     }
 
     return {
-      query: async ({ query }) => {
-        const artifactSchemas = artifactDefinitions.map((artifact) => artifact.schema);
-        const { objects } = await space.db
-          .query(Filter.or(...artifactSchemas.map((schema) => Filter.type(schema as Type.Schema))))
-          .run();
+      getReferences: async ({ query }) => {
+        // 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
@@ -41,15 +41,17 @@ export const useContextProvider = (space?: Space): ContextProvider | undefined =
             // 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))
             .map((object) => ({
-              uri: Obj.getDXN(object as any)!.toString(),
+              uri: Obj.getDXN(object as any).toString(),
               label: Obj.getLabel(object as any) ?? '',
             }))
         );
       },
-      resolveMetadata: async ({ uri }) => {
+      resolveReference: async ({ uri }) => {
         const object = await space.db.query(Filter.ids(uri)).first();
         return { uri, label: Obj.getLabel(object) ?? '' };
       },
-    };
-  }, [space, artifactDefinitions]);
+    } satisfies ReferencesProvider;
+  }, [space, blueprints]);
 };
+
+const stringMatch = (query: string, label: string) => label.toLowerCase().startsWith(query.toLowerCase());

package/src/meta.ts

@@ -11,7 +11,7 @@ export const ASSISTANT_DIALOG = `${ASSISTANT_PLUGIN}/assistant/dialog`;
 export const meta: PluginMeta = {
   id: ASSISTANT_PLUGIN,
   name: 'Assistant',
-  description: 'The Assistant tab allows you to chat with your spaces inside of Composer.',
+  description: 'The Assistant plugin allows you to chat with your spaces inside of Composer.',
   icon: 'ph--atom--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-assistant',
   tags: ['labs'],

package/src/processor/index.ts

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

package/src/processor/presets.ts

@@ -0,0 +1,60 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Schema } from 'effect';
+
+import { type ModelName } from '@dxos/ai';
+
+const ModelProviders = ['dxos-local', 'dxos-remote', 'lm-studio'] as const;
+
+const ModelProvider = Schema.Literal(...ModelProviders);
+type ModelProvider = Schema.Schema.Type<typeof ModelProvider>;
+
+export type AiServicePreset = {
+  id: string;
+  provider: ModelProvider;
+  model: ModelName;
+  label?: string;
+};
+
+const createModelLabel = (model: ModelName) => {
+  const parts = model.split('/');
+  return parts[parts.length - 1];
+};
+
+// TODO(burdon): Users should be able to create and edit presets.
+export const AiServicePresets: AiServicePreset[] = [
+  {
+    provider: 'dxos-remote' as const,
+    model: '@anthropic/claude-opus-4-0' as const,
+  },
+  {
+    provider: 'dxos-remote' 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-27b' as const,
+  },
+  {
+    provider: 'lm-studio' as const,
+    model: '@mlx-community/llama-3.2-3b-instruct' as const,
+  },
+  {
+    model: 'deepseek-r1:latest' as const,
+    provider: 'dxos-local' as const,
+  },
+].map(
+  ({ model, provider }, i) =>
+    ({
+      id: `preset-${i}`,
+      provider,
+      model,
+      label: createModelLabel(model),
+    }) satisfies AiServicePreset,
+);

package/src/processor/processor.test.ts

@@ -0,0 +1,77 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { AiTool, AiToolkit } from '@effect/ai';
+import { describe, it } from '@effect/vitest';
+import { Effect, Layer, Schema } from 'effect';
+
+import { AiService } from '@dxos/ai';
+import { AiServiceTestingPreset } from '@dxos/ai/testing';
+import { AiConversation, makeToolExecutionServiceFromFunctions, makeToolResolverFromFunctions } from '@dxos/assistant';
+import { TestHelpers } from '@dxos/effect';
+import {
+  ComputeEventLogger,
+  CredentialsService,
+  LocalFunctionExecutionService,
+  QueueService,
+  RemoteFunctionExecutionService,
+  TracingService,
+} from '@dxos/functions';
+import { TestDatabaseLayer } from '@dxos/functions/testing';
+import { type DataType } from '@dxos/schema';
+
+import { AiChatProcessor, type AiChatServices } from './processor';
+
+class TestToolkit extends AiToolkit.make(
+  AiTool.make('random', {
+    description: 'Random number generator',
+    parameters: {},
+    success: Schema.Number,
+  }),
+) {}
+
+// TODO(burdon): Create minimal toolkit.
+const toolkit = AiToolkit.merge(TestToolkit) as AiToolkit.Any as AiToolkit.AiToolkit<AiTool.Any>;
+
+// 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 }]),
+  LocalFunctionExecutionService.layer,
+  RemoteFunctionExecutionService.mockLayer,
+);
+
+const TestLayer: Layer.Layer<AiChatServices, never, never> = Layer.mergeAll(
+  AiService.model('@anthropic/claude-opus-4-0'),
+  makeToolResolverFromFunctions([], toolkit),
+  makeToolExecutionServiceFromFunctions([], toolkit, toolkit.toLayer({}) as any),
+  CredentialsService.layerFromDatabase(),
+  ComputeEventLogger.layerFromTracing,
+).pipe(Layer.provideMerge(TestServicesLayer), Layer.orDie);
+
+// TODO(burdon): Create actual test with mock LLM.
+describe('Chat processor', () => {
+  it.effect(
+    'basic',
+    Effect.fn(
+      function* ({ expect }) {
+        const services = yield* Effect.runtime<AiChatServices>();
+        const queue = yield* QueueService.createQueue<DataType.Message>();
+        const conversation = 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'),
+    ),
+  );
+});