@dxos/plugin-script 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

package/src/blueprints/functions/update.ts

@@ -0,0 +1,69 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { next as A, type Doc } from '@automerge/automerge';
+import * as Effect from 'effect/Effect';
+
+import { Database, Obj } from '@dxos/echo';
+import { DocAccessor, createDocAccessor } from '@dxos/echo-db';
+import { type Script } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
+
+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.change(script, (draft) => {
+          if (name !== undefined) {
+            draft.name = name;
+          }
+          if (description !== undefined) {
+            draft.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.change(script, (draft) => {
+          draft.changed = true;
+        });
+      }
+
+      return {
+        function: Obj.getDXN(loaded).toString(),
+      };
+    }),
+  ),
+);

package/src/blueprints/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * as ScriptBlueprint from './script-blueprint';
+export { default as ScriptBlueprint } from './script-blueprint';

package/src/blueprints/script-blueprint.ts

@@ -2,23 +2,55 @@
 // Copyright 2025 DXOS.org
 //
 
+import { type AppCapabilities } from '@dxos/app-toolkit';
 import { Blueprint, Template } from '@dxos/blueprints';
-import { type FunctionDefinition } from '@dxos/functions';
 import { trim } from '@dxos/util';
 
-export const functions: FunctionDefinition[] = [];
-export const tools: string[] = [];
+import {
+  Create,
+  Read,
+  Update,
+  Delete,
+  Deploy,
+  Invoke,
+  InspectInvocations,
+  QueryDeployedFunctions,
+  InstallFunction,
+} from './functions';
 
-export const Key = 'dxos.org/blueprint/script';
+const BLUEPRINT_KEY = 'org.dxos.blueprint.script';
 
