@spider-cloud/spider-client 0.1.57 → 0.1.59

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { ChunkCallbackFunction, Collection, QueryRequest, SpiderCoreResponse, SpiderParams } from "./config";
+import { ChunkCallbackFunction, Collection, QueryRequest, SpiderCoreResponse, SpiderParams, SearchRequestParams } from "./config";
 /**
  * Generic params for core request.
  */
@@ -78,7 +78,7 @@ export declare class Spider {
      * @param {GenericParams} [params={}] - Configuration parameters for the search.
      * @returns {Promise<any>} The result of the crawl, either structured data or a Response object if streaming.
      */
-    search(q: string, params?: GenericParams): Promise<any>;
+    search(q: string, params?: SearchRequestParams): Promise<any>;
     /**
      *  Transform HTML to Markdown or text. You can send up to 10MB of data at once.
      * @param {object} data - The data to trasnform, a list of objects with the key 'html' and optional 'url' key for readability.

package/dist/config.d.ts

@@ -426,6 +426,33 @@ export interface SpiderParams {
      */
     remote_proxy?: string;
 }
+/**
+ * Represents the options available for making a spider search request.
+ */
+export interface SearchRequestParams {
+    /** The base request parameters shared across requests */
+    base?: SpiderParams;
+    /** The search query string (merged with other params) required */
+    search?: string;
+    /** Optional limit on the number of websites to search */
+    search_limit?: number;
+    /** Whether to fetch the actual page content (defaults to true) */
+    fetch_page_content?: boolean;
+    /** Optional search location (e.g., city or region name) */
+    location?: string;
+    /** Optional country code (e.g., "US", "DE") */
+    country?: string;
+    /** Optional language code (e.g., "en", "fr") */
+    language?: string;
+    /** Optional number of search results to retrieve */
+    num?: number;
+    /** Optional page number of search results to fetch */
+    page?: number;
+    /** Optional cap on websites if a list is provided via text or URL (comma-separated) */
+    website_limit?: number;
+    /** If true, prioritizes speed over completeness of results */
+    quick_search?: boolean;
+}
 export type SpiderCoreResponse = {
     content?: string;
     message?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.1.57",
+  "version": "0.1.59",
   "description": "Isomorphic Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "node --import tsx  --test __tests__/*test.ts",