@meetopenbot/firecrawl 1.0.5 → 1.0.7

package/dist/index.js

@@ -1,61 +1,5 @@
-// ../plugin-sdk/dist/plugin.js
-function definePlugin(definition) {
-  return definition;
-}
-
-// ../plugin-sdk/dist/helpers.js
-function shouldHandleInvoke(event, agentId) {
-  const routedTo = event.data?.agentId;
-  return !(typeof routedTo === "string" && routedTo && routedTo !== agentId);
-}
-function agentOutput(args) {
-  return {
-    type: "agent:output",
-    data: { content: args.content },
-    meta: {
-      ...args.meta ?? {},
-      agentId: args.agentId,
-      ...args.threadId ? { threadId: args.threadId } : {}
-    }
-  };
-}
-function uiWidget(args) {
-  return {
-    type: "client:ui:widget",
-    data: args.widget,
-    meta: {
-      ...args.meta ?? {},
-      agentId: args.agentId,
-      ...args.threadId ? { threadId: args.threadId } : {}
-    }
-  };
-}
-
-// src/constants.ts
-var DEFAULT_API_URL = "https://api.firecrawl.dev";
-var POLL_INTERVAL_MS = 3e3;
-var POLL_TIMEOUT_MS = 5 * 60 * 1e3;
-var API_KEY_ENV_VAR = "FIRECRAWL_API_KEY";
-
-// src/utils.ts
-var readEnv = () => globalThis.process?.env ?? {};
-var resolveApiUrl = (config) => {
-  const configured = config.apiUrl;
-  if (typeof configured === "string" && configured.trim()) {
-    return configured.trim();
-  }
-  const envUrl = readEnv().FIRECRAWL_API_URL;
-  return envUrl?.trim() || DEFAULT_API_URL;
-};
-var resolveApiKey = (config) => {
-  const configured = config.apiKey;
-  if (typeof configured === "string" && configured.trim()) {
-    return configured.trim();
-  }
-  const envKey = readEnv()[API_KEY_ENV_VAR];
-  return envKey?.trim() || void 0;
-};
-var isAuthError = (message) => !!message && (/unauthor/i.test(message) || /api[\s-]?key/i.test(message) || /401|403/.test(message));
+// src/index.ts
+import { defineAgentPlugin, missingSecretMessage } from "@meetopenbot/plugin-sdk";
 
 // src/client.ts
 async function firecrawlRequest(apiKey, apiUrl, path, init = { method: "GET" }) {
@@ -83,224 +27,70 @@ async function firecrawlRequest(apiKey, apiUrl, path, init = { method: "GET" })
   return payload;
 }
 
-// src/ui.ts
-var buildApiKeyWidget = (agentId, threadId, reason) => uiWidget({
-  agentId,
-  threadId,
-  widget: {
-    kind: "form",
-    widgetId: `firecrawl_api_key_request_${Date.now()}`,
-    title: "Firecrawl API Key Required",
-    description: `Firecrawl could not authenticate${reason ? ` (${reason})` : ""}. Provide a Firecrawl API key to continue. The key is stored as a workspace variable on your machine and never leaves your local runtime.`,
-    fields: [
-      {
-        id: "apiKey",
-        label: "API Key",
-        type: "text",
-        placeholder: "fc-...",
-        required: true
-      }
-    ],
-    submitLabel: "Save API Key",
-    metadata: {
-      type: "api_key_request",
-      provider: "firecrawl",
-      envVar: API_KEY_ENV_VAR,
-      source: "firecrawl"
+// src/config.ts
+import { lookupSecret } from "@meetopenbot/plugin-sdk";
+var DEFAULT_API_URL = "https://api.firecrawl.dev";
+var POLL_INTERVAL_MS = 3e3;
+var POLL_TIMEOUT_MS = 5 * 60 * 1e3;
+var API_KEY_ENV_VAR = "FIRECRAWL_API_KEY";
+var resolveApiUrl = () => process.env.FIRECRAWL_API_URL?.trim() || DEFAULT_API_URL;
+var resolveApiKey = () => lookupSecret({ envKeys: [API_KEY_ENV_VAR] });
+
+// src/agent.ts
+function resultText(data) {
+  if (data == null) return "Done.";
+  if (typeof data === "string") return data;
+  try {
+    return JSON.stringify(data, null, 2);
+  } catch {
+    return String(data);
+  }
+}
+async function runFirecrawlAgent(args) {
+  const started = await firecrawlRequest(args.apiKey, args.apiUrl, "/v2/agent", {
+    method: "POST",
+    body: { prompt: args.prompt }
+  });
+  if (!started?.success || !started.id) {
+    return started?.error || "Failed to start Firecrawl agent.";
+  }
+  const startTime = Date.now();
+  while (true) {
+    if (Date.now() - startTime > POLL_TIMEOUT_MS) {
+      return `Timed out after ${Math.round(POLL_TIMEOUT_MS / 1e3)}s.`;
+    }
+    const status = await firecrawlRequest(
+      args.apiKey,
+      args.apiUrl,
+      `/v2/agent/${started.id}`
+    );
+    if (status.status === "completed") {
+      return resultText(status.data);
+    }
+    if (status.status === "failed" || status.status === "cancelled") {
+      return `Agent ${status.status}: ${status.error || "no details provided"}`;
     }
+    await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS));
   }
-});
+}
 
 // src/index.ts
