@iwpnd/valhalla-ts 1.0.1 → 1.0.3

package/dist/types/base.d.ts

@@ -1,4 +1,10 @@
 export type StringBool = 'true' | 'false';
+/**
+ * 0 - current departure time
+ * 1 - specified departure time
+ * 2 - specified arrival time
+ * 3 - invariant time
+ */
 export type DateTimeType = 0 | 1 | 2 | 3;
 export type DateTimeValue = string;
 export type DateTime = {

package/dist/types/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAQ1C,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACzC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,YAAY,CAAC;IAEnB,KAAK,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,EAAE,CAAC;AAE1C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,WAAW,GAAG,cAAc,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,CAAC;AAEvE,MAAM,MAAM,UAAU,GAChB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,WAAW,CAAC;AAElB,MAAM,MAAM,UAAU,GAChB,KAAK,GACL,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,KAAK,GACL,OAAO,GACP,WAAW,GACX,SAAS,GACT,WAAW,CAAC;AAElB,MAAM,MAAM,eAAe,GACrB,YAAY,GACZ,qBAAqB,GACrB,uBAAuB,CAAC"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACzC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,YAAY,CAAC;IAEnB,KAAK,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,EAAE,CAAC;AAE1C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,WAAW,GAAG,cAAc,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,CAAC;AAEvE,MAAM,MAAM,UAAU,GAChB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,WAAW,CAAC;AAElB,MAAM,MAAM,UAAU,GAChB,KAAK,GACL,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,KAAK,GACL,OAAO,GACP,WAAW,GACX,SAAS,GACT,WAAW,CAAC;AAElB,MAAM,MAAM,eAAe,GACrB,YAAY,GACZ,qBAAqB,GACrB,uBAAuB,CAAC"}

package/dist/types/costing.d.ts

@@ -2,7 +2,18 @@ import { StringBool } from './base';
 /**
  * Costing Models used in routing
  */
-export type CostingModels = 'pedestrian' | 'bicycle' | 'auto' | 'bus' | 'bikeshare' | 'truck' | 'taxi' | 'motor_scooter' | 'motorcycle' | 'multimodal';
+export declare enum CostingModels {
+    PEDESTRIAN = "pedestrian",
+    BICYCLE = "bicycle",
+    AUTO = "auto",
+    BUS = "bus",
+    TRUCK = "truck",
+    TAXI = "taxi",
+    MOTORSCOOTER = "motor_scooter",
+    MOTORCYCLE = "motorcycle",
+    BIKESHARE = "bikeshare",
+    MULTIMODAL = "multimodal"
+}
 /**
  * Automobile costing options that can be used during routing.
  */
@@ -100,41 +111,225 @@ export interface BaseMotorizedVehicleCostingOptions {
      * are not guaranteed to avoid tracks entirely.
      */
     use_tracks?: number;
+    /**
+     * A penalty applied for transition to generic service road.
+     * The default penalty is 0 trucks and 15 for cars, buses, motor scooters and motorcycles.
+     */
     service_penalty?: number;
+    /**
+     * A factor that modifies (multiplies) the cost when generic service roads are encountered.
+     * The default service_factor is 1.
+     */
     service_factor?: number;
+    /**
+     * A cost applied when encountering an international border.
+     * This cost is added to the estimated and elapsed times.
+     * The default cost is 600 seconds.
+     */
     country_crossing_cost?: number;
+    /**
+     * A penalty applied for a country crossing.
+     * This penalty can be used to create paths that avoid spanning country boundaries.
+     * The default penalty is 0.
+     */
     country_crossing_penalty?: number;
+    /**
+     * Changes the metric to quasi-shortest, i.e. purely distance-based costing.
+     *
+     * Note, this will disable all other costings & penalties.
+     * Also note, shortest will not disable hierarchy pruning,
+     * leading to potentially sub-optimal routes for some costing models.
+     *
+     * The default is false.
+     */
     shortest?: StringBool;
+    /**
+     * Top speed the vehicle can go.
+     * Also used to avoid roads with higher speeds than this value.
+     * top_speed must be between 10 and 252 KPH.
+     * The default value is 140 KPH.
+     */
     top_speed?: number;
+    /**
+     * Fixed speed the vehicle can go.
+     * Used to override the calculated speed.
+     * Can be useful if speed of vehicle is known.
+     * fixed_speed must be between 1 and 252 KPH.
+     * The default value is 0 KPH which disables fixed speed and falls back
+     * to the standard calculated speed based on the road attribution.
+     */
     fixed_speed?: number;
+    /**
+     * If set to true, ignores all closures, marked due to live traffic closures, during routing.
+     * Note: This option cannot be set if location.search_filter.exclude_closures is also specified
+     * in the request and will return an error if it is
+     */
     ignore_closures?: StringBool;
+    /**
+     * A factor that penalizes the cost when traversing a closed edge
+     * Its value can range from 1.0 - don't penalize closed edges,
+     * to 10.0 - apply high cost penalty to closed edges.
+     *
+     * Default value is 9.0.
+     *
+     * Note: This factor is applicable only for motorized modes of transport, i.e auto, motorcycle, motor_scooter, bus, truck & taxi.
+     */
     closure_factor?: number;
 }
+/**
+ * MotorizedVehicleCostingOptions are available for auto, bus, taxi
+ */
 export interface MotorizedVehicleCostingOptions extends BaseMotorizedVehicleCostingOptions {
+    /**
+     * The height of the vehicle (in meters).
+     * Default 1.9 for car, bus, taxi and 4.11 for truck.
+     */
     height?: number;
+    /**
+     * The width of the vehicle (in meters).
+     * Default 1.6 for car, bus, taxi and 2.6 for truck.
+     */
     width?: number;
+    /**
+     * This value indicates whether or not the path may include unpaved roads.
+     * If exclude_unpaved is set to 1 it is allowed to start and end with unpaved roads,
+     * but is not allowed to have them in the middle of the route path,
+     * otherwise they are allowed.
+     * Default false.
+     */
     exclude_unpaved?: 1 | 'false';
+    /**
+     * A boolean value which indicates the desire to avoid routes with cash-only tolls.
+     * Default false.
+     */
     exclude_cash_only_tolls?: StringBool;
+    /**
+     * A boolean value which indicates the desire to include HOV roads with a
+     * 2-occupant requirement in the route when advantageous.
+     *
+     * Default false.
+     */
     include_hov2?: StringBool;
+    /**
+     * A boolean value which indicates the desire to include HOV roads with a
+     * 3-occupant requirement in the route when advantageous.
+     *
+     * Default false.
+     */
     include_hov3?: StringBool;
+    /**
+     * A boolean value which indicates the desire to include tolled HOV roads
+     * which require the driver to pay a toll if the occupant requirement isn't met.
+     *
+     * Default false.
+     */
     include_hot?: StringBool;
 }
+/**
+ * TruckCostingOptions are only available for truck
+ */
 export interface TruckCostingOptions extends MotorizedVehicleCostingOptions {
+    /**
+     * The length of the truck (in meters).
+     * Default 21.64.
+     */
     length?: number;
+    /**
+     * The weight of the truck (in tons).
+     * Default 9.07.
+     */
     weight?: number;
+    /**
+     * The axle load of the truck (in metric tons).
+     * Default 9.07.
+     */
     axle_load?: number;
+    /**
+     * The axle count of the truck .
+     * Default 5.
+     */
     axle_count?: number;
+    /**
+     * A value indicating if the truck is carrying hazardous materials.
+     * Default false.
+     */
     hazmat?: StringBool;
 }
