@dxos/plugin-assistant 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

package/src/capabilities/settings.ts

@@ -2,18 +2,30 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { live } from '@dxos/live-object';
+import * as Effect from 'effect/Effect';
 
-import { meta } from '../meta';
-import { Assistant } from '../types';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { createKvsStore } from '@dxos/effect';
 
-export default () => {
-  const settings = live<Assistant.Settings>({});
+import { meta } from '#meta';
+import { Assistant, AssistantCapabilities } from '#types';
 
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: Assistant.Settings,
-    value: settings,
-  });
-};
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    const settingsAtom = createKvsStore({
+      key: meta.id,
+      schema: Assistant.Settings,
+      defaultValue: () => ({}),
+    });
+
+    return [
+      Capability.contributes(AssistantCapabilities.Settings, settingsAtom),
+      Capability.contributes(AppCapabilities.Settings, {
+        prefix: meta.id,
+        schema: Assistant.Settings,
+        atom: settingsAtom,
+      }),
+    ];
+  }),
+);

package/src/capabilities/state.ts

@@ -2,19 +2,34 @@
 // Copyright 2025 DXOS.org
 //
 
-import { contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
+import { Atom } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
 
-import { meta } from '../meta';
+import { Capability } from '@dxos/app-framework';
+import { type Obj } from '@dxos/echo';
+import { createKvsStore } from '@dxos/effect';
 
-import { AssistantCapabilities } from './capabilities';
+import { meta } from '#meta';
+import { AssistantCapabilities } from '#types';
 
-export default () => {
-  // NOTE: This needs to be a chat object rather than a string id to avoid a query race.
-  // TODO(wittjosiah): Handle serialization and hydration for this so it can be cached.
-  const state = new LocalStorageStore<AssistantCapabilities.AssistantState>(meta.id, {
-    currentChat: {},
-  });
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    // NOTE: This needs to be a chat object rather than a string id to avoid a query race.
+    // TODO(wittjosiah): Handle serialization and hydration for this so it can be cached.
+    const stateAtom = createKvsStore({
+      key: meta.id,
+      schema: AssistantCapabilities.StateSchema,
+      defaultValue: () => ({
+        currentChat: {},
+        pendingPrompts: {},
+      }),
+    });
 
-  return contributes(AssistantCapabilities.State, state.values, () => state.close());
-};
+    const companionChatCacheAtom = Atom.make<Record<string, Obj.Unknown | undefined>>({}).pipe(Atom.keepAlive);
+
+    return [
+      Capability.contributes(AssistantCapabilities.State, stateAtom),
+      Capability.contributes(AssistantCapabilities.CompanionChatCache, companionChatCacheAtom),
+    ];
+  }),
+);

package/src/capabilities/toolkit.ts

@@ -2,167 +2,12 @@
 // Copyright 2025 DXOS.org
 //
 
-import * as Tool from '@effect/ai/Tool';
-import * as Toolkit from '@effect/ai/Toolkit';
 import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
 
