@dxos/plugin-assistant 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

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: 'dxos.org/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'),
+    ),
+  );
+});

package/src/processor/processor.ts

@@ -0,0 +1,296 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type * as Tool from '@effect/ai/Tool';
+import { Atom, Registry } from '@effect-atom/atom-react';
+import * as Cause from 'effect/Cause';
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+import * as Fiber from 'effect/Fiber';
+import * as Option from 'effect/Option';
+import * as Runtime from 'effect/Runtime';
+
+import {
+  AiService,
+  DEFAULT_EDGE_MODEL,
+  type ModelName,
+  type ModelRegistry,
+  type ToolExecutionService,
+  type ToolResolverService,
+} from '@dxos/ai';
+import {
+  AiContextService,
+  type AiConversation,
+  type AiConversationRunProps,
+  ArtifactDiffResolver,
+  GenerationObserver,
+  createSystemPrompt,
+} from '@dxos/assistant';
+import { formatSystemPrompt } from '@dxos/assistant';
+import { type Chat } from '@dxos/assistant-toolkit';
+import { type Blueprint } from '@dxos/blueprints';
+import { Obj } from '@dxos/echo';
+import { type Database } from '@dxos/echo';
+import { runAndForwardErrors, throwCause, unwrapExit } from '@dxos/effect';
+import {
+  type CredentialsService,
+  type FunctionInvocationService,
+  type QueueService,
+  type TracingService,
+} from '@dxos/functions';
+import { log } from '@dxos/log';
+import { type ContentBlock, Message } from '@dxos/types';
+
+import { updateName } from './update-name';
+
+export type AiChatServices =
+  | CredentialsService
+  | Database.Service
+  | QueueService
+  | FunctionInvocationService
+  | AiService.AiService
+  | ToolExecutionService
+  | ToolResolverService
+  | TracingService;
+
+export type AiChatProcessorOptions = {
+  model?: ModelName;
+  modelRegistry?: ModelRegistry;
+  blueprintRegistry?: Blueprint.Registry;
+  observableRegistry?: Registry.Registry;
+  extensions?: ToolContextExtensions;
+} & Pick<AiConversationRunProps, 'system'>;
+
+const defaultOptions: Partial<AiChatProcessorOptions> = {
+  model: DEFAULT_EDGE_MODEL,
+};
+
+// TODO(burdon): Retry, timeout?
+export type AiRequestOptions = {};
+
+export type AiRequest = {
+  message: string;
+  options?: AiRequestOptions;
+};
+
+/**
+ * Handles interactions with the AI service.
+ * Handles streaming responses from the conversation.
+ */
+export class AiChatProcessor {
+  private readonly _registry: Registry.Registry;
+
+  /** External observer. */
+  private readonly _observer: GenerationObserver;
+
+  /** Pending messages (incl. the current user request). */
+  private readonly _pending = Atom.make<Message.Message[]>([]);
+
+  /** Currently streaming message (from the AI service). */
+  private readonly _streaming = Atom.make<Message.Message[]>([]);
+
+  /** Currently active request fiber. */
+  private _fiber: Fiber.Fiber<void, any> | undefined;
+
+  /** Last request (for retries). */
+  private _lastRequest: AiRequest | undefined;
+
+  /** Streaming state. */
+  public readonly streaming = Atom.make<boolean>((get) => get(this._streaming).length > 0);
+
+  /** Active state. */
+  public readonly active = Atom.make(false);
+
+  /** Array of Messages (incl. the current message being streamed). */
+  public readonly messages = Atom.make<Message.Message[]>((get) => [...get(this._pending), ...get(this._streaming)]);
+
+  /** Last error. */
+  public readonly error = Atom.make<Option.Option<Error>>(Option.none());
+
+  constructor(
+    private readonly _conversation: AiConversation,
+    // TODO(dmaretskyi): Replace this with effect's ManagedRuntime wrapping this layer.
+    private readonly _services: () => Promise<Runtime.Runtime<AiChatServices>>,
+    private readonly _options: AiChatProcessorOptions = defaultOptions,
+  ) {
+    // Initialize registries and defaults before using in other logic.
+    this._registry = this._options.observableRegistry ?? Registry.make();
+    this._observer = GenerationObserver.make({
+      onBlock: this._onBlock,
+      onMessage: this._onMessage,
+    });
+    if (this._options.model && !this._options.system) {
+      const capabilities = this._options.modelRegistry?.getCapabilities(this._options.model) ?? {};
+      this._options.system = createSystemPrompt(capabilities);
+    }
+  }
+
+  get context() {
+    return this._conversation.context;
+  }
+
+  get conversation() {
+    return this._conversation;
+  }
+
+  get blueprintRegistry() {
+    return this._options.blueprintRegistry;
+  }
+
+  get system(): string {
+    return this._options.system ?? '';
+  }
+
+  async getTools(): Promise<Record<string, Tool.Any>> {
+    return unwrapExit(await this._conversation.getTools().pipe(await Runtime.runPromiseExit(await this._services())));
+  }
+
+  async getSystemPrompt(): Promise<string> {
+    return unwrapExit(
+      await Effect.gen(this, function* () {
+        const blueprints = this.context.getBlueprints();
+        const objects = this.context.getObjects();
+        const system = yield* formatSystemPrompt({ system: this._options.system, blueprints, objects });
+        return system;
+      }).pipe(
+        Effect.provideService(AiContextService, {
+          binder: this.context,
+        }),
+        await Runtime.runPromiseExit(await this._services()),
+      ),
+    );
+  }
+
+  /**
+   * Initiates a new request.
+   */
+  async request(requestProp: AiRequest): Promise<void> {
+    if (this._fiber) {
+      await this.cancel();
+    }
+
+    try {
+      this._lastRequest = requestProp;
+      this._registry.set(this.error, Option.none());
+      this._registry.set(this.active, true);
+
+      const services = await this._services();
+
+      // Create request.
+      const request = this._conversation.createRequest({
+        system: this._options.system,
+        prompt: requestProp.message,
+        observer: this._observer,
+      });
+
+      // Create fiber.
+      this._fiber = request.pipe(
+        Effect.provide(AiService.model(this._options.model ?? DEFAULT_EDGE_MODEL)),
+        // TODO(dmaretskyi): Move ArtifactDiffResolver upstream.
+        Effect.provideService(ArtifactDiffResolver, this._artifactDiffResolver),
+        Effect.asVoid,
+        Runtime.runFork(services), // Runs in the background.
+      );
+
+      // Execute request.
+      const response = await this._fiber.pipe(Fiber.join, Effect.runPromiseExit);
+      if (!Exit.isSuccess(response) && !Cause.isInterruptedOnly(response.cause)) {
+        throwCause(response.cause);
+      }
+
+      this._registry.set(this.error, Option.none());
+      this._lastRequest = undefined;
+      this._fiber = undefined;
+    } catch (err) {
+      log.error('request failed', { error: err });
+      this._registry.set(this.error, Option.some(new Error('AI service error', { cause: err })));
+    } finally {
+      this._registry.set(this.active, false);
+      this._fiber = undefined;
+    }
+  }
+
+  /**
+   * Cancels the current request.
+   */
+  async cancel(): Promise<void> {
+    await runAndForwardErrors(
+      Effect.gen(this, function* () {
+        if (this._fiber) {
+          yield* this._fiber.pipe(Fiber.interrupt);
+        }
+      }),
+    );
+
+    this._fiber = undefined;
+    this._registry.set(this.active, false);
+  }
+
+  /**
+   * Retry last failed request.
+   */
+  async retry(): Promise<void> {
+    if (this._lastRequest) {
+      return this.request(this._lastRequest);
+    }
+  }
+
+  /**
+   * Update the current chat's name.
+   */
+  async updateName(chat: Chat.Chat): Promise<void> {
+    const runtime = await this._services();
+    await updateName(runtime, this._conversation, chat, this._options.model);
+  }
+
+  // TODO(burdon): Fix/factor out.
+  private _artifactDiffResolver: ArtifactDiffResolver.Service = {
+    resolve: async (_artifacts) => {
+      const versions = new Map();
+      // await Promise.all(
+      //   artifacts.map(async (artifact) => {
+      //     const {
+      //       objects: [object],
+      //     } = await space.db.query(Filter.id(artifact.id)).run();
+      //     if (!object) {
+      //       return;
+      //     }
+
+      //     versions.set(artifact.id, {
+      //       version: getVersion(object),
+      //       diff: `Current state: ${JSON.stringify(object)}`,
+      //     });
+      //   }),
+      // );
+
+      return versions;
+    },
+  };
+
+  // TODO(dmaretskyi): Due to the way effect streams do buffering, we cannot rely on _onBlock and _onMessage to be called in order.
+  private _onBlock = Effect.fn(
+    function* (this: AiChatProcessor, block: ContentBlock.Any) {
+      this._registry.update(this._streaming, (streaming) => {
+        const blocks = streaming.filter((message) => message.blocks.every((block) => !block.pending));
+
+        // AiSession emits a message per each assistant content-block, so we do the same.
+        return [
+          ...blocks,
+          Obj.make(Message.Message, {
+            created: new Date().toISOString(),
+            sender: { role: 'assistant' },
+            blocks: [block],
+          }),
+        ];
+      });
+    }.bind(this),
+  );
+
+  private _onMessage = Effect.fn(
+    function* (this: AiChatProcessor, message: Message.Message) {
+      this._registry.set(this._streaming, []);
+      this._registry.update(this._pending, (pending) => [...pending, message]);
+    }.bind(this),
+  );
+}