@dxos/assistant-toolkit 0.8.4-main.21d9917

package/src/initiative/initiative.test.ts

@@ -0,0 +1,485 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { MemoizedAiService } from '@dxos/ai/testing';
+import { AiConversation } from '@dxos/assistant';
+import { AssistantTestLayerWithTriggers } from '@dxos/assistant/testing';
+import { Blueprint } from '@dxos/blueprints';
+import { Database, Obj, Ref } 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 { Text } from '@dxos/schema';
+import { Message } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+import { agent } from './functions';
+import * as Initiative from './Initiative';
+
+ObjectId.dangerouslyDisableRandomness();
+
+const TestLayer = AssistantTestLayerWithTriggers({
+  aiServicePreset: 'edge-remote',
+  functions: [...Initiative.functions],
+  types: [Initiative.Initiative, Blueprint.Blueprint, Trigger.Trigger, Text.Text],
+  tracing: 'pretty',
+});
+
+const SYSTEM = trim`
+  If you do not have tools to complete the task, inform the user. DO NOT PRETEND TO DO SOMETHING YOU CAN'T DO.
+`;
+
+describe('Initiative', () => {
+  it.scoped(
+    'shopping list',
+    Effect.fnUntraced(
+      function* (_) {
+        const initiative = yield* Database.Service.add(
+          yield* Initiative.make({
+            name: 'Shopping list',
+            spec: 'Keep a shopping list of items to buy.',
+          }),
+        );
+        invariant(initiative.chat?.target, 'Initiative chat queue not found.');
+        yield* Database.Service.flush({ indexes: true });
+        const conversation = yield* acquireReleaseResource(
+          () => new AiConversation({ queue: initiative.chat?.target as any }),
+        );
+        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(() => dumpInitiative(initiative)));
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+
+  it.scoped(
+    'expense tracking list',
+    Effect.fnUntraced(
+      function* (_) {
+        const initiative = yield* Database.Service.add(
+          yield* Initiative.make({
+            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:
+
+              ## Expences
+
+              - Flight to London (2026-02-01): £100
+              - Hotel in London (2026-02-01): £100
+            `,
+          }),
+        );
+        yield* Database.Service.flush({ indexes: true });
+
+        const inboxQueue = yield* QueueService.createQueue();
+        yield* Database.Service.add(
+          Trigger.make({
+            enabled: true,
+            spec: {
+              kind: 'queue',
+              queue: inboxQueue.dxn.toString(),
+            },
+            function: Ref.make(FunctionDefinition.serialize(agent)),
+            input: {
+              initiative: Ref.make(initiative),
+              event: '{{event}}',
+            },
+          }),
+        );
+
+        yield* QueueService.append(
+          inboxQueue,
+          TEST_MESSAGES.map((message) => Obj.clone(message)),
+        );
+
+        const dispatcher = yield* TriggerDispatcher;
+        yield* dispatcher.invokeScheduledTriggers({ kinds: ['queue'], untilExhausted: true });
+
+        console.log(yield* Effect.promise(() => dumpInitiative(initiative)));
+      },
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+});
+
+const dumpInitiative = async (initiative: Initiative.Initiative) => {
+  let text = '';
+  text += `============== Initiative: ${initiative.name} ==============\n\n`;
+  for (const artifact of initiative.artifacts) {
+    const data = await artifact.data.load();
+    text += `============== ${artifact.name} (${Obj.getTypename(data)}) ==============\n`;
+    if (Obj.instanceOf(Text.Text, data)) {
+      text += `    ${data.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/sync/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './sync';

package/src/sync/sync.ts

@@ -0,0 +1,95 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Filter, Obj, Query, Ref } from '@dxos/echo';
+import { Database } from '@dxos/echo';
+import { failedInvariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+
+/**
+ * Syncs objects to the database.
+ * If there's an object with a matching foreign key in the database, it will be updated.
+ * Otherwise, a new object will be added.
+ * Recursively syncs top-level refs.
+ *
+ * @param opts.foreignKeyId - The key to use for matching objects.
+ */
+export const syncObjects: (
+  objs: Obj.Unknown[],
+  opts: { foreignKeyId: string },
+) => Effect.Effect<Obj.Unknown[], never, Database.Service> = Effect.fn('syncObjects')(function* (
+  objs,
+  { foreignKeyId },
+) {
+  return yield* Effect.forEach(
+    objs,
+    Effect.fnUntraced(function* (obj) {
+      // Sync referenced objects.
+      for (const key of Object.keys(obj)) {
+        if (typeof key !== 'string' || key === 'id') continue;
+        if (!Ref.isRef((obj as any)[key])) continue;
+        const ref: Ref.Unknown = (obj as any)[key];
+        if (!ref.target) continue;
+        if (Obj.getDXN(ref.target).isLocalObjectId()) {
+          // obj not persisted to db.
+          const [target] = yield* syncObjects([ref.target], { foreignKeyId });
+          (obj as any)[key] = Ref.make(target);
+        }
+      }
+
+      const schema = Obj.getSchema(obj) ?? failedInvariant('No schema.');
+      const foreignId = Obj.getKeys(obj, foreignKeyId)[0]?.id ?? failedInvariant('No foreign key.');
+      const [existing] = yield* Database.Service.runQuery(
+        Query.select(Filter.foreignKeys(schema, [{ source: foreignKeyId, id: foreignId }])),
+      );
+      log('sync object', {
+        type: Obj.getTypename(obj),
+        foreignId,
+        existing: existing ? Obj.getDXN(existing) : undefined,
+      });
+      if (!existing) {
+        yield* Database.Service.add(obj);
+        return obj;
+      } else {
+        copyObjectData(existing, obj);
+        return existing;
+      }
+    }),
+    { concurrency: 1 },
+  );
+});
+
+const copyObjectData = (existing: Obj.Unknown, newObj: Obj.Unknown) => {
+  Obj.change(existing, (obj) => {
+    // Copy properties from newObj to existing.
+    for (const key of Object.keys(newObj)) {
+      if (typeof key !== 'string' || key === 'id') continue;
+      if (
+        typeof (newObj as any)[key] !== 'string' &&
+        typeof (newObj as any)[key] !== 'number' &&
+        typeof (newObj as any)[key] !== 'boolean' &&
+        !Ref.isRef((newObj as any)[key])
+      )
+        continue;
+      (obj as any)[key] = (newObj as any)[key];
+    }
+
+    // Delete properties that don't exist in newObj.
+    for (const key of Object.keys(obj)) {
+      if (typeof key !== 'string' || key === 'id') continue;
+      if (!(key in newObj)) {
+        delete (obj as any)[key];
+      }
+    }
+
+    // Update foreign keys.
+    for (const foreignKey of Obj.getMeta(newObj).keys) {
+      Obj.deleteKeys(obj, foreignKey.source);
+      // TODO(dmaretskyi): Doesn't work: `Obj.getMeta(existing).keys.push(foreignKey);`
+      Obj.getMeta(obj).keys.push({ ...foreignKey });
+    }
+  });
+};

package/src/testing/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './plugins';

package/src/testing/plugins.tsx

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import React from 'react';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { Format, type Obj, Type } from '@dxos/echo';
+import { JsonFilter } from '@dxos/react-ui-syntax-highlighter';
+
+export const MapSchema = Schema.Struct({
+  coordinates: Format.GeoPoint,
+}).pipe(
+  Type.object({
+    typename: 'example.com/type/Map',
+    version: '0.1.0',
+  }),
+);
+
+export type MapSchema = Schema.Schema.Type<typeof MapSchema>;
+
+// TODO(burdon): Move to ECHO def.
+export type ArtifactsContext = {
+  items: Obj.Unknown[];
+  getArtifacts: () => Obj.Unknown[];
+  addArtifact: (artifact: Obj.Unknown) => void;
+};
+
+declare global {
+  interface ToolContextExtensions {
+    artifacts?: ArtifactsContext;
+  }
+}
+
+// TODO(dmaretskyi): Removed images from conductor GPT implementation.
+const isImage = (data: any): data is any => false;
+
+export const capabilities: Capability.Any[] = [
+  Capability.contributes(
+    Common.Capability.ReactSurface,
+    Common.createSurface({
+      id: 'plugin-image',
+      role: 'card--extrinsic',
+      filter: (data: any): data is any => isImage(data.value),
+      component: ({ data }) => (
+        <img
+          className='grow object-cover'
+          src={`data:image/jpeg;base64,${data.value.source.data}`}
+          alt={data.value.prompt ?? `Generated image [id=${data.value.id}]`}
+        />
+      ),
+    }),
+  ),
+
+  //
+  // Default
+  //
+  Capability.contributes(
+    Common.Capability.ReactSurface,
+    Common.createSurface({
+      id: 'plugin-default',
+      role: 'card--extrinsic',
+      position: 'fallback',
+      component: ({ data }) => <JsonFilter data={data} />,
+    }),
+  ),
+];