@dxos/plugin-script 0.8.4-main.c1de068 → 0.8.4-main.c351d160a8

package/src/templates/index.ts

@@ -2,15 +2,17 @@
 // 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 echo from './echo.ts?raw';
 import email from './email.ts?raw';
 import forexEffect from './forex-effect.ts?raw';
 import forex from './forex.ts?raw';
 import gmail from './gmail.ts?raw';
+import ping from './ping.ts?raw';
 
 const removeHeader = (str: string) => str.split('\n').slice(4).join('\n');
 
@@ -23,56 +25,67 @@ export type Template = {
   presetId?: string;
 };
 
-export const templates: Template[] = [
+export const templates = [
   {
-    id: 'dxos.org/script/echo',
-    name: 'Echo',
-    source: removeHeader(echo),
+    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',
+    id: 'org.dxos.script.gpt',
     name: 'Gpt',
     source: removeHeader(chat),
-    presetId: 'dxos.org/function/gpt',
+    presetId: 'org.dxos.function.gpt',
   },
   {
-    id: 'dxos.org/script/chess',
-    name: 'Chess',
-    source: removeHeader(chess),
-    presetId: 'dxos.org/function/chess',
+    id: 'org.dxos.script.chess-bot',
+    name: 'Chess Bot',
+    source: removeHeader(chessBot),
+    presetId: 'org.dxos.function.chess-bot',
   },
   {
-    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

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

package/src/testing/data.ts

@@ -0,0 +1,72 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Prompt } from '@dxos/blueprints';
+import { Ref } from '@dxos/echo';
+import { createObject } from '@dxos/echo-db';
+import { PublicKey } from '@dxos/keys';
+import { Markdown } from '@dxos/plugin-markdown/types';
+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('c = a() + b'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('a = () => 100'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('b = 200'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('d = a() * 2'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('c + d'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Prompt.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(`docs = (type: ${Markdown.Document.typename})`))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Prompt.make({
+              instructions: 'Very briefly, summarize the documents: {{docs}}',
+            }),
+          ),
+        ),
+      },
+    ],
+  });

package/src/testing/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './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/translations.ts

@@ -2,25 +2,40 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ScriptType } from '@dxos/functions';
+import { Script } from '@dxos/functions';
 import { type Resource } from '@dxos/react-ui';
 
 import { meta } from './meta';
+import { Notebook } from './types';
 
 export const translations = [
   {
     'en-US': {
-      [ScriptType.typename]: {
+      [Script.Script.typename]: {
         'typename label': 'Script',
         'typename label_zero': 'Scripts',
         'typename label_one': 'Script',
         'typename label_other': 'Scripts',
         'object name placeholder': 'New script',
+        'add object label': 'Add script',
         'rename object label': 'Rename script',
         'delete object label': 'Delete script',
+        'object deleted label': 'Script deleted',
+      },
+      [Notebook.Notebook.typename]: {
+        'typename label': 'Notebook',
+        'typename label_zero': 'Notebooks',
+        'typename label_one': 'Notebook',
+        'typename label_other': 'Notebooks',
+        'object name placeholder': 'New notebook',
+        'add object label': 'Add notebook',
+        'rename object label': 'Rename notebook',
+        'delete object label': 'Delete notebook',
+        'object deleted label': 'Notebook deleted',
       },
       [meta.id]: {
         'plugin name': 'Scripts',
+        'settings title': 'Scripts plugin settings',
         'description label': 'Description',
         'description placeholder': 'Enter description',
         'binding placeholder': 'Function name',
@@ -44,25 +59,29 @@ export const translations = [
         'open token manager label': 'Open Token Manager',
         'publish label': 'Publish',
         'publishing label': 'Publishing',
+        'blueprint editor label': 'Blueprint',
+        'blueprint editor description': 'Create a blueprint that exposes this script as a tool.',
+        'blueprint instructions label': 'Instructions',
+        'blueprint instructions placeholder': 'Describe how this tool should be used.',
+        'create blueprint label': 'Create blueprint',
+        'creating label': 'Creating…',
         'editor input mode label': 'Editor input mode',
         'select editor input mode placeholder': 'Select editor input mode…',
         'settings editor input mode default label': 'Default',
         'settings editor input mode vim label': 'Vim',
         'settings editor input mode vscode label': 'VS Code',
-        'template select group label': 'Select template',
         'function panel label': 'Debug Function',
         'script test label': 'Test',
         'script logs label': 'Logs',
+
         'deployment dialog title': 'Default Scripts',
-        'deployment dialog scripts found message_one':
-          'We found the following script template for your new integration:',
-        'deployment dialog scripts found message_other':
-          'We found the following script templates for your new integration:',
+        'deployment dialog scripts found message': 'Script templates:',
         'deployment dialog deploy functions button label_one': 'Create and deploy script',
         'deployment dialog deploy functions button label_other': 'Create and deploy scripts',
         'deployment dialog deploy functions pending button label_one': 'Deploying script',
         'deployment dialog deploy functions pending button label_other': 'Deploying scripts',
         'deployment dialog skip button label': 'Skip',
+
         'script deployment toast label_one': 'Script deployed',
         'script deployment toast label_other': 'Scripts deployed',
         'script deployment toast description_one': 'Your script has been deployed successfully.',
@@ -75,6 +94,17 @@ export const translations = [
         'script deployment error toast description_other': 'There was an error deploying your scripts.',
         'script deployment error toast close label_one': 'Close',
         'script deployment error toast close label_other': 'Close',
+
+        'notebook cell placeholder': 'Enter script',
+        'notebook cell delete label': 'Delete cell',
+        'notebook cell prompt run label': 'Run',
+        'notebook cell insert markdown label': 'Insert Markdown',
+        'notebook cell insert script label': 'Insert Script',
+        'notebook cell insert prompt label': 'Insert Prompt',
+        'notebook cell insert query label': 'Insert Query',
+        'notebook markdown placeholder': 'Enter Markdown',
+        'notebook prompt placeholder': 'Enter prompt',
+        'notebook cell insert label': 'Insert cell',
       },
     },
   },

package/src/types/Notebook.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Prompt } from '@dxos/blueprints';
+import { Annotation, Obj, Ref, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/internal';
+import { LabelAnnotation } from '@dxos/echo/internal';
+import { Graph } from '@dxos/plugin-explorer/types';
+import { Text } from '@dxos/schema';
+
+export type CellType = 'markdown' | 'script' | 'query' | 'prompt' | 'view';
+
+export const Cell = Schema.Struct({
+  id: Schema.String,
+  type: Schema.String,
+  name: Schema.optional(Schema.String),
+  // TODO(burdon): Union type.
+  source: Schema.optional(Ref.Ref(Text.Text)),
+  prompt: Schema.optional(Ref.Ref(Prompt.Prompt)),
+  graph: Schema.optional(Ref.Ref(Graph.Graph)),
+});
+
+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, FormInputAnnotation.set(false)),
+}).pipe(
+  Type.object({
+    typename: 'org.dxos.type.notebook',
+    version: '0.1.0',
+  }),
+  LabelAnnotation.set(['name']),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--notebook--regular',
+    hue: 'sky',
+  }),
+);
+
+export type Notebook = Schema.Schema.Type<typeof Notebook>;
+
+export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }): Notebook => Obj.make(Notebook, props);

