@furkot/directions 2.1.0 → 2.1.2

package/lib/directions.js

@@ -1,5 +1,6 @@
 const travelMode = require('./model').travelMode;
 const { defaults: defaults, withTimeout } = require('./service/util');
+const prepareQuery = require('./profile');
 
 module.exports = furkotDirections;
 
@@ -86,7 +87,7 @@ function furkotDirections(options) {
    */
   function directions(query, { signal } = {}) {
     if (query?.points?.length > 1) {
-      return requestDirections(query, options.timeout);
+      return requestDirections(prepareQuery(query), options.timeout);
     }
 
     async function requestDirections(query, timeout) {

package/lib/profile/index.js

@@ -0,0 +1,15 @@
+const profiles = {
+  5: require('./rv')
+};
+
+module.exports = prepareQuery;
+
+/**
+ * Prepares query depending on the mode.
+ * @param {Object} query - The query object.
+ * @returns {Object} The prepared query.
+ */
+function prepareQuery(query) {
+  const { mode } = query;
+  return profiles[mode]?.(query) || query;
+}

package/lib/profile/rv/dimensions.js

@@ -0,0 +1,24 @@
+/**
+ * Default RV dimensions based on Valhalla defaults for truck:
+ * https://valhalla.github.io/valhalla/api/turn-by-turn/api-reference/#automobile-and-bus-costing-options
+ */
+const defaultRV = {
+  axle_load: 9.07,
+  hazmat: true,
+  height: 4.11,
+  length: 21.64,
+  weight: 21.77,
+  width: 2.6
+};
+
+const passengerCar = {
+  height: 3.8,
+  length: 8,
+  weight: 6,
+  width: 2.5
+};
+
+module.exports = {
+  defaultRV,
+  passengerCar
+};

package/lib/profile/rv/index.js

@@ -0,0 +1,72 @@
+const { passengerCar, defaultRV } = require("./dimensions");
+const passengerCarEntries = Object.entries(passengerCar);
+
+module.exports = prepareQuery;
+
+/**
+ * Treat RV as passenger car when it doesn't carry hazmat and all its dimensions
+ * that are present fall within the passenger car limits.
+ * @param {Object} vehicle - The vehicle object.
+ * @returns {boolean} Whether to treat RV as passenger car.
+ */
+function isPassengerCar(vehicle) {
+  return !vehicle.hazmat && passengerCarEntries.every(([k, v]) => vehicle[k] <= v);
+}
+
+/**
+ * Treat RV as non commercial truck when it doesn't carry hazmat and its
+ * weight and length are below truck limits.
+ * @param {Object} vehicle - The vehicle object.
+ * @returns {boolean} Whether to treat RV as non commercial truck.
+ */
+function isNonCommercialTruck(vehicle) {
+  return !vehicle.hazmat &&
+    vehicle.length < defaultRV.length &&
+    vehicle.weight < defaultRV.weight;
+}
+
+/**
+ * Prepares vehicle size for the query.
+ * @param {Object} query - The query object.
+ * @returns {Object} The prepared query with vehicle size.
+ */
+function prepareVehicle(vehicle) {
+  if (!vehicle) {
+    // treat as a standard truck
+    return {
+      vehicle: defaultRV
+    };
+  }
+  if (isPassengerCar(vehicle)) {
+    // treat as a regular passenger car
+    return {
+      mode: 0
+    };
+  }
+  vehicle = Object.assign({}, defaultRV, vehicle);
+  let proposedMode;
+  if (isNonCommercialTruck(vehicle)) {
+    // treat as a passenger car if at least height and width can be enforced
+    proposedMode = 0;
+  }
+  return {
+    proposedMode,
+    vehicle
+  };
+}
+
+/**
+ * Prepares query.
+ * @param {Object} query - The query object.
+ * @returns {Object} The prepared query.
+ */
+function prepareQuery(query) {
+  const {
+    mode: initialMode,
+    vehicle: initialVehicle
+  } = query;
+  return Object.assign({
+    initialMode,
+    initialVehicle
+  }, query, prepareVehicle(query.vehicle));
+}

package/lib/service/graphhopper/index.js

@@ -9,12 +9,11 @@ const util = require('../util');
 module.exports = init;
 
 const vehicle = {
-  '-1': 'car',
-  0: 'car',
   1: 'bike',
   2: 'foot',
   5: 'truck'
 };
+const defaultVehicle = 'car';
 
 const weighting = {
   true: 'curvature',
@@ -130,9 +129,14 @@ function getStatus(st, response) {
   }
 }
 
+function vehicleType(query) {
+  const { mode, proposedMode } = query;
+  return vehicle[proposedMode ?? mode] || defaultVehicle;
+}
+
 function vehicleSize(query, options) {
-  const { mode, vehicle } = query;
-  if (!(vehicle && mode === travelMode.rv)) {
+  const { initialMode, mode, vehicle } = query;
+  if (!(vehicle && (initialMode ?? mode) === travelMode.rv)) {
     return;
   }
   const { hazmat } = vehicle;
@@ -142,7 +146,7 @@ function vehicleSize(query, options) {
       multiply_by: '0.0'
     });
   }
-  ['height', 'width', 'length', 'weight', 'axle_load'].forEach(p => {
+  ['height', 'width', 'length', 'weight'].forEach(p => {
     if (vehicle[p]) {
       options.push({
         if: `max_${p} < ${vehicle[p]}`,
@@ -165,7 +169,7 @@ function init(options) {
       return;
     }
     let req = {
-      vehicle: vehicle[mode] || vehicle[0],
+      vehicle: vehicleType(query),
       points,
       details: ['road_environment', 'toll']
     };

package/lib/service/openroute/index.js

@@ -205,6 +205,9 @@ function init(options) {
           restrictions
         }
       };
+      if (query.mode === travelMode.rv) {
+        req.options.vehicle_type = 'hgv';
+      }
     }
     const param = { query, req };
     if ((profile[query.mode] || profile[0]) === 'driving-car') {

package/lib/service/valhalla/index.js

@@ -166,9 +166,14 @@ function getStatus(err, response) {
   }
 }
 
+function costingType(query) {
+  const { mode, proposedMode } = query;
+  return costing[proposedMode ?? mode] || defaultCosting;
+}
+
 function vehicleSize(query, options) {
-  const { mode, vehicle } = query;
-  if (!(vehicle && mode === travelMode.rv)) {
+  const { initialMode, mode, vehicle } = query;
+  if (!(vehicle && (initialMode ?? mode) === travelMode.rv)) {
     return;
   }
   Object.assign(options, vehicle);
@@ -179,7 +184,7 @@ function init(options) {
   function prepareRequest(query) {
     let req = {
       locations: query.points.map(prepareWaypoint),
-      costing: costing[query.mode] || defaultCosting,
+      costing: costingType(query),
       costing_options: {},
       directions_options: {
         units: units[query.units] || units.m
@@ -262,3 +267,4 @@ function init(options) {
   });
   return require('..')(options);
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furkot/directions",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Directions service for Furkot",
   "author": {
     "name": "Damian Krzeminski",