@dxos/plugin-script 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/src/capabilities/intent-resolver.ts

@@ -1,87 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Octokit } from '@octokit/core';
-import * as Predicate from 'effect/Predicate';
-
-import { Capabilities, LayoutAction, contributes, createIntent, createResolver } from '@dxos/app-framework';
-import { Obj, Ref } from '@dxos/echo';
-import { ScriptType } from '@dxos/functions';
-import { TokenManagerAction } from '@dxos/plugin-token-manager/types';
-import { DataType } from '@dxos/schema';
-
-import { DEPLOYMENT_DIALOG } from '../components';
-import { defaultScriptsForIntegration } from '../meta';
-import { templates } from '../templates';
-import { Notebook, ScriptAction } from '../types';
-
-export default () =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: ScriptAction.CreateScript,
-      resolve: async ({ name, gistUrl, initialTemplateId }) => {
-        let content = templates[0].source;
-
-        const gistId = gistUrl?.split('/').at(-1);
-        if (gistId) {
-          // TODO(wittjosiah): Capability which contributes Octokit?
-          // NOTE: AccessToken not needed to read public gists.
-          const octokit = new Octokit();
-          const response = await octokit.request('GET /gists/{gist_id}', {
-            gist_id: gistId,
-          });
-          const gistContent = Object.values(response.data.files ?? {})[0]?.content;
-          if (gistContent) {
-            content = gistContent;
-          }
-        }
-
-        if (initialTemplateId) {
-          const template = templates.find((template) => template.id === initialTemplateId);
-          if (template) {
-            content = template.source;
-            name = template.name;
-          }
-        }
-
-        return {
-          data: {
-            object: Obj.make(ScriptType, { name, source: Ref.make(DataType.makeText(content)) }),
-          },
-        };
-      },
-    }),
-    createResolver({
-      intent: ScriptAction.CreateNotebook,
-      resolve: async ({ name }) => {
-        return {
-          data: {
-            object: Obj.make(Notebook.Notebook, { name, cells: [] }),
-          },
-        };
-      },
-    }),
-    createResolver({
-      intent: TokenManagerAction.AccessTokenCreated,
-      resolve: async ({ accessToken }) => {
-        const scriptTemplates = (defaultScriptsForIntegration[accessToken.source] ?? [])
-          .map((id) => templates.find((t) => t.id === id))
-          .filter(Predicate.isNotNullable);
-
-        if (scriptTemplates.length > 0) {
-          return {
-            intents: [
-              createIntent(LayoutAction.UpdateDialog, {
-                part: 'dialog',
-                subject: DEPLOYMENT_DIALOG,
-                options: { blockAlign: 'start', state: true, props: { accessToken, scriptTemplates } },
-              }),
-            ],
-          };
-        }
-
-        return { data: undefined };
-      },
-    }),
-  ]);

package/src/capabilities/react-surface.tsx

@@ -1,102 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface, useCapability } from '@dxos/app-framework';
-import { InvocationTraceContainer } from '@dxos/devtools';
-import { Obj } from '@dxos/echo';
-import { ScriptType } 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 {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog,
-  NotebookContainer,
-  ScriptContainer,
-  ScriptObjectSettings,
-  ScriptPluginSettings,
-  ScriptProperties,
-  TestContainer,
-} from '../components';
-import { meta } from '../meta';
-import { Notebook, type ScriptSettings } from '../types';
-
-import { ScriptCapabilities } from './capabilities';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/plugin-settings`,
-      role: 'article',
-      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}/script/article`,
-      role: ['article', 'section'],
-      filter: (data): data is { subject: ScriptType } => Obj.instanceOf(ScriptType, 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<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),
-      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),
-      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',
-      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 }) => {
-        const space = getSpace(data.companionTo);
-        return (
-          <StackItem.Content>
-            <InvocationTraceContainer space={space} target={data.companionTo} detailAxis='block' />
-          </StackItem.Content>
-        );
-      },
-    }),
-    createSurface({
-      id: DEPLOYMENT_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: { accessToken: DataType.AccessToken; scriptTemplates: any } } =>
-        data.component === DEPLOYMENT_DIALOG,
-      component: ({ data }) => <DeploymentDialog {...data.props} />,
-    }),
-  ]);

package/src/capabilities/settings.ts

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

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

