@tiducto/spider-sdk-typescript 0.1.0

package/dist/realtime.js

@@ -0,0 +1,149 @@
+import { parseJson } from "./http.js";
+import { failure, success } from "./result.js";
+import { SpiderContractMismatchError, TransportError, toSpiderError } from "./errors.js";
+import { occupancyFromWire } from "./enums.js";
+const EMPTY_FRESHNESS = { feedTimestampEpochMs: null, staleSeconds: null };
+const EMPTY_POSITIONS = { vehicles: [], missing: [], freshness: EMPTY_FRESHNESS };
+const EMPTY_DELAYS = { delays: [], missing: [], freshness: EMPTY_FRESHNESS };
+export class SpiderRealtime {
+    transport;
+    constructor(transport) {
+        this.transport = transport;
+    }
+    async vehicles(tripIds) {
+        if (tripIds.length === 0)
+            return success(EMPTY_POSITIONS);
+        try {
+            const dto = await this.transport.getJson('/realtime/vehicles', {
+                tripIds: tripIds.join(','),
+            });
+            return success({
+                vehicles: (dto.vehicles ?? []).map(mapVehicle),
+                missing: dto.missing ?? [],
+                freshness: mapFreshness(dto),
+            });
+        }
+        catch (e) {
+            if (e instanceof SpiderContractMismatchError)
+                throw e;
+            return failure(toSpiderError(e));
+        }
+    }
+    async vehicleForTrip(tripId) {
+        const path = `/realtime/vehicles/by-trip/${encodeURIComponent(tripId)}`;
+        try {
+            const raw = await this.transport.getRaw(path);
+            if (raw.status === 404) {
+                return success({ vehicle: null, freshness: EMPTY_FRESHNESS });
+            }
+            if (!raw.ok) {
+                throw new TransportError('http', `GET ${path} -> ${raw.status}: ${raw.text.slice(0, 300)}`, raw.status);
+            }
+            const dto = parseJson(raw.text, path);
+            return success({
+                vehicle: dto.vehicle != null ? mapVehicle(dto.vehicle) : null,
+                freshness: mapFreshness(dto),
+            });
+        }
+        catch (e) {
+            if (e instanceof SpiderContractMismatchError)
+                throw e;
+            return failure(toSpiderError(e));
+        }
+    }
+    async delays(tripIds) {
+        if (tripIds.length === 0)
+            return success(EMPTY_DELAYS);
+        try {
+            const dto = await this.transport.getJson('/realtime/delays', {
+                tripIds: tripIds.join(','),
+            });
+            return success({
+                delays: (dto.delays ?? []).map(mapDelay),
+                missing: dto.missing ?? [],
+                freshness: mapFreshness(dto),
+            });
+        }
+        catch (e) {
+            if (e instanceof SpiderContractMismatchError)
+                throw e;
+            return failure(toSpiderError(e));
+        }
+    }
+    async alerts() {
+        try {
+            const dto = await this.transport.getJson('/realtime/alerts');
+            return success({
+                alerts: (dto.alerts ?? []).map(mapAlert),
+                freshness: mapFreshness(dto),
+            });
+        }
+        catch (e) {
+            if (e instanceof SpiderContractMismatchError)
+                throw e;
+            return failure(toSpiderError(e));
+        }
+    }
+}
+function secondsToMs(value) {
+    return value != null ? value * 1000 : null;
+}
+function mapFreshness(dto) {
+    return { feedTimestampEpochMs: secondsToMs(dto.feedTimestamp), staleSeconds: dto.staleSeconds ?? null };
+}
+function mapVehicle(v) {
+    return {
+        tripId: v.tripId ?? null,
+        routeId: v.routeId ?? null,
+        vehicleId: v.vehicleId ?? null,
+        label: v.label ?? null,
+        latitude: v.latitude ?? null,
+        longitude: v.longitude ?? null,
+        bearing: v.bearing ?? null,
+        speed: v.speed ?? null,
+        stopId: v.stopId ?? null,
+        currentStatus: v.currentStatus ?? null,
+        occupancy: occupancyFromWire(v.occupancyStatus),
+        timestampEpochMs: secondsToMs(v.timestamp),
+    };
+}
+function mapDelay(d) {
+    return {
+        tripId: d.tripId ?? null,
+        routeId: d.routeId ?? null,
+        delaySeconds: d.delaySeconds ?? null,
+        scheduleRelationship: d.scheduleRelationship ?? null,
+        stopTimeUpdates: (d.stopTimeUpdates ?? []).map(mapStopTimeUpdate),
+    };
+}
+function mapStopTimeUpdate(s) {
+    return {
+        stopId: s.stopId ?? null,
+        stopSequence: s.stopSequence ?? null,
+        arrivalDelay: s.arrivalDelay ?? null,
+        departureDelay: s.departureDelay ?? null,
+        scheduleRelationship: s.scheduleRelationship ?? null,
+    };
+}
+function mapAlert(a) {
+    return {
+        id: a.id ?? null,
+        cause: a.cause ?? null,
+        effect: a.effect ?? null,
+        severityLevel: a.severityLevel ?? null,
+        headerText: a.headerText ?? null,
+        descriptionText: a.descriptionText ?? null,
+        url: a.url ?? null,
+        activePeriods: (a.activePeriods ?? []).map((p) => ({
+            startEpochMs: secondsToMs(p.start),
+            endEpochMs: secondsToMs(p.end),
+        })),
+        informedEntities: (a.informedEntities ?? []).map((e) => ({
+            agencyId: e.agencyId ?? null,
+            routeId: e.routeId ?? null,
+            tripId: e.tripId ?? null,
+            stopId: e.stopId ?? null,
+        })),
+    };
+}
+//# sourceMappingURL=realtime.js.map

