@dxos/plugin-script 0.8.4-main.70d3990 → 0.8.4-main.765dc60934

package/src/{components/NotebookContainer.tsx → containers/NotebookArticle/NotebookArticle.tsx}

@@ -2,58 +2,57 @@
 // Copyright 2025 DXOS.org
 //
 
+import { RegistryContext } from '@effect-atom/atom-react';
 import * as Cause from 'effect/Cause';
 import * as Effect from 'effect/Effect';
 import * as Exit from 'effect/Exit';
-import React, { useCallback, useMemo, useState } from 'react';
+import type * as Types from 'effect/Types';
+import React, { useCallback, useContext, useMemo, useState } from 'react';
 
-import { Agent } from '@dxos/assistant-toolkit';
-import { Blueprint, Prompt } from '@dxos/blueprints';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { AgentPrompt } from '@dxos/assistant-toolkit';
+import { Blueprint, Routine } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
 import { Filter, Obj, Query, Ref } from '@dxos/echo';
 import { QueryBuilder } from '@dxos/echo-query';
-import { type FunctionDefinition, FunctionInvocationService } from '@dxos/functions';
-import { InvocationTracer } from '@dxos/functions-runtime';
-import { TracingServiceExt } from '@dxos/functions-runtime';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { useComputeRuntimeCallback } from '@dxos/plugin-automation';
-import { Graph } from '@dxos/plugin-explorer/types';
-import { getSpace } from '@dxos/react-client/echo';
-import { DropdownMenu, IconButton, Toolbar, useTranslation } from '@dxos/react-ui';
+import { useComputeRuntimeCallback } from '@dxos/plugin-automation/hooks';
+import { Graph } from '@dxos/plugin-explorer';
+import { DropdownMenu, IconButton, Panel, Toolbar, useTranslation } from '@dxos/react-ui';
 import { useAttention } from '@dxos/react-ui-attention';
-import { StackItem } from '@dxos/react-ui-stack';
-import { Text, View } from '@dxos/schema';
+import { Text, ViewModel } from '@dxos/schema';
 import { isNonNullable } from '@dxos/util';
 
-import { meta } from '../meta';
-import { ComputeGraph } from '../notebook';
-import { type Notebook } from '../types';
+import { NotebookMenu, NotebookStack, type NotebookStackProps, type TypescriptEditorProps } from '#components';
+import { meta } from '#meta';
+import { type Notebook } from '#types';
 
-import { NotebookMenu, NotebookStack, type NotebookStackProps } from './NotebookStack';
-import { type TypescriptEditorProps } from './TypescriptEditor';
+import { ComputeGraph } from '../../notebook';
 
-const INCLUDE_BLUEPRINTS = ['dxos.org/blueprint/assistant', 'dxos.org/blueprint/markdown'];
+const INCLUDE_BLUEPRINTS = [
+  'org.dxos.blueprint.assistant',
+  'org.dxos.blueprint.database',
+  'org.dxos.blueprint.markdown',
+];
 
 // TODO(burdon): Support calling named deployed functions (as with sheet).
 
-export type NotebookContainerProps = {
-  role?: string;
-  notebook?: Notebook.Notebook;
-} & Pick<TypescriptEditorProps, 'env'>;
+export type NotebookArticleProps = AppSurface.ObjectArticleProps<Notebook.Notebook, Pick<TypescriptEditorProps, 'env'>>;
 
