@motis-project/motis-client 2.0.0 → 2.0.83

package/dist/types.gen.d.ts

@@ -231,10 +231,11 @@ type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
  *
  * - `WALK`
  * - `BIKE`
- * - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps).
+ * - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
  * - `CAR`
- * - `CAR_PARKING`
- * - `ODM`
+ * - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
+ * - `ODM` on-demand taxis from the Prima+ÖV Project
+ * - `FLEX` flexible transports
  *
  * # Transit modes
  *
@@ -252,9 +253,12 @@ type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
  * - `NIGHT_RAIL`: long distance night trains
  * - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
  * - `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.
  *
  */
-type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | 'ODM' | 'TRANSIT' | 'TRAM' | 'SUBWAY' | 'FERRY' | 'AIRPLANE' | 'METRO' | 'BUS' | 'COACH' | 'RAIL' | 'HIGHSPEED_RAIL' | 'LONG_DISTANCE' | 'NIGHT_RAIL' | 'REGIONAL_FAST_RAIL' | 'REGIONAL_RAIL' | 'OTHER';
+type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | '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';
 /**
  * - `NORMAL` - latitude / longitude coordinate or address
  * - `BIKESHARE` - bike sharing station
@@ -315,6 +319,10 @@ type Place = {
      *
      */
     track?: string;
+    /**
+     * description of the location that provides more detailed information
+     */
+    description?: string;
     vertexType?: VertexType;
     /**
      * Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.
@@ -332,6 +340,22 @@ type Place = {
      * Alerts for this stop.
      */
     alerts?: Array<Alert>;
+    /**
+     * for `FLEX` transports, the flex location area or location group name
+     */
+    flex?: string;
+    /**
+     * for `FLEX` transports, the flex location area ID or location group ID
+     */
+    flexId?: string;
+    /**
+     * Time that on-demand service becomes available
+     */
+    flexStartPickupDropOffWindow?: string;
+    /**
+     * Time that on-demand service ends
+     */
+    flexEndPickupDropOffWindow?: string;
 };
 /**
  * Place reachable by One-to-All
@@ -526,6 +550,24 @@ type StepInstruction = {
      *
      */
     area: boolean;
+    /**
+     * Indicates that a fee must be paid by general traffic to use a road, road bridge or road tunnel.
+     */
+    toll?: boolean;
+    /**
+     * Experimental. Indicates whether access to this part of the route is restricted.
+     * See: https://wiki.openstreetmap.org/wiki/Conditional_restrictions
+     *
+     */
+    accessRestriction?: string;
+    /**
+     * incline in meters across this path segment
+     */
+    elevationUp?: number;
+    /**
+     * decline in meters across this path segment
+     */
+    elevationDown?: number;
 };
 type RentalFormFactor = 'BICYCLE' | 'CARGO_BICYCLE' | 'CAR' | 'MOPED' | 'SCOOTER_STANDING' | 'SCOOTER_SEATED' | 'OTHER';
 type RentalPropulsionType = 'HUMAN' | 'ELECTRIC_ASSIST' | 'ELECTRIC' | 'COMBUSTION' | 'COMBUSTION_DIESEL' | 'HYBRID' | 'PLUG_IN_HYBRID' | 'HYDROGEN_FUEL_CELL';
@@ -747,7 +789,7 @@ type FareTransferRule = 'A_AB' | 'A_AB_B' | 'AB';
  */
 type FareTransfer = {
     rule?: FareTransferRule;
-    transferProduct?: FareProduct;
+    transferProducts?: Array<FareProduct>;
     /**
      * Lists all valid fare products for the effective fare legs.
      * This is an `array<array<FareProduct>>` where the inner array
@@ -757,7 +799,7 @@ type FareTransfer = {
      * and the inner array as OR (you can choose which ticket to buy)
      *
      */
-    effectiveFareLegProducts: Array<Array<FareProduct>>;
+    effectiveFareLegProducts: Array<Array<Array<FareProduct>>>;
 };
 type Itinerary = {
     /**
@@ -786,37 +828,37 @@ type Itinerary = {
     fareTransfers?: Array<FareTransfer>;
 };
 /**
- * footpath from one location to another
+ * transfer from one location to another
  */
-type Footpath = {
+type Transfer = {
     to: Place;
     /**
-     * optional; missing if the GTFS did not contain a footpath
-     * footpath duration in minutes according to GTFS (+heuristics)
+     * optional; missing if the GTFS did not contain a transfer
+     * transfer duration in minutes according to GTFS (+heuristics)
      *
      */
     default?: number;
     /**
      * optional; missing if no path was found (timetable / osr)
-     * footpath duration in minutes for the foot profile
+     * transfer duration in minutes for the foot profile
      *
      */
     foot?: number;
     /**
      * optional; missing if no path was found with foot routing
-     * footpath duration in minutes for the foot profile
+     * transfer duration in minutes for the foot profile
      *
      */
     footRouted?: number;
     /**
      * optional; missing if no path was found with the wheelchair profile
-     * footpath duration in minutes for the wheelchair profile
+     * transfer duration in minutes for the wheelchair profile
      *
      */
     wheelchair?: number;
     /**
      * optional; missing if no path was found with the wheelchair profile
-     * footpath duration in minutes for the wheelchair profile
+     * transfer duration in minutes for the wheelchair profile
      *
      */
     wheelchairRouted?: number;
@@ -826,6 +868,12 @@ type Footpath = {
      *
      */
     wheelchairUsesElevator?: boolean;
+    /**
+     * optional; missing if no path was found with car routing
+     * transfer duration in minutes for the car profile
+     *
+     */
+    car?: number;
 };
 type PlanData = {
     query: {
@@ -862,6 +910,8 @@ type PlanData = {
          * This is being used as a cut-off during transit routing to speed up the search.
          * To prevent this, it's possible to send two separate requests (one with only `transitModes` and one with only `directModes`).
          *
+         * Note: the output `direct` array will stay empty if the input param `maxDirectTime` makes any direct trip impossible.
+         *
          * Only non-transit modes such as `WALK`, `BIKE`, `CAR`, `BIKE_SHARING`, etc. can be used.
          *
          */
@@ -936,6 +986,36 @@ type PlanData = {
          *
          */
         fromPlace: string;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Default is `false`.
+         *
+         * If set to `true`, the routing will ignore rental return constraints for direct connections,
+         * allowing the rental vehicle to be parked anywhere.
+         *
+         */
+        ignoreDirectRentalReturnConstraints?: boolean;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Default is `false`.
+         *
+         * If set to `true`, the routing will ignore rental return constraints for the part from the last transit stop to the `to` coordinate,
+         * allowing the rental vehicle to be parked anywhere.
+         *
+         */
+        ignorePostTransitRentalReturnConstraints?: boolean;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Default is `false`.
+         *
+         * If set to `true`, the routing will ignore rental return constraints for the part from the `from` coordinate to the first transit stop,
+         * allowing the rental vehicle to be parked anywhere.
+         *
+         */
+        ignorePreTransitRentalReturnConstraints?: boolean;
         /**
          * Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
          *
@@ -1125,6 +1205,10 @@ type PlanData = {
          *
          */
         searchWindow?: number;
+        /**
+         * Optional. Experimental. Adds overtaken direct connections.
+         */
+        slowDirect?: boolean;
         /**
          * Optional. Defaults to the current time.
          *
@@ -1555,6 +1639,14 @@ type StoptimesData = {
          *
          */
         direction?: 'EARLIER' | 'LATER';
+        /**
+         * Optional. Default is `false`.
+         *
+         * If set to `true`, only stations that are phyiscally in the radius are considered.
+         * If set to `false`, additionally to the stations in the radius, equivalences with the same name and children are considered.
+         *
+         */
+        exactRadius?: boolean;
         /**
          * Optional. Default is all transit modes.
          *
@@ -1683,7 +1775,7 @@ type LevelsData = {
 };
 type LevelsResponse = (Array<(number)>);
 type LevelsError = unknown;
-type FootpathsData = {
+type TransfersData = {
     query: {
         /**
          * location id
@@ -1691,13 +1783,25 @@ type FootpathsData = {
         id: string;
     };
 };
-type FootpathsResponse = ({
+type TransfersResponse = ({
     place: Place;
     /**
-     * all outgoing footpaths of this location
+     * true if the server has foot transfers computed
+     */
+    hasFootTransfers: boolean;
+    /**
+     * true if the server has wheelchair transfers computed
+     */
+    hasWheelchairTransfers: boolean;
+    /**
+     * true if the server has car transfers computed
+     */
+    hasCarTransfers: boolean;
+    /**
+     * all outgoing transfers of this location
      */
-    footpaths: Array<Footpath>;
+    transfers: Array<Transfer>;
 });
-type FootpathsError = unknown;
+type TransfersError = unknown;
 
-export type { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, Direction, Duration, ElevationCosts, EncodedPolyline, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, Footpath, FootpathsData, FootpathsError, FootpathsResponse, 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, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@motis-project/motis-client",
-	"version": "2.0.0",
+	"version": "2.0.83",
 	"description": "A JS client for the MOTIS API.",
 	"public": true,
 	"main": "dist/index.js",
@@ -11,8 +11,7 @@
 	"scripts": {
 		"generate": "npx @hey-api/openapi-ts -i ../../../../openapi.yaml -o ./openapi/ -c @hey-api/client-fetch",
 		"transpile": "tsup openapi/**/*.ts --format esm --dts -d=./dist",
-		"build": "npm run generate && npm run transpile",
-		"publish": "npm publish --access public"
+		"build": "npm run generate && npm run transpile"
 	},
 	"repository": {
 		"type": "git",