package/dist/realtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.js","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,2BAA2B,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEzF,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAoF/C,MAAM,eAAe,GAAkB,EAAE,oBAAoB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AAC1F,MAAM,eAAe,GAAqB,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;AACpG,MAAM,YAAY,GAAe,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;AAEzF,MAAM,OAAO,cAAc;IACR,SAAS,CAAY;IAEtC,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAA0B;QACvC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC,eAAe,CAAC,CAAC;QAC1D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAuB,oBAAoB,EAAE;gBACnF,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;gBACb,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;gBAC9C,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE;gBAC1B,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,2BAA2B;gBAAE,MAAM,CAAC,CAAC;YACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAAc;QACjC,MAAM,IAAI,GAAG,8BAA8B,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,CAAC;YAChE,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,OAAO,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1G,CAAC;YACD,MAAM,GAAG,GAAG,SAAS,CAA4B,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACjE,OAAO,OAAO,CAAC;gBACb,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;gBAC7D,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,2BAA2B;gBAAE,MAAM,CAAC,CAAC;YACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAA0B;QACrC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAqB,kBAAkB,EAAE;gBAC/E,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;gBACxC,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE;gBAC1B,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,2BAA2B;gBAAE,MAAM,CAAC,CAAC;YACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM;QACV,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAqB,kBAAkB,CAAC,CAAC;YACjF,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;gBACxC,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,2BAA2B;gBAAE,MAAM,CAAC,CAAC;YACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;CACF;AAED,SAAS,WAAW,CAAC,KAAgC;IACnD,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7C,CAAC;AAED,SAAS,YAAY,CAAC,GAAkB;IACtC,OAAO,EAAE,oBAAoB,EAAE,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;AAC1G,CAAC;AAED,SAAS,UAAU,CAAC,CAAiB;IACnC,OAAO;QACL,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;QACxB,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;QAC1B,SAAS,EAAE,CAAC,CAAC,SAAS,IAAI,IAAI;QAC9B,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI;QACtB,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI;QAC5B,SAAS,EAAE,CAAC,CAAC,SAAS,IAAI,IAAI;QAC9B,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;QAC1B,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI;QACtB,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;QACxB,aAAa,EAAE,CAAC,CAAC,aAAa,IAAI,IAAI;QACtC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,eAAe,CAAC;QAC/C,gBAAgB,EAAE,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;KAC3C,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,CAAe;IAC/B,OAAO;QACL,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;QACxB,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;QAC1B,YAAY,EAAE,CAAC,CAAC,YAAY,IAAI,IAAI;QACpC,oBAAoB,EAAE,CAAC,CAAC,oBAAoB,IAAI,IAAI;QACpD,eAAe,EAAE,CAAC,CAAC,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC;KAClE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAwB;IACjD,OAAO;QACL,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;QACxB,YAAY,EAAE,CAAC,CAAC,YAAY,IAAI,IAAI;QACpC,YAAY,EAAE,CAAC,CAAC,YAAY,IAAI,IAAI;QACpC,cAAc,EAAE,CAAC,CAAC,cAAc,IAAI,IAAI;QACxC,oBAAoB,EAAE,CAAC,CAAC,oBAAoB,IAAI,IAAI;KACrD,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,CAAe;IAC/B,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,IAAI;QAChB,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI;QACtB,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;QACxB,aAAa,EAAE,CAAC,CAAC,aAAa,IAAI,IAAI;QACtC,UAAU,EAAE,CAAC,CAAC,UAAU,IAAI,IAAI;QAChC,eAAe,EAAE,CAAC,CAAC,eAAe,IAAI,IAAI;QAC1C,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI;QAClB,aAAa,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACjD,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;YAClC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;QACH,gBAAgB,EAAE,CAAC,CAAC,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACvD,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI;YAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;YAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;YACxB,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI;SACzB,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC"}