-var plugin = definePlugin({
+var plugin = await defineAgentPlugin({
   name: "Firecrawl",
   description: "Firecrawl agent for web data gathering",
-  configSchema: {
-    type: "object",
-    properties: {
-      apiKey: {
-        type: "string",
-        description: "Firecrawl API key. Falls back to the FIRECRAWL_API_KEY workspace variable.",
-        format: "password"
-      },
-      apiUrl: {
-        type: "string",
-        description: "Firecrawl API base URL.",
-        format: "url",
-        default: DEFAULT_API_URL
-      }
-    }
-  },
-  factory: (context) => (builder) => {
-    const apiUrl = resolveApiUrl(context.config);
-    const getApiKey = () => resolveApiKey(context.config);
-    builder.on("agent:invoke", async function* (event, ctx) {
-      if (!shouldHandleInvoke(event, context.agentId)) {
-        return;
-      }
-      const { content } = event.data;
-      const threadId = event.meta?.threadId ?? ctx.state.threadId;
-      if (!content) {
-        yield agentOutput({
-          agentId: context.agentId,
-          content: "No prompt provided.",
-          threadId
-        });
-        return;
-      }
-      const apiKey = getApiKey();
-      if (!apiKey) {
-        yield buildApiKeyWidget(context.agentId, threadId);
-        yield agentOutput({
-          agentId: context.agentId,
-          content: "API key required. Please provide it in the widget.",
-          threadId
-        });
-        return;
-      }
-      try {
-        yield agentOutput({
-          agentId: context.agentId,
-          content: "Starting Firecrawl agent...",
-          threadId
-        });
-        const started = await firecrawlRequest(apiKey, apiUrl, "/v2/agent", {
-          method: "POST",
-          body: { prompt: content }
-        });
-        if (!started?.success || !started.id) {
-          const errMsg = started?.error || "Unknown error";
-          if (isAuthError(errMsg)) {
-            yield buildApiKeyWidget(context.agentId, threadId, errMsg);
-            yield agentOutput({
-              agentId: context.agentId,
-              content: `Authentication failed: ${errMsg}. Please update the API key in the widget.`,
-              threadId
-            });
-          } else {
-            yield agentOutput({
-              agentId: context.agentId,
-              content: `Error starting Firecrawl agent: ${errMsg}`,
-              threadId
-            });
-          }
-          return;
-        }
-        yield agentOutput({
-          agentId: context.agentId,
-          content: `Task created (id: ${started.id}). Waiting for results...`,
-          threadId
-        });
-        const startTime = Date.now();
-        let lastStatus = "";
-        while (true) {
-          if (Date.now() - startTime > POLL_TIMEOUT_MS) {
-            yield agentOutput({
-              agentId: context.agentId,
-              content: `Timed out after ${Math.round(POLL_TIMEOUT_MS / 1e3)}s.`,
-              threadId
-            });
-            return;
-          }
-          const status = await firecrawlRequest(
-            apiKey,
-            apiUrl,
-            `/v2/agent/${started.id}`
-          );
-          if (status.status === "completed") {
-            yield agentOutput({
-              agentId: context.agentId,
-              content: "Completed successfully.",
-              threadId
-            });
-            yield agentOutput({
-              agentId: context.agentId,
-              content: "```json\n" + JSON.stringify(status.data ?? {}, null, 2) + "\n```",
-              threadId
-            });
-            return;
-          }
-          if (status.status === "failed" || status.status === "cancelled") {
-            yield agentOutput({
-              agentId: context.agentId,
-              content: `Agent ${status.status}: ${status.error || "no details provided"}`,
-              threadId
-            });
-            return;
-          }
-          if (status.status && status.status !== lastStatus) {
-            yield agentOutput({
-              agentId: context.agentId,
-              content: `Status: ${status.status}...`,
-              threadId
-            });
-            lastStatus = status.status;
-          }
-          await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS));
-        }
-      } catch (error) {
-        const message = error instanceof Error ? error.message : "Firecrawl request failed.";
-        if (isAuthError(message)) {
-          yield buildApiKeyWidget(context.agentId, threadId, message);
-          yield agentOutput({
-            agentId: context.agentId,
-            content: `Authentication failed: ${message}. Please update the API key in the widget.`,
-            threadId
-          });
-        } else {
-          yield agentOutput({
-            agentId: context.agentId,
-            content: `Error: ${message}`,
-            threadId
-          });
-        }
-      }
+  emptyPrompt: "No prompt provided.",
+  async run({ prompt }) {
+    const apiKey = resolveApiKey();
+    if (!apiKey) return missingSecretMessage(API_KEY_ENV_VAR);
+    return runFirecrawlAgent({
+      prompt,
+      apiKey,
+      apiUrl: resolveApiUrl()
     });
-    builder.on(
-      "client:ui:widget:response",
-      async function* (event, handlerCtx) {
-        const { metadata, values, widgetId } = event.data;
-        if (!metadata || metadata.type !== "api_key_request" || metadata.source !== "firecrawl") {
-          return;
-        }
-        const apiKey = values?.apiKey;
-        if (typeof apiKey !== "string" || !apiKey) {
-          return;
-        }
-        const envVar = typeof metadata.envVar === "string" && metadata.envVar.trim() ? metadata.envVar : API_KEY_ENV_VAR;
-        try {
-          await context.storage.createVariable({ key: envVar, value: apiKey, secret: true });
-          readEnv()[envVar] = apiKey;
-          yield uiWidget({
-            agentId: context.agentId,
-            widget: {
-              widgetId,
-              kind: "message",
-              title: "API Key Saved",
-              body: `Saved ${envVar} as a workspace variable. You can now continue the conversation.`,
-              state: "submitted",
-              actions: [{ id: "ok", label: "Got it", variant: "primary" }]
-            },
-            meta: { agentId: handlerCtx.state.agentId }
-          });
-          yield agentOutput({
-            agentId: context.agentId,
-            content: "API key saved to workspace variables. Re-send your last message to retry.",
-            meta: { agentId: handlerCtx.state.agentId }
-          });
-        } catch (error) {
-          const errorMessage = error instanceof Error ? error.message : String(error);
-          yield agentOutput({
-            agentId: context.agentId,
-            content: `Failed to save API key: ${errorMessage}`,
-            meta: { agentId: handlerCtx.state.agentId }
-          });
-        }
-      }
-    );
   }
 });
 var src_default = plugin;
 export {
-  src_default as default
+  src_default as default,
+  plugin
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meetopenbot/firecrawl",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "type": "module",
   "description": "Firecrawl agent plugin for OpenBot",
   "main": "./dist/index.js",
@@ -25,12 +25,12 @@
     "esbuild": "^0.21.0"
   },
   "dependencies": {
-    "@meetopenbot/plugin-sdk": "^0.2.0"
+    "@meetopenbot/plugin-sdk": "^0.4.0"
   },
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "esbuild src/index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js && node ../../scripts/write-plugin-declaration.mjs",
-    "dev": "esbuild src/index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js --watch",
-    "typecheck": "tsc --noEmit --allowImportingTsExtensions --module ESNext --moduleResolution Bundler --target ES2022 --skipLibCheck src/index.ts"
+    "build": "esbuild src/index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js --external:@meetopenbot/plugin-sdk && node ../../scripts/write-plugin-declaration.mjs",
+    "dev": "esbuild src/index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js --external:@meetopenbot/plugin-sdk --watch",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }