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

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;