package/dist/result.d.ts

@@ -0,0 +1,13 @@
+import type { SpiderError } from './errors.ts';
+export type SpiderResult<T> = {
+    readonly isSuccess: true;
+    readonly data: T;
+    readonly error?: undefined;
+} | {
+    readonly isSuccess: false;
+    readonly error: SpiderError;
+    readonly data?: undefined;
+};
+export declare function success<T>(data: T): SpiderResult<T>;
+export declare function failure<T = never>(error: SpiderError): SpiderResult<T>;
+//# sourceMappingURL=result.d.ts.map

package/dist/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,MAAM,YAAY,CAAC,CAAC,IACtB;IAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAC1E;IAAE,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE1F,wBAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAEnD;AAED,wBAAgB,OAAO,CAAC,CAAC,GAAG,KAAK,EAAE,KAAK,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAEtE"}

package/dist/result.js

@@ -0,0 +1,7 @@
+export function success(data) {
+    return { isSuccess: true, data };
+}
+export function failure(error) {
+    return { isSuccess: false, error };
+}
+//# sourceMappingURL=result.js.map

package/dist/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,OAAO,CAAI,IAAO;IAChC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,OAAO,CAAY,KAAkB;IACnD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACrC,CAAC"}

package/dist/routing.d.ts

@@ -0,0 +1,157 @@
+import type { Transport } from './http.ts';
+import type { SpiderResult } from './result.ts';
+import type { BikesAllowed, TransitMode, WheelchairBoarding } from './enums.ts';
+import type { Location, ViaLocation } from './location.ts';
+import type { RoutingErrorCode, InputField, RealtimeState } from './contract/routing/index.ts';
+export interface LatLon {
+    readonly lat: number;
+    readonly lon: number;
+}
+export interface Leg {
+    readonly mode: TransitMode | null;
+    readonly startScheduled: string;
+    readonly endScheduled: string;
+    readonly fromName: string | null;
+    readonly toName: string | null;
+    readonly routeShortName: string | null;
+    readonly routeLongName: string | null;
+    readonly headsign: string | null;
+    readonly distanceMeters: number | null;
+    readonly durationSeconds: number | null;
+    readonly tripGtfsId: string | null;
+    readonly bikesAllowed: BikesAllowed | null;
+    readonly accessibilityScore: number | null;
+    readonly fromWheelchair: WheelchairBoarding | null;
+    readonly toWheelchair: WheelchairBoarding | null;
+    readonly geometry: readonly LatLon[];
+}
+export interface Itinerary {
+    readonly start: string | null;
+    readonly end: string | null;
+    readonly durationSeconds: number;
+    readonly waitingTimeSeconds: number | null;
+    readonly numberOfTransfers: number;
+    readonly accessibilityScore: number | null;
+    readonly legs: readonly Leg[];
+}
+export interface RouteEdge {
+    readonly cursor: string;
+    readonly itinerary: Itinerary;
+}
+export interface RoutePageInfo {
+    readonly startCursor: string | null;
+    readonly endCursor: string | null;
+    readonly hasNextPage: boolean;
+    readonly hasPreviousPage: boolean;
+    readonly searchWindowUsed: string | null;
+}
+export interface RoutingError {
+    readonly code: RoutingErrorCode;
+    readonly description: string;
+    readonly inputField: InputField | null;
+}
+export interface Route {
+    readonly edges: readonly RouteEdge[];
+    readonly pageInfo: RoutePageInfo;
+    readonly routingErrors: readonly RoutingError[];
+    readonly searchDateTime: string | null;
+}
+export interface Departure {
+    readonly scheduledTimeEpochMs: number;
+    readonly realtimeTimeEpochMs: number | null;
+    readonly isRealtime: boolean;
+    readonly realtimeState: RealtimeState | null;
+    readonly headsign: string | null;
+    readonly tripGtfsId: string | null;
+    readonly routeShortName: string | null;
+    readonly routeLongName: string | null;
+    readonly mode: TransitMode | null;
+}
+export interface TripStop {
+    readonly gtfsId: string;
+    readonly name: string;
+    readonly lat: number | null;
+    readonly lon: number | null;
+    readonly scheduledArrivalEpochMs: number | null;
+    readonly scheduledDepartureEpochMs: number | null;
+    readonly realtimeArrivalEpochMs: number | null;
+    readonly realtimeDepartureEpochMs: number | null;
+    readonly isRealtime: boolean;
+    readonly wheelchairBoarding: WheelchairBoarding | null;
+}
+export interface TripDetails {
+    readonly gtfsId: string;
+    readonly routeShortName: string | null;
+    readonly routeLongName: string | null;
+    readonly mode: TransitMode | null;
+    readonly headsign: string | null;
+    readonly directionId: string | null;
+    readonly bikesAllowed: BikesAllowed | null;
+    readonly stops: readonly TripStop[];
+    readonly geometry: readonly LatLon[];
+}
+export interface PlanOptions {
+    readonly origin: Location;
+    readonly destination: Location;
+    readonly first?: number;
+    readonly departAt?: number | Date;
+    readonly arriveBy?: number | Date;
+    readonly via?: readonly ViaLocation[];
+    /** Restrict routing to these transit modes. Undefined/empty = no filter (all modes); WALK/UNKNOWN drop out. */
+    readonly allowedTransitModes?: readonly TransitMode[];
+    /** Absolute cap on transfers in any returned itinerary. Undefined = OTP default. */
+    readonly maxTransfers?: number;
+    /**
+     * Search window in minutes (default 60). Always sent, deliberately not OTP's dynamic route-dependent
+     * window — predictable cost + paging. Widen for sparse/intercity routes.
+     */
+    readonly searchWindowMinutes?: number;
+    /** Prefer wheelchair-accessible routing. */
+    readonly wheelchairAccessible?: boolean;
+}
+/** Options for the streaming `planUntil` — the plan filters plus the walk's bounds. `searchWindowMinutes` is the step. */
+export interface PlanStreamOptions extends Omit<PlanOptions, 'first'> {
+    /** Stop once ~this many itineraries have been collected (soft — the window that reaches it is yielded whole). */
+    readonly targetResults?: number;
+    /** Stop after stepping through this much total time (default 360 = 6h). `searchWindowMinutes` is the step size. */
+    readonly maxTraversalMinutes?: number;
+}
+/** Bounds for the streaming continuations `planNextUntil` / `planPreviousUntil` (the step is fixed from `prev`). */
+export interface PlanStreamPageOptions {
+    readonly targetResults?: number;
+    readonly maxTraversalMinutes?: number;
+}
+export interface DeparturesOptions {
+    readonly startTime?: number | Date;
+    readonly timeRangeSeconds?: number;
+}
+export declare class SpiderRouting {
+    private readonly transport;
+    constructor(transport: Transport);
+    plan(options: PlanOptions): Promise<SpiderResult<Route>>;
+    planNext(route: Route, first?: number): Promise<SpiderResult<Route> | null>;
+    planPrevious(route: Route, last?: number): Promise<SpiderResult<Route> | null>;
+    /**
+     * Streams itineraries by stepping the search forward one search window at a time, until `targetResults`
+     * itineraries have been collected or `maxTraversalMinutes` of time has been traversed. Each step pulls a
+     * whole window in one search, so a busy window yields more — `targetResults` is a soft floor, the window
+     * that reaches it is yielded whole. Lazy: `for await ... break` stops stepping and skips the remaining OTP
+     * searches. Each yield is one step's `SpiderResult` (a terminal error ends the stream), matching the
+     * non-throwing poll helpers.
+     *
+     * The step is `searchWindowMinutes` and it is fixed for the whole walk — OTP locks the window into the
+     * paging cursor after the first search and ignores it thereafter, so a wider step means a wider
+     * `searchWindowMinutes` here, not on a continuation.
+     */
+    planUntil(options: PlanStreamOptions): AsyncGenerator<SpiderResult<Route>>;
+    /** Streaming form of `planNext`: steps forward from `prev`, one (fixed) search window per step. */
+    planNextUntil(prev: Route, options?: PlanStreamPageOptions): AsyncGenerator<SpiderResult<Route>>;
+    /** Streaming form of `planPrevious`: steps backward from `prev`, one (fixed) search window per step. */
+    planPreviousUntil(prev: Route, options?: PlanStreamPageOptions): AsyncGenerator<SpiderResult<Route>>;
+    private stepFrom;
+    departures(stopId: string, numberOfDepartures?: number, options?: DeparturesOptions): Promise<SpiderResult<Departure[]>>;
+    trip(tripId: string, serviceDate?: string): Promise<SpiderResult<TripDetails>>;
+    private page;
+    private fetchPlan;
+}
+//# sourceMappingURL=routing.d.ts.map

package/dist/routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../src/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhF,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG3D,OAAO,KAAK,EAKV,gBAAgB,EAChB,UAAU,EAQV,aAAa,EAKd,MAAM,6BAA6B,CAAC;AAErC,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACnD,QAAQ,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,SAAS,YAAY,EAAE,CAAC;IAChD,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChD,QAAQ,CAAC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,QAAQ,CAAC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACtC,+GAA+G;IAC/G,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACtD,oFAAoF;IACpF,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,4CAA4C;IAC5C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED,0HAA0H;AAC1H,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC;IACnE,iHAAiH;IACjH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,mHAAmH;IACnH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,oHAAoH;AACpH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAsCD,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAI1B,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAiBxD,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,GAAE,MAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAM1F,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,MAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAMnG;;;;;;;;;;;OAWG;IACI,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,cAAc,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAajF,mGAAmG;IAC5F,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAKvG,wGAAwG;IACjG,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAO5F,QAAQ;IAuBjB,UAAU,CACd,MAAM,EAAE,MAAM,EACd,kBAAkB,SAAK,EACvB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IAoB/B,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAetE,IAAI;YAeJ,SAAS;CAgDxB"}