@land-catalyst/batch-data-sdk 1.2.9 → 1.2.11

package/dist/builders/builders.d.ts

@@ -749,6 +749,8 @@ export declare class PropertySubscriptionBuilder extends BaseBuilder<PropertySub
     searchCriteria(configurator: (builder: SearchCriteriaBuilder) => void): this;
     deliveryConfig(config: DeliveryConfig): this;
     deliveryConfig(configurator: (builder: DeliveryConfigBuilder) => void): this;
+    options(options: PropertyLookupOptions): this;
+    options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
     build(): PropertySubscriptionRequest;
 }
 /**

package/dist/builders/builders.js

@@ -2214,6 +2214,9 @@ class PropertySubscriptionBuilder extends BaseBuilder {
         const builder = new PropertySubscriptionBuilder();
         builder.searchCriteria(request.searchCriteria);
         builder.deliveryConfig(request.deliveryConfig);
+        if (request.options) {
+            builder.options(request.options);
+        }
         return builder;
     }
     searchCriteria(criteriaOrConfigurator) {
@@ -2242,6 +2245,9 @@ class PropertySubscriptionBuilder extends BaseBuilder {
         }
         return this;
     }
+    options(optionsOrConfigurator) {
+        return this.setPropertyWithBuilderClass("options", optionsOrConfigurator, PropertyLookupOptionsBuilder);
+    }
     build() {
         if (!this.criteria.searchCriteria) {
             throw new Error("Search criteria is required");
@@ -2249,10 +2255,17 @@ class PropertySubscriptionBuilder extends BaseBuilder {
         if (!this.criteria.deliveryConfig) {
             throw new Error("Delivery configuration is required");
         }
-        return {
+        const request = {
             searchCriteria: this.criteria.searchCriteria,
             deliveryConfig: this.criteria.deliveryConfig,
         };
+        if (this.builders.options) {
+            request.options = this.builders.options.build();
+        }
+        else if (this.criteria.options) {
+            request.options = this.criteria.options;
+        }
+        return request;
     }
 }
 exports.PropertySubscriptionBuilder = PropertySubscriptionBuilder;

package/dist/client/client.d.ts

@@ -144,6 +144,16 @@ export declare class BatchDataClient implements IBatchDataClient {
     protected readonly logger: ILogger;
     private readonly webhooks?;
     constructor(options: BatchDataClientOptions);
+    /**
+     * Obfuscate sensitive headers (like Authorization) for logging
+     * @param headers Headers object to obfuscate
+     * @returns Headers with sensitive values obfuscated
+     */
+    private obfuscateHeaders;
+    /**
+     * Set up debug logging interceptors for request/response logging
+     */
+    private setupDebugLogging;
     /**
      * Set up axios interceptors from middleware configuration
      * @param middleware The middleware configuration
@@ -254,6 +264,13 @@ export declare class BatchDataClient implements IBatchDataClient {
      * @param options.take Number of properties to return (0 for count-only)
      * @param options.skip Number of properties to skip for pagination
      * @returns Property search API response
+     *
+     * @remarks
+     * The returned PropertySearchResponse includes all possible fields that may be returned
+     * by the API. The actual fields present in the response depend on your subscription level
+     * and the data available for each property. Fields are optional and may be empty objects
+     * (e.g., foreclosure: {}) or undefined if not available. The type system ensures type
+     * safety while allowing for varying response structures based on subscription tier.
      */
     searchProperties(request: PropertySearchRequest): Promise<PropertySearchResponse>;
     /**

package/dist/client/client.js

@@ -32,11 +32,100 @@ class BatchDataClient {
                 Authorization: `Bearer ${options.apiKey}`,
             },
         });
+        // Set up debug logging interceptors
+        this.setupDebugLogging();
         // Set up middleware/interceptors if provided
         if (options.middleware) {
             this.setupMiddleware(options.middleware);
         }
     }
+    /**
+     * Obfuscate sensitive headers (like Authorization) for logging
+     * @param headers Headers object to obfuscate
+     * @returns Headers with sensitive values obfuscated
+     */
+    obfuscateHeaders(headers) {
+        if (!headers)
+            return headers;
+        const obfuscated = { ...headers };
+        // Obfuscate Authorization header
+        if (obfuscated.Authorization || obfuscated.authorization) {
+            const authHeader = (obfuscated.Authorization ||
+                obfuscated.authorization);
+            if (typeof authHeader === "string" && authHeader.startsWith("Bearer ")) {
+                const token = authHeader.substring(7);
+                if (token.length > 8) {
+                    // Show first 4 and last 4 characters, obfuscate the middle
+                    const obfuscatedToken = `${token.substring(0, 4)}${"*".repeat(Math.min(token.length - 8, 20))}${token.substring(token.length - 4)}`;
+                    obfuscated.Authorization = `Bearer ${obfuscatedToken}`;
+                    if (obfuscated.authorization) {
+                        obfuscated.authorization = obfuscated.Authorization;
+                    }
+                }
+                else {
+                    obfuscated.Authorization = "Bearer ***";
+                    if (obfuscated.authorization) {
+                        obfuscated.authorization = "Bearer ***";
+                    }
+                }
+            }
+        }
+        return obfuscated;
+    }
+    /**
+     * Set up debug logging interceptors for request/response logging
+     */
+    setupDebugLogging() {
+        // Request interceptor - log full request details
+        this.axiosInstance.interceptors.request.use((config) => {
+            const obfuscatedHeaders = this.obfuscateHeaders(config.headers);
+            this.logger.debug("HTTP Request", {
+                method: config.method?.toUpperCase(),
+                url: config.url,
+                baseURL: config.baseURL,
+                headers: obfuscatedHeaders,
+                params: config.params,
+                data: config.data,
+            });
+            return config;
+        }, (error) => {
+            this.logger.error("Request interceptor error", error);
+            return Promise.reject(error);
+        });
+        // Response interceptor - log full response details
+        this.axiosInstance.interceptors.response.use((response) => {
+            const obfuscatedHeaders = this.obfuscateHeaders(response.headers);
+            this.logger.debug("HTTP Response", {
+                status: response.status,
+                statusText: response.statusText,
+                headers: obfuscatedHeaders,
+                data: response.data,
+                config: {
+                    method: response.config.method?.toUpperCase(),
+                    url: response.config.url,
+                    baseURL: response.config.baseURL,
+                },
+            });
+            return response;
+        }, (error) => {
+            // Log error response if available
+            if (error.response) {
+                const obfuscatedHeaders = this.obfuscateHeaders(error.response.headers);
+                this.logger.debug("HTTP Error Response", {
+                    status: error.response.status,
+                    statusText: error.response.statusText,
+                    headers: obfuscatedHeaders,
+                    data: error.response.data,
+                    config: {
+                        method: error.config?.method?.toUpperCase(),
+                        url: error.config?.url,
+                        baseURL: error.config?.baseURL,
+                    },
+                });
+            }
+            return Promise.reject(error);
+        });
+    }
     /**
      * Set up axios interceptors from middleware configuration
      * @param middleware The middleware configuration
@@ -304,6 +393,13 @@ class BatchDataClient {
      * @param options.take Number of properties to return (0 for count-only)
      * @param options.skip Number of properties to skip for pagination
      * @returns Property search API response
+     *
+     * @remarks
+     * The returned PropertySearchResponse includes all possible fields that may be returned
+     * by the API. The actual fields present in the response depend on your subscription level
+     * and the data available for each property. Fields are optional and may be empty objects
+     * (e.g., foreclosure: {}) or undefined if not available. The type system ensures type
+     * safety while allowing for varying response structures based on subscription tier.
      */
     async searchProperties(request) {
         const url = `${this.v1BaseUrl}/property/search`;

package/dist/core/types.d.ts

@@ -481,6 +481,7 @@ export interface DeliveryConfig {
 export interface PropertySubscriptionRequest {
     searchCriteria: SearchCriteria;
     deliveryConfig: DeliveryConfig;
+    options?: PropertyLookupOptions;
 }
 /**
  * Property subscription response
@@ -1123,16 +1124,50 @@ export interface MortgageHistoryEntry {
     transactionTypeCode?: string;
     documentDate?: string;
 }
+/**
+ * Open lien mortgage information
+ */
+export interface OpenLienMortgage {
+    recordingDate?: string;
+    loanTypeCode?: string;
+    loanType?: string;
+    financingTypeCode?: string;
+    financingType?: string;
+    loanAmount?: number;
+    lenderName?: string;
+    lenderTypeCode?: string;
+    lenderType?: string;
+    loanTermMonths?: number;
+    dueDate?: string;
+    constructionLoan?: boolean;
+    cashPurchase?: boolean;
+    standaloneRefi?: string;
+    equityCreditLine?: boolean;
+    currentEstimatedBalance?: number;
+    purposeOfLoan?: string;
+    currentEstimatedInterestRate?: number;
+    assignedLenderName?: string;
+    ltv?: number;
+    estimatedPaymentAmount?: number;
+}
 /**
  * Open lien information
  */
 export interface OpenLien {
+    allLoanTypes?: string[];
+    juniorLoanTypes?: string[];
     totalOpenLienCount?: number;
+    totalOpenLienBalance?: number;
+    firstLoanRecordingDate?: string;
+    lastLoanRecordingDate?: string;
+    mortgages?: OpenLienMortgage[];
 }
 /**
  * Owner name entry
  */
 export interface OwnerName {
+    first?: string;
+    middle?: string;
     last?: string;
     full?: string;
 }
@@ -1225,6 +1260,9 @@ export interface PriorSaleMortgage {
  * Sale information
  */
 export interface Sale {
+    lastSale?: {
+        mortgages?: PriorSaleMortgage[];
+    };
     priorSale?: {
         mortgages?: PriorSaleMortgage[];
     };
@@ -1293,7 +1331,7 @@ export interface Property {
      * @dataset History (Deed)
      * @see {@link getPropertyFieldMetadata} to get full metadata
      */
-    foreclosure?: Foreclosure;
+    foreclosure?: Foreclosure | Record<string, never>;
     ids?: PropertyIds;
     images?: PropertyImages;
     intel?: Intel;
@@ -1340,6 +1378,10 @@ export interface ResponseMetadata {
     apiVersion?: string;
     performance?: PerformanceMetrics;
     results?: ResultsMetadata;
+    /**
+     * Request ID for tracking/debugging purposes
+     */
+    requestId?: string;
 }
 /**
  * Property search results

package/dist/property-field/search-criteria-ai-context.d.ts

@@ -3,6 +3,11 @@
  *
  * Builds complete context for AI services to generate SearchCriteria from natural language.
  * This includes all domain documentation, filter types, examples, and rules.
+ *
+ * IMPORTANT: This module only documents SEARCHABLE fields (fields that can be used in SearchCriteria).
+ * Response-only fields (like openLien.mortgages[], owner.names[], sale.lastSale.mortgages[], etc.)
+ * are intentionally excluded as they appear in Property responses but cannot be used as search filters.
+ * All fields documented here correspond to the SearchCriteria type interfaces in types.ts.
  */
 /**
  * Domain metadata with description

package/dist/property-field/search-criteria-ai-context.js

@@ -4,6 +4,11 @@
  *
  * Builds complete context for AI services to generate SearchCriteria from natural language.
  * This includes all domain documentation, filter types, examples, and rules.
+ *
+ * IMPORTANT: This module only documents SEARCHABLE fields (fields that can be used in SearchCriteria).
+ * Response-only fields (like openLien.mortgages[], owner.names[], sale.lastSale.mortgages[], etc.)
+ * are intentionally excluded as they appear in Property responses but cannot be used as search filters.
+ * All fields documented here correspond to the SearchCriteria type interfaces in types.ts.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SEARCH_CRITERIA_DOMAIN_NAMES = exports.SEARCH_CRITERIA_DOMAINS = void 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@land-catalyst/batch-data-sdk",
-  "version": "1.2.9",
+  "version": "1.2.11",
   "description": "TypeScript SDK for BatchData.io Property API - Types, Builders, and Utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,7 @@
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build",
-    "test": "jest",
+    "test": "jest --testPathIgnorePatterns=integration",
     "test:integration": "jest --testMatch=\"**/*integration*.test.ts\"",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",