+/**
+ * PedestrianCostingOptions
+ */
 export interface PedestrianCostingOptions {
+    /**
+     * Walking speed in kilometers per hour (km/h). Must be between 0.5km/h and 25km/h
+     *
+     * Default value is 5.1 km/h
+     */
     walking_speed?: number;
+    /**
+     * Factor to modify the cost when encountering a road classified as footway.
+     * Pedestrian routing will generally prefer sidwalks and footpath over other roads.
+     *
+     * The Default value is 1.
+     */
     walkway_factor?: number;
+    /**
+     * Factor to modify the cost when encountering roads with dedicated sidewalks.
+     *
+     * The Default value is 1
+     */
     sidewalk_factor?: number;
+    /**
+     * Factor to modify (multiply) the cost when encountering alleys. Pedestrian routing wants to
+     * generally dis-favor alleys and narrow buildings between houses.
+     *
+     * The Default value is 2.0
+     */
     alley_factor?: number;
+    /**
+     * Factor to modify (multiply) the cost when encountering driveways.
+     * Pedestrian routing will try to avoid them.
+     *
+     * The Default value is 5.0
+     */
     driveway_factor?: number;
+    /**
+     * A penalty added to each path with steps or stairs.
+     *
+     * The Default value is 2.0
+     */
     step_penalty?: number;
+    /**
+     * A pedestrians's desire to tackle hills in their routes.
+     * This is a range of values from 0 to 1,
+     * where 0 attempts to avoid hills and steep grades even if it means a longer (time and distance) path,
+     * while 1 indicates the rider does not fear hills and steeper grades.
+     *
+     * The default value is 0.5
+     */
     use_hills?: number;
+    /**
+     * This value indicates the willingness to take ferries.
+     * This is a range of values between 0 and 1.
+     * Values near 0 attempt to avoid ferries and values near 1 will favor ferries.
+     *
+     * Note that sometimes ferries are required to complete a route so values of 0
+     * are not guaranteed to avoid ferries entirely.
+     *
+     * The default value is 0.5.
+     */
     use_ferry?: number;
+    /**
+     * This value indicates the willingness to take living streets.
+     * This is a range of values between 0 and 1.
+     *
+     * Values near 0 attempt to avoid living streets and
+     * values from 0.5 to 1 will currently have no effect on route selection.
+     *
+     * The default value is 0.5.
+     *
+     * Note that sometimes living streets are required to complete a route so values of 0
+     * are not guaranteed to avoid living streets entirely.
+     */
     use_living_streets?: number;
     /**
      * This value indicates the willingness to take track roads.
@@ -146,24 +341,153 @@ export interface PedestrianCostingOptions {
      * are not guaranteed to avoid tracks entirely.
      */
     use_tracks?: number;
+    /**
+     * A penalty applied for transition to generic service road.
+     * The default penalty is 0 trucks and 15 for cars, buses, motor scooters and motorcycles.
+     */
     service_penalty?: number;
+    /**
+     * A factor that modifies (multiplies) the cost when generic service roads are encountered.
+     * The default service_factor is 1.
+     */
     service_factor?: number;
+    /**
+     * This value indicates the maximum difficulty of hiking trails that is allowed.
+     *
+     * Values between 0 and 6 are allowed.
+     *
+     * The values correspond to sac_scale values within OpenStreetMap,
+     * see [here](https://wiki.openstreetmap.org/wiki/Key:sac_scale)
+     *
+     * The Default value is 1 which means that well cleared trails that are mostly flat or slightly sloped are allowed.
+     * Higher difficulty trails can be allowed by specifying a higher value for max_hiking_difficulty.
+     */
     max_hiking_difficulty?: number;
+    /**
+     * BSS = Bikeshare scheme
+     * This value is useful when bikeshare is chosen as travel mode.
+     * It is meant to give the time will be used to return a rental bike.
+     * This value will be displayed in the final directions and used to
+     * calculate the whole duation.
+     *
+     * The default value is 120 seconds.
+     */
     bss_return_cost?: number;
+    /**
+     * This value is useful when bikeshare is chosen as travel mode.
+     *
+     * It is meant to describe the potential effort to return a rental bike.
+     * This value won't be displayed and used only inside of the algorithm.
+     */
     bss_return_penalty?: number;
+    /**
+     * Changes the metric to quasi-shortest, i.e. purely distance-based costing.
+     *
+     * Note, this will disable all other costings & penalties.
+     * Also note, shortest will not disable hierarchy pruning, leading to
+     * potentially sub-optimal routes for some costing models.
+     *
+     * The default is false.
+     */
     shortest?: boolean;
 }
 export type BiycleType = 'Hybrid' | 'City' | 'Road' | 'Cross' | 'Mountain';
+/**
+ * BiycleCostingOptions
+ */
 export interface BicycleCostingOptions {
+    /**
+     * type of bicycle
+     */
     bicycle_type?: BiycleType;
+    /**
+     * Cycling speed is the average travel speed along smooth, flat roads.
+     *
+     * When no speed is specifically provided, the default speed is determined by the bicycle type and are as follows:
+     * Road = 25 KPH (15.5 MPH),
+     * Cross = 20 KPH (13 MPH),
+     * Hybrid/City = 18 KPH (11.5 MPH),
+     * and Mountain = 16 KPH (10 MPH).
+     */
     cycling_speed?: number;
+    /**
+     * A cyclist's propensity to use roads alongside other vehicles.
+     * This is a range of values from 0 to 1, where 0 attempts to avoid roads and stay on cycleways and paths,
+     * and 1 indicates the rider is more comfortable riding on roads.
+     * Based on the use_roads factor, roads with certain classifications
+     * and higher speeds are penalized in an attempt to avoid them when finding the best path.
+     *
+     * The default value is 0.5.
+     */
     use_roads?: number;
+    /**
+     * A cyclist's desire to tackle hills in their routes.
+     * This is a range of values from 0 to 1,
+     * where 0 attempts to avoid hills and steep grades even if it means a longer (time and distance) path,
+     * while 1 indicates the rider does not fear hills and steeper grades.
+     *
+     * The default value is 0.5
+     */
     use_hills?: number;
+    /**
+     * This value indicates the willingness to take ferries.
+     * This is a range of values between 0 and 1.
+     * Values near 0 attempt to avoid ferries and values near 1 will favor ferries.
+     *
+     * Note that sometimes ferries are required to complete a route so values of 0
+     * are not guaranteed to avoid ferries entirely.
+     *
+     * The default value is 0.5.
+     */
     use_ferry?: number;
+    /**
+     * This value indicates the willingness to take living streets.
+     * This is a range of values between 0 and 1.
+     *
+     * Values near 0 attempt to avoid living streets and
+     * values from 0.5 to 1 will currently have no effect on route selection.
+     *
+     * The default value is 0.5.
+     *
+     * Note that sometimes living streets are required to complete a route so values of 0
+     * are not guaranteed to avoid living streets entirely.
+     */
     use_living_streets?: number;
+    /**
+     * This value is meant to represent how much a cyclist wants to avoid
+     * roads with poor surfaces relative to the bicycle type being used.
+     *
+     * This is a range of values between 0 and 1.
+     * With 1 avoiding all bad surfaces, and 0 no penalization at all.
+     *
+     * The default value is 0.25.
+     */
     avoid_bad_surfaces?: number;
+    /**
+     * BSS = Bikeshare scheme
+     * This value is useful when bikeshare is chosen as travel mode.
+     * It is meant to give the time will be used to return a rental bike.
+     * This value will be displayed in the final directions and used to
+     * calculate the whole duation.
+     *
+     * The default value is 120 seconds.
+     */
     bss_return_cost?: number;
+    /**
+     * This value is useful when bikeshare is chosen as travel mode.
+     *
+     * It is meant to describe the potential effort to return a rental bike.
+     * This value won't be displayed and used only inside of the algorithm.
+     */
     bss_return_penalty?: number;
+    /**
+     * Changes the metric to quasi-shortest, i.e. purely distance-based costing.
+     *
+     * Note, this will disable all other costings & penalties.
+     * Also note, shortest will not disable hierarchy pruning, leading to potentially sub-optimal routes for some costing models.
+     *
+     * The default is false.
+     */
     shortest?: StringBool;
     /**
      * A penalty applied when transitioning between roads that do not have
@@ -184,15 +508,58 @@ export interface BicycleCostingOptions {
      * The default gate penalty is 300 seconds.
      */
     gate_penalty?: number;
+    /**
+     * A penalty applied for transition to generic service road.
+     * The default penalty is 0 trucks and 15 for cars, buses, motor scooters and motorcycles.
+     */
     service_penalty?: number;
+    /**
+     * A cost applied when encountering an international border.
+     * This cost is added to the estimated and elapsed times.
+     * The default cost is 600 seconds.
+     */
     country_crossing_cost?: number;
+    /**
+     * A penalty applied for a country crossing.
+     * This penalty can be used to create paths that avoid spanning country boundaries.
+     * The default penalty is 0.
+     */
     country_crossing_penalty?: number;
 }