-import { Capabilities, type Capability, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
-import { AiContextService, ArtifactId } from '@dxos/assistant';
-import { WebSearchToolkit } from '@dxos/assistant-testing';
-import { Filter, Obj, Ref, SchemaNotFoundError, Type } from '@dxos/echo';
-import { DatabaseService } from '@dxos/functions';
-import { invariant } from '@dxos/invariant';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { SpaceCapabilities, getActiveSpace } from '@dxos/plugin-space';
-import { SpaceAction } from '@dxos/plugin-space/types';
-import { DataType } from '@dxos/schema';
-import { trim } from '@dxos/util';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { WebSearchToolkitOpaque } from '@dxos/assistant-toolkit';
 
-// TODO(burdon): Reconcile with functions (currently reuses plugin framework intents).
-class AssistantToolkit extends Toolkit.make(
-  Tool.make('add-to-context', {
-    description: trim`
-      Adds the object to the chat context.
-    `,
-    parameters: {
-      id: ArtifactId.annotations({
-        description: 'The ID of the document to read.',
-      }),
-    },
-    success: Schema.Void,
-    failure: Schema.Never,
-    dependencies: [AiContextService, DatabaseService],
-  }),
-
-  Tool.make('get-schemas', {
-    description: trim`
-      Retrieves schemas definitions.
-    `,
-    parameters: {
-      // TODO(wittjosiah): Remove this once parameter-less tools are fixed.
-      limit: Schema.Number,
-    },
-    // TODO(dmaretskyi): Effect returns ({ result, encodedResult })
-    success: Schema.Any,
-    failure: Schema.Never,
-  }),
-
-  Tool.make('add-schema', {
-    description: trim`
-      Adds a schema to the space.
-      The name will be used when displayed to the user.
-      The typename must be in the format of "example.com/type/Type".
-    `,
-    parameters: {
-      name: Schema.String,
-      typename: Schema.String,
-      jsonSchema: Schema.Any,
-    },
-    success: Schema.Any,
-    failure: Schema.Never,
-  }),
-
-  Tool.make('create-record', {
-    description: trim`
-      Creates a new record and adds it to the current space.
-      Get the schema from the get-schemas tool and ensure that the data matches the corresponding schema.
-      Note that only record schemas are supported.
-    `,
-    parameters: {
-      typename: Schema.String,
-      data: Schema.Any,
-    },
-    success: Schema.Any,
-    failure: Schema.Never,
-  }),
-) {
-  static layer = (context: PluginContext) =>
-    AssistantToolkit.toLayer({
-      'add-to-context': Effect.fnUntraced(function* ({ id }) {
-        const { binder } = yield* AiContextService;
-        const { db } = yield* DatabaseService;
-        const ref = Ref.fromDXN(ArtifactId.toDXN(id, db.spaceId));
-        yield* Effect.promise(() =>
-          binder.bind({
-            blueprints: [],
-            objects: [ref],
-          }),
-        );
-      }),
-
-      'get-schemas': () => {
-        const space = getActiveSpace(context);
-        invariant(space, 'No active space');
-
-        return Effect.gen(function* () {
-          const whitelist = context
-            .getCapabilities(ClientCapabilities.SchemaWhiteList)
-            .flat()
-            .map((schema) => ({
-              typename: Type.getTypename(schema),
-              jsonSchema: Type.toJsonSchema(schema),
-              kind: 'record',
-            }));
-
-          // TODO(burdon): Why ObjectForm (bad name for data capability; UI term)?
-          const forms = context.getCapabilities(SpaceCapabilities.ObjectForm).map((form) => ({
-            typename: Type.getTypename(form.objectSchema),
-            jsonSchema: Type.toJsonSchema(form.objectSchema),
-            kind: 'item',
-          }));
-
-          const schemas = [...whitelist, ...forms];
-          if (space) {
-            const { objects } = yield* DatabaseService.runQuery(Filter.type(DataType.StoredSchema));
-            schemas.push(
-              ...objects.map((object) => ({
-                typename: object.typename,
-                jsonSchema: object.jsonSchema,
-                kind: 'record',
-              })),
-            );
-          }
-
-          return schemas;
-        }).pipe(Effect.provide(DatabaseService.layer(space.db)));
-      },
-
-      'add-schema': ({ name, typename, jsonSchema }) => {
-        return Effect.gen(function* () {
-          const { dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-          const space = getActiveSpace(context);
-          invariant(space, 'No active space');
-
-          const schema = Type.toEffectSchema(jsonSchema).pipe(Type.Obj({ typename, version: '0.1.0' }));
-          yield* dispatch(createIntent(SpaceAction.AddSchema, { space, name, typename, schema }));
-        }).pipe(Effect.orDie);
-      },
-
-      'create-record': ({ typename, data }) => {
-        const { dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-        const space = getActiveSpace(context);
-        invariant(space, 'No active space');
-
-        return Effect.gen(function* () {
-          const schemas = context.getCapabilities(ClientCapabilities.SchemaWhiteList).flat();
-          const { objects } = yield* DatabaseService.runQuery(Filter.type(DataType.StoredSchema));
-          schemas.push(...objects.map((object) => Type.toEffectSchema(object.jsonSchema)));
-          const schema = schemas.find((schema) => Type.getTypename(schema) === typename);
-          if (!schema) {
-            throw new SchemaNotFoundError(typename);
-          }
-
-          const object = Obj.make(schema, data);
-          yield* dispatch(createIntent(SpaceAction.AddObject, { object, target: space, hidden: true }));
-          return object;
-        }).pipe(Effect.provide(DatabaseService.layer(space.db)), Effect.orDie);
-      },
-    });
-}
-
-export default (context: PluginContext): Capability<any>[] => [
-  contributes(Capabilities.Toolkit, AssistantToolkit),
-  contributes(Capabilities.ToolkitHandler, AssistantToolkit.layer(context)),
-  contributes(Capabilities.Toolkit, WebSearchToolkit),
-];
+export default Capability.makeModule(() =>
+  Effect.succeed([Capability.contributes(AppCapabilities.Toolkit, WebSearchToolkitOpaque)]),
+);

package/src/cli/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+export * from './plugin';

package/src/cli/plugin.ts

@@ -0,0 +1,84 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { ActivationEvents, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { ContextBinding } from '@dxos/assistant';
+import { Agent, Chat, McpServer, Memory, Plan, ResearchGraph } from '@dxos/assistant-toolkit';
+import { Blueprint, Prompt } from '@dxos/blueprints';
+import { Sequence } from '@dxos/conductor';
+import { Feed } from '@dxos/echo';
+import { ClientEvents } from '@dxos/plugin-client/types';
+import { Text } from '@dxos/schema';
+import { HasSubject, Message } from '@dxos/types';
+
+import {
+  AiService,
+  BlueprintDefinition,
+  EdgeModelResolver,
+  LocalModelResolver,
+  Migrations,
+  OperationHandler,
+  Toolkit,
+} from '#capabilities';
+import { meta } from '#meta';
+import { AssistantEvents } from '#types';
+
+/**
+ * Headless variant of `AssistantPlugin` for Node-only contexts (CLI, tests).
+ * Omits modules that depend on browser globals or the React/UI stack:
+ * translations, ReactSurface, MarkdownExtension, AppGraphBuilder, Settings,
+ * AssistantState, CompanionChatProvisioner, metadata (`createObject` hooks),
+ * and the `on-space-created` hook.
+ */
+export const AssistantPlugin = Plugin.define(meta).pipe(
+  // Headless plugin has no ReactSurface; full Assistant fires SetupArtifactDefinition from the surface module.
+  // Activate blueprint definitions on Startup so AgentHandlers (and other blueprint ops) register in CLI/tests.
+  AppPlugin.addBlueprintDefinitionModule({
+    activate: BlueprintDefinition,
+    activatesOn: ActivationEvents.Startup,
+  }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  AppPlugin.addSchemaModule({
+    schema: [
+      Chat.Chat,
+      Chat.CompanionTo,
+      Blueprint.Blueprint,
+      ContextBinding,
+      Feed.Feed,
+      HasSubject.HasSubject,
+      Message.Message,
+      Prompt.Prompt,
+      ResearchGraph.ResearchGraph,
+      Agent.Agent,
+      McpServer.McpServer,
+      Plan.Plan,
+      Sequence,
+      Memory.Memory,
+      Text.Text,
+    ],
+  }),
+  Plugin.addModule({
+    activatesOn: AssistantEvents.SetupAiServiceProviders,
+    activate: EdgeModelResolver,
+  }),
+  Plugin.addModule({
+    activatesOn: AssistantEvents.SetupAiServiceProviders,
+    activate: LocalModelResolver,
+  }),
+  Plugin.addModule({
+    firesBeforeActivation: [AssistantEvents.SetupAiServiceProviders],
+    activatesOn: ActivationEvents.Startup,
+    activate: AiService,
+  }),
+  Plugin.addModule({
+    activatesOn: ActivationEvents.Startup,
+    activate: Toolkit,
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.SetupMigration,
+    activate: Migrations,
+  }),
+  Plugin.make,
+);

package/src/components/AssistantSettings/AssistantSettings.stories.tsx

@@ -0,0 +1,34 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+import { AssistantSettings } from './AssistantSettings';
+
+const meta = {
+  title: 'plugins/plugin-assistant/components/AssistantSettings',
+  tags: ['settings'],
+  component: AssistantSettings,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof AssistantSettings>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    settings: {
+      customPrompts: false,
+      llmProvider: 'edge',
+    },
+  },
+};

package/src/components/AssistantSettings/AssistantSettings.tsx

@@ -5,11 +5,12 @@
 import React from 'react';
 
 import { DEFAULT_EDGE_MODELS, DEFAULT_OLLAMA_MODELS } from '@dxos/ai';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
 import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
+import { Settings as SettingsForm } from '@dxos/react-ui-form';
 
-import { meta } from '../../meta';
-import { type Assistant, LLM_PROVIDERS } from '../../types';
+import { meta } from '#meta';
+import { type Assistant, LLM_PROVIDERS } from '#types';
 
 // TODO(burdon): Factor out default Selector.
 const DEFAULT_VALUE = '__default';
@@ -20,93 +21,112 @@ const LLM_PROVIDER_LABELS = {
   lmstudio: 'LM Studio',
 } as const;
 
-export const AssistantSettings = ({ settings }: { settings: Assistant.Settings }) => {
+export type AssistantSettingsProps = AppSurface.SettingsArticleProps<Assistant.Settings>;
+
+export const AssistantSettings = ({ settings, onSettingsChange }: AssistantSettingsProps) => {
   const { t } = useTranslation(meta.id);
 
   return (
-    <ControlPage>
-      <ControlSection title={t('settings title', { ns: meta.id })}>
-        <ControlGroup>
-          <ControlItemInput title={t('settings custom prompts label')}>
-            <Input.Switch
-              checked={!!settings.customPrompts}
-              onCheckedChange={(checked) => (settings.customPrompts = checked)}
-            />
-          </ControlItemInput>
+    <SettingsForm.Viewport>
+      <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>
+        <SettingsForm.Item
+          title={t('settings.custom-prompts.label')}
+          description={t('settings.custom-prompts.description')}
+        >
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={!!settings.customPrompts}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, customPrompts: checked }))}
+          />
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings llm provider label')}>
-            <Select.Root
-              value={settings.llmProvider ?? 'edge'}
-              onValueChange={(value) => {
-                settings.llmProvider = value === DEFAULT_VALUE ? undefined : (value as any);
-              }}
-            >
-              <Select.TriggerButton placeholder={t('settings llm provider label')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    <Select.Option value={DEFAULT_VALUE}>{t('settings default label')}</Select.Option>
-                    {LLM_PROVIDERS.map((model) => (
-                      <Select.Option key={model} value={model}>
-                        {LLM_PROVIDER_LABELS[model]}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
+        <SettingsForm.Item
+          title={t('settings.llm-provider.label')}
+          description={t('settings.llm-provider.description')}
+        >
+          <Select.Root
+            disabled={!onSettingsChange}
+            value={settings.llmProvider ?? 'edge'}
+            onValueChange={(value) => {
+              onSettingsChange?.((s) => ({
+                ...s,
+                llmProvider: value === DEFAULT_VALUE ? undefined : (value as any),
+              }));
+            }}
+          >
+            <Select.TriggerButton disabled={!onSettingsChange} placeholder={t('settings.llm-provider.label')} />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  <Select.Option value={DEFAULT_VALUE}>{t('settings.default.label')}</Select.Option>
+                  {LLM_PROVIDERS.map((model) => (
+                    <Select.Option key={model} value={model}>
+                      {LLM_PROVIDER_LABELS[model]}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+                <Select.Arrow />
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings edge llm model label')}>
-            <Select.Root
-              value={settings.edgeModel ?? DEFAULT_VALUE}
-              onValueChange={(value) => {
-                settings.edgeModel = value === DEFAULT_VALUE ? undefined : value;
-              }}
-            >
-              <Select.TriggerButton placeholder={t('settings default llm model label')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    <Select.Option value={DEFAULT_VALUE}>{t('settings default label')}</Select.Option>
-                    {DEFAULT_EDGE_MODELS.map((model) => (
-                      <Select.Option key={model} value={model}>
-                        {model}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
+        <SettingsForm.Item
+          title={t('settings.edge-llm-model.label')}
+          description={t('settings.edge-llm-model.description')}
+        >
+          <Select.Root
+            disabled={!onSettingsChange}
+            value={settings.edgeModel ?? DEFAULT_VALUE}
+            onValueChange={(value) => {
+              onSettingsChange?.((s) => ({ ...s, edgeModel: value === DEFAULT_VALUE ? undefined : value }));
+            }}
+          >
+            <Select.TriggerButton disabled={!onSettingsChange} placeholder={t('settings.default-llm-model.label')} />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  <Select.Option value={DEFAULT_VALUE}>{t('settings.default.label')}</Select.Option>
+                  {DEFAULT_EDGE_MODELS.map((model) => (
+                    <Select.Option key={model} value={model}>
+                      {model}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+                <Select.Arrow />
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </SettingsForm.Item>
 
-          <ControlItemInput title={t('settings ollama llm model label')}>
-            <Select.Root
-              value={settings.ollamaModel ?? DEFAULT_VALUE}
-              onValueChange={(value) => {
-                settings.ollamaModel = value === DEFAULT_VALUE ? undefined : value;
-              }}
-            >
-              <Select.TriggerButton placeholder={t('settings default llm model label')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    <Select.Option value={DEFAULT_VALUE}>{t('settings default label')}</Select.Option>
-                    {DEFAULT_OLLAMA_MODELS.map((model) => (
-                      <Select.Option key={model} value={model}>
-                        {model}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
-        </ControlGroup>
-      </ControlSection>
-    </ControlPage>
+        <SettingsForm.Item
+          title={t('settings.ollama-llm-model.label')}
+          description={t('settings.ollama-llm-model.description')}
+        >
+          <Select.Root
+            disabled={!onSettingsChange}
+            value={settings.ollamaModel ?? DEFAULT_VALUE}
+            onValueChange={(value) => {
+              onSettingsChange?.((s) => ({ ...s, ollamaModel: value === DEFAULT_VALUE ? undefined : value }));
+            }}
+          >
+            <Select.TriggerButton disabled={!onSettingsChange} placeholder={t('settings.default-llm-model.label')} />
+            <Select.Portal>
+              <Select.Content>
+                <Select.Viewport>
+                  <Select.Option value={DEFAULT_VALUE}>{t('settings.default.label')}</Select.Option>
+                  {DEFAULT_OLLAMA_MODELS.map((model) => (
+                    <Select.Option key={model} value={model}>
+                      {model}
+                    </Select.Option>
+                  ))}
+                </Select.Viewport>
+                <Select.Arrow />
+              </Select.Content>
+            </Select.Portal>
+          </Select.Root>
+        </SettingsForm.Item>
+      </SettingsForm.Section>
+    </SettingsForm.Viewport>
   );
 };

package/src/components/AssistantSettings/index.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-export * from './AssistantSettings';
+export { AssistantSettings as default } from './AssistantSettings';