@land-catalyst/batch-data-sdk 1.2.6 → 1.2.8

package/dist/builders/builders.d.ts

@@ -16,7 +16,7 @@
  *   .build();
  * ```
  */
-import { StringFilter, NumericRangeFilter, DateRangeFilter, GeoLocationDistance, GeoLocationBoundingBox, GeoLocationPolygon, AddressSearchCriteria, AssessmentSearchCriteria, BuildingSearchCriteria, CompAddressSearchCriteria, DemographicsSearchCriteria, ForeclosureSearchCriteria, GeneralSearchCriteria, IdsSearchCriteria, IntelSearchCriteria, InvoluntaryLienSearchCriteria, LegalSearchCriteria, ListingSearchCriteria, LotSearchCriteria, OpenLienSearchCriteria, OwnerSearchCriteria, PermitSearchCriteria, PropertyOwnerProfileSearchCriteria, SaleSearchCriteria, TaxSearchCriteria, ValuationSearchCriteria, OrSearchCriteria, SearchCriteria, DeliveryConfig, EventHubConfig, PropertySubscriptionRequest, QuickListValueWithNot, PropertyLookupRequest, PropertyLookupRequestItem, PropertyLookupRequestAddress, PropertyLookupOptions, PropertyPermitRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, GeoPoint } from "../core/types";
+import { StringFilter, NumericRangeFilter, DateRangeFilter, GeoLocationDistance, GeoLocationBoundingBox, GeoLocationPolygon, AddressSearchCriteria, AssessmentSearchCriteria, BuildingSearchCriteria, CompAddressSearchCriteria, DemographicsSearchCriteria, ForeclosureSearchCriteria, GeneralSearchCriteria, IdsSearchCriteria, IntelSearchCriteria, InvoluntaryLienSearchCriteria, LegalSearchCriteria, ListingSearchCriteria, LotSearchCriteria, OpenLienSearchCriteria, OwnerSearchCriteria, PermitSearchCriteria, PropertyOwnerProfileSearchCriteria, SaleSearchCriteria, TaxSearchCriteria, ValuationSearchCriteria, OrSearchCriteria, SearchCriteria, DeliveryConfig, EventHubConfig, PropertySubscriptionRequest, QuickListValueWithNot, PropertyLookupRequest, PropertyLookupRequestItem, PropertyLookupRequestAddress, PropertyLookupOptions, PropertyPermitRequest, PropertyCountRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, GeoPoint } from "../core/types";
 import type { PropertyFieldMetadata } from "../property-field/metadata";
 /**
  * Base interface for all builders
@@ -813,6 +813,17 @@ export declare class PropertyLookupRequestBuilder extends BaseBuilder<PropertyLo
     options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
     build(): PropertyLookupRequest;
 }
+/**
+ * Builder for property count requests
+ *
+ * Used specifically for count-only requests that should never fetch property data.
+ */
+export declare class PropertyCountRequestBuilder extends BaseBuilder<PropertyCountRequest> {
+    static from(request: PropertyCountRequest): PropertyCountRequestBuilder;
+    searchCriteria(criteria: SearchCriteria): this;
+    searchCriteria(configurator: (builder: SearchCriteriaBuilder) => void): this;
+    build(): PropertyCountRequest;
+}
 /**
  * Builder for property search requests
  */

package/dist/builders/builders.js

@@ -18,7 +18,7 @@
  * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyPermitRequestBuilder = exports.PropertyLookupAsyncRequestBuilder = exports.PropertySearchAsyncRequestBuilder = exports.PropertySearchRequestBuilder = exports.PropertyLookupRequestBuilder = exports.AsyncPropertyLookupOptionsBuilder = exports.PropertyLookupOptionsBuilder = exports.PropertyLookupRequestItemBuilder = exports.PropertySubscriptionBuilder = exports.DeliveryConfigBuilder = exports.SearchCriteriaBuilder = exports.OrSearchCriteriaBuilder = exports.ValuationSearchCriteriaBuilder = exports.TaxSearchCriteriaBuilder = exports.SaleSearchCriteriaBuilder = exports.PropertyOwnerProfileSearchCriteriaBuilder = exports.PermitSearchCriteriaBuilder = exports.OwnerSearchCriteriaBuilder = exports.OpenLienSearchCriteriaBuilder = exports.LotSearchCriteriaBuilder = exports.ListingSearchCriteriaBuilder = exports.LegalSearchCriteriaBuilder = exports.InvoluntaryLienSearchCriteriaBuilder = exports.IntelSearchCriteriaBuilder = exports.IdsSearchCriteriaBuilder = exports.GeneralSearchCriteriaBuilder = exports.ForeclosureSearchCriteriaBuilder = exports.DemographicsSearchCriteriaBuilder = exports.CompAddressSearchCriteriaBuilder = exports.BuildingSearchCriteriaBuilder = exports.AssessmentSearchCriteriaBuilder = exports.AddressSearchCriteriaBuilder = exports.GeoLocationFactory = exports.DateRangeFilterBuilder = exports.NumericRangeFilterBuilder = exports.StringFilterBuilder = void 0;
+exports.PropertyPermitRequestBuilder = exports.PropertyLookupAsyncRequestBuilder = exports.PropertySearchAsyncRequestBuilder = exports.PropertySearchRequestBuilder = exports.PropertyCountRequestBuilder = exports.PropertyLookupRequestBuilder = exports.AsyncPropertyLookupOptionsBuilder = exports.PropertyLookupOptionsBuilder = exports.PropertyLookupRequestItemBuilder = exports.PropertySubscriptionBuilder = exports.DeliveryConfigBuilder = exports.SearchCriteriaBuilder = exports.OrSearchCriteriaBuilder = exports.ValuationSearchCriteriaBuilder = exports.TaxSearchCriteriaBuilder = exports.SaleSearchCriteriaBuilder = exports.PropertyOwnerProfileSearchCriteriaBuilder = exports.PermitSearchCriteriaBuilder = exports.OwnerSearchCriteriaBuilder = exports.OpenLienSearchCriteriaBuilder = exports.LotSearchCriteriaBuilder = exports.ListingSearchCriteriaBuilder = exports.LegalSearchCriteriaBuilder = exports.InvoluntaryLienSearchCriteriaBuilder = exports.IntelSearchCriteriaBuilder = exports.IdsSearchCriteriaBuilder = exports.GeneralSearchCriteriaBuilder = exports.ForeclosureSearchCriteriaBuilder = exports.DemographicsSearchCriteriaBuilder = exports.CompAddressSearchCriteriaBuilder = exports.BuildingSearchCriteriaBuilder = exports.AssessmentSearchCriteriaBuilder = exports.AddressSearchCriteriaBuilder = exports.GeoLocationFactory = exports.DateRangeFilterBuilder = exports.NumericRangeFilterBuilder = exports.StringFilterBuilder = void 0;
 const metadata_1 = require("../property-field/metadata");
 /**
  * Abstract base class for builders that store nested builders
@@ -2421,6 +2421,40 @@ class PropertyLookupRequestBuilder extends BaseBuilder {
     }
 }
 exports.PropertyLookupRequestBuilder = PropertyLookupRequestBuilder;
+/**
+ * Builder for property count requests
+ *
+ * Used specifically for count-only requests that should never fetch property data.
+ */
+class PropertyCountRequestBuilder extends BaseBuilder {
+    static from(request) {
+        const builder = new PropertyCountRequestBuilder();
+        builder.searchCriteria(request.searchCriteria);
+        return builder;
+    }
+    searchCriteria(criteriaOrConfigurator) {
+        if (typeof criteriaOrConfigurator === "function") {
+            const builder = new SearchCriteriaBuilder("");
+            criteriaOrConfigurator(builder);
+            this.criteria.searchCriteria = builder.build();
+            this.builders.searchCriteria = undefined;
+        }
+        else {
+            this.criteria.searchCriteria = criteriaOrConfigurator;
+            this.builders.searchCriteria = undefined;
+        }
+        return this;
+    }
+    build() {
+        if (!this.criteria.searchCriteria) {
+            throw new Error("Search criteria is required");
+        }
+        return {
+            searchCriteria: this.criteria.searchCriteria,
+        };
+    }
+}
+exports.PropertyCountRequestBuilder = PropertyCountRequestBuilder;
 /**
  * Builder for property search requests
  */

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, PropertySearchRequest, PropertySearchResponse, 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, 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";
 /**
  * Middleware function that executes before an HTTP request is sent.
  * Can modify the request config or perform side effects (logging, metrics, etc.).
@@ -258,10 +258,14 @@ export declare class BatchDataClient implements IBatchDataClient {
     searchProperties(request: PropertySearchRequest): Promise<PropertySearchResponse>;
     /**
      * Get the count of properties matching the search criteria
-     * @param searchCriteria Search criteria to match properties
+     *
+     * Uses PropertyCountRequest to ensure no property data is fetched (count-only).
+     * This prevents accidental charges for property data retrieval.
+     *
+     * @param searchRequest Count request with search criteria (no options allowed)
      * @returns Number of matching properties, or null if the endpoint is unavailable
      */
-    getPropertyCount(searchRequest: PropertySearchRequest): Promise<number | null>;
+    getPropertyCount(searchRequest: PropertyCountRequest): Promise<number | null>;
     /**
      * Verify and normalize addresses (v1 API)
      * POST /api/v1/address/verify

package/dist/client/client.interface.d.ts

@@ -1,4 +1,4 @@
-import { PropertySubscriptionRequest, PropertySubscriptionResponse, PropertySearchRequest, PropertySearchResponse, 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, 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";
 /**
  * BatchData API Client Interface
  *
@@ -26,10 +26,14 @@ export interface IBatchDataClient {
     searchProperties(request: PropertySearchRequest): Promise<PropertySearchResponse>;
     /**
      * Get the count of properties matching the search criteria
-     * @param searchCriteria Search criteria to match properties
+     *
+     * Uses PropertyCountRequest to ensure no property data is fetched (count-only).
+     * This prevents accidental charges for property data retrieval.
+     *
+     * @param searchRequest Count request with search criteria (no options allowed)
      * @returns Number of matching properties, or null if the endpoint is unavailable
      */
-    getPropertyCount(searchRequest: PropertySearchRequest): Promise<number | null>;
+    getPropertyCount(searchRequest: PropertyCountRequest): Promise<number | null>;
     /**
      * Verify and normalize addresses (v1 API)
      * POST /api/v1/address/verify

package/dist/client/client.js

@@ -321,14 +321,17 @@ class BatchDataClient {
     }
     /**
      * Get the count of properties matching the search criteria
-     * @param searchCriteria Search criteria to match properties
+     *
+     * Uses PropertyCountRequest to ensure no property data is fetched (count-only).
+     * This prevents accidental charges for property data retrieval.
+     *
+     * @param searchRequest Count request with search criteria (no options allowed)
      * @returns Number of matching properties, or null if the endpoint is unavailable
      */
     async getPropertyCount(searchRequest) {
-        const { searchCriteria, options } = searchRequest;
-        const lookupOptions = options
-            ? builders_1.PropertyLookupOptionsBuilder.from(options).take(0)
-            : new builders_1.PropertyLookupOptionsBuilder();
+        const { searchCriteria } = searchRequest;
+        // Always use take(0) to ensure no property data is fetched
+        const lookupOptions = new builders_1.PropertyLookupOptionsBuilder().take(0);
         const response = await this.searchProperties({
             searchCriteria,
             options: lookupOptions.build(),

package/dist/core/types.d.ts

@@ -1654,6 +1654,22 @@ export interface PropertySearchRequest {
     searchCriteria: SearchCriteria;
     options?: PropertyLookupOptions;
 }
+/**
+ * Property count request
+ *
+ * Used specifically for getting property counts without fetching property data.
+ * This type does NOT include options to prevent accidental property data fetching
+ * (which incurs charges). For count-only requests, use this type instead of
+ * PropertySearchRequest to ensure no property data is retrieved.
+ *
+ * Note: All filtering needed for an accurate count should be specified in
+ * searchCriteria. PropertyLookupOptions contains some duplicate filter fields
+ * (useBedrooms, useBathrooms, useYearBuilt, etc.) that mirror SearchCriteria fields,
+ * but these are redundant and should not be needed for accurate counts.
+ */
+export interface PropertyCountRequest {
+    searchCriteria: SearchCriteria;
+}
 /**
  * Property lookup request
  */

package/dist/property-field/metadata.d.ts

@@ -53,6 +53,10 @@ export interface PropertyFieldMetadata {
      * Whether this field is an array element (indicated by [n] in the path)
      */
     isArrayElement: boolean;
+    /**
+     * Optional array of possible values for this field (for enum-like fields)
+     */
+    possibleValues?: string[];
 }
 /**
  * Registry of all property field metadata, indexed by field path

package/dist/property-field/metadata.js

@@ -47,6 +47,7 @@ exports.PROPERTY_FIELD_METADATA = {
         dataType: "string",
         description: "The validity of the address (e.g. Valid, Invalid, Partially Valid)",
         isArrayElement: false,
+        possibleValues: ["Valid", "Invalid", "Partially Valid"],
     },
     "address.city": {
         fieldPath: "address.city",
@@ -187,6 +188,7 @@ exports.PROPERTY_FIELD_METADATA = {
         dataType: "string",
         description: "The validity of the address (e.g. Valid, Invalid, Partially Valid)",
         isArrayElement: false,
+        possibleValues: ["Valid", "Invalid", "Partially Valid"],
     },
     "owner.names.[n].first": {
         fieldPath: "owner.names.[n].first",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@land-catalyst/batch-data-sdk",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "TypeScript SDK for BatchData.io Property API - Types, Builders, and Utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,6 +21,7 @@
     "generate:metadata": "node scripts/generate-property-field-metadata.js",
     "generate:docs": "npx tsx scripts/generate-property-type-docs.ts",
     "add:jsdoc": "node scripts/add-jsdoc-to-types.js",
+    "preversion": "npm run build",
     "v:patch": "npm version patch && git push --follow-tags",
     "v:minor": "npm version minor && git push --follow-tags",
     "v:major": "npm version major && git push --follow-tags"