+/**
+ * MotorScooterCostingOptions
+ */
 export interface MotorScooterCostingOptions extends MotorizedVehicleCostingOptions {
+    /**
+     * Top speed the motorized scooter can go.
+     * Used to avoid roads with higher speeds than this value.
+     * For motor_scooter this value must be between 20 and 120 KPH.
+     *
+     * The default value is 45 KPH (~28 MPH)
+     */
     top_speed?: number;
+    /**
+     * A riders's willingness to use primary roads.
+     * This is a range of values from 0 to 1, where
+     * 0 attempts to avoid primary roads, and
+     * 1 indicates the rider is more comfortable riding on primary roads.
+     *
+     * The default value is 0.5
+     */
     use_primary?: number;
+    /**
+     * A scooter drivers desire to tackle hills in their routes.
+     * This is a range of values from 0 to 1,
+     * where 0 attempts to avoid hills and steep grades even if it means a longer (time and distance) path,
+     * while 1 indicates the rider does not fear hills and steeper grades.
+     *
+     * The default value is 0.5
+     */
     use_hills?: number;
 }
+/**
+ * MotorcycleCostingOptions
+ */
 export interface MotorcycleCostingOptions extends MotorScooterCostingOptions {
     /**
      * This value indicates the willingness to take highways.
@@ -204,18 +571,63 @@ export interface MotorcycleCostingOptions extends MotorScooterCostingOptions {
      * are not guaranteed to avoid highways entirely.
      */
     use_highways?: number;
+    /**
+     * A riders's desire for adventure in their routes.
+     * This is a range of values from 0 to 1, where
+     *
+     * 0 will avoid trails, tracks, unclassified or bad surfaces and
+     * values towards 1 will tend to avoid major roads and route on secondary roads.
+     *
+     * The default value is 0.0.
+     */
     use_trial?: number;
 }
 export type TransitCostingFilter = {
     ids: string[];
     action: 'exclude' | 'include';
 };