-export const make = () =>
+const make = () =>
   Blueprint.make({
-    key: Key,
+    key: BLUEPRINT_KEY,
     name: 'Script',
-    tools: Blueprint.toolDefinitions({ functions, tools }),
+    agentCanEnable: true,
+    tools: Blueprint.toolDefinitions({
+      operations: [
+        Create,
+        Read,
+        Update,
+        Delete,
+        Deploy,
+        Invoke,
+        InspectInvocations,
+        QueryDeployedFunctions,
+        InstallFunction,
+      ],
+    }),
     instructions: Template.make({
       source: trim`
-        You can create and update scripts which contain Typescript code.
+        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: AppCapabilities.BlueprintDefinition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

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

@@ -0,0 +1,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode } from '@dxos/app-toolkit';
+import { Script } from '@dxos/functions';
+import { GraphBuilder } from '@dxos/plugin-graph';
+
+import { meta } from '#meta';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* Effect.all([
+      GraphBuilder.createTypeExtension({
+        id: `${meta.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: `${meta.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/{artifact-definition/artifact-definition.ts → artifact-definition.ts}

@@ -18,7 +18,7 @@ import { invariant } from '@dxos/invariant';
 import { SpaceAction } from '@dxos/plugin-space/types';
 import { type Space } from '@dxos/react-client/echo';
 
-import { meta } from '../../meta';
+import { meta } from '#meta';
 
 // TODO(burdon): Factor out.
 declare global {

package/src/capabilities/blueprint-definition.ts

@@ -0,0 +1,17 @@
+//
+// 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';
+
+const blueprintDefinition = Capability.makeModule<
+  [],
+  Capability.Capability<typeof AppCapabilities.BlueprintDefinition>[]
+>(() => Effect.succeed([Capability.contributes(AppCapabilities.BlueprintDefinition, ScriptBlueprint)]));
+
+export default blueprintDefinition;

package/src/capabilities/{compiler/compiler.ts → compiler.ts}

@@ -15,8 +15,8 @@ import { initializeBundler } from '@dxos/functions-runtime/bundler';
 import { log } from '@dxos/log';
 import { trim } from '@dxos/util';
 
-import { Compiler } from '../../compiler';
-import { ScriptCapabilities } from '../../types';
+import { Compiler } from '../compiler';
+import { ScriptCapabilities } from '#types';
 
 // TODO(burdon): Document.
 const SCRIPT_PACKAGES_BUCKET = 'https://pub-5745ae82e450484aa28f75fc6a175935.r2.dev/dev/';

package/src/capabilities/index.ts

@@ -2,9 +2,15 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './app-graph-builder';
-export * from './blueprint-definition';
-export * from './compiler';
-export * from './operation-resolver';
-export * from './react-surface';
-export * from './settings';
+import { Capability } from '@dxos/app-framework';
+import { OperationHandlerSet } from '@dxos/operation';
+
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
+export const BlueprintDefinition = Capability.lazy('BlueprintDefinition', () => import('./blueprint-definition'));
+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/operation-handler.ts

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

package/src/capabilities/react-surface.tsx

@@ -0,0 +1,152 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface, useAtomCapability, useSettingsState } from '@dxos/app-framework/ui';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { InvocationTraceContainer } from '@dxos/devtools';
+import { Obj } from '@dxos/echo';
+import { Script } from '@dxos/functions';
+import { useClient } from '@dxos/react-client';
+import { getSpace } from '@dxos/react-client/echo';
+import { Panel } from '@dxos/react-ui';
+import { type AccessToken } from '@dxos/types';
+
+import { ScriptPluginSettings } from '#components';
+import { DEPLOYMENT_DIALOG } from '../constants';
+import {
+  DeploymentDialog,
+  NotebookContainer,
+  ScriptContainer,
+  ScriptObjectSettings,
+  ScriptProperties,
+  TestContainer,
+} from '#containers';
+import { useCompiler } from '#hooks';
+import { meta } from '#meta';
+import { Notebook, ScriptCapabilities, type Settings } from '#types';
+import { getAccessCredential } from '../util';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: `${meta.id}.plugin-settings`,
+        role: 'article',
+        filter: (data): data is { subject: AppCapabilities.Settings } =>
+          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
+        component: ({ data: { subject } }) => {
+          const { settings, updateSettings } = useSettingsState<Settings.Settings>(subject.atom);
+          const client = useClient();
+          // TODO(burdon): Check token.
+          const handleAuthenticate = async () => {
+            const { identityKey } = client.halo.identity.get()!;
+            await client.halo.writeCredentials([getAccessCredential(identityKey)]);
+          };
+          return (
+            <ScriptPluginSettings
+              settings={settings}
+              onSettingsChange={updateSettings}
+              onAuthenticate={handleAuthenticate}
+            />
+          );
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}.script.article`,
+        role: ['article', 'section'],
+        filter: (data): data is { subject: Script.Script; attendableId: string } =>
+          Obj.instanceOf(Script.Script, data.subject),
+        component: ({ data, role }) => {
+          const compiler = useCompiler();
+          const settings = useAtomCapability(ScriptCapabilities.Settings);
+          // TODO(wittjosiah): Why? The editor should be allow to render even if the environment is not ready.
+          if (!compiler?.environment) {
+            return null;
+          }
+
+          return (
+            <ScriptContainer
+              role={role}
+              subject={data.subject}
+              attendableId={data.attendableId}
+              settings={settings}
+              env={compiler?.environment}
+            />
+          );
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}.notebook.article`,
+        role: 'article',
+        filter: (data): data is { subject: Notebook.Notebook; attendableId: string } =>
+          typeof data.attendableId === 'string' && Obj.instanceOf(Notebook.Notebook, data.subject),
+        component: ({ data, role }) => {
+          const compiler = useCompiler();
+          return (
+            <NotebookContainer
+              role={role}
+              subject={data.subject}
+              attendableId={data.attendableId}
+              env={compiler?.environment}
+            />
+          );
+        },
+      }),
+      // TODO(burdon): Standardize PluginSettings vs ObjectSettings.
+      // TODO(burdon): Why is ScriptProperties different from ScriptObjectSettings?
+      Surface.create({
+        id: `${meta.id}.companion.base-settings`,
+        role: 'base-object-settings',
+        filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
+        component: ({ data }) => <ScriptProperties object={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}.companion.settings`,
+        role: 'object-settings',
+        filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
+        component: ({ data }) => <ScriptObjectSettings object={data.subject} />,
+      }),
+      Surface.create({
+        id: `${meta.id}.companion.execute`,
+        role: 'article',
+        filter: (data): data is { companionTo: Script.Script } =>
+          Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'execute',
+        component: ({ data, role }) => <TestContainer script={data.companionTo} role={role} />,
+      }),
+      Surface.create({
+        id: `${meta.id}.companion.logs`,
+        role: 'article',
+        filter: (data): data is { companionTo: Script.Script } =>
+          Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'logs',
+        component: ({ data, role }) => {
+          const space = getSpace(data.companionTo);
+          const queueDxn = space?.properties.invocationTraceQueue?.dxn;
+          return (
+            <Panel.Root role={role}>
+              <Panel.Content asChild>
+                <InvocationTraceContainer
+                  db={space?.db}
+                  queueDxn={queueDxn}
+                  target={data.companionTo}
+                  detailAxis='block'
+                />
+              </Panel.Content>
+            </Panel.Root>
+          );
+        },
+      }),
+      Surface.create({
+        id: DEPLOYMENT_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { props: { accessToken: AccessToken.AccessToken; scriptTemplates: any } } =>
+          data.component === DEPLOYMENT_DIALOG,
+        component: ({ data }) => <DeploymentDialog {...data.props} />,
+      }),
+    ]),
+  ),
+);

