@mastra/browser-firecrawl 0.2.0 → 0.2.1-alpha.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-import { AgentBrowserConfig, AgentBrowser, AgentBrowserSession, AgentBrowserThreadManager, AgentBrowserThreadManagerConfig } from '@mastra/agent-browser';
-import { BrowserManager } from 'agent-browser';
-import { Firecrawl } from 'firecrawl';
-
+import { AgentBrowser, AgentBrowserConfig, AgentBrowserSession, AgentBrowserThreadManager, AgentBrowserThreadManagerConfig } from "@mastra/agent-browser";
+import { BrowserManager } from "agent-browser";
+import { Firecrawl } from "firecrawl";
+//#region src/types.d.ts
 /**
  * Options passed to Firecrawl `POST /v2/browser` (see Firecrawl JS SDK `browser()`).
  *
@@ -10,85 +10,89 @@ import { Firecrawl } from 'firecrawl';
  * hosted browser API only—different meaning, same nested key name as required by the SDK.
  */
 interface FirecrawlBrowserSessionOptions {
-    /** Max session wall-clock lifetime (seconds, Firecrawl API). */
-    ttl?: number;
-    /** Idle timeout before the sandbox recycles the session (seconds, Firecrawl API). */
-    activityTtl?: number;
-    /** When true, Firecrawl may stream WebView frames for the remote session. */
-    streamWebView?: boolean;
-    /** Firecrawl named profile (not the same as top-level `AgentBrowserConfig.profile`). */
-    profile?: {
-        /** Saved profile name in Firecrawl. */
-        name: string;
-        /** Persist profile changes when the session ends. */
-        saveChanges?: boolean;
-    };
-    /** Optional integration label for Firecrawl analytics / routing. */
-    integration?: string;
-    /** Optional origin hint for the Firecrawl browser session. */
-    origin?: string;
+  /** Max session wall-clock lifetime (seconds, Firecrawl API). */
+  ttl?: number;
+  /** Idle timeout before the sandbox recycles the session (seconds, Firecrawl API). */
+  activityTtl?: number;
+  /** When true, Firecrawl may stream WebView frames for the remote session. */
+  streamWebView?: boolean;
+  /** Firecrawl named profile (not the same as top-level `AgentBrowserConfig.profile`). */
+  profile?: {
+    /** Saved profile name in Firecrawl. */
+    name: string;
+    /** Persist profile changes when the session ends. */
+    saveChanges?: boolean;
+  };
+  /** Optional integration label for Firecrawl analytics / routing. */
+  integration?: string;
+  /** Optional origin hint for the Firecrawl browser session. */
+  origin?: string;
 }
 /** Configuration for {@link FirecrawlBrowser}. */
 type FirecrawlBrowserConfig = AgentBrowserConfig & {
-    /** Firecrawl API key (or set `FIRECRAWL_API_KEY` in the environment and omit). */
-    apiKey?: string;
-    /** Base URL for a self-hosted Firecrawl API. */
-    apiUrl?: string;
-    /**
-     * Firecrawl-only session options (`browser()`). Distinct from {@link AgentBrowserConfig.profile}
-     * (local Playwright profile path): see {@link FirecrawlBrowserSessionOptions.profile}.
-     */
-    firecrawl?: FirecrawlBrowserSessionOptions;
+  /** Firecrawl API key (or set `FIRECRAWL_API_KEY` in the environment and omit). */
+  apiKey?: string;
+  /** Base URL for a self-hosted Firecrawl API. */
+  apiUrl?: string;
+  /**
+   * Firecrawl-only session options (`browser()`). Distinct from {@link AgentBrowserConfig.profile}
+   * (local Playwright profile path): see {@link FirecrawlBrowserSessionOptions.profile}.
+   */
+  firecrawl?: FirecrawlBrowserSessionOptions;
 };
-
+//#endregion
+//#region src/firecrawl-browser.d.ts
 /**
  * Mastra browser provider backed by [Firecrawl Browser Sandbox](https://docs.firecrawl.dev/features/browser):
  * provisions remote sessions via API and drives them with the same deterministic tools as {@link AgentBrowser}.
  */
 declare class FirecrawlBrowser extends AgentBrowser {
-    readonly name = "FirecrawlBrowser";
-    readonly provider = "firecrawl/browser-sandbox";
-    /** Narrowed from base `MastraBrowser` (`unknown`) — same pattern as {@link AgentBrowser}. */
-    protected sharedManager: BrowserManager | null;
-    private readonly firecrawl;
-    private readonly sessionOpts;
-    private sharedFirecrawlSessionId?;
-    constructor(config: FirecrawlBrowserConfig);
-    protected doLaunch(): Promise<void>;
-    protected doClose(): Promise<void>;
+  readonly name = "FirecrawlBrowser";
+  readonly provider = "firecrawl/browser-sandbox";
+  /** Narrowed from base `MastraBrowser` (`unknown`) — same pattern as {@link AgentBrowser}. */
+  protected sharedManager: BrowserManager | null;
+  private readonly firecrawl;
+  private readonly sessionOpts;
+  private sharedFirecrawlSessionId?;
+  constructor(config: FirecrawlBrowserConfig);
+  protected doLaunch(): Promise<void>;
+  protected doClose(): Promise<void>;
 }
