@dxos/plugin-assistant 0.8.3-staging.0fa589b → 0.8.4-main.1068cf700f

package/src/hooks/useBlueprintRegistry.ts

@@ -0,0 +1,105 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback, useEffect, useMemo, useState } from 'react';
+
+import { useCapabilities } from '@dxos/app-framework/ui';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { type AiContextBinder } from '@dxos/assistant';
+import { Blueprint } from '@dxos/blueprints';
+import { type Database, Filter, Obj, Ref } from '@dxos/echo';
+import { useQuery } from '@dxos/react-client/echo';
+import { distinctBy } from '@dxos/util';
+
+/**
+ * Provide a registry of blueprints from plugins.
+ */
+// TODO(burdon): Reconcile with eventual public registry.
+export const useBlueprintRegistry = () => {
+  const blueprints = useCapabilities(AppCapabilities.BlueprintDefinition);
+  return useMemo(() => new Blueprint.Registry(blueprints), [blueprints]);
+};
+
+export const useBlueprints = ({
+  blueprintRegistry,
+  db,
+}: {
+  blueprintRegistry?: Blueprint.Registry;
+  db?: Database.Database;
+}) => {
+  const staticBlueprints = useMemo(() => blueprintRegistry?.query() ?? [], [blueprintRegistry]);
+  const spaceBlueprints = useQuery(db, Filter.type(Blueprint.Blueprint));
+  return useMemo(() => {
+    const blueprints = distinctBy([...staticBlueprints, ...spaceBlueprints], (b) => b.key);
+    blueprints.sort(({ name: a }, { name: b }) => a.localeCompare(b));
+    return blueprints;
+  }, [staticBlueprints, spaceBlueprints]);
+};
+
+/**
+ * Create reactive map of active blueprints (by key).
+ */
+export const useActiveBlueprints = ({ context }: { context?: AiContextBinder }) => {
+  const [active, setActive] = useState<Map<string, Blueprint.Blueprint>>(new Map());
+
+  useEffect(() => {
+    if (!context) {
+      setActive(new Map());
+      return;
+    }
+
+    const updateActive = () => {
+      const blueprints = context.getBlueprints();
+      setActive(new Map(blueprints.map((blueprint) => [blueprint.key, blueprint])));
+    };
+
+    // Set initial value.
+    updateActive();
+
+    // Subscribe to changes.
+    return context.subscribeBlueprints(updateActive);
+  }, [context]);
+
+  return active;
+};
+
+// TODO(burdon): Move logic into binder.
+export const useBlueprintHandlers = ({
+  db,
+  context,
+  blueprintRegistry,
+}: {
+  db: Database.Database;
+  context?: AiContextBinder;
+  blueprintRegistry?: Blueprint.Registry;
+}) => {
+  const onUpdateBlueprint = useCallback(
+    async (key: string, checked: boolean) => {
+      if (!context || !blueprintRegistry) {
+        return;
+      }
+
+      // Find existing cloned blueprint.
+      const objects = await db.query(Filter.type(Blueprint.Blueprint)).run();
+      let storedBlueprint = objects.find((blueprint) => blueprint.key === key);
+      if (checked) {
+        if (!storedBlueprint) {
+          const blueprint = blueprintRegistry.getByKey(key);
+          if (!blueprint) {
+            return;
+          }
+
+          // NOTE: Possible race condition with other peers.
+          storedBlueprint = db.add(Obj.clone(blueprint));
+        }
+        await context.bind({ blueprints: [Ref.make(storedBlueprint)] });
+      } else if (storedBlueprint) {
+        await context.unbind({ blueprints: [Ref.make(storedBlueprint)] });
+      }
+    },
+    [db, context, blueprintRegistry],
+  );
+
+  return { onUpdateBlueprint };
+};

package/src/hooks/useChatProcessor.ts

