@vepler/http-sdk/dist/services/location/routes/address-lookup.js

The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.addressLookup = addressLookup;
var config_1 = require("../../../config");
var errors_1 = require("../../../utils/errors");
// All types are now imported from @vepler/locations-types
/**
 * Address to UPRN matching with LLM-powered parsing
 *
 * This endpoint provides intelligent address parsing and matching with:
 * - Fast-path optimization for well-formatted addresses (95%+ confidence)
 * - LLM-powered parsing for complex multi-address inputs
 * - Confidence scoring and fallback mechanisms
 * - Detailed processing insights
 *
 * @param params - Address lookup request parameters
 * @returns Promise resolving to address matches with metadata
 *
 * @example
 * ```typescript
 * import { location } from '@vepler/http-sdk';
 *
 * // Simple address lookup
 * const result = await location.lookup({
 *   addressString: "10 Downing Street, London SW1A 2AA"
 * });
 *
 * // Complex multi-address with options
 * const complexResult = await location.lookup({
 *   addressString: "37 barley avenue and 42 in pocklington YO442RW",
 *   options: {
 *     confidenceThreshold: 60,
 *     includeProcessingDetails: true,
 *     maxResults: 10
 *   }
 * });
 * ```
 */
function addressLookup(params) {
    return __awaiter(this, void 0, void 0, function () {
        var addressString, _a, options, api, endpoint, requestBody, requestOptions;
        var _b;
        return __generator(this, function (_c) {
            switch (_c.label) {
                case 0:
                    addressString = params.addressString, _a = params.options, options = _a === void 0 ? {} : _a;
                    // Validate required parameters
                    if (!addressString) {
                        throw new Error((0, errors_1.createRequiredParameterError)('addressString'));
                    }
                    if (addressString.length < 5) {
                        throw new Error('Address string must be at least 5 characters long');
                    }
                    if (addressString.length > 500) {
                        throw new Error('Address string must be less than 500 characters');
                    }
                    api = (0, config_1.getApiInstance)('locator');
                    endpoint = '/address/enhanced-lookup';
                    requestBody = {
                        addressString: addressString,
                        options: {
                            confidenceThreshold: options.confidenceThreshold || 70,
                            fallbackThreshold: options.fallbackThreshold || 60,
                            maxResults: options.maxResults || 5,
                            enableFallback: options.enableFallback !== false,
                            includeProcessingDetails: options.includeProcessingDetails || false,
                            timeout: options.timeout || 120000
                        }
                    };
                    requestOptions = {
                        apiKey: config_1.initialisedConfig.apiKey,
                        timeout: Math.max(((_b = requestBody.options) === null || _b === void 0 ? void 0 : _b.timeout) || 120000, 150000) // At least 2.5 minutes
                    };
                    return [4 /*yield*/, api.post(endpoint, requestBody, requestOptions)];
                case 1: return [2 /*return*/, _c.sent()];
            }
        });
    });
}
//# sourceMappingURL=address-lookup.js.map