misc: update measurement types

packages/bot-utils/src/get.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-await-in-loop */
 import got, { Headers, Response } from 'got';
 
-import type { MeasurementResponse } from './types.js';
+import type { Measurement } from './types.js';
 import { userAgent } from './user-agent.js';
 
 class MeasurementsFetcher {
@@ -12,15 +12,15 @@ class MeasurementsFetcher {
 	etags: Record<string, string>;
 
 	// caches Measurements by ETag
-	measurements: Record<string, MeasurementResponse>;
+	measurements: Record<string, Measurement>;
 
 	constructor (apiUrl: string) {
 		this.apiUrl = apiUrl;
 		this.etags = {};
 		this.measurements = {};
 	}
 
-	async fetchMeasurement (id: string): Promise<MeasurementResponse> {
+	async fetchMeasurement (id: string): Promise<Measurement> {
 		const headers: Headers = {
 			'User-Agent': userAgent(),
 			'Accept-Encoding': 'br',
@@ -59,7 +59,7 @@ class MeasurementsFetcher {
 			}
 		}
 
-		const measurementResponse: MeasurementResponse = JSON.parse(res.body);
+		const measurementResponse: Measurement = JSON.parse(res.body);
 
 		// save etag and response to cache
 		etag = res.headers.etag;
@@ -78,7 +78,7 @@ export const ApiUrl = 'https://api.globalping.io/v1/measurements';
 // api poll interval in milliseconds
 const apiPollInterval = 1000;
 
-export const getMeasurement = async (id: string): Promise<MeasurementResponse> => {
+export const getMeasurement = async (id: string): Promise<Measurement> => {
 	const measurementsFetcher = new MeasurementsFetcher(ApiUrl);
 
 	let data = await measurementsFetcher.fetchMeasurement(id);
@@ -93,11 +93,15 @@ export const getMeasurement = async (id: string): Promise<MeasurementResponse> =
 };
 
 export const getTag = (tags: string[]): string | undefined => {
-	if (tags.length === 0) { return undefined; }
+	if (tags.length === 0) {
+		return undefined;
+	}
 
 	// Iterarate through tags and return the first one that has its last character be a number
 	for (const tag of tags) {
-		if (Number.isInteger(Number(tag.slice(-1)))) { return `${tag}`; }
+		if (Number.isInteger(Number(tag.slice(-1)))) {
+			return `${tag}`;
+		}
 	}
 
 	return undefined;

packages/bot-utils/src/measurements-request.ts

@@ -13,19 +13,19 @@ import {
 	isHttpProtocol,
 	isMtrProtocol,
 	isTraceProtocol,
-	Locations,
-	PostMeasurement,
+	Location,
+	MeasurementCreate,
 } from './types.js';
 import { throwArgError } from './utils.js';
 
-function buildLocations (from: string): Locations[] {
+function buildLocations (from: string): Location[] {
 	return from
 		.split(',')
 		.map(f => f.trim())
-		.map((l): Locations => ({ magic: l }));
+		.map((l): Location => ({ magic: l }));
 }
 
-export const buildPostMeasurements = (args: Flags): PostMeasurement => {
+export const buildPostMeasurements = (args: Flags): MeasurementCreate => {
 	const {
 		cmd,
 		target,

packages/bot-utils/src/post.ts

@@ -1,13 +1,17 @@
 import got, { HTTPError } from 'got';
 
 import { PostError } from './errors.js';
-import type { PostMeasurement, PostMeasurementResponse } from './types.js';
+import type {
+	Location,
+	MeasurementCreate,
+	MeasurementCreateResponse,
+} from './types.js';
 import { userAgent } from './user-agent.js';
 
 export const postMeasurement = async (
-	opts: PostMeasurement,
+	opts: MeasurementCreate,
 	token?: string,
-): Promise<PostMeasurementResponse> => {
+): Promise<MeasurementCreateResponse> => {
 	try {
 		const headers: { [key: string]: string } = {
 			'Content-Type': 'application/json',
@@ -27,15 +31,15 @@ export const postMeasurement = async (
 
 		if (res.statusCode !== 202) {
 			const body = JSON.parse(res.body);
-			body.location = opts.locations[0].magic;
+			body.location = (opts.locations as Location[])[0].magic;
 			throw new Error(body);
 		}
 
 		return JSON.parse(res.body);
 	} catch (error) {
 		if (error instanceof HTTPError) {
 			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			const location = opts.locations[0].magic!;
+			const location = (opts.locations as Location[])[0].magic!;
 			const newError = new PostError(error.response, location, error.message);
 
 			throw newError;