@vepler/http-sdk
Version:
The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.
129 lines • 6.79 kB
JavaScript
;
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.queryGeographyMetricsValidation = void 0;
exports.queryGeographyMetrics = queryGeographyMetrics;
var config_1 = require("../../../config");
var datePattern = /^\d{4}-\d{2}$/;
// This would be the actual Joi implementation in the API route handler
exports.queryGeographyMetricsValidation = {
query: {
geographicCodes: {
required: true,
description: 'Comma-separated list of geographic codes',
},
periods: {
description: 'Comma-separated list of periods in YYYY-MM format',
custom: function (value) {
// Split by comma and validate each period
var periods = value.split(',');
for (var _i = 0, periods_1 = periods; _i < periods_1.length; _i++) {
var period = periods_1[_i];
if (!datePattern.test(period.trim())) {
return new Error("Invalid period format: ".concat(period));
}
}
return value;
},
},
startDate: {
description: 'Start date in YYYY-MM format for period range',
custom: function (value) {
if (!datePattern.test(value)) {
return new Error("Invalid date format: ".concat(value));
}
return value;
},
},
endDate: {
description: 'End date in YYYY-MM format for period range',
custom: function (value) {
if (!datePattern.test(value)) {
return new Error("Invalid date format: ".concat(value));
}
return value;
},
},
mergeAreas: {
default: false,
description: 'Whether to merge all geographic areas into one combined result',
},
includeTimeSeries: {
default: true,
description: 'Whether to include time series data in the response',
},
months: {
min: 1,
max: 24,
default: 12,
description: 'Number of months to include in time series data',
},
},
// This is a pseudo representation of Joi's .or() and .and() methods
validationRules: [{ type: 'or', fields: ['periods', 'startDate'] }],
};
function queryGeographyMetrics(params) {
return __awaiter(this, void 0, void 0, function () {
var geographicCodes, periods, startDate, endDate, _a, mergeAreas, _b, includeTimeSeries, _c, months, api, endpoint;
return __generator(this, function (_d) {
switch (_d.label) {
case 0:
geographicCodes = params.geographicCodes, periods = params.periods, startDate = params.startDate, endDate = params.endDate, _a = params.mergeAreas, mergeAreas = _a === void 0 ? false : _a, _b = params.includeTimeSeries, includeTimeSeries = _b === void 0 ? true : _b, _c = params.months, months = _c === void 0 ? 12 : _c;
// Validate that either periods OR (startDate AND endDate) is provided
if (!periods && !(startDate && endDate)) {
throw new Error('Either "periods" or both "startDate" and "endDate" must be provided');
}
api = (0, config_1.getApiInstance)('safety');
endpoint = "/geography/metrics";
return [4 /*yield*/, api.query(endpoint, {
geographicCodes: geographicCodes,
periods: periods,
startDate: startDate,
endDate: endDate,
mergeAreas: mergeAreas,
includeTimeSeries: includeTimeSeries,
months: months,
}, {
apiKey: config_1.initialisedConfig.apiKey,
})];
case 1: return [2 /*return*/, _d.sent()];
}
});
});
}
//# sourceMappingURL=query-geography-metrics.js.map