@dxos/plugin-script 0.6.11-staging.e6894a4 → 0.6.12-main.15a606f

package/src/components/{DebugPanel.tsx → DebugPanel/DebugPanel.tsx}

@@ -3,15 +3,6 @@
 //
 
 import React, { useEffect, useRef, useState } from 'react';
-// @ts-ignore
-// eslint-disable-next-line no-restricted-imports
-import SyntaxHighlighter from 'react-syntax-highlighter';
-// @ts-ignore
-// eslint-disable-next-line no-restricted-imports
-import styleDark from 'react-syntax-highlighter/dist/esm/styles/hljs/a11y-dark';
-// @ts-ignore
-// eslint-disable-next-line no-restricted-imports
-import styleLight from 'react-syntax-highlighter/dist/esm/styles/hljs/a11y-light';
 
 import { log } from '@dxos/log';
 import {
@@ -22,12 +13,12 @@ import {
   type ThemedClassName,
   Toolbar,
   useControlledValue,
-  useThemeContext,
   useTranslation,
 } from '@dxos/react-ui';
+import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
 import { mx } from '@dxos/react-ui-theme';
 
-import { SCRIPT_PLUGIN } from '../meta';
+import { SCRIPT_PLUGIN } from '../../meta';
 
 type State = 'pending' | 'responding';
 
@@ -56,7 +47,7 @@ export const DebugPanel = ({ classNames, functionUrl, binding: _binding, onBindi
   const [result, setResult] = useState('');
   const [state, setState] = useState<State | null>(null);
 
-  // TODO(burdon): Persistent history (non-space ECHO data?)
+  // TODO(burdon): Persistent history -- at least for session (non-space ECHO data?)
   const [history, setHistory] = useState<Message[]>([]);
 
   const scrollerRef = useRef<HTMLDivElement>(null);
@@ -224,60 +215,62 @@ export const DebugPanel = ({ classNames, functionUrl, binding: _binding, onBindi
   );
 };
 
-const RobotAvatar = () => (
-  <Avatar.Root size={6} variant='circle'>
-    <Avatar.Frame>
-      <Avatar.Icon icon='ph--robot--regular' />
-    </Avatar.Frame>
-  </Avatar.Root>
-);
-
-const MessageItem = ({ classNames, message }: ThemedClassName<{ message: Message }>) => {
-  const { themeMode } = useThemeContext();
-  const { text, data, error } = message;
-  if (error) {
-    return <span className={mx(classNames, 'whitespace-pre text-error')}>{String(error)}</span>;
-  } else if (data) {
-    return (
-      <SyntaxHighlighter
-        language='json'
-        style={themeMode === 'dark' ? styleDark : styleLight}
-        className={mx('w-full text-xs', classNames)}
-      >
-        {JSON.stringify(data, null, 2)}
-      </SyntaxHighlighter>
-    );
-  }
-
-  return <span className={mx(classNames)}>{text || '\u00D8'}</span>;
-};
-
 // TODO(burdon): Replace with thread?
 // TODO(burdon): Button to delete individual messages.
-// TODO(burdon): Button to re-run question.
+// TODO(burdon): Button to edit/re-run question.
 const MessageThread = ({ state, result, history }: { state: State | null; result: string; history: Message[] }) => {
   return (
     <>
       {history.map((message, i) => (
-        <div key={i} className='grid grid-cols-[3rem_1fr]'>
-          <div>{message.type === 'response' && <RobotAvatar />}</div>
-          <div className={mx('flex', message.type === 'request' && 'justify-end')}>
-            <MessageItem
-              classNames={[message.type === 'request' && 'p-1 px-2 rounded-lg bg-hoverSurface']}
-              message={message}
-            />
+        <div key={i} className='grid grid-cols-[3rem_1fr_3rem]'>
+          <div className='p-1'>{message.type === 'response' && <RobotAvatar />}</div>
+          <div className='overflow-auto'>
+            <MessageItem message={message} />
           </div>
         </div>
       ))}
-      <div className='grid grid-cols-[3rem_1fr]'>
-        <div>
-          {(state === 'pending' && <Icon icon='ph--spinner--regular' size={6} classNames='animate-spin-slow' />) ||
-            (result.length > 0 && <RobotAvatar />)}
-        </div>
-        <div>
-          <span>{result}</span>
+      {result?.length > 0 && (
+        <div className='grid grid-cols-[3rem_1fr_3rem]'>
+          <div className='p-1'>
+            {(state === 'pending' && <Icon icon='ph--spinner--regular' size={6} classNames='animate-spin' />) || (
+              <Icon icon='ph--robot--regular' size={6} classNames='animate-[pulse_1s_ease-in-out_infinite]' />
+            )}
+          </div>
+          <div className='overflow-auto'>
+            <MessageItem message={{ type: 'response', text: result }} />
+          </div>
         </div>
-      </div>
+      )}
     </>
   );
 };
+
+const MessageItem = ({ classNames, message }: ThemedClassName<{ message: Message }>) => {
+  const { type, text, data, error } = message;
+  const wrapper = 'p-1 px-2 rounded-lg bg-hoverSurface overflow-auto';
+  return (
+    <div className={mx('flex', type === 'request' ? 'ml-[8rem] justify-end' : 'mr-[8rem]', classNames)}>
+      {error && <div className={mx(wrapper, 'whitespace-pre text-error')}>{String(error)}</div>}
+
+      {text !== undefined && (
+        <div className={mx(wrapper, type === 'request' && 'bg-primary-400 dark:bg-primary-600')}>
+          {text || '\u00D8'}
+        </div>
+      )}
+
+      {data && (
+        <SyntaxHighlighter language='json' className={mx(wrapper, 'px-8 py-2 text-xs')}>
+          {JSON.stringify(data, null, 2)}
+        </SyntaxHighlighter>
+      )}
+    </div>
+  );
+};
+
+const RobotAvatar = () => (
+  <Avatar.Root size={6} variant='circle'>
+    <Avatar.Frame>
+      <Avatar.Icon icon='ph--robot--regular' />
+    </Avatar.Frame>
+  </Avatar.Root>
+);

package/src/components/DebugPanel/index.ts

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

package/src/components/{ScriptBlock/FrameContainer → FrameContainer}/FrameContainer.tsx

@@ -11,7 +11,7 @@ import { baseSurface, mx } from '@dxos/react-ui-theme';
 import { createProtoRpcPeer } from '@dxos/rpc';
 import { createIFramePort } from '@dxos/rpc-tunnel';
 
-import { type BundlerResult } from '../../../bundler';
+import { type BundlerResult } from '../../bundler';
 
 export type FrameContainerProps = {
   containerUrl: string;

package/src/components/ScriptBlock/ScriptBlock.stories.tsx

@@ -9,14 +9,14 @@ import React, { useEffect, useMemo } from 'react';
 import { createSpaceObjectGenerator, TestSchemaType } from '@dxos/echo-generator';
 import { TextType } from '@dxos/plugin-markdown/types';
 import { useClient } from '@dxos/react-client';
-import { create, createDocAccessor, createEchoObject } from '@dxos/react-client/echo';
-import { ClientRepeater } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/storybook-utils';
+import { create, createEchoObject, useSpaces } from '@dxos/react-client/echo';
+import { withClientProvider } from '@dxos/react-client/testing';
+import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-// @ts-ignore
-import mainUrl from './FrameContainer/frame?url';
 import { ScriptBlock } from './ScriptBlock';
 import { ScriptType } from '../../types';
+// @ts-ignore
+import mainUrl from '../FrameContainer/frame?url';
 
 const code = [
   "import { Filter, useQuery, useSpaces} from '@dxos/react-client/echo';",
@@ -32,33 +32,41 @@ const code = [
 
 const Story = () => {
   const client = useClient();
-  // TODO(dmaretskyi): Review what's the right way to create automerge-backed objects.
+  const spaces = useSpaces();
+  console.log(spaces.length);
+
+  useEffect(() => {
+    try {
+      // TODO(burdon): Default not set.
+      const generator = createSpaceObjectGenerator(client.spaces.default);
+      generator.addSchemas();
+      void generator
+        .createObjects({
+          [TestSchemaType.organization]: 20,
+          [TestSchemaType.contact]: 50,
+        })
+        .catch();
+    } catch (err) {
+      console.log(err);
+    }
+  }, [client]);
+
+  // TODO(burdon): Review what's the right way to create automerge-backed objects.
   const object = useMemo(
     () => createEchoObject(create(ScriptType, { source: create(TextType, { content: code }) })),
-    [code],
+    [],
   );
-  const accessor = useMemo(() => createDocAccessor(object, ['content']), [object]);
-  useEffect(() => {
-    const generator = createSpaceObjectGenerator(client.spaces.default);
-    generator.addSchemas();
-    void generator.createObjects({ [TestSchemaType.organization]: 20, [TestSchemaType.contact]: 50 }).catch();
-  }, []);
 
   // TODO(dmaretskyi): Not sure how to provide `containerUrl` here since the html now lives in composer-app.
   // TODO(burdon): Normalize html/frame.tsx with composer-app to test locally.
-  return (
-    <div className={'flex fixed inset-0'}>{accessor && <ScriptBlock script={object} containerUrl={mainUrl} />}</div>
-  );
+  return <ScriptBlock script={object} containerUrl={mainUrl} />;
 };
 
 export default {
   title: 'plugin-script/ScriptBlock',
   component: ScriptBlock,
-  render: () => <ClientRepeater component={Story} createSpace />,
-  decorators: [withTheme],
-  parameters: {
-    layout: 'fullscreen',
-  },
+  decorators: [withClientProvider({ createSpace: true }), withTheme, withLayout({ fullscreen: true, tooltips: true })],
+  render: Story,
 };
 
 export const Default = {};

package/src/components/ScriptBlock/ScriptBlock.tsx

@@ -2,19 +2,17 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Check, Play, Warning } from '@phosphor-icons/react';
 // @ts-ignore
 import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 
 import { createDocAccessor, DocAccessor } from '@dxos/react-client/echo';
-import { DensityProvider, Toolbar, Button } from '@dxos/react-ui';
-import { mx, getSize } from '@dxos/react-ui-theme';
+import { DensityProvider, Toolbar, Button, Icon } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
 
-import { FrameContainer } from './FrameContainer';
-import { Splitter, SplitterSelector, type View } from './Splitter';
 import { Bundler, type BundlerResult, initializeBundler } from '../../bundler';
 import { type ScriptType } from '../../types';
+import { FrameContainer } from '../FrameContainer';
 import { ScriptEditor } from '../ScriptEditor';
 
 // Keep in sync with packages/apps/composer-app/script-frame/main.tsx .
@@ -29,7 +27,6 @@ const PROVIDED_MODULES = [
 
 export type ScriptBlockProps = {
   script: ScriptType;
-  view?: View;
   hideSelector?: boolean;
   classes?: {
     root?: string;
@@ -44,17 +41,8 @@ export type ScriptBlockProps = {
  * @deprecated
  */
 // TODO(burdon): Cache compiled results in context.
-export const ScriptBlock = ({
-  script,
-  view: controlledView,
-  hideSelector,
-  classes,
-  containerUrl,
-}: ScriptBlockProps) => {
+export const ScriptBlock = ({ script, hideSelector, classes, containerUrl }: ScriptBlockProps) => {
   const source = useMemo(() => script.source && createDocAccessor(script.source, ['content']), [script.source]);
-  const [view, setView] = useState<View>(controlledView ?? 'editor');
-  useEffect(() => handleSetView(controlledView ?? 'editor'), [controlledView]);
-
   const [result, setResult] = useState<BundlerResult>();
   const bundler = useMemo(
     () => new Bundler({ platform: 'browser', sandboxedModules: PROVIDED_MODULES, remoteModules: {} }),
@@ -78,16 +66,6 @@ export const ScriptBlock = ({
     return () => clearTimeout(t);
   }, [source]);
 
-  const handleSetView = useCallback(
-    (view: View) => {
-      setView(view);
-      if (!result && view !== 'editor') {
-        void handleExec(false);
-      }
-    },
-    [result],
-  );
-
   const handleExec = useCallback(
     async (auto = true) => {
       if (!source) {
@@ -95,11 +73,8 @@ export const ScriptBlock = ({
       }
       const result = await bundler.bundle(DocAccessor.getValue(source));
       setResult(result);
-      if (auto && view === 'editor') {
-        setView('preview');
-      }
     },
-    [source, view],
+    [source],
   );
 
   return (
@@ -107,29 +82,28 @@ export const ScriptBlock = ({
       {!hideSelector && (
         <DensityProvider density='fine'>
           <Toolbar.Root classNames={mx('mb-2', classes?.toolbar)}>
-            <SplitterSelector view={view} onChange={handleSetView} />
             <div className='grow' />
             {result?.bundle && !result?.error && (
               <div title={String(result.error)}>
-                <Check className={mx(getSize(5), 'text-green-500')} />
+                <Icon icon='ph--check--regular' size={5} classNames='text-green-500' />
               </div>
             )}
             {result?.error && (
               <div title={String(result.error)}>
-                <Warning className={mx(getSize(5), 'text-orange-500')} />
+                <Icon icon='ph--warning--regular' size={5} classNames='text-orange-500' />
               </div>
             )}
             <Button variant='ghost' onClick={() => handleExec()}>
-              <Play className={getSize(5)} />
+              <Icon icon='ph--play--regular' size={5} />
             </Button>
           </Toolbar.Root>
         </DensityProvider>
       )}
 
-      <Splitter view={view}>
+      <div className='flex'>
         <ScriptEditor script={script} />
         {result && <FrameContainer key={script.id} result={result} containerUrl={containerUrl} />}
-      </Splitter>
+      </div>
     </div>
   );
 };

package/src/components/ScriptContainer.tsx

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { fullyQualifiedId } from '@dxos/react-client/echo';
+import { useHasAttention } from '@dxos/react-ui-attention';
+import { mx } from '@dxos/react-ui-theme';
+
+import { ScriptEditor, type ScriptEditorProps } from './ScriptEditor';
+
+const ScriptContainer = ({ script, ...props }: ScriptEditorProps) => {
+  const hasAttention = useHasAttention(fullyQualifiedId(script));
+  return (
+    <div role='none' className={mx('flex row-span-2 w-full overflow-hidden', hasAttention && 'attention-surface')}>
+      <ScriptEditor {...props} script={script} />
+    </div>
+  );
+};
+
+export default ScriptContainer;

package/src/components/ScriptEditor.tsx

@@ -12,12 +12,12 @@ import { log } from '@dxos/log';
 import { useClient } from '@dxos/react-client';
 import { create, createDocAccessor, Filter, getMeta, getSpace, useQuery } from '@dxos/react-client/echo';
 import { useIdentity } from '@dxos/react-client/halo';
-import { useTranslation } from '@dxos/react-ui';
+import { useTranslation, type ThemedClassName } from '@dxos/react-ui';
 import { createDataExtensions, listener } from '@dxos/react-ui-editor';
 import { mx } from '@dxos/react-ui-theme';
 
 import { DebugPanel } from './DebugPanel';
-import { Toolbar } from './Toolbar';
+import { type TemplateSelectProps, Toolbar, type ViewType } from './Toolbar';
 import { TypescriptEditor, type TypescriptEditorProps } from './TypescriptEditor';
 import { Bundler } from '../bundler';
 import {
@@ -25,16 +25,18 @@ import {
   publicKeyToDid,
   setUserFunctionUrlInMetadata,
   uploadWorkerFunction,
+  USERFUNCTIONS_PRESET_META_KEY,
 } from '../edge';
 import { SCRIPT_PLUGIN } from '../meta';
+import { templates } from '../templates';
 import { FunctionType, type ScriptType } from '../types';
 
-export type ScriptEditorProps = {
+export type ScriptEditorProps = ThemedClassName<{
   script: ScriptType;
-  role?: string;
-} & Pick<TypescriptEditorProps, 'env'>;
+}> &
+  Pick<TypescriptEditorProps, 'env'>;
 
-export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
+export const ScriptEditor = ({ classNames, script, env }: ScriptEditorProps) => {
   const { t } = useTranslation(SCRIPT_PLUGIN);
   const client = useClient();
   const identity = useIdentity();
@@ -63,7 +65,7 @@ export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
     [script, script.source, space, identity],
   );
 
-  const [showPanel, setShowPanel] = useState(false);
+  const [view, setView] = useState<ViewType>('editor');
   const initialValue = useMemo(() => script.source?.content, [script.source]);
   const existingFunctionUrl = fn && getUserFunctionUrlInMetadata(getMeta(fn));
   const [error, setError] = useState<string>();
@@ -93,6 +95,22 @@ export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
     }
   }, [script.source]);
 
+  const handleTemplateChange: TemplateSelectProps['onTemplateSelect'] = (id) => {
+    const template = templates.find((template) => template.id === id);
+    if (template) {
+      script.name = template.name;
+      script.source!.content = template.source;
+      const metaKeys = getMeta(script).keys;
+      const oldPresetIndex = metaKeys.findIndex((key) => key.source === USERFUNCTIONS_PRESET_META_KEY);
+      if (oldPresetIndex >= 0) {
+        metaKeys.splice(oldPresetIndex, 1);
+      }
+      if (template.presetId) {
+        metaKeys.push({ source: USERFUNCTIONS_PRESET_META_KEY, id: template.presetId });
+      }
+    }
+  };
+
   const handleDeploy = useCallback(async () => {
     if (!script.source || !identity || !space) {
       return;
@@ -104,11 +122,7 @@ export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
       const existingFunctionId = existingFunctionUrl?.split('/').at(-1);
       const ownerDid = (existingFunctionUrl?.split('/').at(-2) as DID) ?? publicKeyToDid(identity.identityKey);
 
-      const bundler = new Bundler({
-        platform: 'browser',
-        sandboxedModules: [],
-        remoteModules: {},
-      });
+      const bundler = new Bundler({ platform: 'browser', sandboxedModules: [], remoteModules: {} });
       const buildResult = await bundler.bundle(script.source.content);
       if (buildResult.error || !buildResult.bundle) {
         throw buildResult.error;
@@ -124,15 +138,18 @@ export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
       if (result !== 'success' || functionId === undefined || functionVersionNumber === undefined) {
         throw new Error(errorMessage);
       }
+
       log.info('function uploaded', { functionId, functionVersionNumber });
       if (fn) {
         fn.version = functionVersionNumber;
       }
+
       const deployedFunction =
         fn ?? space.db.add(create(FunctionType, { version: functionVersionNumber, source: script }));
       const meta = getMeta(deployedFunction);
-      setUserFunctionUrlInMetadata(meta, `/${ownerDid}/${functionId}`);
       script.changed = false;
+      setUserFunctionUrlInMetadata(meta, `/${ownerDid}/${functionId}`);
+      setView('split');
     } catch (err: any) {
       log.catch(err);
       setError(t('upload failed label'));
@@ -155,33 +172,32 @@ export const ScriptEditor = ({ env, script, role }: ScriptEditorProps) => {
   }, [existingFunctionUrl, space]);
 
   return (
-    <div
-      role='none'
-      className={mx(role === 'article' && 'row-span-2', 'flex flex-col is-full bs-full overflow-hidden')}
-    >
-      <TypescriptEditor
-        id={script.id}
-        env={env}
-        initialValue={initialValue}
-        extensions={extensions}
-        className='flex is-full bs-full overflow-hidden border-b border-separator'
-      />
-
+    <div role='none' className={mx('flex flex-col w-full overflow-hidden divide-y divide-separator', classNames)}>
       <Toolbar
         deployed={Boolean(existingFunctionUrl) && !script.changed}
         functionUrl={functionUrl}
         error={error}
-        showPanel={showPanel}
+        view={view}
+        templates={templates}
         onDeploy={handleDeploy}
         onFormat={handleFormat}
-        onTogglePanel={async () => setShowPanel((showDetails) => !showDetails)}
+        onViewChange={setView}
+        onTemplateSelect={handleTemplateChange}
       />
 
-      {showPanel && (
+      {view !== 'preview' && (
+        <TypescriptEditor
+          id={script.id}
+          env={env}
+          initialValue={initialValue}
+          extensions={extensions}
+          className='flex is-full bs-full overflow-hidden ch-focus-ring-inset-over-all'
+        />
+      )}
+
+      {view !== 'editor' && (
         <DebugPanel functionUrl={functionUrl} binding={fn?.binding} onBindingChange={handleBindingChange} />
       )}
     </div>
   );
 };
-
-export default ScriptEditor;

package/src/components/ScriptSettings/ScriptSettings.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { SettingsValue } from '@dxos/plugin-settings';
+import { type Credential } from '@dxos/protocols/proto/dxos/halo/credentials';
+import { useClient } from '@dxos/react-client';
+import { Button, useTranslation } from '@dxos/react-ui';
+
+import { SCRIPT_PLUGIN } from '../../meta';
+import { type ScriptSettingsProps } from '../../types';
+
+export const ScriptSettings = ({ settings }: { settings: ScriptSettingsProps }) => {
+  const { t } = useTranslation(SCRIPT_PLUGIN);
+  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 (
+    <>
+      <SettingsValue label={t('authenticate action label')}>
+        <Button onClick={handleAuthenticate}>{t('authenticate button label')}</Button>
+      </SettingsValue>
+    </>
+  );
+};

package/src/components/ScriptSettings/index.ts

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

package/src/components/Toolbar/Toolbar.stories.tsx

@@ -0,0 +1,26 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxos-theme';
+
+import { withLayout, withTheme } from '@dxos/storybook-utils';
+
+import { Toolbar } from './Toolbar';
+import { templates } from '../../templates';
+
+export default {
+  title: 'plugin-script/Toolbar',
+  component: Toolbar,
+  decorators: [withTheme, withLayout({ tooltips: true })],
+};
+
+export const Default = {
+  args: {
+    binding: 'example',
+    deployed: true,
+    templates,
+    onFormat: () => console.log('Format'),
+    onTogglePanel: () => {},
+  },
+};