@dxos/plugin-script 0.8.4-main.fd6878d → 0.9.0

package/src/blueprints/functions/update.ts

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { next as A, type Doc } from '@automerge/automerge';
+import * as Effect from 'effect/Effect';
+
+import { type Script, Operation } from '@dxos/compute';
+import { Database, Obj } from '@dxos/echo';
+import { DocAccessor, createDocAccessor } from '@dxos/echo-client';
+
+import { Update } from './definitions';
+
+export default Update.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ function: fn, name, description, edits }) {
+      const loaded = yield* Database.load(fn);
+      if (!loaded.source) {
+        return yield* Effect.fail(new Error('Function has no source script.'));
+      }
+      const script = (yield* Database.load(loaded.source)) as Script.Script;
+
+      if (name !== undefined || description !== undefined) {
+        Obj.update(script, (script) => {
+          if (name !== undefined) {
+            script.name = name;
+          }
+          if (description !== undefined) {
+            script.description = description;
+          }
+        });
+      }
+
+      if (edits && edits.length > 0) {
+        const text = yield* Database.load(script.source);
+        const accessor = createDocAccessor(text, ['content']);
+
+        for (const edit of edits) {
+          accessor.handle.change((doc: Doc<typeof text>) => {
+            const source = DocAccessor.getValue<string>(accessor);
+            if (edit.replaceAll) {
+              let idx = source.indexOf(edit.oldString);
+              while (idx !== -1) {
+                A.splice(doc, accessor.path as A.Prop[], idx, edit.oldString.length, edit.newString);
+                const updated = DocAccessor.getValue<string>(accessor);
+                idx = updated.indexOf(edit.oldString, idx + edit.newString.length);
+              }
+            } else {
+              const idx = source.indexOf(edit.oldString);
+              if (idx === -1) {
+                throw new Error(`Edit not found: ${JSON.stringify(edit.oldString)}`);
+              }
+              A.splice(doc, accessor.path as A.Prop[], idx, edit.oldString.length, edit.newString);
+            }
+          });
+        }
+
+        Obj.update(script, (script) => {
+          script.changed = true;
+        });
+      }
+
+      return {
+        function: Obj.getURI(loaded),
+      };
+    }),
+  ),
+);

package/src/blueprints/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as ScriptBlueprint } from './script-blueprint';

package/src/blueprints/script-blueprint.ts

@@ -0,0 +1,55 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Blueprint, Template } from '@dxos/compute';
+import { trim } from '@dxos/util';
+
+import {
+  Create,
+  Read,
+  Update,
+  Delete,
+  Deploy,
+  Invoke,
+  InspectInvocations,
+  QueryDeployedFunctions,
+  InstallFunction,
+} from './functions';
+
+const BLUEPRINT_KEY = 'org.dxos.blueprint.script';
+
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Script',
+    agentCanEnable: true,
+    tools: Blueprint.toolDefinitions({
+      operations: [
+        Create,
+        Read,
+        Update,
+        Delete,
+        Deploy,
+        Invoke,
+        InspectInvocations,
+        QueryDeployedFunctions,
+        InstallFunction,
+      ],
+    }),
+    instructions: Template.make({
+      source: trim`
+        You can create, read, update, and delete scripts which contain TypeScript code.
+        You can deploy scripts to the Edge runtime and invoke deployed scripts.
+        You can inspect the invocation history of a deployed script.
+        You can query all functions deployed to the EDGE runtime and install them into the current space.
+      `,
+    }),
+  });
+
+const blueprint: Blueprint.Definition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

package/src/capabilities/app-graph-builder.ts

