@dxos/plugin-script 0.8.4-main.5ea62a8 → 0.8.4-main.ae835ea

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 { DataType } 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(DataType.makeText('c = a() + b'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(DataType.makeText('a = () => 100'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(DataType.makeText('b = 200'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(DataType.makeText('d = a() * 2'))),
+      },
+      {
+        id: PublicKey.random().toString(),
+        type: 'script',
+        source: Ref.make(createObject(DataType.makeText('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(DataType.makeText(`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,6 +20,15 @@ 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',
@@ -45,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.',
@@ -76,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 { DataType } 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(DataType.Text)),
+  prompt: Schema.optional(Type.Ref(Prompt.Prompt)),
+  view: Schema.optional(Type.Ref(DataType.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,29 +4,25 @@
 
 import { type Client } from '@dxos/client';
 import { Obj, Ref } from '@dxos/echo';
-import {
-  FunctionType,
-  type ScriptType,
-  getUserFunctionIdInMetadata,
-  setUserFunctionIdInMetadata,
-} from '@dxos/functions';
+import { Function, type Script, getUserFunctionIdInMetadata, setUserFunctionIdInMetadata } from '@dxos/functions';
 import { Bundler } from '@dxos/functions/bundler';
 import { incrementSemverPatch, uploadWorkerFunction } from '@dxos/functions/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 => {
+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;
+  fn?: Function.Function;
   existingFunctionId?: string;
 };
 
@@ -48,7 +44,7 @@ export const deployScript = async ({
   }
 
   try {
-    const bundler = new Bundler({ platform: 'browser', sandboxedModules: [], remoteModules: {} });
+    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');
@@ -83,7 +79,7 @@ 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');
   }
@@ -92,17 +88,17 @@ const validateDeployInputs = (script: ScriptType, space: Space): Error | null =>
 
 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 {
-    const fn = Obj.make(FunctionType, { name: script.name ?? 'New Function', 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;

package/src/util/functions.ts

@@ -2,10 +2,11 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type ScriptType, getInvocationUrl, getUserFunctionIdInMetadata } from '@dxos/functions';
+import { type Function, type Script, getInvocationUrl, getUserFunctionIdInMetadata } from '@dxos/functions';
+import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
+import { type Credential } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { getMeta, getSpace } from '@dxos/react-client/echo';
-
 /**
  * Get the function URL for a given script and client configuration
  */
@@ -14,7 +15,7 @@ export const getFunctionUrl = ({
   fn,
   edgeUrl,
 }: {
-  script: ScriptType;
+  script: Script.Script;
   fn: any;
   edgeUrl: string;
 }): string | undefined => {
@@ -30,7 +31,12 @@ export const getFunctionUrl = ({
   });
 };
 
-export const updateFunctionMetadata = (script: ScriptType, storedFunction: any, meta: any, functionId: string) => {
+export const updateFunctionMetadata = (
+  script: Script.Script,
+  storedFunction: Function.Function,
+  meta: any,
+  functionId: string,
+) => {
   if (script.description !== undefined && script.description.trim() !== '') {
     storedFunction.description = script.description;
   } else if (meta.description) {
@@ -50,4 +56,27 @@ export const updateFunctionMetadata = (script: ScriptType, storedFunction: any,
   } else {
     log.verbose('no output schema in function metadata', { functionId });
   }
+
+  if (meta.key) {
+    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/dist/lib/browser/DeploymentDialog-QZSTVNIS.mjs

@@ -1,12 +0,0 @@
-import {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog_default
-} from "./chunk-YCZPTTFO.mjs";
-import "./chunk-NXKU3BNX.mjs";
-import "./chunk-IS4OG2UW.mjs";
-import "./chunk-QYAREHGH.mjs";
-export {
-  DEPLOYMENT_DIALOG,
-  DeploymentDialog_default as default
-};
-//# sourceMappingURL=DeploymentDialog-QZSTVNIS.mjs.map