@dxos/plugin-script 0.8.4-main.70d3990 → 0.8.4-main.7996785055

package/src/capabilities/react-surface.tsx

@@ -1,103 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-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 { 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 AccessToken } from '@dxos/types';
-
-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: 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<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: 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: 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: 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: Script.Script } =>
-        Obj.instanceOf(Script.Script, data.companionTo) && data.subject === 'logs',
-      component: ({ data }) => {
-        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: AccessToken.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.tsx

@@ -1,123 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useEffect, useMemo } from 'react';
-
-import { LayoutAction, createIntent } from '@dxos/app-framework';
-import { useIntentDispatcher } from '@dxos/app-framework/react';
-import { getSpace } from '@dxos/react-client/echo';
-import { Button, Dialog, IconButton, useTranslation } from '@dxos/react-ui';
-import { type AccessToken } from '@dxos/types';
-
-import { useCreateAndDeployScriptTemplates } from '../../hooks';
-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: AccessToken.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>
-          <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>
-        <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/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/ScriptContainer.tsx

@@ -1,70 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { createDocAccessor } from '@dxos/echo-db';
-import { type Script } from '@dxos/functions';
-import { 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: Script.Script;
-  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']),
-              messenger: 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 Script } 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: Script.Script;
-};
-
-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/templates/chess.ts

@@ -1,49 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// @ts-ignore
-import { S, defineFunction } from 'dxos:functions';
-// @ts-ignore
-import { Chess } from 'https://esm.sh/chess.js@0.13.1?bundle=false';
-
-export default defineFunction({
-  key: 'dxos.org/script/chess',
-  name: 'Chess',
-  description: 'Plays a random move in a chess game.',
-
-  inputSchema: S.Struct({
-    changedObjectId: S.String.annotations({
-      description: 'The objects to play the game on.',
-    }),
-    player: S.optional(S.Literal('w', 'b')).annotations({
-      description: 'The player to play the game as.',
-    }),
-  }),
-
-  outputSchema: S.Struct({
-    state: S.String.annotations({
-      description: 'The state of the game as an ASCII art board.',
-    }),
-  }),
-
-  handler: async ({ data: { changedObjectId, player = 'b' }, context: { space } }: any) => {
-    const { pgn } = await space.db.query({ id: changedObjectId }).first();
-    const game = new Chess();
-    game.load_pgn(pgn);
-    if (game.turn() !== player) {
-      return new Response('Invalid turn', { status: 409 });
-    }
-
-    const moves = game.moves();
-    const move = moves[Math.floor(Math.random() * moves.length)];
-    if (!move) {
-      return new Response('No legal moves', { status: 406 });
-    }
-
-    game.move(move);
-    const newPgn = game.pgn();
-    await space.db.update({ id: changedObjectId }, { pgn: newPgn, fen: game.fen() });
-    return { state: game.ascii() };
-  },
-});

package/src/types/actions.ts

@@ -1,53 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { SpaceSchema } from '@dxos/client/echo';
-import { Script } from '@dxos/functions';
-
-import { meta } from '../meta';
-import { templates } from '../templates';
-
-import * as Notebook from './Notebook';
-
-export namespace ScriptAction {
-  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 class CreateScript extends Schema.TaggedClass<CreateScript>()(`${meta.id}/action/create-script`, {
-    input: Schema.extend(
-      ScriptProps,
-      Schema.Struct({
-        space: SpaceSchema,
-      }),
-    ),
-    output: Schema.Struct({
-      object: Script.Script,
-    }),
-  }) {}
-
-  export const NotebookProps = Schema.Struct({
-    name: Schema.optional(Schema.String),
-  });
-
-  export class CreateNotebook extends Schema.TaggedClass<CreateNotebook>()(`${meta.id}/action/create-notebook`, {
-    input: Schema.extend(
-      NotebookProps,
-      Schema.Struct({
-        space: SpaceSchema,
-      }),
-    ),
-    output: Schema.Struct({
-      object: Notebook.Notebook,
-    }),
-  }) {}
-}