crw-sdk 0.15.2 → 0.17.0

package/dist/cjs/client.js

@@ -115,6 +115,30 @@ class CrwClient {
             return this.httpPost("/v1/search", args);
         return this.localTransport().toolCall("crw_search", args);
     }
+    /**
+     * Firecrawl-compatible Research API (cloud only). Mirrors the Firecrawl
+     * research SDK surface over `/v2/search/research/*`. Each method GETs the
+     * hosted endpoint and returns its `{ success, ... }` payload verbatim.
+     */
+    get research() {
+        const get = (path, params) => {
+            if (this.apiUrl === null)
+                throw new errors_js_1.CrwError("research API requires cloud mode (set apiKey/apiUrl)");
+            const qs = Object.entries(params)
+                .filter(([, v]) => v !== undefined && v !== null)
+                .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
+                .join("&");
+            return this.httpRequest("GET", qs ? `${path}?${qs}` : path, undefined, {
+                checkSuccess: false,
+            });
+        };
+        return {
+            searchPapers: (query, opts = {}) => get("/v2/search/research/papers", { query, ...opts }),
+            getPaper: (id, opts = {}) => get(`/v2/search/research/papers/${encodeURIComponent(id)}`, { ...opts }),
+            similarPapers: (id, opts) => get(`/v2/search/research/papers/${encodeURIComponent(id)}/similar`, { ...opts }),
+            searchGithub: (query, opts = {}) => get("/v2/search/research/github", { query, ...opts }),
+        };
+    }
     /**
      * Parse a document (PDF) into markdown / structured JSON. Works in both modes.
      */

package/dist/esm/client.d.ts

@@ -1,5 +1,5 @@
 /** CRW client — cloud (default), self-hosted HTTP, or local subprocess mode. */
-import type { BatchResult, BatchScrapeOptions, Capabilities, ChangeTrackingOptions, ClientOptions, CrawlOptions, CrawlResult, DiffResult, ExtractOptions, ExtractResult, Json, MapOptions, ParseFileOptions, ParseResult, ScrapeOptions, ScrapeResult, SearchOptions, SearchResult } from "./types.js";
+import type { BatchResult, BatchScrapeOptions, Capabilities, ChangeTrackingOptions, ClientOptions, CrawlOptions, CrawlResult, DiffResult, ExtractOptions, ExtractResult, Json, MapOptions, ParseFileOptions, ParseResult, ScrapeOptions, ScrapeResult, SearchOptions, SearchResult, ResearchSearchOptions, ResearchReadOptions, ResearchSimilarOptions } from "./types.js";
 export declare const CLOUD_API_URL = "https://api.fastcrw.com";
 export declare const DASHBOARD_URL = "https://fastcrw.com/dashboard";
 export declare const DOCS_URL = "https://us.github.io/crw";
@@ -20,6 +20,19 @@ export declare class CrwClient {
      * Works in both modes; local mode needs a SearXNG URL configured on the engine.
      */
     search(query: string, opts?: SearchOptions): Promise<SearchResult>;
+    /**
+     * Firecrawl-compatible Research API (cloud only). Mirrors the Firecrawl
+     * research SDK surface over `/v2/search/research/*`. Each method GETs the
+     * hosted endpoint and returns its `{ success, ... }` payload verbatim.
+     */
+    get research(): {
+        searchPapers: (query: string, opts?: ResearchSearchOptions) => Promise<Json>;
+        getPaper: (id: string, opts?: ResearchReadOptions) => Promise<Json>;
+        similarPapers: (id: string, opts: ResearchSimilarOptions) => Promise<Json>;
+        searchGithub: (query: string, opts?: {
+            k?: number;
+        }) => Promise<Json>;
+    };
     /**
      * Parse a document (PDF) into markdown / structured JSON. Works in both modes.
      */

package/dist/esm/client.js

@@ -112,6 +112,30 @@ export class CrwClient {
             return this.httpPost("/v1/search", args);
         return this.localTransport().toolCall("crw_search", args);
     }
+    /**
+     * Firecrawl-compatible Research API (cloud only). Mirrors the Firecrawl
+     * research SDK surface over `/v2/search/research/*`. Each method GETs the
+     * hosted endpoint and returns its `{ success, ... }` payload verbatim.
+     */
+    get research() {
+        const get = (path, params) => {
+            if (this.apiUrl === null)
+                throw new CrwError("research API requires cloud mode (set apiKey/apiUrl)");
+            const qs = Object.entries(params)
+                .filter(([, v]) => v !== undefined && v !== null)
+                .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
+                .join("&");
+            return this.httpRequest("GET", qs ? `${path}?${qs}` : path, undefined, {
+                checkSuccess: false,
+            });
+        };
+        return {
+            searchPapers: (query, opts = {}) => get("/v2/search/research/papers", { query, ...opts }),
+            getPaper: (id, opts = {}) => get(`/v2/search/research/papers/${encodeURIComponent(id)}`, { ...opts }),
+            similarPapers: (id, opts) => get(`/v2/search/research/papers/${encodeURIComponent(id)}/similar`, { ...opts }),
+            searchGithub: (query, opts = {}) => get("/v2/search/research/github", { query, ...opts }),
+        };
+    }
     /**
      * Parse a document (PDF) into markdown / structured JSON. Works in both modes.
      */

package/dist/esm/types.d.ts

@@ -84,3 +84,24 @@ export type ExtractResult = Json;
 export type BatchResult = Json[];
 export type Capabilities = Json;
 export type DiffResult = Json;
+/** Firecrawl-compatible Research API options (cloud only). */
+export interface ResearchSearchOptions {
+    k?: number;
+    authors?: string;
+    categories?: string;
+    from?: string;
+    to?: string;
+}
+export interface ResearchReadOptions {
+    /** When set, returns top passages answering this question instead of metadata. */
+    query?: string;
+    k?: number;
+}
+export interface ResearchSimilarOptions {
+    /** Required by Firecrawl: natural-language ranking intent. */
+    intent: string;
+    mode?: "similar" | "citers" | "references";
+    k?: number;
+    rerank?: boolean;
+    anchor?: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crw-sdk",
-  "version": "0.15.2",
+  "version": "0.17.0",
   "description": "TypeScript/JavaScript SDK for CRW — scrape, crawl, map, search, parse, and extract any website",
   "license": "MIT",
   "homepage": "https://github.com/us/crw",