package/src/types/actions.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Database } from '@dxos/echo';
+import { Script } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
+
+import { meta } from '../meta';
+import { templates } from '../templates';
+
+const SCRIPT_OPERATION = `${meta.id}.operation`;
+
+export namespace ScriptOperation {
+  export const ScriptProps = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    // TODO(wittjosiah): Placeholder annotation?
+    gistUrl: Schema.optional(Schema.String.annotations({ title: 'Import from Gist (url)' })),
+    initialTemplateId: Schema.Literal(...templates.map(({ id }) => id)).pipe(
+      Schema.annotations({ title: 'Template' }),
+      Schema.optional,
+    ),
+  });
+
+  export const NotebookProps = Schema.Struct({
+    name: Schema.optional(Schema.String),
+  });
+
+  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,
+      }),
+    },
+  });
+}

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

@@ -2,4 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './schema';
+export * from './actions';
+export * from './capabilities';
+export * from './events';
+export * as Notebook from './Notebook';
+export * from './types';

package/src/types/types.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode } from '@dxos/ui-editor';
+
+export const ScriptSettings = Schema.mutable(
+  Schema.Struct({
+    editorInputMode: EditorInputMode,
+  }),
+);
+
+export type ScriptSettings = Schema.Schema.Type<typeof ScriptSettings>;

package/src/util/deploy.ts

@@ -4,34 +4,27 @@
 
 import { type Client } from '@dxos/client';
 import { Obj, Ref } from '@dxos/echo';
-import {
-  FunctionType,
-  type ScriptType,
-  getUserFunctionUrlInMetadata,
-  makeFunctionUrl,
-  setUserFunctionUrlInMetadata,
-} from '@dxos/functions';
-import { Bundler } from '@dxos/functions/bundler';
-import { incrementSemverPatch, uploadWorkerFunction } from '@dxos/functions/edge';
+import { Function, type Script, getUserFunctionIdInMetadata } from '@dxos/functions';
+import { bundleFunction } from '@dxos/functions-runtime/bundler';
+import { FunctionsServiceClient, incrementSemverPatch } from '@dxos/functions-runtime/edge';
 import { log } from '@dxos/log';
+import { FunctionRuntimeKind } from '@dxos/protocols';
 import { type Space } from '@dxos/react-client/echo';
 
