@dxos/plugin-script 0.8.4-main.3c1ae3b → 0.8.4-main.3fbcb4aa9b

package/src/containers/ScriptContainer/ScriptContainer.stories.tsx

@@ -0,0 +1,106 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React, { useEffect, useState } from 'react';
+
+import { SERVICES_CONFIG } from '@dxos/ai/testing';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Blueprint } from '@dxos/compute';
+import { Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { ClientPlugin } from '@dxos/plugin-client/plugin';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { Config } from '@dxos/react-client';
+import { Filter, useQuery, useSpaces } from '@dxos/react-client/echo';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { createScript } from '#testing';
+import { translations } from '#translations';
+
+import { ScriptContainer } from './ScriptContainer';
+
+type DefaultStoryProps = {};
+
+/**
+ * Loads the script source ref so `script.source.target` is available for the editor.
+ */
+const DefaultStory = (_: DefaultStoryProps) => {
+  const [space] = useSpaces();
+  const [script] = useQuery(space?.db, Filter.type(Script.Script));
+  const [sourceReady, setSourceReady] = useState(false);
+
+  useEffect(() => {
+    if (!script) {
+      setSourceReady(false);
+      return;
+    }
+
+    let canceled = false;
+    void (async () => {
+      await script.source.load();
+      if (!canceled) {
+        setSourceReady(true);
+      }
+    })();
+
+    return () => {
+      canceled = true;
+    };
+  }, [script]);
+
+  if (!script || !sourceReady) {
+    return <Loading />;
+  }
+
+  return (
+    <div className='flex flex-col min-h-[80vh] w-document-max-width'>
+      <ScriptContainer role='article' subject={script} attendableId='story-script' />
+    </div>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/containers/ScriptContainer',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column', classNames: 'w-document-max-width' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          config: new Config({
+            runtime: {
+              services: SERVICES_CONFIG.REMOTE,
+            },
+          }),
+          types: [Script.Script, Operation.PersistentOperation, Blueprint.Blueprint, Text.Text],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+              const [space] = client.spaces.get();
+              yield* Effect.promise(() => space.waitUntilReady());
+
+              createScript(space);
+            }),
+        }),
+        StorybookPlugin({}),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<DefaultStoryProps>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/ScriptContainer/ScriptContainer.tsx

