@dxos/plugin-script 0.8.4-main.406dc2a → 0.8.4-main.43cb759274

package/src/templates/discord.ts

@@ -3,7 +3,7 @@
 //
 
 // @ts-ignore
-import { DXN, EchoObject, Filter, ObjectId, S, create, defineFunction } from 'dxos:functions';
+import { DXN, EchoObject, Filter, EntityId, S, create, defineFunction } from 'dxos:functions';
 // @ts-ignore
 import { FetchHttpClient } from 'https://esm.sh/@effect/platform@0.89.0?deps=effect@3.17.0&bundle=false';
 import {
@@ -22,14 +22,14 @@ import * as Redacted from 'https://esm.sh/effect@3.17.0/Redacted?bundle=false';
 import * as Ref from 'https://esm.sh/effect@3.17.0/Ref?bundle=false';
 
 const MessageSchema = S.Struct({
-  id: ObjectId,
+  id: EntityId,
   foreignId: S.Any, // bigint?
   from: S.String,
   created: S.String,
   content: S.String,
 }).pipe(
   EchoObject({
-    typename: 'example.com/type/Message',
+    typename: 'com.example.type.message',
     version: '0.1.0',
   }),
 );
@@ -42,7 +42,7 @@ const generateSnowflake = (unixTimestamp: number): bigint => {
 };
 
 export default defineFunction({
-  key: 'dxos.org/script/discord',
+  key: 'org.dxos.script.discord',
   name: 'Discord',
   inputSchema: S.Struct({
     // TODO(wittjosiah): Remove. This is used to provide a terminal for a cron trigger.
@@ -60,11 +60,11 @@ export default defineFunction({
   handler: ({ data: { channelId, queueId, after = DEFAULT_AFTER, pageSize = 5 }, context: { space } }: any) =>
     Effect.gen(function* () {
       const { token } = yield* Effect.tryPromise({
-        try: () => space.db.query(Filter.typename('dxos.org/type/AccessToken', { source: 'discord.com' })).first(),
+        try: () => space.db.query(Filter.typename('org.dxos.type.accessToken', { source: 'discord.com' })).first(),
         catch: (e: any) => e,
       });
       const { objects } = yield* Effect.tryPromise({
-        try: () => space.queues.queryQueue(DXN.parse(queueId)),
+        try: () => space.queues.queryQueue(DXN.tryMake(queueId)!),
         catch: (e: any) => e,
       });
       const backfill = objects.length === 0;
@@ -84,7 +84,7 @@ export default defineFunction({
           const queueMessages = messages
             .map((message: any) =>
               create(MessageSchema, {
-                id: ObjectId.random(),
+                id: EntityId.random(),
                 foreignId: message.id,
                 from: message.author.username,
                 created: message.timestamp,
@@ -94,7 +94,7 @@ export default defineFunction({
             .toReversed();
           if (queueMessages.length > 0) {
             yield* Effect.tryPromise({
-              try: () => space.queues.insertIntoQueue(DXN.parse(queueId), queueMessages),
+              try: () => space.queues.insertIntoQueue(DXN.tryMake(queueId)!, queueMessages),
               catch: (e: any) => e,
             });
             yield* Ref.update(newMessages, (n: any) => n + queueMessages.length);

package/src/templates/forex-effect.ts

@@ -2,41 +2,48 @@
 // 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';
 
-export default defineFunction({
-  key: 'dxos.org/script/forex-effect',
-  name: 'Forex Effect',
-  description: 'Returns the exchange rate between two currencies.',
+import { Operation } from '@dxos/compute';
+import { DXN } from '@dxos/keys';
 
-  inputSchema: S.Struct({
-    from: S.String.annotations({ description: 'The source currency' }),
-    to: S.String.annotations({ description: 'The target currency' }),
+const ForexEffect = Operation.make({
+  meta: {
+    key: DXN.make('org.dxos.script.forexEffect'),
+    name: 'Forex Effect',
+    description: 'Returns the exchange rate between two currencies.',
+  },
+  input: Schema.Struct({
+    from: Schema.String.annotations({ description: 'The source currency' }),
+    to: Schema.String.annotations({ description: 'The target currency' }),
   }),
+  output: Schema.Any,
+});
 
-  outputSchema: S.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(
+export default ForexEffect.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ from: rawFrom, to: rawTo }) {
+      const from = rawFrom.toUpperCase();
+      const to = rawTo.toUpperCase();
+      const json: any = 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.flatMap((response) => response.json),
+        Effect.timeout('5 seconds'),
         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)),
-});
+      const rate = json?.data?.rates?.[to];
+      if (rate == null) {
+        return yield* Effect.fail(new Error(`No rate found for ${from} -> ${to}`));
+      }
+
+      return rate.toString();
+    }, Effect.provide(FetchHttpClient.layer)),
+  ),
+);

package/src/templates/forex.ts

@@ -2,25 +2,36 @@
 // Copyright 2025 DXOS.org
 //
 
-// @ts-ignore
-import { S, defineFunction } from 'dxos:functions';
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
 
-export default defineFunction({
-  key: 'dxos.org/script/forex',
-  name: 'Forex',
-  description: 'Returns the exchange rate between two currencies.',
+import { Operation } from '@dxos/compute';
+import { DXN } from '@dxos/keys';
 
-  inputSchema: S.Struct({
-    from: S.String.annotations({ description: 'The source currency' }),
-    to: S.String.annotations({ description: 'The target currency' }),
+const Forex = Operation.make({
+  meta: {
+    key: DXN.make('org.dxos.script.forex'),
+    name: 'Forex',
+    description: 'Returns the exchange rate between two currencies.',
+  },
+  input: Schema.Struct({
+    from: Schema.String.annotations({ description: 'The source currency' }),
+    to: Schema.String.annotations({ description: 'The target currency' }),
   }),
+  output: Schema.Any,
+});
 
-  handler: async ({ data: { from, to } }: any) => {
-    const res = await fetch(`https://free.ratesdb.com/v1/rates?from=${from}&to=${to}`);
-    const {
-      data: { rates },
-    } = await res.json();
+export default Forex.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ from: rawFrom, to: rawTo }) {
+      const from = rawFrom.toUpperCase();
+      const to = rawTo.toUpperCase();
+      const res = yield* Effect.promise(() => fetch(`https://free.ratesdb.com/v1/rates?from=${from}&to=${to}`));
+      const {
+        data: { rates },
+      } = yield* Effect.promise(() => res.json());
 
-    return rates[to].toString();
-  },
-});
+      return rates[to].toString();
+    }),
+  ),
+);

package/src/templates/gmail.ts

@@ -3,7 +3,7 @@
 //
 
 // @ts-ignore
-import { EchoObject, Filter, ObjectId, S, create, defineFunction } from 'dxos:functions';
+import { EchoObject, Filter, EntityId, S, create, defineFunction } from 'dxos:functions';
 // @ts-ignore
 import {
   FetchHttpClient,
@@ -27,7 +27,7 @@ import * as Schedule from 'https://esm.sh/effect@3.17.0/Schedule?bundle=false';
 import * as Stream from 'https://esm.sh/effect@3.17.0/Stream?bundle=false';
 
 export default defineFunction({
-  key: 'dxos.org/script/gmail',
+  key: 'org.dxos.script.gmail',
   name: 'Gmail',
   inputSchema: S.Struct({
     mailboxId: S.String,
@@ -47,7 +47,7 @@ export default defineFunction({
   handler: ({ context: { space }, data: { mailboxId, userId, after, pageSize } }: any) =>
     Effect.gen(function* () {
       const { token } = yield* Effect.tryPromise({
-        try: () => space.db.query(Filter.typename('dxos.org/type/AccessToken', { source: 'gmail.com' })).first(),
+        try: () => space.db.query(Filter.typename('org.dxos.type.accessToken', { source: 'gmail.com' })).first(),
         catch: (e: any) => e,
       });
 
@@ -74,7 +74,7 @@ export default defineFunction({
         catch: (e: any) => e,
       });
       const { objects } = yield* Effect.tryPromise({
-        try: () => space.queues.queryQueue(mailbox.queue.dxn),
+        try: () => space.queues.queryQueue(mailbox.queue.uri),
         catch: (e: any) => e,
       });
       const newMessages = yield* Ref.make([]);
@@ -105,7 +105,7 @@ export default defineFunction({
           }
           const subject = messageDetails.payload.headers.find((h: any) => h.name === 'Subject')?.value;
           const object = create(MessageType, {
-            id: ObjectId.random(),
+            id: EntityId.random(),
             created,
             sender,
             blocks: [
@@ -132,7 +132,7 @@ export default defineFunction({
           Stream.grouped(10),
           Stream.flatMap((batch: any) =>
             Effect.tryPromise({
-              try: () => space.queues.insertIntoQueue(mailbox.queue.dxn, Chunk.toReadonlyArray(batch)),
+              try: () => space.queues.insertIntoQueue(mailbox.queue.uri, Chunk.toReadonlyArray(batch)),
               catch: (e: any) => e,
             }),
           ),
@@ -175,8 +175,7 @@ const parseFromHeader = (value: string): { name?: string; email: string } | unde
 // TODO(wittjosiah): These schemas should be imported from @dxos/schema.
 //
 
-const ActorRoles = ['user', 'assistant'] as const;
-const ActorRole = S.Literal(...ActorRoles);
+const ActorRole = S.Literal('user', 'assistant');
 type ActorRole = S.Schema.Type<typeof ActorRole>;
 
 const ActorSchema = S.Struct({
@@ -198,7 +197,7 @@ const Text = S.TaggedStruct('text', {
 interface Text extends S.Schema.Type<typeof Text> {}
 
 const MessageType = S.Struct({
-  id: ObjectId,
+  id: EntityId,
   created: S.String.annotations({
     description: 'ISO date string when the message was sent.',
   }),
@@ -217,8 +216,8 @@ const MessageType = S.Struct({
   ),
 }).pipe(
   EchoObject({
-    typename: 'dxos.org/type/Message',
-    version: '0.2.0',
+    typename: 'org.dxos.type.message',
+    version: '0.1.0',
   }),
 );
 type MessageType = S.Schema.Type<typeof MessageType>;

package/src/templates/index.ts

@@ -2,8 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import chat from './chat.ts?raw';
-import chess from './chess.ts?raw';
+import anthropic from './anthropic.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';
@@ -25,54 +26,59 @@ export type Template = {
 
 export const templates = [
   {
-    id: 'dxos.org/script/ping',
+    id: 'org.dxos.script.ping',
     name: 'Ping',
     source: removeHeader(ping),
   },
   {
-    id: 'dxos.org/script/forex',
+    id: 'org.dxos.script.forex',
     name: 'Forex',
     source: removeHeader(forex),
   },
   {
-    id: 'dxos.org/script/forex-effect',
+    id: 'org.dxos.script.forex-effect',
     name: 'Forex (Effect)',
     source: removeHeader(forexEffect),
   },
   {
-    id: 'dxos.org/script/gpt',
-    name: 'Gpt',
-    source: removeHeader(chat),
-    presetId: 'dxos.org/function/gpt',
+    id: 'org.dxos.script.chess-bot',
+    name: 'Chess Bot',
+    source: removeHeader(chessBot),
+    presetId: 'org.dxos.function.chess-bot',
   },
   {
-    id: 'dxos.org/script/chess',
-    name: 'Chess',
-    source: removeHeader(chess),
-    presetId: 'dxos.org/function/chess',
-  },
-  {
-    id: 'dxos.org/script/email',
+    id: 'org.dxos.script.email',
     name: 'Email',
     source: removeHeader(email),
-    presetId: 'dxos.org/function/email',
+    presetId: 'org.dxos.function.email',
   },
   {
-    id: 'dxos.org/script/discord',
+    id: 'org.dxos.script.discord',
     name: 'Discord',
     source: removeHeader(discord),
-    presetId: 'dxos.org/function/discord',
+    presetId: 'org.dxos.function.discord',
   },
   {
-    id: 'dxos.org/script/gmail',
+    id: 'org.dxos.script.gmail',
     name: 'Gmail',
     source: removeHeader(gmail),
-    presetId: 'dxos.org/function/gmail',
+    presetId: 'org.dxos.function.gmail',
   },
   {
-    id: 'dxos.org/script/data-generator',
+    id: 'org.dxos.script.data-generator',
     name: 'Data Generator',
     source: removeHeader(dataGenerator),
-    presetId: 'dxos.org/function/data-generator',
+    presetId: 'org.dxos.function.data-generator',
+  },
+  {
+    id: 'org.dxos.script.anthropic',
+    name: 'Anthropic',
+    source: removeHeader(anthropic),
+  },
+  {
+    id: 'org.dxos.script.commentary',
+    name: 'Commentary',
+    source: removeHeader(commentary),
+    presetId: 'org.dxos.function.chess.commentary',
   },
 ] as const;

package/src/templates/ping.ts

@@ -1,8 +1,26 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-/**
- * Echos the request data.
- */
-export default async ({ data }: any) => data;
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { Operation } from '@dxos/compute';
+import { DXN } from '@dxos/keys';
+
+const Ping = Operation.make({
+  meta: {
+    key: DXN.make('org.dxos.script.ping'),
+    name: 'Ping',
+  },
+  input: Schema.Any,
+  output: Schema.Any,
+});
+
+export default Ping.pipe(
+  Operation.withHandler(
+    Effect.fn(function* (data) {
+      return data;
+    }),
+  ),
+);

package/src/testing/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './data';
+export * from './test-script';
+export * from './test-notebook';

package/src/testing/simulator.test.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Record from 'effect/Record';
+import { readFile } from 'node:fs/promises';
+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('Run script in sumulator', { tags: ['functions-e2e'] }, () => {
+  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/testing/test-notebook.ts

@@ -0,0 +1,71 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Routine } from '@dxos/compute';
+import { Ref, Type } from '@dxos/echo';
+import { createObject } from '@dxos/echo-db';
+import { PublicKey } from '@dxos/keys';
+import { Markdown } from '@dxos/plugin-markdown';
+import { Text } from '@dxos/schema';
+
+import { Notebook } from '#types';
+
+// TODO(burdon): NOTE: createObject is required for tests.
+export const createNotebook = (): Notebook.Notebook =>
+  Notebook.make({
+    cells: [
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make({ content: 'c = a() + b' }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make({ content: 'a = () => 100' }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make({ content: 'b = 200' }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make({ content: 'd = a() * 2' }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make({ content: 'c + d' }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Routine.make({
+              instructions: 'Very briefly, what colors are associated with the numbers {{a}} and {{b}}.',
+            }),
+          ),
+        ),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'query',
+        source: Ref.make(createObject(Text.make({ content: `docs = (type: ${Type.getTypename(Markdown.Document)})` }))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Routine.make({
+              instructions: 'Very briefly, summarize the documents: {{docs}}',
+            }),
+          ),
+        ),
+      },
+    ],
+  });

package/src/testing/test-script.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { Script, Operation } from '@dxos/compute';
+import { Obj, Ref } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+
+/**
+ * Seeds a script and linked persistent operation for Storybook stories.
+ */
+export const createScript = (space: Space): Script.Script => {
+  const script = Script.make({
+    name: 'Test',
+    source: 'export default () => 42;',
+  });
+
+  space.db.add(script);
+  space.db.add(
+    Obj.make(Operation.PersistentOperation, {
+      [Obj.Meta]: { key: 'org.dxos.script.story-fn', version: '0.1.0' },
+      name: 'Test',
+      source: Ref.make(script),
+    }),
+  );
+
+  return script;
+};