@dxos/plugin-script 0.8.4-main.7ace549 → 0.8.4-main.937b3ca

package/src/components/NotebookStack/NotebookCell.tsx

@@ -5,23 +5,22 @@
 import React, { useCallback, useMemo } from 'react';
 
 import { Surface } from '@dxos/app-framework/react';
+import { type Database, Obj } from '@dxos/echo';
 import { createDocAccessor } from '@dxos/echo-db';
 import { invariant } from '@dxos/invariant';
 import { TemplateEditor } from '@dxos/plugin-assistant';
-import { type Space } from '@dxos/react-client/echo';
 import { useThemeContext, useTranslation } from '@dxos/react-ui';
 import { QueryEditor, type QueryEditorProps } from '@dxos/react-ui-components';
+import { EditorContent, type EditorContentProps } from '@dxos/react-ui-editor';
 import {
   type BasicExtensionsOptions,
-  EditorContent,
-  type EditorContentProps,
   createBasicExtensions,
   createDataExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   decorateMarkdown,
-} from '@dxos/react-ui-editor';
-import { mx } from '@dxos/react-ui-theme';
+} from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
 import { isNonNullable } from '@dxos/util';
 
 import { meta } from '../../meta';
@@ -35,7 +34,7 @@ const editorStyles = 'p-2 pis-3';
 const valueStyles = 'p-1 pis-3';
 
 export type NotebookCellProps = {
-  space?: Space;
+  db?: Database.Database;
   graph?: ComputeGraph;
   dragging?: boolean;
   cell: Notebook.Cell;
@@ -43,7 +42,7 @@ export type NotebookCellProps = {
 } & (Pick<NotebookMenuProps, 'onCellInsert' | 'onCellDelete'> & Pick<TypescriptEditorProps, 'env'>);
 
 // TODO(burdon): Show evaluation errors.
-export const NotebookCell = ({ space, graph, dragging, cell, promptResults, env }: NotebookCellProps) => {
+export const NotebookCell = ({ db, graph, dragging, cell, promptResults, env }: NotebookCellProps) => {
   const { t } = useTranslation(meta.id);
 
   const extensions = useMemo(() => {
@@ -62,7 +61,9 @@ export const NotebookCell = ({ space, graph, dragging, cell, promptResults, env
   const handleQueryChange = useCallback<NonNullable<QueryEditorProps['onChange']>>(
     (value: string) => {
       invariant(cell.source?.target);
-      cell.source.target.content = value;
+      Obj.change(cell.source.target, (s) => {
+        s.content = value;
+      });
     },
     [cell],
   );
@@ -119,7 +120,7 @@ export const NotebookCell = ({ space, graph, dragging, cell, promptResults, env
           <QueryEditor
             id={cell.id}
             classNames={[editorStyles, 'border-be border-subduedSeparator']}
-            db={space?.db}
+            db={db}
             value={cell.source.target.content}
             onChange={handleQueryChange}
           />
@@ -151,7 +152,7 @@ export const NotebookCell = ({ space, graph, dragging, cell, promptResults, env
 };
 
 const NotebookCellValue = ({ cell, graph }: NotebookCellProps) => {
-  const name = graph?.expressions.value[cell.id]?.name;
+  const name = graph?.getExpressions()[cell.id]?.name;
   const value = graph?.getValue(cell.id);
   if (value == null) {
     return null;
@@ -160,7 +161,7 @@ const NotebookCellValue = ({ cell, graph }: NotebookCellProps) => {
   return (
     <div
       className={mx(
-        'flex is-full bg-groupSurface border-t border-subduedSeparator text-description font-mono',
+        'flex is-full bg-groupSurface border-bs border-subduedSeparator text-description font-mono',
         valueStyles,
       )}
     >
@@ -186,14 +187,14 @@ const NotebookPromptResult = ({ cell, promptResults }: NotebookCellProps) => {
   }
 
   return (
-    <div className={mx('flex is-full bg-groupSurface text-description border-t border-subduedSeparator', valueStyles)}>
+    <div className={mx('flex is-full bg-groupSurface text-description border-bs border-subduedSeparator', valueStyles)}>
       <NotebookTextEditor readOnly value={value} />
     </div>
   );
 };
 
 const NotebookTextEditor = ({
-  extensions: extensionsParam,
+  extensions: extensionsProp,
   readOnly,
   ...props
 }: EditorContentProps & Pick<BasicExtensionsOptions, 'readOnly'>) => {
@@ -208,9 +209,9 @@ const NotebookTextEditor = ({
       createThemeExtensions({ themeMode, syntaxHighlighting: true }),
       createMarkdownExtensions(),
       decorateMarkdown(),
-      extensionsParam,
+      extensionsProp,
     ].filter(isNonNullable);
-  }, [extensionsParam]);
+  }, [extensionsProp]);
 
   return <EditorContent {...props} extensions={extensions} selectionEnd />;
 };

package/src/components/NotebookStack/NotebookStack.stories.tsx

@@ -3,12 +3,13 @@
 //
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React, { useMemo } from 'react';
 
-import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { AutomationPlugin } from '@dxos/plugin-automation';
 import { ClientPlugin } from '@dxos/plugin-client';
-import { SpacePlugin } from '@dxos/plugin-space';
+import { corePlugins } from '@dxos/plugin-testing';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
 import { createNotebook } from '../../testing';
@@ -16,24 +17,28 @@ import { translations } from '../../translations';
 
 import { NotebookStack } from './NotebookStack';
 
+// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
+const NotebookStackStory = () => {
+  const notebook = useMemo(() => createNotebook(), []);
+  return <NotebookStack notebook={notebook} />;
+};
+
 const meta = {
   title: 'plugins/plugin-script/NotebookStack',
-  component: NotebookStack,
+  component: NotebookStackStory,
   decorators: [
     withTheme,
-    withLayout({ container: 'column', classNames: 'is-prose' }),
-    // TODO(burdon): Factor out Surface to avoid dependency on app-framework.
+    withLayout({ layout: 'column', classNames: 'is-proseMaxWidth' }),
     withPluginManager({
       plugins: [
+        ...corePlugins(),
         ClientPlugin({
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-            await client.spaces.waitUntilReady();
-          },
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* Effect.promise(() => client.halo.createIdentity());
+              yield* Effect.promise(() => client.spaces.waitUntilReady());
+            }),
         }),
-        SpacePlugin({}),
-        SettingsPlugin(),
-        IntentPlugin(),
         AutomationPlugin(),
       ],
     }),
@@ -41,14 +46,10 @@ const meta = {
   parameters: {
     translations,
   },
-} satisfies Meta<typeof NotebookStack>;
+} satisfies Meta<typeof NotebookStackStory>;
 
 export default meta;
 
 type Story = StoryObj<typeof meta>;
 
-export const Default: Story = {
-  args: {
-    notebook: createNotebook(),
-  },
-};
+export const Default: Story = {};

package/src/components/NotebookStack/NotebookStack.tsx

@@ -20,7 +20,7 @@ export type NotebookStackProps = ThemedClassName<
   {
     notebook?: Notebook.Notebook;
     onRearrange?: StackProps['onRearrange'];
-  } & (Pick<NotebookSectionProps, 'space' | 'graph' | 'promptResults' | 'onCellInsert' | 'onCellDelete'> &
+  } & (Pick<NotebookSectionProps, 'db' | 'graph' | 'promptResults' | 'onCellInsert' | 'onCellDelete'> &
     Pick<TypescriptEditorProps, 'env'>)
 >;
 
@@ -39,7 +39,7 @@ type NotebookSectionProps = NotebookCellProps;
 
 const NotebookSection = ({
   cell,
-  space,
+  db,
   env,
   promptResults,
   onCellInsert,
@@ -73,13 +73,13 @@ const NotebookSection = ({
       <StackItem.DragPreview>
         {({ item: cell }) => (
           <StackItem.Content classNames='overflow-visible bg-groupSurface border border-subduedSeparator'>
-            <NotebookCell space={space} cell={cell} env={env} dragging />
+            <NotebookCell db={db} cell={cell} env={env} dragging />
           </StackItem.Content>
         )}
       </StackItem.DragPreview>
 
       <StackItem.Content classNames='overflow-visible'>
-        <NotebookCell space={space} cell={cell} env={env} promptResults={promptResults} {...props} />
+        <NotebookCell db={db} cell={cell} env={env} promptResults={promptResults} {...props} />
       </StackItem.Content>
     </StackItem.Root>
   );

package/src/components/QueryEditor/QueryEditor.stories.tsx

@@ -0,0 +1,100 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useCallback, useMemo, useState } from 'react';
+
+import { createDocAccessor } from '@dxos/echo-db';
+import { QuerySandbox } from '@dxos/echo-query';
+import { createObject } from '@dxos/react-client/echo';
+import { Toolbar, useAsyncEffect } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Layout } from '@dxos/react-ui-mosaic';
+import { Json } from '@dxos/react-ui-syntax-highlighter';
+import { createDataExtensions } from '@dxos/ui-editor';
+import { trim } from '@dxos/util';
+
+import { QueryEditor, type QueryEditorProps } from './QueryEditor';
+
+const SCRIPT = trim`
+  Query.select(Filter.type('dxos.org/type/Person'))
+`;
+
+const DefaultStory = (props: QueryEditorProps) => {
+  const object = useMemo(() => createObject({ content: SCRIPT }), []);
+  const [result, setResult] = useState<object | undefined>({});
+  const [sandbox, setSandbox] = useState<QuerySandbox>();
+
+  useAsyncEffect(async () => {
+    const sandbox = new QuerySandbox();
+    await sandbox.open();
+    setSandbox(sandbox);
+
+    return () => {
+      void sandbox.close();
+    };
+  }, []);
+
+  const extensions = useMemo(
+    () => [
+      createDataExtensions({
+        id: object.id,
+        text: createDocAccessor(object, ['content']),
+      }),
+    ],
+    [],
+  );
+
+  const handleRun = useCallback(async () => {
+    try {
+      const result = sandbox?.eval(object.content);
+
+      setResult({
+        timestamp: Date.now(),
+        result,
+      });
+    } catch (err) {
+      setResult({
+        timestamp: Date.now(),
+        error: String(err),
+      });
+    }
+  }, [object, sandbox]);
+
+  return (
+    <Layout.Main toolbar>
+      {/* <ScriptToolbar script={script} state={{}} /> */}
+      <Toolbar.Root>
+        <Toolbar.Button onClick={handleRun}>Run</Toolbar.Button>
+      </Toolbar.Root>
+      <div role='none' className='grid grid-rows-[1fr_min-content] bs-full overflow-hidden text-sm'>
+        <QueryEditor {...props} initialValue={object.content} extensions={extensions} />
+        <Json data={result} classNames='shrink-0 p-2 border-bs border-subduedSeparator' />
+      </div>
+    </Layout.Main>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/QueryEditor',
+  component: QueryEditor,
+  render: DefaultStory,
+  decorators: [
+    withTheme,
+    withLayout({
+      layout: 'column',
+      classNames: 'is-proseMaxWidth',
+    }),
+  ],
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    id: 'test',
+  },
+};

package/src/components/QueryEditor/QueryEditor.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useState } from 'react';
+import { ScriptTarget } from 'typescript';
+
+import queryApi from '@dxos/echo-query/api.d.ts?raw';
+import { useAsyncEffect } from '@dxos/react-ui';
+
+import { Compiler } from '../../compiler';
+import { TypescriptEditor, type TypescriptEditorProps } from '../TypescriptEditor';
+
+const GLOBALS = `
+  namespace QueryAPI {
+    ${queryApi}
+  }
+
+  declare global {
+    const Query: typeof QueryAPI.Query;
+    const Filter: typeof QueryAPI.Filter;
+    const Order: typeof QueryAPI.Order;
+  }
+
+  export {};
+`;
+
+export type QueryEditorProps = Omit<TypescriptEditorProps, 'env'>;
+
+export const QueryEditor = (props: QueryEditorProps) => {
+  const [compiler, setCompiler] = useState<Compiler>();
+
+  useAsyncEffect(async () => {
+    const compiler = new Compiler({
+      lib: ['ES5'],
+      target: ScriptTarget.ES2022,
+    });
+    await compiler.initialize(GLOBALS);
+    setCompiler(compiler);
+  }, []);
+
+  if (!compiler) {
+    return null;
+  }
+
+  return <TypescriptEditor {...props} env={compiler.environment} />;
+};

package/src/components/QueryEditor/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './QueryEditor';

package/src/components/ScriptContainer.tsx

@@ -4,12 +4,14 @@
 
 import React, { useMemo } from 'react';
 
+import { type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { Obj } from '@dxos/echo';
 import { createDocAccessor } from '@dxos/echo-db';
 import { type Script } from '@dxos/functions';
 import { getSpace } from '@dxos/react-client/echo';
 import { useIdentity } from '@dxos/react-client/halo';
-import { createDataExtensions, listener, stackItemContentEditorClassNames } from '@dxos/react-ui-editor';
-import { StackItem } from '@dxos/react-ui-stack';
+import { Layout } from '@dxos/react-ui-mosaic';
+import { createDataExtensions, listener, stackItemContentEditorClassNames } from '@dxos/ui-editor';
 
 import { useDeployState, useToolbarState } from '../hooks';
 import { type ScriptSettings } from '../types';
@@ -17,42 +19,54 @@ import { type ScriptSettings } from '../types';
 import { ScriptToolbar } from './ScriptToolbar';
 import { TypescriptEditor, type TypescriptEditorProps } from './TypescriptEditor';
 
-export type ScriptEditorProps = {
-  role: string;
-  script: Script.Script;
-  settings?: ScriptSettings;
-} & Pick<TypescriptEditorProps, 'env'>;
+export type ScriptEditorProps = SurfaceComponentProps<
+  Script.Script,
+  {
+    settings?: ScriptSettings;
+  } & Pick<TypescriptEditorProps, 'env'>
+>;
 
-export const ScriptContainer = ({ role, script, settings = { editorInputMode: 'vscode' }, env }: ScriptEditorProps) => {
+export const ScriptContainer = ({
+  role,
+  subject: script,
+  settings = { editorInputMode: 'vscode' },
+  env,
+}: ScriptEditorProps) => {
   const identity = useIdentity();
   const space = getSpace(script);
   const state = useToolbarState();
-  useDeployState({ state, script });
+  useDeployState({ script, state });
 
-  const extensions = useMemo(
-    () =>
-      script.source.target
-        ? [
-            listener({
-              onChange: ({ text }) => {
-                if (script.source.target?.content !== text) {
-                  script.changed = true;
-                }
-              },
-            }),
-            createDataExtensions({
-              id: script.id,
-              text: createDocAccessor(script.source.target, ['content']),
-              messenger: space,
-              identity,
-            }),
-          ]
-        : [],
-    [identity, space, script, script.source.target],
-  );
+  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.change(script, (s) => {
+              s.changed = true;
+            });
+          }
+        },
+      }),
+    ];
+  }, [identity, space, script, script.source.target]);
+
+  if (!extensions.length) {
+    return null;
+  }
 
   return (
-    <StackItem.Content toolbar>
+    <Layout.Main role={role} toolbar>
       <ScriptToolbar state={state} role={role} script={script} />
       <TypescriptEditor
         id={script.id}
@@ -63,7 +77,7 @@ export const ScriptContainer = ({ role, script, settings = { editorInputMode: 'v
         inputMode={settings.editorInputMode}
         toolbar
       />
-    </StackItem.Content>
+    </Layout.Main>
   );
 };
 

package/src/components/ScriptToolbar/ScriptToolbar.stories.tsx

@@ -2,46 +2,69 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Atom, Registry } from '@effect-atom/atom-react';
 import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
 
-import { IntentPlugin } from '@dxos/app-framework';
+import { OperationPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { Script } from '@dxos/functions';
 import { ClientPlugin } from '@dxos/plugin-client';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
+import { type ScriptToolbarState, type ScriptToolbarStateStore } from '../../hooks';
 import { translations } from '../../translations';
 
 import { ScriptToolbar } from './ScriptToolbar';
 
+// Create a mock store for stories.
+const createMockStore = (initialState: ScriptToolbarState = {}): ScriptToolbarStateStore => {
+  const registry = Registry.make();
+  const atom = Atom.make<ScriptToolbarState>(initialState);
+  return {
+    atom,
+    get value() {
+      return registry.get(atom);
+    },
+    update: (updater) => registry.set(atom, updater(registry.get(atom))),
+    set: (key, value) => registry.set(atom, { ...registry.get(atom), [key]: value }),
+  };
+};
+
+// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
+const ScriptToolbarStory = () => {
+  const state = useMemo(() => createMockStore(), []);
+  const script = useMemo(
+    () =>
+      Script.make({
+        name: 'test',
+        description: 'test',
+        source: 'test',
+      }),
+    [],
+  );
+  return <ScriptToolbar state={state} script={script} />;
+};
+
 const meta = {
   title: 'plugins/plugin-script/Toolbar',
-  component: ScriptToolbar,
+  component: ScriptToolbarStory,
   // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
   decorators: [
     withTheme,
-    withLayout({ classNames: 'is-prose' }),
+    withLayout({ classNames: 'is-proseMaxWidth' }),
     withPluginManager({
-      plugins: [IntentPlugin(), ClientPlugin({})],
+      plugins: [OperationPlugin(), ClientPlugin({})],
     }),
   ],
   parameters: {
     layout: 'centered',
     translations,
   },
-} satisfies Meta<typeof ScriptToolbar>;
+} satisfies Meta<typeof ScriptToolbarStory>;
 
 export default meta;
 
 type Story = StoryObj<typeof meta>;
 
-export const Default: Story = {
-  args: {
-    state: {},
-    script: Script.make({
-      name: 'test',
-      description: 'test',
-      source: 'test',
-    }),
-  },
-};
+export const Default: Story = {};

package/src/components/ScriptToolbar/ScriptToolbar.tsx

@@ -12,14 +12,13 @@ import {
   type ActionGraphProps,
   MenuProvider,
   ToolbarMenu,
-  atomFromSignal,
   createGapSeparator,
   useMenuActions,
 } from '@dxos/react-ui-menu';
 
 import {
   type CreateDeployOptions,
-  type ScriptToolbarState,
+  type ScriptToolbarStateStore,
   createDeploy,
   createFormat,
   createTemplateSelect,
@@ -30,7 +29,7 @@ import { meta } from '../../meta';
 export type ScriptToolbarProps = {
   role?: string;
   script: Script.Script;
-  state: ScriptToolbarState;
+  state: ScriptToolbarStateStore;
 };
 
 export const ScriptToolbar = ({ script, role, state }: ScriptToolbarProps) => {
@@ -49,17 +48,15 @@ export const ScriptToolbar = ({ script, role, state }: ScriptToolbarProps) => {
 };
 
 const createToolbarActions = ({ state, script, ...options }: CreateDeployOptions): Atom.Atom<ActionGraphProps> =>
-  Atom.make((get) =>
-    get(
-      atomFromSignal(() => {
-        const templateSelect = createTemplateSelect(script);
-        const format = createFormat(script);
-        const gap = createGapSeparator();
-        const deploy = createDeploy({ state, script, ...options });
-        return {
-          nodes: [...templateSelect.nodes, ...format.nodes, ...gap.nodes, ...deploy.nodes],
-          edges: [...templateSelect.edges, ...format.edges, ...gap.edges, ...deploy.edges],
-        };
-      }),
-    ),
-  );
+  Atom.make((get) => {
+    // Subscribe to state changes.
+    get(state.atom);
+    const templateSelect = createTemplateSelect(script);
+    const format = createFormat(script);
+    const gap = createGapSeparator();
+    const deploy = createDeploy({ state, script, ...options });
+    return {
+      nodes: [...templateSelect.nodes, ...format.nodes, ...gap.nodes, ...deploy.nodes],
+      edges: [...templateSelect.edges, ...format.edges, ...gap.edges, ...deploy.edges],
+    };
+  });