@dealcrawl/sdk 2.11.0 → 2.11.1

package/README.md

@@ -6,6 +6,29 @@ Official TypeScript SDK for the DealCrawl web scraping and crawling API.
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+## What's New in v2.11.1 (January 2026) 🐛
+
+### Bug Fixes
+
+- **DataResource**: Fixed syntax error in `getDealsByCategory()` method (unclosed docstring + duplicate line)
+- **SDK-API Alignment**: Verified 87% endpoint coverage with detailed alignment report
+
+### Known Gaps
+
+The following API endpoints do not have SDK methods yet (see [API-SDK Alignment Report](../../docs/API-SDK-ALIGNMENT-REPORT.md)):
+
+- `GET /v1/status/:jobId/errors` - Get job errors
+- `GET /v1/data/jobs/:jobId` - Get full job details
+- `GET /v1/data/jobs/:jobId/result` - Get job result
+- `GET /v1/data/jobs/:jobId/export` - Export job in multiple formats
+- `POST /v1/webhooks/:id/rotate` - Rotate webhook secret
+- `GET /v1/webhooks/:id/secret-status` - Get webhook secret status
+- `POST /v1/webhooks/verify` - Verify webhook signature
+
+These methods will be added in a future release.
+
+---
+
 ## What's New in v2.11.0 (January 2026) 🎉
 
 ### Breaking Changes ⚠️

package/dist/index.d.mts

@@ -792,10 +792,17 @@ interface CreateWebhookResponse {
     minDealScore: number;
     active: boolean;
 }