@@ -1,53 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-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 { withTheme } from '@dxos/react-ui/testing';
-import { DataType } from '@dxos/schema';
-
-import { translations } from '../../translations';
-
-import { DeploymentDialog, type DeploymentDialogProps } from './DeploymentDialog';
-
-const DefaultStory = (props: DeploymentDialogProps) => {
-  return (
-    <Dialog.Root defaultOpen={true}>
-      <DeploymentDialog {...props} />
-    </Dialog.Root>
-  );
-};
-
-const meta = {
-  title: 'plugins/plugin-script/DeploymentDialog',
-  component: DeploymentDialog,
-  render: DefaultStory,
-  parameters: { translations },
-  // 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(DataType.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

@@ -1,106 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useEffect, useMemo } from 'react';
-
-import { LayoutAction, createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { getSpace } from '@dxos/react-client/echo';
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
-import { type DataType } from '@dxos/schema';
-
-import { useCreateAndDeployScriptTemplates } from '../../hooks/useCreateAndDeployScriptTemplates';
-import { meta } from '../../meta';
-import { type Template } from '../../templates';
-
-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.
-
-export type DeploymentDialogProps = {
-  accessToken: DataType.AccessToken;
-  scriptTemplates: Template[];
-};
-
-export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDialogProps) => {
-  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();
-
-  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: `${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 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.AddToast, {
-          part: 'toast',
-          subject: {
-            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]);
-
-  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>
-        </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>
-        <ul className='pbs-2'>
-          {scriptTemplates.map((template) => {
-            return <li key={template.id}>{template.name}</li>;
-          })}
-        </ul>
-      </div>
-      <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 })}
-        </Button>
-        <Dialog.Close asChild disabled={status === 'pending'}>
-          <Button disabled={status === 'pending'}>{t('deployment dialog skip button label')}</Button>
-        </Dialog.Close>
-      </div>
-    </Dialog.Content>
-  );
-};
-
-export default DeploymentDialog;

package/src/components/DeploymentDialog/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { DEPLOYMENT_DIALOG, DeploymentDialog } from './DeploymentDialog';
-
-export { DEPLOYMENT_DIALOG };
-
-export default DeploymentDialog;

package/src/components/NotebookContainer.stories.tsx

@@ -1,36 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-
-import { withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { createNotebook } from '../testing';
-import { translations } from '../translations';
-
-import { NotebookContainer } from './NotebookContainer';
-
-const meta = {
-  title: 'plugins/plugin-script/NotebookContainer',
-  component: NotebookContainer,
-  decorators: [withTheme, withClientProvider()],
-  parameters: {
-    layout: {
-      type: 'column',
-      className: 'is-prose',
-    },
-    translations,
-  },
-} satisfies Meta<typeof NotebookContainer>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    notebook: createNotebook(),
-  },
-};

package/src/components/NotebookContainer.tsx

@@ -1,82 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback, useMemo } from 'react';
-
-import { Ref } from '@dxos/echo';
-import { Toolbar, useTranslation } from '@dxos/react-ui';
-import { StackItem } from '@dxos/react-ui-stack';
-import { DataType } from '@dxos/schema';
-
-import { meta } from '../meta';
-import { ComputeGraph } from '../notebook';
-import { type Notebook } from '../types';
-
-import { NotebookStack, type NotebookStackProps } from './NotebookStack';
-import { type TypescriptEditorProps } from './TypescriptEditor';
-
-export type NotebookContainerProps = {
-  role?: string;
-  notebook?: Notebook.Notebook;
-} & Pick<TypescriptEditorProps, 'env'>;
-
-export const NotebookContainer = ({ notebook, env }: NotebookContainerProps) => {
-  const { t } = useTranslation(meta.id);
-
-  const graph = useMemo(() => notebook && new ComputeGraph(notebook), [notebook]);
-
-  const handleCompute = useCallback(() => {
-    graph?.evaluate();
-  }, [graph]);
-
-  const handleCellInsert = useCallback<NonNullable<NotebookStackProps['onCellInsert']>>(
-    (after) => {
-      const idx = after ? notebook!.cells.findIndex((cell) => cell.id === after) : notebook!.cells.length;
-      notebook?.cells.splice(idx, 0, {
-        id: crypto.randomUUID(),
-        script: Ref.make(DataType.makeText('\n\n\n')),
-      });
-    },
-    [notebook],
-  );
-
-  const handleCellDelete = useCallback<NonNullable<NotebookStackProps['onCellDelete']>>(
-    (id: string) => {
-      const idx = notebook!.cells.findIndex((cell) => cell.id === id);
-      if (idx !== -1) {
-        notebook!.cells.splice(idx, 1);
-      }
-    },
-    [notebook],
-  );
-
-  return (
-    <StackItem.Content classNames='container-max-width border-l border-r border-subduedSeparator' toolbar>
-      <Toolbar.Root>
-        <Toolbar.IconButton
-          icon='ph--plus--regular'
-          iconOnly
-          label={t('add cell label')}
-          onClick={() => handleCellInsert('')}
-        />
-        <Toolbar.IconButton
-          icon='ph--play--fill'
-          iconOnly
-          label={t('compute label')}
-          classNames='text-green-500'
-          onClick={handleCompute}
-        />
-      </Toolbar.Root>
-      <NotebookStack
-        notebook={notebook}
-        graph={graph}
-        env={env}
-        onCellInsert={handleCellInsert}
-        onCellDelete={handleCellDelete}
-      />
-    </StackItem.Content>
-  );
-};
-
-export default NotebookContainer;

package/src/components/ScriptContainer.tsx

@@ -1,69 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { type ScriptType } from '@dxos/functions';
-import { createDocAccessor, 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 { useDeployState, useToolbarState } from '../hooks';
-import { type ScriptSettings } from '../types';
-
-import { ScriptToolbar } from './ScriptToolbar';
-import { TypescriptEditor, type TypescriptEditorProps } from './TypescriptEditor';
-
-export type ScriptEditorProps = {
-  role: string;
-  script: ScriptType;
-  settings?: ScriptSettings;
-} & Pick<TypescriptEditorProps, 'env'>;
-
-export const ScriptContainer = ({ role, script, settings = { editorInputMode: 'vscode' }, env }: ScriptEditorProps) => {
-  const identity = useIdentity();
-  const space = getSpace(script);
-  const state = useToolbarState();
-  useDeployState({ state, script });
-
-  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']),
-              space,
-              identity,
-            }),
-          ]
-        : [],
-    [identity, space, script, script.source.target],
-  );
-
-  return (
-    <StackItem.Content toolbar>
-      <ScriptToolbar state={state} role={role} script={script} />
-      <TypescriptEditor
-        id={script.id}
-        env={env}
-        initialValue={script.source?.target?.content}
-        extensions={extensions}
-        classNames={stackItemContentEditorClassNames(role)}
-        inputMode={settings.editorInputMode}
-        toolbar
-      />
-    </StackItem.Content>
-  );
-};
-
-export default ScriptContainer;

package/src/components/Settings/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './ScriptObjectSettings';
-export * from './ScriptPluginSettings';

package/src/components/TestPanel/TestContainer.tsx

@@ -1,27 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { type ScriptType } from '@dxos/functions';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { useDeployState, useToolbarState } from '../../hooks';
-
-import { TestPanel } from './TestPanel';
-
-export type TestContainerProps = {
-  role: string;
-  script: ScriptType;
-};
-
-export const TestContainer = ({ script }: TestContainerProps) => {
-  const state = useToolbarState();
-  useDeployState({ state, script });
-  return (
-    <StackItem.Content>
-      <TestPanel functionUrl={state.functionUrl} />
-    </StackItem.Content>
-  );
-};

package/src/events.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineEvent } from '@dxos/app-framework';
-
-import { meta } from './meta';
-
-export namespace ScriptEvents {
-  export const SetupCompiler = defineEvent(`${meta.id}/event/setup-compiler`);
-}

package/src/notebook/notebook.test.ts

@@ -1,38 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, expect, test } from 'vitest';
-
-import { createNotebook } from '../testing';
-
-import { ComputeGraph } from './notebook';
-
-// TODO(burdon): Create test where one cell could be a AI prompt that references other cells.
-// TODO(burdon): UI cells: Value, Query, TS Expression, Prompt (show input and output).
-
-describe('notebook', () => {
-  test('parse dependency graph', () => {
-    const notebook = createNotebook();
-    const computer = new ComputeGraph(notebook);
-    const result = computer.parse();
-
-    const getId = (i: number) => notebook.cells[i].id;
-
-    // Check dependencies.
-    expect(result.dependencyGraph).toMatchObject({
-      [getId(0)]: [getId(1), getId(2)],
-      [getId(3)]: [getId(1)],
-      [getId(4)]: [getId(0), getId(3)],
-    });
-
-    // Compute values.
-    const values = computer.evaluate();
-    expect(values).toEqual({
-      [getId(0)]: 300,
-      [getId(2)]: 200,
-      [getId(3)]: 200,
-      [getId(4)]: 500,
-    });
-  });
-});