@dealcrawl/sdk 2.2.0 → 2.4.0

package/dist/index.js

@@ -589,6 +589,262 @@ 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
+    });
+  }
+  /**
+   * Generate a JSON Schema from a natural language prompt
+   *
+   * This is useful for building extraction schemas without manual JSON writing.
+   * The generated schema can be used with the main agent.create() method.
+   *
+   * @param options - Schema generation options
+   * @returns Generated schema with refined prompt and confidence score
+   *
+   * @example Basic usage:
+   * ```ts
+   * const result = await client.agent.generateSchema({
+   *   prompt: "Find the best student deals on Coursera for marketing courses"
+   * });
+   *
+   * console.log(result.schema);
+   * // { type: "object", properties: { courses: { ... } } }
+   *
+   * console.log(result.refinedPrompt);
+   * // "Extract student offers for marketing courses..."
+   *
+   * // Use the generated schema with an agent
+   * const job = await client.agent.create({
+   *   url: "https://coursera.org",
+   *   prompt: result.refinedPrompt,
+   *   schema: result.schema
+   * });
+   * ```
+   *
+   * @example With context from conversation:
+   * ```ts
+   * const result = await client.agent.generateSchema({
+   *   prompt: "Find student deals on online courses",
+   *   context: {
+   *     domains: ["marketing", "web development"],
+   *     dataTypes: ["free courses", "discounts"],
+   *     format: "json"
+   *   }
+   * });
+   *
+   * if (result.confidence < 0.7 && result.suggestedQuestions) {
+   *   // Ask user for clarification
+   *   console.log("Please clarify:", result.suggestedQuestions);
+   * }
+   * ```
+   */
+  async generateSchema(options) {
+    const body = {
+      prompt: options.prompt,
+      context: options.context,
+      model: options.model ?? "openai"
+    };
+    const result = await post(
+      this.ctx,
+      "/v1/agent/schema",
+      body
+    );
+    return result.data;
+  }
+};
+
 // src/resources/crawl.ts
 var CRAWL_TEMPLATES = {
   ecommerce: {
@@ -2278,6 +2534,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
    *
@@ -2377,6 +2656,7 @@ var DealCrawl = class {
     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);
@@ -2505,9 +2785,28 @@ var DealCrawl = class {
   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;