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

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

@@ -0,0 +1,579 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+
+import { MemoizedAiService } from '@dxos/ai/testing';
+import { AiConversation } from '@dxos/assistant';
+import { AssistantTestLayerWithTriggers } from '@dxos/assistant/testing';
+import { Blueprint } from '@dxos/blueprints';
+import { SpaceProperties } from '@dxos/client-protocol';
+import { Database, Obj, Ref } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { acquireReleaseResource } from '@dxos/effect';
+import { TestHelpers } from '@dxos/effect/testing';
+import { FunctionDefinition, QueueService, Trigger } from '@dxos/functions';
+import { TriggerDispatcher } from '@dxos/functions-runtime';
+import { invariant } from '@dxos/invariant';
+import { ObjectId } from '@dxos/keys';
+import { MarkdownBlueprint } from '@dxos/plugin-markdown/blueprints';
+import { WithProperties } from '@dxos/plugin-markdown/testing';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { Text } from '@dxos/schema';
+import { Message } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+import { Chat, Plan, Project } from '../../types';
+import { PlanningBlueprint } from '../planning';
+
+import ProjectBlueprintDef from './blueprint';
+import { ProjectFunctions } from './functions';
+
+ObjectId.dangerouslyDisableRandomness();
+
+const TestLayer = AssistantTestLayerWithTriggers({
+  aiServicePreset: 'edge-remote',
+  functions: [...Object.values(ProjectFunctions), ...MarkdownBlueprint.functions],
+  types: [
+    Project.Project,
+    Plan.Plan,
+    Chat.CompanionTo,
+    Chat.Chat,
+    SpaceProperties,
+    Blueprint.Blueprint,
+    Trigger.Trigger,
+    Text.Text,
+    Markdown.Document,
+    Collection.Collection,
+  ],
+  tracing: 'pretty',
+});
+
+const SYSTEM = trim`
+  You are a helpful assistant that can help with tasks in the outside world.
+  Be transparent about what you are doing and what you are not doing.
+  If you do not have tools to complete the task, inform the user.
+  DO NOT PRETEND TO DO SOMETHING YOU CAN'T DO.
+`;
+
+describe.runIf(TestHelpers.tagEnabled('flaky'))('Project', () => {
+  const blueprint = ProjectBlueprintDef.make();
+  it.scoped(
+    'shopping list',
+    Effect.fnUntraced(
+      function* (_) {
+        const project = yield* Database.add(
+          yield* Project.makeInitialized(
+            {
+              name: 'Shopping list',
+              spec: 'Keep a shopping list of items to buy.',
+              blueprints: [Ref.make(MarkdownBlueprint.make())],
+            },
+            blueprint,
+          ),
+        );
+        const chatQueue = project.chat?.target?.queue?.target as any;
+        invariant(chatQueue, 'Project chat queue not found.');
+        yield* Database.flush({ indexes: true });
+        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue: chatQueue }));
+        yield* Effect.promise(() => conversation.context.open());
+
+        yield* conversation.createRequest({
+          system: SYSTEM,
+          prompt: `List ingredients for a scrambled eggs on a toast breakfast.`,
+        });
+
+        console.log(yield* Effect.promise(() => dumpProject(project)));
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+
+  it.scoped(
+    'expense tracking list',
+    Effect.fnUntraced(
+      function* (_) {
+        const project = yield* Database.add(
+          yield* Project.makeInitialized(
+            {
+              name: 'Expense tracking',
+              spec: trim`
+                Keep a list of expenses in a markdown document (create artifact "Expenses").
+                Process incoming emails, add the relevant ones to the list.
+
+                Format:
+
+                ## Expenses
+                - Flight to London (2026-02-01): £100
+                - Hotel in London (2026-02-01): £100
+              `,
+              blueprints: [Ref.make(MarkdownBlueprint.make())],
+            },
+            blueprint,
+          ),
+        );
+        yield* Database.flush({ indexes: true });
+
+        const inboxQueue = yield* QueueService.createQueue();
+        yield* Database.add(
+          Trigger.make({
+            enabled: true,
+            spec: {
+              kind: 'queue',
+              queue: inboxQueue.dxn.toString(),
+            },
+            function: Ref.make(FunctionDefinition.serialize(ProjectFunctions.Agent)),
+            input: {
+              project: Ref.make(project),
+              event: '{{event}}',
+            },
+          }),
+        );
+
+        yield* QueueService.append(
+          inboxQueue,
+          TEST_MESSAGES.map((message) => Obj.clone(message)),
+        );
+
+        const dispatcher = yield* TriggerDispatcher;
+        const invocations = yield* dispatcher.invokeScheduledTriggers({ kinds: ['queue'], untilExhausted: true });
+        expect(invocations.every((invocation) => Exit.isSuccess(invocation.result))).toBe(true);
+
+        console.log(yield* Effect.promise(() => dumpProject(project)));
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+
+  it.scoped(
+    'planning',
+    Effect.fnUntraced(
+      function* (_) {
+        const project = yield* Database.add(
+          yield* Project.makeInitialized(
+            {
+              name: 'Egg making',
+              spec: trim`
+                I'm testing how planning (task management) works.
+                Create tasks to make scrambled eggs.
+
+                Then simulate this plan execution in a markdown document.
+                The document should reflect the state of all objects involved in the cooking process.
+                The document should also have the log of actions taken.
+
+                Important: simualte actions one by one, in the order they are listed.
+                Simlate by updating the local document.
+
+                <example>
+                  # State
+
+                  - 2 raw eggs
+                  - 1 frying pan
+                  
+                  # Action log
+                  
+                  - Taken 2 raw eggs out of the fridge.
+                </example>
+              `,
+              blueprints: [Ref.make(MarkdownBlueprint.make()), Ref.make(Obj.clone(PlanningBlueprint.make()))],
+            },
+            blueprint,
+          ),
+        );
+        yield* Database.flush({ indexes: true });
+
+        const chatQueue = project.chat?.target?.queue?.target as any;
+        invariant(chatQueue, 'Project chat queue not found.');
+        yield* Database.flush({ indexes: true });
+        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue: chatQueue }));
+        yield* Effect.promise(() => conversation.context.open());
+
+        yield* conversation.createRequest({
+          system: SYSTEM,
+          prompt: `Go`,
+        });
+
+        console.log(yield* Effect.promise(() => dumpProject(project)));
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+});
+
+const dumpProject = async (project: Project.Project) => {
+  let text = '';
+  text += `============== Project: ${project.name} ==============\n\n`;
+  text += `============== Spec ==============\n\n`;
+  text += `${await project.spec.load().then((_) => _.content)}\n`;
+  text += `============== Plan ==============\n\n`;
+  text += `${await project.plan?.load().then((_) => Plan.formatPlan(_))}\n`;
+  text += `============== Artifacts ==============\n\n`;
+  for (const artifact of project.artifacts) {
+    const data = await artifact.data.load();
+    text += `============== ${artifact.name} (${Obj.getTypename(data)}) ==============\n`;
+    if (Obj.instanceOf(Markdown.Document, data)) {
+      text += `# ${Obj.getLabel(data)}\n\n${await data.content.load().then((_) => _.content)}\n`;
+    } else {
+      text += `    ${JSON.stringify(data, null, 2)}\n`;
+    }
+    text += '\n';
+  }
+  return text;
+};
+
+const TEST_MESSAGES = [
+  // Expense-related emails
+  Obj.make(Message.Message, {
+    created: new Date('2026-01-28T10:15:00Z').toISOString(),
+    sender: { email: 'receipts@britishairways.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: receipts@britishairways.com
+          Subject: Your British Airways booking confirmation - BA287
+
+          Dear Mr. Smith,
+
+          Thank you for booking with British Airways. Your flight reservation is confirmed.
+
+          BOOKING REFERENCE: XK7M2P
+
+          FLIGHT DETAILS
+          ─────────────────────────────────────
+          Flight: BA287
+          Date: 15 February 2026
+          Route: San Francisco (SFO) → London Heathrow (LHR)
+          Departure: 17:45 PST
+          Arrival: 12:15 GMT (+1 day)
+          Class: Economy
+
+          PASSENGER
+          ─────────────────────────────────────
+          John Smith
+
+          PAYMENT SUMMARY
+          ─────────────────────────────────────
+          Base fare:              £485.00
+          Taxes and fees:         £127.50
+          ─────────────────────────────────────
+          TOTAL PAID:             £612.50
+
+          Payment method: Visa ending in 4521
+          Transaction date: 28 January 2026
+
+          Please keep this email for your records.
+
+          Kind regards,
+          British Airways
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-01-29T14:30:00Z').toISOString(),
+    sender: { email: 'noreply@booking.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: noreply@booking.com
+          Subject: Booking Confirmation - The Savoy London
+
+          Booking Confirmation
+
+          Dear John Smith,
+
+          Your booking is confirmed!
+
+          Hotel: The Savoy London
+          Address: Strand, London WC2R 0EU, United Kingdom
+          Check-in: 15 February 2026, 15:00
+          Check-out: 18 February 2026, 11:00
+          Guests: 1 adult
+          Room: Deluxe King Room
+
+          Total amount: £450.00
+          Payment: Paid via credit card ending in 4521
+          Booking reference: BK-789456123
+
+          We look forward to welcoming you!
+
+          Best regards,
+          Booking.com
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-15T19:45:00Z').toISOString(),
+    sender: { email: 'receipt@uber.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: receipt@uber.com
+          Subject: Your trip receipt
+
+          Trip Receipt
+
+          Trip Date: February 15, 2026 at 7:30 PM
+          Trip ID: 1A2B3C4D5E
+
+          Route: London Heathrow Airport → The Savoy London
+          Distance: 18.2 miles
+          Duration: 45 minutes
+
+          Fare breakdown:
+          Base fare:                    £12.50
+          Distance:                     £18.20
+          Time:                         £11.25
+          Booking fee:                  £2.50
+          ─────────────────────────────────────
+          Subtotal:                     £44.45
+          VAT (20%):                    £8.89
+          ─────────────────────────────────────
+          Total:                        £53.34
+
+          Payment method: Visa •••• 4521
+
+          Thank you for riding with Uber!
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-16T20:15:00Z').toISOString(),
+    sender: { email: 'receipts@opentable.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: receipts@opentable.com
+          Subject: Your receipt from The Ivy
+
+          Receipt
+
+          Restaurant: The Ivy
+          Address: 1-5 West Street, London WC2H 9NQ
+          Date: February 16, 2026
+          Time: 8:00 PM
+          Table: 12
+          Guests: 2
+
+          Order Summary:
+          ─────────────────────────────────────
+          Starter - Scallops                  £18.00
+          Main - Ribeye Steak                 £32.00
+          Main - Sea Bass                     £28.00
+          Side - Truffle Fries                £8.50
+          Wine - Chardonnay (bottle)          £45.00
+          Dessert - Chocolate Soufflé         £12.00
+          ─────────────────────────────────────
+          Subtotal:                           £143.50
+          Service charge (12.5%):             £17.94
+          ─────────────────────────────────────
+          Total:                              £161.44
+
+          Payment: Card ending in 4521
+          Reservation ID: OT-987654321
+
+          Thank you for dining with us!
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-17T09:00:00Z').toISOString(),
+    sender: { email: 'receipts@amazon.co.uk' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: receipts@amazon.co.uk
+          Subject: Your Amazon.co.uk order #123-4567890-1234567
+
+          Order Confirmation
+
+          Hello John Smith,
+
+          We've received your order and will send a confirmation when it ships.
+
+          Order #123-4567890-1234567
+          Order Date: February 17, 2026
+
+          Items Ordered:
+          ─────────────────────────────────────
+          1x  London Travel Guide 2026        £12.99
+          1x  Universal Travel Adapter        £8.50
+          ─────────────────────────────────────
+          Items:                               £21.49
+          Shipping & Handling:                 £4.99
+          ─────────────────────────────────────
+          Order Total:                         £26.48
+
+          Payment method: Visa ending in 4521
+          Shipping to: The Savoy London, Strand, London WC2R 0EU
+
+          Estimated delivery: February 18, 2026
+
+          Thank you for your order!
+        `,
+      },
+    ],
+  }),
+  // Unrelated emails
+  Obj.make(Message.Message, {
+    created: new Date('2026-01-30T08:00:00Z').toISOString(),
+    sender: { email: 'newsletter@techcrunch.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: newsletter@techcrunch.com
+          Subject: Weekly Tech Roundup - AI Breakthroughs & Startup News
+
+          TechCrunch Weekly Newsletter
+
+          This week in tech:
+
+          • OpenAI announces GPT-5 with enhanced reasoning capabilities
+          • New quantum computing milestone achieved by IBM
+          • 5 startups that raised over $100M this week
+          • The future of autonomous vehicles: what's next?
+
+          Read the full stories: https://techcrunch.com/weekly
+
+          Unsubscribe | Manage preferences
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-01T12:00:00Z').toISOString(),
+    sender: { email: 'sarah.johnson@gmail.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: sarah.johnson@gmail.com
+          Subject: Re: Coffee next week?
+
+          Hey John,
+
+          Sounds great! How about Tuesday at 2pm? The usual place?
+
+          Let me know if that works for you.
+
+          Cheers,
+          Sarah
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-10T10:30:00Z').toISOString(),
+    sender: { email: 'promotions@nike.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: promotions@nike.com
+          Subject: 🏃‍♂️ 30% Off Running Shoes - Limited Time!
+
+          Don't miss out!
+
+          Get 30% off all running shoes this week only. Use code RUN30 at checkout.
+
+          Shop now: https://nike.com/sale
+
+          Valid until February 17, 2026.
+
+          Unsubscribe | View in browser
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-14T16:20:00Z').toISOString(),
+    sender: { email: 'notifications@github.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: notifications@github.com
+          Subject: [dxos/dxos] New pull request: feat: add expense tracking
+
+          johnsmith opened a pull request in dxos/dxos
+
+          Title: feat: add expense tracking
+          Branch: feature/expense-tracking → main
+
+          This PR adds a new expense tracking feature to the assistant toolkit.
+
+          Review it here: https://github.com/dxos/dxos/pull/1234
+
+          You're receiving this because you're watching this repository.
+        `,
+      },
+    ],
+  }),
+  Obj.make(Message.Message, {
+    created: new Date('2026-02-18T11:00:00Z').toISOString(),
+    sender: { email: 'receipts@britishairways.com' },
+    blocks: [
+      {
+        _tag: 'text',
+        text: trim`
+          From: receipts@britishairways.com
+          Subject: Your British Airways booking confirmation - BA288
+
+          Dear Mr. Smith,
+
+          Thank you for booking with British Airways. Your return flight reservation is confirmed.
+
+          BOOKING REFERENCE: YK8N3Q
+
+          FLIGHT DETAILS
+          ─────────────────────────────────────
+          Flight: BA288
+          Date: 20 February 2026
+          Route: London Heathrow (LHR) → San Francisco (SFO)
+          Departure: 10:30 GMT
+          Arrival: 13:15 PST
+          Class: Economy
+
+          PASSENGER
+          ─────────────────────────────────────
+          John Smith
+
+          PAYMENT SUMMARY
+          ─────────────────────────────────────
+          Base fare:              £520.00
+          Taxes and fees:         £135.00
+          ─────────────────────────────────────
+          TOTAL PAID:             £655.00
+
+          Payment method: Visa ending in 4521
+          Transaction date: 18 February 2026
+
+          Please keep this email for your records.
+
+          Kind regards,
+          British Airways
+        `,
+      },
+    ],
+  }),
+];

package/src/blueprints/project/blueprint.ts

@@ -0,0 +1,68 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type AppCapabilities } from '@dxos/app-toolkit';
+import { Blueprint, Template } from '@dxos/blueprints';
+import { trim } from '@dxos/util';
+
+import { ProjectFunctions } from './functions';
+
+const BLUEPRINT_KEY = 'dxos.org/blueprint/project';
+
+const functions = [ProjectFunctions.AddArtifact];
+
+/**
+ * Creates the Project blueprint. This is a function to avoid circular dependency issues.
+ */
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Project blueprint',
+    instructions: Template.make({
+      source: trim`
+        You work on an project. Each project has a spec - the goal of the project.
+        The project plan shows the current progress of the project.
+        Project has an number of associated artifacts you can read/write.
+        Spec and plan are also artifacts.
+        You can edit them if necessary.
+
+        IMPORTANT: When create a new artifact, always add it to the project using the add-artifact function.
+
+        {{#with project}}
+        <project id="{{id}}" name="{{name}}">
+          <spec>
+            {{spec}}
+          </spec>
+          <plan>
+            {{plan}}
+          </plan>
+
+          <artifacts>
+          {{#each artifacts}}
+            <artifact type="{{type}}" dxn="{{dxn}}">
+              {{name}}
+            </artifact>
+          {{/each}}
+          </artifacts>
+        </project>
+        {{/with}}
+      `,
+      inputs: [
+        {
+          name: 'project',
+          kind: 'function',
+          function: 'dxos.org/function/project/get-context',
+        },
+      ],
+    }),
+    tools: Blueprint.toolDefinitions({ functions }),
+  });
+
+const blueprint: AppCapabilities.BlueprintDefinition = {
+  key: BLUEPRINT_KEY,
+  functions,
+  make,
+};
+
+export default blueprint;

package/src/blueprints/project/functions/add-artifact.ts

@@ -0,0 +1,41 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { AiContextService } from '@dxos/assistant';
+import { Database, Obj, Ref } from '@dxos/echo';
+import { defineFunction } from '@dxos/functions';
+
+import { Project } from '../../../types';
+
+export default defineFunction({
+  key: 'dxos.org/function/project/add-artifact',
+  name: 'Add artifact',
+  description: 'Adds a new artifact.',
+  inputSchema: Schema.Struct({
+    name: Schema.String.annotations({
+      description: 'The name of the artifact to add.',
+    }),
+    artifact: Ref.Ref(Obj.Unknown).annotations({
+      description: 'The artifact to add. Do NOT guess or try to generate the ID.',
+    }),
+  }),
+  services: [AiContextService],
+  handler: Effect.fnUntraced(function* ({ data }) {
+    if (!(yield* Database.load(data.artifact))) {
+      throw new Error('Artifact not found.');
+    }
+
+    const project = yield* Project.getFromChatContext;
+
+    Obj.change(project, (project) => {
+      project.artifacts.push({
+        name: data.name,
+        data: data.artifact,
+      });
+    });
+  }, AiContextService.fixFunctionHandlerType),
+});