@dxos/plugin-script 0.7.4 → 0.7.5-labs.401163d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-script",
-  "version": "0.7.4",
+  "version": "0.7.5-labs.401163d",
   "description": "Braneframe notebook plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,21 +8,11 @@
   "author": "DXOS.org",
   "sideEffects": true,
   "exports": {
-    "./edge": {
-      "types": "./dist/types/src/edge/index.d.ts",
-      "browser": "./dist/lib/browser/edge/index.mjs",
-      "node": "./dist/lib/node-esm/edge/index.mjs"
-    },
     ".": {
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
-    "./meta": {
-      "types": "./dist/types/src/meta.d.ts",
-      "browser": "./dist/lib/browser/meta.mjs",
-      "node": "./dist/lib/node-esm/meta.mjs"
-    },
     "./types": {
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
@@ -32,12 +22,6 @@
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
     "*": {
-      "edge": [
-        "dist/types/src/edge/index.d.ts"
-      ],
-      "meta": [
-        "dist/types/src/meta.d.ts"
-      ],
       "types": [
         "dist/types/src/types/index.d.ts"
       ]
@@ -57,44 +41,52 @@
     "@codemirror/view": "^6.34.1",
     "@effect/schema": "^0.75.5",
     "@lezer/common": "^1.2.2",
+    "@lezer/highlight": "^1.2.1",
+    "@octokit/core": "^4.0.4",
     "@preact/signals-core": "^1.6.0",
     "@typescript/vfs": "^1.6.0",
+    "@valtown/codemirror-continue": "^2.3.1",
     "@valtown/codemirror-ts": "^2.2.0",
     "codemirror": "^6.0.1",
     "esbuild-wasm": "^0.16.14",
-    "iso-did": "^1.6.0",
     "lodash.get": "^4.4.2",
     "prettier": "^3.2.4",
     "react-syntax-highlighter": "^15.5.0",
-    "typescript": "^5.6.2",
-    "@dxos/app-framework": "0.7.4",
-    "@dxos/async": "0.7.4",
-    "@dxos/client-protocol": "0.7.4",
-    "@dxos/crypto": "0.7.4",
-    "@dxos/client": "0.7.4",
-    "@dxos/debug": "0.7.4",
-    "@dxos/echo-schema": "0.7.4",
-    "@dxos/invariant": "0.7.4",
-    "@dxos/keys": "0.7.4",
-    "@dxos/edge-client": "0.7.4",
-    "@dxos/live-object": "0.7.4",
-    "@dxos/log": "0.7.4",
-    "@dxos/plugin-client": "0.7.4",
-    "@dxos/plugin-graph": "0.7.4",
-    "@dxos/plugin-explorer": "0.7.4",
-    "@dxos/plugin-space": "0.7.4",
-    "@dxos/plugin-markdown": "0.7.4",
-    "@dxos/plugin-stack": "0.7.4",
-    "@dxos/react-client": "0.7.4",
-    "@dxos/protocols": "0.7.4",
-    "@dxos/plugin-theme": "0.7.4",
-    "@dxos/react-ui-attention": "0.7.4",
-    "@dxos/react-ui-form": "0.7.4",
-    "@dxos/react-ui-editor": "0.7.4",
-    "@dxos/react-ui-syntax-highlighter": "0.7.4",
-    "@dxos/rpc": "0.7.4",
-    "@dxos/rpc-tunnel": "0.7.4",
-    "@dxos/util": "0.7.4"
+    "typescript": "^5.7.2",
+    "@dxos/app-framework": "0.7.5-labs.401163d",
+    "@dxos/artifact": "0.7.5-labs.401163d",
+    "@dxos/async": "0.7.5-labs.401163d",
+    "@dxos/assistant": "0.7.5-labs.401163d",
+    "@dxos/client": "0.7.5-labs.401163d",
+    "@dxos/compute": "0.7.5-labs.401163d",
+    "@dxos/client-protocol": "0.7.5-labs.401163d",
+    "@dxos/debug": "0.7.5-labs.401163d",
+    "@dxos/echo-schema": "0.7.5-labs.401163d",
+    "@dxos/functions": "0.7.5-labs.401163d",
+    "@dxos/invariant": "0.7.5-labs.401163d",
+    "@dxos/keys": "0.7.5-labs.401163d",
+    "@dxos/live-object": "0.7.5-labs.401163d",
+    "@dxos/local-storage": "0.7.5-labs.401163d",
+    "@dxos/log": "0.7.5-labs.401163d",
+    "@dxos/plugin-graph": "0.7.5-labs.401163d",
+    "@dxos/plugin-client": "0.7.5-labs.401163d",
+    "@dxos/plugin-explorer": "0.7.5-labs.401163d",
+    "@dxos/plugin-markdown": "0.7.5-labs.401163d",
+    "@dxos/plugin-space": "0.7.5-labs.401163d",
+    "@dxos/plugin-theme": "0.7.5-labs.401163d",
+    "@dxos/protocols": "0.7.5-labs.401163d",
+    "@dxos/plugin-stack": "0.7.5-labs.401163d",
+    "@dxos/react-client": "0.7.5-labs.401163d",
+    "@dxos/react-ui-attention": "0.7.5-labs.401163d",
+    "@dxos/react-ui-editor": "0.7.5-labs.401163d",
+    "@dxos/react-ui-form": "0.7.5-labs.401163d",
+    "@dxos/react-ui-stack": "0.7.5-labs.401163d",
+    "@dxos/react-ui-menu": "0.7.5-labs.401163d",
+    "@dxos/rpc": "0.7.5-labs.401163d",
+    "@dxos/react-ui-syntax-highlighter": "0.7.5-labs.401163d",
+    "@dxos/rpc-tunnel": "0.7.5-labs.401163d",
+    "@dxos/schema": "0.7.5-labs.401163d",
+    "@dxos/util": "0.7.5-labs.401163d"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
@@ -104,19 +96,17 @@
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
     "vite": "5.4.7",
-    "@dxos/random": "0.7.4",
-    "@dxos/react-ui-mosaic": "0.7.4",
-    "@dxos/react-ui-theme": "0.7.4",
-    "@dxos/react-ui": "0.7.4",
-    "@dxos/storybook-utils": "0.7.4"
+    "@dxos/random": "0.7.5-labs.401163d",
+    "@dxos/react-ui": "0.7.5-labs.401163d",
+    "@dxos/storybook-utils": "0.7.5-labs.401163d",
+    "@dxos/react-ui-theme": "0.7.5-labs.401163d"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.1.5",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui-mosaic": "0.7.4",
-    "@dxos/react-ui-theme": "0.7.4",
-    "@dxos/react-ui": "0.7.4"
+    "@dxos/react-ui": "0.7.5-labs.401163d",
+    "@dxos/react-ui-theme": "0.7.5-labs.401163d"
   },
   "publishConfig": {
     "access": "public"

package/src/ScriptPlugin.tsx

@@ -3,156 +3,73 @@
 //
 
 // @ts-ignore
-import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
-import React from 'react';
 
-import { NavigationAction, parseIntentPlugin, type PluginDefinition, resolvePlugin } from '@dxos/app-framework';
-import { create } from '@dxos/live-object';
-import { parseClientPlugin } from '@dxos/plugin-client';
-import { type ActionGroup, createExtension, isActionGroup } from '@dxos/plugin-graph';
-import { TextType } from '@dxos/plugin-markdown/types';
-import { SpaceAction } from '@dxos/plugin-space';
-import { loadObjectReferences } from '@dxos/react-client/echo';
+import { Capabilities, contributes, createIntent, defineModule, definePlugin, Events } from '@dxos/app-framework';
+import { type Space } from '@dxos/client/echo';
+import { FunctionType, ScriptType } from '@dxos/functions';
+import { RefArray } from '@dxos/live-object';
+import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
 
-import { initializeBundler } from './bundler';
-import { Compiler } from './compiler';
-import { AutomationPanel, ScriptContainer, ScriptSettings, ScriptSettingsPanel } from './components';
-import meta, { SCRIPT_PLUGIN } from './meta';
-import { templates } from './templates';
+import { Artifact, Compiler, IntentResolver, ReactSurface, ScriptSettings } from './capabilities';
+import { meta, SCRIPT_PLUGIN } from './meta';
 import translations from './translations';
-import { FunctionType, ScriptAction, type ScriptPluginProvides, ScriptType } from './types';
+import { ScriptAction } from './types';
 
-export const ScriptPlugin = (): PluginDefinition<ScriptPluginProvides> => {
-  const compiler = new Compiler();
-
-  return {
-    meta,
-    initialize: async () => {
-      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;
-      `,
-      );
-      await initializeBundler({ wasmUrl });
-    },
-    provides: {
-      settings: {},
-      metadata: {
-        records: {
-          [ScriptType.typename]: {
-            createObject: ScriptAction.CREATE,
+export const ScriptPlugin = () =>
+  definePlugin(meta, [
+    defineModule({
+      id: `${meta.id}/module/settings`,
+      activatesOn: Events.SetupSettings,
+      activate: ScriptSettings,
+    }),
+    defineModule({
+      id: `${meta.id}/module/compiler`,
+      activatesOn: Events.Startup,
+      activate: Compiler,
+    }),
+    defineModule({
+      id: `${meta.id}/module/translations`,
+      activatesOn: Events.SetupTranslations,
+      activate: () => contributes(Capabilities.Translations, translations),
+    }),
+    defineModule({
+      id: `${meta.id}/module/metadata`,
+      activatesOn: Events.SetupMetadata,
+      activate: () =>
+        contributes(Capabilities.Metadata, {
+          id: ScriptType.typename,
+          metadata: {
+            creationSchema: ScriptAction.CreateScriptSchema,
+            createObject: (props: ScriptAction.CreateScriptProps, { space }: { space: Space }) =>
+              createIntent(ScriptAction.Create, { ...props, space }),
             placeholder: ['object title placeholder', { ns: SCRIPT_PLUGIN }],
             icon: 'ph--code--regular',
             // TODO(wittjosiah): Move out of metadata.
-            loadReferences: (script: ScriptType) => loadObjectReferences(script, (script) => [script.source]),
+            loadReferences: async (script: ScriptType) => await RefArray.loadAll([script.source]),
           },
-        },
-      },
-      translations,
-      echo: {
-        schema: [ScriptType],
-        system: [FunctionType],
-      },
-      graph: {
-        builder: (plugins) => {
-          const client = resolvePlugin(plugins, parseClientPlugin)?.provides.client;
-          const dispatch = resolvePlugin(plugins, parseIntentPlugin)?.provides.intent.dispatch;
-          if (!client || !dispatch) {
-            return [];
-          }
-
-          return createExtension({
-            id: ScriptAction.CREATE,
-            filter: (node): node is ActionGroup => isActionGroup(node) && node.id.startsWith(SpaceAction.ADD_OBJECT),
-            actions: ({ node }) => {
-              const id = node.id.split('/').at(-1);
-              const [spaceId, objectId] = id?.split(':') ?? [];
-              const space = client.spaces.get().find((space) => space.id === spaceId);
-              const object = objectId && space?.db.getObjectById(objectId);
-              const target = objectId ? object : space;
-              if (!target) {
-                return;
-              }
-
-              return [
-                {
-                  id: `${SCRIPT_PLUGIN}/create/${node.id}`,
-                  data: async () => {
-                    await dispatch([
-                      { plugin: SCRIPT_PLUGIN, action: ScriptAction.CREATE },
-                      { action: SpaceAction.ADD_OBJECT, data: { target } },
-                      { action: NavigationAction.OPEN },
-                    ]);
-                  },
-                  properties: {
-                    label: ['create object label', { ns: SCRIPT_PLUGIN }],
-                    icon: 'ph--code--regular',
-                    testId: 'scriptPlugin.createObject',
-                  },
-                },
-              ];
-            },
-          });
-        },
-      },
-      surface: {
-        component: ({ data, role }) => {
-          switch (role) {
-            case 'settings': {
-              return data.plugin === meta.id ? <ScriptSettings settings={{}} /> : null;
-            }
-
-            case 'article': {
-              if (data.object instanceof ScriptType) {
-                return <ScriptContainer script={data.object} env={compiler.environment} />;
-              }
-              break;
-            }
-
-            case 'complementary--automation': {
-              if (data.subject instanceof ScriptType) {
-                return {
-                  node: <AutomationPanel subject={data.subject as any} />,
-                  disposition: 'hoist',
-                };
-              }
-              break;
-            }
-
-            case 'complementary--settings': {
-              if (data.subject instanceof ScriptType) {
-                return <ScriptSettingsPanel script={data.subject} />;
-              }
-              break;
-            }
-          }
-
-          return null;
-        },
-      },
-      intent: {
-        resolver: (intent) => {
-          switch (intent.action) {
-            case ScriptAction.CREATE: {
-              return {
-                data: create(ScriptType, {
-                  source: create(TextType, {
-                    content: templates[0].source,
-                  }),
-                }),
-              };
-            }
-          }
-        },
-      },
-    },
-  };
-};
+        }),
+    }),
+    defineModule({
+      id: `${meta.id}/module/schema`,
+      activatesOn: ClientEvents.SetupSchema,
+      activate: () => [
+        contributes(ClientCapabilities.SystemSchema, [FunctionType]),
+        contributes(ClientCapabilities.Schema, [ScriptType]),
+      ],
+    }),
+    defineModule({
+      id: `${meta.id}/module/react-surface`,
+      activatesOn: Events.SetupSurfaces,
+      activate: ReactSurface,
+    }),
+    defineModule({
+      id: `${meta.id}/module/intent-resolver`,
+      activatesOn: Events.SetupIntents,
+      activate: IntentResolver,
+    }),
+    defineModule({
+      id: `${meta.id}/module/artifact`,
+      activatesOn: Events.Startup,
+      activate: Artifact,
+    }),
+  ]);

package/src/capabilities/artifact.ts

@@ -0,0 +1,219 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capabilities, contributes, createIntent, type PromiseIntentDispatcher } from '@dxos/app-framework';
+import { defineArtifact, defineTool, ToolResult } from '@dxos/artifact';
+import { createArtifactElement } from '@dxos/assistant';
+import { ObjectId, S } from '@dxos/echo-schema';
+import { ScriptType } from '@dxos/functions';
+import { invariant } from '@dxos/invariant';
+import { SpaceAction } from '@dxos/plugin-space/types';
+import { create, makeRef, type Space } from '@dxos/react-client/echo';
+import { TextType } from '@dxos/schema';
+
+// TODO(burdon): Factor out.
+declare global {
+  interface ToolContextExtensions {
+    space?: Space;
+    dispatch?: PromiseIntentDispatcher;
+  }
+}
+
+export default () => {
+  const definition = defineArtifact({
+    id: 'plugin-script',
+    // TODO(dmaretskyi): Since writing scripts requires a lot of domain knowledge,
+    //                   we should offload the work of synthesizing the code to a separate model.
+    //                   The main reasoning model will give it a concrete task and the script model will synthesize the code, knowing all the docs.
+    instructions: `
+      If the user explicitly requests you to write a script, you can create one.
+      If the user requests you to change one of the existing script, you can update it.
+      Scripts are short code pieces of executable code that can be used to perform computations, integrate with external systems, and perform automated tasks.
+      Each script must follow as strict shape for the definition but the body can contain any valid executable code.
+      Scripts are written in JavaScript or TypeScript.
+      Each script must define an input schema and output schema.
+      Each script must have its own detailed description.
+
+      Important: You cannot execute scripts. Scripts are only available as tools after the user deploys them. You must only call the available tools.
+
+      Description:
+        The description is a detailed description of the script.
+        It is used to describe the script's purpose, input, and output.
+        The description is used to generate the script's documentation.
+        The description is also goes into the script metadata.
+        The description is used by AI to understand the script and its purpose.
+        The description must provide cases on when the script should be used.
+
+      Schema: 
+        The schema is defined using a schema-DSL library called Effect Schema.
+        The input schema describes the arguments that the script accepts.
+        The output schema describes the result that the script produces.
+        The schema is used to validate the script's input and output.
+        The schema is also goes into the script metadata.
+        The properties in the schema must have valid descriptions.
+        The input and output schemas must both be a struct of fields.
+
+      Restricts:
+        The scripts can only import code from "dxos:functions" module. No other modules are allowed.
+        Some web APIs are available - like fetch.
+
+      Reasoning:
+        Before writing a script, synthesize the following information:
+        - Description
+        - What APIs will be used.
+        - Detailed input schema
+        - Detailed output schema
+
+      <apis>
+        export function defineFunction(params: { 
+          description: string, 
+          inputSchema: S.Schema, 
+          outputSchema: S.Schema, 
+          handler: (params: { event: { data: TInput } }) => Promise<TOutput> 
+        }): FunctionDefinition
+        /**
+         * Effect Schema
+         */
+        export const S; 
+
+        // Examples: 
+
+        S.String
+        S.Number
+        S.Boolean
+        S.Struct({
+          from: S.String.annotations({ description: 'The source currency' }),
+          to: S.String.annotations({ description: 'The target currency' }),
+        })
+        S.Array(S.String)
+        S.Union(S.String, S.Number)
+        S.optional(S.String)
+        S.String.annotations({ description: 'The source currency' })
+      </apis>
+
+      <handler_function>
+        Async function that takes the argument in the form of:
+
+        type HandlerFunctionParam = {
+          event: {
+            data: T // The input schema
+          },
+        }
+
+        The function must return the result that matches the output schema.
+      </handler_function>
+      
+      <example>
+        import { defineFunction, S } from 'dxos:functions';
+
+        export default defineFunction({
+          description: 'Returns the exchange rate between two currencies.',
+
+          inputSchema: S.Struct({
+            from: S.String.annotations({ description: 'The source currency' }),
+            to: S.String.annotations({ description: 'The target currency' }),
+          }),
+
+          outputSchema: S.Struct({
+            rate: S.String.annotations({ description: 'The exchange rate' }),
+          }),
+
+          handler: async ({
+            event: {
+              data: { from, to },
+            },
+          }: any) => {
+            const res = await fetch(\`https://free.ratesdb.com/v1/rates?from=\${from}&to=\${to}\`);
+            const {
+              data: { rates },
+            } = await res.json();
+
+            return { rate: rates[to].toString() };
+          },
+        });
+      </example>
+  `,
+    schema: ScriptType,
+    tools: [
+      defineTool({
+        name: 'script_new',
+        description: 'Create a new script. Returns the artifact definition for the script',
+        schema: S.Struct({
+          name: S.String.annotations({ description: 'The name of the script' }),
+          code: S.String.annotations({
+            description: 'The full code of the script in JavaScript or TypeScript. Must be valid executable code.',
+          }),
+        }),
+        execute: async ({ name, code }, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+          invariant(extensions?.dispatch, 'No intent dispatcher');
+          const script = create(ScriptType, {
+            name,
+            source: makeRef(
+              create(TextType, {
+                content: code,
+              }),
+            ),
+          });
+          extensions.space.db.add(script);
+          await extensions.space.db.flush();
+
+          const intent = createIntent(SpaceAction.AddObject, { target: extensions.space, object: script });
+          const { data, error } = await extensions.dispatch(intent);
+          if (!data || error) {
+            return ToolResult.Error(error?.message ?? 'Failed to create chess game');
+          }
+
+          return ToolResult.Success(createArtifactElement(script.id));
+        },
+      }),
+      defineTool({
+        name: 'script_inspect',
+        description: 'Inspect a script. Returns the artifact definition for the script',
+        schema: S.Struct({
+          id: ObjectId,
+        }),
+        execute: async ({ id }, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+
+          const script = (await extensions.space.db.query({ id }).first()) as ScriptType;
+          const { content } = await script.source.load();
+
+          return ToolResult.Success({
+            name: script.name,
+            code: content,
+          });
+        },
+      }),
+      defineTool({
+        name: 'script_update',
+        description: 'Update a script. Returns the artifact definition for the script',
+        schema: S.Struct({
+          id: ObjectId,
+          code: S.String.annotations({
+            description: 'The full code of the script in JavaScript or TypeScript. Must be valid executable code.',
+          }),
+        }),
+        execute: async ({ id, code }, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+
+          const script = (await extensions.space.db.query({ id }).first()) as ScriptType;
+          const source = await script.source.load();
+          if (!source) {
+            return ToolResult.Error('Script not found');
+          }
+
+          source.content = code;
+          await extensions.space?.db.flush();
+
+          return ToolResult.Success({
+            name: script.name,
+          });
+        },
+      }),
+    ],
+  });
+
+  return contributes(Capabilities.ArtifactDefinition, definition);
+};

package/src/capabilities/capabilities.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { defineCapability } from '@dxos/app-framework';
+
+import { type Compiler } from '../compiler';
+import { SCRIPT_PLUGIN } from '../meta';
+
+export namespace ScriptCapabilities {
+  export const Compiler = defineCapability<Compiler>(`${SCRIPT_PLUGIN}/capability/compiler`);
+}

package/src/capabilities/compiler.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @ts-ignore
+import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
+
+import { contributes } from '@dxos/app-framework';
+import { initializeBundler } from '@dxos/functions/bundler';
+
+import { ScriptCapabilities } from './capabilities';
+import { Compiler } from '../compiler';
+
+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;
+      `,
+  );
+  await initializeBundler({ wasmUrl });
+
+  return contributes(ScriptCapabilities.Compiler, compiler);
+};

package/src/capabilities/index.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { lazy } from '@dxos/app-framework';
+
+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 const Artifact = lazy(() => import('./artifact'));
+
+export * from './capabilities';