@dxos/plugin-script 0.8.4-main.66e292d → 0.8.4-main.69d29f4

package/src/templates/commentary.ts

@@ -0,0 +1,232 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as A from '@automerge/automerge';
+import { Chess as ChessJS } from 'chess.js';
+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 { AiService, ConsolePrinter, ToolExecutionService, ToolResolverService } from '@dxos/ai';
+import { AiSession, GenerationObserver } from '@dxos/assistant';
+import { ArtifactId } from '@dxos/assistant';
+import { Database, Filter, Obj, Ref, Relation, Type } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-db';
+import { TracingService, defineFunction } from '@dxos/functions';
+import { log } from '@dxos/log';
+import { Chess } from '@dxos/plugin-chess/types';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { Collection, Text } from '@dxos/schema';
+import { HasSubject } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+export default defineFunction({
+  key: 'dxos.org/function/chess/commentary',
+  name: 'Commentary',
+  description: 'Adds commentary about the most recent move to a markdown document associated with the chess game.',
+  inputSchema: Schema.Struct({
+    game: Type.Ref(Chess.Game).annotations({
+      description: 'The chess game to comment on.',
+    }),
+  }),
+  outputSchema: Schema.Union(
+    Schema.Struct({
+      documentId: ArtifactId.annotations({
+        description: 'The ID of the markdown document that was updated or created.',
+      }),
+      commentary: Schema.String.annotations({
+        description: 'The commentary that was added.',
+      }),
+    }),
+    Schema.Void.annotations({
+      description: 'Function did not find anything to comment on.',
+    }),
+  ),
+  types: [Chess.Game, Markdown.Document, Text.Text, HasSubject.HasSubject, Collection.Collection],
+  services: [AiService.AiService, Database.Service],
+  handler: Effect.fnUntraced(
+    function* ({ data: { game: gameRef } }) {
+      // Load the chess game
+      log.info('load game', { gameRef });
+      const chessGame = yield* Database.Service.load(gameRef);
+
+      // Load the chess position from PGN or FEN
+      const chess = new ChessJS();
+      if (chessGame.pgn) {
+        chess.loadPgn(chessGame.pgn);
+      } else if (chessGame.fen) {
+        chess.load(chessGame.fen);
+      } else {
+        log.info('Early return: no pgn or fen');
+        return;
+      }
+
+      // Get the most recent move
+      const history = chess.history({ verbose: true });
+      if (history.length === 0) {
+        throw new Error('No moves have been played yet');
+      }
+      const lastMove = history[history.length - 1];
+      const moveNumber = Math.ceil(history.length / 2);
+      const isWhiteMove = history.length % 2 === 1;
+      const player = isWhiteMove ? 'White' : 'Black';
+      const moveNotation = lastMove.san;
+
+      // Generate AI commentary about the move
+      const result = yield* new AiSession().run({
+        prompt:
+          `Comment on this chess move as if you're commentating a live match for an audience:\n\n` +
+          `Move ${moveNumber}: ${player} plays ${moveNotation} (${lastMove.from} to ${lastMove.to})${lastMove.captured ? `, capturing ${lastMove.captured}` : ''}\n` +
+          `Current position: ${chess.fen()}\n` +
+          `${chess.isCheck() ? 'The king is in check! ' : ''}` +
+          `${chess.isCheckmate() ? 'CHECKMATE! ' : ''}` +
+          `${chess.isStalemate() ? 'STALEMATE! ' : ''}` +
+          `\nGame so far:\n${chess.pgn()}`,
+        system: COMMENTARY_SYSTEM_PROMPT,
+        history: [],
+        observer: GenerationObserver.fromPrinter(new ConsolePrinter({ tag: 'chess-commentary' })),
+      });
+
+      const commentaryText = Function.pipe(
+        result,
+        Array.findLast((msg) => msg.sender.role === 'assistant' && msg.blocks.some((block) => block._tag === 'text')),
+        Option.flatMap((msg) =>
+          Function.pipe(
+            msg.blocks,
+            Array.findLast((block) => block._tag === 'text'),
+            Option.map((block) => block.text),
+          ),
+        ),
+        Option.getOrThrowWith(() => new Error('No commentary generated')),
+      );
+
+      const commentary = `## Move ${moveNumber}: ${player} plays ${moveNotation}\n\n${commentaryText}\n\n`;
+      log.info('commentary', { commentary });
+
+      // TODO(wittjosiah): Functions currently don't support traversals.
+      // const docs = yield* Database.Service.runQuery(
+      //   Query.select(Filter.id(chessGame.id)).targetOf(HasSubject.HasSubject).source(),
+      // ).pipe(Effect.map((objects) => objects.filter((object) => Obj.instanceOf(Markdown.Document, object))));
+      const docs = yield* Database.Service.runQuery(Filter.type(HasSubject.HasSubject)).pipe(
+        Effect.map((relations) =>
+          relations.filter((relation) => {
+            // TODO(wittjosiah): This is a workaround for getTarget not handling deleted objects.
+            try {
+              log.info('relation', {
+                source: Obj.getDXN(Relation.getTarget(relation)).toString(),
+                game: Obj.getDXN(chessGame).toString(),
+              });
+              return Obj.getDXN(Relation.getTarget(relation)).toString() === Obj.getDXN(chessGame).toString();
+            } catch {
+              return false;
+            }
+          }),
+        ),
+        Effect.map((relations) =>
+          relations
+            .map((relation) => {
+              // TODO(wittjosiah): This is a workaround for getSource not handling deleted objects.
+              try {
+                return Relation.getSource(relation);
+              } catch {
+                return undefined;
+              }
+            })
+            .filter((source) => source !== undefined),
+        ),
+        Effect.map((sources) => {
+          const docs = sources.filter((source) => Obj.instanceOf(Markdown.Document, source));
+          log.info('docs', { sources, docs });
+          return docs;
+        }),
+      );
+      log.info('docs', { count: docs.length });
+
+      let document: Markdown.Document;
+      if (docs.length === 0) {
+        // TODO(wittjosiah): Deploy fails if `SpaceProperties` schema is imported because its from `client-protocol`.
+        const [properties] = yield* Database.Service.runQuery(Filter.typename('dxos.org/type/Properties'));
+        const rootCollection = yield* Database.Service.load<Collection.Collection>(
+          properties[Collection.Collection.typename],
+        );
+
+        log.info('rootCollection', { rootCollection });
+
+        // Create a new markdown document
+        const gameName = chessGame.name || 'Chess Game';
+        document = yield* Database.Service.add(
+          Markdown.make({
+            name: `${gameName} Commentary`,
+            content: `# ${gameName} Commentary\n\n${commentary}`,
+          }),
+        );
+
+        const documentRef = Ref.make(document);
+        Obj.change(rootCollection, (c) => {
+          c.objects.push(documentRef);
+        });
+
+        // Create the HasSubject relation
+        yield* Database.Service.add(
+          Relation.make(HasSubject.HasSubject, {
+            [Relation.Source]: document,
+            [Relation.Target]: chessGame,
+            completedAt: new Date().toISOString(),
+          }),
+        );
+      } else {
+        document = docs[0];
+
+        // Load the text content and append the commentary
+        const text = yield* Database.Service.load(document.content);
+        const accessor = createDocAccessor(text, ['content']);
+        accessor.handle.change((doc: A.Doc<Text.Text>) => {
+          A.splice(doc, accessor.path.slice(), text.content.length, 0, commentary);
+        });
+      }
+
+      log.info('result', { documentId: Obj.getDXN(document).toString(), commentary });
+
+      yield* Database.Service.flush();
+
+      return {
+        documentId: Obj.getDXN(document).toString(),
+        commentary,
+      };
+    },
+    Effect.provide(
+      Layer.mergeAll(
+        AiService.model('@anthropic/claude-haiku-4-5'),
+        ToolResolverService.layerEmpty,
+        ToolExecutionService.layerEmpty,
+        TracingService.layerNoop,
+      ),
+    ),
+  ),
+});
+
+const COMMENTARY_SYSTEM_PROMPT = trim`
+  You are a professional chess commentator providing live commentary for a chess match.
+
+  # Style
+  - Write in an engaging, enthusiastic style as if commentating for a live audience
+  - Be concise but informative (2-4 sentences)
+  - Explain the strategic implications of the move
+  - Note any tactical elements (captures, threats, checks)
+  - Comment on the position and what it means for the game
+
+  # Format
+  - Write in plain text (no markdown formatting in the commentary itself)
+  - Be natural and conversational
+  - Use chess terminology appropriately but keep it accessible
+
+  # Special Situations
+  - If it's checkmate, express excitement about the conclusion
+  - If it's check, note the pressure on the king
+  - If a piece is captured, mention the material exchange
+  - Comment on the development of pieces and control of key squares when relevant
+`;

