@dxos/plugin-assistant 0.8.4-main.2e9d522 → 0.8.4-main.548089c

package/src/testing/test-generator.ts

@@ -0,0 +1,261 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Obj } from '@dxos/echo';
+import { ContextQueueService, DatabaseService } 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, DatabaseService | 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* DatabaseService;
+    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

@@ -2,33 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-import { ToolId, ToolRegistry } from '@dxos/ai';
-// import { createExaTool, createGraphWriterTool, createLocalSearchTool } from '@dxos/assistant';
-import { type Space } from '@dxos/client/echo';
-import { SequenceParser, type SequenceDefinition } from '@dxos/conductor';
-import { type DXN } from '@dxos/keys';
-import { isNonNullable } from '@dxos/util';
-
-// TODO(dmaretskyi): make db available through services (same as function executor).
-// TODO(burdon): Can tools implement "aspects" so that variants can be used rather than an explicit reference?
-export const createToolRegistry = (space: Space, queueDxn?: DXN): ToolRegistry => {
-  return new ToolRegistry(
-    [
-      // createExaTool({ apiKey: EXA_API_KEY }),
-      // createLocalSearchTool(space.db, queueDxn && space.queues.get(queueDxn)),
-      // queueDxn &&
-      //   createGraphWriterTool({
-      //     db: space.db,
-      //     queue: space.queues.get(queueDxn),
-      //     schema: DataTypes,
-      //     onDone: async (objects) => {
-      //       const queue = space.queues.get(queueDxn);
-      //       await queue.append(objects);
-      //     },
-      //   }),
-    ].filter(isNonNullable),
-  );
-};
+import { ToolId } from '@dxos/ai';
+import { type SequenceDefinition, SequenceParser } from '@dxos/conductor';
 
 export const RESEARCH_SEQUENCE_DEFINITION: SequenceDefinition = {
   steps: [

package/src/testing/test-services.ts

@@ -4,16 +4,10 @@
 
 import { Obj } from '@dxos/echo';
 
-import {
-  type ApiAuthorization,
-  type BaseServiceRegistry,
-  type ServiceQuery,
-  ServiceType,
-  categoryIcons,
-} from '../types';
+import { type ApiAuthorization, type BaseServiceRegistry, ServiceType, categoryIcons } from '../types';
 
 export class MockServiceRegistry implements BaseServiceRegistry {
-  async queryServices(query?: ServiceQuery): Promise<ServiceType[]> {
+  async queryServices(): Promise<ServiceType[]> {
     return TEST_SERVICES;
   }
 }

package/src/translations.ts

@@ -2,13 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Blueprint, Template } from '@dxos/blueprints';
+import { Blueprint, Prompt } from '@dxos/blueprints';
 import { Sequence } from '@dxos/conductor';
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 
 import { meta } from './meta';
 import { Assistant } from './types';
 
+// TODO(burdon): Standardize translation names.
 export const translations = [
   {
     'en-US': {
@@ -22,14 +24,14 @@ export const translations = [
         'rename object label': 'Rename blueprint',
         'delete object label': 'Delete blueprint',
       },
-      [Template.Template.typename]: {
-        'typename label': 'Template',
-        'typename label_zero': 'Templates',
-        'typename label_one': 'Template',
-        'typename label_other': 'Templates',
-        'object name placeholder': 'New template',
-        'rename object label': 'Rename template',
-        'delete object label': 'Delete template',
+      [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',
       },
       // TODO(burdon): From conductor.
       [Sequence.typename]: {
@@ -42,19 +44,18 @@ export const translations = [
         'delete object label': 'Delete sequence',
       },
       [Assistant.Chat.typename]: {
-        'typename label': 'Assistant',
-        'typename label_zero': 'Assistants',
-        'typename label_one': 'Assistant',
-        'typename label_other': 'Assistants',
-        'object name placeholder': 'New assistant',
-        'rename object label': 'Rename assistant',
-        'delete object label': 'Delete assistant',
+        'typename label': 'AI Chat',
+        'object name placeholder': 'New AI Chat',
+        'rename object label': 'Rename AI Chat',
+        'delete object label': 'Delete AI Chat',
       },
+      // 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',
@@ -67,24 +68,41 @@ export const translations = [
         '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',
 
-        'sequence logs label': 'Logs',
+        'invocations label': 'Invocations',
 
         'assistant dialog title': 'Assistant',
         'open assistant label': 'Open assistant',
 
-        'no tools': 'No tools are configured.',
+        'no tools': 'No tools are configured',
+        'no results': 'No results',
 
-        'button save': 'Save',
-        'button run': 'Run',
+        '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',
+
+        'toolkit label': 'Toolkit',
+        'summary label': 'Summary',
 
         'search placeholder': 'Search...',
-        'prompt placeholder': 'Ask or search for anything...',
-        'context objects placeholder': 'Add to context...',
-        'button add blueprint': 'Configure blueprints',
-        'button microphone': 'Click to speak',
-        'button cancel processing': 'Stop processing',
-        'button scroll down': 'Scroll down',
+        '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',

package/src/types/Assistant.ts

@@ -0,0 +1,63 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Obj, Ref, Type } from '@dxos/echo';
+import { FormAnnotation, LabelAnnotation } from '@dxos/echo/internal';
+import { Queue } from '@dxos/echo-db';
+
+import { LLM_PROVIDERS } from './defs';
+
+/**
+ * AI chat.
+ */
+export const Chat = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+  queue: Type.Ref(Queue).pipe(FormAnnotation.set(false)),
+  // TODO(dmaretskyi): Eventually this and the message queue will be the same.
+  traceQueue: Type.Ref(Queue).pipe(FormAnnotation.set(false), Schema.optional),
+}).pipe(
+  Type.Obj({
+    typename: 'dxos.org/type/assistant/Chat',
+    version: '0.2.0',
+  }),
+  LabelAnnotation.set(['name']),
+);
+
+export interface Chat extends Schema.Schema.Type<typeof Chat> {}
+
+export const makeChat = ({ name, queue }: { name?: string; queue: Queue }) =>
+  Obj.make(Chat, { name, queue: Ref.fromDXN(queue.dxn) });
+
+/**
+ * Relation between a Chat and companion objects (e.g., artifacts).
+ */
+export const CompanionTo = Schema.Struct({
+  id: Type.ObjectId,
+}).pipe(
+  Type.Relation({
+    typename: 'dxos.org/relation/assistant/CompanionTo',
+    version: '0.1.0',
+    source: Chat,
+    target: Type.Expando,
+  }),
+);
+
+export interface CompanionTo extends Schema.Schema.Type<typeof CompanionTo> {}
+
+/**
+ * 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,79 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Blueprint, Prompt } from '@dxos/blueprints';
+import { EchoObjectSchema, SpaceSchema } from '@dxos/client/echo';
+import { Sequence } from '@dxos/conductor';
+import { Collection } from '@dxos/schema';
+
+import { meta } from '../meta';
+
+import { Chat } from './Assistant';
+
+// TODO(burdon): Name?
+export class onCreateSpace extends Schema.TaggedClass<onCreateSpace>()(`${meta.id}/on-space-created`, {
+  input: Schema.Struct({
+    space: SpaceSchema,
+    rootCollection: Collection.Collection,
+  }),
+  output: Schema.Void,
+}) {}
+
+export class CreateChat extends Schema.TaggedClass<CreateChat>()(`${meta.id}/action/create-chat`, {
+  input: Schema.Struct({
+    space: SpaceSchema,
+    name: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Chat,
+  }),
+}) {}
+
+export class UpdateChatName extends Schema.TaggedClass<UpdateChatName>()(`${meta.id}/action/update-name`, {
+  input: Schema.Struct({
+    chat: Chat,
+  }),
+  output: Schema.Void,
+}) {}
+
+export const BlueprintForm = Schema.Struct({
+  key: Schema.String,
+  name: Schema.String,
+  description: Schema.optional(Schema.String),
+});
+
+export class CreateBlueprint extends Schema.TaggedClass<CreateBlueprint>()(`${meta.id}/action/create-blueprint`, {
+  input: BlueprintForm,
+  output: Schema.Struct({
+    object: Blueprint.Blueprint,
+  }),
+}) {}
+
+export class CreatePrompt extends Schema.TaggedClass<CreatePrompt>()(`${meta.id}/action/create-prompt`, {
+  input: Schema.Struct({
+    name: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Prompt.Prompt,
+  }),
+}) {}
+
+export class CreateSequence extends Schema.TaggedClass<CreateSequence>()(`${meta.id}/action/create-sequence`, {
+  input: Schema.Struct({
+    name: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Sequence,
+  }),
+}) {}
+
+export class SetCurrentChat extends Schema.TaggedClass<SetCurrentChat>()(`${meta.id}/action/set-current-chat`, {
+  input: Schema.Struct({
+    companionTo: EchoObjectSchema,
+    chat: Chat.pipe(Schema.optional),
+  }),
+  output: Schema.Void,
+}) {}

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

@@ -2,5 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './schema';
+export * as Assistant from './Assistant';
+export * as AssistantAction from './AssistantAction';
+
+export * from './defs';
 export * from './service';

package/src/types/service.ts

@@ -2,12 +2,14 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { ComputeGraph } from '@dxos/conductor';
 import { Type } from '@dxos/echo';
-import { TypedObject } from '@dxos/echo-schema';
-import { FunctionType } from '@dxos/functions';
+import { TypedObject } from '@dxos/echo/internal';
+import { Function } from '@dxos/functions';
+
+// TODO(burdon): Factor out and reconcile with https://github.com/dxos/dxos/blob/main/packages/plugins/plugin-token-manager/src/defs/presets.ts#L7
 
 const ApiAuthorizationKey = Schema.Struct({
   type: Schema.Literal('api-key'),
@@ -36,7 +38,7 @@ export type ApiAuthorization = Schema.Schema.Type<typeof ApiAuthorization>;
 
 const ServiceInterfaceFunction = Schema.Struct({
   kind: Schema.Literal('function'),
-  fn: Type.Ref(FunctionType),
+  fn: Type.Ref(Function.Function),
 });
 
 const ServiceInterfaceWorkflow = Schema.Struct({
@@ -63,7 +65,13 @@ const ServiceInterfaceApi = Schema.Struct({
   authorization: Schema.optional(ApiAuthorization),
 });
 
-const ServiceInterface = Schema.Union(ServiceInterfaceFunction, ServiceInterfaceWorkflow, ServiceInterfaceApi);
+const ServiceInterface = Schema.Union(
+  // Service types.
+  ServiceInterfaceFunction,
+  ServiceInterfaceWorkflow,
+  ServiceInterfaceApi,
+);
+
 export type ServiceInterface = Schema.Schema.Type<typeof ServiceInterface>;
 
 export class ServiceType extends TypedObject({
@@ -86,15 +94,15 @@ export class ServiceType extends TypedObject({
 // Service Registry
 //
 
+export interface BaseServiceRegistry {
+  queryServices(query?: ServiceQuery): Promise<ServiceType[]>;
+}
+
 export type ServiceQuery = {
   name?: string;
   category?: string;
 };
 
-export interface BaseServiceRegistry {
-  queryServices(query?: ServiceQuery): Promise<ServiceType[]>;
-}
-
 export const categoryIcons: Record<string, string> = {
   finance: 'ph--bank--regular',
   health: 'ph--heart--regular',

package/src/vite-env.d.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/// <reference types="vite/client" />
+
+interface ViteTypeOptions {
+  // By adding this line, you can make the type of ImportMetaEnv strict
+  // to disallow unknown keys.
+  // strictImportMetaEnv: unknown
+}
+
+interface ImportMetaEnv {
+  readonly VITE_LINEAR_API_KEY: string | undefined;
+  // more env variables...
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}
+
+declare module '*.wav' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?raw' {
+  const content: string;
+  export default content;
+}