@dxos/assistant-toolkit 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

package/src/functions/research/research.test.ts

@@ -1,171 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { inspect } from 'node:util';
-
-import { describe, it } from '@effect/vitest';
-import * as Effect from 'effect/Effect';
-import * as Layer from 'effect/Layer';
-
-import { AiService, ConsolePrinter } from '@dxos/ai';
-import { MemoizedAiService, TestAiService } from '@dxos/ai/testing';
-import {
-  AiConversation,
-  type ContextBinding,
-  GenerationObserver,
-  makeToolExecutionServiceFromFunctions,
-  makeToolResolverFromFunctions,
-} from '@dxos/assistant';
-import { Blueprint } from '@dxos/blueprints';
-import { Database, Filter, Obj, Query, Ref } from '@dxos/echo';
-import { acquireReleaseResource } from '@dxos/effect';
-import { TestHelpers } from '@dxos/effect/testing';
-import { CredentialsService, FunctionInvocationService, QueueService, TracingService } from '@dxos/functions';
-import { FunctionInvocationServiceLayerTest, TestDatabaseLayer } from '@dxos/functions-runtime/testing';
-import { invariant } from '@dxos/invariant';
-import { ObjectId } from '@dxos/keys';
-import { MarkdownBlueprint } from '@dxos/plugin-markdown/blueprints';
-import { Markdown } from '@dxos/plugin-markdown/types';
-import { HasSubject, type Message, Organization } from '@dxos/types';
-
-import { ResearchBlueprint } from '../../blueprints';
-import { testToolkit } from '../../blueprints/testing';
-
-import { default as createDocument } from './document-create';
-import { default as research } from './research';
-import { ResearchGraph, queryResearchGraph } from './research-graph';
-import { ResearchDataTypes } from './types';
-
-ObjectId.dangerouslyDisableRandomness();
-
-const TestLayer = Layer.mergeAll(
-  AiService.model('@anthropic/claude-opus-4-0'),
-  makeToolResolverFromFunctions([research, createDocument, ...MarkdownBlueprint.functions], testToolkit),
-  makeToolExecutionServiceFromFunctions(testToolkit, testToolkit.toLayer({}) as any),
-).pipe(
-  Layer.provideMerge(
-    FunctionInvocationServiceLayerTest({
-      functions: [research, createDocument, ...MarkdownBlueprint.functions],
-    }),
-  ),
-  Layer.provideMerge(
-    Layer.mergeAll(
-      TestAiService(),
-      TestDatabaseLayer({
-        spaceKey: 'fixed',
-        indexing: { vector: true },
-        types: [...ResearchDataTypes, ResearchGraph, Blueprint.Blueprint, Markdown.Document, HasSubject.HasSubject],
-      }),
-      CredentialsService.configuredLayer([]),
-      TracingService.layerNoop,
-    ),
-  ),
-);
-
-describe('Research', () => {
-  it.effect(
-    'call a function to generate a research report',
-    Effect.fnUntraced(
-      function* (_) {
-        yield* Database.Service.add(
-          Obj.make(Organization.Organization, {
-            name: 'BlueYard',
-            website: 'https://blueyard.com',
-          }),
-        );
-        yield* Database.Service.flush({ indexes: true });
-        const result = yield* FunctionInvocationService.invokeFunction(research, {
-          query: 'Founders and portfolio of BlueYard.',
-        });
-
-        console.log(inspect(result, { depth: null, colors: true }));
-        console.log(JSON.stringify(result, null, 2));
-
-        yield* Database.Service.flush({ indexes: true });
-        const researchGraph = yield* queryResearchGraph();
-        if (researchGraph) {
-          const data = yield* Database.Service.load(researchGraph.queue).pipe(
-            Effect.flatMap((queue) => Effect.promise(() => queue.queryObjects())),
-          );
-          console.log(inspect(data, { depth: null, colors: true }));
-        }
-      },
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
-  );
-
-  it.scoped(
-    'create and update research report',
-    Effect.fnUntraced(
-      function* (_) {
-        const organization = yield* Database.Service.add(
-          Obj.make(Organization.Organization, {
-            name: 'BlueYard',
-            website: 'https://blueyard.com',
-          }),
-        );
-
-        const queue = yield* QueueService.createQueue<Message.Message | ContextBinding>();
-        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue }));
-
-        yield* Database.Service.flush({ indexes: true });
-        const researchBlueprint = yield* Database.Service.add(Obj.clone(ResearchBlueprint));
-        const markdownBlueprint = yield* Database.Service.add(Obj.clone(MarkdownBlueprint.make()));
-        yield* Effect.promise(() =>
-          conversation.context.bind({
-            blueprints: [Ref.make(researchBlueprint), Ref.make(markdownBlueprint)],
-            objects: [Ref.make(organization)],
-          }),
-        );
-
-        const observer = GenerationObserver.fromPrinter(new ConsolePrinter());
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: `Create a research summary about ${organization.name}.`,
-        });
-        {
-          const docs = yield* Database.Service.runQuery(
-            Query.select(Filter.id(organization.id)).targetOf(HasSubject.HasSubject).source(),
-          );
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 research document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: 'Add a section about their portfolio.',
-        });
-        {
-          const docs = yield* Database.Service.runQuery(
-            Query.select(Filter.id(organization.id)).targetOf(HasSubject.HasSubject).source(),
-          );
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 research document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-      },
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
-  );
-});

