@elizaos/plugin-ngrok 2.0.0-beta.1 → 2.0.11-beta.7

package/src/actions/start-tunnel.ts

@@ -1,255 +0,0 @@
-import {
-  type Action,
-  type ActionExample,
-  type ActionResult,
-  elizaLogger,
-  type HandlerCallback,
-  type IAgentRuntime,
-  type Memory,
-  ModelType,
-  type State,
-} from '@elizaos/core';
-import { getTunnelService } from '@elizaos/plugin-tunnel';
-
-const startTunnelTemplate = `
-Respond with a JSON object containing the port number to start the ngrok tunnel on.
-The user said: "{{userMessage}}"
-
-Extract the port number from their message, or use the default port 3000 if not specified.
-
-Response format:
-\`\`\`json
-{
-  "port": 3000
-}
-\`\`\`
-`;
-
-export const startTunnelAction: Action = {
-  name: 'START_TUNNEL',
-  similes: ['OPEN_TUNNEL', 'CREATE_TUNNEL', 'NGROK_START', 'TUNNEL_UP'],
-  description:
-    'Start an ngrok tunnel to expose a local port to the internet. Supports action chaining by providing tunnel metadata that can be used for webhook configuration, API testing, or remote access workflows.',
-  validate: async (runtime: IAgentRuntime, _message: Memory) => {
-    const tunnelService = getTunnelService(runtime);
-    if (!tunnelService) {
-      return false;
-    }
-
-    // Check if tunnel is already active
-    if (tunnelService.isActive()) {
-      elizaLogger.warn('Tunnel is already active');
-      return false;
-    }
-
-    return true;
-  },
-  handler: async (
-    runtime: IAgentRuntime,
-    message: Memory,
-    _state?: State,
-    _options?: unknown,
-    callback?: HandlerCallback
-  ): Promise<ActionResult> => {
-    const tunnelService = getTunnelService(runtime);
-    if (!tunnelService) {
-      elizaLogger.error('Tunnel service is not available');
-      if (callback) {
-        await callback({
-          text: 'Tunnel service is not available. Please ensure the ngrok plugin is properly configured.',
-        });
-      }
-      return {
-        success: false,
-        text: 'Tunnel service is not available. Please ensure the ngrok plugin is properly configured.',
-        values: { success: false, error: 'service_unavailable' },
-        data: { action: 'START_TUNNEL' },
-      };
-    }
-
-    if (tunnelService.isActive()) {
-      elizaLogger.warn('Tunnel is already active');
-      if (callback) {
-        await callback({
-          text: 'Tunnel is already active. Please stop the existing tunnel before starting a new one.',
-        });
-      }
-      return {
-        success: false,
-        text: 'Tunnel is already active. Please stop the existing tunnel before starting a new one.',
-        values: { success: false, error: 'tunnel_already_active' },
-        data: { action: 'START_TUNNEL' },
-      };
-    }
-
-    elizaLogger.info('Starting ngrok tunnel...');
-
-    try {
-      // Extract port from message — inline the user message into the prompt
-      // (TEXT_SMALL no longer accepts a separate `context` param).
-      const userMessage = message.content.text ?? '';
-      const prompt = startTunnelTemplate.replace('{{userMessage}}', userMessage);
-
-      const portResponse = await runtime.useModel(ModelType.TEXT_SMALL, {
-        prompt,
-        temperature: 0.3,
-      });
-
-      let port = 3000; // default
-      try {
-        const parsed = JSON.parse(portResponse);
-        if (parsed.port) {
-          // Handle both number and string port values
-          const portNum = typeof parsed.port === 'string' ? parseInt(parsed.port, 10) : parsed.port;
-          if (!Number.isNaN(portNum) && portNum > 0 && portNum <= 65535) {
-            port = portNum;
-          }
-        }
-      } catch {
-        // Try to extract port from plain text response
-        const portMatch = portResponse.match(/\b(\d{1,5})\b/);
-        if (portMatch) {
-          const portNum = parseInt(portMatch[1], 10);
-          if (!Number.isNaN(portNum) && portNum > 0 && portNum <= 65535) {
-            port = portNum;
-          }
-        }
-        elizaLogger.warn('Failed to parse port from response, using default 3000');
-      }
-
-      const url = await tunnelService.startTunnel(port);
-
-      const responseText = `✅ Ngrok tunnel started successfully!\n\n🌐 Public URL: ${url}\n🔌 Local Port: ${port}\n\nYour local service is now accessible from the internet.`;
-
-      if (callback) {
-        await callback({
-          text: responseText,
-          metadata: {
-            tunnelUrl: url,
-            port,
-            action: 'tunnel_started',
-          },
-        });
-      }
-
-      return {
-        success: true,
-        text: responseText,
-        values: {
-          success: true,
-          tunnelUrl: url ?? null,
-          port,
-          isActive: true,
-        },
-        data: {
-          action: 'START_TUNNEL',
-          tunnelMetadata: {
-            url: url ?? null,
-            port,
-            startedAt: new Date().toISOString(),
-            provider: 'ngrok',
-          },
-        },
-      };
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      const stack = error instanceof Error ? (error.stack ?? null) : null;
-      elizaLogger.error(`Failed to start tunnel: ${message}`);
-
-      if (callback) {
-        await callback({
-          text: `❌ Failed to start ngrok tunnel: ${message}\n\nPlease make sure ngrok is installed and configured properly.`,
-          metadata: {
-            error: message,
-            action: 'tunnel_failed',
-          },
-        });
-      }
-
-      return {
-        success: false,
-        text: `❌ Failed to start ngrok tunnel: ${message}\n\nPlease make sure ngrok is installed and configured properly.`,
-        values: {
-          success: false,
-          error: message,
-        },
-        data: {
-          action: 'START_TUNNEL',
-          errorType: 'tunnel_start_failed',
-          errorDetails: stack,
-        },
-      };
-    }
-  },
-  examples: [
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Start an ngrok tunnel on port 8080',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: '✅ Ngrok tunnel started successfully!\n\n🌐 Public URL: https://abc123.ngrok.io\n🔌 Local Port: 8080\n\nYour local service is now accessible from the internet.',
-          actions: ['START_TUNNEL'],
-        },
-      },
-    ],
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Create a tunnel for my API server and then test the webhook endpoint',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: "I'll start an ngrok tunnel for your API server and then test the webhook endpoint.",
-          thought:
-            'User wants to expose their API server and test webhooks - I should create the tunnel first, then use the public URL for webhook testing.',
-          actions: ['START_TUNNEL'],
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: '✅ Ngrok tunnel started successfully!\n\n🌐 Public URL: https://xyz789.ngrok.io\n🔌 Local Port: 3000\n\nNow testing the webhook endpoint...',
-          thought:
-            'Tunnel is active and I have the public URL. I can now test the webhook endpoint using this external URL.',
-          actions: ['TEST_WEBHOOK'],
-        },
-      },
-    ],
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Start tunnel on port 4000 and share the link in our team chat',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: "I'll start the ngrok tunnel on port 4000 and then share the public URL with your team.",
-          thought:
-            'User wants to expose their local service and share the link - I need to start the tunnel first, then send a message with the URL.',
-          actions: ['START_TUNNEL'],
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: '✅ Ngrok tunnel started successfully on port 4000! Now sharing the link with your team.',
-          thought:
-            'Tunnel is up and running. I can now send a message to the team chat with the public URL.',
-          actions: ['SEND_MESSAGE'],
-        },
-      },
-    ],
-  ] as ActionExample[][],
-};
-
-export default startTunnelAction;