+/**
+ * TransitCostingOptions
+ */
 export interface TransitCostingOptions {
+    /**
+     * User's desire to use buses.
+     * Range of values from 0 (try to avoid buses) to
+     * 1 (strong preference for riding buses).
+     */
     use_bus?: number;
+    /**
+     * User's desire to use rail/subway/metro.
+     * Range of values from 0 (try to avoid rail) to
+     * 1 (strong preference for riding rail).
+     */
     use_rail?: number;
+    /**
+     * User's desire to favor transfers.
+     * Range of values from 0 (try to avoid transfers) to
+     * 1 (totally comfortable with transfers).
+     */
     use_transfers?: number;
+    /**
+     * This is the maximum accepted walking distance at the beginning or end of a route for
+     * a pedestrian.
+     *
+     * The Default value is 2145 meters
+     */
     transit_start_end_max_distance?: number;
+    /**
+     * Maximum accepted walking distances in transfers
+     *
+     * The Default value is 800 meters
+     */
     transit_transfer_max_distance?: number;
+    /**
+     * A way to filter for one or more stops, routes, or operators.
+     * Filters must contain a list of Onestop IDs,
+     * which is a unique identifier for Transitland data, and an action.
+     *
+     * Example: [{"action": "exclude", ids: ["o-9q9-bart"]}]
+     */
     filters?: TransitCostingFilter[];
 }
 export type CostingOptions = {

package/dist/types/costing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"costing.d.ts","sourceRoot":"","sources":["../../src/types/costing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,aAAa,GACnB,YAAY,GACZ,SAAS,GACT,MAAM,GACN,KAAK,GACL,WAAW,GACX,OAAO,GACP,MAAM,GACN,eAAe,GACf,YAAY,GACZ,YAAY,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAKzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAM/B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAUlC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAOtB,SAAS,CAAC,EAAE,MAAM,CAAC;IASnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,eAAe,CAAC,EAAE,UAAU,CAAC;IAU7B,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAKD,MAAM,WAAW,8BACb,SAAQ,kCAAkC;IAK1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAQf,eAAe,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAK9B,uBAAuB,CAAC,EAAE,UAAU,CAAC;IAOrC,YAAY,CAAC,EAAE,UAAU,CAAC;IAO1B,YAAY,CAAC,EAAE,UAAU,CAAC;IAO1B,WAAW,CAAC,EAAE,UAAU,CAAC;CAC5B;AAKD,MAAM,WAAW,mBAAoB,SAAQ,8BAA8B;IAKvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB;AAKD,MAAM,WAAW,wBAAwB;IAMrC,aAAa,CAAC,EAAE,MAAM,CAAC;IAOvB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAOtB,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAStB,SAAS,CAAC,EAAE,MAAM,CAAC;IAWnB,SAAS,CAAC,EAAE,MAAM,CAAC;IAanB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAKzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAYxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAU/B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAU5B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,UAAU,GAEhB,QAAQ,GACR,MAAM,GAEN,MAAM,GAEN,OAAO,GAEP,UAAU,CAAC;AAKjB,MAAM,WAAW,qBAAqB;IAIlC,YAAY,CAAC,EAAE,UAAU,CAAC;IAU1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAUvB,SAAS,CAAC,EAAE,MAAM,CAAC;IASnB,SAAS,CAAC,EAAE,MAAM,CAAC;IAWnB,SAAS,CAAC,EAAE,MAAM,CAAC;IAanB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAU5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAU5B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAS5B,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAM/B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACrC;AAKD,MAAM,WAAW,0BACb,SAAQ,8BAA8B;IAQtC,SAAS,CAAC,EAAE,MAAM,CAAC;IASnB,WAAW,CAAC,EAAE,MAAM,CAAC;IASrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAKD,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B;IACxE;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAUtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CACjC,CAAC;AAKF,MAAM,WAAW,qBAAqB;IAMlC,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,aAAa,CAAC,EAAE,MAAM,CAAC;IAOvB,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAMxC,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAQvC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,CAAC,EAAE,8BAA8B,CAAC;IACtC,IAAI,CAAC,EAAE,8BAA8B,CAAC;IACtC,GAAG,CAAC,EAAE,8BAA8B,CAAC;IACrC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;IAC3C,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACtC,CAAC"}
+{"version":3,"file":"costing.d.ts","sourceRoot":"","sources":["../../src/types/costing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,oBAAY,aAAa;IACrB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;IACb,YAAY,kBAAkB;IAC9B,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,UAAU,eAAe;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,8BACb,SAAQ,kCAAkC;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,UAAU,CAAC;IACrC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,8BAA8B;IACvE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,UAAU,GAEhB,QAAQ,GACR,MAAM,GAEN,MAAM,GAEN,OAAO,GAEP,UAAU,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,0BACb,SAAQ,8BAA8B;IACtC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B;IACxE;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,CAAC,EAAE,8BAA8B,CAAC;IACtC,IAAI,CAAC,EAAE,8BAA8B,CAAC;IACtC,GAAG,CAAC,EAAE,8BAA8B,CAAC;IACrC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;IAC3C,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACtC,CAAC"}

package/dist/types/costing.js

@@ -1,3 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CostingModels = void 0;
+/**
+ * Costing Models used in routing
+ */
+var CostingModels;
+(function (CostingModels) {
+    CostingModels["PEDESTRIAN"] = "pedestrian";
+    CostingModels["BICYCLE"] = "bicycle";
+    CostingModels["AUTO"] = "auto";
+    CostingModels["BUS"] = "bus";
+    CostingModels["TRUCK"] = "truck";
+    CostingModels["TAXI"] = "taxi";
+    CostingModels["MOTORSCOOTER"] = "motor_scooter";
+    CostingModels["MOTORCYCLE"] = "motorcycle";
+    CostingModels["BIKESHARE"] = "bikeshare";
+    CostingModels["MULTIMODAL"] = "multimodal";
+})(CostingModels || (exports.CostingModels = CostingModels = {}));
 //# sourceMappingURL=costing.js.map

package/dist/types/costing.js.map

@@ -1 +1 @@
-{"version":3,"file":"costing.js","sourceRoot":"","sources":["../../src/types/costing.ts"],"names":[],"mappings":""}
+{"version":3,"file":"costing.js","sourceRoot":"","sources":["../../src/types/costing.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,aAWX;AAXD,WAAY,aAAa;IACrB,0CAAyB,CAAA;IACzB,oCAAmB,CAAA;IACnB,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,+CAA8B,CAAA;IAC9B,0CAAyB,CAAA;IACzB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA;AAC7B,CAAC,EAXW,aAAa,6BAAb,aAAa,QAWxB"}

package/dist/types/error.d.ts

@@ -1,4 +1,8 @@
 export interface ErrorResponse {
+    /**
+     * for detailed run-down see
+     * [here](https://valhalla.github.io/valhalla/api/turn-by-turn/api-reference/#http-status-codes-and-conditions)
+     */
     status: string;
     status_message: string;
     error_code?: string;

package/dist/types/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/types/error.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAK1B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/types/error.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/locations.d.ts

@@ -4,24 +4,67 @@ import { StringBool } from './base';
  */
 export type RoadClass = 'motorway' | 'trunk' | 'primary' | 'secondary' | 'tertiary' | 'unclassified' | 'residential' | 'service_other';
 export type PreferredSide = 'same' | 'opposite' | 'either';
+/**
+ * LocationType
+ * - break: u-turn allowed, generate guidance, create legs from
+ * - through: u-turn not allowed, not guidance, not new legs, just passthrough
+ * - via: u-turn allowed, no legs
+ * - break_through: u-turn not allowed, create legs from
+ *
+ * first and last position of a request are always considered a break point
+ */
 export type LocationType = 'break' | 'break_through' | 'through' | 'via';
 type LocationSearchFilter = {
+    /**
+     * Exclude tunnel edges
+     */
     exclude_tunnel?: StringBool;
+    /**
+     * Exclude bridge edges
+     */
     exclude_bridge?: StringBool;
+    /**
+     * Exclude ramp edges
+     */
     exclude_ramp?: StringBool;
+    /**
+     * Exclude closure edges
+     */
     exclude_closure?: StringBool;
+    /**
+     * lowest road class allowed to snap to, defaults to 'service_other'
+     */
     min_road_class?: RoadClass;
+    /**
+     * highest road class allowed to snap to, defaults to 'motorway'
+     */
     max_road_class?: RoadClass;
 };
 export interface Position {
+    /**
+     * Latitude, duh
+     */
     lat: number;
+    /**
+     * Longitude, duh
+     */
     lon: number;
 }
 export interface ResponseLocation extends Position {
+    /**
+     * The order of the location on the initial request
+     */
     original_index: number;
+    /**
+     * @see {@link LocationType}
+     */
     type: LocationType;
 }
 export interface RequestLocation extends Omit<ResponseLocation, 'original_index' | 'type'> {
+    /**
+     * Additional location information that is forward in the response
+     * name, might be used in routing narration <arrived at "${name}">
+     */
     name?: string;
     city?: string;
     state?: string;
@@ -29,21 +72,81 @@ export interface RequestLocation extends Omit<ResponseLocation, 'original_index'
     country?: string;
     phone?: string;
     url?: string;
+    /**
+     * Time in seconds to spend at location, only for type break or break_through
+     */
     waiting?: number;
+    /**
+     * preferred direction of travel for start
+     */
     heading?: number;
+    /**
+     * tolerance as to when a street would be considered to be
+     * the same as heading parameter. (default: 60)
+     */
     heading_tolerance?: number;
+    /**
+     * aid in finding the correct street at a given lat/lon, not yet implemented
+     * @exprimental
+     */
     street?: string;
+    /**
+     * OSM id of a way to aid in finding the correct routing at a given lat/lon
+     */
     way_id?: number;
+    /**
+     * Minimum number of nodes for a given edge to be considered connected to a region
+     * default: 50 reachable nodes
+     */
     minimum_reachability?: number;
+    /**
+     * Number of meters around the input lat/lon in which edges will be considered.
+     * If non are found, Valhalla will try to find the closest edge.
+     * default: 0 meters
+     */
     radius?: number;
+    /**
+     * If "true", candidate edges will be ranked based upon their distance to input lat/lon
+     * If "false", all candidate edges will be treated equal with emphesis on optimal route
+     */
     rank_candidates?: StringBool;
+    /**
+     * - "same": e.g. drive on the right side, end on the right side
+     * - "opposite": e.g. drive on the right side, end on the left side
+     * - "either": e.g. nobody cares bruh
+     */
     preferred_side?: PreferredSide;
+    /**
+     * If provided lat/lon will be used for routing location, display_lat/display_lon will be
+     * used to show street side location
+     */
     display_lat?: number;
+    /**
+     * If provided lat/lon will be used for routing location, display_lat/display_lon will be
+     * used to show street side location
+     */
     display_lon?: number;
+    /**
+     * cutoff at which Valhalla will be considering an input of being too far to away from network to route to
+     */
     search_cutoff?: number;
+    /**
+     * distance in meters when to snap to intersection or stay on street
+     * default: 5 meters
+     */
     node_snap_tolerance?: number;
+    /**
+     * if inpout coordinate is less than tolerance away from the edge, then Valhalla set side of
+     * street to None, otherwise left or right depending on direction of travel
+     */
     street_side_tolerance?: number;
+    /**
+     * max distance in meters that input lat/lon are considered to determine side of street
+     */
     streetside_max_distance?: number;
+    /**
+     * set of optional filters to exclude edges from the route
+     */
     search_filter?: LocationSearchFilter;
 }
 export interface LatLng {

package/dist/types/locations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locations.d.ts","sourceRoot":"","sources":["../../src/types/locations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,SAAS,GACf,UAAU,GACV,OAAO,GACP,SAAS,GACT,WAAW,GACX,UAAU,GACV,cAAc,GACd,aAAa,GACb,eAAe,CAAC;AAEtB,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;AAW3D,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,eAAe,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzE,KAAK,oBAAoB,GAAG;IAIxB,cAAc,CAAC,EAAE,UAAU,CAAC;IAI5B,cAAc,CAAC,EAAE,UAAU,CAAC;IAI5B,YAAY,CAAC,EAAE,UAAU,CAAC;IAI1B,eAAe,CAAC,EAAE,UAAU,CAAC;IAI7B,cAAc,CAAC,EAAE,SAAS,CAAC;IAI3B,cAAc,CAAC,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,QAAQ;IAIrB,GAAG,EAAE,MAAM,CAAC;IAIZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAI9C,cAAc,EAAE,MAAM,CAAC;IAIvB,IAAI,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,eACb,SAAQ,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAKzD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IAIb,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAK3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAIhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAM9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,eAAe,CAAC,EAAE,UAAU,CAAC;IAM7B,cAAc,CAAC,EAAE,aAAa,CAAC;IAK/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,WAAW,CAAC,EAAE,MAAM,CAAC;IAIrB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAK7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAI/B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAIjC,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACxC;AAED,MAAM,WAAW,MAAM;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,YAAY,CAAC;CACvB"}
+{"version":3,"file":"locations.d.ts","sourceRoot":"","sources":["../../src/types/locations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,SAAS,GACf,UAAU,GACV,OAAO,GACP,SAAS,GACT,WAAW,GACX,UAAU,GACV,cAAc,GACd,aAAa,GACb,eAAe,CAAC;AAEtB,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,eAAe,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzE,KAAK,oBAAoB,GAAG;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,QAAQ;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAC9C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,eACb,SAAQ,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACzD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;;;OAIG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACxC;AAED,MAAM,WAAW,MAAM;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,YAAY,CAAC;CACvB"}

package/dist/types/maneuver.d.ts

@@ -48,6 +48,10 @@ export interface TransitStops {
     arrival_date_time: string;
     departure_date_time: string;
     is_parent_stop: boolean;
+    /**
+     * True if the times are based on an assumed schedule
+     * because the actual schedule is not known.
+     */
     assumed_schedule: boolean;
     lat: number;
     lon: number;
@@ -56,13 +60,31 @@ export interface TransitInfo {
     onestop_id: string;
     short_name: string;
     long_name: string;
+    /**
+     * The sign on a public transport vehicle that identifies the route destination to passengers
+     *
+     * Example: "S1 - Wannsee"
+     */
     headsign: string;
+    /**
+     * Color associated with transit route
+     *
+     * Example: Berlin S1 is "pink"
+     */
     color: string;
+    /**
+     * The numeric text color value associated with a transit route.
+     * The value for black would be "0".
+     */
     text_color: string;
     description: string;
     operator_ones_top_id: string;
     operator_name: string;
     operator_url: string;
+    /**
+     * A list of the stops/stations associated with a specific transit route.
+     * See TransitStop
+     */
     transit_stops: TransitStops;
 }
 export interface ManeuverSignElement {
@@ -70,17 +92,41 @@ export interface ManeuverSignElement {
     consecutive_count?: number;
 }
 export interface ManeuverSign {
+    /**
+     * Example: { "text": "91B" }
+     */
     exit_number_elements: ManeuverSignElement[];
+    /**
+     * Example: { "text": "I 95 North" }
+     */
     exit_branch_elements: ManeuverSignElement[];
+    /**
+     * Example: { "text": "New York" }
+     */
     exit_toward_elements: ManeuverSignElement[];
+    /**
+     * Example: { "text": "Your mom" }
+     */
     exit_name_elements: ManeuverSignElement[];
 }
 export interface Maneuver {
     type: ManeuverType;
     street_names: string[];
+    /**
+     * Estimated time along the maneuver in seconds.
+     */
     time: number;
+    /**
+     * Maneuver length in the units specified (mi, km).
+     */
     length: number;
+    /**
+     * Index into the list of shape points for the start of the maneuver.
+     */
     begin_shape_index: number;
+    /**
+     * Index into the list of shape points for the end of the maneuver.
+     */
     end_shape_index: number;
     travel_mode: TravelMode;
     travel_type: TravelType;
@@ -94,14 +140,62 @@ export interface Maneuver {
     roundabout_exit_count?: number;
 }
 export interface ManeuverWithInstructions extends Maneuver {
+    /**
+     * Written maneuver instruction. Describes the maneuver,
+     * such as "Turn right onto Main Street".
+     */
     instruction: string;
+    /**
+     * Text suitable for use as a verbal alert in a navigation application.
+     *
+     * Example: "Turn right onto North Prince Street"
+     */
     verbal_succinct_transition_instruction: string;
+    /**
+     * Text suitable for use as a verbal message immediately prior to
+     * the maneuver transition
+     *
+     * Example: "Turn right onto North Prince Street, U.S. 2 22"
+     */
     verbal_pre_transition_instruction: string;
+    /**
+     * Text suitable for use as a verbal message immediately after the maneuver transition.
+     *
+     * Example: "Continue on U.S. 2 22 for 3.9 miles"
+     */
     verbal_post_transition_instruction: string;
+    /**
+     * Written depart time instruction.
+     * Typically used with a transit maneuver, such as
+     *
+     * Example: "Depart: 8:04 AM from 8 St - NYU".
+     */
     depart_instruction?: string;
+    /**
+     * Text suitable for use as a verbal depart time instruction.
+     * Typically used with a transit maneuver.
+     *
+     * Example: "Depart at 8:04 AM from 8 St - NYU".
+     */
     verbal_depart_instruction?: string;
+    /**
+     * Written arrive time instruction.
+     * Typically used with a transit maneuver,
+     *
+     * Example: "Arrive: 8:10 AM at 34 St - Herald Sq".
+     */
     arrive_instruction?: string;
+    /**
+     * Text suitable for use as a verbal arrive time instruction.
+     * Typically used with a transit maneuver.
+     *
+     * Example: "Arrive at 8:10 AM at 34 St - Herald Sq".
+     */
     verbal_arrive_instruction?: string;
+    /**
+     * True if the verbal_pre_transition_instruction has been appended
+     * with the verbal instruction of the next maneuver.
+     */
     verbal_multi_cue?: boolean;
 }
 export interface ManeuverWithInstructionsForTransit extends ManeuverWithInstructions {

package/dist/types/maneuver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maneuver.d.ts","sourceRoot":"","sources":["../../src/types/maneuver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEjE,oBAAY,YAAY;IACpB,KAAK,IAAI;IACT,MAAM,IAAI;IACV,WAAW,IAAI;IACf,UAAU,IAAI;IACd,YAAY,IAAI;IAChB,iBAAiB,IAAI;IACrB,gBAAgB,IAAI;IACpB,QAAQ,IAAI;IACZ,SAAS,IAAI;IACb,YAAY,IAAI;IAChB,MAAM,KAAK;IACX,WAAW,KAAK;IAChB,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,UAAU,KAAK;IACf,KAAK,KAAK;IACV,WAAW,KAAK;IAChB,aAAa,KAAK;IAClB,UAAU,KAAK;IACf,SAAS,KAAK;IACd,UAAU,KAAK;IACf,SAAS,KAAK;IACd,aAAa,KAAK;IAClB,UAAU,KAAK;IACf,SAAS,KAAK;IACd,MAAM,KAAK;IACX,gBAAgB,KAAK;IACrB,eAAe,KAAK;IACpB,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,QAAQ,KAAK;IACb,gBAAgB,KAAK;IACrB,gBAAgB,KAAK;IACrB,uBAAuB,KAAK;IAC5B,0BAA0B,KAAK;IAC/B,6BAA6B,KAAK;IAClC,iCAAiC,KAAK;IACtC,WAAW,KAAK;IAChB,UAAU,KAAK;CAClB;AAGD,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,CAAC;AAEpC,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,eAAe,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IAKxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAMlB,QAAQ,EAAE,MAAM,CAAC;IAMjB,KAAK,EAAE,MAAM,CAAC;IAKd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IAKrB,aAAa,EAAE,YAAY,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,YAAY;IAIzB,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAI5C,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAI5C,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAI5C,kBAAkB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,YAAY,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IAIvB,IAAI,EAAE,MAAM,CAAC;IAIb,MAAM,EAAE,MAAM,CAAC;IAIf,iBAAiB,EAAE,MAAM,CAAC;IAI1B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,UAAU,CAAC;IACxB,WAAW,EAAE,UAAU,CAAC;IACxB,iBAAiB,CAAC,EAAE,eAAe,CAAC;IACpC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,wBAAyB,SAAQ,QAAQ;IAKtD,WAAW,EAAE,MAAM,CAAC;IAMpB,sCAAsC,EAAE,MAAM,CAAC;IAO/C,iCAAiC,EAAE,MAAM,CAAC;IAM1C,kCAAkC,EAAE,MAAM,CAAC;IAO3C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAO5B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAOnC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAO5B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAKnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,kCACb,SAAQ,wBAAwB;IAChC,OAAO,CAAC,EAAE,WAAW,CAAC;CACzB"}
+{"version":3,"file":"maneuver.d.ts","sourceRoot":"","sources":["../../src/types/maneuver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEjE,oBAAY,YAAY;IACpB,KAAK,IAAI;IACT,MAAM,IAAI;IACV,WAAW,IAAI;IACf,UAAU,IAAI;IACd,YAAY,IAAI;IAChB,iBAAiB,IAAI;IACrB,gBAAgB,IAAI;IACpB,QAAQ,IAAI;IACZ,SAAS,IAAI;IACb,YAAY,IAAI;IAChB,MAAM,KAAK;IACX,WAAW,KAAK;IAChB,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,UAAU,KAAK;IACf,KAAK,KAAK;IACV,WAAW,KAAK;IAChB,aAAa,KAAK;IAClB,UAAU,KAAK;IACf,SAAS,KAAK;IACd,UAAU,KAAK;IACf,SAAS,KAAK;IACd,aAAa,KAAK;IAClB,UAAU,KAAK;IACf,SAAS,KAAK;IACd,MAAM,KAAK;IACX,gBAAgB,KAAK;IACrB,eAAe,KAAK;IACpB,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,QAAQ,KAAK;IACb,gBAAgB,KAAK;IACrB,gBAAgB,KAAK;IACrB,uBAAuB,KAAK;IAC5B,0BAA0B,KAAK;IAC/B,6BAA6B,KAAK;IAClC,iCAAiC,KAAK;IACtC,WAAW,KAAK;IAChB,UAAU,KAAK;CAClB;AAGD,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,CAAC;AAEpC,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,eAAe,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,aAAa,EAAE,YAAY,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C;;OAEG;IACH,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C;;OAEG;IACH,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C;;OAEG;IACH,kBAAkB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,YAAY,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,UAAU,CAAC;IACxB,WAAW,EAAE,UAAU,CAAC;IACxB,iBAAiB,CAAC,EAAE,eAAe,CAAC;IACpC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,wBAAyB,SAAQ,QAAQ;IACtD;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,sCAAsC,EAAE,MAAM,CAAC;IAC/C;;;;;OAKG;IACH,iCAAiC,EAAE,MAAM,CAAC;IAC1C;;;;OAIG;IACH,kCAAkC,EAAE,MAAM,CAAC;IAC3C;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,kCACb,SAAQ,wBAAwB;IAChC,OAAO,CAAC,EAAE,WAAW,CAAC;CACzB"}

package/dist/types/request.d.ts

@@ -8,7 +8,7 @@ export interface DirectionsOptions {
     language?: SupportedLanguageTags | SupportedLanguageAlias;
 }
 export interface MapMatchingBaseRequest {
-    costing: Extract<CostingModels, 'auto' | 'bicycle' | 'bus' | 'pedestrian'>;
+    costing: `${Extract<CostingModels, 'auto' | 'bicycle' | 'bus' | 'pedestrian'>}`;
     shape_match: ShapeMatchType;
     costing_options?: CostingOptions;
     directions_options?: DirectionsOptions;
@@ -29,68 +29,96 @@ export interface BaseRouteRequest {
     locations: RequestLocation[];
     costing_options?: CostingOptions;
     directions_options?: DirectionsOptions;
+    /**
+     * none | maneuvers | instructions
+     */
     directions_type?: DirectionsType;
+    /**
+     * ID that is returned in route response for reference
+     */
     id?: string;
+    /**
+     * Exclude edges that are close to a set of Positions from the final route
+     */
     exclude_locations?: RequestLocation[];
+    /**
+     * Exclude edges that intersect a set of polygons from the final route
+     */
     exclude_polygons?: OuterPolygonRing[];
+    /**
+     * Use to define departure and arrival time
+     */
     date_time?: DateTime;
+    /**
+     * Output format, defaults to json
+     */
     out_format?: 'json' | 'pbf';
+    /**
+     * When present and true, the successful route response will include a key linear_references
+     */
     linear_references?: StringBool;
+    /**
+     * Prioritize bidirectional a* when date_time.type = depart_at/current.
+     * By default time_dependent_forward a* is used in these cases,
+     * but bidirectional a* is much faster. Currently it does not update
+     * the time (and speeds) when searching for the route path,
+     * but the ETA on that route is recalculated based on the time-dependent speeds
+     */
     prioritize_bidirectional?: StringBool;
 }
 export interface BicycleRouteRequest extends BaseRouteRequest {
-    costing: 'bicycle';
+    costing: `${CostingModels.BICYCLE}`;
     costing_options?: {
         bicycle: BicycleCostingOptions;
     };
 }
 export interface PedestrianRouteRequest extends BaseRouteRequest {
-    costing: 'pedestrian';
+    costing: `${CostingModels.PEDESTRIAN}`;
     costing_options?: {
         pedestrian: PedestrianCostingOptions;
     };
 }
 export interface AutoRouteRequest extends BaseRouteRequest {
-    costing: 'auto';
+    costing: `${CostingModels.AUTO}`;
     costing_options?: {
         auto: MotorizedVehicleCostingOptions;
     };
 }
 export interface BusRouteRequest extends BaseRouteRequest {
-    costing: 'bus';
+    costing: `${CostingModels.BUS}`;
     costing_options?: {
         bus: MotorizedVehicleCostingOptions;
     };
 }
 export interface TaxiRouteRequest extends BaseRouteRequest {
-    costing: 'taxi';
+    costing: `${CostingModels.TAXI}`;
     costing_options?: {
         taxi: MotorizedVehicleCostingOptions;
     };
 }
 export interface TruckRouteRequest extends BaseRouteRequest {
-    costing: 'truck';
+    costing: `${CostingModels.TRUCK}`;
     costing_options?: {
         truck: TruckCostingOptions;
     };
 }
 export interface MotorCycleRouteRequest extends BaseRouteRequest {
-    costing: 'motorcycle';
+    costing: `${CostingModels.MOTORCYCLE}`;
     costing_options?: {
         motorcycle: MotorcycleCostingOptions;
     };
 }
 export interface MotorScooterRouteRequest extends BaseRouteRequest {
-    costing: 'motor_scooter';
+    costing: `${CostingModels.MOTORSCOOTER}`;
     costing_options?: {
         motor_scooter: MotorScooterCostingOptions;
     };
 }
 export interface MultiModalRouteRequest extends BaseRouteRequest {
-    costing: 'multimodal';
+    costing: `${CostingModels.MULTIMODAL}`;
 }
 export interface BikeShareRouteRequest extends BaseRouteRequest {
-    costing: 'bikeshare';
+    costing: `${CostingModels.BIKESHARE}`;
 }
 export type TurnByTurnRouteRequest = BicycleRouteRequest | PedestrianRouteRequest | AutoRouteRequest | BusRouteRequest | TaxiRouteRequest | TruckRouteRequest | MotorCycleRouteRequest | MotorScooterRouteRequest | BikeShareRouteRequest | MultiModalRouteRequest;
 export type OptimizedRouteRequest = AutoRouteRequest | BicycleRouteRequest | PedestrianRouteRequest;
@@ -106,9 +134,28 @@ export interface IsochroneDistanceContour extends IsochroneBaseContour {
 export type IsochroneBaseRequest = (AutoRouteRequest | BicycleRouteRequest | PedestrianRouteRequest | MultiModalRouteRequest) & {
     date_time?: DateTime;
     id?: string;
+    /**
+     * A Boolean value to determine whether to return geojson polygons or linestrings as the contours.
+     *
+     * The Default value is false (returns LineStrings)
+     */
     polygons?: boolean;
+    /**
+     * A floating point value from 0 to 1 (default of 1) which can be used to remove smaller contours.
+     * A value of 1 will only return the largest contour for a given time value.
+     * A value of 0.5 drops any contours that are less than half the area of
+     * the largest contour in the set of contours for that same time value.
+     */
     denoise?: number;
+    /**
+     * Floating point value in meters as the tolerance in douglas-peucker generalization
+     */
     generalize?: number;
+    /**
+     * True, returns input location as MultiPoint, one for the search location, one for the snap to the edge
+     *
+     * The Default value is false
+     */
     show_locations?: boolean;
 };
 export type IsochroneTimeRequest = IsochroneBaseRequest & {

package/dist/types/request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/types/request.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,eAAe,EAClB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACH,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,EACxB,8BAA8B,EAC9B,wBAAwB,EACxB,mBAAmB,EACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEhE,MAAM,WAAW,iBAAiB;IAC9B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,qBAAqB,GAAG,sBAAsB,CAAC;CAC7D;AAED,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,YAAY,CAAC,CAAC;IAC3E,WAAW,EAAE,cAAc,CAAC;IAC5B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IACvC,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACtE,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IAIvC,eAAe,CAAC,EAAE,cAAc,CAAC;IAIjC,EAAE,CAAC,EAAE,MAAM,CAAC;IAIZ,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC;IAItC,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAItC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAIrB,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAI5B,iBAAiB,CAAC,EAAE,UAAU,CAAC;IAQ/B,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACzC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD,OAAO,EAAE,SAAS,CAAC;IACnB,eAAe,CAAC,EAAE;QAAE,OAAO,EAAE,qBAAqB,CAAA;KAAE,CAAC;CACxD;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,eAAe,CAAC,EAAE;QAAE,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE;QAAE,IAAI,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACrD,OAAO,EAAE,KAAK,CAAC;IACf,eAAe,CAAC,EAAE;QAAE,GAAG,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE;QAAE,IAAI,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE;QAAE,KAAK,EAAE,mBAAmB,CAAA;KAAE,CAAC;CACpD;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,eAAe,CAAC,EAAE;QAAE,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAC9D,OAAO,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE;QAAE,aAAa,EAAE,0BAA0B,CAAA;KAAE,CAAC;CACnE;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,OAAO,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,MAAM,sBAAsB,GAC5B,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,qBAAqB,GACrB,sBAAsB,CAAC;AAE7B,MAAM,MAAM,qBAAqB,GAC3B,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,CAAC;AAE7B,MAAM,WAAW,oBAAoB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAC7B,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,GACtB,sBAAsB,CAC3B,GAAG;IACA,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IAMZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IAOnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACtD,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAC1D,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACxC,CAAC"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/types/request.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,eAAe,EAClB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACH,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,EACxB,8BAA8B,EAC9B,wBAAwB,EACxB,mBAAmB,EACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEhE,MAAM,WAAW,iBAAiB;IAC9B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,qBAAqB,GAAG,sBAAsB,CAAC;CAC7D;AAED,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,YAAY,CAAC,EAAE,CAAC;IAChF,WAAW,EAAE,cAAc,CAAC;IAC5B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IACvC,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACtE,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC;IACtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,UAAU,CAAC;IAC/B;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACzC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD,OAAO,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,CAAC;IACpC,eAAe,CAAC,EAAE;QAAE,OAAO,EAAE,qBAAqB,CAAA;KAAE,CAAC;CACxD;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;IACvC,eAAe,CAAC,EAAE;QAAE,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,OAAO,EAAE,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;IACjC,eAAe,CAAC,EAAE;QAAE,IAAI,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACrD,OAAO,EAAE,GAAG,aAAa,CAAC,GAAG,EAAE,CAAC;IAChC,eAAe,CAAC,EAAE;QAAE,GAAG,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,OAAO,EAAE,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;IACjC,eAAe,CAAC,EAAE;QAAE,IAAI,EAAE,8BAA8B,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACvD,OAAO,EAAE,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC;IAClC,eAAe,CAAC,EAAE;QAAE,KAAK,EAAE,mBAAmB,CAAA;KAAE,CAAC;CACpD;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;IACvC,eAAe,CAAC,EAAE;QAAE,UAAU,EAAE,wBAAwB,CAAA;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAC9D,OAAO,EAAE,GAAG,aAAa,CAAC,YAAY,EAAE,CAAC;IACzC,eAAe,CAAC,EAAE;QAAE,aAAa,EAAE,0BAA0B,CAAA;KAAE,CAAC;CACnE;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,OAAO,EAAE,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,OAAO,EAAE,GAAG,aAAa,CAAC,SAAS,EAAE,CAAC;CACzC;AAED,MAAM,MAAM,sBAAsB,GAC5B,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,qBAAqB,GACrB,sBAAsB,CAAC;AAE7B,MAAM,MAAM,qBAAqB,GAC3B,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,CAAC;AAE7B,MAAM,WAAW,oBAAoB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAC7B,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,GACtB,sBAAsB,CAC3B,GAAG;IACA,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACtD,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAC1D,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACxC,CAAC"}

package/dist/types/response.d.ts

@@ -26,6 +26,10 @@ export interface LegWithManeuvers<T extends Maneuver = Maneuver> extends Leg {
 export interface Trip<T extends Leg = Leg> {
     locations: ResponseLocation[];
     legs: T[];
+    /**
+     * for detailed run-down see
+     * [here](https://valhalla.github.io/valhalla/api/turn-by-turn/api-reference/#http-status-codes-and-conditions)
+     */
     status: number;
     status_message: string;
     language: SupportedLanguageAlias | SupportedLanguageTags;
@@ -58,14 +62,37 @@ export interface MatchedPoints {
     lon: number;
     type: 'matched' | 'interpolated' | 'unmatched';
     edge_index: number;
+    /**
+     * The boolean value is true if this match result is the begin location of a route disconnect.
+     *
+     * This value will not exist if this is false.
+     */
     begin_route_discontinuity?: boolean;
+    /**
+     * The boolean value is true if this match result is the end location of a route disconnect.
+     * This value will not exist if this is false.
+     */
     end_route_discontinuity?: boolean;
+    /**
+     * The distance along the associated edge for this matched point.
+     * For example, if the matched point is halfway along the edge then the value would be 0.5.
+     *
+     * This value will not exist if this point was unmatched.
+     */
     distance_along_edge: number;
+    /**
+     * The distance in meters from the trace point to the matched point.
+     *
+     * This value will not exist if this point was unmatched.
+     */
     distance_from_trace_point?: number;
 }
 export interface MapMatchingTraceAttributesResponse {
     units: UnitsOfDistance;
     osm_changeset: number;
+    /**
+     * Encoded polyline
+     */
     shape: string;
     confidence_score: number;
     raw_score: number;
@@ -78,10 +105,26 @@ export interface MapMatchingTraceAttributesResponse {
     edges: object[];
     matched_points: MatchedPoints[];
 }
+/**
+ * Status Service API
+ *
+ * In its base form will return version and tileset_last_modified
+ *
+ * If service_limits.status.allow_verbose is set to true, will also
+ * return addtional.
+ */
 export interface StatusResponse {
     version: string;
     tileset_last_modfied: number;
 }
+/**
+ * Status Service API
+ *
+ * In its base form will return version and tileset_last_modified
+ *
+ * If service_limits.status.allow_verbose is set to true, will also
+ * return addtional.
+ */
 export interface ExtendedStatusResponse extends StatusResponse {
     has_tiles?: boolean;
     has_admin?: boolean;

package/dist/types/response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/types/response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,WAAW,OAAO;IACpB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,GAAG;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,GAAG;IACxE,SAAS,EAAE,CAAC,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG;IACrC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,EAAE,CAAC;IAKV,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,sBAAsB,GAAG,qBAAqB,CAAC;IACzD,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG;IAC7C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,mCAAmC;IAChD,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CACnC,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,OAAO,EACzD,2BAA2B,CAC9B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CACrD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,EACzD,2BAA2B,CAC9B,CAAC;AAEF,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,GAAG,cAAc,GAAG,WAAW,CAAC;IAC/C,UAAU,EAAE,MAAM,CAAC;IAMnB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAKpC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAOlC,mBAAmB,EAAE,MAAM,CAAC;IAM5B,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,kCAAkC;IAC/C,KAAK,EAAE,eAAe,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IAItB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACJ,YAAY,EAAE,MAAM,CAAC;QACrB,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;CACnC;AAUD,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAUD,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/types/response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,WAAW,OAAO;IACpB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,GAAG;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,GAAG;IACxE,SAAS,EAAE,CAAC,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG;IACrC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,sBAAsB,GAAG,qBAAqB,CAAC;IACzD,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG;IAC7C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,mCAAmC;IAChD,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CACnC,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,OAAO,EACzD,2BAA2B,CAC9B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CACrD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,EACzD,2BAA2B,CAC9B,CAAC;AAEF,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,GAAG,cAAc,GAAG,WAAW,CAAC;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,kCAAkC;IAC/C,KAAK,EAAE,eAAe,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACJ,YAAY,EAAE,MAAM,CAAC;QACrB,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/tracing.d.ts

@@ -7,9 +7,21 @@ export interface TraceAttributesFilter {
 }
 export interface TraceOptions {
     turn_penalty_factor?: number;
+    /**
+     * Search radius in meters associated with supplied trace points.
+     */
     search_radius?: number[];
+    /**
+     * GPS accuracy in meters associated with supplied trace points.
+     */
     gps_accuracy?: number[];
+    /**
+     * Breaking distance in meters between trace points.
+     */
     breakage_distance?: number;
+    /**
+     * Interpolation distance in meters beyond which trace points are merged together.
+     */
     interpolation_distance?: number;
 }
 //# sourceMappingURL=tracing.d.ts.map

package/dist/types/tracing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../src/types/tracing.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAC5B,eAAe,GACf,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,GACd,oBAAoB,GACpB,mCAAmC,GACnC,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,CAAC;AAE1C,MAAM,MAAM,qBAAqB,GAC3B,sCAAsC,GACtC,mDAAmD,GACnD,iDAAiD,GACjD,qCAAqC,GACrC,oCAAoC,GACpC,oCAAoC,GACpC,4BAA4B,GAC5B,mCAAmC,GACnC,mCAAmC,GACnC,mBAAmB,GACnB,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,gBAAgB,CAAC;AAEvB,MAAM,MAAM,qBAAqB,GAC3B,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,UAAU,GACV,WAAW,GACX,cAAc,GACd,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,4BAA4B,GAC5B,qBAAqB,GACrB,cAAc,GACd,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,qBAAqB,GACrB,kBAAkB,GAClB,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,aAAa,GACb,qBAAqB,GACrB,uBAAuB,GACvB,yBAAyB,GACzB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAC;AAEzB,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,CACN,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,CAC3B,EAAE,CAAC;IACJ,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,YAAY;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAI7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAIzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAIxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAI3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC"}
+{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../src/types/tracing.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAC5B,eAAe,GACf,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,GACd,oBAAoB,GACpB,mCAAmC,GACnC,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,CAAC;AAE1C,MAAM,MAAM,qBAAqB,GAC3B,sCAAsC,GACtC,mDAAmD,GACnD,iDAAiD,GACjD,qCAAqC,GACrC,oCAAoC,GACpC,oCAAoC,GACpC,4BAA4B,GAC5B,mCAAmC,GACnC,mCAAmC,GACnC,mBAAmB,GACnB,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,gBAAgB,CAAC;AAEvB,MAAM,MAAM,qBAAqB,GAC3B,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,UAAU,GACV,WAAW,GACX,cAAc,GACd,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,4BAA4B,GAC5B,qBAAqB,GACrB,cAAc,GACd,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,qBAAqB,GACrB,kBAAkB,GAClB,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,aAAa,GACb,qBAAqB,GACrB,uBAAuB,GACvB,yBAAyB,GACzB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAC;AAEzB,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,CACN,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,CAC3B,EAAE,CAAC;IACJ,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,YAAY;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iwpnd/valhalla-ts",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A nodejs client and helper utilities for valhalla routing engine",
   "main": "dist/index.js",
   "files": [