package/src/templates/data-generator.ts

@@ -23,7 +23,7 @@ export default defineFunction({
     data: { documentAmount = 1, textSize = 10, mutationAmount = 0, waitAfterCreation = 10_000 },
     context: { space },
   }: any) => {
-    await space.db.graph.schemaRegistry.addSchema([Expando]);
+    await space.db.graph.schemaRegistry.register([Expando]);
     const result: Record<string, any> = {};
     const objects: Expando[] = [];
 

package/src/templates/forex-effect.ts

@@ -2,41 +2,36 @@
 // Copyright 2025 DXOS.org
 //
 
-// @ts-ignore
-import { S, defineFunction } from 'dxos:functions';
-import {
-  FetchHttpClient,
-  HttpClient,
-  HttpClientRequest,
-  // @ts-ignore
-} from 'https://esm.sh/@effect/platform@0.89.0?deps=effect@3.17.0&bundle=false';
-// @ts-ignore
-import * as Effect from 'https://esm.sh/effect@3.17.0/Effect?bundle=false';
-// @ts-ignore
-import * as Schedule from 'https://esm.sh/effect@3.17.0/Schedule?bundle=false';
+import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
+import * as HttpClient from '@effect/platform/HttpClient';
+import * as HttpClientRequest from '@effect/platform/HttpClientRequest';
+import * as Effect from 'effect/Effect';
+import * as Schedule from 'effect/Schedule';
+import * as Schema from 'effect/Schema';
+
+import { defineFunction } from '@dxos/functions';
 
 export default defineFunction({
   key: 'dxos.org/script/forex-effect',
   name: 'Forex Effect',
   description: 'Returns the exchange rate between two currencies.',
 
-  inputSchema: S.Struct({
-    from: S.String.annotations({ description: 'The source currency' }),
-    to: S.String.annotations({ description: 'The target currency' }),
+  inputSchema: Schema.Struct({
+    from: Schema.String.annotations({ description: 'The source currency' }),
+    to: Schema.String.annotations({ description: 'The target currency' }),
   }),
 
-  outputSchema: S.String.annotations({ description: 'The exchange rate between the two currencies' }),
+  outputSchema: Schema.String.annotations({ description: 'The exchange rate between the two currencies' }),
 
-  handler: async ({ data: { from, to } }: any) =>
-    Effect.gen(function* () {
-      const res = yield* HttpClientRequest.get(`https://free.ratesdb.com/v1/rates?from=${from}&to=${to}`).pipe(
-        HttpClient.execute,
-        Effect.flatMap((res: any) => res.json),
-        Effect.timeout('1 second'),
-        Effect.retry(Schedule.exponential(1_000).pipe(Schedule.compose(Schedule.recurs(3)))),
-        Effect.scoped,
-      );
+  handler: Effect.fnUntraced(function* ({ data: { from, to } }) {
+    const res = yield* HttpClientRequest.get(`https://free.ratesdb.com/v1/rates?from=${from}&to=${to}`).pipe(
+      HttpClient.execute,
+      Effect.flatMap((res: any) => res.json),
+      Effect.timeout('1 second'),
+      Effect.retry(Schedule.exponential(1_000).pipe(Schedule.compose(Schedule.recurs(3)))),
+      Effect.scoped,
+    );
 
-      return res.data.rates[to].toString();
-    }).pipe(Effect.provide(FetchHttpClient.layer)),
+    return (res as any).data.rates[to].toString();
+  }, Effect.provide(FetchHttpClient.layer)),
 });

package/src/templates/forex.ts

@@ -2,20 +2,21 @@
 // Copyright 2025 DXOS.org
 //
 
-// @ts-ignore
-import { S, defineFunction } from 'dxos:functions';
+import * as Schema from 'effect/Schema';
+
+import { defineFunction } from '@dxos/functions';
 
 export default defineFunction({
   key: 'dxos.org/script/forex',
   name: 'Forex',
   description: 'Returns the exchange rate between two currencies.',
 
-  inputSchema: S.Struct({
-    from: S.String.annotations({ description: 'The source currency' }),
-    to: S.String.annotations({ description: 'The target currency' }),
+  inputSchema: Schema.Struct({
+    from: Schema.String.annotations({ description: 'The source currency' }),
+    to: Schema.String.annotations({ description: 'The target currency' }),
   }),
 
-  handler: async ({ data: { from, to } }: any) => {
+  handler: async ({ data: { from, to } }) => {
     const res = await fetch(`https://free.ratesdb.com/v1/rates?from=${from}&to=${to}`);
     const {
       data: { rates },

package/src/templates/index.ts

@@ -2,8 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
+import anthropic from './anthropic.ts?raw';
 import chat from './chat.ts?raw';
-import chess from './chess.ts?raw';
+import chessBot from './chess-bot.ts?raw';
+import commentary from './commentary.ts?raw';
 import dataGenerator from './data-generator.ts?raw';
 import discord from './discord.ts?raw';
 import email from './email.ts?raw';
@@ -46,10 +48,10 @@ export const templates = [
     presetId: 'dxos.org/function/gpt',
   },
   {
-    id: 'dxos.org/script/chess',
-    name: 'Chess',
-    source: removeHeader(chess),
-    presetId: 'dxos.org/function/chess',
+    id: 'dxos.org/script/chess-bot',
+    name: 'Chess Bot',
+    source: removeHeader(chessBot),
+    presetId: 'dxos.org/function/chess-bot',
   },
   {
     id: 'dxos.org/script/email',
@@ -75,4 +77,15 @@ export const templates = [
     source: removeHeader(dataGenerator),
     presetId: 'dxos.org/function/data-generator',
   },
+  {
+    id: 'dxos.org/script/anthropic',
+    name: 'Anthropic',
+    source: removeHeader(anthropic),
+  },
+  {
+    id: 'dxos.org/script/commentary',
+    name: 'Commentary',
+    source: removeHeader(commentary),
+    presetId: 'dxos.org/function/chess/commentary',
+  },
 ] as const;

package/src/templates/ping.ts

@@ -1,8 +1,17 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-/**
- * Echos the request data.
- */
-export default async ({ data }: any) => data;
+import * as Schema from 'effect/Schema';
+
+import { defineFunction } from '@dxos/functions';
+
+export default defineFunction({
+  key: 'dxos.org/script/ping',
+  name: 'Ping',
+  inputSchema: Schema.Any,
+
+  handler: async ({ data }) => {
+    return data;
+  },
+});

package/src/testing/simulator.test.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { readFile } from 'node:fs/promises';
+
+import * as Record from 'effect/Record';
+import { describe, expect, test } from 'vitest';
+
+import { bundleFunction } from '@dxos/functions-runtime/bundler';
+import { FunctionWorker } from '@dxos/functions-simulator-cloudflare';
+import { ErrorCodec } from '@dxos/protocols';
+
+// Requires downloading assets from R2
+describe.runIf(process.env.DX_TEST_TAGS?.includes('functions-e2e'))('Run script in sumulator', () => {
+  test('forex-effect', { timeout: 120_000 }, async () => {
+    const source = await readFile(new URL('../templates/forex-effect.ts', import.meta.url), 'utf-8');
+
+    // Bundle and upload.
+    const buildResult = await bundleFunction({ source });
+    if ('error' in buildResult) {
+      throw buildResult.error ?? new Error('Bundle creation failed');
+    }
+
+    const worker = new FunctionWorker({
+      mainModule: buildResult.entryPoint,
+      modules: Record.map(buildResult.assets, (contents, filename) => ({
+        contents: contents as Uint8Array<ArrayBuffer>,
+        contentType: filename.endsWith('.wasm') ? 'application/wasm' : 'application/javascript',
+      })),
+    });
+
+    const result = await worker.invoke({ from: 'USD', to: 'EUR' });
+    console.log(result);
+    if (result._kind === 'error') {
+      throw ErrorCodec.decode(result.error);
+    }
+    expect(Number(result.result)).toBeGreaterThan(0);
+  });
+});

package/src/types/Notebook.ts

@@ -13,7 +13,7 @@ import { Text } from '@dxos/schema';
 
 export type CellType = 'markdown' | 'script' | 'query' | 'prompt' | 'view';
 
-const Cell_ = Schema.Struct({
+export const Cell = Schema.Struct({
   id: Schema.String,
   type: Schema.String,
   name: Schema.optional(Schema.String),
@@ -21,16 +21,15 @@ const Cell_ = Schema.Struct({
   source: Schema.optional(Type.Ref(Text.Text)),
   prompt: Schema.optional(Type.Ref(Prompt.Prompt)),
   graph: Schema.optional(Type.Ref(Graph.Graph)),
-}).pipe(Schema.mutable);
-export interface Cell extends Schema.Schema.Type<typeof Cell_> {}
-export interface Cell_Encoded extends Schema.Schema.Encoded<typeof Cell_> {}
-export const Cell: Schema.Schema<Cell, Cell_Encoded> = Cell_;
+});
+
+export interface Cell extends Schema.Schema.Type<typeof Cell> {}
 
 export const Notebook = Schema.Struct({
   name: Schema.String.pipe(Schema.optional),
-  cells: Cell.pipe(Schema.Array, Schema.mutable, FormInputAnnotation.set(false)),
+  cells: Cell.pipe(Schema.Array, FormInputAnnotation.set(false)),
 }).pipe(
-  Type.Obj({
+  Type.object({
     typename: 'dxos.org/type/Notebook',
     version: '0.1.0',
   }),
@@ -39,4 +38,4 @@ export const Notebook = Schema.Struct({
 
 export type Notebook = Schema.Schema.Type<typeof Notebook>;
 
-export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }) => Obj.make(Notebook, props);
+export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }): Notebook => Obj.make(Notebook, props);

package/src/types/actions.ts

@@ -4,15 +4,16 @@
 
 import * as Schema from 'effect/Schema';
 
-import { SpaceSchema } from '@dxos/client/echo';
+import { Database } from '@dxos/echo';
 import { Script } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
 
 import { meta } from '../meta';
 import { templates } from '../templates';
 
-import * as Notebook from './Notebook';
+const SCRIPT_OPERATION = `${meta.id}/operation`;
 
-export namespace ScriptAction {
+export namespace ScriptOperation {
   export const ScriptProps = Schema.Struct({
     name: Schema.optional(Schema.String),
     // TODO(wittjosiah): Placeholder annotation?
@@ -23,31 +24,22 @@ export namespace ScriptAction {
     ),
   });
 
-  export class CreateScript extends Schema.TaggedClass<CreateScript>()(`${meta.id}/action/create-script`, {
-    input: Schema.extend(
-      ScriptProps,
-      Schema.Struct({
-        space: SpaceSchema,
-      }),
-    ),
-    output: Schema.Struct({
-      object: Script.Script,
-    }),
-  }) {}
-
   export const NotebookProps = Schema.Struct({
     name: Schema.optional(Schema.String),
   });
 
-  export class CreateNotebook extends Schema.TaggedClass<CreateNotebook>()(`${meta.id}/action/create-notebook`, {
-    input: Schema.extend(
-      NotebookProps,
-      Schema.Struct({
-        space: SpaceSchema,
+  export const CreateScript = Operation.make({
+    meta: { key: `${SCRIPT_OPERATION}/create-script`, name: 'Create Script' },
+    schema: {
+      input: Schema.extend(
+        ScriptProps,
+        Schema.Struct({
+          db: Database.Database,
+        }),
+      ),
+      output: Schema.Struct({
+        object: Script.Script,
       }),
-    ),
-    output: Schema.Struct({
-      object: Notebook.Notebook,
-    }),
-  }) {}
+    },
+  });
 }

package/src/types/capabilities.ts

@@ -0,0 +1,17 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+
+import { Capability } from '@dxos/app-framework';
+
+import { type Compiler } from '../compiler';
+import { meta } from '../meta';
+
+import { type ScriptSettings } from './types';
+
+export namespace ScriptCapabilities {
+  export const Settings = Capability.make<Atom.Writable<ScriptSettings>>(`${meta.id}/capability/settings`);
+  export const Compiler = Capability.make<Compiler>(`${meta.id}/capability/compiler`);
+}

package/src/types/events.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent } from '@dxos/app-framework';
+
+import { meta } from '../meta';
+
+export namespace ScriptEvents {
+  export const SetupCompiler = ActivationEvent.make(`${meta.id}/event/setup-compiler`);
+}

package/src/types/index.ts

@@ -3,5 +3,7 @@
 //
 
 export * from './actions';
+export * from './capabilities';
+export * from './events';
 export * as Notebook from './Notebook';
 export * from './types';

package/src/types/types.ts

@@ -4,7 +4,7 @@
 
 import * as Schema from 'effect/Schema';
 
-import { EditorInputMode } from '@dxos/react-ui-editor';
+import { EditorInputMode } from '@dxos/ui-editor';
 
 export const ScriptSettings = Schema.mutable(
   Schema.Struct({