-/** List webhooks response */
+/** List webhooks response (standardized list format) */
 interface ListWebhooksResponse {
-    webhooks: WebhookItem[];
-    count: number;
+    data: WebhookItem[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasMore: boolean;
+    };
+    meta?: Record<string, unknown>;
 }
 /** Update webhook response */
 interface UpdateWebhookResponse {
@@ -1415,7 +1422,7 @@ interface PriceRange {
 interface CrawlOptions {
     /** Starting URL for the crawl (required) */
     url: string;
-    /** Alias for url - Starting URL for the crawl */
+    /** @deprecated Use 'url' instead. Kept for backward compatibility. */
     startUrl?: string;
     /** Prompt to guide the crawl (optional) */
     prompt?: string;
@@ -1535,8 +1542,6 @@ interface DorkOptions {
     inTitle?: string;
     /** Maximum results to return (default: 10, max: 100) */
     maxResults?: number;
-    /** Region code (2 letter ISO code) */
-    region?: string;
 }
 /** Options for getting job deals */
 interface GetDealsOptions {
@@ -1612,19 +1617,25 @@ interface ExportDealsOptions {
     format?: ExportFormat;
     /** Minimum deal score */
     minScore?: number;
-    /** Maximum price */
-    maxPrice?: number;
     /** Filter by category */
     category?: string;
-    /** Include raw signals in export */
-    includeRawSignals?: boolean;
+    /** Filter by sync status to DealUp */
+    synced?: boolean;
+    /** Filter from date (ISO string) */
+    fromDate?: string;
+    /** Filter to date (ISO string) */
+    toDate?: string;
+    /** Maximum number of deals to export (default: 500, max: 1000) */
+    limit?: number;
 }
 /** Webhook event types */
 type WebhookEvent = "deal.found" | "deal.synced" | "crawl.completed" | "crawl.failed";
 /** Options for creating a webhook */
 interface CreateWebhookOptions {
-    /** Event type to subscribe to */
-    event: WebhookEvent;
+    /** Event types to subscribe to (array) */
+    events?: WebhookEvent[];
+    /** @deprecated Use 'events' array instead */
+    event?: WebhookEvent;
     /** URL to receive webhook notifications */
     url: string;
     /** Secret for signature verification */
@@ -2315,9 +2326,9 @@ declare class AuthResource {
      * and how many are currently active.
      *
      * Tier limits:
-     * - Free: 2 concurrent connections
-     * - Pro: 10 concurrent connections
-     * - Enterprise: 50 concurrent connections
+     * - Free: 10 concurrent connections
+     * - Pro: 50 concurrent connections
+     * - Enterprise: 200 concurrent connections
      *
      * @example
      * ```ts
@@ -2676,17 +2687,9 @@ declare class DataResource {
      * @example
      * ```ts
      * const electronicsDeals = await client.data.getDealsByCategory("electronics");
-    async getDealsByCategory(
-      category: string,
-      options?: Omit<ListDealsOptions, "category">
-    ): Promise<ListDealsResponse> {
-      if (!category || !category.trim()) {
-        throw new Error("category is required and cannot be empty");
-      }
-      return this.listDeals({ category, ...options });
-    }    return this.listDeals({ category, ...options });
-    }
-  
+     * ```
+     */
+    getDealsByCategory(category: string, options?: Omit<ListDealsOptions, "category">): Promise<ListDealsResponse>;
     /**
      * Get unsynced deals (not yet sent to DealUp)
      *
@@ -3221,7 +3224,9 @@ declare class KeysResource {
      */
     revokeAll(): Promise<{
         success: boolean;
-        count: number;
+        revokedCount: number;
+        message: string;
+        warning: string;
     }>;
     /**
      * Get active keys only

package/dist/index.d.ts

@@ -792,10 +792,17 @@ interface CreateWebhookResponse {
     minDealScore: number;
     active: boolean;
 }
-/** List webhooks response */
+/** List webhooks response (standardized list format) */
 interface ListWebhooksResponse {
-    webhooks: WebhookItem[];
-    count: number;
+    data: WebhookItem[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasMore: boolean;
+    };
+    meta?: Record<string, unknown>;
 }
 /** Update webhook response */
 interface UpdateWebhookResponse {
@@ -1415,7 +1422,7 @@ interface PriceRange {
 interface CrawlOptions {
     /** Starting URL for the crawl (required) */
     url: string;
-    /** Alias for url - Starting URL for the crawl */
+    /** @deprecated Use 'url' instead. Kept for backward compatibility. */
     startUrl?: string;
     /** Prompt to guide the crawl (optional) */
     prompt?: string;
@@ -1535,8 +1542,6 @@ interface DorkOptions {
     inTitle?: string;
     /** Maximum results to return (default: 10, max: 100) */
     maxResults?: number;
-    /** Region code (2 letter ISO code) */
-    region?: string;
 }
 /** Options for getting job deals */
 interface GetDealsOptions {
@@ -1612,19 +1617,25 @@ interface ExportDealsOptions {
     format?: ExportFormat;
     /** Minimum deal score */
     minScore?: number;
-    /** Maximum price */
-    maxPrice?: number;
     /** Filter by category */
     category?: string;
-    /** Include raw signals in export */
-    includeRawSignals?: boolean;
+    /** Filter by sync status to DealUp */
+    synced?: boolean;
+    /** Filter from date (ISO string) */
+    fromDate?: string;
+    /** Filter to date (ISO string) */
+    toDate?: string;
+    /** Maximum number of deals to export (default: 500, max: 1000) */
+    limit?: number;
 }
 /** Webhook event types */
 type WebhookEvent = "deal.found" | "deal.synced" | "crawl.completed" | "crawl.failed";
 /** Options for creating a webhook */
 interface CreateWebhookOptions {
-    /** Event type to subscribe to */
-    event: WebhookEvent;
+    /** Event types to subscribe to (array) */
+    events?: WebhookEvent[];
+    /** @deprecated Use 'events' array instead */
+    event?: WebhookEvent;
     /** URL to receive webhook notifications */
     url: string;
     /** Secret for signature verification */
@@ -2315,9 +2326,9 @@ declare class AuthResource {
      * and how many are currently active.
      *
      * Tier limits:
-     * - Free: 2 concurrent connections
-     * - Pro: 10 concurrent connections
-     * - Enterprise: 50 concurrent connections
+     * - Free: 10 concurrent connections
+     * - Pro: 50 concurrent connections
+     * - Enterprise: 200 concurrent connections
      *
      * @example
      * ```ts
@@ -2676,17 +2687,9 @@ declare class DataResource {
      * @example
      * ```ts
      * const electronicsDeals = await client.data.getDealsByCategory("electronics");
-    async getDealsByCategory(
-      category: string,
-      options?: Omit<ListDealsOptions, "category">
-    ): Promise<ListDealsResponse> {
-      if (!category || !category.trim()) {
-        throw new Error("category is required and cannot be empty");
-      }
-      return this.listDeals({ category, ...options });
-    }    return this.listDeals({ category, ...options });
-    }
-  
+     * ```
+     */
+    getDealsByCategory(category: string, options?: Omit<ListDealsOptions, "category">): Promise<ListDealsResponse>;
     /**
      * Get unsynced deals (not yet sent to DealUp)
      *
@@ -3221,7 +3224,9 @@ declare class KeysResource {
      */
     revokeAll(): Promise<{
         success: boolean;
-        count: number;
+        revokedCount: number;
+        message: string;
+        warning: string;
     }>;
     /**
      * Get active keys only

package/dist/index.js

@@ -1173,9 +1173,9 @@ var AuthResource = class {
    * and how many are currently active.
    *
    * Tier limits:
-   * - Free: 2 concurrent connections
-   * - Pro: 10 concurrent connections
-   * - Enterprise: 50 concurrent connections
+   * - Free: 10 concurrent connections
+   * - Pro: 50 concurrent connections
+   * - Enterprise: 200 concurrent connections
    *
    * @example
    * ```ts
@@ -1533,12 +1533,10 @@ var CrawlResource = class {
    * ```
    */
   async analyze(url) {
-    const result = await get(
+    const result = await post(
       this.ctx,
       "/v1/crawl/analyze",
-      {
-        url
-      }
+      { url }
     );
     return result.data;
   }
@@ -1704,31 +1702,28 @@ var DataResource = class {
     });
   }
   /**
-     * Get deals by category
-     * Convenience method for filtering by category
-     *
-     * @example
-     * ```ts
-     * const electronicsDeals = await client.data.getDealsByCategory("electronics");
-    async getDealsByCategory(
-      category: string,
-      options?: Omit<ListDealsOptions, "category">
-    ): Promise<ListDealsResponse> {
-      if (!category || !category.trim()) {
-        throw new Error("category is required and cannot be empty");
-      }
-      return this.listDeals({ category, ...options });
-    }    return this.listDeals({ category, ...options });
+   * Get deals by category
+   * Convenience method for filtering by category
+   *
+   * @example
+   * ```ts
+   * const electronicsDeals = await client.data.getDealsByCategory("electronics");
+   * ```
+   */
+  async getDealsByCategory(category, options) {
+    if (!category || !category.trim()) {
+      throw new Error("category is required and cannot be empty");
     }
-  
-    /**
-     * Get unsynced deals (not yet sent to DealUp)
-     *
-     * @example
-     * ```ts
-     * const unsyncedDeals = await client.data.getUnsyncedDeals();
-     * ```
-     */
+    return this.listDeals({ category, ...options });
+  }
+  /**
+   * Get unsynced deals (not yet sent to DealUp)
+   *
+   * @example
+   * ```ts
+   * const unsyncedDeals = await client.data.getUnsyncedDeals();
+   * ```
+   */
   async getUnsyncedDeals(options) {
     return this.listDeals({ synced: false, ...options });
   }
@@ -1784,9 +1779,11 @@ var DataResource = class {
       {
         format: options.format || "json",
         minScore: options.minScore,
-        maxPrice: options.maxPrice,
         category: options.category,
-        includeRawSignals: options.includeRawSignals
+        synced: options.synced?.toString(),
+        fromDate: options.fromDate,
+        toDate: options.toDate,
+        limit: options.limit
       }
     );
     return result.data;
@@ -1831,8 +1828,8 @@ var DorkResource = class {
   async create(options) {
     const body = {
       query: this.buildQuery(options),
-      maxResults: options.maxResults,
-      region: options.region
+      site: options.site,
+      maxResults: options.maxResults
     };
     const result = await post(this.ctx, "/v1/dork", body);
     return result.data;
@@ -1947,9 +1944,6 @@ var DorkResource = class {
     if (typeof options.query === "string" && options.query.trim() !== "") {
       parts.push(options.query);
     }
-    if (options.site) {
-      parts.push(`site:${options.site}`);
-    }
     if (options.fileType) {
       parts.push(`filetype:${options.fileType}`);
     }
@@ -2574,10 +2568,7 @@ var KeysResource = class {
    * ```
    */
   async revokeAll() {
-    const result = await del(
-      this.ctx,
-      "/v1/keys/all"
-    );
+    const result = await post(this.ctx, "/v1/keys/revoke-all");
     return result.data;
   }
   /**
@@ -3106,7 +3097,9 @@ var WebhooksResource = class {
    */
   async create(options) {
     const result = await post(this.ctx, "/v1/webhooks", {
+      events: options.events ?? (options.event ? [options.event] : void 0),
       event: options.event,
+      // Legacy fallback
       url: options.url,
       secret: options.secret,
       minDealScore: options.minDealScore,
@@ -3144,7 +3137,7 @@ var WebhooksResource = class {
       this.ctx,
       `/v1/webhooks/${webhookId}`
     );
-    return result.data;
+    return result.data.webhook;
   }
   /**
    * Update a webhook
@@ -3202,7 +3195,8 @@ var WebhooksResource = class {
   async test(webhookId) {
     const result = await post(
       this.ctx,
-      `/v1/webhooks/${webhookId}/test`
+      "/v1/webhooks/test",
+      { webhookId }
     );
     return result.data;
   }
@@ -3240,7 +3234,7 @@ var WebhooksResource = class {
    */
   async getActive() {
     const all = await this.list();
-    return all.webhooks.filter((w) => w.active);
+    return all.data.filter((w) => w.active);
   }
   /**
    * Get webhooks by event type
@@ -3252,7 +3246,7 @@ var WebhooksResource = class {
    */
   async getByEvent(event) {
     const all = await this.list();
-    return all.webhooks.filter((w) => w.event === event);
+    return all.data.filter((w) => w.event === event);
   }
 };