OpenUV - Global Real-Time UV Index Forecast API

/**
 * OpenUVGlobalRealTimeUVIndexForecastAPI - generated by OmniStream from OpenUV - Global Real-Time UV Index Forecast 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/openuv";

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

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

export class OpenUVGlobalRealTimeUVIndexForecastAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: OpenUVGlobalRealTimeUVIndexForecastAPIOptions = {}) {
    if (!token) throw new Error("OpenUVGlobalRealTimeUVIndexForecastAPI: 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 OpenUVGlobalRealTimeUVIndexForecastAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Get hourly UV Index Forecast by location and date. Optional altitude, ozone level and datetime could be provided. */
  getforecast(params: { "lat": number; "lng": number; "x-access-token": string; "alt"?: number; "ozone"?: number; "dt"?: string }): Promise<any> {
    return this._request("GET", "/forecast", { params });
  }

  /** Get daily protection time by location, UV Index from and UV Index to with 10 minutes accuracy. Optional altitide and ozone level could be provided. */
  getprotection(params: { "lat": number; "lng": number; "from": number; "to": number; "x-access-token": string; "alt"?: number; "ozone"?: number }): Promise<any> {
    return this._request("GET", "/protection", { params });
  }

  /** Get real-time UV Index by location. Optional altitude, ozone level and datetime could be provided. */
  getuv(params: { "lat": number; "lng": number; "x-access-token": string; "alt"?: number; "ozone"?: number; "dt"?: string }): Promise<any> {
    return this._request("GET", "/uv", { params });
  }
}

export default OpenUVGlobalRealTimeUVIndexForecastAPI;