@dealcrawl/sdk 2.1.3 → 2.3.0

package/dist/index.js

@@ -589,6 +589,203 @@ var AccountResource = class {
   }
 };
 
+// src/resources/agent.ts
+var AgentResource = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  /**
+   * Create a new AI agent job
+   *
+   * @param options - Agent configuration options
+   * @returns Job creation response with jobId and status URL
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.create({
+   *   url: "https://booking.com",
+   *   prompt: "Find hotels in Paris for 2 adults, March 15-17, sort by price and extract the 3 cheapest options",
+   *   maxSteps: 20,
+   *   takeScreenshots: true
+   * });
+   * ```
+   */
+  async create(options) {
+    const body = {
+      url: options.url,
+      urls: options.urls,
+      prompt: options.prompt,
+      schema: options.schema,
+      maxSteps: options.maxSteps ?? 10,
+      actions: options.actions,
+      model: options.model ?? "openai",
+      timeout: options.timeout ?? 3e4,
+      onlyMainContent: options.onlyMainContent ?? true,
+      takeScreenshots: options.takeScreenshots ?? false,
+      headers: options.headers,
+      webhook: options.webhook
+    };
+    const result = await post(this.ctx, "/v1/agent", body);
+    return result.data;
+  }
+  /**
+   * Get the status of an agent job
+   *
+   * @param jobId - The job ID to check
+   * @returns Agent status with progress and partial results
+   *
+   * @example
+   * ```ts
+   * const status = await client.agent.getStatus(jobId);
+   * console.log(`Step ${status.partialResult?.steps.length}/${status.totalSteps}`);
+   * ```
+   */
+  async getStatus(jobId) {
+    const result = await get(
+      this.ctx,
+      `/v1/status/${jobId}`
+    );
+    return result.data;
+  }
+  /**
+   * Create an agent with preset actions
+   * Useful for handling common scenarios like cookie consent, popups, etc.
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.withPresetActions(
+   *   "https://shop.com",
+   *   "Find the best discount and extract product details",
+   *   [
+   *     { type: "click", selector: "#accept-cookies" },
+   *     { type: "wait", milliseconds: 1000 }
+   *   ]
+   * );
+   * ```
+   */
+  async withPresetActions(url, prompt, actions, options) {
+    return this.create({
+      url,
+      prompt,
+      actions,
+      ...options
+    });
+  }
+  /**
+   * Create an agent with a JSON schema for structured output
+   * The agent will extract data matching the provided schema
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.withSchema(
+   *   "https://linkedin.com/company/example",
+   *   "Extract company information",
+   *   {
+   *     type: "object",
+   *     properties: {
+   *       name: { type: "string" },
+   *       employees: { type: "number" },
+   *       description: { type: "string" },
+   *       website: { type: "string" }
+   *     },
+   *     required: ["name"]
+   *   }
+   * );
+   * ```
+   */
+  async withSchema(url, prompt, schema, options) {
+    return this.create({
+      url,
+      prompt,
+      schema,
+      ...options
+    });
+  }
+  /**
+   * Create an agent optimized for deal/product extraction
+   * Pre-configured for e-commerce scenarios
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.forDeals(
+   *   "https://slickdeals.net",
+   *   "Find the top 10 tech deals posted today"
+   * );
+   * ```
+   */
+  async forDeals(url, prompt, options) {
+    return this.create({
+      url,
+      prompt: `${prompt}. Extract deal information including: product name, current price, original price (if available), discount percentage, merchant/store, and any promo codes or coupons.`,
+      schema: {
+        type: "object",
+        properties: {
+          deals: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                productName: { type: "string" },
+                currentPrice: { type: "number" },
+                originalPrice: { type: "number" },
+                discountPercent: { type: "number" },
+                merchant: { type: "string" },
+                promoCode: { type: "string" },
+                url: { type: "string" },
+                expiresAt: { type: "string" }
+              },
+              required: ["productName", "currentPrice"]
+            }
+          }
+        },
+        required: ["deals"]
+      },
+      maxSteps: options?.maxSteps ?? 15,
+      ...options
+    });
+  }
+  /**
+   * Create an agent to fill and submit a form
+   * Useful for search forms, login forms, etc.
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.fillForm(
+   *   "https://kayak.com",
+   *   "Search for flights from Paris to New York on March 20, return March 27",
+   *   { takeScreenshots: true }
+   * );
+   * ```
+   */
+  async fillForm(url, instructions, options) {
+    return this.create({
+      url,
+      prompt: `Navigate to the form and ${instructions}. After submitting, extract the results.`,
+      maxSteps: options?.maxSteps ?? 12,
+      ...options
+    });
+  }
+  /**
+   * Create an agent using Claude (Anthropic) instead of GPT
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.withClaude(
+   *   "https://complex-site.com",
+   *   "Navigate through the multi-step checkout process"
+   * );
+   * ```
+   */
+  async withClaude(url, prompt, options) {
+    return this.create({
+      url,
+      prompt,
+      model: "anthropic",
+      ...options
+    });
+  }
+};
+
 // src/resources/crawl.ts
 var CRAWL_TEMPLATES = {
   ecommerce: {
@@ -1544,11 +1741,21 @@ var KeysResource = class {
    *
    * @example
    * ```ts
+   * // Simple revoke
    * await client.keys.revoke("key_abc123");
+   *
+   * // With reason
+   * await client.keys.revoke("key_abc123", {
+   *   reason: "Key compromised"
+   * });
    * ```
    */
-  async revoke(keyId) {
-    const result = await del(this.ctx, `/v1/keys/${keyId}`);
+  async revoke(keyId, options = {}) {
+    const result = await del(
+      this.ctx,
+      `/v1/keys/${keyId}`,
+      options.reason ? { reason: options.reason } : void 0
+    );
     return result.data;
   }
   /**
@@ -1624,6 +1831,8 @@ var ScrapeResource = class {
       detectSignals: options.detectSignals ?? true,
       extractWithAI: options.extractWithAI,
       extractDeal: options.extractDeal,
+      extractMultipleDeals: options.extractMultipleDeals,
+      maxDeals: options.maxDeals,
       useAdvancedModel: options.useAdvancedModel,
       minDealScore: options.minDealScore,
       screenshot: options.screenshot,
@@ -1652,6 +1861,25 @@ var ScrapeResource = class {
       ...options
     });
   }
+  /**
+   * Scrape a list page and extract multiple deals
+   * Use for category pages, deal lists, search results
+   *
+   * @example
+   * ```ts
+   * const job = await client.scrape.extractDeals(
+   *   "https://amazon.fr/deals",
+   *   { maxDeals: 30, useAdvancedModel: true }
+   * );
+   * ```
+   */
+  async extractDeals(url, options) {
+    return this.create({
+      url,
+      extractMultipleDeals: true,
+      ...options
+    });
+  }
   /**
    * Scrape a URL with screenshot capture
    * Convenience method for screenshot capture
@@ -1674,6 +1902,185 @@ var ScrapeResource = class {
       ...options
     });
   }
+  // ============================================
+  // BATCH SCRAPING METHODS
+  // ============================================
+  /**
+   * Create a batch scrape job for multiple URLs
+   * Scrapes 1-100 URLs in a single request
+   *
+   * @example
+   * ```ts
+   * const batch = await client.scrape.batch({
+   *   urls: [
+   *     { url: "https://shop1.com/product1" },
+   *     { url: "https://shop2.com/deal", extractDeal: true }
+   *   ],
+   *   defaults: { detectSignals: true }
+   * });
+   * console.log(batch.batchId, batch.results);
+   * ```
+   */
+  async batch(options) {
+    const body = {
+      urls: options.urls,
+      defaults: options.defaults,
+      webhookUrl: options.webhookUrl,
+      priority: options.priority,
+      delayMs: options.delay
+    };
+    const result = await post(
+      this.ctx,
+      "/v1/scrape/batch",
+      body
+    );
+    return result.data;
+  }
+  /**
+   * Get status of a batch scrape operation
+   *
+   * @example
+   * ```ts
+   * const status = await client.scrape.getBatchStatus(batchId);
+   * console.log(`Completed: ${status.completed}/${status.total}`);
+   * ```
+   */
+  async getBatchStatus(batchId) {
+    const result = await get(
+      this.ctx,
+      `/v1/scrape/batch/${batchId}`
+    );
+    return result.data;
+  }
+  /**
+   * Batch scrape with deal extraction enabled for all URLs
+   * Convenience method for deal-focused batch scraping
+   *
+   * @example
+   * ```ts
+   * const batch = await client.scrape.batchForDeals([
+   *   "https://shop1.com/sale",
+   *   "https://shop2.com/deals"
+   * ]);
+   * ```
+   */
+  async batchForDeals(urls, options) {
+    return this.batch({
+      urls: urls.map((url) => ({ url })),
+      defaults: {
+        extractDeal: true,
+        detectSignals: true,
+        ...options?.defaults
+      },
+      ...options
+    });
+  }
+};
+
+// src/resources/search.ts
+var SearchResource = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  /**
+   * Create a new search job
+   *
+   * @example
+   * ```ts
+   * const result = await client.search.create({
+   *   query: "laptop deals black friday",
+   *   maxResults: 20,
+   *   useDealScoring: true
+   * });
+   * ```
+   */
+  async create(options) {
+    const body = {
+      query: options.query,
+      limit: options.maxResults,
+      scrapeResults: options.autoScrape,
+      maxScrapeResults: options.autoScrapeLimit,
+      useAiOptimization: options.useAiOptimization,
+      aiProvider: options.aiProvider,
+      aiModel: options.aiModel,
+      useDealScoring: options.useDealScoring,
+      skipCache: options.skipCache,
+      filters: options.filters,
+      webhook: options.webhook
+    };
+    const result = await post(this.ctx, "/v1/search", body);
+    return result.data;
+  }
+  /**
+   * Search with AI query optimization
+   * Convenience method for AI-enhanced searches
+   *
+   * @example
+   * ```ts
+   * const result = await client.search.withAI("iphone discount", {
+   *   aiProvider: "openai",
+   *   aiModel: "gpt-4o-mini"
+   * });
+   * ```
+   */
+  async withAI(query, options) {
+    return this.create({
+      query,
+      useAiOptimization: true,
+      ...options
+    });
+  }
+  /**
+   * Search with deal scoring enabled
+   * Scores each result for deal relevance (0-100)
+   *
+   * @example
+   * ```ts
+   * const result = await client.search.forDeals("gaming laptop");
+   * ```
+   */
+  async forDeals(query, options) {
+    return this.create({
+      query,
+      useDealScoring: true,
+      ...options
+    });
+  }
+  /**
+   * Search and auto-scrape top results
+   * Creates scrape jobs for the best matching URLs
+   *
+   * @example
+   * ```ts
+   * const result = await client.search.andScrape("promo codes", {
+   *   autoScrapeLimit: 5
+   * });
+   * console.log(result.data.scrapedJobIds);
+   * ```
+   */
+  async andScrape(query, options) {
+    return this.create({
+      query,
+      autoScrape: true,
+      ...options
+    });
+  }
+  /**
+   * Check search API status
+   * Returns availability and features info
+   *
+   * @example
+   * ```ts
+   * const status = await client.search.getStatus();
+   * if (status.available) {
+   *   console.log(`Provider: ${status.provider}`);
+   * }
+   * ```
+   */
+  async getStatus() {
+    const result = await get(this.ctx, "/v1/search/status");
+    return result.data;
+  }
 };
 
 // src/resources/status.ts
@@ -1995,17 +2402,38 @@ var DealCrawl = class {
   // RESOURCES
   // ============================================
   /**
-   * Scrape resource - Single page scraping
+   * Scrape resource - Single page and batch scraping
    *
    * @example
    * ```ts
+   * // Single page
    * const job = await client.scrape.create({
    *   url: "https://example.com",
    *   extractDeal: true
    * });
+   *
+   * // Batch scraping
+   * const batch = await client.scrape.batch({
+   *   urls: [{ url: "https://shop1.com" }, { url: "https://shop2.com" }]
+   * });
    * ```
    */
   scrape;
+  /**
+   * Search resource - Web search with AI optimization
+   *
+   * @example
+   * ```ts
+   * const result = await client.search.create({
+   *   query: "laptop deals",
+   *   useDealScoring: true
+   * });
+   *
+   * // With AI optimization
+   * const result = await client.search.withAI("iphone discount");
+   * ```
+   */
+  search;
   /**
    * Crawl resource - Website crawling
    *
@@ -2047,6 +2475,29 @@ var DealCrawl = class {
    * ```
    */
   dork;
+  /**
+   * Agent resource - AI-powered autonomous web navigation
+   *
+   * The agent uses ReAct pattern (Observation → Thought → Action → Evaluation)
+   * to navigate web pages and extract structured data based on natural language.
+   *
+   * @example
+   * ```ts
+   * const job = await client.agent.create({
+   *   url: "https://amazon.com",
+   *   prompt: "Search for wireless headphones under $50 and extract top 5 results",
+   *   maxSteps: 15
+   * });
+   *
+   * // With schema for structured output
+   * const job = await client.agent.withSchema(
+   *   "https://example.com",
+   *   "Extract product info",
+   *   { type: "object", properties: {...} }
+   * );
+   * ```
+   */
+  agent;
   /**
    * Status resource - Job status management
    *
@@ -2142,9 +2593,11 @@ var DealCrawl = class {
       onRateLimit: config.onRateLimit
     };
     this.scrape = new ScrapeResource(this.ctx);
+    this.search = new SearchResource(this.ctx);
     this.crawl = new CrawlResource(this.ctx);
     this.extract = new ExtractResource(this.ctx);
     this.dork = new DorkResource(this.ctx);
+    this.agent = new AgentResource(this.ctx);
     this.status = new StatusResource(this.ctx);
     this.data = new DataResource(this.ctx);
     this.webhooks = new WebhooksResource(this.ctx);
@@ -2257,9 +2710,44 @@ var DealCrawl = class {
     const job = await this.extract.create(options);
     return this.waitForResult(job.jobId, waitOptions);
   }
+  /**
+   * Search and return results directly
+   * Note: Search is synchronous, no waiting needed
+   *
+   * @example
+   * ```ts
+   * const result = await client.searchAndWait({
+   *   query: "gaming laptop deals",
+   *   useDealScoring: true
+   * });
+   * console.log(result.data.results);
+   * ```
+   */
+  async searchAndWait(options) {
+    return this.search.create(options);
+  }
+  /**
+   * Create an agent job and wait for result
+   * Combines create and waitForResult
+   *
+   * @example
+   * ```ts
+   * const result = await client.agentAndWait({
+   *   url: "https://booking.com",
+   *   prompt: "Find hotels in Paris for March 15-17",
+   *   maxSteps: 20
+   * });
+   * console.log(result.data);
+   * ```
+   */
+  async agentAndWait(options, waitOptions) {
+    const job = await this.agent.create(options);
+    return this.waitForResult(job.jobId, waitOptions);
+  }
 };
 
 exports.AccountResource = AccountResource;
+exports.AgentResource = AgentResource;
 exports.CrawlResource = CrawlResource;
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 exports.DataResource = DataResource;
@@ -2270,6 +2758,7 @@ exports.ERROR_CODES = ERROR_CODES;
 exports.ExtractResource = ExtractResource;
 exports.KeysResource = KeysResource;
 exports.ScrapeResource = ScrapeResource;
+exports.SearchResource = SearchResource;
 exports.StatusResource = StatusResource;
 exports.WebhooksResource = WebhooksResource;
 exports.default = DealCrawl;