openbot 0.4.0 → 0.4.2

package/src/plugins/storage/index.ts

@@ -1,6 +1,7 @@
 import z from 'zod';
 import type { Plugin } from '../../services/plugins/types.js';
 import { OpenBotEvent } from '../../app/types.js';
+import { buildWorkspaceFileUrl } from './files.js';
 
 /**
  * `storage` — exposes channel/thread/variable mutation tools and provides
@@ -25,7 +26,9 @@ const storageToolDefinitions = {
       cwd: z
         .string()
         .optional()
-        .describe('Optional initial current working directory for the channel.'),
+        .describe(
+          'Optional initial current working directory for the channel. Defaults to an absolute path under ~/openbot/{channelId}.',
+        ),
     }),
   },
   patch_channel_details: {
@@ -45,10 +48,20 @@ const storageToolDefinitions = {
             'Markdown content for the channel specification (SPEC.md). Use for goals and rules.',
           ),
         cwd: z.string().optional().describe('Current working directory for the channel.'),
+        participants: z
+          .array(z.string())
+          .optional()
+          .describe(
+            'List of agent IDs that are participants in this channel. When a user tags an agent (e.g. @agent-id), you should ensure they are added to this list if they are not already there.',
+          ),
       })
       .refine(
-        (value) => value.state !== undefined || value.spec !== undefined || value.cwd !== undefined,
-        { message: 'Provide at least one of state, spec, or cwd.' },
+        (value) =>
+          value.state !== undefined ||
+          value.spec !== undefined ||
+          value.cwd !== undefined ||
+          value.participants !== undefined,
+        { message: 'Provide at least one of state, spec, cwd, or participants.' },
       ),
   },
   patch_thread_details: {
@@ -75,6 +88,22 @@ const storageToolDefinitions = {
       key: z.string().describe('The key of the variable to delete.'),
     }),
   },
+  delete_channel: {
+    description:
+      'Permanently delete a channel and all its threads and events. Always confirm with the user before deleting.',
+    inputSchema: z.object({
+      channelId: z.string().describe('The channel ID to delete.'),
+    }),
+  },
+  get_workspace_file_url: {
+    description:
+      'Get a fetchable HTTP URL for a file in the current channel workspace (images, video, audio, documents).',
+    inputSchema: z.object({
+      path: z
+        .string()
+        .describe('Path relative to the channel working directory, e.g. "uploads/clip.mp4".'),
+    }),
+  },
 };
 
 export const storagePlugin: Plugin = {
@@ -82,7 +111,9 @@ export const storagePlugin: Plugin = {
   name: 'Storage',
   description: 'Tools for creating channels, patching state, and managing workspace variables.',
   toolDefinitions: storageToolDefinitions,
-  factory: ({ storage }) => (builder) => {
+  factory: ({ storage, publicBaseUrl }) => (builder) => {
+    const resolvePublicBaseUrl = () => publicBaseUrl;
+
     builder.on('action:create_thread', async function* (event, context) {
       const threadId = event.meta?.threadId;
       const channelId = context.state.channelId;
@@ -180,6 +211,44 @@ export const storagePlugin: Plugin = {
       }
     });
 
+    builder.on('action:delete_channel', async function* (event, context) {
+      const rawChannelId = ((event.data as { channelId?: string })?.channelId || '').trim();
+      const resultMeta = { ...(event.meta || {}), agentId: context.state.agentId };
+
+      if (!rawChannelId) {
+        yield {
+          type: 'action:delete_channel:result',
+          data: { success: false, channelId: '', error: 'channelId is required' },
+          meta: resultMeta,
+        } as OpenBotEvent;
+        return;
+      }
+
+      try {
+        await storage.deleteChannel({ channelId: rawChannelId });
+        yield {
+          type: 'action:delete_channel:result',
+          data: { success: true, channelId: rawChannelId },
+          meta: resultMeta,
+        } as OpenBotEvent;
+        yield {
+          type: 'agent:output',
+          data: { content: `Deleted channel \`${rawChannelId}\`.` },
+          meta: resultMeta,
+        } as OpenBotEvent;
+      } catch (error) {
+        yield {
+          type: 'action:delete_channel:result',
+          data: {
+            success: false,
+            channelId: rawChannelId,
+            error: error instanceof Error ? error.message : 'Unknown error',
+          },
+          meta: resultMeta,
+        } as OpenBotEvent;
+      }
+    });
+
     builder.on('action:update_channel', async function* (event, context) {
       const data = (event.data || {}) as {
         channelId?: string;
@@ -302,7 +371,8 @@ export const storagePlugin: Plugin = {
             widgetId: "patch-channel-details-result" + Date.now(),
             kind: "message",
             title: "Channel details updated.",
-            body: "The channel details have been updated.",
+            body: `The channel details have been updated. ${updatedFields.join(', ')}`,
+            display: "collapsed",
           },
           meta: resultMeta,
         }
@@ -395,6 +465,26 @@ export const storagePlugin: Plugin = {
       yield { type: 'action:storage:get-threads-result', data: { threads } };
     });
 
+    builder.on('action:storage:set-last-read', async function* (event, context) {
+      const { channelId, threadId, lastReadEventId } = event.data;
+      try {
+        await storage.setLastRead({
+          channelId: channelId || context.state.channelId,
+          threadId: threadId || context.state.threadId,
+          lastReadEventId,
+        });
+        yield { type: 'action:storage:set-last-read-result', data: { success: true } };
+      } catch (error) {
+        yield {
+          type: 'action:storage:set-last-read-result',
+          data: {
+            success: false,
+            error: error instanceof Error ? error.message : 'Unknown error',
+          },
+        };
+      }
+    });
+
     builder.on('action:storage:get-channel-details', async function* (_, state) {
       const channelDetails = await storage.getChannelDetails({
         channelId: state.state.channelId,
@@ -484,6 +574,21 @@ export const storagePlugin: Plugin = {
       }
     });
 
+    builder.on('action:storage:delete-channel', async function* (event) {
+      try {
+        await storage.deleteChannel({ channelId: event.data.channelId });
+        yield { type: 'action:storage:delete-channel-result', data: { success: true } };
+      } catch (error) {
+        yield {
+          type: 'action:storage:delete-channel-result',
+          data: {
+            success: false,
+            error: error instanceof Error ? error.message : 'Unknown error',
+          },
+        };
+      }
+    });
+
     builder.on('action:storage:delete-agent', async function* (event) {
       try {
         await storage.deleteAgent({ agentId: event.data.agentId });
@@ -602,7 +707,9 @@ export const storagePlugin: Plugin = {
 
     builder.on('action:storage:read-file', async function* (event, context) {
       const channelId = context.state.channelId;
-      const filePath = (event.data as any)?.path;
+      const data = event.data as { path?: string; encoding?: 'utf8' | 'base64' };
+      const filePath = data?.path;
+      const encoding = data?.encoding ?? 'utf8';
       if (!filePath) {
         yield {
           type: 'action:storage:read-file:result',
@@ -611,10 +718,23 @@ export const storagePlugin: Plugin = {
         return;
       }
       try {
-        const content = await storage.readFile({ channelId, path: filePath });
+        if (encoding === 'utf8') {
+          const content = await storage.readFile({ channelId, path: filePath });
+          yield {
+            type: 'action:storage:read-file:result',
+            data: { success: true, content, path: filePath, encoding },
+          };
+          return;
+        }
+
+        const { content, mimeType, size } = await storage.readChannelFile({
+          channelId,
+          path: filePath,
+          encoding,
+        });
         yield {
           type: 'action:storage:read-file:result',
-          data: { success: true, content, path: filePath },
+          data: { success: true, content, path: filePath, encoding, mimeType, size },
         };
       } catch (error) {
         yield {
@@ -627,6 +747,76 @@ export const storagePlugin: Plugin = {
         };
       }
     });
+
+    builder.on('action:storage:get-file-url', async function* (event, context) {
+      const channelId = context.state.channelId;
+      const filePath = (event.data as { path?: string })?.path;
+      if (!filePath) {
+        yield {
+          type: 'action:storage:get-file-url:result',
+          data: { success: false, path: '', error: 'Path is required' },
+        };
+        return;
+      }
+      try {
+        const { size, mimeType } = await storage.getChannelFileStat({ channelId, path: filePath });
+        const url = buildWorkspaceFileUrl({
+          baseUrl: resolvePublicBaseUrl(),
+          channelId,
+          filePath,
+        });
+        yield {
+          type: 'action:storage:get-file-url:result',
+          data: { success: true, path: filePath, url, mimeType, size },
+        };
+      } catch (error) {
+        yield {
+          type: 'action:storage:get-file-url:result',
+          data: {
+            success: false,
+            path: filePath,
+            error: error instanceof Error ? error.message : 'Unknown error',
+          },
+        };
+      }
+    });
+
+    builder.on('action:get_workspace_file_url', async function* (event, context) {
+      const channelId = context.state.channelId;
+      const filePath = (event.data as { path?: string })?.path;
+      const toolCallId = event.meta?.toolCallId;
+
+      if (!filePath) {
+        yield {
+          type: 'action:get_workspace_file_url:result',
+          data: { success: false, path: '', error: 'Path is required', output: 'Path is required' },
+          meta: { ...(event.meta || {}), toolCallId },
+        };
+        return;
+      }
+
+      try {
+        const { size, mimeType } = await storage.getChannelFileStat({ channelId, path: filePath });
+        const url = buildWorkspaceFileUrl({
+          baseUrl: resolvePublicBaseUrl(),
+          channelId,
+          filePath,
+        });
+        const output = JSON.stringify({ path: filePath, url, mimeType, size });
+        yield {
+          type: 'action:get_workspace_file_url:result',
+          data: { success: true, path: filePath, url, mimeType, size, output },
+          meta: { ...(event.meta || {}), toolCallId },
+        };
+      } catch (error) {
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        yield {
+          type: 'action:get_workspace_file_url:result',
+          data: { success: false, path: filePath, error: message, output: message },
+          meta: { ...(event.meta || {}), toolCallId },
+        };
+      }
+    });
   },
 };