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

package/src/translations.ts

@@ -2,77 +2,107 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ScriptType } from '@dxos/functions';
+import { Script } from '@dxos/compute';
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
+import { meta } from '#meta';
+import { Notebook } from '#types';
 
 export const translations = [
   {
     'en-US': {
-      [ScriptType.typename]: {
-        'typename label': 'Script',
-        'typename label_zero': 'Scripts',
-        'typename label_one': 'Script',
-        'typename label_other': 'Scripts',
-        'object name placeholder': 'New script',
+      [Type.getTypename(Script.Script)]: {
+        'typename.label': 'Script',
+        'typename.label_zero': 'Scripts',
+        'typename.label_one': 'Script',
+        'typename.label_other': 'Scripts',
+        'object-name.placeholder': 'New script',
+        'add-object.label': 'Add script',
+        'rename-object.label': 'Rename script',
+        'delete-object.label': 'Delete script',
+        'object-deleted.label': 'Script deleted',
+      },
+      [Type.getTypename(Notebook.Notebook)]: {
+        'typename.label': 'Notebook',
+        'typename.label_zero': 'Notebooks',
+        'typename.label_one': 'Notebook',
+        'typename.label_other': 'Notebooks',
+        'object-name.placeholder': 'New notebook',
+        'add-object.label': 'Add notebook',
+        'rename-object.label': 'Rename notebook',
+        'delete-object.label': 'Delete notebook',
+        'object-deleted.label': 'Notebook deleted',
       },
       [meta.id]: {
-        'plugin name': 'Scripts',
-        'description label': 'Description',
-        'description placeholder': 'Enter description',
-        'binding placeholder': 'Function name',
-        'function request placeholder': 'Function request',
-        'deploy label': 'Deploy',
-        'deployed label': 'Current version of the script is deployed',
-        'upload failed label': 'Upload failed',
-        'copy link label': 'Copy function link',
-        'format label': 'Format',
-        'toggle details label': 'Toggle details panel',
-        'authenticate action label': 'Authenticate functions service',
-        'authenticate button label': 'Authenticate',
-        'name label': 'Name',
-        'remote function settings heading': 'Remote Function',
-        'function url label': 'Invocation URL',
-        'function binding label': 'Function binding',
-        'function binding placeholder': 'Enter binding name (e.g., NAME)',
-        'script publish settings label': 'Publishing',
-        'script publish settings description': 'Scripts can be shared publicly as Github gists.',
-        'no github token label': 'This space has no GitHub access token available.',
-        'open token manager label': 'Open Token Manager',
-        'publish label': 'Publish',
-        'publishing label': 'Publishing',
-        '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 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.',
-        'script deployment toast description_other': 'Your scripts have been deployed successfully.',
-        'script deployment toast close label_one': 'Close',
-        'script deployment toast close label_other': 'Close',
-        'script deployment error toast label_one': 'Script deployment failed',
-        'script deployment error toast label_other': 'Scripts deployment failed',
-        'script deployment error toast description_one': 'There was an error deploying your script.',
-        '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',
+        'plugin.name': 'Scripts',
+        'settings.title': 'Scripts settings',
+        'description.label': 'Description',
+        'description.placeholder': 'Enter description',
+        'binding.placeholder': 'Function name',
+        'function-request.placeholder': 'Function request',
+        'deploy.label': 'Deploy',
+        'deployed.label': 'Current version of the script is deployed',
+        'upload-failed.label': 'Upload failed',
+        'copy-link.label': 'Copy function link',
+        'format.label': 'Format',
+        'toggle-details.label': 'Toggle details panel',
+        'authenticate-action.label': 'Authenticate functions service',
+        'authenticate-action.description':
+          'Sign in to the remote functions service to enable script deployment and execution.',
+        'authenticate-button.label': 'Authenticate',
+        'name.label': 'Name',
+        'remote-function-settings.heading': 'Remote Function',
+        'function-url.label': 'Invocation URL',
+        'function-binding.label': 'Function binding',
+        'function-binding.placeholder': 'Enter binding name (e.g., NAME)',
+        'script-publish-settings.label': 'Publishing',
+        'script-publish-settings.description': 'Scripts can be shared publicly as Github gists.',
+        'no-github-token.label': 'This space has no GitHub access token available.',
+        'open-token-manager.label': 'Open Token Manager',
+        'publish.label': 'Publish',
+        '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',
+        'update-blueprint.label': 'Update blueprint',
+        'function-panel.label': 'Debug Function',
+        'script-test.label': 'Test',
+        'script-logs.label': 'Logs',
+        'compute.label': 'Compute',
+
+        'deployment-dialog.title': 'Default Scripts',
+        '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.',
+        'script-deployment-toast.description_other': 'Your scripts have been deployed successfully.',
+        'script-deployment-toast-close.label_one': 'Close',
+        'script-deployment-toast-close.label_other': 'Close',
+        'script-deployment-error-toast.label_one': 'Script deployment failed',
+        'script-deployment-error-toast.label_other': 'Scripts deployment failed',
+        'script-deployment-error-toast.description_one': 'There was an error deploying your script.',
+        '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,39 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Routine } from '@dxos/compute';
+import { DXN, Annotation, Obj, Ref, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/Annotation';
+import { LabelAnnotation } from '@dxos/echo/Annotation';
+import { Graph } from '@dxos/plugin-explorer';
+import { Text } from '@dxos/schema';
+
+export type CellType = 'markdown' | 'script' | 'query' | 'prompt' | 'view';
+
+export const Cell = Schema.Struct({
+  id: Schema.String,
+  type: Schema.String,
+  name: Schema.optional(Schema.String),
+  // TODO(burdon): Union type.
+  source: Schema.optional(Ref.Ref(Text.Text)),
+  prompt: Schema.optional(Ref.Ref(Routine.Routine)),
+  graph: Schema.optional(Ref.Ref(Graph.Graph)),
+});
+
+export type Cell = Schema.Schema.Type<typeof Cell>;
+
+export const Notebook = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+  cells: Cell.pipe(Schema.Array, FormInputAnnotation.set(false)),
+}).pipe(
+  LabelAnnotation.set(['name']),
+  Annotation.IconAnnotation.set({ icon: 'ph--notebook--regular', hue: 'sky' }),
+  Type.makeObject(DXN.make('org.dxos.type.notebook', '0.1.0')),
+);
+
+export type Notebook = Type.InstanceType<typeof Notebook>;
+
+export const make = (props: Obj.MakeProps<typeof Notebook> = { cells: [] }): Notebook => Obj.make(Notebook, props);

package/src/types/ScriptCapabilities.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type Atom } from '@effect-atom/atom-react';
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+import { type Compiler as CompilerType } from '../compiler';
+
+// Inline import to avoid `Settings` namespace alias colliding with the
+// `Settings` capability export below.
+export const Settings = Capability.make<Atom.Writable<import('./Settings').Settings>>(`${meta.id}.capability.settings`);
+export const Compiler = Capability.make<CompilerType>(`${meta.id}.capability.compiler`);

package/src/types/ScriptEvents.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { ActivationEvent } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+export const SetupCompiler = ActivationEvent.make(`${meta.id}.event.setup-compiler`);

package/src/types/ScriptOperation.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Script, Operation } from '@dxos/compute';
+import { Database, Type, DXN } from '@dxos/echo';
+
+import { meta } from '#meta';
+
+import { templates } from '../templates';
+
+const makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);
+
+export const ScriptProps = Schema.Struct({
+  name: Schema.optional(Schema.String),
+  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 const NotebookProps = Schema.Struct({
+  name: Schema.optional(Schema.String),
+});
+
+export const CreateScript = Operation.make({
+  meta: { key: makeKey('createScript'), name: 'Create Script', icon: 'ph--code--regular' },
+  input: Schema.extend(
+    ScriptProps,
+    Schema.Struct({
+      db: Database.Database,
+    }),
+  ),
+  output: Schema.Struct({
+    object: Type.getSchema(Script.Script),
+  }),
+});

package/src/types/Settings.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode } from '@dxos/ui-editor/types';
+
+export const Settings = Schema.mutable(
+  Schema.Struct({
+    editorInputMode: EditorInputMode.annotations({
+      title: 'Editor input mode',
+      description: 'Choose the keybinding style for the script editor.',
+    }),
+  }),
+);
+
+export interface Settings extends Schema.Schema.Type<typeof Settings> {}

package/src/types/index.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './types';
+
+export * as Notebook from './Notebook';
+export * as ScriptCapabilities from './ScriptCapabilities';
+export * as ScriptEvents from './ScriptEvents';
+export * as ScriptOperation from './ScriptOperation';

package/src/types/types.ts

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

package/src/util/deploy.ts

@@ -3,35 +3,30 @@
 //
 
 import { type Client } from '@dxos/client';
+import { Script, Operation } from '@dxos/compute';
+import { Context } from '@dxos/context';
 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 { getUserFunctionIdInMetadata } from '@dxos/functions';
+import { bundleFunction } from '@dxos/functions-runtime/bundler';
+import { FunctionsServiceClient, incrementSemverPatch } from '@dxos/functions-runtime/edge';
 import { log } from '@dxos/log';
+import { FunctionRuntimeKind } from '@dxos/protocols';
 import { type Space } from '@dxos/react-client/echo';
 
-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?: Operation.PersistentOperation;
+  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,33 +44,30 @@ 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 buildResult = await bundleFunction({
+      source: script.source!.target!.content,
+    });
+    if ('error' in buildResult) {
+      throw buildResult.error || new Error('Bundle creation failed');
     }
 
-    const { functionId, version, meta } = await uploadWorkerFunction({
-      client,
+    const functionsServiceClient = FunctionsServiceClient.fromClient(client);
+    const newFunction = await functionsServiceClient.deploy(Context.default(), {
+      // TODO(dmaretskyi): Space key or identity key.
       ownerPublicKey: space.key,
-      version: fn ? incrementSemverPatch(fn.version) : '0.0.1',
+      version: fn ? incrementSemverPatch(Obj.getMeta(fn).version ?? '0.0.0') : '0.0.1',
       functionId: existingFunctionId,
-      source: bundle,
+      entryPoint: buildResult.entryPoint,
+      assets: buildResult.assets,
+      runtime: FunctionRuntimeKind.enums.WORKER_LOADER,
     });
 
-    if (functionId === undefined || version === undefined) {
-      throw new Error(`Upload didn't return expected data: ${JSON.stringify({ functionId, version })}`);
-    }
-
-    const storedFunction = createOrUpdateFunctionInSpace(space, fn, script, functionId, version);
-    script.changed = false;
-    updateFunctionMetadata(script, storedFunction, meta, functionId);
-
-    const functionUrl = makeFunctionUrl({ functionId });
-    setUserFunctionUrlInMetadata(Obj.getMeta(storedFunction), functionUrl);
+    const storedFunction = createOrUpdateFunctionInSpace(space, fn, script, newFunction);
+    Obj.update(script, (script) => {
+      script.changed = false;
+    });
 
-    return { success: true, functionUrl };
+    return { success: true, functionId: getUserFunctionIdInMetadata(Obj.getMeta(storedFunction)) };
   } catch (err: any) {
     log.catch(err);
     return { success: false, error: err };
@@ -85,39 +77,26 @@ 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,
-  functionId: string,
-  version: string,
-): FunctionType => {
+  fn: Operation.PersistentOperation | undefined,
+  script: Script.Script,
+  newFunction: Operation.PersistentOperation,
+): Operation.PersistentOperation => {
   if (fn) {
-    fn.version = version;
+    Operation.setFrom(fn, newFunction);
     return fn;
   } else {
-    return space.db.add(Obj.make(FunctionType, { name: functionId, version, source: Ref.make(script) }));
+    Obj.update(newFunction, (newFunction) => {
+      newFunction.source = Ref.make(script);
+    });
+    return space.db.add(newFunction);
   }
 };

package/src/util/functions.ts

@@ -2,9 +2,13 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type ScriptType, getInvocationUrl, getUserFunctionUrlInMetadata } from '@dxos/functions';
+import { type Operation, Script } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { getUserFunctionIdInMetadata } from '@dxos/functions';
+import { getInvocationUrl } from '@dxos/functions-runtime';
+import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import { getMeta, getSpace } from '@dxos/react-client/echo';
+import { type Credential } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 /**
  * Get the function URL for a given script and client configuration
@@ -14,40 +18,70 @@ export const getFunctionUrl = ({
   fn,
   edgeUrl,
 }: {
-  script: ScriptType;
+  script: Script.Script;
   fn: any;
   edgeUrl: string;
 }): string | undefined => {
-  const space = getSpace(script);
-  const existingFunctionUrl = fn && getUserFunctionUrlInMetadata(getMeta(fn));
+  const spaceId = Obj.getDatabase(script)?.spaceId;
+  const existingFunctionId = fn && getUserFunctionIdInMetadata(Obj.getMeta(fn));
 
-  if (!existingFunctionUrl) {
+  if (!existingFunctionId) {
     return undefined;
   }
 
-  return getInvocationUrl(existingFunctionUrl, edgeUrl, {
-    spaceId: space?.id,
+  return getInvocationUrl(existingFunctionId, edgeUrl, {
+    spaceId,
   });
 };
 
-export const updateFunctionMetadata = (script: ScriptType, storedFunction: any, meta: any, functionId: string) => {
-  if (script.description !== undefined && script.description.trim() !== '') {
-    storedFunction.description = script.description;
-  } else if (meta.description) {
-    storedFunction.description = meta.description;
-  } else {
-    log.verbose('no description in function metadata', { functionId });
-  }
+export const updateFunctionMetadata = (
+  script: Script.Script,
+  storedFunction: Operation.PersistentOperation,
+  meta: any,
+  functionId: string,
+) => {
+  Obj.update(storedFunction, (storedFunction) => {
+    if (script.description !== undefined && script.description.trim() !== '') {
+      storedFunction.description = script.description;
+    } else if (meta.description) {
+      storedFunction.description = meta.description;
+    } else {
+      log.verbose('no description in function metadata', { functionId });
+    }
 
-  if (meta.inputSchema) {
-    storedFunction.inputSchema = meta.inputSchema;
-  } else {
-    log.verbose('no input schema in function metadata', { functionId });
-  }
+    if (meta.inputSchema) {
+      storedFunction.inputSchema = meta.inputSchema;
+    } else {
+      log.verbose('no input schema in function metadata', { functionId });
+    }
 
-  if (meta.outputSchema) {
-    storedFunction.outputSchema = meta.outputSchema;
-  } else {
-    log.verbose('no output schema in function metadata', { functionId });
-  }
+    if (meta.outputSchema) {
+      storedFunction.outputSchema = meta.outputSchema;
+    } else {
+      log.verbose('no output schema in function metadata', { functionId });
+    }
+
+    if (meta.key) {
+      Obj.getMeta(storedFunction).key = meta.key;
+    } else {
+      log.verbose('no key in function metadata', { functionId });
+    }
+  });
+};
+
+export const getAccessCredential = (identityKey: PublicKey): Credential => {
+  return {
+    issuer: identityKey,
+    issuanceDate: new Date(),
+    subject: {
+      id: identityKey,
+      assertion: {
+        '@type': 'dxos.halo.credentials.ServiceAccess',
+        serverName: 'hub.dxos.network',
+        serverKey: identityKey,
+        identityKey,
+        capabilities: ['composer:beta'],
+      },
+    },
+  };
 };

package/src/vite-env.d.ts

@@ -18,3 +18,10 @@ declare module '*?raw' {
   const content: string;
   export default content;
 }
+
+declare module 'https://*';
+
+declare module '*.mdl?raw' {
+  const content: string;
+  export default content;
+}

package/dist/lib/browser/DeploymentDialog-RIGSJM6A.mjs

@@ -1,12 +0,0 @@
-import {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog_default
-} from "./chunk-QHVTSNHD.mjs";
-import "./chunk-OORJVKHC.mjs";
-import "./chunk-EEL5O3IC.mjs";
-import "./chunk-QYAREHGH.mjs";
-export {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog_default as default
-};
-//# sourceMappingURL=DeploymentDialog-RIGSJM6A.mjs.map