package/src/functions/research/research.ts

@@ -1,189 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Toolkit from '@effect/ai/Toolkit';
-import * as AnthropicTool from '@effect/ai-anthropic/AnthropicTool';
-import * as Array from 'effect/Array';
-import * as Effect from 'effect/Effect';
-import * as Function from 'effect/Function';
-import * as Layer from 'effect/Layer';
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import * as String from 'effect/String';
-
-import { AiService, ConsolePrinter } from '@dxos/ai';
-import {
-  AiSession,
-  GenerationObserver,
-  createToolkit,
-  makeToolExecutionServiceFromFunctions,
-  makeToolResolverFromFunctions,
-} from '@dxos/assistant';
-import { Template } from '@dxos/blueprints';
-import { type DXN, Entity, Obj } from '@dxos/echo';
-import { Database } from '@dxos/echo';
-import { TracingService, defineFunction } from '@dxos/functions';
-import { FunctionInvocationServiceLayerTestMocked } from '@dxos/functions-runtime/testing';
-import { type Message, Person } from '@dxos/types';
-import { trim } from '@dxos/util';
-
-import { LocalSearchHandler, LocalSearchToolkit, makeGraphWriterHandler, makeGraphWriterToolkit } from '../../crud';
-import { exaFunction, exaMockFunction } from '../exa';
-
-import { contextQueueLayerFromResearchGraph } from './research-graph';
-import PROMPT from './research-instructions.tpl?raw';
-import { ResearchDataTypes } from './types';
-
-/**
- * Exec external service and return the results as a Subgraph.
- */
-export default defineFunction({
-  key: 'dxos.org/function/research',
-  name: 'Research',
-  description: trim`
-    Search the web to research information about the given subject.
-    Inserts structured data into the research graph. 
-    Creates a research summary and returns the objects created.
-  `,
-  inputSchema: Schema.Struct({
-    query: Schema.String.annotations({
-      description: trim`
-        The search query.
-        If doing research on an object then load it first and pass it as JSON.
-      `,
-    }),
-
-    instructions: Schema.optional(Schema.String).annotations({
-      description: trim`
-        The instructions for the research agent. 
-      `,
-    }),
-
-    // TOOD(burdon): Move to context.
-    mockSearch: Schema.optional(Schema.Boolean).annotations({
-      description: 'Whether to use the mock search tool.',
-      default: false,
-    }),
-
-    entityExtraction: Schema.optional(Schema.Boolean).annotations({
-      description: trim`
-        Whether to extract structured entities from the research. 
-        Experimental feature only enable if user explicitly requests it.
-      `,
-      default: false,
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    document: Schema.optional(Schema.String).annotations({
-      description: 'The generated research document.',
-    }),
-    objects: Schema.Array(Schema.Unknown).annotations({
-      description: 'Structured objects created during the research process.',
-    }),
-  }),
-  handler: Effect.fnUntraced(
-    function* ({ data: { query, instructions, mockSearch = false, entityExtraction = false } }) {
-      if (mockSearch) {
-        const mockPerson = yield* Database.Service.add(
-          Obj.make(Person.Person, {
-            preferredName: 'John Doe',
-            emails: [{ value: 'john.doe@example.com' }],
-            phoneNumbers: [{ value: '123-456-7890' }],
-          }),
-        );
-
-        return {
-          document: trim`
-            The research ran in test-mode and was mocked. Proceed as usual.
-            We reference John Doe to test reference: ${Obj.getDXN(mockPerson)}
-          `,
-          objects: [Obj.toJSON(mockPerson)],
-        };
-      }
-
-      yield* Database.Service.flush({ indexes: true });
-      yield* TracingService.emitStatus({ message: 'Starting research...' });
-
-      const NativeWebSearch = Toolkit.make(AnthropicTool.WebSearch_20250305({}));
-
-      let toolkit: Toolkit.Any = NativeWebSearch;
-      let handlers: Layer.Layer<any, any> = Layer.empty as any;
-
-      const objectDXNs: DXN[] = [];
-      if (entityExtraction) {
-        const GraphWriterToolkit = makeGraphWriterToolkit({ schema: ResearchDataTypes });
-        const GraphWriterHandler = makeGraphWriterHandler(GraphWriterToolkit, {
-          onAppend: (dxns) => objectDXNs.push(...dxns),
-        });
-
-        toolkit = Toolkit.merge(toolkit, LocalSearchToolkit, GraphWriterToolkit);
-        handlers = Layer.mergeAll(handlers, LocalSearchHandler, GraphWriterHandler).pipe(
-          Layer.provide(contextQueueLayerFromResearchGraph),
-        ) as any;
-      }
-
-      const finishedToolkit = yield* createToolkit({ toolkit }).pipe(Effect.provide(handlers));
-
-      const session = new AiSession();
-      const result = yield* session.run({
-        prompt: query,
-        system: join(
-          Template.process(PROMPT, { entityExtraction }),
-          instructions && `<instructions>${instructions}</instructions>`,
-        ),
-        toolkit: finishedToolkit,
-        observer: GenerationObserver.fromPrinter(new ConsolePrinter({ tag: 'research' })),
-      });
-
-      const objects = yield* Effect.forEach(objectDXNs, (dxn) => Database.Service.resolve(dxn)).pipe(
-        Effect.map(Array.map((obj) => Entity.toJSON(obj))),
-      );
-
-      return {
-        document: extractLastTextBlock(result),
-        objects,
-      };
-    },
-    Effect.provide(
-      Layer.mergeAll(
-        AiService.model('@anthropic/claude-sonnet-4-0'),
-        // TODO(dmaretskyi): Extract.
-        makeToolResolverFromFunctions([exaFunction, exaMockFunction], Toolkit.make()),
-        makeToolExecutionServiceFromFunctions(Toolkit.make() as any, Layer.empty as any),
-      ).pipe(
-        Layer.provide(
-          // TODO(dmaretskyi): This should be provided by environment.
-          Layer.mergeAll(FunctionInvocationServiceLayerTestMocked({ functions: [exaFunction, exaMockFunction] })),
-        ),
-      ),
-    ),
-  ),
-});
-
-// TODO(burdon): Factor out.
-const join = (...strings: (string | undefined)[]) => strings.filter(Boolean).join('\n\n');
-
-/**
- * Extracts the last text block from the result.
- * Skips citations.
- */
-// TODO(burdon): Factor out.
-const extractLastTextBlock = (result: Message.Message[]) => {
-  return Function.pipe(
-    result,
-    Array.last,
-    Option.map(
-      Function.flow(
-        (_: Message.Message) => _.blocks,
-        Array.reverse,
-        Array.dropWhile((_: any) => _._tag === 'summary'),
-        Array.takeWhile((_: any) => _._tag === 'text'),
-        Array.reverse,
-        Array.map((_: any) => _.text),
-        Array.reduce('', String.concat),
-      ),
-    ),
-    Option.getOrElse(() => ''),
-  );
-};

package/src/functions/tasks/index.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { default as read$ } from './read';
-import { default as update$ } from './update';
-
-export namespace Tasks {
-  export const read = read$;
-  export const update = update$;
-}

package/src/functions/tasks/read.ts

@@ -1,35 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId } from '@dxos/assistant';
-import { Database } from '@dxos/echo';
-import { defineFunction } from '@dxos/functions';
-import { Markdown } from '@dxos/plugin-markdown/types';
-
-export default defineFunction({
-  key: 'dxos.org/function/markdown/read-tasks',
-  name: 'Read',
-  description: 'Read markdown tasks.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the document to read.',
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    content: Schema.String,
-  }),
-  handler: Effect.fn(function* ({ data: { id } }) {
-    const doc = yield* Database.Service.resolve(ArtifactId.toDXN(id), Markdown.Document);
-
-    // Return content with line numbers prefixed.
-    const { content } = yield* Database.Service.load(doc.content);
-    const lines = content.split('\n');
-    const len = String(lines.length).length;
-    const numbered = lines.map((line, i) => `${String(i + 1).padStart(len, ' ')}. ${line}`).join('\n');
-    return { content: numbered };
-  }),
-});