-
+//#endregion
+//#region src/firecrawl-thread-manager.d.ts
 /**
  * Thread session with Firecrawl sandbox id for cleanup.
  */
 interface FirecrawlAgentBrowserSession extends AgentBrowserSession {
-    firecrawlSessionId?: string;
+  firecrawlSessionId?: string;
 }
 interface FirecrawlAgentBrowserThreadManagerConfig extends AgentBrowserThreadManagerConfig {
-    firecrawl: Firecrawl;
-    /** Resolve HTTP CDP URL to WebSocket URL. */
-    resolveWebSocketUrl: (url: string) => Promise<string>;
-    /** Options for each `firecrawl.browser()` call (thread scope = one call per thread). */
-    sessionOptions?: FirecrawlBrowserSessionOptions;
+  firecrawl: Firecrawl;
+  /** Resolve HTTP CDP URL to WebSocket URL. */
+  resolveWebSocketUrl: (url: string) => Promise<string>;
+  /** Options for each `firecrawl.browser()` call (thread scope = one call per thread). */
+  sessionOptions?: FirecrawlBrowserSessionOptions;
 }
 /**
  * Provisions a dedicated Firecrawl Browser Sandbox session per Mastra thread and connects Playwright over CDP.
  */
 declare class FirecrawlAgentBrowserThreadManager extends AgentBrowserThreadManager {
-    private readonly firecrawl;
-    private readonly resolveWebSocketUrl;
-    private readonly sessionOptions;
-    constructor(config: FirecrawlAgentBrowserThreadManagerConfig);
-    protected createSession(threadId: string): Promise<FirecrawlAgentBrowserSession>;
-    protected doDestroySession(session: FirecrawlAgentBrowserSession): Promise<void>;
+  private readonly firecrawl;
+  private readonly resolveWebSocketUrl;
+  private readonly sessionOptions;
+  constructor(config: FirecrawlAgentBrowserThreadManagerConfig);
+  protected createSession(threadId: string): Promise<FirecrawlAgentBrowserSession>;
+  protected doDestroySession(session: FirecrawlAgentBrowserSession): Promise<void>;
 }
-
+//#endregion
+//#region src/resolve-cdp.d.ts
 /**
  * Resolve an HTTP CDP endpoint to a WebSocket URL (same behavior as MastraBrowser.resolveWebSocketUrl).
  */
 declare function resolveCdpWebSocketUrl(url: string, logger?: {
-    debug?: (message: string) => void;
-    warn?: (message: string) => void;
+  debug?: (message: string) => void;
+  warn?: (message: string) => void;
 }): Promise<string>;
