@dxos/assistant-toolkit 0.8.4-main.ae835ea → 0.8.4-main.bc2380dfbc

package/src/blueprints/database/blueprint.test.ts

@@ -0,0 +1,531 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { Blueprint, Operation } from '@dxos/compute';
+import { Database, Entity, Feed, Filter, Obj, Query, Ref, Relation, Tag } from '@dxos/echo';
+import { TestHelpers } from '@dxos/effect/testing';
+import { AgentService } from '@dxos/functions-runtime';
+import { AssistantTestLayer } from '@dxos/functions-runtime/testing';
+import { ObjectId } from '@dxos/keys';
+import { Employer, Organization, Person } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+import DatabaseBlueprint from './blueprint';
+import { DatabaseHandlers } from './functions';
+import { Query as DatabaseQueryOperation } from './functions/definitions';
+
+ObjectId.dangerouslyDisableRandomness();
+
+const TestLayer = AssistantTestLayer({
+  operationHandlers: DatabaseHandlers,
+  types: [Organization.Organization, Person.Person, Employer.Employer, Tag.Tag, Blueprint.Blueprint, Feed.Feed],
+  blueprints: [DatabaseBlueprint.make()],
+  tracing: 'pretty',
+  aiServicePreset: 'edge-remote',
+});
+
+describe('Database Blueprint', () => {
+  //
+  // Schema
+  //
+
+  it.effect(
+    'schema-list: list available schemas',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt('List all available schemas. Tell me what typenames are available.');
+        yield* agent.waitForCompletion();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'schema-add: add a new schema',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt(
+          'Add a new schema called "Project" with typename "com.example.type.project" and fields: name (string), description (string), and status (string).',
+        );
+        yield* agent.waitForCompletion();
+        const schemas = yield* Database.runSchemaQuery({
+          typename: 'com.example.type.project',
+          location: ['database', 'runtime'],
+        });
+        expect(schemas.length).toBeGreaterThanOrEqual(1);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  //
+  // Objects
+  //
+
+  it.effect(
+    'object-create: create an object',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt('Create a new organization called "Cyberdyne Systems".');
+        yield* agent.waitForCompletion();
+        const orgs = yield* Database.runQuery(Query.type(Organization.Organization, { name: 'Cyberdyne Systems' }));
+        expect(orgs).toHaveLength(1);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'object-create: create an object with a reference',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt(
+          'Create a preson fullName="John Doe" with a reference to the organization "Cyberdyne Systems".',
+        );
+        yield* agent.waitForCompletion();
+        const orgs = yield* Database.runQuery(Query.type(Organization.Organization, { name: 'Cyberdyne Systems' }));
+        const persons = yield* Database.runQuery(Query.type(Person.Person, { fullName: 'John Doe' }));
+        expect(orgs).toHaveLength(1);
+        expect(persons).toHaveLength(1);
+        expect(persons[0].organization?.target).toBe(orgs[0]);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'object-delete: delete an object',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Obsolete Corp' }));
+        yield* agent.submitPrompt(`Delete the organization "Obsolete Corp".`);
+        yield* agent.waitForCompletion();
+        expect(Obj.isDeleted(org)).toBe(true);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'object-update: update an object',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Old Name Inc' }));
+        yield* agent.submitPrompt(`Update the organization "Old Name Inc" and change its name to "New Name Corp".`);
+        yield* agent.waitForCompletion();
+        expect(org.name).toBe('New Name Corp');
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  //
+  // Query & Load
+  //
+
+  it.effect(
+    'query: search for objects',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* Database.add(Obj.make(Organization.Organization, { name: 'Acme Corp' }));
+        yield* Database.add(Obj.make(Organization.Organization, { name: 'Globex Industries' }));
+        yield* agent.submitPrompt('Search for all organizations. How many are there?');
+        yield* agent.waitForCompletion();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'load: load object details',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(
+          Obj.make(Organization.Organization, { name: 'Detail Corp', description: 'A detailed organization.' }),
+        );
+        const dxn = Obj.getDXN(org).toString();
+        yield* agent.submitPrompt(`Load the full details of object ${dxn}. What is its description?`);
+        yield* agent.waitForCompletion();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  //
+  // Relations
+  //
+
+  it.effect(
+    'relation-create: create a relation between objects',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* Database.add(Obj.make(Person.Person, { fullName: 'John Connor' }));
+        yield* Database.add(Obj.make(Organization.Organization, { name: 'Cyberdyne Systems' }));
+        yield* agent.submitPrompt(
+          `Create an Employer relation from person "John Connor" to organization "Cyberdyne Systems" with role "Engineer". List schemas first to find the relation typename.`,
+        );
+        yield* agent.waitForCompletion();
+        const relations = yield* Database.runQuery(Query.type(Employer.Employer));
+        expect(relations.length).toBeGreaterThanOrEqual(1);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'relation-delete: delete a relation',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const person = yield* Database.add(Obj.make(Person.Person, { fullName: 'Sarah Connor' }));
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Cyberdyne Systems' }));
+        const relation = yield* Database.add(
+          Relation.make(Employer.Employer, {
+            [Relation.Source]: person,
+            [Relation.Target]: org,
+            role: 'Director',
+          }),
+        );
+        const relationDXN = Relation.getDXN(relation).toString();
+        yield* agent.submitPrompt(`Delete the relation ${relationDXN}.`);
+        yield* agent.waitForCompletion();
+        expect(Relation.isDeleted(relation)).toBe(true);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  //
+  // Tags
+  //
+
+  it.effect(
+    'tag-add: add a tag to an object',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Tagged Corp' }));
+        const tag = yield* Database.add(Tag.make({ label: 'important' }));
+        yield* agent.submitPrompt(`Add tag "important" to the organization "Tagged Corp".`);
+        yield* agent.waitForCompletion();
+        const tags = Obj.getMeta(org).tags ?? [];
+        // TODO(dmaretskyi): matcher doesnt work with echo proxies.
+        expect([...tags]).toContain(Obj.getDXN(tag).toString());
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'tag-remove: remove a tag from an object',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Untagged Corp' }));
+        const tag = yield* Database.add(Tag.make({ label: 'obsolete' }));
+        const tagDXN = Obj.getDXN(tag).toString();
+        Entity.update(org, (org) => Entity.addTag(org, tagDXN));
+        expect(Obj.getMeta(org).tags ?? []).toContain(tagDXN);
+        yield* agent.submitPrompt(`Remove tag "obsolete" from the organization "Untagged Corp".`);
+        yield* agent.waitForCompletion();
+        const tags = Obj.getMeta(org).tags ?? [];
+        // TODO(dmaretskyi): matcher doesnt work with echo proxies.
+        expect([...tags]).not.toContain(tagDXN);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  //
+  // Context
+  //
+
+  it.effect(
+    'context-add: add object to chat context',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* Database.add(Obj.make(Organization.Organization, { name: 'Context Corp' }));
+        yield* agent.submitPrompt(`Add the organization "Context Corp" to the chat context.`);
+        yield* agent.waitForCompletion();
+        const contextRefs = yield* agent.getContext();
+        expect(contextRefs.length).toBeGreaterThanOrEqual(1);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'context-remove: remove object from chat context',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        const org = yield* Database.add(Obj.make(Organization.Organization, { name: 'Remove Context Corp' }));
+        const { db } = yield* Database.Service;
+        const ref = db.makeRef(Obj.getDXN(org)) as Ref.Ref<any>;
+        yield* agent.addContext([ref]);
+        const dxn = Obj.getDXN(org).toString();
+        yield* agent.submitPrompt(`Remove the organization "Remove Context Corp" from the chat context.`);
+        yield* agent.waitForCompletion();
+        const contextRefs = yield* agent.getContext();
+        const found = contextRefs.find((contextRef) => contextRef.dxn.toString() === dxn);
+        expect(found).toBeUndefined();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'query: includeQueues finds mock email in feed (agent uses Query tool)',
+    Effect.fnUntraced(
+      function* (_) {
+        const feed = Feed.make();
+        yield* Database.add(feed);
+        yield* Feed.append(feed, [
+          Obj.make(Organization.Organization, {
+            name: 'Lot Booking Co',
+            description: 'Mock email body: your parking reservation is confirmed.',
+          }),
+        ]);
+        yield* Database.flush();
+
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt(trim`
+          A mock email was stored only on a feed (queue), not as a regular space document: organization "Lot Booking Co"
+          mentioning a parking reservation.
+
+          Use the Query tool once: full-text "reservation", includeQueues true, includeContent false, limit 20.
+          Confirm the results include Lot Booking Co.
+        `);
+        yield* agent.waitForCompletion();
+
+        const { db } = yield* Database.Service;
+        const spaceOnly = yield* Database.runQuery(
+          Query.select(Filter.text('reservation', { type: 'full-text' })).limit(20),
+        );
+        expect(spaceOnly).toHaveLength(0);
+
+        const withFeeds = yield* Database.runQuery(
+          Query.select(Filter.text('reservation', { type: 'full-text' }))
+            .from(db, { includeFeeds: true })
+            .limit(20),
+        );
+        expect(withFeeds.length).toBeGreaterThanOrEqual(1);
+        expect(
+          withFeeds.some(
+            (obj) =>
+              Obj.getTypename(obj) === 'org.dxos.type.organization' &&
+              String(Obj.getLabel(obj) ?? '').includes('Lot Booking'),
+          ),
+        ).toBe(true);
+
+        const byTypename = yield* Database.runQuery(
+          Query.type(Organization.Organization).from(db, { includeFeeds: true }).limit(20),
+        );
+        expect(byTypename.length).toBeGreaterThanOrEqual(1);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'query operation: includeQueues via invokeFunction',
+    Effect.fnUntraced(
+      function* ({ expect }) {
+        const feed = Feed.make();
+        yield* Database.add(feed);
+        yield* Feed.append(feed, [
+          Obj.make(Organization.Organization, {
+            name: 'Invoke Op Lot Co',
+            description: 'Feed-only mock email op-search-token-7f3a2c91 reservation line.',
+          }),
+        ]);
+        yield* Database.flush();
+
+        const noQueues = yield* Operation.invoke(DatabaseQueryOperation, {
+          text: 'op-search-token-7f3a2c91',
+          includeQueues: false,
+          limit: 20,
+        });
+        expect(noQueues).toHaveLength(0);
+
+        const withQueues = yield* Operation.invoke(DatabaseQueryOperation, {
+          text: 'op-search-token-7f3a2c91',
+          includeQueues: true,
+          limit: 20,
+        });
+        type QueryRow = { typename?: string; label?: string };
+        expect(withQueues.length).toBeGreaterThanOrEqual(1);
+        expect(
+          (withQueues as QueryRow[]).some(
+            (row) => row.typename === 'org.dxos.type.organization' && String(row.label ?? '').includes('Invoke Op Lot'),
+          ),
+        ).toBe(true);
+
+        const byTypename = yield* Operation.invoke(DatabaseQueryOperation, {
+          typename: 'org.dxos.type.organization',
+          includeQueues: true,
+          limit: 20,
+        });
+        expect(byTypename.length).toBeGreaterThanOrEqual(1);
+        expect(
+          (byTypename as QueryRow[]).some(
+            (row) => row.typename === 'org.dxos.type.organization' && String(row.label ?? '').includes('Invoke Op Lot'),
+          ),
+        ).toBe(true);
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+  );
+
+  it.effect(
+    'query: in param scopes to feed children (agent uses Query tool)',
+    Effect.fnUntraced(
+      function* (_) {
+        const feed1 = Feed.make({ name: 'inbox-1' });
+        yield* Database.add(feed1);
+        yield* Feed.append(feed1, [
+          Obj.make(Organization.Organization, {
+            name: 'Email Corp Alpha',
+            description: 'Mock email in-param-token-a1b2c3.',
+          }),
+        ]);
+
+        const feed2 = Feed.make({ name: 'inbox-2' });
+        yield* Database.add(feed2);
+        yield* Feed.append(feed2, [
+          Obj.make(Organization.Organization, {
+            name: 'Email Corp Beta',
+            description: 'Mock email in-param-token-d4e5f6.',
+          }),
+        ]);
+        yield* Database.flush();
+
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt('Query for organizations in "inbox-1" feed.');
+        yield* agent.waitForCompletion();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+
+  it.effect(
+    'query operation: in param can be passed as string',
+    Effect.fnUntraced(
+      function* (_) {
+        const feed1 = Feed.make({ name: 'inbox-1' });
+        yield* Database.add(feed1);
+        yield* Feed.append(feed1, [
+          Obj.make(Organization.Organization, {
+            name: 'Email Corp Alpha',
+            description: 'Mock email in-param-invoke-token-a1b2c3.',
+          }),
+        ]);
+
+        const feed2 = Feed.make({ name: 'inbox-2' });
+        yield* Database.add(feed2);
+        yield* Feed.append(feed2, [
+          Obj.make(Organization.Organization, {
+            name: 'Email Corp Beta',
+            description: 'Mock email in-param-invoke-token-d4e5f6.',
+          }),
+        ]);
+        yield* Database.flush();
+
+        const agent = yield* AgentService.createSession({
+          blueprints: [DatabaseBlueprint.make()],
+        });
+        yield* agent.submitPrompt(
+          `Call query tool with precisely ${JSON.stringify({
+            includeContent: false,
+            limit: 10,
+            typename: Organization.Organization.typename,
+            in: [Obj.getDXN(feed1).toString()],
+          })}`,
+        );
+        yield* agent.waitForCompletion();
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    { timeout: 60_000 },
+  );
+});

package/src/blueprints/database/blueprint.ts

@@ -0,0 +1,66 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Blueprint } from '@dxos/compute';
+import { Ref } from '@dxos/echo';
+import { Text } from '@dxos/schema';
+import { trim } from '@dxos/util';
+
+import {
+  Query,
+  Load,
+  ObjectCreate,
+  ObjectUpdate,
+  ObjectDelete,
+  SchemaAdd,
+  SchemaList,
+  ContextAdd,
+  ContextRemove,
+  RelationCreate,
+  RelationDelete,
+  TagAdd,
+  TagRemove,
+} from './functions';
+
+const BLUEPRINT_KEY = 'org.dxos.blueprint.database';
+
+const instructions = trim`
+  You can query, create, update, and delete objects in ECHO.
+  You can manage schemas, relations, tags, and add objects to the chat context.
+`;
+
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Database',
+    description: 'Query and manipulate objects in the ECHO database.',
+    agentCanEnable: true,
+    instructions: {
+      source: Ref.make(Text.make({ content: instructions })),
+    },
+    tools: Blueprint.toolDefinitions({
+      operations: [
+        ContextAdd,
+        ContextRemove,
+        Load,
+        ObjectCreate,
+        ObjectDelete,
+        ObjectUpdate,
+        Query,
+        RelationCreate,
+        RelationDelete,
+        SchemaAdd,
+        SchemaList,
+        TagAdd,
+        TagRemove,
+      ],
+    }),
+  });
+
+const blueprint: Blueprint.Definition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

package/src/blueprints/database/functions/context-add.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { AiContext } from '@dxos/assistant';
+import { Operation } from '@dxos/compute';
+
+import { ContextAdd } from './definitions';
+
+export default ContextAdd.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ obj }) {
+      const { binder } = yield* AiContext.Service;
+      yield* Effect.promise(() =>
+        binder.bind({
+          blueprints: [],
+          objects: [obj],
+        }),
+      );
+    }),
+  ),
+);

package/src/blueprints/database/functions/context-remove.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { AiContext } from '@dxos/assistant';
+import { Operation } from '@dxos/compute';
+
+import { ContextRemove } from './definitions';
+
+export default ContextRemove.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ obj }) {
+      const { binder } = yield* AiContext.Service;
+      yield* Effect.promise(() =>
+        binder.unbind({
+          blueprints: [],
+          objects: [obj],
+        }),
+      );
+    }) as any,
+  ),
+);