package/src/functions/tasks/update.ts

@@ -1,53 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId } from '@dxos/assistant';
-import { Database } from '@dxos/echo';
-import { defineFunction } from '@dxos/functions';
-import { Markdown } from '@dxos/plugin-markdown/types';
-
-import { MarkdownTasks, type TaskOperation } from './task-list';
-
-export default defineFunction({
-  key: 'dxos.org/function/markdown/update-tasks',
-  name: 'Update markdown',
-  description: 'Creates and updates tasks in markdown documents.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the document to update.',
-    }),
-    operations: Schema.optional(
-      Schema.Array(
-        Schema.Any.annotations({
-          description: 'Task operations to apply.',
-        }),
-      ),
-    ),
-  }),
-  outputSchema: Schema.Struct({
-    content: Schema.String,
-    numberedContent: Schema.String.annotations({
-      description: 'Content with line numbers for agent reference.',
-    }),
-  }),
-  handler: Effect.fn(function* ({ data: { id, operations = [] } }) {
-    const doc = yield* Database.Service.resolve(ArtifactId.toDXN(id), Markdown.Document);
-
-    // Create task manager and apply operations if provided.
-    const { content } = yield* Database.Service.load(doc.content);
-    const taskManager = new MarkdownTasks(content);
-    if (operations.length > 0) {
-      taskManager.applyOperations(operations as TaskOperation[]);
-      // TODO: Update the document content when database operations are fixed.
-    }
-
-    return {
-      content: taskManager.getRawContent(),
-      numberedContent: taskManager.getNumberedContent(),
-    };
-  }),
-});

