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

package/src/testing/test-generator.ts

@@ -0,0 +1,262 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Obj } from '@dxos/echo';
+import { Database } from '@dxos/echo';
+import { ContextQueueService } from '@dxos/functions';
+import { faker } from '@dxos/random';
+import { renderObjectLink } from '@dxos/react-ui-components';
+import { type Actor, type ContentBlock, Message, Organization } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+export const createMessage = (role: Actor.Role, blocks: ContentBlock.Any[]): Message.Message => {
+  return Obj.make(Message.Message, {
+    created: new Date().toISOString(),
+    sender: { role },
+    blocks,
+  });
+};
+
+export type MessageGenerator = Effect.Effect<void, never, Database.Service | ContextQueueService>;
+
+export const createMessageGenerator = (): MessageGenerator[] => [
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('user', [
+          {
+            _tag: 'text',
+            text: faker.lorem.sentence(5),
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text:
+              trim`
+              ## Markdown
+              Here is a [link](https://dxos.org)
+
+              And some **bold** text.
+
+              And some JSON
+              \`\`\`json
+              {
+                "key": "value"
+              }
+              \`\`\`
+
+              And some code
+              \`\`\`js
+              const x = 1;
+              \`\`\`
+            ` + '\n',
+          },
+          {
+            _tag: 'text',
+            disposition: 'cot',
+            text:
+              [
+                faker.lorem.paragraph(),
+                '',
+                ...Array.from({
+                  length: faker.number.int({ min: 3, max: 5 }),
+                }).map((_, idx) => `${idx + 1}. ${faker.lorem.paragraph()}`),
+              ].join('\n') + '\n',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: 'How can I help?',
+          },
+          {
+            _tag: 'suggestion',
+            text: 'List tools',
+          },
+          {
+            _tag: 'suggestion',
+            text: 'Show info',
+          },
+          {
+            _tag: 'suggestion',
+            text: faker.lorem.paragraph(),
+          },
+        ]),
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: 'Select an option:',
+          },
+          {
+            _tag: 'select',
+            options: ['Option 1', 'Option 2', 'Option 3'],
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'toolkit',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('user', [
+          {
+            _tag: 'text',
+            text: faker.lorem.sentence(5),
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    const { db } = yield* Database.Service;
+    const obj1 = db.add(Obj.make(Organization.Organization, { name: 'DXOS' }));
+    // const obj2 = db.add(Obj.make(Person.Person, { fullName: 'Alice' }));
+    // const obj3 = db.add(Obj.make(Person.Person, { fullName: 'Bob' }));
+    // const obj4 = db.add(Obj.make(Person.Person, { fullName: 'Charlie' }));
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          // Inline tag.
+          {
+            _tag: 'text',
+            text: [faker.lorem.paragraph(), renderObjectLink(obj1), faker.lorem.paragraph(), '\n'].join(' '),
+          },
+
+          // Inline cards.
+          // ...[obj1, obj2, obj3, obj4].map(
+          //   (obj) =>
+          //     ({
+          //       _tag: 'text',
+          //       text: renderObjectLink(obj, true) + '\n',
+          //     }) satisfies ContentBlock.Text,
+          // ),
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.lorem.paragraph() + '\n',
+          },
+        ]),
+        createMessage('assistant', [
+          {
+            _tag: 'toolCall',
+            toolCallId: '1234',
+            name: 'search',
+            input: JSON.stringify({}),
+            providerExecuted: false,
+          },
+        ]),
+        createMessage('user', [
+          {
+            _tag: 'toolResult',
+            toolCallId: '1234',
+            name: 'search',
+            result: 'This is a tool result.',
+            providerExecuted: false,
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.lorem.paragraph() + '\n',
+          },
+        ]),
+        createMessage('assistant', [
+          {
+            _tag: 'toolCall',
+            toolCallId: '4567',
+            name: 'create',
+            input: JSON.stringify({}),
+            providerExecuted: false,
+          },
+        ]),
+        createMessage('user', [
+          {
+            _tag: 'toolResult',
+            toolCallId: '4567',
+            name: 'create',
+            result: 'This is a tool result.',
+            providerExecuted: false,
+          },
+        ]),
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text:
+              Array.from({ length: faker.number.int({ min: 2, max: 3 }) })
+                .map(() => faker.lorem.paragraph())
+                .join('\n\n') + '\n',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.lorem.paragraph(),
+          },
+        ]),
+      ]),
+    );
+  }),
+];