package/src/actions/stop-tunnel.ts

@@ -1,203 +0,0 @@
-import {
-  type Action,
-  type ActionExample,
-  type ActionResult,
-  elizaLogger,
-  type HandlerCallback,
-  type IAgentRuntime,
-  type Memory,
-  type State,
-} from '@elizaos/core';
-import { getTunnelService } from '@elizaos/plugin-tunnel';
-
-export const stopTunnelAction: Action = {
-  name: 'STOP_TUNNEL',
-  similes: ['CLOSE_TUNNEL', 'SHUTDOWN_TUNNEL', 'NGROK_STOP', 'TUNNEL_DOWN'],
-  description:
-    'Stop the running ngrok tunnel and clean up resources. Can be chained with START_TUNNEL actions for tunnel rotation workflows or combined with deployment actions for automated service management.',
-  validate: async (runtime: IAgentRuntime, _message: Memory) => {
-    return !!getTunnelService(runtime);
-  },
-  handler: async (
-    runtime: IAgentRuntime,
-    _message: Memory,
-    _state?: State,
-    _options?: unknown,
-    callback?: HandlerCallback
-  ): Promise<ActionResult> => {
-    const tunnelService = getTunnelService(runtime);
-    if (!tunnelService) {
-      elizaLogger.error('Tunnel service is not available');
-      if (callback) {
-        await callback({
-          text: 'Tunnel service is not available. Please ensure the ngrok plugin is properly configured.',
-        });
-      }
-      return {
-        success: false,
-        text: 'Tunnel service is not available. Please ensure the ngrok plugin is properly configured.',
-        values: { success: false, error: 'service_unavailable' },
-        data: { action: 'STOP_TUNNEL' },
-      };
-    }
-
-    if (!tunnelService.isActive()) {
-      elizaLogger.warn('No active tunnel to stop');
-      if (callback) {
-        await callback({
-          text: 'No tunnel is currently running.',
-          metadata: {
-            action: 'tunnel_not_active',
-          },
-        });
-      }
-      return {
-        success: true,
-        text: 'No tunnel is currently running.',
-        values: { success: true, wasActive: false },
-        data: { action: 'STOP_TUNNEL', status: 'already_stopped' },
-      };
-    }
-
-    elizaLogger.info('Stopping ngrok tunnel...');
-
-    try {
-      const status = tunnelService.getStatus();
-      const previousUrl = status.url;
-      const previousPort = status.port;
-
-      await tunnelService.stopTunnel();
-
-      const responseText = `✅ Ngrok tunnel stopped successfully!\n\n🔌 Was running on port: ${previousPort}\n🌐 Previous URL: ${previousUrl}\n\nThe tunnel has been closed and is no longer accessible.`;
-
-      if (callback) {
-        await callback({
-          text: responseText,
-          metadata: {
-            previousUrl,
-            previousPort,
-            action: 'tunnel_stopped',
-          },
-        });
-      }
-
-      return {
-        success: true,
-        text: responseText,
-        values: {
-          success: true,
-          wasActive: true,
-          previousUrl,
-          previousPort,
-        },
-        data: {
-          action: 'STOP_TUNNEL',
-          previousTunnelMetadata: {
-            url: previousUrl,
-            port: previousPort,
-            stoppedAt: new Date().toISOString(),
-          },
-        },
-      };
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      const stack = error instanceof Error ? (error.stack ?? null) : null;
-      elizaLogger.error(`Failed to stop tunnel: ${message}`);
-
-      if (callback) {
-        await callback({
-          text: `❌ Failed to stop ngrok tunnel: ${message}`,
-          metadata: {
-            error: message,
-            action: 'tunnel_stop_failed',
-          },
-        });
-      }
-
-      return {
-        success: false,
-        text: `❌ Failed to stop ngrok tunnel: ${message}`,
-        values: {
-          success: false,
-          error: message,
-        },
-        data: {
-          action: 'STOP_TUNNEL',
-          errorType: 'tunnel_stop_failed',
-          errorDetails: stack,
-        },
-      };
-    }
-  },
-  examples: [
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Stop the ngrok tunnel',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: '✅ Ngrok tunnel stopped successfully!\n\n🔌 Was running on port: 3000\n🌐 Previous URL: https://abc123.ngrok.io\n\nThe tunnel has been closed and is no longer accessible.',
-          actions: ['STOP_TUNNEL'],
-        },
-      },
-    ],
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Stop the current tunnel and start a new one on port 8080',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: "I'll stop the current tunnel and then start a new one on port 8080.",
-          thought:
-            'User wants to switch tunnels - I need to stop the current one first, then start a new tunnel on the specified port.',
-          actions: ['STOP_TUNNEL'],
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: '✅ Tunnel stopped successfully! Now starting new tunnel on port 8080...',
-          thought:
-            'Current tunnel is closed. Now I can start the new tunnel on port 8080 as requested.',
-          actions: ['START_TUNNEL'],
-        },
-      },
-    ],
-    [
-      {
-        name: '{{user}}',
-        content: {
-          text: 'Close the tunnel and deploy to production',
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: "I'll stop the development tunnel and then proceed with the production deployment.",
-          thought:
-            'User is ready to move from development to production - I should close the ngrok tunnel first, then handle the deployment process.',
-          actions: ['STOP_TUNNEL'],
-        },
-      },
-      {
-        name: '{{agent}}',
-        content: {
-          text: 'Development tunnel closed successfully. Now initiating production deployment...',
-          thought:
-            'Tunnel is down, development phase is complete. I can now proceed with the production deployment workflow.',
-          actions: ['DEPLOY_PRODUCTION'],
-        },
-      },
-    ],
-  ] as ActionExample[][],
-};
-
-export default stopTunnelAction;