@dxos/plugin-script 0.8.3 → 0.8.4-main.1068cf700f

package/src/capabilities/settings/settings.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+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';
+
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    const settingsAtom = createKvsStore({
+      key: meta.id,
+      schema: ScriptSettings,
+      defaultValue: () => ({
+        editorInputMode: 'vscode' as const,
+      }),
+    });
+
+    return [
+      Capability.contributes(ScriptCapabilities.Settings, settingsAtom),
+      Capability.contributes(AppCapabilities.Settings, {
+        prefix: meta.id,
+        schema: ScriptSettings,
+        atom: settingsAtom,
+      }),
+    ];
+  }),
+);

package/src/compiler/compiler.ts

@@ -3,15 +3,17 @@
 //
 
 import {
+  type VirtualTypeScriptEnvironment,
   createDefaultMapFromCDN,
   createSystem,
   createVirtualTypeScriptEnvironment,
-  type VirtualTypeScriptEnvironment,
 } from '@typescript/vfs';
 import ts from 'typescript';
 
 import { invariant } from '@dxos/invariant';
 
+const GLOBALS = 'globals.d.ts';
+
 const defaultOptions: ts.CompilerOptions = {
   lib: ['DOM', 'es2022'],
   target: ts.ScriptTarget.ES2022,
@@ -23,16 +25,21 @@ export class Compiler {
 
   constructor(private readonly _options: ts.CompilerOptions = defaultOptions) {}
 
-  async initialize(): Promise<void> {
+  async initialize(globals?: string): Promise<void> {
     if (this._env) {
       return;
     }
 
     // TODO(wittjosiah): Figure out how to get workers working in plugin packages.
     //   https://github.com/val-town/codemirror-ts?tab=readme-ov-file#setup-worker
-    this._fsMap = await createDefaultMapFromCDN(this._options, '5.5.4', true, ts);
+    this._fsMap = await createDefaultMapFromCDN(this._options, '5.7.2', true, ts);
+    if (globals) {
+      this._fsMap.set(GLOBALS, globals);
+    }
+
+    const rootFiles = globals ? [GLOBALS] : [];
     const system = createSystem(this._fsMap);
-    this._env = createVirtualTypeScriptEnvironment(system, [], ts, this._options);
+    this._env = createVirtualTypeScriptEnvironment(system, rootFiles, ts, this._options);
   }
 
   get environment() {

package/src/components/DeploymentDialog/DeploymentDialog.stories.tsx

@@ -2,38 +2,61 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react';
-import React from 'react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
 
+import { OperationPlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Obj } from '@dxos/echo';
+import { ClientPlugin } from '@dxos/plugin-client';
 import { Dialog } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import translations from '../../translations';
-import { DeploymentDialog } from '../DeploymentDialog/DeploymentDialog';
-
-export const Default = {
-  args: {
-    accessToken: { value: 'example-token' },
-    scripts: [
-      { label: 'Script 1', templateId: 'template1' },
-      { label: 'Script 2', templateId: 'template2' },
-      { label: 'Script 3', templateId: 'template3' },
+import { withTheme } from '@dxos/react-ui/testing';
+import { AccessToken } from '@dxos/types';
+
+import { translations } from '../../translations';
+
+import { DeploymentDialog } from './DeploymentDialog';
+
+// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
+const DeploymentDialogStory = () => {
+  const accessToken = useMemo(
+    () =>
+      Obj.make(AccessToken.AccessToken, {
+        source: 'example.com',
+        token: 'example-token',
+      }),
+    [],
+  );
+  const scriptTemplates = useMemo(
+    () => [
+      { id: 't-1', name: 'Script 1', source: 'template1' },
+      { id: 't-2', name: 'Script 2', source: 'template2' },
+      { id: 't-3', name: 'Script 3', source: 'template3' },
     ],
-  },
-  render: (args: any) => (
+    [],
+  );
+  return (
     <Dialog.Root defaultOpen={true}>
-      <DeploymentDialog {...args} />
+      <DeploymentDialog accessToken={accessToken} scriptTemplates={scriptTemplates} />
     </Dialog.Root>
-  ),
+  );
 };
 
-const meta: Meta = {
+const meta = {
   title: 'plugins/plugin-script/DeploymentDialog',
-  component: DeploymentDialog,
+  component: DeploymentDialogStory,
   parameters: { translations },
-  decorators: [withTheme, withLayout()],
-};
+  // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+  decorators: [
+    withTheme(),
+    withPluginManager({
+      plugins: [OperationPlugin(), ClientPlugin({})],
+    }),
+  ],
+} satisfies Meta<typeof DeploymentDialogStory>;
 
 export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/components/DeploymentDialog/DeploymentDialog.tsx

@@ -4,91 +4,78 @@
 
 import React, { useEffect, useMemo } from 'react';
 
-import { createIntent, LayoutAction, useIntentDispatcher } from '@dxos/app-framework';
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation } from '@dxos/app-toolkit';
 import { getSpace } from '@dxos/react-client/echo';
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
-import { type DataType } from '@dxos/schema';
+import { Button, Dialog, IconButton, useTranslation } from '@dxos/react-ui';
+import { type AccessToken } from '@dxos/types';
 
-import { useCreateAndDeployScriptTemplates } from '../../hooks/useCreateAndDeployScriptTemplates';
-import { SCRIPT_PLUGIN } from '../../meta';
+import { useCreateAndDeployScriptTemplates } from '../../hooks';
+import { meta } from '../../meta';
 import { type Template } from '../../templates';
 
-export const DEPLOYMENT_DIALOG = `${SCRIPT_PLUGIN}/deployment/dialog`;
+export const DEPLOYMENT_DIALOG = `${meta.id}/deployment/dialog`;
 
 // TODO(ZaymonFC):
-//   - Show activity and feedback to the user.
-//   - Only take an array of templateIds and get the name from the data.
-//   - Pending / onError states.
+//  - Show activity and feedback to the user.
+//  - Only take an array of templateIds and get the name from the data.
+//  - Pending / onError states.
 
-type DeploymentDialogProps = {
-  accessToken: DataType.AccessToken;
+export type DeploymentDialogProps = {
+  accessToken: AccessToken.AccessToken;
   scriptTemplates: Template[];
 };
 
 export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDialogProps) => {
-  const { t } = useTranslation(SCRIPT_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const space = useMemo(() => getSpace(accessToken), [accessToken]);
 
   // TODO(ZaymonFC): Thinking further. All of this should get moved to intents to run async in the background.
   //   Deployment shouldn't be tied to the lifecycle of the dialogue component.
   const { handleCreateAndDeployScripts, status } = useCreateAndDeployScriptTemplates(space, scriptTemplates);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const { invokePromise } = useOperationInvoker();
 
   useEffect(() => {
     if (status === 'success') {
       // TODO(ZaymonFC): We can probably re-use this toast for normal script deployment.
-      void dispatch(
-        createIntent(LayoutAction.AddToast, {
-          part: 'toast',
-          subject: {
-            id: `${SCRIPT_PLUGIN}/deployment-success`,
-            icon: 'ph--check--regular',
-            duration: Infinity,
-            title: ['script deployment toast label', { ns: SCRIPT_PLUGIN, count: scriptTemplates.length }],
-            description: ['script deployment toast description', { ns: SCRIPT_PLUGIN, count: scriptTemplates.length }],
-            closeLabel: ['script deployment toast close label', { ns: SCRIPT_PLUGIN, count: scriptTemplates.length }],
-          },
-        }),
-      );
-      void dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } }));
+      void invokePromise(LayoutOperation.AddToast, {
+        id: `${meta.id}/deployment-success`,
+        icon: 'ph--check--regular',
+        duration: Infinity,
+        title: ['script deployment toast label', { ns: meta.id, count: scriptTemplates.length }],
+        description: ['script deployment toast description', { ns: meta.id, count: scriptTemplates.length }],
+        closeLabel: ['script deployment toast close label', { ns: meta.id, count: scriptTemplates.length }],
+      });
+      void invokePromise(LayoutOperation.UpdateDialog, { state: false });
     }
     if (status === 'error') {
-      void dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } }));
-      void dispatch(
-        createIntent(LayoutAction.AddToast, {
-          part: 'toast',
-          subject: {
-            id: `${SCRIPT_PLUGIN}/deployment-error`,
-            icon: 'ph--warning--regular',
-            duration: Infinity,
-            title: ['script deployment error toast label', { ns: SCRIPT_PLUGIN, count: scriptTemplates.length }],
-            description: [
-              'script deployment error toast description',
-              { ns: SCRIPT_PLUGIN, count: scriptTemplates.length },
-            ],
-            closeLabel: [
-              'script deployment error toast close label',
-              { ns: SCRIPT_PLUGIN, count: scriptTemplates.length },
-            ],
-          },
-        }),
-      );
+      void invokePromise(LayoutOperation.UpdateDialog, { state: false });
+      void invokePromise(LayoutOperation.AddToast, {
+        id: `${meta.id}/deployment-error`,
+        icon: 'ph--warning--regular',
+        duration: Infinity,
+        title: ['script deployment error toast label', { ns: meta.id, count: scriptTemplates.length }],
+        description: ['script deployment error toast description', { ns: meta.id, count: scriptTemplates.length }],
+        closeLabel: ['script deployment error toast close label', { ns: meta.id, count: scriptTemplates.length }],
+      });
     }