@@ -2,63 +2,46 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-import { ScriptType } from '@dxos/functions';
-import { ATTENDABLE_PATH_SEPARATOR, PLANK_COMPANION_TYPE } from '@dxos/plugin-deck/types';
-import { createExtension } from '@dxos/plugin-graph';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode } from '@dxos/app-toolkit';
+import { Script } from '@dxos/compute';
+import { GraphBuilder } from '@dxos/plugin-graph';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
-export default (context: PluginContext) =>
-  contributes(Capabilities.AppGraphBuilder, [
-    createExtension({
-      id: `${meta.id}/execute`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (Obj.instanceOf(ScriptType, node.data) ? Option.some(node) : Option.none())),
-            Option.map((node) => [
-              {
-                id: [node.id, 'execute'].join(ATTENDABLE_PATH_SEPARATOR),
-                type: PLANK_COMPANION_TYPE,
-                data: 'execute',
-                properties: {
-                  label: ['script test label', { ns: meta.id }],
-                  icon: 'ph--terminal--regular',
-                  disposition: 'hidden',
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-    createExtension({
-      id: `${meta.id}/logs`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (Obj.instanceOf(ScriptType, node.data) ? Option.some(node) : Option.none())),
-            Option.map((node) => [
-              {
-                id: [node.id, 'logs'].join(ATTENDABLE_PATH_SEPARATOR),
-                type: PLANK_COMPANION_TYPE,
-                data: 'logs',
-                properties: {
-                  label: ['script logs label', { ns: meta.id }],
-                  icon: 'ph--clock-countdown--regular',
-                  disposition: 'hidden',
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  ]);
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* Effect.all([
+      GraphBuilder.createTypeExtension({
+        id: 'execute',
+        type: Script.Script,
+        connector: () =>
+          Effect.succeed([
+            AppNode.makeCompanion({
+              id: 'execute',
+              label: ['script-test.label', { ns: meta.id }],
+              icon: 'ph--terminal--regular',
+              data: 'execute',
+            }),
+          ]),
+      }),
+      GraphBuilder.createTypeExtension({
+        id: 'logs',
+        type: Script.Script,
+        connector: () =>
+          Effect.succeed([
+            AppNode.makeCompanion({
+              id: 'logs',
+              label: ['script-logs.label', { ns: meta.id }],
+              icon: 'ph--clock-countdown--regular',
+              data: 'logs',
+            }),
+          ]),
+      }),
+    ]);
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

package/src/capabilities/blueprint-definition.ts

@@ -0,0 +1,19 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+
+import { ScriptBlueprint } from '#blueprints';
+
+// NOTE: Explicit annotation required: d.ts emit cannot portably name the inferred @dxos/compute types (TS2883).
+const blueprintDefinition: () => Effect.Effect<
+  Capability.Capability<typeof AppCapabilities.BlueprintDefinition>[],
+  never,
+  Capability.Service
+> = () => Effect.succeed([Capability.contributes(AppCapabilities.BlueprintDefinition, ScriptBlueprint)]);
+
+export default blueprintDefinition;

package/src/capabilities/compiler.ts

@@ -2,33 +2,110 @@
 // Copyright 2025 DXOS.org
 //
 
-// @ts-ignore
+import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
+import * as HttpClient from '@effect/platform/HttpClient';
+import * as Effect from 'effect/Effect';
+import * as Schedule from 'effect/Schedule';
+import * as Schema from 'effect/Schema';
 import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
+import * as ts from 'typescript';
 
-import { contributes } from '@dxos/app-framework';
-import { initializeBundler } from '@dxos/functions/bundler';
+import { Capability } from '@dxos/app-framework';
+import { initializeBundler } from '@dxos/functions-runtime/bundler';
+import { log } from '@dxos/log';
+import { trim } from '@dxos/util';
+
+import { ScriptCapabilities } from '#types';
 
 import { Compiler } from '../compiler';
 
-import { ScriptCapabilities } from './capabilities';
-
-export default async () => {
-  const compiler = new Compiler();
-
-  await compiler.initialize();
-  // TODO(wittjosiah): Fetch types for https modules.
-  compiler.setFile('/src/typings.d.ts', "declare module 'https://*';");
-  // TODO(wittjosiah): Proper function handler types.
-  // TODO(wittjosiah): Remove.
-  compiler.setFile(
-    '/src/runtime.ts',
-    `
-        export const Filter: any = {};
-        export type FunctionHandler = ({ event, context }: { event: any; context: any }) => Promise<Response>;
-        export const functionHandler = (handler: FunctionHandler) => handler;
-      `,
+// TODO(burdon): Document.
+const SCRIPT_PACKAGES_BUCKET = 'https://pub-5745ae82e450484aa28f75fc6a175935.r2.dev/dev/';
+const DECLARATION_EXTS = ['.d.ts', '.d.mts'];
+const NO_TYPES = true; // Types temopararly disabled due to compiler erorrs.
+
+export default Capability.makeModule(() =>
+  Effect.gen(function* () {
+    yield* Effect.tryPromise({
+      try: () => initializeBundler({ wasmUrl }),
+      catch: (error) => new Error(`Failed to initialize bundler: ${error}`),
+    });
+
+    const runtimeModules = yield* fetchRuntimeModules().pipe(Effect.provide(FetchHttpClient.layer));
+
+    const compiler = new Compiler({
+      target: ts.ScriptTarget.ES2022,
+      lib: ['lib.es2022.d.ts', 'lib.dom.d.ts'],
+      skipLibCheck: true,
+      moduleResolution: ts.ModuleResolutionKind.Bundler,
+      allowImportingTsExtensions: true,
+      noEmit: true,
+      strict: true,
+      esModuleInterop: true,
+      paths: Object.fromEntries(runtimeModules.map((mod: any) => [mod.moduleName, [`./src/${mod.filename}`]])),
+    });
+
+    yield* Effect.tryPromise({
+      try: () =>
+        compiler.initialize(trim`
+        declare module 'https://*';
+        ${NO_TYPES ? '' : 'declare module "*";'}
+      `),
+      catch: (error) => new Error(`Failed to initialize compiler: ${error}`),
+    });
+    if (!NO_TYPES) {
+      for (const mod of runtimeModules) {
+        compiler.setFile(`/src/${mod.filename}`, mod.content);
+      }
+    }
+
+    return Capability.contributes(ScriptCapabilities.Compiler, compiler);
+  }),
+);
+
+const fetchRuntimeModules = Effect.fnUntraced(function* () {
+  // { key, size, contentType }
+  const manifest = yield* HttpClient.get(new URL('manifest.json', SCRIPT_PACKAGES_BUCKET)).pipe(
+    Effect.flatMap((_) => _.json),
+    Effect.flatMap(
+      Schema.decodeUnknown(
+        Schema.Struct({
+          files: Schema.Array(
+            Schema.Struct({
+              key: Schema.String,
+            }),
+          ),
+        }),
+      ),
+    ),
+    Effect.map((manifest) => ({ ...manifest, files: manifest.files.map((f) => f.key) })),
+  );
+
+  const declarationFiles = manifest.files.filter((file) => DECLARATION_EXTS.some((ext) => file.endsWith(ext)));
+
+  let fetched = 0;
+  const modules = yield* Effect.forEach(
+    declarationFiles,
+    Effect.fnUntraced(
+      function* (filename) {
+        const response = yield* HttpClient.get(new URL(filename, SCRIPT_PACKAGES_BUCKET)).pipe(
+          Effect.retry(Schedule.exponential(1_000).pipe(Schedule.compose(Schedule.recurs(3)))),
+        );
+        const content = yield* response.text;
+        const moduleName = filename.replace(/\.d\.(ts|mts)$/, '');
+        fetched++;
+
+        return {
+          moduleName,
+          filename,
+          content,
+        };
+      },
+      Effect.retry(Schedule.exponential(1_000).pipe(Schedule.compose(Schedule.recurs(3)))),
+    ),
+    { concurrency: 20 },
   );
-  await initializeBundler({ wasmUrl });
 
-  return contributes(ScriptCapabilities.Compiler, compiler);
-};
+  log.info('runtime modules', { manifest: manifest.files.length, files: declarationFiles.length, fetched });
+  return modules;
+});

package/src/capabilities/create-object.ts

@@ -0,0 +1,49 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation, Script } from '@dxos/compute';
+import { Type } from '@dxos/echo';
+import { SpaceOperation } from '@dxos/plugin-space';
+import { SpaceCapabilities } from '@dxos/plugin-space';
+
+import { ScriptOperation } from '#types';
+import { Notebook } from '#types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    return [
+      Capability.contributes(SpaceCapabilities.CreateObjectEntry, {
+        id: Type.getTypename(Script.Script),
+        inputSchema: ScriptOperation.ScriptProps,
+        createObject: (props, options) =>
+          Effect.gen(function* () {
+            const { object } = yield* Operation.invoke(ScriptOperation.CreateScript, props);
+            return yield* Operation.invoke(SpaceOperation.AddObject, {
+              object,
+              target: options.target,
+              hidden: true,
+              targetNodeId: options.targetNodeId,
+            });
+          }),
+      }),
+      Capability.contributes(SpaceCapabilities.CreateObjectEntry, {
+        id: Type.getTypename(Notebook.Notebook),
+        inputSchema: ScriptOperation.NotebookProps,
+        createObject: (props, options) =>
+          Effect.gen(function* () {
+            const object = Notebook.make(props);
+            return yield* Operation.invoke(SpaceOperation.AddObject, {
+              object,
+              target: options.target,
+              hidden: true,
+              targetNodeId: options.targetNodeId,
+            });
+          }),
+      }),
+    ];
+  }),
+);

package/src/capabilities/index.ts

@@ -2,12 +2,22 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
+import { type AppCapabilities } from '@dxos/app-toolkit';
+import type { OperationHandlerSet } from '@dxos/compute';
 
-export const AppGraphBuilder = lazy(() => import('./app-graph-builder'));
-export const Compiler = lazy(() => import('./compiler'));
-export const IntentResolver = lazy(() => import('./intent-resolver'));
-export const ReactSurface = lazy(() => import('./react-surface'));
-export const ScriptSettings = lazy(() => import('./settings'));
-
-export * from './capabilities';
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
+// The contributed capability type references Blueprint types from @dxos/compute, so the lazy
+// wrapper needs an explicit annotation to keep the inferred type portable (TS2883).
+export const BlueprintDefinition: Capability.LazyCapability<
+  void,
+  Capability.Capability<typeof AppCapabilities.BlueprintDefinition>[]
+> = Capability.lazy('BlueprintDefinition', () => import('./blueprint-definition'));
+export const CreateObject = Capability.lazy('CreateObject', () => import('./create-object'));
+export const Compiler = Capability.lazy('Compiler', () => import('./compiler'));
+export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
+  'OperationHandler',
+  () => import('./operation-handler'),
+);
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
+export const ScriptSettings = Capability.lazy('ScriptSettings', () => import('./settings'));

package/src/capabilities/node.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+import { type AppCapabilities } from '@dxos/app-toolkit';
+import type { OperationHandlerSet } from '@dxos/compute';
+
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
+// The contributed capability type references Blueprint types from @dxos/compute, so the lazy
+// wrapper needs an explicit annotation to keep the inferred type portable (TS2883).
+export const BlueprintDefinition: Capability.LazyCapability<
+  void,
+  Capability.Capability<typeof AppCapabilities.BlueprintDefinition>[]
+> = Capability.lazy('BlueprintDefinition', () => import('./blueprint-definition'));
+export const CreateObject = Capability.lazy('CreateObject', () => import('./create-object'));
+export const Compiler = Capability.lazy('Compiler', () => import('./compiler'));
+export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
+  'OperationHandler',
+  () => import('./operation-handler'),
+);

package/src/capabilities/operation-handler.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { OperationHandlerSet } from '@dxos/compute';
+
+import { ScriptOperationHandlerSet } from '#operations';
+
+import { ScriptHandlers } from '../blueprints/functions';
+
+export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(
+      Capabilities.OperationHandler,
+      OperationHandlerSet.merge(ScriptOperationHandlerSet, ScriptHandlers),
+    );
+  }),
+);