package/src/testing/test-sequence.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ToolId } from '@dxos/ai';
+import { type SequenceDefinition, SequenceParser } from '@dxos/conductor';
+
+export const RESEARCH_SEQUENCE_DEFINITION: SequenceDefinition = {
+  steps: [
+    {
+      instructions: 'Research information and entities related to the selected objects.',
+      tools: [ToolId.make('search/web_search')],
+    },
+    {
+      instructions:
+        'Based on your research find matching entires that are already in the graph. Do exaustive research.',
+      tools: [ToolId.make('search/local_search')],
+    },
+    {
+      instructions: 'Add researched data to the graph. Make connections to existing objects.',
+      tools: [ToolId.make('search/local_search'), ToolId.make('graph/writer')],
+    },
+  ],
+};
+
+export const RESEARCH_SEQUENCE = SequenceParser.create().parse(RESEARCH_SEQUENCE_DEFINITION);

package/src/testing/test-services.ts

@@ -2,18 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Obj } from '@dxos/echo';
+import { Obj, type Type } from '@dxos/echo';
 
-import {
-  type ApiAuthorization,
-  type BaseServiceRegistry,
-  type ServiceQuery,
-  ServiceType,
-  categoryIcons,
-} from '../types';
+import { type ApiAuthorization, type BaseServiceRegistry, ServiceType, categoryIcons } from '../types';
+
+const ServiceTypeSchema = ServiceType as unknown as Type.Obj.Any;
 
 export class MockServiceRegistry implements BaseServiceRegistry {
-  async queryServices(query?: ServiceQuery): Promise<ServiceType[]> {
+  async queryServices(): Promise<ServiceType[]> {
     return TEST_SERVICES;
   }
 }
@@ -54,7 +50,7 @@ const VISUAL_CROSSING_CREDENTIALS: ApiAuthorization = {
 //  - e.g., https://github.com/konfig-sdks/openapi-examples/blob/main/xkcd/openapi.yaml
 
 const TEST_SERVICES: ServiceType[] = [
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'amadeus.com/service/FlightSearch',
     name: 'Amadeus Flight Search',
     description: 'Search for local and international flights.',
@@ -68,7 +64,7 @@ const TEST_SERVICES: ServiceType[] = [
     ],
   }),
 
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'amadeus.com/service/HotelSearch',
     name: 'Amadeus Hotel Search',
     description: 'Search for local and international hotels.',
@@ -82,7 +78,7 @@ const TEST_SERVICES: ServiceType[] = [
     ],
   }),
 
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'visualcrossing.com/service/Weather',
     name: 'Visual Crossing Weather',
     description: 'Search for global weather forecasts.',
@@ -97,7 +93,7 @@ const TEST_SERVICES: ServiceType[] = [
   }),
 
   // TODO(burdon): Needs auth.
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'abstractapi.com/service/GeoLocation',
     name: 'Abstract GeoLocation',
     description: 'Get the location of any IP address.',
