@motis-project/motis-client 2.1.2 → 2.5.0

package/dist/types.gen.d.ts

@@ -199,10 +199,18 @@ type Match = {
      * house number
      */
     houseNumber?: string;
+    /**
+     * ISO3166-1 country code from OpenStreetMap
+     */
+    country?: string;
     /**
      * zip code
      */
     zip?: string;
+    /**
+     * timezone name (e.g. "Europe/Berlin")
+     */
+    tz?: string;
     /**
      * list of areas
      */
@@ -226,6 +234,14 @@ type ElevationCosts = 'NONE' | 'LOW' | 'HIGH';
  * Different accessibility profiles for pedestrians.
  */
 type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
+/**
+ * Average speed for pedestrian routing in meters per second
+ */
+type PedestrianSpeed = number;
+/**
+ * Average speed for bike routing in meters per second
+ */
+type CyclingSpeed = number;
 /**
  * # Street modes
  *
@@ -242,13 +258,13 @@ type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
  *
  * - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`
  * - `TRAM`: trams
- * - `SUBWAY`: subway trains
+ * - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
  * - `FERRY`: ferries
  * - `AIRPLANE`: airline flights
  * - `BUS`: short distance buses (does not include `COACH`)
  * - `COACH`: long distance buses (does not include `BUS`)
- * - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,METRO,SUBWAY`
- * - `METRO`: metro trains
+ * - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`
+ * - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
  * - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
  * - `LONG_DISTANCE`: long distance inter city trains
  * - `NIGHT_RAIL`: long distance night trains
@@ -256,10 +272,12 @@ type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
  * - `REGIONAL_RAIL`: regional train
  * - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
  * - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.
- * - `AREAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.
+ * - `AERIAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.
+ * - `AREAL_LIFT`: deprecated
+ * - `METRO`: deprecated
  *
  */
-type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | 'CAR_DROPOFF' | 'ODM' | 'FLEX' | 'TRANSIT' | 'TRAM' | 'SUBWAY' | 'FERRY' | 'AIRPLANE' | 'METRO' | 'BUS' | 'COACH' | 'RAIL' | 'HIGHSPEED_RAIL' | 'LONG_DISTANCE' | 'NIGHT_RAIL' | 'REGIONAL_FAST_RAIL' | 'REGIONAL_RAIL' | 'CABLE_CAR' | 'FUNICULAR' | 'AREAL_LIFT' | 'OTHER';
+type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | 'CAR_DROPOFF' | 'ODM' | 'FLEX' | 'TRANSIT' | 'TRAM' | 'SUBWAY' | 'FERRY' | 'AIRPLANE' | 'SUBURBAN' | 'BUS' | 'COACH' | 'RAIL' | 'HIGHSPEED_RAIL' | 'LONG_DISTANCE' | 'NIGHT_RAIL' | 'REGIONAL_FAST_RAIL' | 'REGIONAL_RAIL' | 'CABLE_CAR' | 'FUNICULAR' | 'AERIAL_LIFT' | 'OTHER' | 'AREAL_LIFT' | 'METRO';
 /**
  * - `NORMAL` - latitude / longitude coordinate or address
  * - `BIKESHARE` - bike sharing station
@@ -294,6 +312,10 @@ type Place = {
      * level according to OpenStreetMap
      */
     level: number;
+    /**
+     * timezone name (e.g. "Europe/Berlin")
+     */
+    tz?: string;
     /**
      * arrival time
      */
@@ -413,18 +435,40 @@ type StopTime = {
      */
     realTime: boolean;
     /**
-     * For transit legs, the headsign of the bus or train being used.
+     * The headsign of the bus or train being used.
      * For non-transit legs, null
      *
      */
     headsign: string;
+    /**
+     * final stop of this trip
+     */
+    tripTo: Place;
     agencyId: string;
     agencyName: string;
     agencyUrl: string;
     routeColor?: string;
     routeTextColor?: string;
     tripId: string;
+    routeType?: number;
     routeShortName: string;
+    routeLongName: string;
+    tripShortName: string;
+    displayName: string;
+    /**
+     * Experimental. Expect unannounced breaking changes (without version bumps).
+     *
+     * Stops on the trips before this stop. Returned only if `fetchStop` and `arriveBy` are `true`.
+     *
+     */
+    previousStops?: Array<Place>;
+    /**
+     * Experimental. Expect unannounced breaking changes (without version bumps).
+     *
+     * Stops on the trips after this stop. Returned only if `fetchStop` is `true` and `arriveBy` is `false`.
+     *
+     */
+    nextStops?: Array<Place>;
     /**
      * Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations
      */
@@ -451,9 +495,13 @@ type TripInfo = {
      */
     tripId: string;
     /**
-     * trip display name
+     * trip display name (api version < 4)
      */
-    routeShortName: string;
+    routeShortName?: string;
+    /**
+     * trip display name (api version >= 4)
+     */
+    displayName?: string;
 };
 /**
  * trip segment between two stops to show a trip on a map
@@ -684,14 +732,21 @@ type Leg = {
      *
      */
     headsign?: string;
+    /**
+     * final stop of this trip (can differ from headsign)
+     */
+    tripTo?: Place;
     routeColor?: string;
     routeTextColor?: string;
-    routeType?: string;
+    routeType?: number;
     agencyName?: string;
     agencyUrl?: string;
     agencyId?: string;
     tripId?: string;
     routeShortName?: string;
+    routeLongName?: string;
+    tripShortName?: string;
+    displayName?: string;
     /**
      * Whether this trip is cancelled
      */
@@ -895,6 +950,9 @@ type Transfer = {
      */
     car?: number;
 };
+type Error = {
+    error?: string;
+};
 type PlanData = {
     query: {
         /**
@@ -904,6 +962,10 @@ type PlanData = {
          *
          */
         additionalTransferTime?: number;
+        /**
+         * algorithm to use
+         */
+        algorithm?: 'RAPTOR' | 'TB';
         /**
          * Optional. Default is `false`.
          *
@@ -912,6 +974,13 @@ type PlanData = {
          *
          */
         arriveBy?: boolean;
+        /**
+         * Optional
+         *
+         * Average speed for bike routing.
+         *
+         */
+        cyclingSpeed?: CyclingSpeed;
         /**
          * - true: Compute transfer polylines and step instructions.
          * - false: Only return basic information (start time, end time, duration) for transfers.
@@ -998,7 +1067,7 @@ type PlanData = {
         /**
          * Optional.
          * Factor with which the duration of the fastest slowDirect connection is multiplied.
-         * Values > 1.0 allow connections that are slower than the fastest direct connection to be found.
+         * Values > 1.0 allow connections that are slower than the fastest direct transit connection to be found.
          * Values < 1.0 will return all slowDirect connections.
          *
          */
@@ -1068,6 +1137,7 @@ type PlanData = {
         /**
          * Optional. Default is 30min which is `1800`.
          * Maximum time in seconds for direct connections.
+         * Is limited by server config variable `street_routing_max_direct_seconds`.
          *
          */
         maxDirectTime?: number;
@@ -1081,12 +1151,14 @@ type PlanData = {
         /**
          * Optional. Default is 15min which is `900`.
          * Maximum time in seconds for the last street leg.
+         * Is limited by server config variable `street_routing_max_prepost_transit_seconds`.
          *
          */
         maxPostTransitTime?: number;
         /**
          * Optional. Default is 15min which is `900`.
          * Maximum time in seconds for the first street leg.
+         * Is limited by server config variable `street_routing_max_prepost_transit_seconds`.
          *
          */
         maxPreTransitTime?: number;
@@ -1155,6 +1227,13 @@ type PlanData = {
          *
          */
         pedestrianProfile?: PedestrianProfile;
+        /**
+         * Optional
+         *
+         * Average speed for pedestrian routing.
+         *
+         */
+        pedestrianSpeed?: PedestrianSpeed;
         /**
          * Optional. Default is `WALK`. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
          *
@@ -1315,7 +1394,7 @@ type PlanData = {
         /**
          * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
          * Allowed modes for the transit part. If empty, no transit connections will be computed.
-         * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
+         * For example, this can be used to allow only `SUBURBAN,SUBWAY,TRAM`.
          *
          */
         transitModes?: Array<Mode>;
@@ -1393,7 +1472,7 @@ type PlanResponse = ({
      */
     nextPageCursor: string;
 });
-type PlanError = unknown;
+type PlanError = (Error);
 type OneToManyData = {
     query: {
         /**
@@ -1460,6 +1539,13 @@ type OneToAllData = {
          *
          */
         arriveBy?: boolean;
+        /**
+         * Optional
+         *
+         * Average speed for bike routing.
+         *
+         */
+        cyclingSpeed?: CyclingSpeed;
         /**
          * Optional. Default is `NONE`.
          *
@@ -1491,6 +1577,7 @@ type OneToAllData = {
          * Optional. Default is 15min which is `900`.
          * - `arriveBy=true`: Maximum time in seconds for the street leg at `one` location.
          * - `arriveBy=false`: Currently not used
+         * Is limited by server config variable `street_routing_max_prepost_transit_seconds`.
          *
          */
         maxPostTransitTime?: number;
@@ -1498,6 +1585,7 @@ type OneToAllData = {
          * Optional. Default is 15min which is `900`.
          * - `arriveBy=true`: Currently not used
          * - `arriveBy=false`: Maximum time in seconds for the street leg at `one` location.
+         * Is limited by server config variable `street_routing_max_prepost_transit_seconds`.
          *
          */
         maxPreTransitTime?: number;
@@ -1522,7 +1610,7 @@ type OneToAllData = {
          */
         maxTransfers?: number;
         /**
-         * maximum travel time in minutes
+         * The maximum travel time in minutes. Defaults to 90. The limit may be increased by the server administrator using `onetoall_max_travel_minutes` option in `config.yml`. See documentation for details.
          */
         maxTravelTime: number;
         /**
@@ -1551,6 +1639,13 @@ type OneToAllData = {
          *
          */
         pedestrianProfile?: PedestrianProfile;
+        /**
+         * Optional
+         *
+         * Average speed for pedestrian routing.
+         *
+         */
+        pedestrianSpeed?: PedestrianSpeed;
         /**
          * Optional. Default is `WALK`. The behavior depends on whether `arriveBy` is set:
          * - `arriveBy=true`: Only applies if the `one` place is a coordinate (not a transit stop).
@@ -1601,7 +1696,7 @@ type OneToAllData = {
         /**
          * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
          * Allowed modes for the transit part. If empty, no transit connections will be computed.
-         * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
+         * For example, this can be used to allow only `SUBURBAN,SUBWAY,TRAM`.
          *
          */
         transitModes?: Array<Mode>;
@@ -1615,7 +1710,7 @@ type OneToAllData = {
     };
 };
 type OneToAllResponse = (Reachable);
-type OneToAllError = unknown;
+type OneToAllError = (Error);
 type ReverseGeocodeData = {
     query: {
         /**
@@ -1633,7 +1728,7 @@ type ReverseGeocodeData = {
     };
 };
 type ReverseGeocodeResponse = (Array<Match>);
-type ReverseGeocodeError = unknown;
+type ReverseGeocodeError = (Error);
 type GeocodeData = {
     query: {
         /**
@@ -1669,7 +1764,7 @@ type GeocodeData = {
     };
 };
 type GeocodeResponse = (Array<Match>);
-type GeocodeError = unknown;
+type GeocodeError = (Error);
 type TripData = {
     query: {
         /**
@@ -1699,7 +1794,7 @@ type TripData = {
     };
 };
 type TripResponse = (Itinerary);
-type TripError = unknown;
+type TripError = (Error);
 type StoptimesData = {
     query: {
         /**
@@ -1731,6 +1826,14 @@ type StoptimesData = {
          *
          */
         exactRadius?: boolean;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Default is `false`. If set to `true`, the following stops are returned
+         * for departures and the previous stops are returned for arrivals.
+         *
+         */
+        fetchStops?: boolean;
         /**
          * language tags as used in OpenStreetMap / GTFS
          * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
@@ -1803,7 +1906,7 @@ type StoptimesResponse = ({
      */
     nextPageCursor: string;
 });
-type StoptimesError = unknown;
+type StoptimesError = (Error);
 type TripsData = {
     query: {
         /**
@@ -1829,7 +1932,7 @@ type TripsData = {
     };
 };
 type TripsResponse = (Array<TripSegment>);
-type TripsError = unknown;
+type TripsError = (Error);
 type InitialResponse = ({
     /**
      * latitude
@@ -1844,7 +1947,7 @@ type InitialResponse = ({
      */
     zoom: number;
 });
-type InitialError = unknown;
+type InitialError = (Error);
 type StopsData = {
     query: {
         /**
@@ -1858,7 +1961,7 @@ type StopsData = {
     };
 };
 type StopsResponse = (Array<Place>);
-type StopsError = unknown;
+type StopsError = (Error);
 type LevelsData = {
     query: {
         /**
@@ -1872,7 +1975,7 @@ type LevelsData = {
     };
 };
 type LevelsResponse = (Array<(number)>);
-type LevelsError = unknown;
+type LevelsError = (Error);
 type TransfersData = {
     query: {
         /**
@@ -1902,4 +2005,4 @@ type TransfersResponse = ({
 });
 type TransfersError = unknown;
 
-export type { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, Direction, Duration, ElevationCosts, EncodedPolyline, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, InitialError, InitialResponse, Itinerary, Leg, LevelsData, LevelsError, LevelsResponse, LocationType, Match, Mode, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyResponse, PedestrianProfile, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalReturnConstraint, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType };
+export type { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, CyclingSpeed, Direction, Duration, ElevationCosts, EncodedPolyline, Error, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, InitialError, InitialResponse, Itinerary, Leg, LevelsData, LevelsError, LevelsResponse, LocationType, Match, Mode, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyResponse, PedestrianProfile, PedestrianSpeed, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalReturnConstraint, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@motis-project/motis-client",
-	"version": "2.1.2",
+	"version": "2.5.0",
 	"description": "A JS client for the MOTIS API.",
 	"public": true,
 	"main": "dist/index.js",