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

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

@@ -379,10 +379,20 @@ export interface SearchCriteria {
     or?: OrSearchCriteria[];
 }
 /**
- * Delivery configuration for webhook or Kinesis
+ * Event Hub configuration for Azure Event Hubs
+ */
+export interface EventHubConfig {
+    fullyQualifiedNamespace: string;
+    clientId: string;
+    tenantId: string;
+    clientSecret: string;
+    eventHubName: string;
+}
+/**
+ * Delivery configuration for webhook, Kinesis, or Event Hub
  */
 export interface DeliveryConfig {
-    type: "webhook" | "kinesis";
+    type: "webhook" | "kinesis" | "event-hub";
     streamName?: string;
     region?: string;
     iamAccessKeyId?: string;
@@ -390,6 +400,7 @@ export interface DeliveryConfig {
     url?: string;
     errorUrl?: string;
     headers?: Record<string, string>;
+    eventHub?: EventHubConfig;
 }
 /**
  * Property subscription request payload
@@ -711,33 +722,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 +970,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 +1067,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 +1175,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);

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

@@ -0,0 +1,105 @@
+/**
+ * Property Field Metadata
+ *
+ * This file contains metadata about all available property response fields,
+ * generated from the property-details-data-dictionary.csv file.
+ *
+ * This metadata can be used for:
+ * - Type-safe field path access
+ * - Documentation generation
+ * - Field validation
+ * - IDE autocomplete
+ *
+ * @generated This file is auto-generated. Do not edit manually.
+ * Run: node scripts/generate-property-field-metadata.js
+ */
+/**
+ * Property field data type
+ */
+export type PropertyFieldType = "string" | "number" | "boolean" | "date" | "array[string]" | "array[number]" | "object";
+/**
+ * Property field metadata entry
+ */
+export interface PropertyFieldMetadata {
+    /**
+     * The field path in the response (e.g., "address.city", "owner.names.[n].first")
+     */
+    fieldPath: string;
+    /**
+     * The dataset this field belongs to
+     */
+    dataset: string;
+    /**
+     * The top-level response group name (e.g., "address", "owner")
+     */
+    responseGroupName?: string;
+    /**
+     * The resource sub-group name (e.g., "mailingAddress", "names")
+     */
+    resourceSubGroupName?: string;
+    /**
+     * The field name
+     */
+    name: string;
+    /**
+     * The data type
+     */
+    dataType: PropertyFieldType;
+    /**
+     * Human-readable description
+     */
+    description: string;
+    /**
+     * Whether this field is an array element (indicated by [n] in the path)
+     */
+    isArrayElement: boolean;
+}
+/**
+ * Registry of all property field metadata, indexed by field path
+ */
+export declare const PROPERTY_FIELD_METADATA: Record<string, PropertyFieldMetadata>;
+/**
+ * Get metadata for a specific field path
+ * @param fieldPath The field path (e.g., "address.city")
+ * @returns The field metadata, or undefined if not found
+ */
+export declare function getFieldMetadata(fieldPath: string): PropertyFieldMetadata | undefined;
+/**
+ * Get all fields for a specific dataset
+ * @param dataset The dataset name
+ * @returns Array of field metadata
+ */
+export declare function getFieldsByDataset(dataset: string): PropertyFieldMetadata[];
+/**
+ * Get all fields for a specific response group
+ * @param responseGroupName The response group name (e.g., "address", "owner")
+ * @returns Array of field metadata
+ */
+export declare function getFieldsByResponseGroup(responseGroupName: string): PropertyFieldMetadata[];
+/**
+ * Get all available field paths
+ * @returns Array of field paths
+ */
+export declare function getAllFieldPaths(): string[];
+/**
+ * Get all available datasets
+ * @returns Array of unique dataset names
+ */
+export declare function getAllDatasets(): string[];
+/**
+ * Get all available response groups
+ * @returns Array of unique response group names
+ */
+export declare function getAllResponseGroups(): string[];
+/**
+ * Check if a field path exists in the metadata
+ * @param fieldPath The field path to check
+ * @returns True if the field exists
+ */
+export declare function hasField(fieldPath: string): boolean;
+/**
+ * Get the TypeScript type for a field based on its data type
+ * @param dataType The property field data type
+ * @returns The TypeScript type string
+ */
+export declare function getTypeScriptType(dataType: PropertyFieldType): string;