add output fields to other plugins (#103)

ctate · web-flow · commit 41e10a57c7c0 · 2025-12-02T02:18:27.000-06:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -457,6 +457,11 @@ const myIntegrationPlugin: IntegrationPlugin = {
       category: "My Integration",
       stepFunction: "sendMessageStep",
       stepImportPath: "send-message",
+      // Output fields for template autocomplete (what this action returns)
+      outputFields: [
+        { field: "id", description: "Message ID" },
+        { field: "url", description: "Message URL" },
+      ],
       // Declarative config fields (not React components)
       configFields: [
         {
@@ -490,7 +495,22 @@ export default myIntegrationPlugin;
 2. **envVar**: Maps formField to environment variable (auto-generates credential mapping)
 3. **getTestFunction**: Lazy-loads test function to avoid bundling server code
 4. **slug**: Action identifier (full ID becomes `my-integration/send-message`)
-5. **configFields**: Declarative array defining UI fields (not React components)
+5. **outputFields**: Defines what fields the action returns (for template autocomplete)
+6. **configFields**: Declarative array defining UI fields (not React components)
+
+**Output Fields:**
+
+The `outputFields` array defines what fields the action returns, enabling autocomplete when referencing this action's output in subsequent steps:
+
+```typescript
+outputFields: [
+  { field: "id", description: "Message ID" },
+  { field: "url", description: "Message URL" },
+  { field: "items", description: "Array of items" }, // For arrays, just use the array name
+],
+```
+
+These fields appear in the template variable dropdown when users type `@` in a template input field. The `field` should match the property names in your step's return type.
 
 **Supported configField types:**
 - `template-input`: Single-line input with `{{variable}}` support
@@ -594,6 +614,10 @@ actions: [
     category: "My Integration",
     stepFunction: "sendMessageStep",
     stepImportPath: "send-message",
+    outputFields: [
+      { field: "id", description: "Message ID" },
+      { field: "timestamp", description: "Send timestamp" },
+    ],
     configFields: [
       { key: "message", label: "Message", type: "template-input" },
       { key: "channel", label: "Channel", type: "text" },
@@ -606,6 +630,10 @@ actions: [
     category: "My Integration",
     stepFunction: "createRecordStep",
     stepImportPath: "create-record",
+    outputFields: [
+      { field: "id", description: "Record ID" },
+      { field: "url", description: "Record URL" },
+    ],
     configFields: [
       { key: "title", label: "Title", type: "template-input", required: true },
       { key: "description", label: "Description", type: "template-textarea" },
diff --git a/components/ui/template-autocomplete.tsx b/components/ui/template-autocomplete.tsx
@@ -111,44 +111,16 @@ const isActionType = (
 const getCommonFields = (node: WorkflowNode) => {
   const actionType = node.data.config?.actionType as string | undefined;
 
-  // First, check if the plugin defines output fields
-  if (actionType) {
-    const action = findActionById(actionType);
-    if (action?.outputFields && action.outputFields.length > 0) {
-      return action.outputFields;
-    }
-  }
-
-  // Legacy hardcoded fields for backwards compatibility
-  if (isActionType(actionType, "Find Issues", "linear/find-issues")) {
-    return [
-      { field: "issues", description: "Array of issues found" },
-      { field: "count", description: "Number of issues" },
-    ];
-  }
-  if (isActionType(actionType, "Send Email", "resend/send-email")) {
-    return [
-      { field: "id", description: "Email ID" },
-      { field: "status", description: "Send status" },
-    ];
-  }
-  if (isActionType(actionType, "Create Ticket", "linear/create-ticket")) {
-    return [
-      { field: "id", description: "Ticket ID" },
-      { field: "url", description: "Ticket URL" },
-      { field: "number", description: "Ticket number" },
-    ];
-  }
+  // Special handling for dynamic outputs (system actions and schema-based)
   if (actionType === "HTTP Request") {
     return [
       { field: "data", description: "Response data" },
       { field: "status", description: "HTTP status code" },
     ];
   }
+
   if (actionType === "Database Query") {
     const dbSchema = node.data.config?.dbSchema as string | undefined;
-
-    // If schema is defined, show schema fields
     if (dbSchema) {
       try {
         const schema = JSON.parse(dbSchema) as SchemaField[];
@@ -159,18 +131,17 @@ const getCommonFields = (node: WorkflowNode) => {
         // If schema parsing fails, fall through to default fields
       }
     }
-
-    // Default fields when no schema
     return [
       { field: "rows", description: "Query result rows" },
       { field: "count", description: "Number of rows" },
     ];
   }
+
+  // AI Gateway generate-text has dynamic output based on format/schema
   if (isActionType(actionType, "Generate Text", "ai-gateway/generate-text")) {
     const aiFormat = node.data.config?.aiFormat as string | undefined;
     const aiSchema = node.data.config?.aiSchema as string | undefined;
 
-    // If format is object and schema is defined, show schema fields under "object" prefix
     if (aiFormat === "object" && aiSchema) {
       try {
         const schema = JSON.parse(aiSchema) as SchemaField[];
@@ -181,59 +152,22 @@ const getCommonFields = (node: WorkflowNode) => {
         // If schema parsing fails, fall through to default fields
       }
     }
-
-    // Default fields for text format or when no schema
-    return [
-      { field: "text", description: "Generated text" },
-      { field: "model", description: "Model used" },
-    ];
+    return [{ field: "text", description: "Generated text" }];
   }
-  if (isActionType(actionType, "Generate Image", "ai-gateway/generate-image")) {
-    return [
-      { field: "base64", description: "Base64 image data" },
-      { field: "model", description: "Model used" },
-    ];
-  }
-  if (
-    isActionType(actionType, "Scrape", "Scrape URL", "firecrawl/scrape")
-  ) {
-    return [
-      { field: "markdown", description: "Scraped content as markdown" },
-      { field: "metadata.url", description: "Page URL" },
-      { field: "metadata.title", description: "Page title" },
-      { field: "metadata.description", description: "Page description" },
-      { field: "metadata.language", description: "Page language" },
-      { field: "metadata.favicon", description: "Favicon URL" },
-    ];
-  }
-  if (isActionType(actionType, "Search", "Search Web", "firecrawl/search")) {
-    return [{ field: "web", description: "Array of search results" }];
-  }
-  if (isActionType(actionType, "Create Chat", "v0/create-chat")) {
-    return [
-      { field: "chatId", description: "v0 chat ID" },
-      { field: "url", description: "v0 chat URL" },
-      { field: "demoUrl", description: "Demo preview URL" },
-    ];
-  }
-  if (isActionType(actionType, "Send Message", "v0/send-message")) {
-    return [
-      { field: "chatId", description: "v0 chat ID" },
-      { field: "demoUrl", description: "Demo preview URL" },
-    ];
-  }
-  if (isActionType(actionType, "Send Slack Message", "slack/send-message")) {
-    return [
-      { field: "ok", description: "Success status" },
-      { field: "ts", description: "Message timestamp" },
-      { field: "channel", description: "Channel ID" },
-    ];
+
+  // Check if the plugin defines output fields
+  if (actionType) {
+    const action = findActionById(actionType);
+    if (action?.outputFields && action.outputFields.length > 0) {
+      return action.outputFields;
+    }
   }
+
+  // Trigger fields
   if (node.data.type === "trigger") {
     const triggerType = node.data.config?.triggerType as string | undefined;
     const webhookSchema = node.data.config?.webhookSchema as string | undefined;
 
-    // If it's a webhook trigger with a schema, show schema fields
     if (triggerType === "Webhook" && webhookSchema) {
       try {
         const schema = JSON.parse(webhookSchema) as SchemaField[];
@@ -245,7 +179,6 @@ const getCommonFields = (node: WorkflowNode) => {
       }
     }
 
-    // Default trigger fields
     return [
       { field: "triggered", description: "Trigger status" },
       { field: "timestamp", description: "Trigger timestamp" },
diff --git a/plugins/ai-gateway/index.ts b/plugins/ai-gateway/index.ts
@@ -112,6 +112,7 @@ const aiGatewayPlugin: IntegrationPlugin = {
       category: "AI Gateway",
       stepFunction: "generateImageStep",
       stepImportPath: "generate-image",
+      outputFields: [{ field: "base64", description: "Base64-encoded image data" }],
       configFields: [
         {
           key: "imageModel",
diff --git a/plugins/firecrawl/index.ts b/plugins/firecrawl/index.ts
@@ -40,6 +40,10 @@ const firecrawlPlugin: IntegrationPlugin = {
       category: "Firecrawl",
       stepFunction: "firecrawlScrapeStep",
       stepImportPath: "scrape",
+      outputFields: [
+        { field: "markdown", description: "Scraped content as markdown" },
+        { field: "metadata", description: "Page metadata object" },
+      ],
       configFields: [
         {
           key: "url",
@@ -58,6 +62,7 @@ const firecrawlPlugin: IntegrationPlugin = {
       category: "Firecrawl",
       stepFunction: "firecrawlSearchStep",
       stepImportPath: "search",
+      outputFields: [{ field: "data", description: "Array of search results" }],
       configFields: [
         {
           key: "query",
diff --git a/plugins/linear/index.ts b/plugins/linear/index.ts
@@ -50,6 +50,11 @@ const linearPlugin: IntegrationPlugin = {
       category: "Linear",
       stepFunction: "createTicketStep",
       stepImportPath: "create-ticket",
+      outputFields: [
+        { field: "id", description: "Ticket ID" },
+        { field: "url", description: "Ticket URL" },
+        { field: "title", description: "Ticket title" },
+      ],
       configFields: [
         {
           key: "ticketTitle",
@@ -90,6 +95,10 @@ const linearPlugin: IntegrationPlugin = {
       category: "Linear",
       stepFunction: "findIssuesStep",
       stepImportPath: "find-issues",
+      outputFields: [
+        { field: "issues", description: "Array of issues found" },
+        { field: "count", description: "Number of issues" },
+      ],
       configFields: [
         {
           key: "linearAssigneeId",
diff --git a/plugins/resend/index.ts b/plugins/resend/index.ts
@@ -49,6 +49,7 @@ const resendPlugin: IntegrationPlugin = {
       category: "Resend",
       stepFunction: "sendEmailStep",
       stepImportPath: "send-email",
+      outputFields: [{ field: "id", description: "Email ID" }],
       configFields: [
         {
           key: "emailFrom",
diff --git a/plugins/slack/index.ts b/plugins/slack/index.ts
@@ -40,6 +40,10 @@ const slackPlugin: IntegrationPlugin = {
       category: "Slack",
       stepFunction: "sendSlackMessageStep",
       stepImportPath: "send-slack-message",
+      outputFields: [
+        { field: "ts", description: "Message timestamp" },
+        { field: "channel", description: "Channel ID" },
+      ],
       configFields: [
         {
           key: "slackChannel",
diff --git a/plugins/superagent/index.ts b/plugins/superagent/index.ts
@@ -41,6 +41,12 @@ const superagentPlugin: IntegrationPlugin = {
       category: "Superagent",
       stepFunction: "superagentGuardStep",
       stepImportPath: "guard",
+      outputFields: [
+        { field: "classification", description: "Threat classification" },
+        { field: "violationTypes", description: "Array of violation types" },
+        { field: "cweCodes", description: "Array of CWE codes" },
+        { field: "reasoning", description: "Analysis reasoning" },
+      ],
       configFields: [
         {
           key: "text",
@@ -61,6 +67,10 @@ const superagentPlugin: IntegrationPlugin = {
       category: "Superagent",
       stepFunction: "superagentRedactStep",
       stepImportPath: "redact",
+      outputFields: [
+        { field: "redactedText", description: "Text with PII redacted" },
+        { field: "reasoning", description: "Redaction reasoning" },
+      ],
       configFields: [
         {
           key: "text",
diff --git a/plugins/v0/index.ts b/plugins/v0/index.ts
@@ -42,6 +42,11 @@ const v0Plugin: IntegrationPlugin = {
       category: "v0",
       stepFunction: "createChatStep",
       stepImportPath: "create-chat",
+      outputFields: [
+        { field: "chatId", description: "v0 chat ID" },
+        { field: "url", description: "v0 chat URL" },
+        { field: "demoUrl", description: "Demo preview URL" },
+      ],
       configFields: [
         {
           key: "message",
@@ -68,6 +73,10 @@ const v0Plugin: IntegrationPlugin = {
       category: "v0",
       stepFunction: "sendMessageStep",
       stepImportPath: "send-message",
+      outputFields: [
+        { field: "chatId", description: "v0 chat ID" },
+        { field: "demoUrl", description: "Demo preview URL" },
+      ],
       configFields: [
         {
           key: "chatId",

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ const aiGatewayPlugin: IntegrationPlugin = {`
`112`	`112`	`category: "AI Gateway",`
`113`	`113`	`stepFunction: "generateImageStep",`
`114`	`114`	`stepImportPath: "generate-image",`
	`115`	`+ outputFields: [{ field: "base64", description: "Base64-encoded image data" }],`
`115`	`116`	`configFields: [`
`116`	`117`	`{`
`117`	`118`	`key: "imageModel",`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ const resendPlugin: IntegrationPlugin = {`
`49`	`49`	`category: "Resend",`
`50`	`50`	`stepFunction: "sendEmailStep",`
`51`	`51`	`stepImportPath: "send-email",`
	`52`	`+ outputFields: [{ field: "id", description: "Email ID" }],`
`52`	`53`	`configFields: [`
`53`	`54`	`{`
`54`	`55`	`key: "emailFrom",`