@dxos/plugin-script 0.8.4-main.f9ba587 → 0.8.4-staging.60fe92afc8

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 no-new-func
-  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/FrameContainer/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './FrameContainer';

package/src/components/ScriptContainer.tsx

@@ -1,67 +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, type StackItemContentProps } 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 = Pick<StackItemContentProps, 'role'> & {
-  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());

package/src/components/Settings/ScriptPluginSettings.tsx

@@ -1,71 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { type Credential } from '@dxos/protocols/proto/dxos/halo/credentials';
-import { useClient } from '@dxos/react-client';
-import { Button, Select, useTranslation } from '@dxos/react-ui';
-import { type EditorInputMode, EditorInputModes } from '@dxos/react-ui-editor';
-import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
-
-import { meta } from '../../meta';
-import { type ScriptSettingsProps } from '../../types';
-
-export const ScriptPluginSettings = ({ settings }: { settings: ScriptSettingsProps }) => {
-  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([
-      {
-        issuer: identityKey,
-        issuanceDate: new Date(),
-        subject: {
-          id: identityKey,
-          assertion: {
-            '@type': 'dxos.halo.credentials.ServiceAccess',
-            serverName: 'hub.dxos.network',
-            serverKey: identityKey,
-            identityKey,
-            capabilities: ['composer:beta'],
-          },
-        },
-      } satisfies Credential,
-    ]);
-  };
-
-  return (
-    <DeprecatedFormContainer>
-      {/* TODO(wittjosiah): Hide outside of dev environments. */}
-      <DeprecatedFormInput label={t('authenticate action label')}>
-        <Button onClick={handleAuthenticate}>{t('authenticate button label')}</Button>
-      </DeprecatedFormInput>
-
-      <DeprecatedFormInput label={t('editor input mode label')}>
-        <Select.Root
-          value={settings.editorInputMode ?? 'default'}
-          onValueChange={(value) => {
-            settings.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.Content>
-          </Select.Portal>
-        </Select.Root>
-      </DeprecatedFormInput>
-    </DeprecatedFormContainer>
-  );
-};

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,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { type ScriptType } from '@dxos/functions';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { TestPanel } from './TestPanel';
-import { useDeployState, useToolbarState } from '../../hooks';
-
-export type TestContainerProps = {
-  role: string;
-  script: ScriptType;
-};
-
-export const TestContainer = ({ script, role }: TestContainerProps) => {
-  const state = useToolbarState();
-  useDeployState({ state, script });
-  return (
-    <StackItem.Content role={role}>
-      <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 { SCRIPT_PLUGIN } from './meta';
-
-export namespace ScriptEvents {
-  export const SetupCompiler = defineEvent(`${SCRIPT_PLUGIN}/event/setup-compiler`);
-}

package/src/templates/chat.ts

@@ -1,96 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-// @ts-ignore
-import { transformServerSentEvents } from 'https://esm.sh/@dxos/script-toolbox?bundle=false';
-
-/**
- * Chatbot that answers questions based on the context data.
- */
-export default async ({ data: { bodyText }, context: { space, ai } }: any) => {
-  let parsedRequest: any;
-  try {
-    parsedRequest = JSON.parse(bodyText);
-  } catch (err) {
-    const answer = await ai.run('@cf/meta/llama-3.1-8b-instruct', {
-      stream: true,
-      prompt: `
-     Using only the context data below to answer the user's question.
-     If you cannot answer the question from the provided content, then reply with "I don't know."
-
-     CONTEXT:
-     ${await getContext({ space })}
-
-     QUESTION:
-     ${bodyText}
-    `,
-    });
-    return new Response(transformServerSentEvents(answer));
-  }
-
-  const promptId = parsedRequest.trigger.promptId;
-  const promptObject = await space.crud.query({ id: promptId }).first();
-
-  if (parsedRequest.data.objects.length !== 1) {
-    return new Response('Message batches not supported.');
-  }
-
-  const messageId = parsedRequest.data.objects[0];
-  let message;
-  try {
-    message = await space.crud.query({ id: messageId }).first();
-  } catch (err) {
-    return new Response('Message not replicated yet.', { status: 409 });
-  }
-
-  if (message.text.includes('--------')) {
-    return new Response('Message was already processed.');
-  }
-
-  let prompt = promptObject.template;
-  for (const input of promptObject.inputs) {
-    let value: string | null = null;
-    if (input.type === TemplateInputType.VALUE) {
-      value = String(input.value);
-    } else if (input.type === TemplateInputType.RETRIEVER) {
-      value = await getContext({ space });
-    } else if (input.type === TemplateInputType.PASS_THROUGH) {
-      value = message.text;
-    }
-    if (value) {
-      prompt = prompt.replaceAll(`{${input.name}}`, value);
-    }
-  }
-
-  const answer = await ai.run('@cf/meta/llama-3.1-8b-instruct', {
-    stream: false,
-    prompt,
-  });
-  const response = { response: answer.response, prompt, message };
-  const textWithAnswer = message.text + '\n--------\n\n' + answer.response;
-  await space.crud.update({ id: messageId }, { text: textWithAnswer });
-
-  return new Response(JSON.stringify(response));
-};
-
-const getContext = async ({ space }: any) => {
-  let context = '';
-  const { objects: docs } = await space.crud.query({ __typename: 'dxos.org/type/Document' }).run();
-  for (const doc of docs) {
-    const { content } = await space.crud.query({ id: doc.content }).first();
-    context += content + '\n\n';
-  }
-  return context;
-};
-
-enum TemplateInputType {
-  VALUE = 0,
-  PASS_THROUGH = 1,
-  RETRIEVER = 2,
-  FUNCTION = 3,
-  QUERY = 4,
-  RESOLVER = 5,
-  CONTEXT = 6,
-  SCHEMA = 7,
-}

package/src/templates/chess.ts

@@ -1,47 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// @ts-ignore
-import { defineFunction, S } from 'dxos:functions';
-// @ts-ignore
-import { Chess } from 'https://esm.sh/chess.js@0.13.1?bundle=false';
-
-export default defineFunction({
-  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/templates/echo.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-/**
- * Echos the request data.
- */
-export default async ({ data }: any) => data;

package/src/types.ts

@@ -1,42 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { Schema } from 'effect';
-
-import { SpaceSchema } from '@dxos/client/echo';
-import { ScriptType } from '@dxos/functions';
-import { EditorInputMode } from '@dxos/react-ui-editor';
-
-import { SCRIPT_PLUGIN } from './meta';
-
-// TODO(burdon): Standardize export (e.g., @dxos/plugin-script/meta)?
-export { SCRIPT_PLUGIN };
-
-export namespace ScriptAction {
-  const SCRIPT_ACTION = `${SCRIPT_PLUGIN}/action`;
-
-  export const CreateScriptSchema = Schema.Struct({
-    name: Schema.optional(Schema.String),
-    // TODO(wittjosiah): Placeholder annotation?
-    gistUrl: Schema.optional(Schema.String.annotations({ title: 'Import from Gist (url)' })),
-    initialTemplateId: Schema.optional(Schema.String),
-  });
-
-  export type CreateScriptProps = Schema.Schema.Type<typeof CreateScriptSchema>;
-
-  export class Create extends Schema.TaggedClass<Create>()(`${SCRIPT_ACTION}/create`, {
-    input: Schema.extend(CreateScriptSchema, Schema.Struct({ space: SpaceSchema })),
-    output: Schema.Struct({
-      object: ScriptType,
-    }),
-  }) {}
-}
-
-export const ScriptSettingsSchema = Schema.mutable(
-  Schema.Struct({
-    editorInputMode: EditorInputMode,
-  }),
-);
-
-export type ScriptSettingsProps = Schema.Schema.Type<typeof ScriptSettingsSchema>;