@motis-project/motis-client 2.5.0 → 2.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/{chunk-ZSHHWD3H.js → chunk-FDF4H3WD.js} +7 -0
- package/dist/{chunk-5QEG6DOF.js → chunk-UREEG3GO.js} +469 -39
- package/dist/index.d.ts +3 -3
- package/dist/index.js +20 -2
- package/dist/schemas.gen.d.ts +404 -7
- package/dist/schemas.gen.js +17 -1
- package/dist/services.gen.d.ts +22 -2
- package/dist/services.gen.js +3 -1
- package/dist/types.gen.d.ts +481 -44
- package/package.json +3 -3
- package/dist/chunk-35GMB6DP.js +0 -1232
- package/dist/chunk-7PIP6KRC.js +0 -1300
- package/dist/chunk-7UKCGCXT.js +0 -1247
- package/dist/chunk-CAW6R2LI.js +0 -1285
- package/dist/chunk-EM7IAOVY.js +0 -91
- package/dist/chunk-IHFNO6R3.js +0 -91
- package/dist/chunk-IYBFZNEH.js +0 -1224
- package/dist/chunk-QM2K42W7.js +0 -91
- package/dist/chunk-RM52T2X5.js +0 -1293
- package/dist/chunk-VOTN5CAZ.js +0 -91
- package/dist/chunk-ZBHU6VX2.js +0 -1291
package/dist/types.gen.d.ts
CHANGED
|
@@ -21,13 +21,13 @@ type TimeRange = {
|
|
|
21
21
|
* If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
|
-
start
|
|
24
|
+
start: string;
|
|
25
25
|
/**
|
|
26
26
|
* If missing, the interval ends at plus infinity.
|
|
27
27
|
* If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
|
-
end
|
|
30
|
+
end: string;
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
33
|
* An alert, indicating some sort of incident in the public transit network.
|
|
@@ -160,11 +160,56 @@ type Token = [
|
|
|
160
160
|
* location type
|
|
161
161
|
*/
|
|
162
162
|
type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
|
|
163
|
+
/**
|
|
164
|
+
* # Street modes
|
|
165
|
+
*
|
|
166
|
+
* - `WALK`
|
|
167
|
+
* - `BIKE`
|
|
168
|
+
* - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
169
|
+
* - `CAR`
|
|
170
|
+
* - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
171
|
+
* - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
|
|
172
|
+
* - `ODM` on-demand taxis from the Prima+ÖV Project
|
|
173
|
+
* - `RIDE_SHARING` ride sharing from the Prima+ÖV Project
|
|
174
|
+
* - `FLEX` flexible transports
|
|
175
|
+
*
|
|
176
|
+
* # Transit modes
|
|
177
|
+
*
|
|
178
|
+
* - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`
|
|
179
|
+
* - `TRAM`: trams
|
|
180
|
+
* - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
|
|
181
|
+
* - `FERRY`: ferries
|
|
182
|
+
* - `AIRPLANE`: airline flights
|
|
183
|
+
* - `BUS`: short distance buses (does not include `COACH`)
|
|
184
|
+
* - `COACH`: long distance buses (does not include `BUS`)
|
|
185
|
+
* - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`
|
|
186
|
+
* - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
|
|
187
|
+
* - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
|
|
188
|
+
* - `LONG_DISTANCE`: long distance inter city trains
|
|
189
|
+
* - `NIGHT_RAIL`: long distance night trains
|
|
190
|
+
* - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
|
|
191
|
+
* - `REGIONAL_RAIL`: regional train
|
|
192
|
+
* - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
|
|
193
|
+
* - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.
|
|
194
|
+
* - `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.
|
|
195
|
+
* - `AREAL_LIFT`: deprecated
|
|
196
|
+
* - `METRO`: deprecated
|
|
197
|
+
*
|
|
198
|
+
*/
|
|
199
|
+
type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | 'CAR_DROPOFF' | 'ODM' | 'RIDE_SHARING' | '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';
|
|
163
200
|
/**
|
|
164
201
|
* GeoCoding match
|
|
165
202
|
*/
|
|
166
203
|
type Match = {
|
|
167
204
|
type: LocationType;
|
|
205
|
+
/**
|
|
206
|
+
* Experimental. Type categories might be adjusted.
|
|
207
|
+
*
|
|
208
|
+
* For OSM stop locations: the amenity type based on
|
|
209
|
+
* https://wiki.openstreetmap.org/wiki/OpenStreetMap_Carto/Symbols
|
|
210
|
+
*
|
|
211
|
+
*/
|
|
212
|
+
category?: string;
|
|
168
213
|
/**
|
|
169
214
|
* list of non-overlapping tokens that were matched
|
|
170
215
|
*/
|
|
@@ -219,6 +264,14 @@ type Match = {
|
|
|
219
264
|
* score according to the internal scoring system (the scoring algorithm might change in the future)
|
|
220
265
|
*/
|
|
221
266
|
score: number;
|
|
267
|
+
/**
|
|
268
|
+
* available transport modes for stops
|
|
269
|
+
*/
|
|
270
|
+
modes?: Array<Mode>;
|
|
271
|
+
/**
|
|
272
|
+
* importance of a stop, normalized from [0, 1]
|
|
273
|
+
*/
|
|
274
|
+
importance?: number;
|
|
222
275
|
};
|
|
223
276
|
/**
|
|
224
277
|
* Different elevation cost profiles for street routing.
|
|
@@ -242,42 +295,6 @@ type PedestrianSpeed = number;
|
|
|
242
295
|
* Average speed for bike routing in meters per second
|
|
243
296
|
*/
|
|
244
297
|
type CyclingSpeed = number;
|
|
245
|
-
/**
|
|
246
|
-
* # Street modes
|
|
247
|
-
*
|
|
248
|
-
* - `WALK`
|
|
249
|
-
* - `BIKE`
|
|
250
|
-
* - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
251
|
-
* - `CAR`
|
|
252
|
-
* - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
253
|
-
* - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
|
|
254
|
-
* - `ODM` on-demand taxis from the Prima+ÖV Project
|
|
255
|
-
* - `FLEX` flexible transports
|
|
256
|
-
*
|
|
257
|
-
* # Transit modes
|
|
258
|
-
*
|
|
259
|
-
* - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`
|
|
260
|
-
* - `TRAM`: trams
|
|
261
|
-
* - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
|
|
262
|
-
* - `FERRY`: ferries
|
|
263
|
-
* - `AIRPLANE`: airline flights
|
|
264
|
-
* - `BUS`: short distance buses (does not include `COACH`)
|
|
265
|
-
* - `COACH`: long distance buses (does not include `BUS`)
|
|
266
|
-
* - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`
|
|
267
|
-
* - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
|
|
268
|
-
* - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
|
|
269
|
-
* - `LONG_DISTANCE`: long distance inter city trains
|
|
270
|
-
* - `NIGHT_RAIL`: long distance night trains
|
|
271
|
-
* - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
|
|
272
|
-
* - `REGIONAL_RAIL`: regional train
|
|
273
|
-
* - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
|
|
274
|
-
* - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.
|
|
275
|
-
* - `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.
|
|
276
|
-
* - `AREAL_LIFT`: deprecated
|
|
277
|
-
* - `METRO`: deprecated
|
|
278
|
-
*
|
|
279
|
-
*/
|
|
280
|
-
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';
|
|
281
298
|
/**
|
|
282
299
|
* - `NORMAL` - latitude / longitude coordinate or address
|
|
283
300
|
* - `BIKESHARE` - bike sharing station
|
|
@@ -300,6 +317,10 @@ type Place = {
|
|
|
300
317
|
* The ID of the stop. This is often something that users don't care about.
|
|
301
318
|
*/
|
|
302
319
|
stopId?: string;
|
|
320
|
+
/**
|
|
321
|
+
* The importance of the stop between 0-1.
|
|
322
|
+
*/
|
|
323
|
+
importance?: number;
|
|
303
324
|
/**
|
|
304
325
|
* latitude
|
|
305
326
|
*/
|
|
@@ -629,6 +650,14 @@ type RentalReturnConstraint = 'NONE' | 'ANY_STATION' | 'ROUNDTRIP_STATION';
|
|
|
629
650
|
* Vehicle rental
|
|
630
651
|
*/
|
|
631
652
|
type Rental = {
|
|
653
|
+
/**
|
|
654
|
+
* Rental provider ID
|
|
655
|
+
*/
|
|
656
|
+
providerId: string;
|
|
657
|
+
/**
|
|
658
|
+
* Rental provider group ID
|
|
659
|
+
*/
|
|
660
|
+
providerGroupId: string;
|
|
632
661
|
/**
|
|
633
662
|
* Vehicle share system ID
|
|
634
663
|
*/
|
|
@@ -641,6 +670,12 @@ type Rental = {
|
|
|
641
670
|
* URL of the vehicle share system
|
|
642
671
|
*/
|
|
643
672
|
url?: string;
|
|
673
|
+
/**
|
|
674
|
+
* Color associated with this provider, in hexadecimal RGB format
|
|
675
|
+
* (e.g. "#FF0000" for red). Can be empty.
|
|
676
|
+
*
|
|
677
|
+
*/
|
|
678
|
+
color?: string;
|
|
644
679
|
/**
|
|
645
680
|
* Name of the station
|
|
646
681
|
*/
|
|
@@ -669,6 +704,305 @@ type Rental = {
|
|
|
669
704
|
propulsionType?: RentalPropulsionType;
|
|
670
705
|
returnConstraint?: RentalReturnConstraint;
|
|
671
706
|
};
|
|
707
|
+
/**
|
|
708
|
+
* A multi-polygon contains a number of polygons, each containing a number
|
|
709
|
+
* of rings, which are encoded as polylines (with precision 6).
|
|
710
|
+
*
|
|
711
|
+
* For each polygon, the first ring is the outer ring, all subsequent rings
|
|
712
|
+
* are inner rings (holes).
|
|
713
|
+
*
|
|
714
|
+
*/
|
|
715
|
+
type MultiPolygon = Array<Array<EncodedPolyline>>;
|
|
716
|
+
type RentalZoneRestrictions = {
|
|
717
|
+
/**
|
|
718
|
+
* List of vehicle types (as indices into the provider's vehicle types
|
|
719
|
+
* array) to which these restrictions apply.
|
|
720
|
+
* If empty, the restrictions apply to all vehicle types of the provider.
|
|
721
|
+
*
|
|
722
|
+
*/
|
|
723
|
+
vehicleTypeIdxs: Array<(number)>;
|
|
724
|
+
/**
|
|
725
|
+
* whether the ride is allowed to start in this zone
|
|
726
|
+
*/
|
|
727
|
+
rideStartAllowed: boolean;
|
|
728
|
+
/**
|
|
729
|
+
* whether the ride is allowed to end in this zone
|
|
730
|
+
*/
|
|
731
|
+
rideEndAllowed: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* whether the ride is allowed to pass through this zone
|
|
734
|
+
*/
|
|
735
|
+
rideThroughAllowed: boolean;
|
|
736
|
+
/**
|
|
737
|
+
* whether vehicles can only be parked at stations in this zone
|
|
738
|
+
*/
|
|
739
|
+
stationParking?: boolean;
|
|
740
|
+
};
|
|
741
|
+
type RentalVehicleType = {
|
|
742
|
+
/**
|
|
743
|
+
* Unique identifier of the vehicle type (unique within the provider)
|
|
744
|
+
*/
|
|
745
|
+
id: string;
|
|
746
|
+
/**
|
|
747
|
+
* Public name of the vehicle type (can be empty)
|
|
748
|
+
*/
|
|
749
|
+
name?: string;
|
|
750
|
+
formFactor: RentalFormFactor;
|
|
751
|
+
propulsionType: RentalPropulsionType;
|
|
752
|
+
returnConstraint: RentalReturnConstraint;
|
|
753
|
+
/**
|
|
754
|
+
* Whether the return constraint was guessed instead of being specified by the rental provider
|
|
755
|
+
*/
|
|
756
|
+
returnConstraintGuessed: boolean;
|
|
757
|
+
};
|
|
758
|
+
type RentalProvider = {
|
|
759
|
+
/**
|
|
760
|
+
* Unique identifier of the rental provider
|
|
761
|
+
*/
|
|
762
|
+
id: string;
|
|
763
|
+
/**
|
|
764
|
+
* Name of the provider to be displayed to customers
|
|
765
|
+
*/
|
|
766
|
+
name: string;
|
|
767
|
+
/**
|
|
768
|
+
* Id of the rental provider group this provider belongs to
|
|
769
|
+
*/
|
|
770
|
+
groupId: string;
|
|
771
|
+
/**
|
|
772
|
+
* Name of the system operator
|
|
773
|
+
*/
|
|
774
|
+
operator?: string;
|
|
775
|
+
/**
|
|
776
|
+
* URL of the vehicle share system
|
|
777
|
+
*/
|
|
778
|
+
url?: string;
|
|
779
|
+
/**
|
|
780
|
+
* URL where a customer can purchase a membership
|
|
781
|
+
*/
|
|
782
|
+
purchaseUrl?: string;
|
|
783
|
+
/**
|
|
784
|
+
* Color associated with this provider, in hexadecimal RGB format
|
|
785
|
+
* (e.g. "#FF0000" for red). Can be empty.
|
|
786
|
+
*
|
|
787
|
+
*/
|
|
788
|
+
color?: string;
|
|
789
|
+
/**
|
|
790
|
+
* Bounding box of the area covered by this rental provider,
|
|
791
|
+
* [west, south, east, north] as [lon, lat, lon, lat]
|
|
792
|
+
*
|
|
793
|
+
*/
|
|
794
|
+
bbox: [
|
|
795
|
+
number,
|
|
796
|
+
number,
|
|
797
|
+
number,
|
|
798
|
+
number
|
|
799
|
+
];
|
|
800
|
+
vehicleTypes: Array<RentalVehicleType>;
|
|
801
|
+
/**
|
|
802
|
+
* List of form factors offered by this provider
|
|
803
|
+
*/
|
|
804
|
+
formFactors: Array<RentalFormFactor>;
|
|
805
|
+
defaultRestrictions: RentalZoneRestrictions;
|
|
806
|
+
globalGeofencingRules: Array<RentalZoneRestrictions>;
|
|
807
|
+
};
|
|
808
|
+
type RentalProviderGroup = {
|
|
809
|
+
/**
|
|
810
|
+
* Unique identifier of the rental provider group
|
|
811
|
+
*/
|
|
812
|
+
id: string;
|
|
813
|
+
/**
|
|
814
|
+
* Name of the provider group to be displayed to customers
|
|
815
|
+
*/
|
|
816
|
+
name: string;
|
|
817
|
+
/**
|
|
818
|
+
* Color associated with this provider group, in hexadecimal RGB format
|
|
819
|
+
* (e.g. "#FF0000" for red). Can be empty.
|
|
820
|
+
*
|
|
821
|
+
*/
|
|
822
|
+
color?: string;
|
|
823
|
+
/**
|
|
824
|
+
* List of rental provider IDs that belong to this group
|
|
825
|
+
*/
|
|
826
|
+
providers: Array<(string)>;
|
|
827
|
+
/**
|
|
828
|
+
* List of form factors offered by this provider group
|
|
829
|
+
*/
|
|
830
|
+
formFactors: Array<RentalFormFactor>;
|
|
831
|
+
};
|
|
832
|
+
type RentalStation = {
|
|
833
|
+
/**
|
|
834
|
+
* Unique identifier of the rental station
|
|
835
|
+
*/
|
|
836
|
+
id: string;
|
|
837
|
+
/**
|
|
838
|
+
* Unique identifier of the rental provider
|
|
839
|
+
*/
|
|
840
|
+
providerId: string;
|
|
841
|
+
/**
|
|
842
|
+
* Unique identifier of the rental provider group
|
|
843
|
+
*/
|
|
844
|
+
providerGroupId: string;
|
|
845
|
+
/**
|
|
846
|
+
* Public name of the station
|
|
847
|
+
*/
|
|
848
|
+
name: string;
|
|
849
|
+
/**
|
|
850
|
+
* latitude
|
|
851
|
+
*/
|
|
852
|
+
lat: number;
|
|
853
|
+
/**
|
|
854
|
+
* longitude
|
|
855
|
+
*/
|
|
856
|
+
lon: number;
|
|
857
|
+
/**
|
|
858
|
+
* Address where the station is located
|
|
859
|
+
*/
|
|
860
|
+
address?: string;
|
|
861
|
+
/**
|
|
862
|
+
* Cross street or landmark where the station is located
|
|
863
|
+
*/
|
|
864
|
+
crossStreet?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Rental URI for Android (deep link to the specific station)
|
|
867
|
+
*/
|
|
868
|
+
rentalUriAndroid?: string;
|
|
869
|
+
/**
|
|
870
|
+
* Rental URI for iOS (deep link to the specific station)
|
|
871
|
+
*/
|
|
872
|
+
rentalUriIOS?: string;
|
|
873
|
+
/**
|
|
874
|
+
* Rental URI for web (deep link to the specific station)
|
|
875
|
+
*/
|
|
876
|
+
rentalUriWeb?: string;
|
|
877
|
+
/**
|
|
878
|
+
* true if vehicles can be rented from this station, false if it is temporarily out of service
|
|
879
|
+
*/
|
|
880
|
+
isRenting: boolean;
|
|
881
|
+
/**
|
|
882
|
+
* true if vehicles can be returned to this station, false if it is temporarily out of service
|
|
883
|
+
*/
|
|
884
|
+
isReturning: boolean;
|
|
885
|
+
/**
|
|
886
|
+
* Number of vehicles available for rental at this station
|
|
887
|
+
*/
|
|
888
|
+
numVehiclesAvailable: number;
|
|
889
|
+
/**
|
|
890
|
+
* List of form factors available for rental and/or return at this station
|
|
891
|
+
*/
|
|
892
|
+
formFactors: Array<RentalFormFactor>;
|
|
893
|
+
/**
|
|
894
|
+
* List of vehicle types currently available at this station (vehicle type ID -> count)
|
|
895
|
+
*/
|
|
896
|
+
vehicleTypesAvailable: {
|
|
897
|
+
[key: string]: (number);
|
|
898
|
+
};
|
|
899
|
+
/**
|
|
900
|
+
* List of vehicle docks currently available at this station (vehicle type ID -> count)
|
|
901
|
+
*/
|
|
902
|
+
vehicleDocksAvailable: {
|
|
903
|
+
[key: string]: (number);
|
|
904
|
+
};
|
|
905
|
+
stationArea?: MultiPolygon;
|
|
906
|
+
/**
|
|
907
|
+
* Bounding box of the area covered by this station,
|
|
908
|
+
* [west, south, east, north] as [lon, lat, lon, lat]
|
|
909
|
+
*
|
|
910
|
+
*/
|
|
911
|
+
bbox: [
|
|
912
|
+
number,
|
|
913
|
+
number,
|
|
914
|
+
number,
|
|
915
|
+
number
|
|
916
|
+
];
|
|
917
|
+
};
|
|
918
|
+
type RentalVehicle = {
|
|
919
|
+
/**
|
|
920
|
+
* Unique identifier of the rental vehicle
|
|
921
|
+
*/
|
|
922
|
+
id: string;
|
|
923
|
+
/**
|
|
924
|
+
* Unique identifier of the rental provider
|
|
925
|
+
*/
|
|
926
|
+
providerId: string;
|
|
927
|
+
/**
|
|
928
|
+
* Unique identifier of the rental provider group
|
|
929
|
+
*/
|
|
930
|
+
providerGroupId: string;
|
|
931
|
+
/**
|
|
932
|
+
* Vehicle type ID (unique within the provider)
|
|
933
|
+
*/
|
|
934
|
+
typeId: string;
|
|
935
|
+
/**
|
|
936
|
+
* latitude
|
|
937
|
+
*/
|
|
938
|
+
lat: number;
|
|
939
|
+
/**
|
|
940
|
+
* longitude
|
|
941
|
+
*/
|
|
942
|
+
lon: number;
|
|
943
|
+
formFactor: RentalFormFactor;
|
|
944
|
+
propulsionType: RentalPropulsionType;
|
|
945
|
+
returnConstraint: RentalReturnConstraint;
|
|
946
|
+
/**
|
|
947
|
+
* Station ID if the vehicle is currently at a station
|
|
948
|
+
*/
|
|
949
|
+
stationId?: string;
|
|
950
|
+
/**
|
|
951
|
+
* Station ID where the vehicle must be returned, if applicable
|
|
952
|
+
*/
|
|
953
|
+
homeStationId?: string;
|
|
954
|
+
/**
|
|
955
|
+
* true if the vehicle is currently reserved by a customer, false otherwise
|
|
956
|
+
*/
|
|
957
|
+
isReserved: boolean;
|
|
958
|
+
/**
|
|
959
|
+
* true if the vehicle is out of service, false otherwise
|
|
960
|
+
*/
|
|
961
|
+
isDisabled: boolean;
|
|
962
|
+
/**
|
|
963
|
+
* Rental URI for Android (deep link to the specific vehicle)
|
|
964
|
+
*/
|
|
965
|
+
rentalUriAndroid?: string;
|
|
966
|
+
/**
|
|
967
|
+
* Rental URI for iOS (deep link to the specific vehicle)
|
|
968
|
+
*/
|
|
969
|
+
rentalUriIOS?: string;
|
|
970
|
+
/**
|
|
971
|
+
* Rental URI for web (deep link to the specific vehicle)
|
|
972
|
+
*/
|
|
973
|
+
rentalUriWeb?: string;
|
|
974
|
+
};
|
|
975
|
+
type RentalZone = {
|
|
976
|
+
/**
|
|
977
|
+
* Unique identifier of the rental provider
|
|
978
|
+
*/
|
|
979
|
+
providerId: string;
|
|
980
|
+
/**
|
|
981
|
+
* Unique identifier of the rental provider group
|
|
982
|
+
*/
|
|
983
|
+
providerGroupId: string;
|
|
984
|
+
/**
|
|
985
|
+
* Public name of the geofencing zone
|
|
986
|
+
*/
|
|
987
|
+
name?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Zone precedence / z-index (higher number = higher precedence)
|
|
990
|
+
*/
|
|
991
|
+
z: number;
|
|
992
|
+
/**
|
|
993
|
+
* Bounding box of the area covered by this zone,
|
|
994
|
+
* [west, south, east, north] as [lon, lat, lon, lat]
|
|
995
|
+
*
|
|
996
|
+
*/
|
|
997
|
+
bbox: [
|
|
998
|
+
number,
|
|
999
|
+
number,
|
|
1000
|
+
number,
|
|
1001
|
+
number
|
|
1002
|
+
];
|
|
1003
|
+
area: MultiPolygon;
|
|
1004
|
+
rules: Array<RentalZoneRestrictions>;
|
|
1005
|
+
};
|
|
672
1006
|
type Leg = {
|
|
673
1007
|
/**
|
|
674
1008
|
* Transport mode for this leg
|
|
@@ -965,7 +1299,7 @@ type PlanData = {
|
|
|
965
1299
|
/**
|
|
966
1300
|
* algorithm to use
|
|
967
1301
|
*/
|
|
968
|
-
algorithm?: 'RAPTOR' | 'TB';
|
|
1302
|
+
algorithm?: 'RAPTOR' | 'PONG' | 'TB';
|
|
969
1303
|
/**
|
|
970
1304
|
* Optional. Default is `false`.
|
|
971
1305
|
*
|
|
@@ -1027,6 +1361,16 @@ type PlanData = {
|
|
|
1027
1361
|
*
|
|
1028
1362
|
*/
|
|
1029
1363
|
directRentalPropulsionTypes?: Array<RentalPropulsionType>;
|
|
1364
|
+
/**
|
|
1365
|
+
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1366
|
+
*
|
|
1367
|
+
* Optional. Only applies to direct connections.
|
|
1368
|
+
*
|
|
1369
|
+
* A list of rental provider groups that are allowed to be used for direct connections.
|
|
1370
|
+
* If empty (the default), all providers are allowed.
|
|
1371
|
+
*
|
|
1372
|
+
*/
|
|
1373
|
+
directRentalProviderGroups?: Array<(string)>;
|
|
1030
1374
|
/**
|
|
1031
1375
|
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1032
1376
|
*
|
|
@@ -1128,7 +1472,7 @@ type PlanData = {
|
|
|
1128
1472
|
* (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
1129
1473
|
*
|
|
1130
1474
|
*/
|
|
1131
|
-
language?: string
|
|
1475
|
+
language?: Array<(string)>;
|
|
1132
1476
|
/**
|
|
1133
1477
|
* Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
|
|
1134
1478
|
*
|
|
@@ -1141,6 +1485,23 @@ type PlanData = {
|
|
|
1141
1485
|
*
|
|
1142
1486
|
*/
|
|
1143
1487
|
maxDirectTime?: number;
|
|
1488
|
+
/**
|
|
1489
|
+
* Optional. By default all computed itineraries will be returned
|
|
1490
|
+
*
|
|
1491
|
+
* The maximum number of itineraries to compute.
|
|
1492
|
+
* This is only relevant if `timetableView=true`.
|
|
1493
|
+
*
|
|
1494
|
+
* Note: With the current implementation, setting this to a lower
|
|
1495
|
+
* number will not result in any speedup.
|
|
1496
|
+
*
|
|
1497
|
+
* Note: The number of returned itineraries might be slightly higher
|
|
1498
|
+
* than `maxItineraries` as there might be several itineraries with
|
|
1499
|
+
* the same departure time but different number of transfers. In order
|
|
1500
|
+
* to not miss any itineraries for paging, either none or all
|
|
1501
|
+
* itineraries with the same departure time have to be returned.
|
|
1502
|
+
*
|
|
1503
|
+
*/
|
|
1504
|
+
maxItineraries?: number;
|
|
1144
1505
|
/**
|
|
1145
1506
|
* Optional. Default is 25 meters.
|
|
1146
1507
|
*
|
|
@@ -1263,6 +1624,16 @@ type PlanData = {
|
|
|
1263
1624
|
*
|
|
1264
1625
|
*/
|
|
1265
1626
|
postTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1629
|
+
*
|
|
1630
|
+
* Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviderGroups`).
|
|
1631
|
+
*
|
|
1632
|
+
* A list of rental provider groups that are allowed to be used from the last transit stop to the `to` coordinate.
|
|
1633
|
+
* If empty (the default), all providers are allowed.
|
|
1634
|
+
*
|
|
1635
|
+
*/
|
|
1636
|
+
postTransitRentalProviderGroups?: Array<(string)>;
|
|
1266
1637
|
/**
|
|
1267
1638
|
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1268
1639
|
*
|
|
@@ -1302,6 +1673,16 @@ type PlanData = {
|
|
|
1302
1673
|
*
|
|
1303
1674
|
*/
|
|
1304
1675
|
preTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
|
|
1676
|
+
/**
|
|
1677
|
+
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1678
|
+
*
|
|
1679
|
+
* Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviderGroups`).
|
|
1680
|
+
*
|
|
1681
|
+
* A list of rental provider groups that are allowed to be used from the `from` coordinate to the first transit stop.
|
|
1682
|
+
* If empty (the default), all providers are allowed.
|
|
1683
|
+
*
|
|
1684
|
+
*/
|
|
1685
|
+
preTransitRentalProviderGroups?: Array<(string)>;
|
|
1305
1686
|
/**
|
|
1306
1687
|
* Experimental. Expect unannounced breaking changes (without version bumps).
|
|
1307
1688
|
*
|
|
@@ -1736,7 +2117,7 @@ type GeocodeData = {
|
|
|
1736
2117
|
* (usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
1737
2118
|
*
|
|
1738
2119
|
*/
|
|
1739
|
-
language?: string
|
|
2120
|
+
language?: Array<(string)>;
|
|
1740
2121
|
/**
|
|
1741
2122
|
* Optional. Used for biasing results towards the coordinate.
|
|
1742
2123
|
*
|
|
@@ -1782,7 +2163,7 @@ type TripData = {
|
|
|
1782
2163
|
* (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
1783
2164
|
*
|
|
1784
2165
|
*/
|
|
1785
|
-
language?: string
|
|
2166
|
+
language?: Array<(string)>;
|
|
1786
2167
|
/**
|
|
1787
2168
|
* trip identifier (e.g. from an itinerary leg or stop event)
|
|
1788
2169
|
*/
|
|
@@ -1839,7 +2220,7 @@ type StoptimesData = {
|
|
|
1839
2220
|
* (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
1840
2221
|
*
|
|
1841
2222
|
*/
|
|
1842
|
-
language?: string
|
|
2223
|
+
language?: Array<(string)>;
|
|
1843
2224
|
/**
|
|
1844
2225
|
* Optional. Default is all transit modes.
|
|
1845
2226
|
*
|
|
@@ -1976,6 +2357,60 @@ type LevelsData = {
|
|
|
1976
2357
|
};
|
|
1977
2358
|
type LevelsResponse = (Array<(number)>);
|
|
1978
2359
|
type LevelsError = (Error);
|
|
2360
|
+
type RentalsData = {
|
|
2361
|
+
query?: {
|
|
2362
|
+
/**
|
|
2363
|
+
* latitude,longitude pair of the upper left coordinate
|
|
2364
|
+
*/
|
|
2365
|
+
max?: string;
|
|
2366
|
+
/**
|
|
2367
|
+
* latitude,longitude pair of the lower right coordinate
|
|
2368
|
+
*/
|
|
2369
|
+
min?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* A list of rental provider groups to return.
|
|
2372
|
+
* If both `providerGroups` and `providers` are empty/not specified,
|
|
2373
|
+
* all providers in the map section are returned.
|
|
2374
|
+
*
|
|
2375
|
+
*/
|
|
2376
|
+
providerGroups?: Array<(string)>;
|
|
2377
|
+
/**
|
|
2378
|
+
* A list of rental providers to return.
|
|
2379
|
+
* If both `providerGroups` and `providers` are empty/not specified,
|
|
2380
|
+
* all providers in the map section are returned.
|
|
2381
|
+
*
|
|
2382
|
+
*/
|
|
2383
|
+
providers?: Array<(string)>;
|
|
2384
|
+
/**
|
|
2385
|
+
* Optional. Include providers in output. If false, only provider
|
|
2386
|
+
* groups are returned.
|
|
2387
|
+
*
|
|
2388
|
+
* Also affects the providers list for each provider group.
|
|
2389
|
+
*
|
|
2390
|
+
*/
|
|
2391
|
+
withProviders?: boolean;
|
|
2392
|
+
/**
|
|
2393
|
+
* Optional. Include stations in output (requires at least min+max or providers filter).
|
|
2394
|
+
*/
|
|
2395
|
+
withStations?: boolean;
|
|
2396
|
+
/**
|
|
2397
|
+
* Optional. Include free-floating vehicles in output (requires at least min+max or providers filter).
|
|
2398
|
+
*/
|
|
2399
|
+
withVehicles?: boolean;
|
|
2400
|
+
/**
|
|
2401
|
+
* Optional. Include geofencing zones in output (requires at least min+max or providers filter).
|
|
2402
|
+
*/
|
|
2403
|
+
withZones?: boolean;
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
type RentalsResponse = ({
|
|
2407
|
+
providerGroups: Array<RentalProviderGroup>;
|
|
2408
|
+
providers: Array<RentalProvider>;
|
|
2409
|
+
stations: Array<RentalStation>;
|
|
2410
|
+
vehicles: Array<RentalVehicle>;
|
|
2411
|
+
zones: Array<RentalZone>;
|
|
2412
|
+
});
|
|
2413
|
+
type RentalsError = (Error);
|
|
1979
2414
|
type TransfersData = {
|
|
1980
2415
|
query: {
|
|
1981
2416
|
/**
|
|
@@ -1986,6 +2421,8 @@ type TransfersData = {
|
|
|
1986
2421
|
};
|
|
1987
2422
|
type TransfersResponse = ({
|
|
1988
2423
|
place: Place;
|
|
2424
|
+
root: Place;
|
|
2425
|
+
equivalences: Array<Place>;
|
|
1989
2426
|
/**
|
|
1990
2427
|
* true if the server has foot transfers computed
|
|
1991
2428
|
*/
|
|
@@ -2005,4 +2442,4 @@ type TransfersResponse = ({
|
|
|
2005
2442
|
});
|
|
2006
2443
|
type TransfersError = unknown;
|
|
2007
2444
|
|
|
2008
|
-
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 };
|
|
2445
|
+
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, MultiPolygon, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyResponse, PedestrianProfile, PedestrianSpeed, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalProvider, RentalProviderGroup, RentalReturnConstraint, RentalStation, RentalVehicle, RentalVehicleType, RentalZone, RentalZoneRestrictions, RentalsData, RentalsError, RentalsResponse, 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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@motis-project/motis-client",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.7.2",
|
|
4
4
|
"description": "A JS client for the MOTIS API.",
|
|
5
5
|
"public": true,
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
"/dist"
|
|
10
10
|
],
|
|
11
11
|
"scripts": {
|
|
12
|
-
"generate": "
|
|
12
|
+
"generate": "openapi-ts -i ../../openapi.yaml -o ./openapi/ -c @hey-api/client-fetch",
|
|
13
13
|
"transpile": "tsup openapi/**/*.ts --format esm --dts -d=./dist",
|
|
14
|
-
"build": "
|
|
14
|
+
"build": "pnpm generate && pnpm transpile"
|
|
15
15
|
},
|
|
16
16
|
"repository": {
|
|
17
17
|
"type": "git",
|