@@ -115,7 +111,7 @@ const TEST_SERVICES: ServiceType[] = [
   //
 
   ...Array.from({ length: 20 }, (_, i) =>
-    Obj.make(ServiceType, {
+    Obj.make(ServiceTypeSchema, {
       serviceId: `example.com/service/test-${i}`,
       name: `Test ${i}`,
       description: `Test ${i}`,

package/src/translations.ts

@@ -2,41 +2,74 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Blueprint } from '@dxos/assistant';
+import { Chat, Initiative } from '@dxos/assistant-toolkit';
+import { Blueprint, Prompt } from '@dxos/blueprints';
+import { Sequence } from '@dxos/conductor';
 import { Type } from '@dxos/echo';
+import { type Resource } from '@dxos/react-ui';
 
-import { ASSISTANT_PLUGIN } from './meta';
-import { AIChatType, TemplateType } from './types';
+import { meta } from './meta';
 
-export default [
+// TODO(burdon): Standardize translation names.
+export const translations = [
   {
     'en-US': {
-      [Type.getTypename(AIChatType)]: {
-        'typename label': 'Assistant',
-        'typename label_zero': 'Assistants',
-        'typename label_one': 'Assistant',
-        'typename label_other': 'Assistants',
-        'object name placeholder': 'New assistant',
-      },
-      [Type.getTypename(Blueprint)]: {
+      // TODO(burdon): From assistant.
+      [Blueprint.Blueprint.typename]: {
         'typename label': 'Blueprint',
         'typename label_zero': 'Blueprints',
         'typename label_one': 'Blueprint',
         'typename label_other': 'Blueprints',
         'object name placeholder': 'New blueprint',
+        'rename object label': 'Rename blueprint',
+        'delete object label': 'Delete blueprint',
+        'object deleted label': 'Blueprint deleted',
+      },
+      [Type.getTypename(Prompt.Prompt)]: {
+        'typename label': 'Prompt',
+        'typename label_zero': 'Prompts',
+        'typename label_one': 'Prompt',
+        'typename label_other': 'Prompts',
+        'object name placeholder': 'New prompt',
+        'rename object label': 'Rename prompt',
+        'delete object label': 'Delete prompt',
+        'object deleted label': 'Prompt deleted',
+      },
+      // TODO(burdon): From conductor.
+      [Sequence.typename]: {
+        'typename label': 'Sequence',
+        'typename label_zero': 'Sequences',
+        'typename label_one': 'Sequence',
+        'typename label_other': 'Sequences',
+        'object name placeholder': 'New sequence',
+        'rename object label': 'Rename sequence',
+        'delete object label': 'Delete sequence',
+        'object deleted label': 'Sequence deleted',
       },
-      [Type.getTypename(TemplateType)]: {
-        'typename label': 'Template',
-        'typename label_zero': 'Templates',
-        'typename label_one': 'Template',
-        'typename label_other': 'Templates',
-        'object name placeholder': 'New template',
+      [Chat.Chat.typename]: {
+        'typename label': 'AI Chat',
+        'object name placeholder': 'New AI Chat',
+        'rename object label': 'Rename AI Chat',
+        'delete object label': 'Delete AI Chat',
+        'object deleted label': 'AI Chat deleted',
       },
-      [ASSISTANT_PLUGIN]: {
+      [Initiative.Initiative.typename]: {
+        'typename label': 'Initiative',
+        'typename label_zero': 'Initiatives',
+        'typename label_one': 'Initiative',
+        'typename label_other': 'Initiatives',
+        'object name placeholder': 'New initiative',
+        'rename object label': 'Rename initiative',
+        'delete object label': 'Delete initiative',
+        'object deleted label': 'Initiative deleted',
+      },
+      // TODO(burdon): Reconcile with react-ui-chat.
+      [meta.id]: {
         'templates label': 'Templates',
         'open ambient chat label': 'Open Assistant',
         'assistant chat label': 'Assistant',
         'plugin name': 'Assistant',
+        'settings title': 'Assistant settings',
         'object placeholder': 'New prompt',
         'create object label': 'Create prompt',
         'create trigger label': 'Create trigger',
@@ -49,29 +82,59 @@ export default [
         'description placeholder': 'Enter description of when this template should be used',
         'select preset template placeholder': 'Select preset',
         'service registry label': 'Service Registry',
+        'type filter placeholder': 'Type',
+        'any type filter label': 'Any',
+        'no blueprint message': 'No active blueprints',
+        'tool call label': 'Calling tool...',
+        'tool result label': 'Success',
+        'tool error label': 'Tool call failed',
 
-        'blueprint logs label': 'Logs',
+        'invocations label': 'Invocations',
 
         'assistant dialog title': 'Assistant',
         'open assistant label': 'Open assistant',
+        'reset blueprints label': 'Reset blueprints',
+
+        'no tools': 'No tools are configured',
+        'no results': 'No results',
 
-        'search input placeholder': 'Search...',
-        'chat input placeholder': 'Ask a question...',
-        'chat stop': 'Cancel request.',
+        'cancel button': 'Cancel',
+        'save button': 'Save',
+        'new thread button': 'New Chat',
+        'rename thread button': 'Rename Chat',
+        'chat history label': 'Chat History',
+        'chat update name label': 'Update AI Chat name',
 
-        'button save': 'Save',
-        'button run': 'Run',
+        'toolkit label': 'Toolkit',
+        'summary label': 'Summary',
 
-        'prompt placeholder': 'Ask a question...',
+        'search placeholder': 'Search...',
+        'prompt placeholder': 'Enter question or command...',
+        'context objects button': 'Add to context',
+        'context settings button': 'Chat settings',
         'microphone button': 'Click to speak',
         'cancel processing button': 'Stop processing',
+        'blueprints in context title': 'Blueprints',
+        'objects in context title': 'Content',
+        'remove object in context label': 'Remove document',
+        'chat model title': 'Model',
 
         'settings default label': 'Default',
         'settings custom prompts label': 'Use custom prompts',
         'settings llm provider label': 'LLM provider',
         'settings edge llm model label': 'Remote language model',
         'settings ollama llm model label': 'Ollama language model',
+
+        // Trigger status
+        'trigger status disabled label': 'Triggers disabled',
+        'trigger status idle label': 'Triggers idle',
+        'trigger status running label': 'Trigger running',
+        'trigger status error label': 'Trigger error',
+        'trigger runtime label': 'Trigger Runtime',
+        'trigger runtime description': 'Enable automatic trigger execution',
+        'trigger last invocation label': 'Last run',
+        'trigger duration label': 'Duration',
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/types/Assistant.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Chat as ChatModule } from '@dxos/assistant-toolkit';
+
+import { LLM_PROVIDERS } from './defs';
+
+// Re-export Chat schema for backward compatibility.
+export const Chat = ChatModule.Chat;
+export type Chat = ChatModule.Chat;
+
+/**
+ * Plugin settings.
+ */
+export const Settings = Schema.mutable(
+  Schema.Struct({
+    llmProvider: Schema.optional(Schema.Literal(...LLM_PROVIDERS)),
+    edgeModel: Schema.optional(Schema.String),
+    ollamaModel: Schema.optional(Schema.String),
+    lmstudioModel: Schema.optional(Schema.String),
+    customPrompts: Schema.optional(Schema.Boolean),
+  }),
+);
+
+export type Settings = Schema.Schema.Type<typeof Settings>;

package/src/types/AssistantAction.ts

@@ -0,0 +1,76 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Chat } from '@dxos/assistant-toolkit';
+import { SpaceSchema } from '@dxos/client/echo';
+import { Database, Type } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { Collection } from '@dxos/schema';
+
+import { meta } from '../meta';
+
+// Operations
+const ASSISTANT_OPERATION = `${meta.id}/operation`;
+
+export namespace AssistantOperation {
+  export const OnCreateSpace = Operation.make({
+    meta: { key: `${ASSISTANT_OPERATION}/on-create-space`, name: 'On Create Space' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        space: SpaceSchema,
+        rootCollection: Collection.Collection,
+      }),
+      output: Schema.Void,
+    },
+  });
+
+  export const CreateChat = Operation.make({
+    meta: { key: `${ASSISTANT_OPERATION}/create-chat`, name: 'Create Chat' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        db: Database.Database,
+        name: Schema.optional(Schema.String),
+        /** If false, chat is created in-memory only and not added to space. Defaults to true. */
+        addToSpace: Schema.optional(Schema.Boolean),
+      }),
+      output: Schema.Struct({
+        object: Chat.Chat,
+      }),
+    },
+  });
+
+  export const UpdateChatName = Operation.make({
+    meta: { key: `${ASSISTANT_OPERATION}/update-chat-name`, name: 'Update Chat Name' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        chat: Chat.Chat,
+      }),
+      output: Schema.Void,
+    },
+  });
+
+  export const SetCurrentChat = Operation.make({
+    meta: { key: `${ASSISTANT_OPERATION}/set-current-chat`, name: 'Set Current Chat' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        companionTo: Type.Obj,
+        chat: Chat.Chat.pipe(Schema.optional),
+      }),
+      output: Schema.Void,
+    },
+  });
+
+  export const BlueprintForm = Schema.Struct({
+    key: Schema.String,
+    name: Schema.String,
+    description: Schema.optional(Schema.String),
+  });
+}

package/src/types/capabilities.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '../meta';
+
+import { type Assistant } from './';
+
+export namespace AssistantCapabilities {
+  export const Settings = Capability.make<Atom.Writable<Assistant.Settings>>(`${meta.id}/capability/settings`);
+
+  export const StateSchema = Schema.mutable(
+    Schema.Struct({
+      /** Map of primary object dxn to current chat dxn. */
+      currentChat: Schema.Record({ key: Schema.String, value: Schema.UndefinedOr(Schema.String) }),
+    }),
+  );
+
+  export type AssistantState = Schema.Schema.Type<typeof StateSchema>;
+
+  export const State = Capability.make<Atom.Writable<AssistantState>>(`${meta.id}/capability/state`);
+}

package/src/types/defs.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export const LLM_PROVIDERS = ['edge', 'ollama', 'lmstudio'] as const;

package/src/types/events.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent } from '@dxos/app-framework';
+
+import { meta } from '../meta';
+
+export namespace AssistantEvents {
+  export const SetupAiServiceProviders = ActivationEvent.make(`${meta.id}/event/setup-ai-service-providers`);
+}

package/src/types/index.ts

@@ -2,7 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './chat';
+// Re-export Chat type from assistant-toolkit for public API type declarations.
+export type { Chat as ChatType } from '@dxos/assistant-toolkit';
+
+export * as Assistant from './Assistant';
+export { AssistantOperation } from './AssistantAction';
+
+export * from './capabilities';
+export * from './defs';
+export * from './events';
 export * from './service';
-export * from './template';
-export * from './types';