-import { updateFunctionMetadata } from './functions';
-
-export const isScriptDeployed = ({ script, fn }: { script: ScriptType; fn: any }): boolean => {
-  const existingFunctionUrl = fn && getUserFunctionUrlInMetadata(Obj.getMeta(fn));
-  return Boolean(existingFunctionUrl) && !script.changed;
+export const isScriptDeployed = ({ script, fn }: { script: Script.Script; fn: any }): boolean => {
+  const existingFunctionId = fn && getUserFunctionIdInMetadata(Obj.getMeta(fn));
+  return Boolean(existingFunctionId) && !script.changed;
 };
 
 type DeployScriptProps = {
-  script: ScriptType;
+  script: Script.Script;
   client: Client;
   space: Space;
-  fn?: FunctionType;
-  existingFunctionUrl?: string;
+  fn?: Function.Function;
+  existingFunctionId?: string;
 };
 
-type DeployScriptResult = { success: boolean; error?: Error; functionUrl?: string };
+type DeployScriptResult = { success: boolean; error?: Error; functionId?: string };
 
 /**
  * Deploy a script to a space, handling bundling and uploading to the FaaS infrastructure.
@@ -41,7 +34,7 @@ export const deployScript = async ({
   client,
   space,
   fn,
-  existingFunctionUrl,
+  existingFunctionId,
 }: DeployScriptProps): Promise<DeployScriptResult> => {
   const validationError = validateDeployInputs(script, space);
   if (validationError) {
@@ -49,33 +42,30 @@ export const deployScript = async ({
   }
 
   try {
-    const existingFunctionId = extractFunctionId(existingFunctionUrl);
-
-    const { bundle, error } = await bundleScript(script.source!.target!.content);
-    if (error || !bundle) {
-      throw error || new Error('Bundle creation failed');
+    const buildResult = await bundleFunction({
+      source: script.source!.target!.content,
+    });
+    if ('error' in buildResult) {
+      throw buildResult.error || new Error('Bundle creation failed');
     }
 
-    const { functionId, version, meta } = await uploadWorkerFunction({
-      client,
+    const functionsServiceClient = FunctionsServiceClient.fromClient(client);
+    const newFunction = await functionsServiceClient.deploy({
+      // TODO(dmaretskyi): Space key or identity key.
       ownerPublicKey: space.key,
       version: fn ? incrementSemverPatch(fn.version) : '0.0.1',
       functionId: existingFunctionId,
-      source: bundle,
+      entryPoint: buildResult.entryPoint,
+      assets: buildResult.assets,
+      runtime: FunctionRuntimeKind.enums.WORKER_LOADER,
     });
 
-    if (functionId === undefined || version === undefined) {
-      throw new Error(`Upload didn't return expected data: ${JSON.stringify({ functionId, version })}`);
-    }
-
-    const storedFunction = createOrUpdateFunctionInSpace(space, fn, script, functionId, version);
-    script.changed = false;
-    updateFunctionMetadata(script, storedFunction, meta, functionId);
-
-    const functionUrl = makeFunctionUrl({ functionId });
-    setUserFunctionUrlInMetadata(Obj.getMeta(storedFunction), functionUrl);
+    const storedFunction = createOrUpdateFunctionInSpace(space, fn, script, newFunction);
+    Obj.change(script, (s) => {
+      s.changed = false;
+    });
 
-    return { success: true, functionUrl };
+    return { success: true, functionId: getUserFunctionIdInMetadata(Obj.getMeta(storedFunction)) };
   } catch (err: any) {
     log.catch(err);
     return { success: false, error: err };
@@ -85,39 +75,26 @@ export const deployScript = async ({
 /**
  * Validate inputs for script deployment.
  */
-const validateDeployInputs = (script: ScriptType, space: Space): Error | null => {
+const validateDeployInputs = (script: Script.Script, space: Space): Error | null => {
   if (!script.source || !space) {
     return new Error('Script source or space not available');
   }
   return null;
 };
 
-const extractFunctionId = (functionUrl?: string): string | undefined => {
-  return functionUrl?.split('/').at(-1);
-};
-
-const bundleScript = async (source: string): Promise<{ bundle?: string; error?: Error }> => {
-  const bundler = new Bundler({ platform: 'browser', sandboxedModules: [], remoteModules: {} });
-  const buildResult = await bundler.bundle({ source });
-
-  if (buildResult.error || !buildResult.bundle) {
-    return { error: buildResult.error || new Error('Bundle creation failed') };
-  }
-
-  return { bundle: buildResult.bundle };
-};
-
 const createOrUpdateFunctionInSpace = (
   space: Space,
-  fn: FunctionType | undefined,
-  script: ScriptType,
-  functionId: string,
-  version: string,
-): FunctionType => {
+  fn: Function.Function | undefined,
+  script: Script.Script,
+  newFunction: Function.Function,
+): Function.Function => {
   if (fn) {
-    fn.version = version;
+    Function.setFrom(fn, newFunction);
     return fn;
   } else {
-    return space.db.add(Obj.make(FunctionType, { name: functionId, version, source: Ref.make(script) }));
+    Obj.change(newFunction, (f) => {
+      f.source = Ref.make(script);
+    });
+    return space.db.add(newFunction);
   }
 };