@dxos/plugin-script 0.8.4-main.c4373fc → 0.8.4-main.d9fc60f731

package/src/components/Settings/ScriptObjectSettings.tsx

@@ -1,286 +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 { SettingsAction, createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { Blueprint, Template } from '@dxos/blueprints';
-import { FunctionType, type ScriptType, getInvocationUrl, getUserFunctionIdInMetadata } from '@dxos/functions';
-import { log } from '@dxos/log';
-import { useClient } from '@dxos/react-client';
-import { Filter, Ref, getMeta, getSpace, useQuery } from '@dxos/react-client/echo';
-import { Button, Clipboard, Input, useAsyncEffect, useControlledState, useTranslation } from '@dxos/react-ui';
-import { DataType } from '@dxos/schema';
-import { kebabize } from '@dxos/util';
-
-import { meta } from '../../meta';
-
-export type ScriptObjectSettingsProps = {
-  object: ScriptType;
-};
-
-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) => {
-          object.description = event.target.value;
-        }}
-      />
-    </Input.Root>
-  );
-};
-
-const BlueprintEditor = ({ object }: ScriptObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const space = getSpace(object);
-  const [fn] = useQuery(space, Filter.type(FunctionType, { source: Ref.make(object) }));
-  const blueprints = useQuery(space, 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 (!space) {
-      return;
-    }
-
-    setCreating(true);
-    try {
-      if (existingBlueprint) {
-        const text = await existingBlueprint.instructions.source.load();
-        text.content = instructions;
-        if (fn?.key) {
-          const toolId = ToolId.make(fn.key);
-          if (!existingBlueprint.tools?.includes(toolId)) {
-            existingBlueprint.tools = [...(existingBlueprint.tools ?? []), toolId];
-          }
-        }
-      } else if (fn?.key) {
-        space.db.add(
-          Blueprint.make({
-            key: blueprintKey,
-            name: object.name ?? 'Script',
-            instructions: Template.make({
-              source: instructions,
-            }),
-            tools: [ToolId.make(fn.key)],
-          }),
-        );
-      }
-      await space.db.flush();
-    } finally {
-      setCreating(false);
-    }
-  }, [space, 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 space = getSpace(object);
-  const [fn] = useQuery(space, Filter.type(FunctionType, { source: Ref.make(object) }));
-
-  const functionId = fn && getUserFunctionIdInMetadata(getMeta(fn));
-  const functionUrl =
-    functionId &&
-    getInvocationUrl(functionId, 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(meta.id);
-  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>();
-
-  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(
-    () => 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>
-  );
-};

package/src/components/Settings/ScriptPluginSettings.tsx

@@ -1,61 +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 { type EditorInputMode, EditorInputModes } from '@dxos/react-ui-editor';
-import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
-
-import { meta } from '../../meta';
-import { type ScriptSettings } from '../../types';
-import { getAccessCredential } from '../../util';
-
-export const ScriptPluginSettings = ({ settings }: { settings: ScriptSettings }) => {
-  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 (
-    <ControlPage>
-      <ControlSection title={t('settings title', { ns: meta.id })}>
-        <ControlGroup>
-          {/* TODO(wittjosiah): Hide outside of dev environments. */}
-          <ControlItemInput title={t('authenticate action label')}>
-            <Button onClick={handleAuthenticate}>{t('authenticate button label')}</Button>
-          </ControlItemInput>
-
-          <ControlItemInput title={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.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
-        </ControlGroup>
-      </ControlSection>
-    </ControlPage>
-  );
-};

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 ScriptType } 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: ScriptType;
-};
-
-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/notebook/notebook.test.ts

@@ -1,38 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, expect, test } from 'vitest';
-
-import { createNotebook } from '../testing';
-
-import { ComputeGraph } from './notebook';
-
-// TODO(burdon): Create test where one cell could be a AI prompt that references other cells.
-// TODO(burdon): UI cells: Value, Query, TS Expression, Prompt (show input and output).
-
-describe('notebook', () => {
-  test('parse dependency graph', () => {
-    const notebook = createNotebook();
-    const computer = new ComputeGraph(notebook);
-    const result = computer.parse();
-
-    const getId = (i: number) => notebook.cells[i].id;
-
-    // Check dependencies.
-    expect(result.dependencyGraph).toMatchObject({
-      [getId(0)]: [getId(1), getId(2)],
-      [getId(3)]: [getId(1)],
-      [getId(4)]: [getId(0), getId(3)],
-    });
-
-    // Compute values.
-    const values = computer.evaluate();
-    expect(values).toEqual({
-      [getId(0)]: 300,
-      [getId(2)]: 200,
-      [getId(3)]: 200,
-      [getId(4)]: 500,
-    });
-  });
-});

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,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/templates/echo.ts

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

package/src/testing/data.ts

@@ -1,37 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Ref } from '@dxos/echo';
-import { createObject } from '@dxos/echo-db';
-import { PublicKey } from '@dxos/keys';
-import { DataType } from '@dxos/schema';
-
-import { Notebook } from '../types';
-
-// NOTE: createObject(DataType.makeText is required to make codemirror work.
-export const createNotebook = () =>
-  Notebook.make({
-    cells: [
-      {
-        id: PublicKey.random().toString(),
-        script: Ref.make(createObject(DataType.makeText(['c = a() + b', '', ''].join('\n')))),
-      },
-      {
-        id: PublicKey.random().toString(),
-        script: Ref.make(createObject(DataType.makeText(['a = () => 100', ''].join('\n')))),
-      },
-      {
-        id: PublicKey.random().toString(),
-        script: Ref.make(createObject(DataType.makeText(['b = 200'].join('\n')))),
-      },
-      {
-        id: PublicKey.random().toString(),
-        script: Ref.make(createObject(DataType.makeText(['d = a() * 2'].join('\n')))),
-      },
-      {
-        id: PublicKey.random().toString(),
-        script: Ref.make(createObject(DataType.makeText(['c + d', '', '', ''].join('\n')))),
-      },
-    ],
-  });

package/src/types/actions.ts

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