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

package/src/components/NotebookStack/NotebookCell.tsx

@@ -4,38 +4,38 @@
 
 import React, { useCallback, useMemo } from 'react';
 
-import { Surface } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
+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 { TemplateEditor } from '@dxos/plugin-assistant/components';
 import { useThemeContext, useTranslation } from '@dxos/react-ui';
 import { QueryEditor, type QueryEditorProps } from '@dxos/react-ui-components';
+import { Editor, type EditorViewProps } 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';
+import { meta } from '#meta';
+import { type Notebook } from '#types';
+
 import { type ComputeGraph } from '../../notebook';
-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 = {
-  space?: Space;
+  db?: Database.Database;
   graph?: ComputeGraph;
   dragging?: boolean;
   cell: Notebook.Cell;
@@ -43,7 +43,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 +62,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.update(cell.source.target, (obj) => {
+        obj.content = value;
+      });
     },
     [cell],
   );
@@ -97,7 +99,7 @@ export const NotebookCell = ({ space, graph, dragging, cell, promptResults, env
             extensions={extensions}
             env={env}
             options={{
-              placeholder: t('notebook cell placeholder'),
+              placeholder: t('notebook-cell.placeholder'),
               highlightActiveLine: false,
               lineNumbers: false,
             }}
@@ -113,17 +115,21 @@ export const NotebookCell = ({ space, 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']}
-            db={space?.db}
+            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
+              type={AppSurface.Section}
+              limit={1}
+              data={{ subject: explorerGraph, attendableId: cell.id }}
+            />
+          )}
         </div>
       );
 
@@ -151,7 +157,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,13 +166,13 @@ const NotebookCellValue = ({ cell, graph }: NotebookCellProps) => {
   return (
     <div
       className={mx(
-        'flex is-full bg-groupSurface border-t 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>
         </>
       )}
@@ -186,31 +192,35 @@ 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 w-full bg-group-surface text-description border-y border-subdued-separator', valueStyles)}>
       <NotebookTextEditor readOnly value={value} />
     </div>
   );
 };
 
 const NotebookTextEditor = ({
-  extensions: extensionsParam,
+  extensions: extensionsProp,
   readOnly,
   ...props
-}: EditorContentProps & Pick<BasicExtensionsOptions, 'readOnly'>) => {
+}: EditorViewProps & Pick<BasicExtensionsOptions, 'readOnly'>) => {
   const { t } = useTranslation(meta.id);
   const { themeMode } = useThemeContext();
   const extensions = useMemo(() => {
     return [
       createBasicExtensions({
-        placeholder: t('notebook markdown placeholder'),
+        placeholder: t('notebook-markdown.placeholder'),
         readOnly,
       }),
       createThemeExtensions({ themeMode, syntaxHighlighting: true }),
       createMarkdownExtensions(),
       decorateMarkdown(),
-      extensionsParam,
+      extensionsProp,
     ].filter(isNonNullable);
-  }, [extensionsParam]);
+  }, [extensionsProp]);
 
-  return <EditorContent {...props} extensions={extensions} selectionEnd />;
+  return (
+    <Editor.Root>
+      <Editor.View {...props} extensions={extensions} selectionEnd />
+    </Editor.Root>
+  );
 };

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>

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

@@ -3,37 +3,40 @@
 //
 
 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 { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { AutomationPlugin } from '@dxos/plugin-automation/testing';
+import { ClientPlugin } from '@dxos/plugin-client/testing';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { corePlugins } from '@dxos/plugin-testing';
+import { withLayout } from '@dxos/react-ui/testing';
 
-import { createNotebook } from '../../testing';
-import { translations } from '../../translations';
+import { createNotebook } from '#testing';
+import { translations } from '#translations';
 
 import { NotebookStack } from './NotebookStack';
 
+const NotebookStackStory = () => {
+  const notebook = useMemo(() => createNotebook(), []);
+  return <NotebookStack notebook={notebook} />;
+};
+
 const meta = {
-  title: 'plugins/plugin-script/NotebookStack',
-  component: NotebookStack,
+  title: 'plugins/plugin-script/components/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: 'w-document-max-width' }),
     withPluginManager({
       plugins: [
+        ...corePlugins(),
         ClientPlugin({
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-            await client.spaces.waitUntilReady();
-          },
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+            }),
         }),
-        SpacePlugin({}),
-        SettingsPlugin(),
-        IntentPlugin(),
         AutomationPlugin(),
       ],
     }),
@@ -41,14 +44,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