-
+//#endregion
 export { type FirecrawlAgentBrowserSession, FirecrawlAgentBrowserThreadManager, type FirecrawlAgentBrowserThreadManagerConfig, FirecrawlBrowser, type FirecrawlBrowserConfig, type FirecrawlBrowserSessionOptions, resolveCdpWebSocketUrl };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/firecrawl-browser.ts","../src/firecrawl-thread-manager.ts","../src/resolve-cdp.ts"],"mappings":";;;;;;;;;;;UASiB;;EAEf;;EAEA;;EAEA;;EAEA;;IAEE;;IAEA;;;EAGF;;EAEA;;;KAIU,yBAAyB;;EAEnC;;EAEA;;;;;EAKA,YAAY;;;;;;;;cChBD,yBAAyB;WAClB;WACA;;YAGA,eAAe;mBAEhB;mBACA;UACT;EAEI,YAAA,QAAQ;YAsBK,YAAY;YAoEZ,WAAW;;;;;;;UCjHrB,qCAAqC;EACpD;;UAGe,iDAAiD;EAChE,WAAW;;EAEX,sBAAsB,gBAAgB;;EAEtC,iBAAiB;;;;;cAMN,2CAA2C;mBACrC;mBACA;mBACA;EAEL,YAAA,QAAQ;YAOK,cAAc,mBAAmB,QAAQ;YA8FzC,iBAAiB,SAAS,+BAA+B;;;;;;;iBCjI9D,uBACpB,aACA;EAAW,SAAS;EAA0B,QAAQ;IACrD"}

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { AgentBrowserConfig, AgentBrowser, AgentBrowserSession, AgentBrowserThreadManager, AgentBrowserThreadManagerConfig } from '@mastra/agent-browser';
-import { BrowserManager } from 'agent-browser';
-import { Firecrawl } from 'firecrawl';
-
+import { AgentBrowser, AgentBrowserConfig, AgentBrowserSession, AgentBrowserThreadManager, AgentBrowserThreadManagerConfig } from "@mastra/agent-browser";
+import { BrowserManager } from "agent-browser";
+import { Firecrawl } from "firecrawl";
+//#region src/types.d.ts
 /**
  * Options passed to Firecrawl `POST /v2/browser` (see Firecrawl JS SDK `browser()`).
  *
@@ -10,85 +10,89 @@ import { Firecrawl } from 'firecrawl';
  * hosted browser API only—different meaning, same nested key name as required by the SDK.
  */
 interface FirecrawlBrowserSessionOptions {
-    /** Max session wall-clock lifetime (seconds, Firecrawl API). */
-    ttl?: number;
-    /** Idle timeout before the sandbox recycles the session (seconds, Firecrawl API). */
-    activityTtl?: number;
-    /** When true, Firecrawl may stream WebView frames for the remote session. */
-    streamWebView?: boolean;
-    /** Firecrawl named profile (not the same as top-level `AgentBrowserConfig.profile`). */
-    profile?: {
-        /** Saved profile name in Firecrawl. */
-        name: string;
-        /** Persist profile changes when the session ends. */
-        saveChanges?: boolean;
-    };
-    /** Optional integration label for Firecrawl analytics / routing. */
-    integration?: string;
-    /** Optional origin hint for the Firecrawl browser session. */
-    origin?: string;
+  /** Max session wall-clock lifetime (seconds, Firecrawl API). */
+  ttl?: number;
+  /** Idle timeout before the sandbox recycles the session (seconds, Firecrawl API). */
+  activityTtl?: number;
+  /** When true, Firecrawl may stream WebView frames for the remote session. */
+  streamWebView?: boolean;
+  /** Firecrawl named profile (not the same as top-level `AgentBrowserConfig.profile`). */
+  profile?: {
+    /** Saved profile name in Firecrawl. */
+    name: string;
+    /** Persist profile changes when the session ends. */
+    saveChanges?: boolean;
+  };
+  /** Optional integration label for Firecrawl analytics / routing. */
+  integration?: string;
+  /** Optional origin hint for the Firecrawl browser session. */
+  origin?: string;
 }
 /** Configuration for {@link FirecrawlBrowser}. */
 type FirecrawlBrowserConfig = AgentBrowserConfig & {
-    /** Firecrawl API key (or set `FIRECRAWL_API_KEY` in the environment and omit). */
-    apiKey?: string;
-    /** Base URL for a self-hosted Firecrawl API. */
-    apiUrl?: string;
-    /**
-     * Firecrawl-only session options (`browser()`). Distinct from {@link AgentBrowserConfig.profile}
-     * (local Playwright profile path): see {@link FirecrawlBrowserSessionOptions.profile}.
-     */
-    firecrawl?: FirecrawlBrowserSessionOptions;
+  /** Firecrawl API key (or set `FIRECRAWL_API_KEY` in the environment and omit). */
+  apiKey?: string;
+  /** Base URL for a self-hosted Firecrawl API. */
+  apiUrl?: string;
+  /**
+   * Firecrawl-only session options (`browser()`). Distinct from {@link AgentBrowserConfig.profile}
+   * (local Playwright profile path): see {@link FirecrawlBrowserSessionOptions.profile}.
+   */
+  firecrawl?: FirecrawlBrowserSessionOptions;
 };
-
+//#endregion
+//#region src/firecrawl-browser.d.ts
 /**
  * Mastra browser provider backed by [Firecrawl Browser Sandbox](https://docs.firecrawl.dev/features/browser):
  * provisions remote sessions via API and drives them with the same deterministic tools as {@link AgentBrowser}.
  */
 declare class FirecrawlBrowser extends AgentBrowser {
-    readonly name = "FirecrawlBrowser";
-    readonly provider = "firecrawl/browser-sandbox";
-    /** Narrowed from base `MastraBrowser` (`unknown`) — same pattern as {@link AgentBrowser}. */
-    protected sharedManager: BrowserManager | null;
-    private readonly firecrawl;
-    private readonly sessionOpts;
-    private sharedFirecrawlSessionId?;
-    constructor(config: FirecrawlBrowserConfig);
-    protected doLaunch(): Promise<void>;
-    protected doClose(): Promise<void>;
+  readonly name = "FirecrawlBrowser";
+  readonly provider = "firecrawl/browser-sandbox";
+  /** Narrowed from base `MastraBrowser` (`unknown`) — same pattern as {@link AgentBrowser}. */
+  protected sharedManager: BrowserManager | null;
+  private readonly firecrawl;
+  private readonly sessionOpts;
+  private sharedFirecrawlSessionId?;
+  constructor(config: FirecrawlBrowserConfig);
+  protected doLaunch(): Promise<void>;
+  protected doClose(): Promise<void>;
 }