@@ -0,0 +1,78 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Registry, RegistryContext } from '@effect-atom/atom-react';
+import type * as Runtime from 'effect/Runtime';
+import { useContext, useMemo, useState } from 'react';
+
+import { AiConversation } from '@dxos/assistant';
+import { type Chat } from '@dxos/assistant-toolkit';
+import { type Blueprint } from '@dxos/blueprints';
+import { log } from '@dxos/log';
+import { type Queue, type Space } from '@dxos/react-client/echo';
+import { useAsyncEffect } from '@dxos/react-ui';
+
+import { AiChatProcessor, type AiChatServices, type AiServicePreset } from '../processor';
+import { type Assistant } from '../types';
+
+export type UseChatProcessorProps = {
+  space?: Space;
+  chat?: Chat.Chat;
+  preset?: AiServicePreset;
+  services?: () => Promise<Runtime.Runtime<AiChatServices>>;
+  blueprintRegistry?: Blueprint.Registry;
+  settings?: Assistant.Settings;
+};
+
+/**
+ * Configure and create AiChatProcessor.
+ */
+export const useChatProcessor = ({
+  space,
+  chat,
+  preset,
+  services,
+  blueprintRegistry,
+  settings,
+}: UseChatProcessorProps): AiChatProcessor | undefined => {
+  const observableRegistry = useContext(RegistryContext);
+
+  // Create conversation from chat queue.
+  const [conversation, setConversation] = useState<AiConversation>();
+  useAsyncEffect(async () => {
+    if (!space || !chat) {
+      return;
+    }
+
+    // NOTE: Passing in space and getting queue from space rather than resolving the reference.
+    //  This is because if the chat isn't in a space yet, the reference will not be resolvable.
+    const queue = space.queues.get(chat.queue.dxn);
+    const conversation = new AiConversation({
+      queue: queue as Queue<any>,
+      registry: observableRegistry as Registry.Registry,
+    });
+    await conversation.open();
+    setConversation(conversation);
+    return () => {
+      void conversation.close();
+      setConversation(undefined);
+    };
+  }, [space, chat?.queue.dxn.toString()]);
+
+  // 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,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import type * as Runtime from 'effect/Runtime';
+import { useMemo } from 'react';
+
+import { useCapability } from '@dxos/app-framework/ui';
+import { type Chat } from '@dxos/assistant-toolkit';
+import { type Key } from '@dxos/echo';
+import { TracingService } from '@dxos/functions';
+import { TracingServiceExt } from '@dxos/functions-runtime';
+import { AutomationCapabilities } from '@dxos/plugin-automation';
+import { useClient } from '@dxos/react-client';
+
+import { type AiChatServices } from '../processor';
+
+export type UseChatServicesProps = {
+  id?: Key.SpaceId;
+  chat?: Chat.Chat;
+};
+
+/**
+ * Construct service layer.
+ */
+// TODO(dmaretskyi): Better return type.
+export const useChatServices = ({
+  id,
+  chat,
+}: UseChatServicesProps): (() => Promise<Runtime.Runtime<AiChatServices>>) | undefined => {
+  const client = useClient();
+  id ??= client.spaces.default.id;
+
+  const runtimeResolver = useCapability(AutomationCapabilities.ComputeRuntime);
+  return useMemo(() => {
+    const runtime = runtimeResolver.getRuntime(id);
+    return () =>
+      runtime.runPromise(
+        Effect.runtime<AiChatServices>().pipe(
+          Effect.provide(
+            chat?.traceQueue?.target ? TracingServiceExt.layerQueue(chat.traceQueue?.target) : TracingService.layerNoop,
+          ),
+        ),
+      );
+  }, [id, chat?.traceQueue?.target]);
+};

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.Entity.Any[] => {
+  const [types, setTypes] = useState<Type.Entity.Any[]>([]);
+  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

@@ -0,0 +1,58 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { useCapabilities } from '@dxos/app-framework/ui';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { type Space } from '@dxos/client/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 => {
+  const blueprints = useCapabilities(AppCapabilities.BlueprintDefinition);
+
+  return useMemo<ReferencesProvider | undefined>((): ReferencesProvider | undefined => {
+    if (!space) {
+      return undefined;
+    }
+
+    return {
+      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
+            // TODO(burdon): Remove cast ??? (+ two instances below).
+            // .map((object) => {
+            //   log.info('object', { object, label: Obj.getLabel(object as any) });
+            //   return object;
+            // })
+            .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.Unknown))
+            .map((object) => ({
+              uri: Obj.getDXN(object as any).toString(),
+              label: Obj.getLabel(object as any) ?? '',
+            }))
+        );
+      },
+      resolveReference: async ({ uri }) => {
+        const object = await space.db.query(Filter.id(uri)).first();
+        return { uri, label: Obj.getLabel(object) ?? '' };
+      },
+    } satisfies ReferencesProvider;
+  }, [space, blueprints]);
+};
+
+const stringMatch = (query: string, label: string) => label.toLowerCase().startsWith(query.toLowerCase());

package/src/index.ts

@@ -4,8 +4,9 @@
 
 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';