-export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) => {
+export const NotebookArticle = ({ role, subject: notebook, attendableId, env }: NotebookArticleProps) => {
   const { t } = useTranslation(meta.id);
-  const space = getSpace(notebook);
-  const attendableId = notebook ? Obj.getDXN(notebook).toString() : '';
+  const registry = useContext(RegistryContext);
+  const db = Obj.getDatabase(notebook);
   const { hasAttention } = useAttention(attendableId);
 
   // TODO(burdon): Consolidate execution and state (with graph).
   //  Generalize ComputeGraph evaluation function (using effects).
-  const graph = useMemo(() => notebook && new ComputeGraph(notebook), [notebook]);
+  const graph = useMemo(() => notebook && new ComputeGraph(notebook, registry), [notebook, registry]);
 
   const [queryValues, setQueryValues] = useState<Record<string, any>>({});
   const handleExecQueries = useCallback(async () => {
-    invariant(space);
+    invariant(db);
 
     const builder = new QueryBuilder();
     for (const cell of notebook?.cells ?? []) {
@@ -65,12 +64,19 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
             const ast = Query.select(filter).ast;
             const graph = cell.graph?.target;
             if (!graph) {
-              const { view } = await View.makeFromSpace({ space });
-              const graph = Graph.make({ query: { ast }, view });
-              cell.graph = Ref.make(graph);
-              cell.name = name;
+              const { view } = await ViewModel.makeFromDatabase({ db });
+              const newGraph = Graph.make({ query: { ast }, view });
+              Obj.update(notebook!, (obj) => {
+                const c = obj.cells.find((c) => c.id === cell.id);
+                if (c) {
+                  c.graph = Ref.make(newGraph);
+                  c.name = name;
+                }
+              });
             } else {
-              graph.query.ast = ast;
+              Obj.update(graph, (graph) => {
+                graph.query.ast = ast as Obj.Mutable<typeof ast>;
+              });
             }
           }
         }
@@ -78,17 +84,17 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
         if (cell.name && cell.graph?.target) {
           const graph = Obj.getSnapshot(cell.graph?.target);
           const query = Query.fromAst(graph.query.ast);
-          const result = await space?.db.query(query).run();
-          const objectIds = result?.objects?.map((obj) => obj.id);
+          const objects = await db.query(query).run();
+          const objectIds = objects?.map((obj) => obj.id);
           setQueryValues((prev) => ({ ...prev, [cell.name!]: objectIds }));
         }
       }
     }
-  }, [space, notebook, graph]);
+  }, [db, notebook, graph]);
 
   const [promptResults, setPromptResults] = useState<Record<string, string>>({});
   const handleExecPrompts = useComputeRuntimeCallback(
-    space,
+    db?.spaceId,
     Effect.fnUntraced(function* () {
       invariant(graph);
 
@@ -101,7 +107,7 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
       for (const prompt of prompts) {
         yield* runPrompt({
           prompt,
-          input: { ...queryValues, ...graph.valuesByName.value },
+          input: { ...queryValues, ...graph.getValuesByName() },
           onResult: (result) =>
             setPromptResults((prev) => ({
               ...prev,
@@ -127,10 +133,12 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
       const from = notebook.cells.findIndex((cell) => cell.id === source.id);
       const to = notebook.cells.findIndex((cell) => cell.id === target.id);
       if (from != null && to != null) {
-        const cell = notebook.cells.splice(from, 1)[0];
-        if (cell) {
-          notebook.cells.splice(to, 0, cell);
-        }
+        Obj.update(notebook, (notebook) => {
+          const cell = notebook.cells.splice(from, 1)[0];
+          if (cell) {
+            notebook.cells.splice(to, 0, cell);
+          }
+        });
       }
     },
     [notebook],
@@ -139,7 +147,7 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
   const handleCellInsert = useCallback<NonNullable<NotebookStackProps['onCellInsert']>>(
     async (type, after) => {
       invariant(notebook);
-      const cell: Notebook.Cell = { id: crypto.randomUUID(), type };
+      const cell: Types.Mutable<Notebook.Cell> = { id: crypto.randomUUID(), type };
       switch (type) {
         case 'markdown':
         case 'script':
@@ -149,21 +157,26 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
         }
 
         case 'prompt': {
-          if (space) {
-            const result = await space.db.query(Query.select(Filter.type(Blueprint.Blueprint))).run();
-            const blueprints = result.objects
-              .filter((blueprint) => INCLUDE_BLUEPRINTS.includes(blueprint.key))
+          if (db) {
+            const objects = await db.query(Query.select(Filter.type(Blueprint.Blueprint))).run();
+            const blueprints = objects
+              .filter((blueprint) => {
+                const key = Obj.getMeta(blueprint).key;
+                return key !== undefined && INCLUDE_BLUEPRINTS.includes(key);
+              })
               .map((blueprint) => Ref.make(blueprint));
-            cell.prompt = Ref.make(Prompt.make({ instructions: '', blueprints }));
+            cell.prompt = Ref.make(Routine.make({ instructions: '', blueprints }));
           }
           break;
         }
       }
 
       const idx = after ? notebook.cells.findIndex((cell) => cell.id === after) : notebook.cells.length;
-      notebook.cells.splice(idx, 0, cell);
+      Obj.update(notebook, (notebook) => {
+        notebook.cells.splice(idx, 0, cell);
+      });
     },
-    [space, notebook],
+    [db, notebook],
   );
 
   const handleCellDelete = useCallback<NonNullable<NotebookStackProps['onCellDelete']>>(
@@ -171,33 +184,36 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
       invariant(notebook);
       const idx = notebook.cells.findIndex((cell) => cell.id === id);
       if (idx !== -1) {
-        notebook.cells.splice(idx, 1);
+        Obj.update(notebook, (notebook) => {
+          notebook.cells.splice(idx, 1);
+        });
       }
     },
     [notebook],
   );
 
   return (
-    <StackItem.Content toolbar>
-      <Toolbar.Root disabled={!hasAttention} textBlockWidth>
-        <DropdownMenu.Root>
-          <DropdownMenu.Trigger asChild>
-            <IconButton icon='ph--plus--regular' iconOnly label={t('notebook cell insert label')} />
-          </DropdownMenu.Trigger>
-          <NotebookMenu onCellInsert={handleCellInsert} />
-        </DropdownMenu.Root>
-        <Toolbar.IconButton
-          icon='ph--play--fill'
-          iconOnly
-          label={t('compute label')}
-          classNames='text-green-500'
-          onClick={handleCompute}
-        />
-      </Toolbar.Root>
-      <div role='none' className='flex bs-full overflow-hidden -mis-[1px] -mie-[1px]'>
+    <Panel.Root role={role} className='dx-document'>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root disabled={!hasAttention}>
+          <DropdownMenu.Root>
+            <DropdownMenu.Trigger asChild>
+              <IconButton icon='ph--plus--regular' iconOnly label={t('notebook-cell-insert.label')} />
+            </DropdownMenu.Trigger>
+            <NotebookMenu onCellInsert={handleCellInsert} />
+          </DropdownMenu.Root>
+          <Toolbar.IconButton
+            icon='ph--play--fill'
+            iconOnly
+            label={t('compute.label')}
+            classNames='text-success-text'
+            onClick={handleCompute}
+          />
+        </Toolbar.Root>
+      </Panel.Toolbar>
+      <Panel.Content asChild>
         <NotebookStack
-          classNames='container-max-width border-l border-r border-subduedSeparator'
-          space={space}
+          db={db}
           notebook={notebook}
           graph={graph}
           env={env}
@@ -206,40 +222,24 @@ export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) =>
           onCellInsert={handleCellInsert}
           onCellDelete={handleCellDelete}
         />
-      </div>
-    </StackItem.Content>
+      </Panel.Content>
+    </Panel.Root>
   );
 };
 
-export default NotebookContainer;
-
 // TODO(wittjosiah): Factor out. Copied from PromptArticle in plugin-assistant.
 const runPrompt = Effect.fn(function* ({
   prompt,
   input,
   onResult,
 }: {
-  prompt: Ref.Ref<Prompt.Prompt>;
+  prompt: Ref.Ref<Routine.Routine>;
   input: Record<string, any>;
   onResult: (result: string) => void;
 }) {
-  const inputData: FunctionDefinition.Input<typeof Agent.prompt> = {
-    prompt,
-    input,
-  };
-  const tracer = yield* InvocationTracer;
-  const trace = yield* tracer.traceInvocationStart({
-    target: undefined,
-    payload: {
-      data: {},
-    },
-  });
-
+  const inputData: Operation.Definition.Input<typeof AgentPrompt> = { prompt, input };
   // Invoke the function.
-  const result = yield* FunctionInvocationService.invokeFunction(Agent.prompt, inputData).pipe(
-    Effect.provide(TracingServiceExt.layerQueue(trace.invocationTraceQueue)),
-    Effect.exit,
-  );
+  const result = yield* Operation.invoke(AgentPrompt, inputData).pipe(Effect.orDie, Effect.exit);
 
   Exit.match(result, {
     onFailure: (cause) => {
@@ -251,10 +251,4 @@ const runPrompt = Effect.fn(function* ({
       onResult(result.note);
     },
   });
-
-  yield* tracer.traceInvocationEnd({
-    trace,
-    // TODO(dmaretskyi): Might miss errors.
-    exception: Exit.isFailure(result) ? Cause.prettyErrors(result.cause)[0] : undefined,
-  });
 });

package/src/containers/NotebookArticle/index.ts

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

package/src/containers/ScriptArticle/ScriptArticle.stories.tsx

@@ -0,0 +1,107 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React, { useEffect, useState } from 'react';
+
+import { SERVICES_CONFIG } from '@dxos/ai/testing';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Blueprint } from '@dxos/compute';
+import { Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { Filter } from '@dxos/echo';
+import { ClientPlugin } from '@dxos/plugin-client/testing';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { Config } from '@dxos/react-client';
+import { useQuery, useSpaces } from '@dxos/react-client/echo';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { createScript } from '#testing';
+import { translations } from '#translations';
+
+import { ScriptArticle } from './ScriptArticle';
+
+type DefaultStoryProps = {};
+
+/**
+ * Loads the script source ref so `script.source.target` is available for the editor.
+ */
+const DefaultStory = (_: DefaultStoryProps) => {
+  const [space] = useSpaces();
+  const [script] = useQuery(space?.db, Filter.type(Script.Script));
+  const [sourceReady, setSourceReady] = useState(false);
+
+  useEffect(() => {
+    if (!script) {
+      setSourceReady(false);
+      return;
+    }
+
+    let canceled = false;
+    void (async () => {
+      await script.source.load();
+      if (!canceled) {
+        setSourceReady(true);
+      }
+    })();
+
+    return () => {
+      canceled = true;
+    };
+  }, [script]);
+
+  if (!script || !sourceReady) {
+    return <Loading />;
+  }
+
+  return (
+    <div className='flex flex-col min-h-[80vh] w-document-max-width'>
+      <ScriptArticle role='article' subject={script} attendableId='story-script' />
+    </div>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/containers/ScriptArticle',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column', classNames: 'w-document-max-width' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          config: new Config({
+            runtime: {
+              services: SERVICES_CONFIG.REMOTE,
+            },
+          }),
+          types: [Script.Script, Operation.PersistentOperation, Blueprint.Blueprint, Text.Text],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+              const [space] = client.spaces.get();
+              yield* Effect.promise(() => space.waitUntilReady());
+
+              createScript(space);
+            }),
+        }),
+        StorybookPlugin({}),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<DefaultStoryProps>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/ScriptArticle/ScriptArticle.tsx

@@ -0,0 +1,85 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Script } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-db';
+import { getSpace } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Panel } from '@dxos/react-ui';
+import { createDataExtensions, listener, editorClassNames } from '@dxos/ui-editor';
+
+import { ScriptToolbar, TypescriptEditor, type TypescriptEditorProps } from '#components';
+import { useDeployState, useToolbarState } from '#hooks';
+import { type Settings } from '#types';
+
+export type ScriptEditorProps = AppSurface.ObjectArticleProps<
+  Script.Script,
+  {
+    settings?: Settings.Settings;
+  } & Pick<TypescriptEditorProps, 'env'>
+>;
+
+export const ScriptArticle = ({
+  role,
+  attendableId,
+  subject: script,
+  settings = { editorInputMode: 'vscode' },
+  env,
+}: ScriptEditorProps) => {
+  const identity = useIdentity();
+  const space = getSpace(script);
+  const state = useToolbarState();
+  useDeployState({ script, state });
+
+  const extensions = useMemo(() => {
+    if (!script.source.target) {
+      return [];
+    }
+
+    return [
+      createDataExtensions({
+        id: script.id,
+        text: createDocAccessor(script.source.target, ['content']),
+        messenger: space,
+        identity,
+      }),
+      listener({
+        onChange: ({ text }) => {
+          if (script.source.target?.content !== text) {
+            Obj.update(script, (script) => {
+              script.changed = true;
+            });
+          }
+        },
+      }),
+    ];
+  }, [identity, space, script, script.source.target]);
+
+  if (!extensions.length) {
+    return null;
+  }
+
+  return (
+    <Panel.Root role={role}>
+      <Panel.Toolbar asChild>
+        <ScriptToolbar script={script} attendableId={attendableId} state={state} role={role} />
+      </Panel.Toolbar>
+      <Panel.Content asChild>
+        <TypescriptEditor
+          classNames={editorClassNames(role)}
+          id={script.id}
+          env={env}
+          initialValue={script.source?.target?.content}
+          extensions={extensions}
+          inputMode={settings.editorInputMode}
+          toolbar
+        />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/ScriptArticle/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { ScriptArticle as default } from './ScriptArticle';

package/src/containers/ScriptProperties/BlueprintEditor.tsx

@@ -0,0 +1,102 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useState } from 'react';
+
+import { ToolId } from '@dxos/ai';
+import { Blueprint, Template } from '@dxos/compute';
+import { type Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { Filter, Obj, Ref } from '@dxos/echo';
+import { useQuery } from '@dxos/react-client/echo';
+import { Button, Input, useAsyncEffect, useTranslation } from '@dxos/react-ui';
+import { Form } from '@dxos/react-ui-form';
+import { kebabize } from '@dxos/util';
+
+import { meta } from '#meta';
+
+export type BlueprintEditorProps = { object: Script.Script };
+
+export const BlueprintEditor = ({ object }: BlueprintEditorProps) => {
+  const { t } = useTranslation(meta.id);
+  const db = Obj.getDatabase(object);
+  const [fn] = useQuery(db, Filter.type(Operation.PersistentOperation, { source: Ref.make(object) }));
+  const blueprints = useQuery(db, Filter.type(Blueprint.Blueprint));
+
+  const [creating, setCreating] = useState(false);
+  // TODO(burdon): Remove?
+  const [instructions, setInstructions] = useState<string>(`You can run the script "${object.name ?? 'script'}".`);
+  const blueprintKey = `org.dxos.blueprint.${kebabize(object.name ?? 'script')}`;
+  const existingBlueprint = blueprints.find((bp) => Obj.getMeta(bp).key === blueprintKey);
+  const fnKey = fn ? Obj.getMeta(fn).key : undefined;
+
+  useAsyncEffect(async () => {
+    if (!existingBlueprint) {
+      return;
+    }
+
+    const source = await existingBlueprint.instructions.source.load();
+    setInstructions(source.content ?? '');
+  }, [existingBlueprint]);
+
+  const handleSave = useCallback(async () => {
+    if (!db) {
+      return;
+    }
+
+    setCreating(true);
+    try {
+      if (existingBlueprint) {
+        const text = await existingBlueprint.instructions.source.load();
+        Obj.update(text, (text) => {
+          text.content = instructions;
+        });
+
+        if (fnKey) {
+          const toolId = ToolId.make(fnKey);
+          if (!existingBlueprint.tools?.includes(toolId)) {
+            Obj.update(existingBlueprint, (existingBlueprint) => {
+              existingBlueprint.tools = [...(existingBlueprint.tools ?? []), toolId];
+            });
+          }
+        }
+      } else if (fnKey) {
+        db.add(
+          Blueprint.make({
+            key: blueprintKey,
+            name: object.name ?? 'Script',
+            instructions: Template.make({ source: instructions }),
+            tools: [ToolId.make(fnKey)],
+          }),
+        );
+      }
+      await db.flush();
+    } finally {
+      setCreating(false);
+    }
+  }, [db, existingBlueprint, fnKey, blueprintKey, object.name, instructions]);
+
+  return (
+    <div className='flex flex-col'>
+      <Form.Section label={t('blueprint-editor.label')} description={t('blueprint-editor.description')} />
+
+      <Input.Root>
+        <Input.Label>{t('blueprint-instructions.label')}</Input.Label>
+        <Input.TextArea
+          placeholder={t('blueprint-instructions.placeholder')}
+          rows={6}
+          value={instructions}
+          onChange={(event) => setInstructions(event.target.value)}
+          classNames='resize-y'
+        />
+      </Input.Root>
+
+      <div className='pt-2'>
+        <Button disabled={(!existingBlueprint && !fnKey) || creating} onClick={handleSave}>
+          {t(existingBlueprint ? 'update-blueprint.label' : 'create-blueprint.label')}
+        </Button>
+      </div>
+    </div>
+  );
+};