@dxos/plugin-script 0.8.4-main.7996785055 → 0.8.4-main.8baae0fced

package/src/containers/ScriptProperties/ScriptProperties.stories.tsx

@@ -0,0 +1,76 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+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 { useQuery, useSpaces } from '@dxos/react-client/echo';
+import { ObjectProperties } from '@dxos/react-ui-form';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { createScript } from '#testing';
+import { translations } from '#translations';
+
+import { ScriptProperties } from './ScriptProperties';
+
+type DefaultStoryProps = {};
+
+const DefaultStory = (_: DefaultStoryProps) => {
+  const [space] = useSpaces();
+  const [script] = useQuery(space?.db, Filter.type(Script.Script));
+  if (!script) {
+    return <Loading />;
+  }
+
+  return (
+    <ObjectProperties object={script}>
+      <ScriptProperties role='object-properties' subject={script} />
+    </ObjectProperties>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/containers/ScriptProperties',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          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/ScriptProperties/ScriptProperties.tsx

@@ -4,30 +4,21 @@
 
 import React from 'react';
 
-import { Obj } from '@dxos/echo';
-import { type Script } from '@dxos/functions';
-import { Input, useTranslation } from '@dxos/react-ui';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Script } from '@dxos/compute';
 
-import { meta } from '../../meta';
+import { BlueprintEditor } from './BlueprintEditor';
+import { FunctionBinding } from './FunctionBinding';
+import { FunctionPublishing } from './FunctionPublishing';
 
-export type ScriptPropertiesProps = {
-  object: Script.Script;
-};
+export type ScriptPropertiesProps = AppSurface.ObjectPropertiesProps<Script.Script>;
 
-export const ScriptProperties = ({ object }: ScriptPropertiesProps) => {
-  const { t } = useTranslation(meta.id);
+export const ScriptProperties = ({ subject: object }: ScriptPropertiesProps) => {
   return (
-    <Input.Root>
-      <Input.Label>{t('description label')}</Input.Label>
-      <Input.TextInput
-        placeholder={t('description placeholder')}
-        value={object.description ?? ''}
-        onChange={(event) => {
-          Obj.change(object, (obj) => {
-            obj.description = event.target.value;
-          });
-        }}
-      />
-    </Input.Root>
+    <div className='flex flex-col py-form-gap gap-form-section-gap'>
+      <FunctionBinding object={object} />
+      <BlueprintEditor object={object} />
+      <FunctionPublishing object={object} />
+    </div>
   );
 };

package/src/containers/ScriptProperties/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2024 DXOS.org
 //
 
-import { ScriptProperties } from './ScriptProperties';
-
-export default ScriptProperties;
+export { ScriptProperties as default } from './ScriptProperties';

package/src/containers/TestContainer/TestContainer.tsx

@@ -4,15 +4,14 @@
 
 import React, { useCallback, useMemo } from 'react';
 
+import { type Script } from '@dxos/compute';
 import { Context } from '@dxos/context';
-
-import { type Script } from '@dxos/functions';
+import { Obj } from '@dxos/echo';
 import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
 import { Panel } from '@dxos/react-ui';
-import { getSpace } from '@dxos/react-client/echo';
 
-import { TestPanel } from '../../components';
-import { useDeployDeps } from '../../hooks';
+import { TestPanel } from '#components';
+import { useDeployDeps } from '#hooks';
 
 export type TestContainerProps = {
   role: string;
@@ -21,7 +20,7 @@ export type TestContainerProps = {
 
 export const TestContainer = ({ role, script }: TestContainerProps) => {
   const { client, fn, existingFunctionId } = useDeployDeps({ script });
-  const space = getSpace(script);
+  const spaceId = Obj.getDatabase(script)?.spaceId;
 
   const functionsClient = useMemo(() => FunctionsServiceClient.fromClient(client), [client]);
 
@@ -30,9 +29,9 @@ export const TestContainer = ({ role, script }: TestContainerProps) => {
       if (!fn) {
         throw new Error('Function not deployed');
       }
-      return functionsClient.invoke(Context.default(), fn, input, { spaceId: space?.id });
+      return functionsClient.invoke(Context.default(), fn, input, { spaceId });
     },
-    [fn, functionsClient, space?.id],
+    [fn, functionsClient, spaceId],
   );
 
   return (

package/src/containers/TestContainer/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-import { TestContainer } from './TestContainer';
-
-export default TestContainer;
+export { TestContainer as default } from './TestContainer';

package/src/containers/index.ts

@@ -5,9 +5,7 @@
 import { type ComponentType, lazy } from 'react';
 
 export const DeploymentDialog: ComponentType<any> = lazy(() => import('./DeploymentDialog'));
-export const NotebookContainer: ComponentType<any> = lazy(() => import('./NotebookContainer'));
-export const ScriptContainer: ComponentType<any> = lazy(() => import('./ScriptContainer'));
-export const ScriptObjectSettings: ComponentType<any> = lazy(() => import('./ScriptObjectSettings'));
-export const ScriptPluginSettings: ComponentType<any> = lazy(() => import('./ScriptPluginSettings'));
+export const NotebookArticle: ComponentType<any> = lazy(() => import('./NotebookArticle'));
+export const ScriptArticle: ComponentType<any> = lazy(() => import('./ScriptArticle'));
 export const ScriptProperties: ComponentType<any> = lazy(() => import('./ScriptProperties'));
 export const TestContainer: ComponentType<any> = lazy(() => import('./TestContainer'));

package/src/e2e/ai.test.ts

@@ -7,16 +7,16 @@ import { test } from 'vitest';
 
 import { Client } from '@dxos/client';
 import { type Space } from '@dxos/client-protocol';
+import { Operation } from '@dxos/compute';
 import { configPreset } from '@dxos/config';
 import { Context } from '@dxos/context';
-import { Operation } from '@dxos/operation';
 import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
 import { bundleFunction } from '@dxos/functions-runtime/native';
 import { FunctionRuntimeKind } from '@dxos/protocols';
 import { EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
 
 // To heavy to run in CI.
-describe.runIf(process.env.DX_TEST_TAGS?.includes('functions-e2e')).skip('Function', () => {
+describe.skip('Function', { tags: ['functions-e2e'] }, () => {
   const config = configPreset({ edge: 'local' });
 
   test('bundle anthropic function', { timeout: 120_000 }, async () => {

package/src/e2e/deploy.test.ts

@@ -3,7 +3,6 @@
 //
 
 import { readFile } from 'node:fs/promises';
-
 import { describe, expect, test } from 'vitest';
 
 import { Client, type Config } from '@dxos/client';
@@ -15,7 +14,9 @@ import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 
-describe.runIf(process.env.DX_TEST_TAGS?.includes('functions-e2e'))('Functions deployment', () => {
+// TODO(wittjosiah): Re-enable once @dxos/compute.js is available at the R2 dev bucket
+// (https://pub-5745ae82e450484aa28f75fc6a175935.r2.dev/dev/@dxos/compute.js currently 404s).
+describe.skip('Functions deployment', { tags: ['functions-e2e'] }, () => {
   test('deploys FOREX (effect) function and invokes it via EDGE (main)', { timeout: 120_000 }, async () => {
     const config = configPreset({ edge: 'main' });
     await testDeploy(config);

package/src/hooks/deploy.ts

@@ -4,9 +4,9 @@
 
 import { useEffect, useMemo } from 'react';
 
+import { Script, Operation } from '@dxos/compute';
 import { Obj, Query, Ref } from '@dxos/echo';
-import { type Script, getUserFunctionIdInMetadata } from '@dxos/functions';
-import { Operation } from '@dxos/operation';
+import { getUserFunctionIdInMetadata } from '@dxos/functions';
 import { log } from '@dxos/log';
 import { type Client, useClient } from '@dxos/react-client';
 import { type Space, getSpace, useQuery } from '@dxos/react-client/echo';
@@ -14,7 +14,8 @@ import { type TFunction } from '@dxos/react-ui';
 import { createMenuAction } from '@dxos/react-ui-menu';
 import { messageValence } from '@dxos/ui-theme';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
+
 import { deployScript, getFunctionUrl, isScriptDeployed } from '../util';
 
 export type DeployActionProperties = { type: 'deploy' } | { type: 'copy' };
@@ -43,7 +44,7 @@ export const createDeploy = ({ state, script, space, fn, client, existingFunctio
 
   // TODO(wittjosiah): Should this be an action?
   const errorItem = createMenuAction('error', () => {}, {
-    label: value.error ?? ['no error label', { ns: meta.id }],
+    label: value.error ?? ['no-error.label', { ns: meta.id }],
     icon: 'ph--warning-circle--regular',
     hidden: !value.error,
     classNames: value.error && messageValence('error'),
@@ -63,14 +64,14 @@ export const createDeploy = ({ state, script, space, fn, client, existingFunctio
 
       if (!result.success) {
         log.catch(result.error);
-        state.set('error', t('upload failed label'));
+        state.set('error', t('upload-failed.label'));
       }
 
       state.set('deploying', false);
     },
     {
       type: 'deploy',
-      label: [value.deploying ? 'publishing label' : 'deploy label', { ns: meta.id }],
+      label: [value.deploying ? 'publishing.label' : 'deploy.label', { ns: meta.id }],
       icon: value.deploying ? 'ph--spinner-gap--regular' : 'ph--cloud-arrow-up--regular',
       disabled: value.deploying,
       classNames: value.deploying ? '[&_svg]:animate-spin' : '',
@@ -86,7 +87,7 @@ export const createDeploy = ({ state, script, space, fn, client, existingFunctio
     },
     {
       type: 'copy',
-      label: ['copy link label', { ns: meta.id }],
+      label: ['copy-link.label', { ns: meta.id }],
       icon: 'ph--link--regular',
       disabled: !value.functionUrl,
     },

package/src/hooks/format.ts

@@ -6,12 +6,12 @@ import { format } from 'prettier';
 import prettierPluginEstree from 'prettier/plugins/estree';
 import prettierPluginTypescript from 'prettier/plugins/typescript';
 
+import { type Script } from '@dxos/compute';
 import { Obj } from '@dxos/echo';
-import { type Script } from '@dxos/functions';
 import { log } from '@dxos/log';
 import { createMenuAction } from '@dxos/react-ui-menu';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
 export type FormatActionProperties = { type: 'format' };
 
@@ -30,7 +30,7 @@ export const createFormat = (script: Script.Script) => {
           semi: true,
           singleQuote: true,
         });
-        Obj.change(script.source.target!, (obj) => {
+        Obj.update(script.source.target!, (obj) => {
           obj.content = formatted;
         });
       } catch (err: any) {
@@ -39,7 +39,7 @@ export const createFormat = (script: Script.Script) => {
       }
     },
     {
-      label: ['format label', { ns: meta.id }],
+      label: ['format.label', { ns: meta.id }],
       icon: 'ph--magic-wand--regular',
     },
   );

package/src/hooks/template.ts

@@ -2,8 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
+import { Script } from '@dxos/compute';
 import { Obj } from '@dxos/echo';
-import { FUNCTIONS_PRESET_META_KEY, type Script } from '@dxos/functions';
+import { FUNCTIONS_PRESET_META_KEY } from '@dxos/functions';
 import { createMenuAction } from '@dxos/react-ui-menu';
 
 import { templates } from '../templates';
@@ -15,9 +16,9 @@ const createTemplateSelectActions = (script: Script.Script) => {
     return createMenuAction<TemplateActionProperties>(
       `template--${template.id}`,
       () => {
-        Obj.change(script, (obj) => {
-          obj.name = template.name;
-          const meta = Obj.getMeta(obj);
+        Obj.update(script, (script) => {
+          script.name = template.name;
+          const meta = Obj.getMeta(script);
           const oldPresetIndex = meta.keys.findIndex((key) => key.source === FUNCTIONS_PRESET_META_KEY);
           if (oldPresetIndex >= 0) {
             meta.keys.splice(oldPresetIndex, 1);
@@ -27,7 +28,7 @@ const createTemplateSelectActions = (script: Script.Script) => {
           }
         });
         if (script.source?.target) {
-          Obj.change(script.source.target, (obj) => {
+          Obj.update(script.source.target, (obj) => {
             obj.content = template.source;
           });
         }

package/src/hooks/useCompiler.ts

@@ -6,9 +6,10 @@ import { useCapabilities, usePluginManager } from '@dxos/app-framework/ui';
 import { runAndForwardErrors } from '@dxos/effect';
 import { useAsyncEffect } from '@dxos/react-ui';
 
+import { ScriptEvents } from '#types';
+import { ScriptCapabilities } from '#types';
+
 import type { Compiler } from '../compiler';
-import { ScriptEvents } from '../types';
-import { ScriptCapabilities } from '../types';
 
 /**
  * Asynchronously sets up the compiler and returns it.

package/src/hooks/useCreateAndDeployScriptTemplates.ts

@@ -5,15 +5,16 @@
 import { useCallback, useState } from 'react';
 
 import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { Script } from '@dxos/compute';
 import { Obj } from '@dxos/echo';
-import { Script } from '@dxos/functions';
 import { invariant } from '@dxos/invariant';
-import { SpaceOperation } from '@dxos/plugin-space/operations';
+import { SpaceOperation } from '@dxos/plugin-space';
 import { useClient } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 
+import { ScriptOperation } from '#types';
+
 import { type Template } from '../templates';
-import { ScriptOperation } from '../operations';
 import { deployScript } from '../util';
 
 type DeploymentStatus = 'idle' | 'pending' | 'success' | 'error';

package/src/index.ts

@@ -2,10 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-export { ScriptCapabilities, ScriptEvents } from './types';
-export * from './components';
-export * from './containers';
+export * from './blueprints';
 export * from './meta';
+export * from './types';
 export * from './util';
-
-export * from './ScriptPlugin';

package/src/meta.ts

@@ -8,6 +8,7 @@ import { trim } from '@dxos/util';
 export const meta: Plugin.Meta = {
   id: 'org.dxos.plugin.script',
   name: 'Scripts',
+  author: 'DXOS',
   description: trim`
     Write and deploy custom JavaScript functions that extend your workspace capabilities.
     Create AI agent tools, spreadsheet formulas, and automation scripts that integrate seamlessly with other plugins.

package/src/notebook/compute-graph.test.ts

@@ -7,7 +7,7 @@ import { describe, expect, test } from 'vitest';
 
 import { Obj } from '@dxos/echo';
 
-import { createNotebook } from '../testing';
+import { createNotebook } from '#testing';
 
 import { ComputeGraph } from './compute-graph';
 
@@ -43,8 +43,8 @@ describe('notebook', () => {
     // Replace one of the cells with code that tries to access window/document.
     const sourceTarget = notebook.cells[2].source?.target;
     if (sourceTarget) {
-      Obj.change(sourceTarget, (obj) => {
-        obj.content = 'b = typeof window';
+      Obj.update(sourceTarget, (sourceTarget) => {
+        sourceTarget.content = 'b = typeof window';
       });
     }
 
@@ -57,8 +57,8 @@ describe('notebook', () => {
 
     // Test document access.
     if (sourceTarget) {
-      Obj.change(sourceTarget, (obj) => {
-        obj.content = 'b = typeof document';
+      Obj.update(sourceTarget, (sourceTarget) => {
+        sourceTarget.content = 'b = typeof document';
       });
     }
     graph.parse();
@@ -69,8 +69,8 @@ describe('notebook', () => {
 
     // Test that safe globals still work.
     if (sourceTarget) {
-      Obj.change(sourceTarget, (obj) => {
-        obj.content = 'b = Math.max(100, 200)';
+      Obj.update(sourceTarget, (sourceTarget) => {
+        sourceTarget.content = 'b = Math.max(100, 200)';
       });
     }
     graph.parse();

package/src/notebook/compute-graph.ts

@@ -6,7 +6,7 @@ import { Atom, type Registry } from '@effect-atom/atom-react';
 
 import { log } from '@dxos/log';
 
-import { type Notebook } from '../types';
+import { type Notebook } from '#types';
 
 import { evalScript } from './eval';
 import { type ParsedExpression, VirtualTypeScriptParser } from './vfs-parser';

package/src/notebook/vfs-parser.ts

@@ -42,6 +42,7 @@ export class VirtualTypeScriptParser {
   protected compilerOptions: ts.CompilerOptions = {
     target: ts.ScriptTarget.ES2020,
     module: ts.ModuleKind.ESNext,
+    moduleResolution: ts.ModuleResolutionKind.Bundler,
     strict: true,
     esModuleInterop: true,
     skipLibCheck: true,
@@ -91,7 +92,9 @@ export class VirtualTypeScriptParser {
     // Analyze each file.
     files.forEach((file) => {
       const sourceFile = env.getSourceFile(file.filename);
-      if (!sourceFile || !typeChecker) return;
+      if (!sourceFile || !typeChecker) {
+        return;
+      }
 
       const fileResults = this.analyzeSourceFile(sourceFile, typeChecker);
       results.push(...fileResults);
@@ -207,7 +210,9 @@ export class VirtualTypeScriptParser {
     signature: ts.Signature | undefined,
     typeChecker: ts.TypeChecker,
   ): Array<{ name: string; type: string }> {
-    if (!signature) return [];
+    if (!signature) {
+      return [];
+    }
 
     return signature.parameters.map((param) => ({
       name: param.getName(),
@@ -429,7 +434,9 @@ export class NotebookVirtualParser extends VirtualTypeScriptParser {
         const previousExports = new Set<string>();
         for (const [_prevCellId, prevAnalysis] of cellAnalysis) {
           prevAnalysis.exports.forEach((exp) => {
-            if (exp.name) previousExports.add(exp.name);
+            if (exp.name) {
+              previousExports.add(exp.name);
+            }
           });
         }
 

package/src/operations/create-script.ts

@@ -5,13 +5,12 @@
 import { Octokit } from '@octokit/core';
 import * as Effect from 'effect/Effect';
 
-import { Script } from '@dxos/functions';
-import { Operation } from '@dxos/operation';
+import { Script, Operation } from '@dxos/compute';
 
 import { templates } from '../templates';
-import { CreateScript } from './definitions';
+import { ScriptOperation } from '../types';
 
-const handler: Operation.WithHandler<typeof CreateScript> = CreateScript.pipe(
+const handler: Operation.WithHandler<typeof ScriptOperation.CreateScript> = ScriptOperation.CreateScript.pipe(
   Operation.withHandler(
     Effect.fnUntraced(function* ({ name, gistUrl, initialTemplateId }) {
       let source = templates[0].source;

package/src/operations/index.ts

@@ -2,11 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
-import { OperationHandlerSet } from '@dxos/operation';
+import { OperationHandlerSet } from '@dxos/compute';
 
-export * as ScriptOperation from './definitions';
-
-export const ScriptOperationHandlerSet = OperationHandlerSet.lazy(
-  () => import('./access-token-created'),
-  () => import('./create-script'),
-);
+export const ScriptOperationHandlerSet = OperationHandlerSet.lazy(() => import('./create-script'));

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const ScriptPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { ScriptOperationHandlerSet } from './operations';

package/src/templates/anthropic.ts

@@ -9,7 +9,7 @@ import * as Schema from 'effect/Schema';
 import * as Stream from 'effect/Stream';
 
 import { AiService } from '@dxos/ai';
-import { Operation } from '@dxos/operation';
+import { Operation } from '@dxos/compute';
 
 const Anthropic = Operation.make({
   meta: {

package/src/templates/chess-bot.ts

@@ -6,9 +6,10 @@ import { Chess as ChessJS } from 'chess.js';
 import * as Effect from 'effect/Effect';
 import * as Schema from 'effect/Schema';
 
-import { Database, Obj, Ref } from '@dxos/echo';
-import { Operation } from '@dxos/operation';
-import { Chess } from '@dxos/plugin-chess/types';
+import { Operation } from '@dxos/compute';
+import { Database, Obj } from '@dxos/echo';
+import { Chess } from '@dxos/plugin-chess';
+import { GameRef, Game, loadGame } from '@dxos/plugin-game';
 
 const ChessBot = Operation.make({
   meta: {
@@ -17,7 +18,7 @@ const ChessBot = Operation.make({
     description: 'Plays a random move in a chess game.',
   },
   input: Schema.Struct({
-    game: Ref.Ref(Chess.Game).annotations({
+    game: GameRef(Chess.State).annotations({
       description: 'The chess game to comment on.',
     }),
     player: Schema.optional(Schema.Literal('white', 'black')).annotations({
@@ -29,16 +30,16 @@ const ChessBot = Operation.make({
       description: 'The state of the game as an ASCII art board.',
     }),
   }),
-  types: [Chess.Game],
+  types: [Game, Chess.State],
   services: [Database.Service],
 });
 
 export default ChessBot.pipe(
   Operation.withHandler(
     Effect.fnUntraced(function* ({ game, player = 'black' }) {
-      const loadedGame = yield* Database.load(game);
+      const { variant } = yield* loadGame(game, Chess.State);
       const chess = new ChessJS();
-      chess.loadPgn(loadedGame.pgn ?? '');
+      chess.loadPgn(variant.pgn ?? '');
       if (chess.turn() !== (player === 'white' ? 'w' : 'b')) {
         return { state: chess.ascii() };
       }
@@ -51,8 +52,9 @@ export default ChessBot.pipe(
 
       chess.move(move.san);
       const newPgn = chess.pgn();
-      Obj.change(loadedGame, (obj) => {
-        obj.pgn = newPgn;
+      Obj.update(variant, (variant) => {
+        const mutable = variant as Obj.Mutable<typeof variant>;
+        mutable.pgn = newPgn;
       });
       yield* Database.flush();
       return { state: chess.ascii() };