@dxos/plugin-script 0.8.4-main.28f8d3d → 0.8.4-main.2c6827d

package/src/capabilities/react-surface.tsx

@@ -4,18 +4,20 @@
 
 import React from 'react';
 
-import { Capabilities, contributes, createSurface, useCapability } from '@dxos/app-framework';
+import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
+import { useCapability } from '@dxos/app-framework/react';
 import { InvocationTraceContainer } from '@dxos/devtools';
 import { Obj } from '@dxos/echo';
-import { ScriptType } from '@dxos/functions';
+import { Script } from '@dxos/functions';
 import { SettingsStore } from '@dxos/local-storage';
 import { getSpace } from '@dxos/react-client/echo';
 import { StackItem } from '@dxos/react-ui-stack';
-import { type DataType } from '@dxos/schema';
+import { type AccessToken } from '@dxos/types';
 
 import {
   DEPLOYMENT_DIALOG,
   DeploymentDialog,
+  NotebookContainer,
   ScriptContainer,
   ScriptObjectSettings,
   ScriptPluginSettings,
@@ -23,7 +25,7 @@ import {
   TestContainer,
 } from '../components';
 import { meta } from '../meta';
-import { type ScriptSettingsProps } from '../types';
+import { Notebook, type ScriptSettings } from '../types';
 
 import { ScriptCapabilities } from './capabilities';
 
@@ -32,46 +34,57 @@ export default () =>
     createSurface({
       id: `${meta.id}/plugin-settings`,
       role: 'article',
-      filter: (data): data is { subject: SettingsStore<ScriptSettingsProps> } =>
+      filter: (data): data is { subject: SettingsStore<ScriptSettings> } =>
         data.subject instanceof SettingsStore && data.subject.prefix === meta.id,
       component: ({ data: { subject } }) => <ScriptPluginSettings settings={subject.value} />,
     }),
     createSurface({
-      id: `${meta.id}/article`,
-      role: 'article',
-      filter: (data): data is { subject: ScriptType } => Obj.instanceOf(ScriptType, data.subject),
+      id: `${meta.id}/script/article`,
+      role: ['article', 'section'],
+      filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
       component: ({ data, role }) => {
         const compiler = useCapability(ScriptCapabilities.Compiler);
         // TODO(dmaretskyi): Since settings store is not reactive, this would break on the script plugin being enabled without a page reload.
-        const settings = useCapability(Capabilities.SettingsStore).getStore<ScriptSettingsProps>(meta.id)?.value;
+        const settings = useCapability(Capabilities.SettingsStore).getStore<ScriptSettings>(meta.id)?.value;
         return <ScriptContainer role={role} script={data.subject} settings={settings} env={compiler.environment} />;
       },
     }),
+    createSurface({
+      id: `${meta.id}/notebook/article`,
+      role: 'article',
+      filter: (data): data is { subject: Notebook.Notebook } => Obj.instanceOf(Notebook.Notebook, data.subject),
+      component: ({ data, role }) => {
+        const compiler = useCapability(ScriptCapabilities.Compiler);
+        return <NotebookContainer role={role} notebook={data.subject} env={compiler.environment} />;
+      },
+    }),
+    // TODO(burdon): Standardize PluginSettings vs ObjectSettings.
+    // TODO(burdon): Why is ScriptProperties different from ScriptObjectSettings?
     createSurface({
       id: `${meta.id}/companion/base-settings`,
       role: 'base-object-settings',
-      filter: (data): data is { subject: ScriptType } => Obj.instanceOf(ScriptType, data.subject),
+      filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
       component: ({ data }) => <ScriptProperties object={data.subject} />,
     }),
     createSurface({
       id: `${meta.id}/companion/settings`,
       role: 'object-settings',
-      filter: (data): data is { subject: ScriptType } => Obj.instanceOf(ScriptType, data.subject),
+      filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
       component: ({ data }) => <ScriptObjectSettings object={data.subject} />,
     }),
     createSurface({
       id: `${meta.id}/companion/execute`,
       role: 'article',
-      filter: (data): data is { companionTo: ScriptType } =>
-        Obj.instanceOf(ScriptType, data.companionTo) && data.subject === 'execute',
+      filter: (data): data is { companionTo: Script.Script } =>
+        Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'execute',
       component: ({ data, role }) => <TestContainer script={data.companionTo} role={role} />,
     }),
     createSurface({
       id: `${meta.id}/companion/logs`,
       role: 'article',
-      filter: (data): data is { companionTo: ScriptType } =>
-        Obj.instanceOf(ScriptType, data.companionTo) && data.subject === 'logs',
-      component: ({ data, role }) => {
+      filter: (data): data is { companionTo: Script.Script } =>
+        Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'logs',
+      component: ({ data }) => {
         const space = getSpace(data.companionTo);
         return (
           <StackItem.Content>
@@ -83,7 +96,7 @@ export default () =>
     createSurface({
       id: DEPLOYMENT_DIALOG,
       role: 'dialog',
-      filter: (data): data is { props: { accessToken: DataType.AccessToken; scriptTemplates: any } } =>
+      filter: (data): data is { props: { accessToken: AccessToken.AccessToken; scriptTemplates: any } } =>
         data.component === DEPLOYMENT_DIALOG,
       component: ({ data }) => <DeploymentDialog {...data.props} />,
     }),

package/src/capabilities/settings.ts

@@ -6,16 +6,16 @@ import { Capabilities, contributes } from '@dxos/app-framework';
 import { live } from '@dxos/live-object';
 
 import { meta } from '../meta';
-import { ScriptSettingsSchema } from '../types';
+import { ScriptSettings } from '../types';
 
 export default () => {
-  const settings = live(ScriptSettingsSchema, {
+  const settings = live<ScriptSettings>({
     editorInputMode: 'vscode',
   });
 
   return contributes(Capabilities.Settings, {
     prefix: meta.id,
-    schema: ScriptSettingsSchema,
+    schema: ScriptSettings,
     value: settings,
   });
 };

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

@@ -2,38 +2,57 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
+import { IntentPlugin } 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 { withTheme } from '@dxos/react-ui/testing';
+import { AccessToken } from '@dxos/types';
 
 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' },
-    ],
-  },
-  render: (args: any) => (
+import { DeploymentDialog, type DeploymentDialogProps } from './DeploymentDialog';
+
+const DefaultStory = (props: DeploymentDialogProps) => {
+  return (
     <Dialog.Root defaultOpen={true}>
-      <DeploymentDialog {...args} />
+      <DeploymentDialog {...props} />
     </Dialog.Root>
-  ),
+  );
 };
 
-const meta: Meta = {
+const meta = {
   title: 'plugins/plugin-script/DeploymentDialog',
   component: DeploymentDialog,
+  render: DefaultStory,
   parameters: { translations },
-  decorators: [withTheme, withLayout()],
-};
+  // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+  decorators: [
+    withTheme,
+    withPluginManager({
+      plugins: [IntentPlugin(), ClientPlugin({})],
+    }),
+  ],
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    accessToken: Obj.make(AccessToken.AccessToken, {
+      source: 'example.com',
+      token: 'example-token',
+    }),
+    scriptTemplates: [
+      { id: 't-1', name: 'Script 1', source: 'template1' },
+      { id: 't-2', name: 'Script 2', source: 'template2' },
+      { id: 't-3', name: 'Script 3', source: 'template3' },
+    ],
+  },
+};

package/src/components/DeploymentDialog/DeploymentDialog.tsx

@@ -4,29 +4,30 @@
 
 import React, { useEffect, useMemo } from 'react';
 
-import { LayoutAction, createIntent, useIntentDispatcher } from '@dxos/app-framework';
+import { LayoutAction, createIntent } from '@dxos/app-framework';
+import { useIntentDispatcher } from '@dxos/app-framework/react';
 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.
 
-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.
@@ -41,35 +42,39 @@ export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDia
         createIntent(LayoutAction.AddToast, {
           part: 'toast',
           subject: {
-            id: `${SCRIPT_PLUGIN}/deployment-success`,
+            id: `${meta.id}/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 }],
+            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 dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } }));
+      void dispatch(
+        createIntent(LayoutAction.UpdateDialog, {
+          part: 'dialog',
+          options: { state: false },
+        }),
+      );
     }
     if (status === 'error') {
-      void dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } }));
+      void dispatch(
+        createIntent(LayoutAction.UpdateDialog, {
+          part: 'dialog',
+          options: { state: false },
+        }),
+      );
       void dispatch(
         createIntent(LayoutAction.AddToast, {
           part: 'toast',
           subject: {
-            id: `${SCRIPT_PLUGIN}/deployment-error`,
+            id: `${meta.id}/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 },
-            ],
+            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 }],
           },
         }),
       );