-
+//#endregion
+//#region src/firecrawl-thread-manager.d.ts
 /**
  * Thread session with Firecrawl sandbox id for cleanup.
  */
 interface FirecrawlAgentBrowserSession extends AgentBrowserSession {
-    firecrawlSessionId?: string;
+  firecrawlSessionId?: string;
 }
 interface FirecrawlAgentBrowserThreadManagerConfig extends AgentBrowserThreadManagerConfig {
-    firecrawl: Firecrawl;
-    /** Resolve HTTP CDP URL to WebSocket URL. */
-    resolveWebSocketUrl: (url: string) => Promise<string>;
-    /** Options for each `firecrawl.browser()` call (thread scope = one call per thread). */
-    sessionOptions?: FirecrawlBrowserSessionOptions;
+  firecrawl: Firecrawl;
+  /** Resolve HTTP CDP URL to WebSocket URL. */
+  resolveWebSocketUrl: (url: string) => Promise<string>;
+  /** Options for each `firecrawl.browser()` call (thread scope = one call per thread). */
+  sessionOptions?: FirecrawlBrowserSessionOptions;
 }
 /**
  * Provisions a dedicated Firecrawl Browser Sandbox session per Mastra thread and connects Playwright over CDP.
  */
 declare class FirecrawlAgentBrowserThreadManager extends AgentBrowserThreadManager {
-    private readonly firecrawl;
-    private readonly resolveWebSocketUrl;
-    private readonly sessionOptions;
-    constructor(config: FirecrawlAgentBrowserThreadManagerConfig);
-    protected createSession(threadId: string): Promise<FirecrawlAgentBrowserSession>;
-    protected doDestroySession(session: FirecrawlAgentBrowserSession): Promise<void>;
+  private readonly firecrawl;
+  private readonly resolveWebSocketUrl;
+  private readonly sessionOptions;
+  constructor(config: FirecrawlAgentBrowserThreadManagerConfig);
+  protected createSession(threadId: string): Promise<FirecrawlAgentBrowserSession>;
+  protected doDestroySession(session: FirecrawlAgentBrowserSession): Promise<void>;
 }
-
+//#endregion
+//#region src/resolve-cdp.d.ts
 /**
  * Resolve an HTTP CDP endpoint to a WebSocket URL (same behavior as MastraBrowser.resolveWebSocketUrl).
  */
 declare function resolveCdpWebSocketUrl(url: string, logger?: {
-    debug?: (message: string) => void;
-    warn?: (message: string) => void;
+  debug?: (message: string) => void;
+  warn?: (message: string) => void;
 }): Promise<string>;
-
+//#endregion
 export { type FirecrawlAgentBrowserSession, FirecrawlAgentBrowserThreadManager, type FirecrawlAgentBrowserThreadManagerConfig, FirecrawlBrowser, type FirecrawlBrowserConfig, type FirecrawlBrowserSessionOptions, resolveCdpWebSocketUrl };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/firecrawl-browser.ts","../src/firecrawl-thread-manager.ts","../src/resolve-cdp.ts"],"mappings":";;;;;;;;;;;UASiB;;EAEf;;EAEA;;EAEA;;EAEA;;IAEE;;IAEA;;;EAGF;;EAEA;;;KAIU,yBAAyB;;EAEnC;;EAEA;;;;;EAKA,YAAY;;;;;;;;cChBD,yBAAyB;WAClB;WACA;;YAGA,eAAe;mBAEhB;mBACA;UACT;EAEI,YAAA,QAAQ;YAsBK,YAAY;YAoEZ,WAAW;;;;;;;UCjHrB,qCAAqC;EACpD;;UAGe,iDAAiD;EAChE,WAAW;;EAEX,sBAAsB,gBAAgB;;EAEtC,iBAAiB;;;;;cAMN,2CAA2C;mBACrC;mBACA;mBACA;EAEL,YAAA,QAAQ;YAOK,cAAc,mBAAmB,QAAQ;YA8FzC,iBAAiB,SAAS,+BAA+B;;;;;;;iBCjI9D,uBACpB,aACA;EAAW,SAAS;EAA0B,QAAQ;IACrD"}