-  }, [status, dispatch]);
+  }, [status, invokePromise]);
 
   return (
     <Dialog.Content>
       <div className='flex justify-between items-center'>
         <Dialog.Title>{t('deployment dialog title')}</Dialog.Title>
         <Dialog.Close asChild>
-          <Button density='fine' variant='ghost'>
-            <Icon icon='ph--x--regular' size={4} />
-          </Button>
+          <IconButton icon='ph--x--regular' size={4} label='Close' iconOnly density='fine' variant='ghost' />
         </Dialog.Close>
       </div>
       <div role='none' className='plb-4'>
         {/* TODO: Implement deployment logic and UI. */}
-        <p>{t('deployment dialog scripts found message', { count: scriptTemplates.length })}</p>
+        <p>
+          {t('deployment dialog scripts found message', {
+            count: scriptTemplates.length,
+          })}
+        </p>
         <ul className='pbs-2'>
           {scriptTemplates.map((template) => {
             return <li key={template.id}>{template.name}</li>;
@@ -98,8 +85,12 @@ export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDia
       <div role='none' className='flex flex-row-reverse gap-1'>
         <Button variant='primary' onClick={handleCreateAndDeployScripts} disabled={status === 'pending'}>
           {status === 'pending'
-            ? t('deployment dialog deploy functions pending button label', { count: scriptTemplates.length })
-            : t('deployment dialog deploy functions button label', { count: scriptTemplates.length })}
+            ? t('deployment dialog deploy functions pending button label', {
+                count: scriptTemplates.length,
+              })
+            : t('deployment dialog deploy functions button label', {
+                count: scriptTemplates.length,
+              })}
         </Button>
         <Dialog.Close asChild disabled={status === 'pending'}>
           <Button disabled={status === 'pending'}>{t('deployment dialog skip button label')}</Button>

package/src/components/DeploymentDialog/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { DeploymentDialog, DEPLOYMENT_DIALOG } from './DeploymentDialog';
+import { DEPLOYMENT_DIALOG, DeploymentDialog } from './DeploymentDialog';
 
 export { DEPLOYMENT_DIALOG };
 

package/src/components/FrameContainer/FrameContainer.tsx

@@ -5,13 +5,13 @@
 import React, { useEffect, useRef } from 'react';
 
 import { clientServiceBundle } from '@dxos/client-protocol';
-import { type BundleResult } from '@dxos/functions/bundler';
+import { type BundleResult } from '@dxos/functions-runtime/bundler';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { useClient } from '@dxos/react-client';
-import { baseSurface, mx } from '@dxos/react-ui-theme';
 import { createProtoRpcPeer } from '@dxos/rpc';
 import { createIFramePort } from '@dxos/rpc-tunnel';
+import { baseSurface, mx } from '@dxos/ui-theme';
 
 export type FrameContainerProps = {
   containerUrl: string;
@@ -48,7 +48,10 @@ export const FrameContainer = ({ containerUrl, result, debug = true }: FrameCont
   // Encodes compiled code via URL.
   invariant(result.sourceHash, 'Source hash is required.');
   const sourceHash = Buffer.from(result.sourceHash).toString('hex');
-  const src = result.bundle && `${containerUrl}?ts=${sourceHash}#code=${encodeURIComponent(result.bundle)}`;
+  const src =
+    'bundle' in result
+      ? `${containerUrl}?ts=${sourceHash}#code=${encodeURIComponent(new TextDecoder().decode(Object.values(result.bundle as any)[0] as Uint8Array))}`
+      : undefined;
 
   return (
     <>
@@ -59,7 +62,7 @@ export const FrameContainer = ({ containerUrl, result, debug = true }: FrameCont
           <div
             className={mx(
               baseSurface,
-              'flex absolute right-2 bottom-2 w-[30rem] h-[200px] ring rounded',
+              'flex absolute right-2 bottom-2 is-[30rem] bs-[200px] ring rounded',
               'z-20 overflow-x-hidden overflow-y-auto',
             )}
           >
@@ -68,7 +71,7 @@ export const FrameContainer = ({ containerUrl, result, debug = true }: FrameCont
                 {
                   timestamp: result.timestamp,
                   sourceHash,
-                  error: result.error,
+                  error: 'error' in result ? result.error : undefined,
                   src,
                 },
                 undefined,

package/src/components/FrameContainer/frame.tsx

@@ -28,7 +28,7 @@ const main = async () => {
     '@dxos/plugin-explorer': await import('@dxos/plugin-explorer'),
   }));
 
-  // eslint-disable-next-line no-new-func
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval
   const Component = Function('React', "return React.lazy(() => import('@frame/bundle'))")(React);
 
   const services = new ClientServicesProxy(

package/src/components/NotebookContainer.stories.tsx

@@ -0,0 +1,87 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { SERVICES_CONFIG } from '@dxos/ai/testing';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Agent } from '@dxos/assistant-toolkit';
+import { Filter } from '@dxos/echo';
+import { Function, serializeFunction } from '@dxos/functions';
+import { AssistantPlugin } from '@dxos/plugin-assistant';
+import { AutomationPlugin } from '@dxos/plugin-automation';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { ExplorerPlugin } from '@dxos/plugin-explorer';
+import { Markdown, MarkdownPlugin } from '@dxos/plugin-markdown';
+import { corePlugins } from '@dxos/plugin-testing';
+import { Config, useClient } from '@dxos/react-client';
+import { useQuery } from '@dxos/react-client/echo';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { DataTypes } from '@dxos/schema';
+
+import { createNotebook } from '../testing';
+import { translations } from '../translations';
+import { Notebook } from '../types';
+
+import { NotebookContainer } from './NotebookContainer';
+
+const meta: Meta<typeof NotebookContainer> = {
+  title: 'plugins/plugin-script/NotebookContainer',
+  component: NotebookContainer,
+  render: (args) => {
+    const client = useClient();
+    const space = client.spaces.default;
+    const notebooks = useQuery(space?.db, Filter.type(Notebook.Notebook));
+    return <NotebookContainer {...args} subject={notebooks[0]} />;
+  },
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column', classNames: 'is-proseMaxWidth' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          // TODO(wittjosiah): ComputeRuntime requires edge to be configured or it will throw.
+          config: new Config({
+            runtime: {
+              services: SERVICES_CONFIG.REMOTE,
+            },
+          }),
+          types: [...DataTypes, Notebook.Notebook, Function.Function, Markdown.Document],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* Effect.promise(() => client.halo.createIdentity());
+              yield* Effect.promise(() => client.spaces.waitUntilReady());
+              const space = client.spaces.default;
+              yield* Effect.promise(() => space.waitUntilReady());
+
+              space.db.add(createNotebook());
+              space.db.add(Markdown.make({ content: '# Hello World' }));
+              space.db.add(serializeFunction(Agent.prompt));
+            }),
+        }),
+        AssistantPlugin(),
+        AutomationPlugin(),
+        ExplorerPlugin(),
+        MarkdownPlugin(),
+      ],
+    }),
+  ],
+  parameters: {
+    translations,
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    role: 'article',
+    subject: undefined as any,
+  },
+};