@dxos/plugin-script 0.8.4-main.c85a9c8dae → 0.8.4-main.dfabb4ec29

package/src/templates/ping.ts

@@ -2,16 +2,24 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
 import * as Schema from 'effect/Schema';
 
-import { defineFunction } from '@dxos/functions';
+import { Operation } from '@dxos/compute';
 
-export default defineFunction({
-  key: 'dxos.org/script/ping',
-  name: 'Ping',
-  inputSchema: Schema.Any,
-
-  handler: async ({ data }) => {
-    return data;
+const Ping = Operation.make({
+  meta: {
+    key: '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

@@ -2,17 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
-import { readFile } from 'node:fs/promises';
-
 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.runIf(process.env.DX_TEST_TAGS?.includes('functions-e2e'))('Run script in sumulator', () => {
+// 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');
 

package/src/testing/{data.ts → test-notebook.ts}

@@ -2,51 +2,50 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Prompt } from '@dxos/blueprints';
+import { Routine } from '@dxos/compute';
 import { Ref } from '@dxos/echo';
 import { createObject } from '@dxos/echo-db';
 import { PublicKey } from '@dxos/keys';
-import { Markdown } from '@dxos/plugin-markdown/types';
+import { Markdown } from '@dxos/plugin-markdown';
 import { Text } from '@dxos/schema';
 
-import { Notebook } from '../types';
+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'))),
+        source: Ref.make(createObject(Text.make({ content: 'c = a() + b' }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'script',
-        source: Ref.make(createObject(Text.make('a = () => 100'))),
+        source: Ref.make(createObject(Text.make({ content: 'a = () => 100' }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'script',
-        source: Ref.make(createObject(Text.make('b = 200'))),
+        source: Ref.make(createObject(Text.make({ content: 'b = 200' }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'script',
-        source: Ref.make(createObject(Text.make('d = a() * 2'))),
+        source: Ref.make(createObject(Text.make({ content: 'd = a() * 2' }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'script',
-        source: Ref.make(createObject(Text.make('c + d'))),
+        source: Ref.make(createObject(Text.make({ content: 'c + d' }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'prompt',
         prompt: Ref.make(
           createObject(
-            Prompt.make({
+            Routine.make({
               instructions: 'Very briefly, what colors are associated with the numbers {{a}} and {{b}}.',
             }),
           ),
@@ -55,14 +54,14 @@ export const createNotebook = (): Notebook.Notebook =>
       {
         id: PublicKey.random().toString(),
         type: 'query',
-        source: Ref.make(createObject(Text.make(`docs = (type: ${Markdown.Document.typename})`))),
+        source: Ref.make(createObject(Text.make({ content: `docs = (type: ${Markdown.Document.typename})` }))),
       },
       {
         id: PublicKey.random().toString(),
         type: 'prompt',
         prompt: Ref.make(
           createObject(
-            Prompt.make({
+            Routine.make({
               instructions: 'Very briefly, summarize the documents: {{docs}}',
             }),
           ),

package/src/testing/test-script.ts

@@ -0,0 +1,29 @@
+//
+// 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, {
+      key: 'org.dxos.script.story-fn',
+      name: 'Test',
+      version: '0.1.0',
+      source: Ref.make(script),
+    }),
+  );
+
+  return script;
+};

package/src/translations.ts

@@ -2,107 +2,106 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Script } from '@dxos/functions';
+import { Script } from '@dxos/compute';
 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': {
       [Script.Script.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',
-        'object deleted label': 'Script deleted',
+        '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',
-        'object deleted label': 'Notebook deleted',
+        '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',
-        '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 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',
+        '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

@@ -4,11 +4,11 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Prompt } from '@dxos/blueprints';
-import { Obj, Ref, Type } from '@dxos/echo';
+import { Routine } from '@dxos/compute';
+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 { Graph } from '@dxos/plugin-explorer';
 import { Text } from '@dxos/schema';
 
 export type CellType = 'markdown' | 'script' | 'query' | 'prompt' | 'view';
@@ -19,7 +19,7 @@ export const Cell = Schema.Struct({
   name: Schema.optional(Schema.String),
   // TODO(burdon): Union type.
   source: Schema.optional(Ref.Ref(Text.Text)),
-  prompt: Schema.optional(Ref.Ref(Prompt.Prompt)),
+  prompt: Schema.optional(Ref.Ref(Routine.Routine)),
   graph: Schema.optional(Ref.Ref(Graph.Graph)),
 });
 
@@ -30,10 +30,14 @@ export const Notebook = Schema.Struct({
   cells: Cell.pipe(Schema.Array, FormInputAnnotation.set(false)),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Notebook',
+    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>;

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 } from '@dxos/echo';
+
+import { meta } from '#meta';
+
+import { templates } from '../templates';
+
+const SCRIPT_OPERATION = `${meta.id}.operation`;
+
+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: `${SCRIPT_OPERATION}.create-script`, name: 'Create Script' },
+  input: Schema.extend(
+    ScriptProps,
+    Schema.Struct({
+      db: Database.Database,
+    }),
+  ),
+  output: Schema.Struct({
+    object: 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,8 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './actions';
-export * from './capabilities';
-export * from './events';
-export * as Notebook from './Notebook';
 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

@@ -2,14 +2,4 @@
 // 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>;
+export * as Settings from './Settings';

package/src/util/deploy.ts

@@ -3,8 +3,10 @@
 //
 
 import { type Client } from '@dxos/client';
+import { Script, Operation } from '@dxos/compute';
+import { Context } from '@dxos/context';
 import { Obj, Ref } from '@dxos/echo';
-import { Function, type Script, getUserFunctionIdInMetadata } from '@dxos/functions';
+import { getUserFunctionIdInMetadata } from '@dxos/functions';
 import { bundleFunction } from '@dxos/functions-runtime/bundler';
 import { FunctionsServiceClient, incrementSemverPatch } from '@dxos/functions-runtime/edge';
 import { log } from '@dxos/log';
@@ -20,7 +22,7 @@ type DeployScriptProps = {
   script: Script.Script;
   client: Client;
   space: Space;
-  fn?: Function.Function;
+  fn?: Operation.PersistentOperation;
   existingFunctionId?: string;
 };
 
@@ -50,7 +52,7 @@ export const deployScript = async ({
     }
 
     const functionsServiceClient = FunctionsServiceClient.fromClient(client);
-    const newFunction = await functionsServiceClient.deploy({
+    const newFunction = await functionsServiceClient.deploy(Context.default(), {
       // TODO(dmaretskyi): Space key or identity key.
       ownerPublicKey: space.key,
       version: fn ? incrementSemverPatch(fn.version) : '0.0.1',
@@ -61,8 +63,8 @@ export const deployScript = async ({
     });
 
     const storedFunction = createOrUpdateFunctionInSpace(space, fn, script, newFunction);
-    Obj.change(script, (s) => {
-      s.changed = false;
+    Obj.update(script, (script) => {
+      script.changed = false;
     });
 
     return { success: true, functionId: getUserFunctionIdInMetadata(Obj.getMeta(storedFunction)) };
@@ -84,16 +86,16 @@ const validateDeployInputs = (script: Script.Script, space: Space): Error | null
 
 const createOrUpdateFunctionInSpace = (
   space: Space,
-  fn: Function.Function | undefined,
+  fn: Operation.PersistentOperation | undefined,
   script: Script.Script,
-  newFunction: Function.Function,
-): Function.Function => {
+  newFunction: Operation.PersistentOperation,
+): Operation.PersistentOperation => {
   if (fn) {
-    Function.setFrom(fn, newFunction);
+    Operation.setFrom(fn, newFunction);
     return fn;
   } else {
-    Obj.change(newFunction, (f) => {
-      f.source = Ref.make(script);
+    Obj.update(newFunction, (newFunction) => {
+      newFunction.source = Ref.make(script);
     });
     return space.db.add(newFunction);
   }