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

package/src/capabilities/compiler.ts

@@ -1,33 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// @ts-ignore
-import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
-
-import { contributes } from '@dxos/app-framework';
-import { initializeBundler } from '@dxos/functions/bundler';
-
-import { ScriptCapabilities } from './capabilities';
-import { Compiler } from '../compiler';
-
-export default async () => {
-  const compiler = new Compiler();
-
-  await compiler.initialize();
-  // TODO(wittjosiah): Fetch types for https modules.
-  compiler.setFile('/src/typings.d.ts', "declare module 'https://*';");
-  // TODO(wittjosiah): Proper function handler types.
-  // TODO(wittjosiah): Remove.
-  compiler.setFile(
-    '/src/runtime.ts',
-    `
-        export const Filter: any = {};
-        export type FunctionHandler = ({ event, context }: { event: any; context: any }) => Promise<Response>;
-        export const functionHandler = (handler: FunctionHandler) => handler;
-      `,
-  );
-  await initializeBundler({ wasmUrl });
-
-  return contributes(ScriptCapabilities.Compiler, compiler);
-};

package/src/capabilities/intent-resolver.ts

@@ -1,80 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Octokit } from '@octokit/core';
-import { Predicate } from 'effect';
-
-import { contributes, Capabilities, createResolver, createIntent, LayoutAction } 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 { ScriptAction } from '../types';
-
-export default () =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: ScriptAction.Create,
-      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(Obj.make(DataType.Text, { content })),
-            }),
-          },
-        };
-      },
-    }),
-    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,89 +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 { ScriptCapabilities } from './capabilities';
-import {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog,
-  ScriptContainer,
-  ScriptPluginSettings,
-  ScriptObjectSettings,
-  ScriptProperties,
-  TestContainer,
-} from '../components';
-import { meta } from '../meta';
-import { type ScriptSettingsProps } from '../types';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/plugin-settings`,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<ScriptSettingsProps> } =>
-        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),
-      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;
-        return <ScriptContainer role={role} script={data.subject} settings={settings} env={compiler.environment} />;
-      },
-    }),
-    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 { ScriptSettingsSchema } from '../types';
-
-export default () => {
-  const settings = live(ScriptSettingsSchema, {
-    editorInputMode: 'vscode',
-  });
-
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: ScriptSettingsSchema,
-    value: settings,
-  });
-};

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

@@ -1,39 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
-import React from 'react';
-
-import { Dialog } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-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) => (
-    <Dialog.Root defaultOpen={true}>
-      <DeploymentDialog {...args} />
-    </Dialog.Root>
-  ),
-};
-
-const meta: Meta = {
-  title: 'plugins/plugin-script/DeploymentDialog',
-  component: DeploymentDialog,
-  parameters: { translations },
-  decorators: [withTheme, withLayout()],
-};
-
-export default meta;

package/src/components/DeploymentDialog/DeploymentDialog.tsx

@@ -1,112 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useEffect, useMemo } from 'react';
-
-import { createIntent, LayoutAction, 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 { SCRIPT_PLUGIN } from '../../meta';
-import { type Template } from '../../templates';
-
-export const DEPLOYMENT_DIALOG = `${SCRIPT_PLUGIN}/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;
-  scriptTemplates: Template[];
-};
-
-export const DeploymentDialog = ({ accessToken, scriptTemplates }: DeploymentDialogProps) => {
-  const { t } = useTranslation(SCRIPT_PLUGIN);
-  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: `${SCRIPT_PLUGIN}/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 }],
-          },
-        }),
-      );
-      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: `${SCRIPT_PLUGIN}/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 },
-            ],
-          },
-        }),
-      );
-    }
-  }, [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 { DeploymentDialog, DEPLOYMENT_DIALOG } from './DeploymentDialog';
-
-export { DEPLOYMENT_DIALOG };
-
-export default DeploymentDialog;

package/src/components/ScriptContainer.tsx

@@ -1,68 +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 { ScriptToolbar } from './ScriptToolbar';
-import { TypescriptEditor, type TypescriptEditorProps } from './TypescriptEditor';
-import { useDeployState, useToolbarState } from '../hooks';
-import { type ScriptSettingsProps } from '../types';
-
-export type ScriptEditorProps = {
-  role: string;
-  script: ScriptType;
-  settings?: ScriptSettingsProps;
-} & 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/ScriptObjectSettings.tsx

@@ -1,206 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Octokit } from '@octokit/core';
-import React, { type ChangeEvent, useCallback, useEffect, useState } from 'react';
-
-import { createIntent, SettingsAction, useIntentDispatcher } from '@dxos/app-framework';
-import { FunctionType, type ScriptType, getInvocationUrl, getUserFunctionUrlInMetadata } from '@dxos/functions';
-import { log } from '@dxos/log';
-import { useClient } from '@dxos/react-client';
-import { Filter, getMeta, getSpace, Ref, useQuery } from '@dxos/react-client/echo';
-import { Button, Clipboard, Input, useControlledState, useTranslation } from '@dxos/react-ui';
-import { DataType } from '@dxos/schema';
-
-import { SCRIPT_PLUGIN } from '../../meta';
-
-export type ScriptObjectSettingsProps = {
-  object: ScriptType;
-};
-
-export const ScriptObjectSettings = ({ object }: ScriptObjectSettingsProps) => {
-  return (
-    <>
-      <Binding object={object} />
-      <Publishing object={object} />
-    </>
-  );
-};
-
-export const ScriptProperties = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(SCRIPT_PLUGIN);
-  return (
-    <Input.Root>
-      <Input.Label>{t('description label')}</Input.Label>
-      <Input.TextInput
-        placeholder={t('description placeholder')}
-        value={object.description ?? ''}
-        onChange={(event) => {
-          object.description = event.target.value;
-        }}
-      />
-    </Input.Root>
-  );
-};
-
-const Binding = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(SCRIPT_PLUGIN);
-  const client = useClient();
-  const space = getSpace(object);
-  const [fn] = useQuery(space, Filter.type(FunctionType, { source: Ref.make(object) }));
-
-  const functionPath = fn && getUserFunctionUrlInMetadata(getMeta(fn));
-  const functionUrl =
-    functionPath &&
-    getInvocationUrl(functionPath, client.config.values.runtime?.services?.edge?.url ?? '', {
-      spaceId: space?.id,
-    });
-
-  const [binding, setBinding] = useControlledState(fn?.binding ?? '');
-  const handleBindingChange = useCallback(
-    (event: ChangeEvent<HTMLInputElement>) => {
-      setBinding(event.target.value);
-    },
-    [setBinding],
-  );
-
-  const handleBindingBlur = useCallback(() => {
-    fn.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) => {
-                fn.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(SCRIPT_PLUGIN);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const space = getSpace(object);
-  const [githubToken] = useQuery(space, Filter.type(DataType.AccessToken, { source: 'github.com' }));
-  const gistKey = getMeta(object).keys.find(({ source }) => source === 'github.com');
-  const [gistUrl, setGistUrl] = useState<string | undefined>();
-
-  useEffect(() => {
-    const token = githubToken?.token;
-    const gistId = gistKey?.id;
-    if (!token || !gistId) {
-      setGistUrl(undefined);
-      return;
-    }
-
-    const timeout = setTimeout(async () => {
-      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);
-      }
-    });
-
-    return () => clearTimeout(timeout);
-  }, [githubToken, gistKey]);
-
-  const handleOpenTokenManager = useCallback(
-    () => dispatch(createIntent(SettingsAction.Open, { plugin: 'dxos.org/plugin/token-manager' })),
-    [],
-  );
-
-  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 = 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,
-        });
-        if (response.data.id) {
-          meta.keys.push({ source: 'github.com', id: response.data.id });
-        }
-      }
-    } 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>
-  );
-};
-
-// TODO(wittjosiah): Factor out.
-// From https://stackoverflow.com/a/67243723/2804332
-const kebabize = (str: string) => str.replace(/[A-Z]+(?![a-z])|[A-Z]/g, ($, ofs) => (ofs ? '-' : '') + $.toLowerCase());