package/src/initiative/Initiative.ts

@@ -1,99 +0,0 @@
-//
-// Copyright 2026 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { AiContextBinder, type ContextBinding } from '@dxos/assistant';
-import { Blueprint, Template } from '@dxos/blueprints';
-import { Database, Obj, Ref } from '@dxos/echo';
-import { QueueService } from '@dxos/functions';
-import { Text } from '@dxos/schema';
-import type { Message } from '@dxos/types';
-import { trim } from '@dxos/util';
-
-import { agent, getContext, update } from './functions';
-import { Initiative, PLAN_ARTIFACT_NAME, SPEC_ARTIFACT_NAME } from './InitiativeSchema';
-
-export { Initiative, PLAN_ARTIFACT_NAME, SPEC_ARTIFACT_NAME } from './InitiativeSchema';
-export type { Initiative as InitiativeType } from './InitiativeSchema';
-
-export const make = (
-  props: Omit<Obj.MakeProps<typeof Initiative>, 'artifacts' | 'chat'> &
-    Partial<Pick<Obj.MakeProps<typeof Initiative>, 'artifacts'>> & {
-      spec: string;
-      plan?: string;
-      blueprints?: Ref.Ref<Blueprint.Blueprint>[];
-      contextObjects?: Ref.Ref<Obj.Any>[];
-    },
-): Effect.Effect<Initiative, never, QueueService | Database.Service> =>
-  Effect.gen(function* () {
-    const initiative = Obj.make(Initiative, {
-      ...props,
-      artifacts: [
-        {
-          name: SPEC_ARTIFACT_NAME,
-          data: Ref.make(Text.make(props.spec)),
-        },
-        {
-          name: PLAN_ARTIFACT_NAME,
-          data: Ref.make(Text.make(props.plan ?? '')),
-        },
-        ...(props.artifacts ?? []),
-      ],
-    });
-    yield* Database.Service.add(initiative);
-    const queue = yield* QueueService.createQueue<Message.Message | ContextBinding>();
-    const contextBinder = new AiContextBinder({ queue });
-    const initiativeBlueprint = yield* Database.Service.add(Obj.clone(InitiativeBlueprint, { deep: true }));
-    yield* Effect.promise(() =>
-      contextBinder.bind({
-        blueprints: [Ref.make(initiativeBlueprint), ...(props.blueprints ?? [])],
-        objects: [Ref.make(initiative), ...(props.contextObjects ?? [])],
-      }),
-    );
-    Obj.change(initiative, (initiative) => {
-      initiative.chat = Ref.fromDXN(queue.dxn);
-    });
-
-    return initiative;
-  });
-
-export const functions = [getContext, update, agent];
-
-export const InitiativeBlueprint = Blueprint.make({
-  key: 'dxos.org/blueprint/initiative',
-  name: 'Initiative blueprint',
-  instructions: Template.make({
-    source: trim`
-      You work on an initiative. Each initiative has a spec - the goal of the initiative.
-      The initiative plan shows the current progress of the initiative.
-      Initiative has an number of associated artifacts you can read/write.
-      Spec and plan are also artifacts.
-      You can edit them if necessary.
-      
-      {{#with initiative}}
-        Initiative spec:
-          {{spec.dxn}}
-          {{spec.content}}
-
-        Initiative plan:
-          {{plan.dxn}}
-          {{plan.content}}
-
-        All artifacts:
-        {{#each artifacts}}
-          {{name}}: {{type}} {{dxn}}
-        {{/each}}
-      {{/with}}
-    `,
-    inputs: [
-      {
-        name: 'initiative',
-        kind: 'function',
-        function: 'dxos.org/function/initiative/get-context',
-      },
-    ],
-  }),
-  tools: Blueprint.toolDefinitions({ functions: [update] }),
-});