@@ -0,0 +1,85 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Script } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { createDocAccessor } from '@dxos/echo-db';
+import { getSpace } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Panel } from '@dxos/react-ui';
+import { createDataExtensions, listener, editorClassNames } from '@dxos/ui-editor';
+
+import { ScriptToolbar, TypescriptEditor, type TypescriptEditorProps } from '#components';
+import { useDeployState, useToolbarState } from '#hooks';
+import { type Settings } from '#types';
+
+export type ScriptEditorProps = AppSurface.ObjectArticleProps<
+  Script.Script,
+  {
+    settings?: Settings.Settings;
+  } & Pick<TypescriptEditorProps, 'env'>
+>;
+
+export const ScriptContainer = ({
+  role,
+  attendableId,
+  subject: script,
+  settings = { editorInputMode: 'vscode' },
+  env,
+}: ScriptEditorProps) => {
+  const identity = useIdentity();
+  const space = getSpace(script);
+  const state = useToolbarState();
+  useDeployState({ script, state });
+
+  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.update(script, (script) => {
+              script.changed = true;
+            });
+          }
+        },
+      }),
+    ];
+  }, [identity, space, script, script.source.target]);
+
+  if (!extensions.length) {
+    return null;
+  }
+
+  return (
+    <Panel.Root role={role}>
+      <Panel.Toolbar asChild>
+        <ScriptToolbar script={script} attendableId={attendableId} state={state} role={role} />
+      </Panel.Toolbar>
+      <Panel.Content asChild>
+        <TypescriptEditor
+          classNames={editorClassNames(role)}
+          id={script.id}
+          env={env}
+          initialValue={script.source?.target?.content}
+          extensions={extensions}
+          inputMode={settings.editorInputMode}
+          toolbar
+        />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/ScriptContainer/index.ts

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

package/src/containers/ScriptProperties/BlueprintEditor.tsx

@@ -0,0 +1,101 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useState } from 'react';
+
+import { ToolId } from '@dxos/ai';
+import { Blueprint, Template } from '@dxos/compute';
+import { type Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { Filter, Obj, Ref } from '@dxos/echo';
+import { useQuery } from '@dxos/react-client/echo';
+import { Button, Input, useAsyncEffect, useTranslation } from '@dxos/react-ui';
+import { Form } from '@dxos/react-ui-form';
+import { kebabize } from '@dxos/util';
+
+import { meta } from '#meta';
+
+export type BlueprintEditorProps = { object: Script.Script };
+
+export const BlueprintEditor = ({ object }: BlueprintEditorProps) => {
+  const { t } = useTranslation(meta.id);
+  const db = Obj.getDatabase(object);
+  const [fn] = useQuery(db, Filter.type(Operation.PersistentOperation, { source: Ref.make(object) }));
+  const blueprints = useQuery(db, Filter.type(Blueprint.Blueprint));
+
+  const [creating, setCreating] = useState(false);
+  // TODO(burdon): Remove?
+  const [instructions, setInstructions] = useState<string>(`You can run the script "${object.name ?? 'script'}".`);
+  const blueprintKey = `org.dxos.blueprint.${kebabize(object.name ?? 'script')}`;
+  const existingBlueprint = blueprints.find((bp) => bp.key === blueprintKey);
+
+  useAsyncEffect(async () => {
+    if (!existingBlueprint) {
+      return;
+    }
+
+    const source = await existingBlueprint.instructions.source.load();
+    setInstructions(source.content ?? '');
+  }, [existingBlueprint]);
+
+  const handleSave = useCallback(async () => {
+    if (!db) {
+      return;
+    }
+
+    setCreating(true);
+    try {
+      if (existingBlueprint) {
+        const text = await existingBlueprint.instructions.source.load();
+        Obj.update(text, (text) => {
+          text.content = instructions;
+        });
+
+        if (fn?.key) {
+          const toolId = ToolId.make(fn.key);
+          if (!existingBlueprint.tools?.includes(toolId)) {
+            Obj.update(existingBlueprint, (existingBlueprint) => {
+              existingBlueprint.tools = [...(existingBlueprint.tools ?? []), toolId];
+            });
+          }
+        }
+      } else if (fn?.key) {
+        db.add(
+          Blueprint.make({
+            key: blueprintKey,
+            name: object.name ?? 'Script',
+            instructions: Template.make({ source: instructions }),
+            tools: [ToolId.make(fn.key)],
+          }),
+        );
+      }
+      await db.flush();
+    } finally {
+      setCreating(false);
+    }
+  }, [db, existingBlueprint, fn, blueprintKey, object.name, instructions]);
+
+  return (
+    <div className='flex flex-col'>
+      <Form.Section label={t('blueprint-editor.label')} description={t('blueprint-editor.description')} />
+
+      <Input.Root>
+        <Input.Label>{t('blueprint-instructions.label')}</Input.Label>
+        <Input.TextArea
+          placeholder={t('blueprint-instructions.placeholder')}
+          rows={6}
+          value={instructions}
+          onChange={(event) => setInstructions(event.target.value)}
+          classNames='resize-y'
+        />
+      </Input.Root>
+
+      <div className='pt-2'>
+        <Button disabled={(!existingBlueprint && !fn?.key) || creating} onClick={handleSave}>
+          {t(existingBlueprint ? 'update-blueprint.label' : 'create-blueprint.label')}
+        </Button>
+      </div>
+    </div>
+  );
+};

package/src/containers/ScriptProperties/FunctionBinding.tsx

@@ -0,0 +1,83 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { type ChangeEvent, useCallback } from 'react';
+
+import { type Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { Filter, Obj, Ref } from '@dxos/echo';
+import { getUserFunctionIdInMetadata } from '@dxos/functions';
+import { getInvocationUrl } from '@dxos/functions-runtime';
+import { useClient } from '@dxos/react-client';
+import { useQuery } from '@dxos/react-client/echo';
+import { Clipboard, Input, useControlledState, useTranslation } from '@dxos/react-ui';
+import { Form } from '@dxos/react-ui-form';
+
+import { meta } from '#meta';
+
+export type FunctionBindingProps = { object: Script.Script };
+
+export const FunctionBinding = ({ object }: FunctionBindingProps) => {
+  const { t } = useTranslation(meta.id);
+  const client = useClient();
+  const db = Obj.getDatabase(object);
+
+  const [fn] = useQuery(db, Filter.type(Operation.PersistentOperation, { source: Ref.make(object) }));
+  const functionId = fn && getUserFunctionIdInMetadata(Obj.getMeta(fn));
+  const functionUrl =
+    functionId &&
+    getInvocationUrl(functionId, client.config.values.runtime?.services?.edge?.url ?? '', {
+      spaceId: db?.spaceId,
+    });
+
+  const [binding, setBinding] = useControlledState(fn?.binding ?? '');
+  const handleBindingChange = useCallback(
+    (event: ChangeEvent<HTMLInputElement>) => setBinding(event.target.value),
+    [setBinding],
+  );
+
+  const handleBindingBlur = useCallback(() => {
+    if (fn) {
+      Obj.update(fn, (fn) => {
+        fn.binding = binding;
+      });
+    }
+  }, [fn, binding]);
+
+  if (!fn) {
+    return null;
+  }
+
+  return (
+    <div className='flex flex-col'>
+      <Form.Section label={t('remote-function-settings.heading')} />
+
+      {functionUrl && (
+        <Input.Root>
+          <Input.Label>{t('function-url.label')}</Input.Label>
+          <Input.TextInput
+            disabled
+            value={functionUrl}
+            onChange={(event) => {
+              Obj.update(fn, (fn) => {
+                fn.name = event.target.value;
+              });
+            }}
+          />
+          <Clipboard.IconButton value={functionUrl} />
+        </Input.Root>
+      )}
+
+      <Input.Root>
+        <Input.Label>{t('function-binding.label')}</Input.Label>
+        <Input.TextInput
+          placeholder={t('function-binding.placeholder')}
+          value={binding}
+          onChange={handleBindingChange}
+          onBlur={handleBindingBlur}
+        />
+      </Input.Root>
+    </div>
+  );
+};

package/src/containers/ScriptProperties/FunctionPublishing.tsx

@@ -0,0 +1,121 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Octokit } from '@octokit/core';
+import React, { useCallback, useState } from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { SettingsOperation } from '@dxos/app-toolkit';
+import { type Script } from '@dxos/compute';
+import { Filter, Obj } from '@dxos/echo';
+import { log } from '@dxos/log';
+import { useQuery } from '@dxos/react-client/echo';
+import { Button, Clipboard, Message, useAsyncEffect, useTranslation } from '@dxos/react-ui';
+import { Form } from '@dxos/react-ui-form';
+import { AccessToken } from '@dxos/types';
+import { kebabize } from '@dxos/util';
+
+import { meta } from '#meta';
+
+export type FunctionPublishingProps = { object: Script.Script };
+
+// TODO(burdon): Move to separate tab?
+export const FunctionPublishing = ({ object }: FunctionPublishingProps) => {
+  const { t } = useTranslation(meta.id);
+  const { invokePromise } = useOperationInvoker();
+  const db = Obj.getDatabase(object);
+
+  const [githubToken] = useQuery(db, Filter.type(AccessToken.AccessToken, { source: 'github.com' }));
+  const gistKey = Obj.getMeta(object).keys.find(({ source }) => source === 'github.com');
+  const [gistUrl, setGistUrl] = useState<string | undefined>();
+
+  useAsyncEffect(async () => {
+    const token = githubToken?.token;
+    const gistId = gistKey?.id;
+    if (!token || !gistId) {
+      setGistUrl(undefined);
+      return;
+    }
+
+    try {
+      const octokit = new Octokit({ auth: githubToken.token });
+      const response = await octokit.request('GET /gists/{gist_id}', {
+        gist_id: gistId,
+      });
+      setGistUrl(response.data.html_url);
+    } catch (err) {
+      log.catch(err);
+      setGistUrl(undefined);
+    }
+  }, [githubToken, gistKey]);
+
+  const handleOpenTokenManager = useCallback(
+    () =>
+      invokePromise(SettingsOperation.Open, {
+        plugin: 'org.dxos.plugin.token-manager',
+      }),
+    [invokePromise],
+  );
+
+  const [publishing, setPublishing] = useState(false);
+  const handlePublish = useCallback(async () => {
+    setPublishing(true);
+    const octokit = new Octokit({ auth: githubToken.token });
+    const source = await object.source.load();
+    const filename = object.name ? kebabize(object.name) : 'composer-script';
+    const files = { [`${filename}.ts`]: { content: source.content } };
+
+    try {
+      // TODO(wittjosiah): Factor out to intent.
+      const meta = Obj.getMeta(object);
+      const githubKey = meta.keys.find(({ source }) => source === 'github.com');
+      const gistId = githubKey?.id;
+      if (gistId) {
+        await octokit.request('PATCH /gists/{gist_id}', {
+          gist_id: gistId,
+          files,
+        });
+      } else {
+        const response = await octokit.request('POST /gists', {
+          public: true,
+          files,
+        });
+        const gistId = response.data.id;
+        if (gistId) {
+          Obj.update(object, (object) => {
+            Obj.getMeta(object).keys.push({ source: 'github.com', id: gistId });
+          });
+        }
+      }
+    } finally {
+      setPublishing(false);
+    }
+  }, [object, githubToken]);
+
+  return (
+    <div className='flex flex-col'>
+      <Form.Section label={t('script-publish-settings.label')} description={t('script-publish-settings.description')} />
+
+      {!githubToken && (
+        <div className='flex flex-col py-form-gap'>
+          <Message.Root valence='info'>
+            <Message.Title>{t('no-github-token.label')}</Message.Title>
+          </Message.Root>
+          <div className='flex pt-form-gap'>
+            <Button onClick={handleOpenTokenManager}>{t('open-token-manager.label')}</Button>
+          </div>
+        </div>
+      )}
+
+      {githubToken && (
+        <div className='flex justify-end gap-2'>
+          {gistUrl && <Clipboard.IconButton value={gistUrl} />}
+          <Button disabled={publishing} onClick={handlePublish}>
+            {t('publish.label')}
+          </Button>
+        </div>
+      )}
+    </div>
+  );
+};

package/src/containers/ScriptProperties/ScriptProperties.stories.tsx

@@ -0,0 +1,75 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Blueprint } from '@dxos/compute';
+import { Script } from '@dxos/compute';
+import { Operation } from '@dxos/compute';
+import { ClientPlugin } from '@dxos/plugin-client/plugin';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { Filter, useQuery, useSpaces } from '@dxos/react-client/echo';
+import { ObjectProperties } from '@dxos/react-ui-form';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Text } from '@dxos/schema';
+
+import { createScript } from '#testing';
+import { translations } from '#translations';
+
+import { ScriptProperties } from './ScriptProperties';
+
+type DefaultStoryProps = {};
+
+const DefaultStory = (_: DefaultStoryProps) => {
+  const [space] = useSpaces();
+  const [script] = useQuery(space?.db, Filter.type(Script.Script));
+  if (!script) {
+    return <Loading />;
+  }
+
+  return (
+    <ObjectProperties object={script}>
+      <ScriptProperties role='object-properties' subject={script} />
+    </ObjectProperties>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-script/containers/ScriptProperties',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        ClientPlugin({
+          types: [Script.Script, Operation.PersistentOperation, Blueprint.Blueprint, Text.Text],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+              const [space] = client.spaces.get();
+              yield* Effect.promise(() => space.waitUntilReady());
+              createScript(space);
+            }),
+        }),
+        StorybookPlugin({}),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<DefaultStoryProps>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/ScriptProperties/ScriptProperties.tsx

