@furkot/directions 2.1.4 → 3.0.0

package/Readme.md

@@ -15,7 +15,7 @@ $ npm install --save furkot-directions
 ## Usage
 
 ```js
-var furkotDirections = require('furkot-directions');
+import furkotDirections from 'furkot-directions';
 
 furkotDirections('Rainbow');
 ```

package/lib/directions.js

@@ -1,8 +1,11 @@
-const travelMode = require('./model').travelMode;
-const { defaults, withTimeout } = require('./service/util');
-const prepareQuery = require('./profile');
-
-module.exports = furkotDirections;
+import { travelMode } from './model.js';
+import prepareQuery from './profile/index.js';
+import graphhopper from './service/graphhopper/index.js';
+import mapquest from './service/mapquest/index.js';
+import openroute from './service/openroute/index.js';
+import osrm from './service/osrm/index.js';
+import { defaults, withTimeout } from './service/util.js';
+import valhalla from './service/valhalla/index.js';
 
 function skip(options, query) {
   // if service is disabled
@@ -14,23 +17,23 @@ function skip(options, query) {
 // it should be skipped or applied to a given request
 const services = {
   graphhopper: {
-    service: require('./service/graphhopper'),
+    service: graphhopper,
     skip
   },
   mapquest: {
-    service: require('./service/mapquest'),
+    service: mapquest,
     skip
   },
   openroute: {
-    service: require('./service/openroute'),
+    service: openroute,
     skip
   },
   valhalla: {
-    service: require('./service/valhalla'),
+    service: valhalla,
     skip
   },
   osrm: {
-    service: require('./service/osrm'),
+    service: osrm,
     skip(options, query) {
       // or asking for walking or biking directions (OSRM doesn't do it well)
       return skip(options, query) || (query.mode !== travelMode.car && query.mode !== travelMode.motorcycle);
@@ -41,7 +44,7 @@ const services = {
 // default timeout to complete operation
 const defaultTimeout = 20 * 1000;
 
-function furkotDirections(options) {
+export default function furkotDirections(options) {
   options = {
     timeout: defaultTimeout,
     order: ['osrm', 'mapquest', 'valhalla', 'graphhopper', 'openroute'],

package/lib/model.js

@@ -1,5 +1,5 @@
 // path simplification constants
-const pathType = {
+export const pathType = {
   none: 'none', // don't include the path in route (default)
   coarse: 'coarse', // include heavily simplified path
   smooth: 'smooth', // include path that is somewhat simplified
@@ -7,7 +7,7 @@ const pathType = {
 };
 
 // travel mode constants
-const travelMode = {
+export const travelMode = {
   motorcycle: -1,
   car: 0,
   bicycle: 1,
@@ -17,7 +17,7 @@ const travelMode = {
 };
 
 // template for directions query object
-const directionsQuery = {
+export const directionsQuery = {
   mode: travelMode.car, // numeric value of travel mode
   avoidHighways: false, // true to avoid highways
   avoidTolls: false, // true to avoid toll roads
@@ -33,7 +33,7 @@ const directionsQuery = {
 };
 
 // template for directions results object
-const directionsResult = {
+export const directionsResult = {
   query: directionsQuery, // query parameters
   places: [], // addresses or place names corresponding to points (if directions service performs reverse geocoding)
   name: '', // human-readable name of directions (if available)
@@ -59,10 +59,3 @@ const directionsResult = {
   stats: [], // list of providers that requests have been sent to to obtain directions
   provider: '' // identifies service providing the directions
 };
-
-module.exports = {
-  directionsQuery,
-  directionsResult,
-  pathType,
-  travelMode
-};

package/lib/profile/index.js

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

package/lib/profile/rv/dimensions.js

@@ -2,7 +2,7 @@
  * 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 = {
+export const defaultRV = {
   axle_load: 9.07,
   hazmat: true,
   height: 4.11,
@@ -11,14 +11,9 @@ const defaultRV = {
   width: 2.6
 };
 
-const passengerCar = {
+export const passengerCar = {
   height: 3.8,
   length: 8,
   weight: 6,
   width: 2.5
 };
-
-module.exports = {
-  defaultRV,
-  passengerCar
-};

package/lib/profile/rv/index.js

@@ -1,7 +1,6 @@
-const { passengerCar, defaultRV } = require('./dimensions');
-const passengerCarEntries = Object.entries(passengerCar);
+import { defaultRV, passengerCar } from './dimensions.js';
 
-module.exports = prepareQuery;
+const passengerCarEntries = Object.entries(passengerCar);
 
 /**
  * Treat RV as passenger car when it doesn't carry hazmat and all its dimensions
@@ -58,7 +57,7 @@ function prepareVehicle(vehicle) {
  * @param {Object} query - The query object.
  * @returns {Object} The prepared query.
  */
-function prepareQuery(query) {
+export default function prepareQuery(query) {
   const { mode: initialMode, vehicle: initialVehicle } = query;
   return Object.assign(
     {

package/lib/service/graphhopper/index.js

@@ -1,12 +1,11 @@
 // https://docs.graphhopper.com/#tag/Routing-API
 // https://github.com/boldtrn/kurviger-api-documentation
 
-const { pathType, travelMode } = require('../../model');
-const status = require('../status');
-const tagRoute = require('../tag-route');
-const util = require('../util');
-
-module.exports = init;
+import { pathType, travelMode } from '../../model.js';
+import initService from '../index.js';
+import * as status from '../status.js';
+import tagRoute from '../tag-route.js';
+import * as util from '../util.js';
 
 const vehicle = {
   1: 'bike',
@@ -162,7 +161,7 @@ function vehicleSize(query, options) {
   });
 }
 
-function init(options) {
+export default function init(options) {
   function prepareUrl(url) {
     return `${url}?key=${options.graphhopper_key}`;
   }
@@ -273,5 +272,5 @@ function init(options) {
     processResponse
   });
   options.parameters = options.graphhopper_parameters || {};
-  return require('..')(options);
+  return initService(options);
 }

package/lib/service/index.js

@@ -1,17 +1,17 @@
-const fetchagent = require('fetchagent');
-const { pathType } = require('../model');
-const makeLimiter = require('limiter-component');
-const status = require('./status');
-const makeSimplify = require('./simplify');
-const debug = require('debug')('furkot:directions:service');
+import Debug from 'debug';
+import fetchagent from 'fetchagent';
+import makeLimiter from 'limiter-component';
+import { pathType } from '../model.js';
+import makeSimplify from './simplify.js';
+import * as status from './status.js';
 
-module.exports = init;
+const debug = Debug('furkot:directions:service');
 
 const limiters = {};
 
 const ERROR = 'input error';
 
-function init(options) {
+export default function init(options) {
   options = {
     interval: 340,
     penaltyInterval: 2000,

package/lib/service/mapquest/index.js

@@ -1,8 +1,7 @@
-const { pathType } = require('../../model');
-const status = require('../status');
-const util = require('../util');
-
-module.exports = init;
+import { pathType } from '../../model.js';
+import initService from '../index.js';
+import * as status from '../status.js';
+import * as util from '../util.js';
 
 const units = {
   km: 'k',
@@ -102,17 +101,17 @@ function getStatus(_err, response) {
   }
 }
 
-function init(options) {
+export default function init(options) {
   function getProvider(query) {
     if (query.alternate) {
       return options.name;
     }
-    return 'open' + options.name;
+    return `open${options.name}`;
   }
 
   function getUrl(query) {
     return (
-      options[getProvider(query) + '_url'] +
+      options[`${getProvider(query)}_url`] +
       '/directions/v2/' +
       (query.alternate && query.points.length <= 2 ? 'alternateroutes' : 'route')
     );
@@ -205,5 +204,5 @@ function init(options) {
     prepareRequest,
     processResponse
   });
-  return require('..')(options);
+  return initService(options);
 }

package/lib/service/openroute/index.js

@@ -1,12 +1,11 @@
 // https://openrouteservice.org/dev/#/api-docs/directions
 
-const LatLon = require('geodesy/latlon-spherical');
-const { pathType, travelMode } = require('../../model');
-const status = require('../status');
-const tagRoute = require('../tag-route');
-const util = require('../util');
-
-module.exports = init;
+import LatLon from 'geodesy/latlon-spherical.js';
+import { pathType, travelMode } from '../../model.js';
+import initService from '../index.js';
+import * as status from '../status.js';
+import tagRoute from '../tag-route.js';
+import * as util from '../util.js';
 
 const profile = {
   '-1': 'driving-car',
@@ -183,7 +182,7 @@ function vehicleSize(query, restrictions) {
   return restrictions;
 }
 
-function init(options) {
+export default function init(options) {
   function prepareUrl(query) {
     return [options.openroute_url, profile[query.mode] || profile[0], 'json'].join('/');
   }
@@ -272,5 +271,5 @@ function init(options) {
     prepareRequest,
     processResponse
   });
-  return require('..')(options);
+  return initService(options);
 }

package/lib/service/osrm/index.js

@@ -1,6 +1,7 @@
-const { pathType } = require('../../model');
-const status = require('../status');
-const util = require('../util');
+import { pathType } from '../../model.js';
+import initService from '../index.js';
+import * as status from '../status.js';
+import * as util from '../util.js';
 
 const code2status = {
   Ok: status.success,
@@ -9,8 +10,6 @@ const code2status = {
 };
 const RADIUS = 1000; // search radius for nearby roads
 
-module.exports = init;
-
 function convertPlace(wpt) {
   return wpt.name;
 }
@@ -20,7 +19,7 @@ function convertStep(step) {
     duration: step.duration,
     distance: step.distance,
     path: util.decode(step.geometry),
-    instructions: step.maneuver.type + ' ' + step.maneuver.modifier
+    instructions: `${step.maneuver.type} ${step.maneuver.modifier}`
   };
 }
 
@@ -76,7 +75,7 @@ const profile = {
 
 function prepareUrl(baseUrl, query) {
   function coords2string(c) {
-    return c[0].toFixed(5) + ',' + c[1].toFixed(5);
+    return `${c[0].toFixed(5)},${c[1].toFixed(5)}`;
   }
 
   const path = query.points.map(coords2string).join(';');
@@ -84,7 +83,7 @@ function prepareUrl(baseUrl, query) {
   return [baseUrl, 'route/v1', profile[query.mode], path].join('/');
 }
 
-function init(options) {
+export default function init(options) {
   function processResponse(response, query) {
     const directions = {
       query,
@@ -130,5 +129,5 @@ function init(options) {
     prepareRequest,
     processResponse
   });
-  return require('..')(options);
+  return initService(options);
 }

package/lib/service/partition.js

@@ -1,6 +1,4 @@
-const util = require('./util');
-
-module.exports = partition;
+import * as util from './util.js';
 
 function distanceSquare(p1, p2) {
   return (p1[0] - p2[0]) ** 2 + (p1[1] - p2[1]) ** 2;
@@ -71,7 +69,7 @@ function cut(prev, next) {
 }
 
 // divide path into routes
-function partition(path, routes, segments) {
+export default function partition(path, routes, segments) {
   path.segments = segments;
   routes[0].path = path;
   routes.reduce(cut);

package/lib/service/simplify.js

@@ -1,10 +1,8 @@
-const { pathType } = require('../model');
-const { default: simplifyPolyline } = require('vis-why');
-const util = require('./util');
+import simplifyPolyline from 'vis-why';
+import { pathType } from '../model.js';
+import * as util from './util.js';
 
-module.exports = init;
-
-function init(options = {}) {
+export default function init(options = {}) {
   const algorithm = options.algorithm || simplifyPolyline;
   const endPoints = options.endPoints || 25; // how many points keep at ends
   const maxPoints = options.pathPoints || 100; // maximum number of points kept per path

package/lib/service/status.js

@@ -1,6 +1,4 @@
-module.exports = {
-  success: 'success', // success
-  failure: 'failure', // ultimate failure
-  error: 'error', // temporary error
-  empty: 'empty' // no result
-};
+export const success = 'success'; // success
+export const failure = 'failure'; // ultimate failure
+export const error = 'error'; // temporary error
+export const empty = 'empty'; // no result

package/lib/service/tag-route.js

@@ -1,5 +1,3 @@
-module.exports = tagRoute;
-
 function splitSegment(result, length) {
   const { segments, seg } = result;
   const { distance, duration, path } = segments[seg];
@@ -48,7 +46,7 @@ function extractRouteType(result, [from, to, type]) {
   return result;
 }
 
-function tagRoute(tagSegments, params) {
+export default function tagRoute(tagSegments, params) {
   params.seg = params.running = 0;
   return tagSegments?.reduce(extractRouteType, params);
 }

package/lib/service/util.js

@@ -1,35 +1,21 @@
-const LatLon = require('geodesy/latlon-spherical');
-const polyline = require('@pirxpilot/google-polyline');
-
-module.exports = {
-  concat,
-  decode,
-  defaults,
-  distance,
-  indexAt,
-  isFuture,
-  join,
-  last,
-  metersInKm: 1000,
-  metersInMile: 1609.34,
-  split2object,
-  collateResults,
-  withTimeout,
-  timeout
-};
-
-function concat(result, path) {
+import * as polyline from '@pirxpilot/google-polyline';
+import LatLon from 'geodesy/latlon-spherical.js';
+
+export const metersInKm = 1000;
+export const metersInMile = 1609.34;
+
+export function concat(result, path) {
   if (path) {
     Array.prototype.push.apply(result, path);
   }
   return result;
 }
 
-function decode(poly, factor) {
+export function decode(poly, factor) {
   return poly && polyline.decode(poly, factor);
 }
 
-function defaults(obj, source) {
+export function defaults(obj, source) {
   return Object.assign({}, source, obj);
 }
 
@@ -37,11 +23,11 @@ function toLatLon(p) {
   return new LatLon(p[1], p[0]);
 }
 
-function distance(p1, p2) {
+export function distance(p1, p2) {
   return toLatLon(p1).distanceTo(toLatLon(p2));
 }
 
-function indexAt(path, distance) {
+export function indexAt(path, distance) {
   let index = 1;
   let p1 = toLatLon(path[0]);
   let d = 0;
@@ -57,29 +43,29 @@ function indexAt(path, distance) {
   return index;
 }
 
-function isFuture(time) {
+export function isFuture(time) {
   time = time && Date.parse(time);
   return time && time >= Date.now();
 }
 
 // like normal join but with optional filter fn
-function join(arr, conn, fn) {
+export function join(arr, conn, fn) {
   fn = fn || (it => it);
   return arr.filter(fn).join(conn);
 }
 
-function last(arr) {
+export function last(arr) {
   return arr[arr.length - 1];
 }
 
-function split2object(str, conn, obj) {
+export function split2object(str, conn, obj) {
   return str.split(conn || '-').reduce((result, word) => {
     result[word] = word;
     return result;
   }, obj || {});
 }
 
-function collateResults(results, query) {
+export function collateResults(results, query) {
   return results.reduce(
     (result, r) => {
       concatArrayProp(result, r, 'segments');
@@ -107,7 +93,7 @@ function collateResults(results, query) {
   }
 }
 
-function withTimeout(promise, millis, signal) {
+export function withTimeout(promise, millis, signal) {
   let id;
   let resolve;
   let reject;
@@ -129,6 +115,6 @@ function withTimeout(promise, millis, signal) {
   }
 }
 
-function timeout(millis = 0) {
+export function timeout(millis = 0) {
   return new Promise(resolve => setTimeout(resolve, millis));
 }

package/lib/service/valhalla/index.js

@@ -1,11 +1,10 @@
 // https://github.com/valhalla/valhalla-docs
 
-const LatLon = require('geodesy/latlon-spherical');
-const { pathType, travelMode } = require('../../model');
-const status = require('../status');
-const util = require('../util');
-
-module.exports = init;
+import LatLon from 'geodesy/latlon-spherical.js';
+import { pathType, travelMode } from '../../model.js';
+import initService from '../index.js';
+import * as status from '../status.js';
+import * as util from '../util.js';
 
 const units = {
   km: 'kilometers',
@@ -180,7 +179,7 @@ function vehicleSize(query, options) {
   Object.assign(options, vehicle);
 }
 
-function init(options) {
+export default function init(options) {
   function prepareRequest(query) {
     let req = {
       locations: query.points.map(prepareWaypoint),
@@ -265,5 +264,5 @@ function init(options) {
     prepareRequest,
     processResponse
   });
-  return require('..')(options);
+  return initService(options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furkot/directions",
-  "version": "2.1.4",
+  "version": "3.0.0",
   "description": "Directions service for Furkot",
   "author": {
     "name": "Damian Krzeminski",
@@ -17,22 +17,23 @@
     "furkot",
     "directions"
   ],
+  "type": "module",
+  "exports": "./lib/directions.js",
   "dependencies": {
-    "@pirxpilot/google-polyline": "^3.0.0",
-    "debug": "~2 || ~3 || ~4",
-    "fetchagent": "~2.1.0",
-    "geodesy": "^1.1.1",
-    "limiter-component": "^1.2.0",
+    "@pirxpilot/google-polyline": "~4",
+    "debug": "~4",
+    "fetchagent": "~3",
+    "geodesy": "~2",
+    "limiter-component": "~2",
     "vis-why": "~2"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.9.4"
+    "@biomejs/biome": "^2.3.13"
   },
   "scripts": {
     "test": "make check"
   },
   "files": [
-    "index.js",
     "lib"
   ]
 }

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./lib/directions');