@tileflow/routing 0.0.0-stage → 0.1.0-alpha.1

package/dist/client.d.ts

@@ -0,0 +1,53 @@
+import { RoutingErrorCode, RoutingIsochroneRequest, RoutingIsochroneResponse, RoutingMatchRequest, RoutingMatchResponse, RoutingMatrixRequest, RoutingMatrixResponse, RoutingNearestRequest, RoutingNearestResponse, RoutingRouteRequest, RoutingRouteResponse } from './contract.js';
+import 'zod';
+
+type RoutingOptions = Readonly<{
+    /** A Tileflow credential with the Routing permission. */
+    apiKey: string;
+    /** Defaults to `https://api.tileflow.dev`. Plain HTTP is accepted only on loopback. */
+    apiUrl?: string;
+    /**
+     * The native app a publishable credential admits: its iOS bundle ID, or its Android package name
+     * with the SHA-256 fingerprint of its signing certificate. Browsers send their origin instead.
+     */
+    app?: Readonly<{
+        id: string;
+        certificateSha256?: string;
+    }>;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}>;
+declare class RoutingError extends Error {
+    readonly code: RoutingErrorCode | null;
+    readonly requestId: string | null;
+    readonly status: number;
+    readonly retryAfterSeconds: number | null;
+    constructor(message: string, input: {
+        code?: RoutingErrorCode;
+        requestId?: string;
+        status: number;
+        retryAfterSeconds?: number | null;
+    });
+}
+/**
+ * The fastest route through two to five positions, with up to two alternatives between two
+ * positions. Each route has its line, distance, duration, turn-by-turn steps and whether it uses
+ * tolls, highways or ferries.
+ */
+declare function route(request: RoutingRouteRequest, options: RoutingOptions): Promise<RoutingRouteResponse>;
+/** The areas reachable from a position in one to four times, one polygon per time. */
+declare function isochrone(request: RoutingIsochroneRequest, options: RoutingOptions): Promise<RoutingIsochroneResponse>;
+/**
+ * Travel times and distances from every source to every target: one row per source, one column
+ * per target, in request order, with `null` where no route connects a pair.
+ */
+declare function matrix(request: RoutingMatrixRequest, options: RoutingOptions): Promise<RoutingMatrixResponse>;
+/**
+ * The roads a GPS trace followed: the matched line, where each trace position was matched, and
+ * each road with what OpenStreetMap records about it, including tagged speed limits.
+ */
+declare function match(request: RoutingMatchRequest, options: RoutingOptions): Promise<RoutingMatchResponse>;
+/** The nearest point of a road the mode can use, its distance and what OpenStreetMap records. */
+declare function nearest(request: RoutingNearestRequest, options: RoutingOptions): Promise<RoutingNearestResponse>;
+
+export { RoutingError, type RoutingOptions, isochrone, match, matrix, nearest, route };

package/dist/client.js

@@ -0,0 +1,17 @@
+import {
+  RoutingError,
+  isochrone,
+  match,
+  matrix,
+  nearest,
+  route
+} from "./chunk-MCATD4FU.js";
+import "./chunk-ECBK2QPL.js";
+export {
+  RoutingError,
+  isochrone,
+  match,
+  matrix,
+  nearest,
+  route
+};