Highways England API

/**
 * HighwaysEnglandAPI - generated by OmniStream from Highways England API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/highwaysengland";

export class HighwaysEnglandAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `HighwaysEnglandAPI error ${status}`);
    this.name = "HighwaysEnglandAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface HighwaysEnglandAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class HighwaysEnglandAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: HighwaysEnglandAPIOptions = {}) {
    if (!token) throw new Error("HighwaysEnglandAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new HighwaysEnglandAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Returns list of areas */
  areasGet(params: { "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/areas", { params });
  }

  /** Returns details of selected area */
  getvVersionAreasAreaIds(params: { "area_Ids": string; "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/areas/{area_Ids}", { params });
  }

  /** Get Site DailyQuality */
  qualityGetDailyDataQualityForSite(params: { "siteId": string; "start_date": string; "end_date": string; "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/quality/daily", { params });
  }

  /** Get Site OverallQuality */
  qualityGetOverallDataQualityForSites(params: { "sites": string; "start_date": string; "end_date": string; "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/quality/overall", { params });
  }

  /** Gets the daily report. */
  reportsIndex(params: { "report_type": string; "sites": string; "start_date": string; "end_date": string; "page": number; "page_size": number; "version": string; "reportSubTypeId"?: number }): Promise<any> {
    return this._request("GET", "/v{version}/reports/{report_type}", { params });
  }

  /** Gets the daily report. */
  getvVersionReportsStartDateToEndDateReport(params: { "report_type": string; "sites": string; "start_date": string; "end_date": string; "page": number; "page_size": number; "version": string; "reportSubTypeId"?: number }): Promise<any> {
    return this._request("GET", "/v{version}/reports/{start_date}/to/{end_date}/{report_type}", { params });
  }

  /** Get a list of sites */
  sitesIndex(params: { "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/sites", { params });
  }

  /** Get selected sites */
  getvVersionSitesSiteIds(params: { "site_Ids": string; "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/sites/{site_Ids}", { params });
  }

  /** Return list of site types */
  siteTypesIndex(params: { "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/sitetypes", { params });
  }

  /** Returns the layer metadata for the LayerId specified. */
  siteTypesGetSitesForPublicFacingAPI(params: { "siteType_Id": number; "version": string }): Promise<any> {
    return this._request("GET", "/v{version}/sitetypes/{siteType_Id}/sites", { params });
  }
}

export default HighwaysEnglandAPI;