@land-catalyst/batch-data-sdk 1.3.0 → 1.3.1

package/dist/builders/builders.js

@@ -2276,7 +2276,9 @@ class PropertySubscriptionBuilder extends RequestWithSearchCriteriaBuilder {
     static from(request) {
         const builder = new PropertySubscriptionBuilder();
         builder.searchCriteria(request.searchCriteria);
-        builder.deliveryConfig(request.deliveryConfig);
+        if (request.deliveryConfig) {
+            builder.deliveryConfig(request.deliveryConfig);
+        }
         if (request.options) {
             builder.options(request.options);
         }
@@ -2297,12 +2299,11 @@ class PropertySubscriptionBuilder extends RequestWithSearchCriteriaBuilder {
     }
     build() {
         this.validateSearchCriteria();
-        if (!this.criteria.deliveryConfig) {
-            throw new Error("Delivery configuration is required");
-        }
         const request = {
             searchCriteria: this.criteria.searchCriteria,
-            deliveryConfig: this.criteria.deliveryConfig,
+            ...(this.criteria.deliveryConfig && {
+                deliveryConfig: this.criteria.deliveryConfig,
+            }),
         };
         return this.buildOptionsIntoRequest(request);
     }

package/dist/client/client.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosResponse, AxiosError, InternalAxiosRequestConfig } from "axios";
 import { IBatchDataClient } from "./client.interface";
 import { ILogger } from "../core/logger.interface";
-import { PropertySubscriptionRequest, PropertySubscriptionResponse, PropertyCountRequest, PropertySearchRequest, PropertySearchResponse, PropertyLookupOptions, AddressVerifyRequest, AddressVerifyResponse, AddressAutocompleteRequest, AddressAutocompleteResponse, AddressGeocodeRequest, AddressGeocodeResponse, AddressReverseGeocodeRequest, AddressReverseGeocodeResponse, PropertyLookupRequest, PropertyLookupResponse, PropertyLookupAsyncRequest, PropertyLookupAsyncResponse, PropertySearchAsyncRequest, PropertySearchAsyncResponse, PropertySkipTraceRequest, PropertySkipTraceResponse, PropertySkipTraceAsyncRequest, PropertySkipTraceAsyncResponse, PhoneVerificationRequest, PhoneVerificationResponse, PhoneVerificationAsyncRequest, PhoneVerificationAsyncResponse, PhoneDNCRequest, PhoneDNCResponse, PhoneDNCAsyncRequest, PhoneDNCAsyncResponse, PhoneTCPARequest, PhoneTCPAResponse, PhoneTCPAAsyncRequest, PhoneTCPAAsyncResponse, GetPropertySubscriptionsResponse, GetPropertySubscriptionDetailResponse, DeletePropertySubscriptionResponse, PropertyPermitRequest, PropertyPermitResponse, PropertySkipTraceV3Request, PropertySkipTraceV3Response, PropertySkipTraceV3AsyncRequest, PropertySkipTraceV3AsyncResponse } from "../core/types";
+import { PropertySubscriptionRequest, PropertySubscriptionResponse, PropertyCountRequest, PropertySearchRequest, PropertySearchResponse, PropertyLookupOptions, AddressVerifyRequest, AddressVerifyResponse, AddressAutocompleteRequest, AddressAutocompleteResponse, AddressGeocodeRequest, AddressGeocodeResponse, AddressReverseGeocodeRequest, AddressReverseGeocodeResponse, PropertyLookupRequest, PropertyLookupResponse, PropertyLookupAsyncRequest, PropertyLookupAsyncResponse, PropertySearchAsyncRequest, PropertySearchAsyncResponse, PropertySkipTraceRequest, PropertySkipTraceResponse, PropertySkipTraceAsyncRequest, PropertySkipTraceAsyncResponse, PhoneVerificationRequest, PhoneVerificationResponse, PhoneVerificationAsyncRequest, PhoneVerificationAsyncResponse, PhoneDNCRequest, PhoneDNCResponse, PhoneDNCAsyncRequest, PhoneDNCAsyncResponse, PhoneTCPARequest, PhoneTCPAResponse, PhoneTCPAAsyncRequest, PhoneTCPAAsyncResponse, GetPropertySubscriptionsResponse, GetPropertySubscriptionDetailResponse, DeletePropertySubscriptionResponse, PropertyPermitRequest, PropertyPermitResponse, PropertySkipTraceV3Request, PropertySkipTraceV3Response, PropertySkipTraceV3AsyncRequest, PropertySkipTraceV3AsyncResponse, EventHubConfig, DeliveryConfig } from "../core/types";
 /**
  * Middleware function that executes before an HTTP request is sent.
  * Can modify the request config or perform side effects (logging, metrics, etc.).
@@ -98,6 +98,20 @@ export interface AsyncWebhookConfiguration {
      */
     propertySubscription?: AsyncWebhookUrls;
 }
