@dxos/plugin-script 0.8.4-main.c4373fc → 0.8.4-main.d9fc60f731

package/src/templates/index.ts

@@ -2,15 +2,16 @@
 // 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 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 +24,61 @@ 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',
-    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

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+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;
+};

package/src/translations.ts

@@ -2,99 +2,107 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ScriptType } from '@dxos/functions';
+import { Script } from '@dxos/compute';
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
-import { Notebook } from './types';
+import { meta } from '#meta';
+import { Notebook } from '#types';
 
 export const translations = [
   {
     'en-US': {
-      [ScriptType.typename]: {
-        'typename label': 'Script',
-        'typename label_zero': 'Scripts',
-        'typename label_one': 'Script',
-        'typename label_other': 'Scripts',
-        'object name placeholder': 'New script',
-        'rename object label': 'Rename script',
-        'delete object label': 'Delete script',
+      [Type.getTypename(Script.Script)]: {
+        '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',
-        'rename object label': 'Rename notebook',
-        'delete object label': 'Delete notebook',
+      [Type.getTypename(Notebook.Notebook)]: {
+        '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',
-        'function request placeholder': 'Function request',
-        'deploy label': 'Deploy',
-        'deployed label': 'Current version of the script is deployed',
-        'upload failed label': 'Upload failed',
-        'copy link label': 'Copy function link',
-        'format label': 'Format',
-        'toggle details label': 'Toggle details panel',
-        'authenticate action label': 'Authenticate functions service',
-        'authenticate button label': 'Authenticate',
-        'name label': 'Name',
-        'remote function settings heading': 'Remote Function',
-        'function url label': 'Invocation URL',
-        'function binding label': 'Function binding',
-        'function binding placeholder': 'Enter binding name (e.g., NAME)',
-        'script publish settings label': 'Publishing',
-        'script publish settings description': 'Scripts can be shared publicly as Github gists.',
-        'no github token label': 'This space has no GitHub access token available.',
-        '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',
+        'plugin.name': 'Scripts',
+        'settings.title': 'Scripts settings',
+        'description.label': 'Description',
+        'description.placeholder': 'Enter description',
+        'binding.placeholder': 'Function name',
+        'function-request.placeholder': 'Function request',
+        'deploy.label': 'Deploy',
+        'deployed.label': 'Current version of the script is deployed',
+        'upload-failed.label': 'Upload failed',
+        'copy-link.label': 'Copy function link',
+        'format.label': 'Format',
+        'toggle-details.label': 'Toggle details panel',
+        'authenticate-action.label': 'Authenticate functions service',
+        'authenticate-action.description':
+          'Sign in to the remote functions service to enable script deployment and execution.',
+        'authenticate-button.label': 'Authenticate',
+        'name.label': 'Name',
+        'remote-function-settings.heading': 'Remote Function',
+        'function-url.label': 'Invocation URL',
+        'function-binding.label': 'Function binding',
+        'function-binding.placeholder': 'Enter binding name (e.g., NAME)',
+        'script-publish-settings.label': 'Publishing',
+        'script-publish-settings.description': 'Scripts can be shared publicly as Github gists.',
+        'no-github-token.label': 'This space has no GitHub access token available.',
+        'open-token-manager.label': 'Open Token Manager',
+        'publish.label': 'Publish',
+        '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',
+        'update-blueprint.label': 'Update blueprint',
+        'function-panel.label': 'Debug Function',
+        'script-test.label': 'Test',
+        'script-logs.label': 'Logs',
+        'compute.label': 'Compute',
 
-        'deployment dialog title': 'Default Scripts',
-        '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',
+        'deployment-dialog.title': 'Default Scripts',
+        '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.',
-        'script deployment toast description_other': 'Your scripts have been deployed successfully.',
-        'script deployment toast close label_one': 'Close',
-        'script deployment toast close label_other': 'Close',
-        'script deployment error toast label_one': 'Script deployment failed',
-        'script deployment error toast label_other': 'Scripts deployment failed',
-        'script deployment error toast description_one': 'There was an error deploying your script.',
-        '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',
+        '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.',
+        'script-deployment-toast.description_other': 'Your scripts have been deployed successfully.',
+        'script-deployment-toast-close.label_one': 'Close',
+        'script-deployment-toast-close.label_other': 'Close',
+        'script-deployment-error-toast.label_one': 'Script deployment failed',
+        'script-deployment-error-toast.label_other': 'Scripts deployment failed',
+        'script-deployment-error-toast.description_one': 'There was an error deploying your script.',
+        '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 insert label': 'Insert cell',
+        '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,39 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Routine } from '@dxos/compute';
+import { DXN, 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';
+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(Routine.Routine)),
+  graph: Schema.optional(Ref.Ref(Graph.Graph)),
+});
+
+export type Cell = 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(
+  LabelAnnotation.set(['name']),
+  Annotation.IconAnnotation.set({ icon: 'ph--notebook--regular', hue: 'sky' }),
+  Type.makeObject(DXN.make('org.dxos.type.notebook', '0.1.0')),
+);
+
+export type Notebook = Type.InstanceType<typeof Notebook>;
+
+export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }): Notebook => Obj.make(Notebook, props);

package/src/types/ScriptCapabilities.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type Atom } from '@effect-atom/atom-react';
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+import { type Compiler as CompilerType } from '../compiler';
+
+// Inline import to avoid `Settings` namespace alias colliding with the
+// `Settings` capability export below.
+export const Settings = Capability.make<Atom.Writable<import('./Settings').Settings>>(`${meta.id}.capability.settings`);
+export const Compiler = Capability.make<CompilerType>(`${meta.id}.capability.compiler`);

package/src/types/ScriptEvents.ts

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

package/src/types/ScriptOperation.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Script, Operation } from '@dxos/compute';
+import { Database, Type, DXN } from '@dxos/echo';
+
+import { meta } from '#meta';
+
+import { templates } from '../templates';
+
+const makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);
+
+export const ScriptProps = Schema.Struct({
+  name: Schema.optional(Schema.String),
+  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: makeKey('createScript'), name: 'Create Script', icon: 'ph--code--regular' },
+  input: Schema.extend(
+    ScriptProps,
+    Schema.Struct({
+      db: Database.Database,
+    }),
+  ),
+  output: Schema.Struct({
+    object: Type.getSchema(Script.Script),
+  }),
+});

package/src/types/Settings.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode } from '@dxos/ui-editor/types';
+
+export const Settings = Schema.mutable(
+  Schema.Struct({
+    editorInputMode: EditorInputMode.annotations({
+      title: 'Editor input mode',
+      description: 'Choose the keybinding style for the script editor.',
+    }),
+  }),
+);
+
+export interface Settings extends Schema.Schema.Type<typeof Settings> {}

package/src/types/index.ts

@@ -2,5 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './actions';
-export * from './schema';
+export * from './types';
+
+export * as Notebook from './Notebook';
+export * as ScriptCapabilities from './ScriptCapabilities';
+export * as ScriptEvents from './ScriptEvents';
+export * as ScriptOperation from './ScriptOperation';

package/src/types/types.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * as Settings from './Settings';