@meetopenbot/firecrawl 1.0.2 → 1.0.4

package/dist/index.js

@@ -1,34 +1,63 @@
-// index.ts
-var FIRECRAWL_API_URL = globalThis?.process?.env?.FIRECRAWL_API_URL || "https://api.firecrawl.dev";
+// node_modules/@meetopenbot/plugin-sdk/dist/plugin.js
+function definePlugin(definition) {
+  return definition;
+}
+
+// node_modules/@meetopenbot/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 buildApiKeyWidget = (agentId, threadId, reason) => ({
-  type: "client:ui:widget",
-  data: {
-    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: "FIRECRAWL_API_KEY",
-      source: "firecrawl"
-    }
-  },
-  meta: { agentId, threadId }
-});
+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/client.ts
 async function firecrawlRequest(apiKey, apiUrl, path, init = { method: "GET" }) {
   const res = await fetch(`${apiUrl.replace(/\/$/, "")}${path}`, {
     method: init.method,
@@ -45,153 +74,233 @@ async function firecrawlRequest(apiKey, apiUrl, path, init = { method: "GET" })
     payload = null;
   }
   if (!res.ok) {
-    const message = payload?.error || payload?.message || `Firecrawl request failed (${res.status} ${res.statusText})`;
+    const errorPayload = payload;
+    const message = errorPayload?.error || errorPayload?.message || `Firecrawl request failed (${res.status} ${res.statusText})`;
     const err = new Error(message);
     err.status = res.status;
     throw err;
   }
   return payload;
 }
-var firecrawlPlugin = (options = {}) => (builder) => {
-  const { storage } = options;
-  const env = globalThis?.process?.env || {};
-  const apiUrl = options.apiUrl || env.FIRECRAWL_API_URL || FIRECRAWL_API_URL;
-  const getApiKey = () => options.apiKey ?? env.FIRECRAWL_API_KEY;
-  builder.on("agent:invoke", async function* (event, ctx) {
-    const { content } = event.data ?? {};
-    const threadId = event.meta?.threadId || ctx.state.threadId;
-    if (!content) {
-      yield { type: "agent:output", data: { content: "No prompt provided." } };
-      return;
+
+// 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"
     }
-    const apiKey = getApiKey();
-    if (!apiKey) {
-      yield buildApiKeyWidget(ctx.state.agentId, threadId);
-      return;
+  }
+});
+
+// src/index.ts
+var plugin = definePlugin({
+  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
+      }
     }
-    try {
-      yield { type: "agent:output", data: { content: "Starting Firecrawl agent..." } };
-      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(ctx.state.agentId, threadId, errMsg);
-        } else {
-          yield {
-            type: "agent:output",
-            data: { content: `Error starting Firecrawl agent: ${errMsg}` }
-          };
-        }
+  },
+  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;
       }
-      yield {
-        type: "agent:output",
-        data: { content: `Firecrawl agent task created (id: ${started.id}). Waiting for results...` }
-      };
-      const startTime = Date.now();
-      let lastStatus = "";
-      while (true) {
-        if (Date.now() - startTime > POLL_TIMEOUT_MS) {
-          yield {
-            type: "agent:output",
-            data: { content: `Firecrawl agent timed out after ${Math.round(POLL_TIMEOUT_MS / 1e3)}s.` }
-          };
+      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;
         }
-        const status = await firecrawlRequest(
-          apiKey,
-          apiUrl,
-          `/v2/agent/${started.id}`
-        );
-        if (status.status === "completed") {
-          yield { type: "agent:output", data: { content: "Firecrawl agent completed successfully." } };
-          yield {
-            type: "agent:output",
-            data: { content: "```json\n" + JSON.stringify(status.data ?? {}, null, 2) + "\n```" }
-          };
+        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
+          });
+        }
+      }
+    });
+    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;
         }
-        if (status.status === "failed" || status.status === "cancelled") {
-          yield {
-            type: "agent:output",
-            data: {
-              content: `Firecrawl agent ${status.status}: ${status.error || "no details provided"}`
-            }
-          };
+        const apiKey = values?.apiKey;
+        if (typeof apiKey !== "string" || !apiKey) {
           return;
         }
-        if (status.status && status.status !== lastStatus) {
-          yield { type: "agent:output", data: { content: `Status: ${status.status}...` } };
-          lastStatus = status.status;
+        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 }
+          });
         }
-        await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS));
-      }
-    } catch (error) {
-      const message = error?.message || "Firecrawl request failed.";
-      if (isAuthError(message)) {
-        yield buildApiKeyWidget(ctx.state.agentId, threadId, message);
-      } else {
-        yield { type: "agent:output", data: { content: `Error: ${message}` } };
       }
-    }
-  });
-  builder.on("client:ui:widget:response", async function* (event, context) {
-    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 : "FIRECRAWL_API_KEY";
-    if (!storage) {
-      yield {
-        type: "agent:output",
-        data: { content: "[firecrawl] no storage available; cannot persist API key." },
-        meta: { agentId: context.state.agentId }
-      };
-      return;
-    }
-    try {
-      await storage.createVariable({ key: envVar, value: apiKey, secret: true });
-      env[envVar] = apiKey;
-      yield {
-        type: "client:ui:widget",
-        data: {
-          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: context.state.agentId }
-      };
-      yield {
-        type: "agent:output",
-        data: {
-          content: "Saved Firecrawl API key to workspace variables. Re-send your last message to retry."
-        },
-        meta: { agentId: context.state.agentId }
-      };
-    } catch (error) {
-      const errorMessage = error instanceof Error ? error.message : String(error);
-      yield {
-        type: "agent:output",
-        data: { content: `[firecrawl] failed to save API key: ${errorMessage}` },
-        meta: { agentId: context.state.agentId }
-      };
-    }
-  });
-};
-var plugin = {
-  id: "firecrawl",
-  name: "Firecrawl",
-  description: "Firecrawl agent for web data gathering",
-  kind: "runtime",
-  factory: (options) => firecrawlPlugin(options)
-};
+    );
+  }
+});
+var src_default = plugin;
 export {
-  firecrawlPlugin,
-  plugin
+  src_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meetopenbot/firecrawl",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "description": "Firecrawl agent plugin for OpenBot",
   "main": "./dist/index.js",
@@ -14,7 +14,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "esbuild index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js",
+    "build": "esbuild src/index.ts --bundle --platform=node --target=node18 --format=esm --outfile=dist/index.js",
     "prepublishOnly": "npm run build"
   },
   "engines": {
@@ -23,5 +23,8 @@
   "devDependencies": {
     "@types/node": "^20.10.1",
     "esbuild": "^0.21.0"
+  },
+  "dependencies": {
+    "@meetopenbot/plugin-sdk": "^0.1.1"
   }
 }