@meetopenbot/openbot 0.2.7 → 1.0.0

package/dist/tools/preview.js

@@ -1,269 +0,0 @@
-import { z } from 'zod';
-import { spawn } from 'node:child_process';
-import { randomUUID } from 'node:crypto';
-import { asActionBuilder } from '../types.js';
-const TUNNEL_URL_PATTERN = /https:\/\/[a-z0-9-]+\.trycloudflare\.com/i;
-const TUNNEL_READY_TIMEOUT_MS = 60000;
-const MAX_LOG_CHARS = 8000;
-const previewToolDefinitions = {
-    expose_port: {
-        description: 'Expose a local dev server port via a temporary public Cloudflare quick tunnel. Returns a previewUrl stored on the channel. Dev servers must listen on 0.0.0.0 or 127.0.0.1. Call after shell_exec when the server is ready.',
-        inputSchema: z.object({
-            port: z
-                .number()
-                .int()
-                .min(1024)
-                .max(65535)
-                .describe('Local port of the running dev server (e.g. 5173).'),
-        }),
-    },
-    unexpose_port: {
-        description: 'Stop the active Cloudflare preview tunnel for this channel and clear previewUrl from channel state.',
-        inputSchema: z.object({}),
-    },
-};
-const tunnels = new Map();
-const tunnelByChannel = new Map();
-const blockedPorts = () => {
-    const openbotPort = Number(process.env.PORT ?? 4132);
-    return new Set([22, 80, 443, openbotPort]);
-};
-const appendLog = (tunnel, chunk) => {
-    tunnel.logs += chunk;
-    if (tunnel.logs.length > MAX_LOG_CHARS) {
-        tunnel.logs = tunnel.logs.slice(-MAX_LOG_CHARS);
-    }
-};
-const killTunnelProcess = (tunnel) => {
-    const { process: child } = tunnel;
-    if (!child.pid) {
-        try {
-            child.kill();
-        }
-        catch {
-            /* ignore */
-        }
-        return;
-    }
-    try {
-        child.kill('SIGTERM');
-    }
-    catch {
-        try {
-            child.kill();
-        }
-        catch {
-            /* ignore */
-        }
-    }
-};
-const removeTunnel = (tunnelId) => {
-    const tunnel = tunnels.get(tunnelId);
-    if (!tunnel)
-        return;
-    killTunnelProcess(tunnel);
-    tunnels.delete(tunnelId);
-    if (tunnelByChannel.get(tunnel.channelId) === tunnelId) {
-        tunnelByChannel.delete(tunnel.channelId);
-    }
-};
-export const stopPreviewForChannel = (channelId) => {
-    const tunnelId = tunnelByChannel.get(channelId);
-    if (tunnelId) {
-        removeTunnel(tunnelId);
-    }
-};
-const waitForTunnelUrl = (child, timeoutMs) => new Promise((resolve, reject) => {
-    let buffer = '';
-    let settled = false;
-    const cleanup = () => {
-        clearTimeout(timer);
-        child.stdout?.off('data', onData);
-        child.stderr?.off('data', onData);
-        child.off('exit', onExit);
-        child.off('error', onError);
-    };
-    const tryParse = () => {
-        const match = buffer.match(TUNNEL_URL_PATTERN);
-        if (match) {
-            settled = true;
-            cleanup();
-            resolve(match[0]);
-        }
-    };
-    const onData = (chunk) => {
-        buffer += chunk.toString();
-        if (buffer.length > 16000) {
-            buffer = buffer.slice(-16000);
-        }
-        tryParse();
-    };
-    const onExit = (code) => {
-        if (settled)
-            return;
-        settled = true;
-        cleanup();
-        reject(new Error(`cloudflared exited before providing a tunnel URL (code ${code ?? 'unknown'})`));
-    };
-    const onError = (err) => {
-        if (settled)
-            return;
-        settled = true;
-        cleanup();
-        reject(err);
-    };
-    const timer = setTimeout(() => {
-        if (settled)
-            return;
-        settled = true;
-        cleanup();
-        reject(new Error('Timed out waiting for Cloudflare tunnel URL'));
-    }, timeoutMs);
-    child.stdout?.on('data', onData);
-    child.stderr?.on('data', onData);
-    child.on('exit', onExit);
-    child.on('error', onError);
-    tryParse();
-});
-const startCloudflaredTunnel = async (channelId, port) => {
-    const child = spawn('cloudflared', ['tunnel', '--url', `http://127.0.0.1:${port}`, '--no-autoupdate'], {
-        env: process.env,
-        stdio: ['ignore', 'pipe', 'pipe'],
-    });
-    const tunnel = {
-        id: randomUUID(),
-        channelId,
-        port,
-        url: '',
-        process: child,
-        startedAt: Date.now(),
-        logs: '',
-    };
-    child.stdout?.on('data', (data) => appendLog(tunnel, data.toString()));
-    child.stderr?.on('data', (data) => appendLog(tunnel, data.toString()));
-    child.on('exit', () => {
-        tunnels.delete(tunnel.id);
-        if (tunnelByChannel.get(channelId) === tunnel.id) {
-            tunnelByChannel.delete(channelId);
-        }
-    });
-    const url = await waitForTunnelUrl(child, TUNNEL_READY_TIMEOUT_MS);
-    tunnel.url = url;
-    tunnels.set(tunnel.id, tunnel);
-    tunnelByChannel.set(channelId, tunnel.id);
-    return tunnel;
-};
-const clearPreviewChannelState = async (storage, channelId) => {
-    await storage.patchChannelState({
-        channelId,
-        state: {
-            previewUrl: null,
-            previewPort: null,
-            previewExposedAt: null,
-        },
-    });
-};
-const previewPluginRuntime = (storage) => (builder) => {
-    const actions = asActionBuilder(builder);
-    actions.on('expose_port', async function* (event, context) {
-        const channelId = context.state.channelId;
-        const port = event.data?.port;
-        if (!Number.isInteger(port)) {
-            yield {
-                type: 'action:expose_port:result',
-                data: {
-                    success: false,
-                    output: 'port must be an integer between 1024 and 65535.',
-                },
-                meta: event.meta,
-            };
-            return;
-        }
-        if (blockedPorts().has(port)) {
-            yield {
-                type: 'action:expose_port:result',
-                data: {
-                    success: false,
-                    output: `Port ${port} is reserved and cannot be exposed.`,
-                },
-                meta: event.meta,
-            };
-            return;
-        }
-        const existingTunnelId = tunnelByChannel.get(channelId);
-        if (existingTunnelId) {
-            removeTunnel(existingTunnelId);
-        }
-        try {
-            const tunnel = await startCloudflaredTunnel(channelId, port);
-            await storage.patchChannelState({
-                channelId,
-                state: {
-                    previewUrl: tunnel.url,
-                    previewPort: port,
-                    previewExposedAt: tunnel.startedAt,
-                },
-            });
-            if (context.state.channelDetails) {
-                context.state.channelDetails = await storage.getChannelDetails({ channelId });
-            }
-            yield {
-                type: 'action:expose_port:result',
-                data: {
-                    success: true,
-                    previewUrl: tunnel.url,
-                    port,
-                    temporary: true,
-                    output: `Preview available at ${tunnel.url} (temporary Cloudflare quick tunnel).`,
-                },
-                meta: event.meta,
-            };
-        }
-        catch (error) {
-            const message = error instanceof Error ? error.message : 'Failed to start Cloudflare tunnel';
-            const needsCloudflared = message.includes('ENOENT') || message.toLowerCase().includes('cloudflared');
-            const hint = needsCloudflared
-                ? ' Install cloudflared and ensure it is on PATH (https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/downloads/).'
-                : '';
-            yield {
-                type: 'action:expose_port:result',
-                data: {
-                    success: false,
-                    error: message,
-                    output: `${message}${hint}`,
-                },
-                meta: event.meta,
-            };
-        }
-    });
-    actions.on('unexpose_port', async function* (event, context) {
-        const channelId = context.state.channelId;
-        stopPreviewForChannel(channelId);
-        await clearPreviewChannelState(storage, channelId);
-        if (context.state.channelDetails) {
-            context.state.channelDetails = await storage.getChannelDetails({ channelId });
-        }
-        yield {
-            type: 'action:unexpose_port:result',
-            data: {
-                success: true,
-                output: 'Preview tunnel stopped and previewUrl cleared from channel state.',
-            },
-            meta: event.meta,
-        };
-    });
-    actions.on('delete_channel', async function* (event) {
-        const channelId = event.data?.channelId;
-        if (channelId) {
-            stopPreviewForChannel(channelId);
-        }
-    });
-};
-export const previewPlugin = {
-    id: 'preview',
-    name: 'Preview',
-    description: 'Temporary public preview URLs via Cloudflare quick tunnels.',
-    toolDefinitions: previewToolDefinitions,
-    factory: ({ storage }) => previewPluginRuntime(storage),
-};
-export default previewPlugin;