@@ -81,14 +86,16 @@ export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDia
       <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 +105,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/FrameContainer/FrameContainer.tsx

@@ -5,7 +5,7 @@
 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';
@@ -48,7 +48,8 @@ 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(result.bundle)}` : undefined;
 
   return (
     <>
@@ -59,7 +60,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 +69,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/NotebookContainer.stories.tsx

@@ -0,0 +1,83 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { SERVICES_CONFIG } from '@dxos/ai/testing';
+import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
+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 { SpacePlugin } from '@dxos/plugin-space';
+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 = {
+  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} notebook={notebooks[0]} />;
+  },
+  decorators: [
+    withTheme,
+    withLayout({ container: 'column', classNames: 'is-prose' }),
+    withPluginManager({
+      plugins: [
+        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: async ({ client }) => {
+            await client.halo.createIdentity();
+            await client.spaces.waitUntilReady();
+            const space = client.spaces.default;
+            await space.waitUntilReady();
+
+            space.db.add(createNotebook());
+            space.db.add(Markdown.make({ content: '# Hello World' }));
+            space.db.add(serializeFunction(Agent.prompt));
+          },
+        }),
+        SpacePlugin({}),
+        SettingsPlugin(),
+        IntentPlugin(),
+        AssistantPlugin(),
+        AutomationPlugin(),
+        ExplorerPlugin(),
+        MarkdownPlugin(),
+      ],
+    }),
+  ],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof NotebookContainer>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};