@@ -0,0 +1,24 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Script } from '@dxos/compute';
+
+import { BlueprintEditor } from './BlueprintEditor';
+import { FunctionBinding } from './FunctionBinding';
+import { FunctionPublishing } from './FunctionPublishing';
+
+export type ScriptPropertiesProps = AppSurface.ObjectPropertiesProps<Script.Script>;
+
+export const ScriptProperties = ({ subject: object }: ScriptPropertiesProps) => {
+  return (
+    <div className='flex flex-col py-form-gap gap-form-section-gap'>
+      <FunctionBinding object={object} />
+      <BlueprintEditor object={object} />
+      <FunctionPublishing object={object} />
+    </div>
+  );
+};

package/src/containers/ScriptProperties/index.ts

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

package/src/containers/TestContainer/TestContainer.tsx

@@ -0,0 +1,44 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback, useMemo } from 'react';
+
+import { type Script } from '@dxos/compute';
+import { Context } from '@dxos/context';
+import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
+import { getSpace } from '@dxos/react-client/echo';
+import { Panel } from '@dxos/react-ui';
+
+import { TestPanel } from '#components';
+import { useDeployDeps } from '#hooks';
+
+export type TestContainerProps = {
+  role: string;
+  script: Script.Script;
+};
+
+export const TestContainer = ({ role, script }: TestContainerProps) => {
+  const { client, fn, existingFunctionId } = useDeployDeps({ script });
+  const space = getSpace(script);
+
+  const functionsClient = useMemo(() => FunctionsServiceClient.fromClient(client), [client]);
+
+  const handleInvoke = useCallback(
+    async (input: unknown) => {
+      if (!fn) {
+        throw new Error('Function not deployed');
+      }
+      return functionsClient.invoke(Context.default(), fn, input, { spaceId: space?.id });
+    },
+    [fn, functionsClient, space?.id],
+  );
+
+  return (
+    <Panel.Root role={role} className='dx-document'>
+      <Panel.Content asChild>
+        <TestPanel onInvoke={existingFunctionId ? handleInvoke : undefined} />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/TestContainer/index.ts

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

package/src/containers/index.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const DeploymentDialog: ComponentType<any> = lazy(() => import('./DeploymentDialog'));
+export const NotebookContainer: ComponentType<any> = lazy(() => import('./NotebookContainer'));
+export const ScriptContainer: ComponentType<any> = lazy(() => import('./ScriptContainer'));
+export const ScriptProperties: ComponentType<any> = lazy(() => import('./ScriptProperties'));
+export const TestContainer: ComponentType<any> = lazy(() => import('./TestContainer'));