GraphHopper Directions

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

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

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

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

  /** POST Cluster Endpoint */
  solveClusteringProblem(body: unknown): Promise<any> {
    return this._request("POST", "/cluster", { body });
  }

  /** Batch Cluster Endpoint */
  asyncClusteringProblem(body: unknown): Promise<any> {
    return this._request("POST", "/cluster/calculate", { body });
  }

  /** GET Batch Solution Endpoint */
  getClusterSolution(params: { "jobId": string }): Promise<any> {
    return this._request("GET", "/cluster/solution/{jobId}", { params });
  }

  /** Geocoding Endpoint */
  getGeocode(params: { "q"?: string; "locale"?: string; "limit"?: number; "reverse"?: boolean; "debug"?: boolean; "point"?: string; "provider"?: string }): Promise<any> {
    return this._request("GET", "/geocode", { params });
  }

  /** Isochrone Endpoint */
  getIsochrone(params: { "point": string; "time_limit"?: number; "distance_limit"?: number; "vehicle"?: string; "buckets"?: number; "reverse_flow"?: boolean; "weighting"?: string }): Promise<any> {
    return this._request("GET", "/isochrone", { params });
  }

  /** Map-match a GPX file */
  postGPX(params: { "gps_accuracy"?: number; "vehicle"?: string }): Promise<any> {
    return this._request("POST", "/match", { params });
  }

  /** GET Matrix Endpoint */
  getMatrix(params: { "point"?: unknown[]; "from_point"?: unknown[]; "to_point"?: unknown[]; "point_hint"?: unknown[]; "from_point_hint"?: unknown[]; "to_point_hint"?: unknown[]; "snap_prevention"?: unknown[]; "curbside"?: unknown[]; "from_curbside"?: unknown[]; "to_curbside"?: unknown[]; "out_array"?: unknown[]; "vehicle"?: string; "fail_fast"?: boolean; "turn_costs"?: boolean }): Promise<any> {
    return this._request("GET", "/matrix", { params });
  }

  /** POST Matrix Endpoint */
  postMatrix(body: unknown): Promise<any> {
    return this._request("POST", "/matrix", { body });
  }

  /** Batch Matrix Endpoint */
  calculateMatrix(body: unknown): Promise<any> {
    return this._request("POST", "/matrix/calculate", { body });
  }

  /** GET Batch Matrix Endpoint */
  getMatrixSolution(params: { "jobId": string }): Promise<any> {
    return this._request("GET", "/matrix/solution/{jobId}", { params });
  }

  /** GET Route Endpoint */
  getRoute(params: { "point": unknown[]; "point_hint"?: unknown[]; "snap_prevention"?: unknown[]; "vehicle"?: string; "curbside"?: unknown[]; "turn_costs"?: boolean; "locale"?: string; "elevation"?: boolean; "details"?: unknown[]; "optimize"?: string; "instructions"?: boolean; "calc_points"?: boolean; "debug"?: boolean; "points_encoded"?: boolean; "ch.disable"?: boolean; "weighting"?: string; "heading"?: unknown[]; "heading_penalty"?: number; "pass_through"?: boolean; "block_area"?: string; "avoid"?: string; "algorithm"?: string; "round_trip.distance"?: number; "round_trip.seed"?: number; "alternative_route.max_paths"?: number; "alternative_route.max_weight_factor"?: number; "alternative_route.max_share_factor"?: number }): Promise<any> {
    return this._request("GET", "/route", { params });
  }

  /** POST Route Endpoint */
  postRoute(body: unknown): Promise<any> {
    return this._request("POST", "/route", { body });
  }

  /** Coverage information */
  getrouteInfo(): Promise<any> {
    return this._request("GET", "/route/info", {});
  }

  /** POST route optimization problem */
  solveVRP(body: unknown): Promise<any> {
    return this._request("POST", "/vrp", { body });
  }

  /** POST route optimization problem (batch mode) */
  asyncVRP(body: unknown): Promise<any> {
    return this._request("POST", "/vrp/optimize", { body });
  }

  /** GET the solution (batch mode) */
  getSolution(params: { "jobId": string }): Promise<any> {
    return this._request("GET", "/vrp/solution/{jobId}", { params });
  }
}

export default GraphHopperDirections;