@@ -6,40 +6,51 @@ import React from 'react';
 
 import { DropdownMenu, IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
 import { Stack, StackItem, type StackProps } from '@dxos/react-ui-stack';
+import { composable, composableProps } from '@dxos/ui-theme';
 
-import { meta } from '../../meta';
-import { type Notebook } from '../../types';
-import { type TypescriptEditorProps } from '../TypescriptEditor';
+import { meta } from '#meta';
+import { type Notebook } from '#types';
 
+import { type TypescriptEditorProps } from '../TypescriptEditor';
 import { NotebookCell, type NotebookCellProps } from './NotebookCell';
 import { NotebookMenu } from './NotebookMenu';
 
-const minSectionHeight = 'min-bs-[16rem]';
+const minSectionHeight = 'min-h-[16rem]';
 
 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'>)
 >;
 
 // TODO(burdon): Option for narrow rail (with compact buttons that align with first button in toolbar).
-export const NotebookStack = ({ classNames, notebook, onRearrange, ...props }: NotebookStackProps) => {
-  return (
-    <Stack classNames={classNames} orientation='vertical' size='contain' rail onRearrange={onRearrange}>
-      {notebook?.cells.map((cell, i) => (
-        <NotebookSection key={i} cell={cell} {...props} />
-      ))}
-    </Stack>
-  );
-};
+export const NotebookStack = composable<HTMLDivElement, NotebookStackProps>(
+  ({ notebook, onRearrange, db, graph, promptResults, onCellInsert, onCellDelete, env, ...props }, forwardedRef) => {
+    const sectionProps = { db, graph, promptResults, onCellInsert, onCellDelete, env };
+    return (
+      <Stack
+        {...composableProps(props)}
+        orientation='vertical'
+        size='contain'
+        rail
+        onRearrange={onRearrange}
+        ref={forwardedRef}
+      >
+        {notebook?.cells.map((cell, i) => (
+          <NotebookSection key={i} cell={cell} {...sectionProps} />
+        ))}
+      </Stack>
+    );
+  },
+);
 
 type NotebookSectionProps = NotebookCellProps;
 
 const NotebookSection = ({
   cell,
-  space,
+  db,
   env,
   promptResults,
   onCellInsert,
@@ -51,7 +62,7 @@ const NotebookSection = ({
 
   return (
     <StackItem.Root role='section' item={cell} draggable classNames={resizable && minSectionHeight}>
-      <StackItem.Heading classNames='bs-full p-1 justify-between attention-surface'>
+      <StackItem.Heading classNames='h-full p-1 justify-between dx-attention-surface'>
         <StackItem.DragHandle asChild>
           <IconButton variant='ghost' icon='ph--dots-six-vertical--regular' iconOnly label='Drag handle' />
         </StackItem.DragHandle>
@@ -61,7 +72,7 @@ const NotebookSection = ({
               variant='ghost'
               icon='ph--dots-three--regular'
               iconOnly
-              label={t('notebook cell insert label')}
+              label={t('notebook-cell-insert.label')}
             />
           </DropdownMenu.Trigger>
           <NotebookMenu cell={cell} onCellInsert={onCellInsert} onCellDelete={onCellDelete} />
@@ -72,14 +83,14 @@ const NotebookSection = ({
       {/* TODO(burdon): Move drag preview to outer stack (uniformly). */}
       <StackItem.DragPreview>
         {({ item: cell }) => (
-          <StackItem.Content classNames='overflow-visible bg-groupSurface border border-subduedSeparator'>
-            <NotebookCell space={space} cell={cell} env={env} dragging />
+          <StackItem.Content classNames='overflow-visible bg-group-surface border border-subdued-separator'>
+            <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,96 @@
+//
+// 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 { Panel, Toolbar, useAsyncEffect } from '@dxos/react-ui';
+import { JsonHighlighter } from '@dxos/react-ui-syntax-highlighter';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { createDataExtensions } from '@dxos/ui-editor';
+import { trim } from '@dxos/util';
+
+import { QueryEditor, type QueryEditorProps } from './QueryEditor';
+
+const SCRIPT = trim`
+  Query.select(Filter.type('org.dxos.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 (
+    <Panel.Root>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root>
+          <Toolbar.Button onClick={handleRun}>Run</Toolbar.Button>
+        </Toolbar.Root>
+      </Panel.Toolbar>
+      <Panel.Content>
+        <div className='grid grid-rows-[1fr_min-content] h-full overflow-hidden text-sm'>
+          <QueryEditor {...props} initialValue={object.content} extensions={extensions} />
+          <JsonHighlighter data={result} classNames='shrink-0 p-2 border-y border-subdued-separator' />
+        </div>
+      </Panel.Content>
+    </Panel.Root>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/components/QueryEditor',
+  component: QueryEditor,
+  render: DefaultStory,
+  decorators: [withTheme(), withLayout({ layout: 'column', classNames: 'w-document-max-width' })],
+} 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,49 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useState } from 'react';
+import { ModuleResolutionKind, 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,
+      // Avoid `@typescript/vfs`'s deprecated `node10` default (rejected by TS 6).
+      moduleResolution: ModuleResolutionKind.Bundler,
+    });
+    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/ScriptPluginSettings/ScriptPluginSettings.stories.tsx

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '#translations';
+
+import { ScriptPluginSettings } from './ScriptPluginSettings';
+
+const meta = {
+  title: 'plugins/plugin-script/components/ScriptPluginSettings',
+  component: ScriptPluginSettings,
+  tags: ['settings'],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof ScriptPluginSettings>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    settings: { editorInputMode: 'default' },
+  },
+};

package/src/components/ScriptPluginSettings/ScriptPluginSettings.tsx

@@ -0,0 +1,42 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Button, useTranslation } from '@dxos/react-ui';
+import { Settings as SettingsForm } from '@dxos/react-ui-form';
+
+import { meta } from '#meta';
+import { Settings } from '#types';
+
+export type ScriptPluginSettingsProps = AppSurface.SettingsArticleProps<
+  Settings.Settings,
+  {
+    onAuthenticate?: () => void;
+  }
+>;
+
+export const ScriptPluginSettings = ({ settings, onSettingsChange, onAuthenticate }: ScriptPluginSettingsProps) => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <SettingsForm.Viewport>
+      <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>
+        {/* TODO(wittjosiah): Hide outside of dev environments. */}
+        <SettingsForm.Item title={t('authenticate-action.label')} description={t('authenticate-action.description')}>
+          <Button disabled={!onSettingsChange} onClick={onAuthenticate}>
+            {t('authenticate-button.label')}
+          </Button>
+        </SettingsForm.Item>
+        <SettingsForm.FieldSet
+          readonly={!onSettingsChange}
+          schema={Settings.Settings}
+          values={settings}
+          onValuesChanged={(values) => onSettingsChange?.(() => values)}
+        />
+      </SettingsForm.Section>
+    </SettingsForm.Viewport>
+  );
+};

package/src/components/ScriptPluginSettings/index.ts

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