@dxos/plugin-script 0.8.4-main.1068cf700f → 0.8.4-main.1c7ec43d41

package/src/capabilities/react-surface/react-surface.tsx

@@ -1,119 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import React from 'react';
-
-import { Capabilities, Capability } from '@dxos/app-framework';
-import { Surface, useAtomCapability, useSettingsState } from '@dxos/app-framework/ui';
-import { AppCapabilities } from '@dxos/app-toolkit';
-import { InvocationTraceContainer } from '@dxos/devtools';
-import { Obj } from '@dxos/echo';
-import { Script } from '@dxos/functions';
-import { getSpace } from '@dxos/react-client/echo';
-import { Layout } from '@dxos/react-ui';
-import { type AccessToken } from '@dxos/types';
-
-import {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog,
-  NotebookContainer,
-  ScriptContainer,
-  ScriptObjectSettings,
-  ScriptPluginSettings,
-  ScriptProperties,
-  TestContainer,
-} from '../../components';
-import { useCompiler } from '../../hooks';
-import { meta } from '../../meta';
-import { Notebook, ScriptCapabilities, type ScriptSettings } from '../../types';
-
-export default Capability.makeModule(() =>
-  Effect.succeed(
-    Capability.contributes(Capabilities.ReactSurface, [
-      Surface.create({
-        id: `${meta.id}/plugin-settings`,
-        role: 'article',
-        filter: (data): data is { subject: AppCapabilities.Settings } =>
-          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
-        component: ({ data: { subject } }) => {
-          const { settings, updateSettings } = useSettingsState<ScriptSettings>(subject.atom);
-          return <ScriptPluginSettings settings={settings} onSettingsChange={updateSettings} />;
-        },
-      }),
-      Surface.create({
-        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 = useCompiler();
-          const settings = useAtomCapability(ScriptCapabilities.Settings);
-          // TODO(wittjosiah): Why? The editor should be allow to render even if the environment is not ready.
-          if (!compiler?.environment) {
-            return null;
-          }
-
-          return <ScriptContainer role={role} subject={data.subject} settings={settings} env={compiler?.environment} />;
-        },
-      }),
-      Surface.create({
-        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 = useCompiler();
-          return <NotebookContainer role={role} subject={data.subject} env={compiler?.environment} />;
-        },
-      }),
-      // TODO(burdon): Standardize PluginSettings vs ObjectSettings.
-      // TODO(burdon): Why is ScriptProperties different from ScriptObjectSettings?
-      Surface.create({
-        id: `${meta.id}/companion/base-settings`,
-        role: 'base-object-settings',
-        filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
-        component: ({ data }) => <ScriptProperties object={data.subject} />,
-      }),
-      Surface.create({
-        id: `${meta.id}/companion/settings`,
-        role: 'object-settings',
-        filter: (data): data is { subject: Script.Script } => Obj.instanceOf(Script.Script, data.subject),
-        component: ({ data }) => <ScriptObjectSettings object={data.subject} />,
-      }),
-      Surface.create({
-        id: `${meta.id}/companion/execute`,
-        role: 'article',
-        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} />,
-      }),
-      Surface.create({
-        id: `${meta.id}/companion/logs`,
-        role: 'article',
-        filter: (data): data is { companionTo: Script.Script } =>
-          Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'logs',
-        component: ({ data, role }) => {
-          const space = getSpace(data.companionTo);
-          const queueDxn = space?.properties.invocationTraceQueue?.dxn;
-          return (
-            <Layout.Main role={role}>
-              <InvocationTraceContainer
-                db={space?.db}
-                queueDxn={queueDxn}
-                target={data.companionTo}
-                detailAxis='block'
-              />
-            </Layout.Main>
-          );
-        },
-      }),
-      Surface.create({
-        id: DEPLOYMENT_DIALOG,
-        role: 'dialog',
-        filter: (data): data is { props: { accessToken: AccessToken.AccessToken; scriptTemplates: any } } =>
-          data.component === DEPLOYMENT_DIALOG,
-        component: ({ data }) => <DeploymentDialog {...data.props} />,
-      }),
-    ]),
-  ),
-);

package/src/capabilities/settings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ScriptSettings = Capability.lazy('ScriptSettings', () => import('./settings'));

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/FrameContainer/frame.html