package/src/capabilities/{settings/settings.ts → settings.ts}

@@ -4,17 +4,18 @@
 
 import * as Effect from 'effect/Effect';
 
-import { Capability, Common } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
 import { createKvsStore } from '@dxos/effect';
 
-import { meta } from '../../meta';
-import { ScriptCapabilities, ScriptSettings } from '../../types';
+import { meta } from '#meta';
+import { ScriptCapabilities, Settings } from '#types';
 
 export default Capability.makeModule(() =>
   Effect.sync(() => {
     const settingsAtom = createKvsStore({
       key: meta.id,
-      schema: ScriptSettings,
+      schema: Settings.Settings,
       defaultValue: () => ({
         editorInputMode: 'vscode' as const,
       }),
@@ -22,9 +23,9 @@ export default Capability.makeModule(() =>
 
     return [
       Capability.contributes(ScriptCapabilities.Settings, settingsAtom),
-      Capability.contributes(Common.Capability.Settings, {
+      Capability.contributes(AppCapabilities.Settings, {
         prefix: meta.id,
-        schema: ScriptSettings,
+        schema: Settings.Settings,
         atom: settingsAtom,
       }),
     ];

package/src/components/{FrameContainer/FrameContainer.tsx → FramePanel/FramePanel.tsx}

@@ -11,9 +11,9 @@ import { log } from '@dxos/log';
 import { useClient } from '@dxos/react-client';
 import { createProtoRpcPeer } from '@dxos/rpc';
 import { createIFramePort } from '@dxos/rpc-tunnel';
-import { baseSurface, mx } from '@dxos/ui-theme';
+import { mx } from '@dxos/ui-theme';
 
-export type FrameContainerProps = {
+export type FramePanelProps = {
   containerUrl: string;
   result: BundleResult;
   debug?: boolean;
@@ -22,7 +22,7 @@ export type FrameContainerProps = {
 /**
  * IFrame container for the compiled script.
  */
-export const FrameContainer = ({ containerUrl, result, debug = true }: FrameContainerProps) => {
+export const FramePanel = ({ containerUrl, result, debug = true }: FramePanelProps) => {
   const client = useClient();
   const iframeRef = useRef<HTMLIFrameElement>(null);
   useEffect(() => {
@@ -61,8 +61,7 @@ export const FrameContainer = ({ containerUrl, result, debug = true }: FrameCont
         <div className='relative'>
           <div
             className={mx(
-              baseSurface,
-              'flex absolute right-2 bottom-2 is-[30rem] bs-[200px] ring rounded',
+              'flex absolute right-2 bottom-2 w-[30rem] h-[200px] bg-base-surface ring rounded-sm',
               'z-20 overflow-x-hidden overflow-y-auto',
             )}
           >

package/src/components/{FrameContainer → FramePanel}/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './FrameContainer';
+export * from './FramePanel';

package/src/components/NotebookStack/NotebookCell.tsx

@@ -4,7 +4,7 @@
 
 import React, { useCallback, useMemo } from 'react';
 
-import { Surface } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
 import { type Database, Obj } from '@dxos/echo';
 import { createDocAccessor } from '@dxos/echo-db';
 import { invariant } from '@dxos/invariant';
@@ -23,15 +23,15 @@ import {
 import { mx } from '@dxos/ui-theme';
 import { isNonNullable } from '@dxos/util';
 
-import { meta } from '../../meta';
+import { meta } from '#meta';
 import { type ComputeGraph } from '../../notebook';
-import { type Notebook } from '../../types';
+import { type Notebook } from '#types';
 import { TypescriptEditor, type TypescriptEditorProps } from '../TypescriptEditor';
 
 import { type NotebookMenuProps } from './NotebookMenu';
 
-const editorStyles = 'p-2 pis-3';
-const valueStyles = 'p-1 pis-3';
+const editorStyles = 'p-2 ps-3';
+const valueStyles = 'p-1 ps-3';
 
 export type NotebookCellProps = {
   db?: Database.Database;
@@ -61,8 +61,8 @@ export const NotebookCell = ({ db, graph, dragging, cell, promptResults, env }:
   const handleQueryChange = useCallback<NonNullable<QueryEditorProps['onChange']>>(
     (value: string) => {
       invariant(cell.source?.target);
-      Obj.change(cell.source.target, (s) => {
-        s.content = value;
+      Obj.change(cell.source.target, (obj) => {
+        obj.content = value;
       });
     },
     [cell],
@@ -98,7 +98,7 @@ export const NotebookCell = ({ db, graph, dragging, cell, promptResults, env }:
             extensions={extensions}
             env={env}
             options={{
-              placeholder: t('notebook cell placeholder'),
+              placeholder: t('notebook-cell.placeholder'),
               highlightActiveLine: false,
               lineNumbers: false,
             }}
@@ -114,17 +114,15 @@ export const NotebookCell = ({ db, graph, dragging, cell, promptResults, env }:
 
       // TODO(burdon): Remove app-framework deps (via render prop).
       return (
-        <div
-          className={mx('bs-full overflow-hidden grid', explorerGraph && !dragging && 'grid-rows-[min-content_1fr]')}
-        >
+        <div className={mx('h-full overflow-hidden grid', explorerGraph && !dragging && 'grid-rows-[min-content_1fr]')}>
           <QueryEditor
             id={cell.id}
-            classNames={[editorStyles, 'border-be border-subduedSeparator']}
+            classNames={[editorStyles, 'border-b border-subdued-separator']}
             db={db}
             value={cell.source.target.content}
             onChange={handleQueryChange}
           />
-          {explorerGraph && !dragging && <Surface role='section' limit={1} data={{ subject: explorerGraph }} />}
+          {explorerGraph && !dragging && <Surface.Surface role='section' limit={1} data={{ subject: explorerGraph }} />}
         </div>
       );
 
@@ -161,13 +159,13 @@ const NotebookCellValue = ({ cell, graph }: NotebookCellProps) => {
   return (
     <div
       className={mx(
-        'flex is-full bg-groupSurface border-bs border-subduedSeparator text-description font-mono',
+        'flex w-full bg-group-surface border-y border-subdued-separator text-description font-mono',
         valueStyles,
       )}
     >
       {name && (
         <>
-          <span className='text-successText'>{name}</span>
+          <span className='text-success-text'>{name}</span>
           <span className='text-description'>&nbsp;=&nbsp;</span>
         </>
       )}
@@ -187,7 +185,7 @@ const NotebookPromptResult = ({ cell, promptResults }: NotebookCellProps) => {
   }
 
   return (
-    <div className={mx('flex is-full bg-groupSurface text-description border-bs border-subduedSeparator', valueStyles)}>
+    <div className={mx('flex w-full bg-group-surface text-description border-y border-subdued-separator', valueStyles)}>
       <NotebookTextEditor readOnly value={value} />
     </div>
   );
@@ -203,7 +201,7 @@ const NotebookTextEditor = ({
   const extensions = useMemo(() => {
     return [
       createBasicExtensions({
-        placeholder: t('notebook markdown placeholder'),
+        placeholder: t('notebook-markdown.placeholder'),
         readOnly,
       }),
       createThemeExtensions({ themeMode, syntaxHighlighting: true }),

package/src/components/NotebookStack/NotebookMenu.tsx

@@ -6,8 +6,8 @@ import React from 'react';
 
 import { DropdownMenu, useTranslation } from '@dxos/react-ui';
 
-import { meta } from '../../meta';
-import { type Notebook } from '../../types';
+import { meta } from '#meta';
+import { type Notebook } from '#types';
 
 export type NotebookMenuProps = {
   cell?: Notebook.Cell;
@@ -23,20 +23,20 @@ export const NotebookMenu = ({ cell, onCellInsert, onCellDelete }: NotebookMenuP
       <DropdownMenu.Content>
         <DropdownMenu.Viewport>
           <DropdownMenu.Item onClick={() => onCellInsert?.('script', cell?.id)}>
-            {t('notebook cell insert script label')}
+            {t('notebook-cell-insert-script.label')}
           </DropdownMenu.Item>
           <DropdownMenu.Item onClick={() => onCellInsert?.('prompt', cell?.id)}>
-            {t('notebook cell insert prompt label')}
+            {t('notebook-cell-insert-prompt.label')}
           </DropdownMenu.Item>
           <DropdownMenu.Item onClick={() => onCellInsert?.('query', cell?.id)}>
-            {t('notebook cell insert query label')}
+            {t('notebook-cell-insert-query.label')}
           </DropdownMenu.Item>
           <DropdownMenu.Item onClick={() => onCellInsert?.('markdown', cell?.id)}>
-            {t('notebook cell insert markdown label')}
+            {t('notebook-cell-insert-markdown.label')}
           </DropdownMenu.Item>
           {cell && onCellDelete && (
             <DropdownMenu.Item onClick={() => onCellDelete?.(cell.id)}>
-              {t('notebook cell delete label')}
+              {t('notebook-cell-delete.label')}
             </DropdownMenu.Item>
           )}
         </DropdownMenu.Viewport>