@dxos/plugin-script 0.8.4-main.2e9d522 → 0.8.4-main.548089c

package/src/templates/gmail.ts

@@ -3,20 +3,32 @@
 //
 
 // @ts-ignore
-import { create, defineFunction, EchoObject, Filter, ObjectId, S } from 'dxos:functions';
+import { EchoObject, Filter, ObjectId, S, create, defineFunction } from 'dxos:functions';
 // @ts-ignore
 import {
+  FetchHttpClient,
   HttpClient,
   HttpClientRequest,
-  FetchHttpClient,
   // @ts-ignore
-} from 'https://esm.sh/@effect/platform@0.77.2?deps=effect@3.14.21&bundle=false';
+} from 'https://esm.sh/@effect/platform@0.89.0?deps=effect@3.17.0&bundle=false';
 // @ts-ignore
 import { format, subDays } from 'https://esm.sh/date-fns@3.3.1?bundle=false';
 // @ts-ignore
-import { pipe, Chunk, Effect, Ref, Schedule, Stream } from 'https://esm.sh/effect@3.14.21?bundle=false';
+import * as Chunk from 'https://esm.sh/effect@3.17.0/Chunk?bundle=false';
+// @ts-ignore
+import * as Effect from 'https://esm.sh/effect@3.17.0/Effect?bundle=false';
+// @ts-ignore
+import * as Function from 'https://esm.sh/effect@3.17.0/Function?bundle=false';
+// @ts-ignore
+import * as Ref from 'https://esm.sh/effect@3.17.0/Ref?bundle=false';
+// @ts-ignore
+import * as Schedule from 'https://esm.sh/effect@3.17.0/Schedule?bundle=false';
+// @ts-ignore
+import * as Stream from 'https://esm.sh/effect@3.17.0/Stream?bundle=false';
 
 export default defineFunction({
+  key: 'dxos.org/script/gmail',
+  name: 'Gmail',
   inputSchema: S.Struct({
     mailboxId: S.String,
     userId: S.optional(S.String).pipe(S.withDecodingDefault(() => 'me')),
@@ -41,7 +53,7 @@ export default defineFunction({
 
       // NOTE: Google API bundles size is v. large and caused runtime issues.
       const makeRequest = (url: string) =>
-        pipe(
+        Function.pipe(
           url,
           HttpClientRequest.get,
           HttpClientRequest.setHeaders({ Authorization: `Bearer ${token}`, Accept: 'application/json' }),
@@ -80,7 +92,7 @@ export default defineFunction({
           const messageDetails = yield* getMessage(userId, message.id);
           const created = new Date(parseInt(messageDetails.internalDate)).toISOString();
           const from = messageDetails.payload.headers.find((h: any) => h.name === 'From');
-          const sender = from && parseEmailString(from.value);
+          const sender = from && parseFromHeader(from.value);
           // TODO(wittjosiah): Improve parsing of email contents.
           const content =
             messageDetails.payload.body?.data ??
@@ -98,7 +110,7 @@ export default defineFunction({
             sender,
             blocks: [
               {
-                type: 'text',
+                _tag: 'text',
                 text: Buffer.from(content, 'base64').toString('utf-8'),
               },
             ],
@@ -114,7 +126,7 @@ export default defineFunction({
 
       const queueMessages = yield* Ref.get(newMessages);
       if (queueMessages.length > 0) {
-        yield* pipe(
+        yield* Function.pipe(
           queueMessages,
           Stream.fromIterable,
           Stream.grouped(10),
@@ -145,17 +157,17 @@ const getUrl = (userId: string, messageId?: string, params?: Record<string, any>
 /**
  * Parses an email string in the format "Name <email@example.com>" into separate name and email components.
  */
-const parseEmailString = (emailString: string): { name?: string; email: string } | undefined => {
-  const match = emailString.match(/^([^<]+?)\s*<([^>]+@[^>]+)>$/);
+const parseFromHeader = (value: string): { name?: string; email: string } | undefined => {
+  const EMAIL_REGEX = /^([^<]+?)\s*<([^>]+@[^>]+)>$/;
+  const removeOuterQuotes = (str: string) => str.replace(/^['"]|['"]$/g, '');
+  const match = value.match(EMAIL_REGEX);
   if (match) {
     const [, name, email] = match;
     return {
-      name: name.trim(),
+      name: removeOuterQuotes(name.trim()),
       email: email.trim(),
     };
   }
-
-  return undefined;
 };
 
 //
@@ -163,8 +175,7 @@ const parseEmailString = (emailString: string): { name?: string; email: string }
 // TODO(wittjosiah): These schemas should be imported from @dxos/schema.
 //
 
-const ActorRoles = ['user', 'assistant'] as const;
-const ActorRole = S.Literal(...ActorRoles);
+const ActorRole = S.Literal('user', 'assistant');
 type ActorRole = S.Schema.Type<typeof ActorRole>;
 
 const ActorSchema = S.Struct({
@@ -174,57 +185,16 @@ const ActorSchema = S.Struct({
   role: S.optional(ActorRole),
 });
 
-const AbstractContentBlock = S.Struct({
+const Base = S.Struct({
   pending: S.optional(S.Boolean),
 });
-type AbstractContentBlock = S.Schema.Type<typeof AbstractContentBlock>;
-const TextContentBlock = S.extend(
-  AbstractContentBlock,
-  S.Struct({
-    type: S.Literal('text'),
-    disposition: S.optional(S.String),
-    text: S.String,
-  }),
-).pipe(S.mutable);
-type TextContentBlock = S.Schema.Type<typeof TextContentBlock>;
-const JsonContentBlock = S.extend(
-  AbstractContentBlock,
-  S.Struct({
-    type: S.Literal('json'),
-    disposition: S.optional(S.String),
-    data: S.String,
-  }),
-).pipe(S.mutable);
-type JsonContentBlock = S.Schema.Type<typeof JsonContentBlock>;
-const Base64ImageSource = S.Struct({
-  type: S.Literal('base64'),
-  mediaType: S.String,
-  data: S.String,
+type Base = S.Schema.Type<typeof Base>;
+const Text = S.TaggedStruct('text', {
+  mimeType: S.optional(S.String),
+  text: S.String,
+  ...Base.fields,
 }).pipe(S.mutable);
-const HttpImageSource = S.Struct({
-  type: S.Literal('http'),
-  url: S.String,
-}).pipe(S.mutable);
-const ImageSource = S.Union(Base64ImageSource, HttpImageSource);
-type ImageSource = S.Schema.Type<typeof ImageSource>;
-const ImageContentBlock = S.extend(
-  AbstractContentBlock,
-  S.Struct({
-    type: S.Literal('image'),
-    id: S.optional(S.String),
-    source: S.optional(ImageSource),
-  }),
-).pipe(S.mutable);
-type ImageContentBlock = S.Schema.Type<typeof ImageContentBlock>;
-const ReferenceContentBlock = S.extend(
-  AbstractContentBlock,
-  S.Struct({
-    type: S.Literal('reference'),
-    reference: S.Any,
-  }),
-).pipe(S.mutable);
-type ReferenceContentBlock = S.Schema.Type<typeof ReferenceContentBlock>;
-const MessageContentBlock = S.Union(TextContentBlock, JsonContentBlock, ImageContentBlock, ReferenceContentBlock);
+interface Text extends S.Schema.Type<typeof Text> {}
 
 const MessageType = S.Struct({
   id: ObjectId,
@@ -234,7 +204,7 @@ const MessageType = S.Struct({
   sender: ActorSchema.annotations({
     description: 'Identity of the message sender.',
   }),
-  blocks: S.Array(MessageContentBlock).annotations({
+  blocks: S.Array(Text).annotations({
     description: 'Contents of the message.',
   }),
   properties: S.optional(

package/src/templates/index.ts

@@ -6,11 +6,11 @@ import chat from './chat.ts?raw';
 import chess from './chess.ts?raw';
 import dataGenerator from './data-generator.ts?raw';
 import discord from './discord.ts?raw';
-import echo from './echo.ts?raw';
 import email from './email.ts?raw';
 import forexEffect from './forex-effect.ts?raw';
 import forex from './forex.ts?raw';
 import gmail from './gmail.ts?raw';
+import ping from './ping.ts?raw';
 
 const removeHeader = (str: string) => str.split('\n').slice(4).join('\n');
 
@@ -23,11 +23,11 @@ export type Template = {
   presetId?: string;
 };
 
-export const templates: Template[] = [
+export const templates = [
   {
-    id: 'dxos.org/script/echo',
-    name: 'Echo',
-    source: removeHeader(echo),
+    id: 'dxos.org/script/ping',
+    name: 'Ping',
+    source: removeHeader(ping),
   },
   {
     id: 'dxos.org/script/forex',
@@ -75,4 +75,4 @@ export const templates: Template[] = [
     source: removeHeader(dataGenerator),
     presetId: 'dxos.org/function/data-generator',
   },
-];
+] as const;

package/src/testing/data.ts

@@ -0,0 +1,72 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Prompt } from '@dxos/blueprints';
+import { Ref } from '@dxos/echo';
+import { createObject } from '@dxos/echo-db';
+import { PublicKey } from '@dxos/keys';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { Text } from '@dxos/schema';
+
+import { Notebook } from '../types';
+
+// TODO(burdon): NOTE: createObject is required for tests.
+
+export const createNotebook = (): Notebook.Notebook =>
+  Notebook.make({
+    cells: [
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('c = a() + b'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('a = () => 100'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('b = 200'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('d = a() * 2'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(Text.make('c + d'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Prompt.make({
+              instructions: 'Very briefly, what colors are associated with the numbers {{a}} and {{b}}.',
+            }),
+          ),
+        ),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'query',
+        source: Ref.make(createObject(Text.make(`docs = (type: ${Markdown.Document.typename})`))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'prompt',
+        prompt: Ref.make(
+          createObject(
+            Prompt.make({
+              instructions: 'Very briefly, summarize the documents: {{docs}}',
+            }),
+          ),
+        ),
+      },
+    ],
+  });

package/src/testing/index.ts

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

package/src/translations.ts

@@ -2,15 +2,16 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ScriptType } from '@dxos/functions';
+import { Script } from '@dxos/functions';
 import { type Resource } from '@dxos/react-ui';
 
 import { meta } from './meta';
+import { Notebook } from './types';
 
 export const translations = [
   {
     'en-US': {
-      [ScriptType.typename]: {
+      [Script.Script.typename]: {
         'typename label': 'Script',
         'typename label_zero': 'Scripts',
         'typename label_one': 'Script',
@@ -19,8 +20,18 @@ export const translations = [
         'rename object label': 'Rename script',
         'delete object label': 'Delete script',
       },
+      [Notebook.Notebook.typename]: {
+        'typename label': 'Notebook',
+        'typename label_zero': 'Notebooks',
+        'typename label_one': 'Notebook',
+        'typename label_other': 'Notebooks',
+        'object name placeholder': 'New notebook',
+        'rename object label': 'Rename notebook',
+        'delete object label': 'Delete notebook',
+      },
       [meta.id]: {
         'plugin name': 'Scripts',
+        'settings title': 'Scripts plugin settings',
         'description label': 'Description',
         'description placeholder': 'Enter description',
         'binding placeholder': 'Function name',
@@ -44,25 +55,29 @@ export const translations = [
         'open token manager label': 'Open Token Manager',
         'publish label': 'Publish',
         'publishing label': 'Publishing',
+        'blueprint editor label': 'Blueprint',
+        'blueprint editor description': 'Create a blueprint that exposes this script as a tool.',
+        'blueprint instructions label': 'Instructions',
+        'blueprint instructions placeholder': 'Describe how this tool should be used.',
+        'create blueprint label': 'Create blueprint',
+        'creating label': 'Creating…',
         'editor input mode label': 'Editor input mode',
         'select editor input mode placeholder': 'Select editor input mode…',
         'settings editor input mode default label': 'Default',
         'settings editor input mode vim label': 'Vim',
         'settings editor input mode vscode label': 'VS Code',
-        'template select group label': 'Select template',
         'function panel label': 'Debug Function',
         'script test label': 'Test',
         'script logs label': 'Logs',
+
         'deployment dialog title': 'Default Scripts',
-        'deployment dialog scripts found message_one':
-          'We found the following script template for your new integration:',
-        'deployment dialog scripts found message_other':
-          'We found the following script templates for your new integration:',
+        'deployment dialog scripts found message': 'Script templates:',
         'deployment dialog deploy functions button label_one': 'Create and deploy script',
         'deployment dialog deploy functions button label_other': 'Create and deploy scripts',
         'deployment dialog deploy functions pending button label_one': 'Deploying script',
         'deployment dialog deploy functions pending button label_other': 'Deploying scripts',
         'deployment dialog skip button label': 'Skip',
+
         'script deployment toast label_one': 'Script deployed',
         'script deployment toast label_other': 'Scripts deployed',
         'script deployment toast description_one': 'Your script has been deployed successfully.',
@@ -75,6 +90,17 @@ export const translations = [
         'script deployment error toast description_other': 'There was an error deploying your scripts.',
         'script deployment error toast close label_one': 'Close',
         'script deployment error toast close label_other': 'Close',
+
+        'notebook cell placeholder': 'Enter script',
+        'notebook cell delete label': 'Delete cell',
+        'notebook cell prompt run label': 'Run',
+        'notebook cell insert markdown label': 'Insert Markdown',
+        'notebook cell insert script label': 'Insert Script',
+        'notebook cell insert prompt label': 'Insert Prompt',
+        'notebook cell insert query label': 'Insert Query',
+        'notebook markdown placeholder': 'Enter Markdown',
+        'notebook prompt placeholder': 'Enter prompt',
+        'notebook cell insert label': 'Insert cell',
       },
     },
   },

package/src/types/Notebook.ts

@@ -0,0 +1,41 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Prompt } from '@dxos/blueprints';
+import { Obj, Type } from '@dxos/echo';
+import { FormAnnotation } from '@dxos/echo/internal';
+import { LabelAnnotation } from '@dxos/echo/internal';
+import { Text, View } from '@dxos/schema';
+
+export type CellType = 'markdown' | 'script' | 'query' | 'prompt' | 'view';
+
+const Cell_ = Schema.Struct({
+  id: Schema.String,
+  type: Schema.String,
+  name: Schema.optional(Schema.String),
+  // TODO(burdon): Union type.
+  source: Schema.optional(Type.Ref(Text.Text)),
+  prompt: Schema.optional(Type.Ref(Prompt.Prompt)),
+  view: Schema.optional(Type.Ref(View.View)),
+}).pipe(Schema.mutable);
+export interface Cell extends Schema.Schema.Type<typeof Cell_> {}
+export interface Cell_Encoded extends Schema.Schema.Encoded<typeof Cell_> {}
+export const Cell: Schema.Schema<Cell, Cell_Encoded> = Cell_;
+
+export const Notebook = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+  cells: Cell.pipe(Schema.Array, Schema.mutable, FormAnnotation.set(false)),
+}).pipe(
+  Type.Obj({
+    typename: 'dxos.org/type/Notebook',
+    version: '0.1.0',
+  }),
+  LabelAnnotation.set(['name']),
+);
+
+export type Notebook = Schema.Schema.Type<typeof Notebook>;
+
+export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }) => Obj.make(Notebook, props);

package/src/types/actions.ts

@@ -0,0 +1,53 @@
+//
+// 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,
+    }),
+  }) {}
+}

package/src/types/index.ts

@@ -2,4 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './schema';
+export * from './actions';
+export * as Notebook from './Notebook';
+export * from './types';

package/src/types/types.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode } from '@dxos/react-ui-editor';
+
+export const ScriptSettings = Schema.mutable(
+  Schema.Struct({
+    editorInputMode: EditorInputMode,
+  }),
+);
+
+export type ScriptSettings = Schema.Schema.Type<typeof ScriptSettings>;

package/src/util/deploy.ts

@@ -4,34 +4,29 @@
 
 import { type Client } from '@dxos/client';
 import { Obj, Ref } from '@dxos/echo';
-import {
-  FunctionType,
-  type ScriptType,
-  getUserFunctionUrlInMetadata,
-  makeFunctionUrl,
-  setUserFunctionUrlInMetadata,
-} from '@dxos/functions';
-import { Bundler } from '@dxos/functions/bundler';
-import { incrementSemverPatch, uploadWorkerFunction } from '@dxos/functions/edge';
+import { Function, type Script, getUserFunctionIdInMetadata, setUserFunctionIdInMetadata } from '@dxos/functions';
+import { Bundler } from '@dxos/functions-runtime/bundler';
+import { incrementSemverPatch, uploadWorkerFunction } from '@dxos/functions-runtime/edge';
 import { log } from '@dxos/log';
 import { type Space } from '@dxos/react-client/echo';
+import { isNode } from '@dxos/util';
 
 import { updateFunctionMetadata } from './functions';
 
-export const isScriptDeployed = ({ script, fn }: { script: ScriptType; fn: any }): boolean => {
-  const existingFunctionUrl = fn && getUserFunctionUrlInMetadata(Obj.getMeta(fn));
-  return Boolean(existingFunctionUrl) && !script.changed;
+export const isScriptDeployed = ({ script, fn }: { script: Script.Script; fn: any }): boolean => {
+  const existingFunctionId = fn && getUserFunctionIdInMetadata(Obj.getMeta(fn));
+  return Boolean(existingFunctionId) && !script.changed;
 };
 
 type DeployScriptProps = {
-  script: ScriptType;
+  script: Script.Script;
   client: Client;
   space: Space;
-  fn?: FunctionType;
-  existingFunctionUrl?: string;
+  fn?: Function.Function;
+  existingFunctionId?: string;
 };
 
-type DeployScriptResult = { success: boolean; error?: Error; functionUrl?: string };
+type DeployScriptResult = { success: boolean; error?: Error; functionId?: string };
 
 /**
  * Deploy a script to a space, handling bundling and uploading to the FaaS infrastructure.
@@ -41,7 +36,7 @@ export const deployScript = async ({
   client,
   space,
   fn,
-  existingFunctionUrl,
+  existingFunctionId,
 }: DeployScriptProps): Promise<DeployScriptResult> => {
   const validationError = validateDeployInputs(script, space);
   if (validationError) {
@@ -49,11 +44,10 @@ export const deployScript = async ({
   }
 
   try {
-    const existingFunctionId = extractFunctionId(existingFunctionUrl);
-
-    const { bundle, error } = await bundleScript(script.source!.target!.content);
-    if (error || !bundle) {
-      throw error || new Error('Bundle creation failed');
+    const bundler = new Bundler({ platform: isNode() ? 'node' : 'browser', sandboxedModules: [], remoteModules: {} });
+    const buildResult = await bundler.bundle({ source: script.source!.target!.content });
+    if ('error' in buildResult) {
+      throw buildResult.error || new Error('Bundle creation failed');
     }
 
     const { functionId, version, meta } = await uploadWorkerFunction({
@@ -61,7 +55,8 @@ export const deployScript = async ({
       ownerPublicKey: space.key,
       version: fn ? incrementSemverPatch(fn.version) : '0.0.1',
       functionId: existingFunctionId,
-      source: bundle,
+      entryPoint: buildResult.entryPoint,
+      assets: { [buildResult.entryPoint]: buildResult.asset },
     });
 
     if (functionId === undefined || version === undefined) {
@@ -72,10 +67,9 @@ export const deployScript = async ({
     script.changed = false;
     updateFunctionMetadata(script, storedFunction, meta, functionId);
 
-    const functionUrl = makeFunctionUrl({ functionId });
-    setUserFunctionUrlInMetadata(Obj.getMeta(storedFunction), functionUrl);
+    setUserFunctionIdInMetadata(Obj.getMeta(storedFunction), functionId);
 
-    return { success: true, functionUrl };
+    return { success: true, functionId };
   } catch (err: any) {
     log.catch(err);
     return { success: false, error: err };
@@ -85,39 +79,28 @@ export const deployScript = async ({
 /**
  * Validate inputs for script deployment.
  */
-const validateDeployInputs = (script: ScriptType, space: Space): Error | null => {
+const validateDeployInputs = (script: Script.Script, space: Space): Error | null => {
   if (!script.source || !space) {
     return new Error('Script source or space not available');
   }
   return null;
 };
 
-const extractFunctionId = (functionUrl?: string): string | undefined => {
-  return functionUrl?.split('/').at(-1);
-};
-
-const bundleScript = async (source: string): Promise<{ bundle?: string; error?: Error }> => {
-  const bundler = new Bundler({ platform: 'browser', sandboxedModules: [], remoteModules: {} });
-  const buildResult = await bundler.bundle({ source });
-
-  if (buildResult.error || !buildResult.bundle) {
-    return { error: buildResult.error || new Error('Bundle creation failed') };
-  }
-
-  return { bundle: buildResult.bundle };
-};
-
 const createOrUpdateFunctionInSpace = (
   space: Space,
-  fn: FunctionType | undefined,
-  script: ScriptType,
+  fn: Function.Function | undefined,
+  script: Script.Script,
   functionId: string,
   version: string,
-): FunctionType => {
+): Function.Function => {
   if (fn) {
+    fn.name = script.name ?? 'New Function';
     fn.version = version;
     return fn;
   } else {
-    return space.db.add(Obj.make(FunctionType, { name: functionId, version, source: Ref.make(script) }));
+    const fn = Function.make({ name: script.name ?? 'New Function', version, source: Ref.make(script) });
+    space.db.add(fn);
+    setUserFunctionIdInMetadata(Obj.getMeta(fn), functionId);
+    return fn;
   }
 };