+/**
+ * Event Hub configuration for async API requests
+ * Allows specifying Event Hub config per endpoint type, with fallback to defaults
+ */
+export interface AsyncEventHubConfiguration {
+    /**
+     * Default Event Hub config used as fallback for all async endpoints
+     */
+    default?: EventHubConfig;
+    /**
+     * Event Hub config for property subscription requests
+     */
+    propertySubscription?: EventHubConfig;
+}
 /**
  * BatchData API Client Options
  */
@@ -129,6 +143,28 @@ export interface BatchDataClientOptions {
      * Allows specifying webhook URLs per endpoint type, with fallback to defaults
      */
     webhooks?: AsyncWebhookConfiguration;
+    /**
+     * Optional Event Hub configuration for async requests
+     * Allows specifying Event Hub config per endpoint type, with fallback to defaults
+     */
+    eventHubs?: AsyncEventHubConfiguration;
+    /**
+     * Optional default delivery configuration for property subscriptions
+     * If provided, this will be used when a subscription request doesn't specify deliveryConfig
+     * Takes precedence over webhooks and eventHubs configurations
+     *
+     * @example
+     * ```typescript
+     * const client = new BatchDataClient({
+     *   apiKey: "...",
+     *   defaultDeliveryConfig: {
+     *     type: "webhook",
+     *     url: "https://example.com/webhook",
+     *   }
+     * });
+     * ```
+     */
+    defaultDeliveryConfig?: DeliveryConfig;
     /**
      * Optional default PropertyLookupOptions to apply to all requests
      * These defaults are merged with request-specific options, with request options taking precedence
@@ -178,6 +214,8 @@ export declare class BatchDataClient implements IBatchDataClient {
     protected readonly axiosInstance: AxiosInstance;
     protected readonly logger: ILogger;
     private readonly webhooks?;
+    private readonly eventHubs?;
+    private readonly defaultDeliveryConfig?;
     private readonly defaultOptions?;
     private readonly maxTake?;
     constructor(options: BatchDataClientOptions);
@@ -231,14 +269,22 @@ export declare class BatchDataClient implements IBatchDataClient {
      */
     private applyDefaultOptions;
     /**
-     * Apply default webhook URLs to a property subscription request if they're not already set.
-     * This helper ensures that if webhook URLs are configured in the client,
-     * they will be used for property subscriptions that don't explicitly specify webhook URLs.
+     * Get delivery config from fallbacks (defaultDeliveryConfig first, then Event Hub preferred over webhooks).
+     * Returns undefined if no fallback configs are available.
+     *
+     * @returns Delivery config from fallbacks, or undefined if none available
+     */
+    private createDeliveryConfigFromFallbacks;
+    /**
+     * Apply default delivery configuration (Event Hub or webhook) to a property subscription request.
+     * Event Hub takes precedence over webhooks if both are configured.
+     * If deliveryConfig is not set, it will be created based on available configs (Event Hub preferred).
      *
      * @param request The property subscription request to modify
-     * @returns The request with webhook URLs applied (if needed)
+     * @returns The request with delivery config applied (if needed)
+     * @throws Error if deliveryConfig type is explicitly set but required config is missing
      */
-    private applyPropertySubscriptionWebhooks;
+    private applyDeliveryConfigDefaults;
     /**
      * Add a request middleware function that executes before requests are sent.
      * Useful for adding headers, logging, metrics, etc.

package/dist/client/client.js

@@ -24,6 +24,8 @@ class BatchDataClient {
         this.v3BaseUrl = options.v3BaseUrl || "https://api.batchdata.com/api/v3";
         this.logger = options.logger || new logger_interface_1.ConsoleLogger();
         this.webhooks = options.webhooks;
+        this.eventHubs = options.eventHubs;
+        this.defaultDeliveryConfig = options.defaultDeliveryConfig;
         this.defaultOptions = options.defaultOptions;
         this.maxTake = options.maxTake;
         this.axiosInstance = axios_1.default.create({
@@ -288,14 +290,18 @@ class BatchDataClient {
         };
     }
     /**
-     * Apply default webhook URLs to a property subscription request if they're not already set.
-     * This helper ensures that if webhook URLs are configured in the client,
-     * they will be used for property subscriptions that don't explicitly specify webhook URLs.
+     * Get delivery config from fallbacks (defaultDeliveryConfig first, then Event Hub preferred over webhooks).
+     * Returns undefined if no fallback configs are available.
      *
-     * @param request The property subscription request to modify
-     * @returns The request with webhook URLs applied (if needed)
+     * @returns Delivery config from fallbacks, or undefined if none available
      */
-    applyPropertySubscriptionWebhooks(request) {
+    createDeliveryConfigFromFallbacks() {
+        // Explicit defaultDeliveryConfig takes highest precedence
+        if (this.defaultDeliveryConfig) {
+            return this.defaultDeliveryConfig;
+        }
+        // Determine which Event Hub config to use (property subscription-specific first, then default)
+        const eventHubConfig = this.eventHubs?.propertySubscription ?? this.eventHubs?.default;
         // Determine which webhook URLs to use
         let webhookUrl;
         let errorWebhookUrl;
@@ -309,32 +315,85 @@ class BatchDataClient {
             webhookUrl = this.webhooks.default.url;
             errorWebhookUrl = errorWebhookUrl || this.webhooks.default.errorUrl;
         }
-        // If no webhook URLs are configured, return original request
-        if (!webhookUrl && !errorWebhookUrl) {
-            return request;
+        // Event Hub takes precedence over webhooks
+        if (eventHubConfig) {
+            return {
+                type: "event-hub",
+                eventHub: eventHubConfig,
+            };
         }
-        // If deliveryConfig is not set or is not a webhook type, create/update it
-        const deliveryConfig = request.deliveryConfig || {
-            type: "webhook",
-        };
-        // Only apply defaults if deliveryConfig is a webhook type
-        if (deliveryConfig.type === "webhook") {
-            // Apply webhook URL if not already set
-            if (!deliveryConfig.url && webhookUrl) {
-                deliveryConfig.url = webhookUrl;
+        if (webhookUrl || errorWebhookUrl) {
+            return {
+                type: "webhook",
+                ...(webhookUrl && { url: webhookUrl }),
+                ...(errorWebhookUrl && { errorUrl: errorWebhookUrl }),
+            };
+        }
+        return undefined;
+    }
+    /**
+     * Apply default delivery configuration (Event Hub or webhook) to a property subscription request.
+     * Event Hub takes precedence over webhooks if both are configured.
+     * If deliveryConfig is not set, it will be created based on available configs (Event Hub preferred).
+     *
+     * @param request The property subscription request to modify
+     * @returns The request with delivery config applied (if needed)
+     * @throws Error if deliveryConfig type is explicitly set but required config is missing
+     */
+    applyDeliveryConfigDefaults(request) {
+        const fallbackConfig = this.createDeliveryConfigFromFallbacks();
+        // If deliveryConfig is not set, create it from fallbacks
+        if (!request.deliveryConfig) {
+            if (fallbackConfig) {
+                return { ...request, deliveryConfig: fallbackConfig };
+            }
+            // If no fallback config is available, throw an error
+            throw new Error("Property subscription requires delivery configuration. " +
+                "Please provide deliveryConfig in the request, or configure webhooks or eventHubs in BatchDataClient options.");
+        }
+        const deliveryConfig = request.deliveryConfig;
+        // If type is event-hub, use request's eventHub or fallback's eventHub
+        if (deliveryConfig.type === "event-hub") {
+            const eventHubConfig = deliveryConfig.eventHub ??
+                (fallbackConfig?.type === "event-hub"
+                    ? fallbackConfig.eventHub
+                    : undefined);
+            if (!eventHubConfig) {
+                throw new Error("Property subscription requires Event Hub configuration, but none is available. " +
+                    "Please provide eventHub in deliveryConfig, or configure eventHubs in BatchDataClient options.");
             }
-            // Apply error webhook URL if not already set
-            if (!deliveryConfig.errorUrl && errorWebhookUrl) {
-                deliveryConfig.errorUrl = errorWebhookUrl;
+            if (!deliveryConfig.eventHub) {
+                return {
+                    ...request,
+                    deliveryConfig: {
+                        ...deliveryConfig,
+                        eventHub: eventHubConfig,
+                    },
+                };
             }
         }
-        // Return a new request object with updated deliveryConfig
-        return {
-            ...request,
-            deliveryConfig: {
-                ...deliveryConfig,
-            },
-        };
+        // If type is webhook, use request's URLs or fallback's URLs
+        if (deliveryConfig.type === "webhook") {
+            const webhookUrl = deliveryConfig.url ??
+                (fallbackConfig?.type === "webhook" ? fallbackConfig.url : undefined);
+            const errorWebhookUrl = deliveryConfig.errorUrl ??
+                (fallbackConfig?.type === "webhook"
+                    ? fallbackConfig.errorUrl
+                    : undefined);
+            if ((!deliveryConfig.url && webhookUrl) ||
+                (!deliveryConfig.errorUrl && errorWebhookUrl)) {
+                return {
+                    ...request,
+                    deliveryConfig: {
+                        ...deliveryConfig,
+                        ...(webhookUrl && !deliveryConfig.url && { url: webhookUrl }),
+                        ...(errorWebhookUrl &&
+                            !deliveryConfig.errorUrl && { errorUrl: errorWebhookUrl }),
+                    },
+                };
+            }
+        }
+        return request;
     }
     /**
      * Add a request middleware function that executes before requests are sent.
@@ -449,8 +508,8 @@ class BatchDataClient {
      */
     async createPropertySubscription(request) {
         const url = `${this.v2BaseUrl}/property-subscription`;
-        // Apply default webhook URLs if configured
-        let requestWithDefaults = this.applyPropertySubscriptionWebhooks(request);
+        // Apply default delivery config (Event Hub preferred over webhooks)
+        let requestWithDefaults = this.applyDeliveryConfigDefaults(request);
         // Apply defaults and limits (including maxTake)
         requestWithDefaults =
             this.applySearchRequestDefaultsAndLimits(requestWithDefaults);

package/dist/core/types.d.ts

@@ -479,7 +479,7 @@ export interface DeliveryConfig {
  * Property subscription request payload
  */
 export interface PropertySubscriptionRequest extends RequestWithSearchCriteria {
-    deliveryConfig: DeliveryConfig;
+    deliveryConfig?: DeliveryConfig;
 }
 /**
  * Property subscription response

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@land-catalyst/batch-data-sdk",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "TypeScript SDK for BatchData.io Property API - Types, Builders, and Utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",