@@ -1,25 +0,0 @@
-<html>
-<head>
-  <script src="https://cdn.tailwindcss.com"></script>
-  <script type="importmap">
-    __IMPORT_MAP__
-  </script>
-
-  <script type="module">
-    import RefreshRuntime from '/@react-refresh';
-    RefreshRuntime.injectIntoGlobalHook(window);
-    window.$RefreshReg$ = () => {};
-    window.$RefreshSig$ = () => (type) => type;
-    window.__vite_plugin_react_preamble_installed__ = true;
-  </script>
-  <script type="module" src="/@vite/client"></script>
-</head>
-<body>
-  <div id="root"></div>
-
-  <!-- Prevent vite from compiling this. -->
-  <script type="module">
-    eval('import("@frame/main")');
-  </script>
-</body>
-</html>

package/src/components/FrameContainer/frame.tsx

@@ -1,51 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-import { createRoot } from 'react-dom/client';
-
-import { ClientProvider } from '@dxos/react-client';
-
-const init = async (f: () => Promise<Record<string, any>>) =>
-  Object.entries(await f()).reduce<Record<string, any>>((map, [key, module]) => {
-    map[key] = module;
-    return map;
-  }, {});
-
-const main = async () => {
-  const { ClientServicesProxy } = await import('@dxos/react-client');
-  const { createIFramePort } = await import('@dxos/rpc-tunnel');
-
-  // @ts-ignore
-  window.__DXOS_SANDBOX_MODULES__ = await init(async () => ({
-    // prettier-ignore
-    'react': await import('react'),
-    'react-dom/client': await import('react-dom/client'),
-    '@dxos/client': await import('@dxos/client'),
-    '@dxos/react-client': await import('@dxos/react-client'),
-    '@dxos/react-client/echo': await import('@dxos/react-client/echo'),
-    '@dxos/plugin-explorer': await import('@dxos/plugin-explorer'),
-  }));
-
-  // eslint-disable-next-line @typescript-eslint/no-implied-eval
-  const Component = Function('React', "return React.lazy(() => import('@frame/bundle'))")(React);
-
-  const services = new ClientServicesProxy(
-    createIFramePort({
-      channel: 'frame',
-      origin: '*',
-    }),
-  );
-
-  // TODO(burdon): Error handling.
-  createRoot(document.getElementById('root')!).render(
-    <div className='flex fixed inset-0'>
-      <ClientProvider services={() => services}>
-        <Component />
-      </ClientProvider>
-    </div>,
-  );
-};
-
-void main();

package/src/components/Settings/ScriptObjectSettings.tsx