package/dist/tools/ui.js

@@ -1,120 +0,0 @@
-import { randomUUID } from 'node:crypto';
-import { z } from 'zod';
-/**
- * `ui` — provides a tool for the agent to render interactive UI widgets.
- *
- * The model can choose which widget to render (form, choice, list, message)
- * depending on the situation.
- */
-export const uiPlugin = {
-    id: 'ui',
-    name: 'UI',
-    description: 'Render interactive UI widgets to interact with the user.',
-    toolDefinitions: {
-        render_widget: {
-            description: 'Render a UI widget to the user. Use "form" for data collection, "choice" for simple selection, "list" for displaying items, and "message" for simple notifications with actions. When using form widge to unquire user, do not provide complex forms with many fields, always try to make it simple to keep the experience smooth and straightforward.',
-            inputSchema: z.object({
-                kind: z.enum(['message', 'choice', 'form', 'list']).describe('The type of widget to render.'),
-                title: z.string().describe('The title of the widget.'),
-                description: z.string().optional().describe('A description or body text.'),
-                fields: z.array(z.object({
-                    id: z.string().describe('Unique ID for the field.'),
-                    label: z.string().describe('Label shown to the user.'),
-                    type: z.enum(['text', 'textarea', 'number', 'boolean', 'select', 'multiselect', 'date']),
-                    description: z.string().optional(),
-                    placeholder: z.string().optional(),
-                    required: z.boolean().optional(),
-                    options: z.array(z.object({ label: z.string(), value: z.string() })).optional(),
-                    defaultValue: z.any().optional()
-                })).optional().describe('Required for kind="form". List of form fields.'),
-                actions: z.array(z.object({
-                    id: z.string(),
-                    label: z.string(),
-                    variant: z.enum(['primary', 'secondary', 'danger']).optional(),
-                })).optional().describe('Buttons or actions available on the widget.'),
-                items: z.array(z.object({
-                    id: z.string(),
-                    label: z.string(),
-                    description: z.string().optional(),
-                    status: z
-                        .string()
-                        .optional()
-                        .describe('Status label shown on the item (e.g. "Pending", "Shipped").'),
-                    statusVariant: z
-                        .enum(['default', 'success', 'warning', 'danger', 'info'])
-                        .optional()
-                        .describe('Semantic hint for status badge coloring in the client.'),
-                    metadata: z.record(z.string(), z.any()).optional()
-                })).optional().describe('Required for kind="list". List of items to display.'),
-                submitLabel: z.string().optional().describe('Label for the primary action button (e.g. "Submit", "Save").')
-            })
-        }
-    },
-    factory: () => (builder) => {
-        // Handle the tool call from the agent
-        builder.on('action:render_widget', async function* (event, context) {
-            const widgetEvent = event;
-            const toolCallId = widgetEvent.meta?.toolCallId;
-            const threadId = widgetEvent.meta?.threadId || context.state.threadId;
-            if (!toolCallId)
-                return;
-            const widgetId = randomUUID();
-            // Emit the UI widget event to the client
-            yield {
-                type: 'client:ui:widget',
-                data: {
-                    ...widgetEvent.data,
-                    widgetId,
-                    metadata: {
-                        type: 'ui:request',
-                        originalEvent: widgetEvent
-                    }
-                },
-                meta: { agentId: context.state.agentId, threadId }
-            };
-        });
-        // Handle the user's response from the UI widget
-        builder.on('client:ui:widget:response', async function* (event, context) {
-            const responseEvent = event;
-            const { widgetId, actionId, values, metadata } = responseEvent.data;
-            if (metadata?.type !== 'ui:request')
-                return;
-            const originalEvent = metadata.originalEvent;
-            const toolCallId = originalEvent?.meta?.toolCallId;
-            const threadId = originalEvent?.meta?.threadId || context.state.threadId;
-            if (!toolCallId)
-                return;
-            // Yield a "submitted" widget update to the UI to collapse/disable it
-            yield {
-                type: 'client:ui:widget',
-                data: {
-                    widgetId,
-                    title: originalEvent.data.title,
-                    kind: originalEvent.data.kind,
-                    state: 'submitted',
-                    body: "Thank you for your response. We will process it and get back to you soon.",
-                    display: 'collapsed',
-                    disabled: true,
-                    actions: [], // Clear actions to disable buttons in UI
-                },
-                meta: { agentId: context.state.agentId, threadId },
-            };
-            // Emit the tool result event so the agent runtime can resume
-            yield {
-                type: 'action:render_widget:result',
-                data: {
-                    success: true,
-                    actionId,
-                    values,
-                    output: JSON.stringify(values)
-                },
-                meta: {
-                    agentId: context.state.agentId,
-                    threadId,
-                    toolCallId
-                }
-            };
-        });
-    },
-};
-export default uiPlugin;

package/dist/utils/workspace-url.js

@@ -1,6 +0,0 @@
-export function buildWorkspaceFileUrl(args) {
-    const base = args.baseUrl.replace(/\/$/, '');
-    const data = encodeURIComponent(JSON.stringify({ path: args.filePath }));
-    const channelId = encodeURIComponent(args.channelId);
-    return `${base}/api/state?channelId=${channelId}&type=${encodeURIComponent('action:storage:serve-file')}&data=${data}`;
-}