@land-catalyst/batch-data-sdk 1.1.12 → 1.1.19

package/dist/{builders.d.ts → builders/builders.d.ts}

@@ -16,7 +16,8 @@
  *   .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, PropertySubscriptionRequest, QuickListValueWithNot, PropertyLookupRequest, PropertyLookupRequestItem, PropertyLookupRequestAddress, PropertyLookupOptions, PropertyPermitRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, GeoPoint } from "./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, PropertySubscriptionRequest, QuickListValueWithNot, PropertyLookupRequest, PropertyLookupRequestItem, PropertyLookupRequestAddress, PropertyLookupOptions, PropertyPermitRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, GeoPoint } from "../core/types";
+import type { PropertyFieldMetadata } from "../property-field/metadata";
 /**
  * Base interface for all builders
  */
@@ -47,6 +48,79 @@ export type BuildersStorage<T> = {
 declare abstract class BaseBuilder<T> implements Builder<T> {
     protected criteria: Partial<T>;
     protected builders: BuildersStorage<T>;
+    /**
+     * Get metadata for a property field path
+     * @param fieldPath The field path (e.g., "address.city", "owner.fullName")
+     * @returns The field metadata, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const cityMeta = builder.getFieldMetadata("address.city");
+     * console.log(cityMeta?.description); // "The city (e.g. Chicago)"
+     * ```
+     */
+    getFieldMetadata(fieldPath: string): PropertyFieldMetadata | undefined;
+    /**
+     * Get description for a property field path
+     * @param fieldPath The field path
+     * @returns The description, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const desc = builder.getFieldDescription("address.city");
+     * console.log(desc); // "The city (e.g. Chicago)"
+     * ```
+     */
+    getFieldDescription(fieldPath: string): string | undefined;
+    /**
+     * Get data type for a property field path
+     * @param fieldPath The field path
+     * @returns The data type, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const type = builder.getFieldType("address.city");
+     * console.log(type); // "string"
+     * ```
+     */
+    getFieldType(fieldPath: string): PropertyFieldMetadata["dataType"] | undefined;
+    /**
+     * Get Property field metadata for a SearchCriteria field path
+     * This helps you understand what Property field you're filtering on
+     * @param searchCriteriaPath The SearchCriteria field path (e.g., "address.city")
+     * @returns The Property field metadata, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new AddressSearchCriteriaBuilder();
+     * builder.city((c) => {
+     *   // See what Property field this filters on
+     *   const meta = builder.getSearchCriteriaFieldMetadata("address.city");
+     *   console.log(`Filtering on: ${meta?.description}`);
+     *   c.equals("Phoenix");
+     * });
+     * ```
+     */
+    getSearchCriteriaFieldMetadata(searchCriteriaPath: string): PropertyFieldMetadata | undefined;
+    /**
+     * Get SearchCriteria field metadata inferred from Property field metadata
+     * This provides a SearchCriteria-specific metadata object that explains what Property field
+     * you're filtering on, even if the mapping isn't exact
+     * @param searchCriteriaPath The SearchCriteria field path (e.g., "address.city")
+     * @returns SearchCriteria field metadata with Property field information
+     * @example
+     * ```typescript
+     * const builder = new AddressSearchCriteriaBuilder();
+     * builder.city((c) => {
+     *   // Get SearchCriteria metadata (inferred from Property metadata)
+     *   const scMeta = builder.getSearchCriteriaMetadata("address.city");
+     *   console.log(scMeta.description); // "Filter on: The city (e.g. Chicago)"
+     *   console.log(scMeta.hasPropertyMapping); // true
+     *   console.log(scMeta.propertyDataType); // "string"
+     *   c.equals("Phoenix");
+     * });
+     * ```
+     */
+    getSearchCriteriaMetadata(searchCriteriaPath: string): any;
     /**
      * Helper method to set a property either directly or via a builder configurator.
      * This extracts the common pattern of checking if a configurator function is provided,

package/dist/{builders.js → builders/builders.js}

@@ -19,6 +19,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;
+const metadata_1 = require("../property-field/metadata");
 /**
  * Abstract base class for builders that store nested builders
  * Handles the common pattern of storing builder instances and building them all at once
@@ -28,6 +29,95 @@ class BaseBuilder {
         this.criteria = {};
         this.builders = {};
     }
+    /**
+     * Get metadata for a property field path
+     * @param fieldPath The field path (e.g., "address.city", "owner.fullName")
+     * @returns The field metadata, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const cityMeta = builder.getFieldMetadata("address.city");
+     * console.log(cityMeta?.description); // "The city (e.g. Chicago)"
+     * ```
+     */
+    getFieldMetadata(fieldPath) {
+        return (0, metadata_1.getFieldMetadata)(fieldPath);
+    }
+    /**
+     * Get description for a property field path
+     * @param fieldPath The field path
+     * @returns The description, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const desc = builder.getFieldDescription("address.city");
+     * console.log(desc); // "The city (e.g. Chicago)"
+     * ```
+     */
+    getFieldDescription(fieldPath) {
+        return this.getFieldMetadata(fieldPath)?.description;
+    }
+    /**
+     * Get data type for a property field path
+     * @param fieldPath The field path
+     * @returns The data type, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new SearchCriteriaBuilder("test");
+     * const type = builder.getFieldType("address.city");
+     * console.log(type); // "string"
+     * ```
+     */
+    getFieldType(fieldPath) {
+        return this.getFieldMetadata(fieldPath)?.dataType;
+    }
+    /**
+     * Get Property field metadata for a SearchCriteria field path
+     * This helps you understand what Property field you're filtering on
+     * @param searchCriteriaPath The SearchCriteria field path (e.g., "address.city")
+     * @returns The Property field metadata, or undefined if not found
+     * @example
+     * ```typescript
+     * const builder = new AddressSearchCriteriaBuilder();
+     * builder.city((c) => {
+     *   // See what Property field this filters on
+     *   const meta = builder.getSearchCriteriaFieldMetadata("address.city");
+     *   console.log(`Filtering on: ${meta?.description}`);
+     *   c.equals("Phoenix");
+     * });
+     * ```
+     */
+    getSearchCriteriaFieldMetadata(searchCriteriaPath) {
+        // Dynamic import to avoid circular dependency
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const { getSearchCriteriaFieldMetadata } = require("../property-field/utils");
+        return getSearchCriteriaFieldMetadata(searchCriteriaPath);
+    }
+    /**
+     * Get SearchCriteria field metadata inferred from Property field metadata
+     * This provides a SearchCriteria-specific metadata object that explains what Property field
+     * you're filtering on, even if the mapping isn't exact
+     * @param searchCriteriaPath The SearchCriteria field path (e.g., "address.city")
+     * @returns SearchCriteria field metadata with Property field information
+     * @example
+     * ```typescript
+     * const builder = new AddressSearchCriteriaBuilder();
+     * builder.city((c) => {
+     *   // Get SearchCriteria metadata (inferred from Property metadata)
+     *   const scMeta = builder.getSearchCriteriaMetadata("address.city");
+     *   console.log(scMeta.description); // "Filter on: The city (e.g. Chicago)"
+     *   console.log(scMeta.hasPropertyMapping); // true
+     *   console.log(scMeta.propertyDataType); // "string"
+     *   c.equals("Phoenix");
+     * });
+     * ```
+     */
+    getSearchCriteriaMetadata(searchCriteriaPath) {
+        // Dynamic import to avoid circular dependency
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const { getSearchCriteriaMetadata } = require("../property-field/utils");
+        return getSearchCriteriaMetadata(searchCriteriaPath);
+    }
     /**
      * Helper method to set a property either directly or via a builder configurator.
      * This extracts the common pattern of checking if a configurator function is provided,

package/dist/builders/property-field-builder-mixin.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Property Field Builder Mixin
+ *
+ * Mixin to add metadata access capabilities to builders
+ */
+import type { PropertyFieldMetadata } from "../property-field/metadata";
+/**
+ * Interface for builders that support metadata access
+ */
+export interface MetadataAwareBuilder {
+    /**
+     * Get metadata for a field path
+     * @param fieldPath The field path (e.g., "address.city")
+     * @returns The field metadata, or undefined if not found
+     */
+    getFieldMetadata(fieldPath: string): PropertyFieldMetadata | undefined;
+    /**
+     * Get description for a field path
+     * @param fieldPath The field path
+     * @returns The description, or undefined if not found
+     */
+    getFieldDescription(fieldPath: string): string | undefined;
+    /**
+     * Get data type for a field path
+     * @param fieldPath The field path
+     * @returns The data type, or undefined if not found
+     */
+    getFieldType(fieldPath: string): PropertyFieldMetadata["dataType"] | undefined;
+}
+/**
+ * Mixin to add metadata capabilities to any builder
+ * @param Base The base builder class
+ * @returns A builder class with metadata access
+ */
+export declare function withMetadataAccess<T extends new (...args: any[]) => any>(Base: T): {
+    new (...args: any[]): {
+        [x: string]: any;
+        getFieldMetadata(fieldPath: string): PropertyFieldMetadata | undefined;
+        getFieldDescription(fieldPath: string): string | undefined;
+        getFieldType(fieldPath: string): PropertyFieldMetadata["dataType"] | undefined;
+    };
+} & T;
+/**
+ * Helper to get metadata for a builder field
+ * This can be used as a static method or utility function
+ */
+export declare function getBuilderFieldMetadata(fieldPath: string): PropertyFieldMetadata | undefined;

package/dist/builders/property-field-builder-mixin.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Property Field Builder Mixin
+ *
+ * Mixin to add metadata access capabilities to builders
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withMetadataAccess = withMetadataAccess;
+exports.getBuilderFieldMetadata = getBuilderFieldMetadata;
+const metadata_1 = require("../property-field/metadata");
+/**
+ * Mixin to add metadata capabilities to any builder
+ * @param Base The base builder class
+ * @returns A builder class with metadata access
+ */
+function withMetadataAccess(Base) {
+    return class extends Base {
+        getFieldMetadata(fieldPath) {
+            return (0, metadata_1.getFieldMetadata)(fieldPath);
+        }
+        getFieldDescription(fieldPath) {
+            return (0, metadata_1.getFieldMetadata)(fieldPath)?.description;
+        }
+        getFieldType(fieldPath) {
+            return (0, metadata_1.getFieldMetadata)(fieldPath)?.dataType;
+        }
+    };
+}
+/**
+ * Helper to get metadata for a builder field
+ * This can be used as a static method or utility function
+ */
+function getBuilderFieldMetadata(fieldPath) {
+    return (0, metadata_1.getFieldMetadata)(fieldPath);
+}

package/dist/{client.d.ts → client/client.d.ts}

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosResponse, AxiosError, InternalAxiosRequestConfig } from "axios";
 import { IBatchDataClient } from "./client.interface";
-import { ILogger } from "./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 "./types";
+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";
 /**
  * Middleware function that executes before an HTTP request is sent.
  * Can modify the request config or perform side effects (logging, metrics, etc.).

package/dist/{client.interface.d.ts → 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 "./types";
+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";
 /**
  * BatchData API Client Interface
  *

package/dist/{client.js → client/client.js}

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchDataClient = void 0;
 const axios_1 = __importDefault(require("axios"));
-const logger_interface_1 = require("./logger.interface");
-const builders_1 = require("./builders");
+const logger_interface_1 = require("../core/logger.interface");
+const builders_1 = require("../builders/builders");
 /**
  * BatchData API Client
  *

package/dist/{types.d.ts → core/types.d.ts}

@@ -711,33 +711,194 @@ export interface PropertySearchPreviewResponse {
  * Property address information
  */
 export interface PropertyAddress {
+    /**
+     * The validity of the address (e.g. Valid, Invalid, Partially Valid)
+     * @fieldPath address.addressValidity
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     addressValidity?: string;
+    /**
+     * House number of the property address.
+     * @fieldPath address.houseNumber
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     houseNumber?: string;
+    /**
+     * The street address (e.g. 123 Main Street)
+     * @fieldPath address.street
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     street?: string;
+    /**
+     * The city (e.g. Chicago)
+     * @fieldPath address.city
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     city?: string;
+    /**
+     * Property address County
+     * @fieldPath address.county
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     county?: string;
+    /**
+     * Property address state (2 letter abbreviation)
+     * @fieldPath address.state
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     state?: string;
+    /**
+     * Property address zip code.
+     * @fieldPath address.zip
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     zip?: string;
+    /**
+     * Property address zip+4 code
+     * @fieldPath address.zipPlus4
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     zipPlus4?: string;
+    /**
+     * The property's latitude
+     * @fieldPath address.latitude
+     * @dataType number
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     latitude?: number;
+    /**
+     * The property's longitude
+     * @fieldPath address.longitude
+     * @dataType number
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     longitude?: number;
+    /**
+     * The county FIPS code for the property address
+     * @fieldPath address.countyFipsCode
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     countyFipsCode?: string;
+    /**
+     * The property's address hash. Used to uniquely identify an address street, city, state and zip.
+     * @fieldPath address.hash
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     hash?: string;
 }
 /**
  * Mailing address information
  */
 export interface MailingAddress {
+    /**
+     * The street address (e.g. 123 Main St Apt 45)
+     * @fieldPath owner.mailingAddress.street
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     street?: string;
+    /**
+     * The city (e.g. Chicago)
+     * @fieldPath owner.mailingAddress.city
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     city?: string;
+    /**
+     * The state abbreviation (e.g. IL)
+     * @fieldPath owner.mailingAddress.state
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     state?: string;
+    /**
+     * The zip code (e.g. 12345)
+     * @fieldPath owner.mailingAddress.zip
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     zip?: string;
+    /**
+     * The owner mailing address' hash. Used to uniquely identify an address street, city, state and zip.
+     * @fieldPath owner.mailingAddress.hash
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     hash?: string;
+    /**
+     * The validity of the address (e.g. Valid, Invalid, Partially Valid)
+     * @fieldPath owner.mailingAddress.addressValidity
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     addressValidity?: string;
+    /**
+     * The county (e.g. Cook)
+     * @fieldPath owner.mailingAddress.county
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     county?: string;
+    /**
+     * The zip plus 4 code (e.g. 6789)
+     * @fieldPath owner.mailingAddress.zipPlus4
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     zipPlus4?: string;
+    /**
+     * The 2 digits representing the delivery point of the address + an additional check digit.
+     * @fieldPath owner.mailingAddress.deliveryPointCode
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     deliveryPointCode?: string;
+    /**
+     * Delivery point verification match code.
+     * @fieldPath owner.mailingAddress.dpvMatchCode
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     dpvMatchCode?: string;
+    /**
+     * Codes with more details about the DPV match.
+     * @fieldPath owner.mailingAddress.dpvFootnotes
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     dpvFootnotes?: string;
 }
 /**
@@ -798,6 +959,13 @@ export interface Foreclosure {
  * Property IDs
  */
 export interface PropertyIds {
+    /**
+     * The assessor's parcel number
+     * @fieldPath ids.apn
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     apn?: string;
 }
 /**
@@ -888,6 +1056,13 @@ export interface OwnerName {
  * Owner information
  */
 export interface Owner {
+    /**
+     * The property owner name(s)
+     * @fieldPath owner.fullName
+     * @dataType string
+     * @dataset Basic Property Data
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     fullName?: string;
     mailingAddress?: MailingAddress;
     names?: OwnerName[];
@@ -989,9 +1164,51 @@ export interface Valuation {
  */
 export interface Property {
     _id?: string;
+    /**
+     * The address of the listing brokerage
+     * @fieldPath listing.brokerage.address
+     * @dataType string
+     * @dataset Listing
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
+    /**
+     * The address of the listing brokerage
+     * @fieldPath listing.brokerage.address
+     * @dataType string
+     * @dataset Listing
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
+    /**
+     * The address of the listing brokerage
+     * @fieldPath listing.brokerage.address
+     * @dataType string
+     * @dataset Listing
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     address?: PropertyAddress;
     deedHistory?: DeedHistoryEntry[];
     demographics?: Demographics;
+    /**
+     * A flag indicating the sale/transfer is at auction by an investor or repossession by a financial institution
+     * @fieldPath deedHistory.[n].foreclosure
+     * @dataType boolean
+     * @dataset History (Deed)
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
+    /**
+     * A flag indicating the sale/transfer is at auction by an investor or repossession by a financial institution
+     * @fieldPath deedHistory.[n].foreclosure
+     * @dataType boolean
+     * @dataset History (Deed)
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
+    /**
+     * A flag indicating the sale/transfer is at auction by an investor or repossession by a financial institution
+     * @fieldPath deedHistory.[n].foreclosure
+     * @dataType boolean
+     * @dataset History (Deed)
+     * @see {@link getPropertyFieldMetadata} to get full metadata
+     */
     foreclosure?: Foreclosure;
     ids?: PropertyIds;
     images?: PropertyImages;

package/dist/index.d.ts

@@ -4,10 +4,14 @@
  * TypeScript SDK for BatchData.io Property API
  * Complete type definitions, fluent query builders, and utilities
  */
-export * from "./types";
-export * from "./builders";
-export * from "./errors";
-export * from "./client";
-export * from "./client.interface";
-export * from "./logger.interface";
-export type { RequestMiddleware, ResponseMiddleware, ErrorMiddleware, HttpMiddleware, } from "./client";
+export * from "./core/types";
+export * from "./builders/builders";
+export * from "./core/errors";
+export * from "./client/client";
+export * from "./client/client.interface";
+export * from "./core/logger.interface";
+export * from "./property-field/metadata";
+export * from "./property-field/utils";
+export { type PropertyFieldPathType, type PropertyFieldValueType, type FieldMetadataForPath, } from "./property-field/types";
+export type { SearchCriteriaFieldMapping, SearchCriteriaFieldMetadata, } from "./property-field/utils";
+export type { RequestMiddleware, ResponseMiddleware, ErrorMiddleware, HttpMiddleware, } from "./client/client";

package/dist/index.js

@@ -20,9 +20,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./builders"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./client"), exports);
-__exportStar(require("./client.interface"), exports);
-__exportStar(require("./logger.interface"), exports);
+__exportStar(require("./core/types"), exports);
+__exportStar(require("./builders/builders"), exports);
+__exportStar(require("./core/errors"), exports);
+__exportStar(require("./client/client"), exports);
+__exportStar(require("./client/client.interface"), exports);
+__exportStar(require("./core/logger.interface"), exports);
+__exportStar(require("./property-field/metadata"), exports);
+__exportStar(require("./property-field/utils"), exports);