@@ -1,309 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Octokit } from '@octokit/core';
-import React, { type ChangeEvent, useCallback, useState } from 'react';
-
-import { ToolId } from '@dxos/ai';
-import { useOperationInvoker } from '@dxos/app-framework/ui';
-import { SettingsOperation } from '@dxos/app-toolkit';
-import { Blueprint, Template } from '@dxos/blueprints';
-import { Filter, Obj, Ref } from '@dxos/echo';
-import { Function, type Script, getUserFunctionIdInMetadata } from '@dxos/functions';
-import { getInvocationUrl } from '@dxos/functions-runtime';
-import { log } from '@dxos/log';
-import { useClient } from '@dxos/react-client';
-import { useQuery } from '@dxos/react-client/echo';
-import { Button, Clipboard, Input, useAsyncEffect, useControlledState, useTranslation } from '@dxos/react-ui';
-import { AccessToken } from '@dxos/types';
-import { kebabize } from '@dxos/util';
-
-import { meta } from '../../meta';
-
-export type ScriptObjectSettingsProps = {
-  object: Script.Script;
-};
-
-export const ScriptObjectSettings = ({ object }: ScriptObjectSettingsProps) => {
-  return (
-    <>
-      <Binding object={object} />
-      <BlueprintEditor object={object} />
-      <Publishing object={object} />
-    </>
-  );
-};
-
-export const ScriptProperties = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  return (
-    <Input.Root>
-      <Input.Label>{t('description label')}</Input.Label>
-      <Input.TextInput
-        placeholder={t('description placeholder')}
-        value={object.description ?? ''}
-        onChange={(event) => {
-          Obj.change(object, (o) => {
-            o.description = event.target.value;
-          });
-        }}
-      />
-    </Input.Root>
-  );
-};
-
-const BlueprintEditor = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const db = Obj.getDatabase(object);
-  const [fn] = useQuery(db, Filter.type(Function.Function, { source: Ref.make(object) }));
-  const blueprints = useQuery(db, Filter.type(Blueprint.Blueprint));
-
-  const [creating, setCreating] = useState(false);
-  const [instructions, setInstructions] = useState<string>(`You can run the script "${object.name ?? 'script'}".`);
-  const blueprintKey = `dxos.org/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.change(text, (t) => {
-          t.content = instructions;
-        });
-        if (fn?.key) {
-          const toolId = ToolId.make(fn.key);
-          if (!existingBlueprint.tools?.includes(toolId)) {
-            Obj.change(existingBlueprint, (b) => {
-              b.tools = [...(b.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 gap-4 mlb-cardSpacingBlock'>
-      <div>
-        <h2>{t('blueprint editor label', { default: 'Blueprint' })}</h2>
-        <p className='text-description text-sm'>
-          {t('blueprint editor description', {
-            default: 'Create a blueprint that exposes this script as a tool.',
-          })}
-        </p>
-      </div>
-      <Input.Root>
-        <div role='none' className='flex flex-col gap-1'>
-          <Input.Label>{t('blueprint instructions label', { default: 'Instructions' })}</Input.Label>
-          <Input.TextArea
-            placeholder={t('blueprint instructions placeholder', {
-              default: 'Describe how this tool should be used.',
-            })}
-            rows={6}
-            value={instructions}
-            onChange={(event) => setInstructions(event.target.value)}
-            classNames='resize-y'
-          />
-        </div>
-      </Input.Root>
-      <div className='flex justify-end gap-2'>
-        <Button disabled={(!existingBlueprint && !fn?.key) || creating} onClick={handleSave}>
-          {t(creating ? 'creating label' : 'create blueprint label', {
-            default: creating ? 'Creating…' : 'Create blueprint',
-          })}
-        </Button>
-      </div>
-    </div>
-  );
-};
-
-const Binding = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const client = useClient();
-  const db = Obj.getDatabase(object);
-  const [fn] = useQuery(db, Filter.type(Function.Function, { 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(() => {
-    Obj.change(fn, (f) => {
-      f.binding = binding;
-    });
-  }, [fn, binding]);
-
-  if (!fn || !functionUrl) {
-    return null;
-  }
-
-  // TODO(burdon): Use form.
-  return (
-    <div role='form' className='flex flex-col gap-2 mlb-cardSpacingBlock'>
-      <h2>{t('remote function settings heading')}</h2>
-      <Input.Root>
-        <div role='none' className='flex flex-col gap-1'>
-          <Input.Label>{t('function url label')}</Input.Label>
-          <div role='none' className='flex gap-1'>
-            <Input.TextInput
-              disabled
-              value={functionUrl}
-              onChange={(event) => {
-                Obj.change(fn, (f) => {
-                  f.name = event.target.value;
-                });
-              }}
-            />
-            <Clipboard.IconButton value={functionUrl} />
-          </div>
-        </div>
-      </Input.Root>
-      <Input.Root>
-        <div role='none' className='flex flex-col gap-1'>
-          <Input.Label>{t('function binding label')}</Input.Label>
-          <Input.TextInput
-            placeholder={t('function binding placeholder')}
-            value={binding}
-            onChange={handleBindingChange}
-            onBlur={handleBindingBlur}
-          />
-        </div>
-      </Input.Root>
-    </div>
-  );
-};
-
-// TODO(burdon): Move to separate tab?
-const Publishing = ({ object }: ScriptObjectSettingsProps) => {
-  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: 'dxos.org/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.change(object, (obj) => {
-            Obj.getMeta(obj).keys.push({ source: 'github.com', id: gistId });
-          });
-        }
-      }
-    } finally {
-      setPublishing(false);
-    }
-  }, [object, githubToken]);
-
-  return (
-    <div className='flex flex-col gap-4 mlb-cardSpacingBlock'>
-      <div>
-        <h2>{t('script publish settings label')}</h2>
-        <p className='text-description text-sm'>{t('script publish settings description')}</p>
-      </div>
-      {!githubToken && (
-        <div className='flex flex-col gap-2'>
-          <span>{t('no github token label')}</span>
-          <Button onClick={handleOpenTokenManager}>{t('open token manager label')}</Button>
-        </div>
-      )}
-      {githubToken && (
-        <div className='flex justify-end gap-2'>
-          {gistUrl && <Clipboard.IconButton value={gistUrl} />}
-          <Button disabled={publishing} onClick={handlePublish}>
-            {t(publishing ? 'publishing label' : 'publish label')}
-          </Button>
-        </div>
-      )}
-    </div>
-  );
-};

package/src/components/Settings/ScriptPluginSettings.tsx

@@ -1,66 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useClient } from '@dxos/react-client';
-import { Button, Select, useTranslation } from '@dxos/react-ui';
-import { Settings } from '@dxos/react-ui-form';
-import { type EditorInputMode, EditorInputModes } from '@dxos/ui-editor';
-
-import { meta } from '../../meta';
-import { type ScriptSettings } from '../../types';
-import { getAccessCredential } from '../../util';
-
-export type ScriptPluginSettingsComponentProps = {
-  settings: ScriptSettings;
-  onSettingsChange: (fn: (current: ScriptSettings) => ScriptSettings) => void;
-};
-
-export const ScriptPluginSettings = ({ settings, onSettingsChange }: ScriptPluginSettingsComponentProps) => {
-  const { t } = useTranslation(meta.id);
-  const client = useClient();
-
-  // TODO(burdon): Check token.
-  const handleAuthenticate = async () => {
-    const { identityKey } = client.halo.identity.get()!;
-    await client.halo.writeCredentials([getAccessCredential(identityKey)]);
-  };
-
-  return (
-    <Settings.Root>
-      <Settings.Section title={t('settings title', { ns: meta.id })}>
-        <Settings.Group>
-          {/* TODO(wittjosiah): Hide outside of dev environments. */}
-          <Settings.ItemInput title={t('authenticate action label')}>
-            <Button onClick={handleAuthenticate}>{t('authenticate button label')}</Button>
-          </Settings.ItemInput>
-
-          <Settings.ItemInput title={t('editor input mode label')}>
-            <Select.Root
-              value={settings.editorInputMode ?? 'default'}
-              onValueChange={(value) => {
-                onSettingsChange((s) => ({ ...s, editorInputMode: value as EditorInputMode }));
-              }}
-            >
-              <Select.TriggerButton placeholder={t('select editor input mode placeholder')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    {EditorInputModes.map((mode) => (
-                      <Select.Option key={mode} value={mode}>
-                        {t(`settings editor input mode ${mode} label`)}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </Settings.ItemInput>
-        </Settings.Group>
-      </Settings.Section>
-    </Settings.Root>
-  );
-};

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 Script } from '@dxos/functions';
-import { Layout } from '@dxos/react-ui';
-
-import { useDeployState, useToolbarState } from '../../hooks';
-
-import { TestPanel } from './TestPanel';
-
-export type TestContainerProps = {
-  role: string;
-  script: Script.Script;
-};
-
-export const TestContainer = ({ role, script }: TestContainerProps) => {
-  const state = useToolbarState();
-  useDeployState({ state, script });
-  return (
-    <Layout.Main role={role}>
-      <TestPanel functionUrl={state.value.functionUrl} />
-    </Layout.Main>
-  );
-};

package/src/types/actions.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Database } from '@dxos/echo';
-import { Script } from '@dxos/functions';
-import { Operation } from '@dxos/operation';
-
-import { meta } from '../meta';
-import { templates } from '../templates';
-
-const SCRIPT_OPERATION = `${meta.id}/operation`;
-
-export namespace ScriptOperation {
-  export const ScriptProps = Schema.Struct({
-    name: Schema.optional(Schema.String),
-    // TODO(wittjosiah): Placeholder annotation?
-    gistUrl: Schema.optional(Schema.String.annotations({ title: 'Import from Gist (url)' })),
-    initialTemplateId: Schema.Literal(...templates.map(({ id }) => id)).pipe(
-      Schema.annotations({ title: 'Template' }),
-      Schema.optional,
-    ),
-  });
-
-  export const NotebookProps = Schema.Struct({
-    name: Schema.optional(Schema.String),
-  });
-
-  export const CreateScript = Operation.make({
-    meta: { key: `${SCRIPT_OPERATION}/create-script`, name: 'Create Script' },
-    schema: {
-      input: Schema.extend(
-        ScriptProps,
-        Schema.Struct({
-          db: Database.Database,
-        }),
-      ),
-      output: Schema.Struct({
-        object: Script.Script,
-      }),
-    },
-  });
-}