@land-catalyst/batch-data-sdk 1.5.2 → 1.6.0

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, PropertyCountRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, RequestWithLookupOptions, RequestWithSearchCriteria, GeoPoint, AirConditioningSource, BasementType, BuildingClass, BuildingCondition, BuildingQuality, ConstructionType, Driveway, ExteriorWalls, FloorCover, Garage, HeatSource, HeatingFuelType, InteriorWalls, Patio, Pool, Porch, RoofCover, RoofType, Sewer, Style, WaterService, Features, HomeownerRenter, BusinessOwner, Gender, Investments, DemographicsValue, ReligiousAffiliation, ForeclosureStatus, PropertyTypeCategory, PropertyTypeDetail, LienType, LienTypeCode, LoanType, OwnerStatusType, LastSaleDocumentType, ZoningCode } 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, RequestWithLookupOptions, RequestWithSearchCriteria, GeoPoint, AirConditioningSource, BasementType, BuildingClass, BuildingCondition, BuildingQuality, ConstructionType, Driveway, ExteriorWalls, FloorCover, Garage, HeatSource, HeatingFuelType, InteriorWalls, Patio, Pool, Porch, RoofCover, RoofType, Sewer, Style, WaterService, Features, HomeownerRenter, BusinessOwner, Gender, Investments, DemographicsValue, ReligiousAffiliation, ForeclosureStatus, PropertyTypeCategory, PropertyTypeDetail, LienType, LienTypeCode, LoanType, OwnerStatusType, LastSaleDocumentType, ZoningCode, Dataset } from "../core/types";
 import type { PropertyFieldMetadata } from "../property-field/metadata";
 /**
  * Base interface for all builders
@@ -863,6 +863,18 @@ export declare class PropertyLookupOptionsBuilder {
     dateFormat(format: string): this;
     sort(field: string, order: "asc" | "desc" | "random", sessionId?: string): this;
     useSubdivision(enabled: boolean): this;
+    /**
+     * Specify which data sections to include in the response.
+     * Max 5 items. 'basic' and 'core' are mutually exclusive.
+     * If not specified, all datasets allowed for the API token are returned.
+     */
+    datasets(...datasets: Dataset[]): this;
+    /**
+     * Field-level projection to include/exclude specific fields.
+     * Use 1 to include, 0 to exclude.
+     * e.g. projection({ "address": 1, "owner.phoneNumbers": 0 })
+     */
+    projection(fields: Record<string, 0 | 1>): this;
     build(): PropertyLookupOptions;
 }
 /**

package/dist/builders/builders.js

@@ -2480,6 +2480,24 @@ class PropertyLookupOptionsBuilder {
         this.options.useSubdivision = enabled;
         return this;
     }
+    /**
+     * Specify which data sections to include in the response.
+     * Max 5 items. 'basic' and 'core' are mutually exclusive.
+     * If not specified, all datasets allowed for the API token are returned.
+     */
+    datasets(...datasets) {
+        this.options.datasets = datasets;
+        return this;
+    }
+    /**
+     * Field-level projection to include/exclude specific fields.
+     * Use 1 to include, 0 to exclude.
+     * e.g. projection({ "address": 1, "owner.phoneNumbers": 0 })
+     */
+    projection(fields) {
+        this.options.projection = fields;
+        return this;
+    }
     build() {
         return this.options;
     }

package/dist/core/types.d.ts

@@ -1932,6 +1932,14 @@ export type RequestWithLookupOptionsType = PropertySearchRequest | PropertySearc
  * Useful for writing generic functions that work with search-based requests
  */
 export type RequestWithSearchCriteriaType = PropertySearchRequest | PropertySearchAsyncRequest | PropertySubscriptionRequest;
+/**
+ * Specifies which data sections to include in the response.
+ * If not specified in the request, all datasets allowed for the API token are returned.
+ * Only datasets that are both requested AND permitted for the API token will be included.
+ * Note: 'basic' and 'core' are mutually exclusive — you can only request one or the other, not both.
+ * Max 5 items per request.
+ */
+export type Dataset = "basic" | "batchrank" | "contact" | "core" | "deed" | "demographic" | "foreclosure" | "image" | "listing" | "mortgage-liens" | "owner" | "permit" | "quicklist" | "valuation";
 /**
  * Property lookup options (shared with property search)
  */
@@ -1980,6 +1988,10 @@ export interface PropertyLookupOptions {
         sessionId?: string;
     };
     useSubdivision?: boolean;
+    /** Specifies which data sections to include in the response. Max 5 items. */
+    datasets?: Dataset[];
+    /** Field-level projection to include/exclude specific fields from the response. */
+    projection?: Record<string, 0 | 1>;
 }
 /**
  * Property search request (synchronous)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@land-catalyst/batch-data-sdk",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "TypeScript SDK for BatchData.io Property API - Types, Builders, and Utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,7 +38,8 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/land-catalyst/batch-data-sdk.git"
+    "url": "git+https://github.com/land-catalyst/land-catalyst.git",
+    "directory": "packages/batch-data-sdk"
   },
   "dependencies": {
     "axios": "^1.7.9"