package/src/initiative/InitiativeSchema.ts

@@ -1,37 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Type } from '@dxos/echo';
-import { Queue } from '@dxos/echo-db';
-
-/**
- * Initiative schema definition.
- */
-export const Initiative = Schema.Struct({
-  name: Schema.String,
-  artifacts: Schema.Array(
-    Schema.Struct({
-      name: Schema.String,
-      data: Type.Ref(Type.Obj),
-    }),
-  ),
-
-  // TODO(dmaretskyi): Consider using chat type.
-  // TODO(dmaretskyi): Multiple chats.
-  chat: Schema.optional(Type.Ref(Queue)),
-
-  // TODO(dmaretskyi): Triggers & input queue.
-}).pipe(
-  Type.object({
-    typename: 'dxos.org/type/Initiative',
-    version: '0.1.0',
-  }),
-);
-export interface Initiative extends Schema.Schema.Type<typeof Initiative> {}
-
-export const SPEC_ARTIFACT_NAME = 'Spec';
-
-export const PLAN_ARTIFACT_NAME = 'Plan';

package/src/initiative/functions/agent.ts

@@ -1,57 +0,0 @@
-//
-// Copyright 2026 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { AiContextService, AiConversation } from '@dxos/assistant';
-import { Database, Obj, Type } from '@dxos/echo';
-import { acquireReleaseResource } from '@dxos/effect';
-import { TriggerEvent, defineFunction } from '@dxos/functions';
-import { invariant } from '@dxos/invariant';
-
-import * as Initiative from '../InitiativeSchema';
-
-export default defineFunction({
-  key: 'dxos.org/function/initiative/agent',
-  name: 'Initiative Agent',
-  description: 'Agentic worker that drives the initiative autonomously.',
-  inputSchema: Schema.Struct({
-    initiative: Schema.suspend(() => Type.Ref(Initiative.Initiative)),
-    prompt: Schema.optional(Schema.String),
-    event: Schema.optional(TriggerEvent.TriggerEvent),
-  }),
-  outputSchema: Schema.Void,
-  services: [AiContextService],
-  handler: Effect.fnUntraced(function* ({ data }) {
-    const initiative = yield* Database.Service.load(data.initiative);
-    invariant(Obj.instanceOf(Initiative.Initiative, initiative));
-    invariant(initiative.chat, 'Initiative has no chat.');
-    const chatQueue = yield* Database.Service.load(initiative.chat!);
-    invariant(chatQueue, 'Initiative chat queue not found.');
-    const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue: chatQueue as any }));
-
-    const iniativesInContext = conversation.context.getObjects().filter(Obj.instanceOf(Initiative.Initiative));
-    if (iniativesInContext.length !== 1) {
-      throw new Error('There should be exactly one initiative in context. Got: ' + iniativesInContext.length);
-    }
-
-    if (!data.prompt && !data.event) {
-      throw new Error('Either prompt or event must be provided.');
-    }
-
-    let input = '';
-    if (data.prompt) {
-      input += `${data.prompt}\n\n`;
-    }
-    if (data.event) {
-      input += `<event>\n${JSON.stringify(data.event, null, 2)}\n</event>\n\n`;
-    }
-
-    yield* conversation.createRequest({
-      prompt: input,
-      // observer: GenerationObserver.fromPrinter(new ConsolePrinter()),
-    });
-  }, Effect.scoped) as any, // TODO(dmaretskyi): Services don't align -- need to refactor how functions are defined.
-});