Merge branch 'feature/docs' of https://github.com/openplannerteam/pla…

…nner.js into feature/docs

README.md

@@ -1,10 +1,10 @@
 # Planner.js: A JS library for route planning
 
-🛸 [![Build Status](https://travis-ci.org/openplannerteam/planner.js.svg?branch=dev)](https://travis-ci.org/openplannerteam/planner.js) 🚴‍♂️ [![MIT License](https://img.shields.io/github/license/openplannerteam/planner.js.svg?maxAge=2592000)](https://github.com/openplannerteam/planner.js/blob/master/LICENSE) 🚉
+🛸️ [![Build Status](https://travis-ci.org/openplannerteam/planner.js.svg?branch=dev)](https://travis-ci.org/openplannerteam/planner.js) 🚴 [![MIT License](https://img.shields.io/github/license/openplannerteam/planner.js.svg?maxAge=2592000)](https://github.com/openplannerteam/planner.js/blob/master/LICENSE) 🚉  [![npm version](https://badge.fury.io/js/plannerjs.svg)](https://badge.fury.io/js/plannerjs) 🚀
 
-Current status: _to be launched in February_ 🚀
-
-For now: clone the repository, run `npm install` and `npm build`. Afterwards you can use it as follows:
+```
+$ npm install plannerjs
+```
 
 Include it in the browser:
 ```html
@@ -13,21 +13,35 @@ Include it in the browser:
 
 Include it in your JavaScript project:
 ```javascript
-// Not yet published on NPM...
 const Planner = require('plannerjs').default;
+
+// or
+
+import Planner              from 'plannerjs';
 ```
 
 Use it in both environments:
 ```javascript
 const planner = new Planner();
+
 planner.query({
-  publicTransportOnly: true,
   from: "http://irail.be/stations/NMBS/008812005", // Brussels North
   to: "http://irail.be/stations/NMBS/008892007", // Ghent-Sint-Pieters
-  minimumDepartureTime: new Date(),
-  maximumWalkingDistance: 200, // 200 meters
-  maximumTransferDuration: 30 * 60 * 1000, // 30 minutes
-  minimumWalkingSpeed: 3 // 3 km/h
+  minimumDepartureTime: new Date("Mon Feb 11 2019 16:00:00"),
+  maximumArrivalTime: new Date("Mon Feb 11 2019 19:00:00"),
+  publicTransportOnly: true,
+
+  walkingSpeed: 3, // KmH
+  minimumWalkingSpeed: 3, // KmH
+
+  maximumWalkingDistance: 200, // meters
+
+  minimumTransferDuration: Planner.Units.fromMinutes(1),
+  maximumTransferDuration: Planner.Units.fromMinutes(30),
+
+  maximumTravelDuration: Planner.Units.fromHours(1.5),
+
+  maximumTransfers: 4,
 })
   .take(3)
   .on('data', (path) => {
@@ -37,7 +51,7 @@ planner.query({
     console.log('No more paths!')
   })
   .on('error', (error) => {
-    console.log(error);
+    console.error(error);
   });
 ```
 
@@ -50,3 +64,4 @@ For further instructions, follow the documentation at https://openplannerteam.gi
  * Building the docs with typedoc: `npm run doc`
  * Testing with jest: `npm test`
  * Build a new browser version with `npm run browser`
+ * Bundle the latest planner for the docs example `npm run doc-bundle`

docs/css/style.css

@@ -96,10 +96,12 @@ body {
     position: absolute;
     top: 10px;
     left: 54px;
+    max-width: calc(100% - 225px);
     z-index: 500;
 }
 
 .prefetch-view {
+    width: 0px;
     height: 6px;
     margin-bottom: 3px;
     border-radius: 30px;
@@ -117,5 +119,7 @@ body {
 }
 
 #prefetch-bar {
-    height: 18px;
+    height: 17px;
+    max-width: 100%;
+    overflow: hidden;
 }

docs/js/example.js

@@ -22,6 +22,7 @@ const resetButton = document.querySelector("#reset");
 const results = document.querySelector("#results");
 const prefetchWrapper = document.querySelector("#prefetch");
 const prefetchBar = document.querySelector("#prefetch-bar");
+let prefetchBarWidth = 0;
 
 let lines = [];
 let polyLines = [];
@@ -64,7 +65,7 @@ const removePrefetchView = () => {
   }
 };
 
-resetButton.onclick = e => {
+resetButton.onclick = (e) => {
   removeLines();
   removeResultObjects();
   query = [];
@@ -118,7 +119,7 @@ planner
       minimumDepartureTime,
       maximumArrivalTime,
       maximumArrivalTime - minimumDepartureTime,
-      maximumTravelDuration,
+      maximumTravelDuration
     );
 
     removeLines();
@@ -181,8 +182,15 @@ planner
     } else {
       const width = getPrefetchViewWidth(firstPrefetch, departureTime);
 
+      prefetchBarWidth = width + 10;
+
+      const prefetch = document.getElementById("prefetch");
+      prefetch.style.width = `${prefetchBarWidth}px`;
+
       prefetchBar.style.width = `${width}px`;
       prefetchBar.setAttribute("data-last", departureTime.toLocaleTimeString());
+
+      drawPrefetchViews();
     }
   })
   .on("connection-iterator-view", (lowerBound, upperBound, completed) => {
@@ -197,7 +205,7 @@ planner
       const prefetchView = document.createElement("div");
       prefetchView.className = "prefetch-view";
       prefetchView.style.marginLeft = `${offset}px`;
-      prefetchView.style.width = `${width}px`;
+      prefetchView.style.width = `${width * 100 / prefetchBarWidth}%`;
       prefetchView.style.backgroundColor = "red";
 
       prefetchWrapper.appendChild(prefetchView);
@@ -208,17 +216,28 @@ planner
         .find((view) => view.lowerBound === lowerBound && view.upperBound === upperBound);
 
       if (!elem) {
-        console.warn("Wut");
         return;
       }
 
+      drawPrefetchViews();
+
       elem.style.backgroundColor = "limegreen";
     }
   })
   .on("warning", (warning) => {
     console.warn(warning);
   });
 
+function drawPrefetchViews() {
+  for (const prefetchView of prefetchViews) {
+    const viewWidth = getPrefetchViewWidth(prefetchView.lowerBound, prefetchView.upperBound);
+    const offset = getPrefetchViewWidth(firstPrefetch, prefetchView.lowerBound);
+
+    prefetchView.elem.style.width = `${viewWidth * 100 / prefetchBarWidth}%`;
+    prefetchView.elem.style.marginLeft = `${offset}px`;
+  }
+}
+
 function onMapClick(e) {
   selectRoute(e);
 }
@@ -449,7 +468,7 @@ function runQuery(query) {
       to: query[1],
       minimumDepartureTime: new Date(),
       maximumWalkingDistance,
-      maximumTransferDuration: 30 * 60 * 1000, // 30 minutes
+      maximumTransferDuration: Planner.Units.fromMinutes(30), // 30 minutes
       minimumWalkingSpeed: 3
     })
     .take(amount)

src/Defaults.ts

@@ -6,8 +6,8 @@ import Units from "./util/Units";
 export default class Defaults {
   public static readonly defaultMinimumWalkingSpeed = 3;
   public static readonly defaultMaximumWalkingSpeed = 6;
-  public static readonly defaultWalkingDuration = Units.fromSeconds(10 * 60);
-  public static readonly defaultMinimumTransferDuration = Units.fromSeconds(60);
-  public static readonly defaultMaximumTransferDuration = Units.fromHours(.4);
+  public static readonly defaultWalkingDuration = Units.fromMinutes(10);
+  public static readonly defaultMinimumTransferDuration = Units.fromMinutes(1);
+  public static readonly defaultMaximumTransferDuration = Units.fromMinutes(25);
   public static readonly defaultMaximumTransfers = 4;
 }

src/Planner.ts

@@ -12,12 +12,15 @@ import IQuery from "./interfaces/IQuery";
 import defaultContainer from "./inversify.config";
 import IQueryRunner from "./query-runner/IQueryRunner";
 import TYPES from "./types";
+import Units from "./util/Units";
 
 /**
  * Allows to ask route planning queries. Emits events defined in [[EventType]]
  */
 // @ts-ignore
 export default class Planner implements EventEmitter {
+  public static Units = Units;
+
   private context: Context;
   private queryRunner: IQueryRunner;
 

src/demo.ts

@@ -76,7 +76,7 @@ export default async (logResults) => {
         from: "Ingelmunster", // Ingelmunster
         to: "http://irail.be/stations/NMBS/008892007", // Ghent-Sint-Pieters
         minimumDepartureTime: new Date(),
-        maximumTransferDuration: Units.fromHours(0.5),
+        maximumTransferDuration: Units.fromMinutes(30),
       })
         .take(amount)
         .on("error", (error) => {

src/fetcher/connections/prefetch/ConnectionsStore.ts

@@ -21,7 +21,7 @@ import IExpandingForwardView from "./IExpandingForwardView";
  */
 export default class ConnectionsStore {
 
-  private static REPORTING_THRESHOLD = Units.fromHours(.1);
+  private static REPORTING_THRESHOLD = Units.fromMinutes(6);
 
   private readonly context: Context;
   private readonly store: IConnection[];

src/planner/stops/ReachableStopsFinderBirdsEye.test.ts

@@ -32,7 +32,7 @@ test("[ReachableStopsFinderBirdsEye] reachable stops", async () => {
   const reachableStops = await reachableStopsFinder.findReachableStops(
     sourceStop,
     ReachableStopsFinderMode.Source,
-    Units.fromHours(0.25),
+    Units.fromMinutes(15),
     4,
   );
 

src/query-runner/earliest-arrival-first/QueryRunnerEarliestArrivalFirst.test.ts

@@ -22,7 +22,7 @@ describe("[QueryRunnerExponential]", () => {
     from: "http://irail.be/stations/NMBS/008896925", // Ingelmunster
     to: "http://irail.be/stations/NMBS/008892007", // Ghent-Sint-Pieters
     minimumDepartureTime: new Date(),
-    maximumTransferDuration: Units.fromHours(.5),
+    maximumTransferDuration: Units.fromHours(30),
   };
 
   const createEarliestArrivalQueryRunner = () => {

src/query-runner/exponential/QueryRunnerExponential.test.ts

@@ -23,7 +23,7 @@ describe("[QueryRunnerExponential]", () => {
     from: "http://irail.be/stations/NMBS/008896925", // Ingelmunster
     to: "http://irail.be/stations/NMBS/008892007", // Ghent-Sint-Pieters
     minimumDepartureTime: new Date(),
-    maximumTransferDuration: Units.fromHours(.5),
+    maximumTransferDuration: Units.fromMinutes(30),
   };
 
   const createExponentialQueryRunner = () => {

src/util/Units.ts

@@ -22,6 +22,10 @@ export default class Units {
     return hours * 3600000;
   }
 
+  public static fromMinutes(minutes: number): DurationMs {
+    return minutes * 60000;
+  }
+
   public static fromSeconds(seconds: number): DurationMs {
     return seconds * 1000;
   }