minotor 3.0.1 → 4.0.0

package/.cspell.json

@@ -30,7 +30,18 @@
     "Klosters",
     "Engadin",
     "isochrone",
-    "Delling"
+    "Delling",
+    "Moléson",
+    "Bulle",
+    "Gruyères",
+    "gare",
+    "funi",
+    "Francey",
+    "téléphérique",
+    "Moritz",
+    "Haut",
+    "Rhin",
+    "Olten"
   ],
   "flagWords": [],
   "ignorePaths": [

package/.gitattributes

@@ -0,0 +1,3 @@
+src/__e2e__/timetable/stops.bin filter=lfs diff=lfs merge=lfs -text
+src/__e2e__/timetable/timetable.bin filter=lfs diff=lfs merge=lfs -text
+src/__e2e__/timetable/*.bin filter=lfs diff=lfs merge=lfs -text

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -2,3 +2,6 @@ Fixes # (issue)
 
 Please provide a concise description of your changes, and the motivation for making them.
 If relevant, include links to related issues or pull requests.
+
+- [ ] If the timetable or stops format changed, I re-generated `src/__e2e__/timetable/stops.bin` and `src/__e2e__/timetable/timetable.bin` based on the latest Swiss GTFS for the next Monday (and adjusted e2e tests results accordingly if needed).
+- [ ] I ran the performance tests and confirmed that no regression was introduced.

package/.github/workflows/minotor.yml

@@ -67,9 +67,25 @@ jobs:
       - name: ⚡ Tests
         run: npm run test:coverage
 
+  e2e:
+    name: 🏁 End-to-end tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+      - name: Checkout LFS objects
+        run: git lfs pull
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '21.1.0'
+      - uses: bahmutov/npm-install@v1
+      - name: 🏁 End-to-end tests
+        run: npm run e2e
+
   build-and-release:
     name: 🚀 Build & release
-    needs: [format, lint, audit, spell, type, test]
+    needs: [format, lint, audit, spell, type, test, e2e]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

package/CHANGELOG.md

@@ -1,6 +1,11 @@
-## [3.0.1](https://github.com/aubryio/minotor/compare/v3.0.0...v3.0.1) (2025-06-03)
+# [4.0.0](https://github.com/aubryio/minotor/compare/v3.0.2...v4.0.0) (2025-09-13)
 
 
-### Bug Fixes
+### Performance Improvements
 
-* do not pin point lib version for the repl ([#18](https://github.com/aubryio/minotor/issues/18)) ([2cef9e7](https://github.com/aubryio/minotor/commit/2cef9e7488f09743aba52e2ebb0ae52bead476c6))
+* encode boarding flags on 2 bits only ([b373d0c](https://github.com/aubryio/minotor/commit/b373d0c606ca6ead53e9138d5ca31d2928e2415b))
+
+
+### BREAKING CHANGES
+
+* Timetable format 0.0.4 introduced to use 2 bits instead of 8 for boarding flags.

package/README.md

@@ -61,8 +61,9 @@ const parser = new GtfsParser('gtfs-feed.zip', chGtfsProfile);
 const { timetable, stopsIndex } = await parser.parse(new Date());
 ```
 
-Note that this operation can take a few minutes for large GTFS feeds.
-See comments in the code for more options.
+Note that times are only represented at the minute level so they can fit on 16 bits.
+
+This operation can take a few minutes for large GTFS feeds.
 
 #### Stop Search (Browser or Node.js)
 
@@ -127,11 +128,21 @@ Query routes (`minotor> .route -h for more options`):
 
 ## Development
 
+### Requirements
+
+Make sure you have a working [node](https://nodejs.org) environment.
+
+`protoc` also needs to be available on the build system.
+
+Ubuntu: `sudo apt install -y protobuf-compiler` |
+Fedora: `sudo dnf install -y protobuf-compiler` |
+MacOS: `brew install protobuf`
+
 ### Debugging
 
 It is possible to plot the router graph to debug the algorithm:
 
-`minotor repl`
+Using the npm script `repl`, or `minotor repl` if the project is installed globally.
 
 `minotor> .plot from <stationId> to <stationId> at <HH:mm> [with <N> transfers] [to <graph.dot>]`
 
@@ -139,15 +150,20 @@ It is possible to plot the router graph to debug the algorithm:
 
 ### Build
 
-Make sure you have a working node setup as well as a protobuf compiler.
-
 - `build`: builds the project in the `dist/` directory
 - `clean`: removes the `dist/` directory
 
-### Tests
+### Unit Tests
+
+- `test`: runs unit tests
+- `test:coverage`: runs unit test runner with coverage reports
+
+### End-to-End Tests
 
-- `test`: runs test runner
-- `test:coverage`: runs test runner with coverage reports
+- `e2e`: runs end-to-end tests, using a real data from a day in the Swiss GTFS dataset
+- `perf`: runs a basic performance test, using a real data from a day in the Swiss GTFS dataset
+
+Note that performance tests are not included in the CI pipeline and must be run manually.
 
 ### Formatting & linting
 
@@ -163,15 +179,20 @@ Releases are automatically published to npm when merging to the `main` or `beta`
 
 ## Roadmap
 
-The project is under active development. Here are some of the features that are planned:
+The project is under active development. Here are some of the features that are planned (ordered by priority).
+Contact [the author](https://aubry.io/) for feature requests.
 
-- Load multiple GTFS archives at once
+- Route/Trip-based transfer support
+- Favor shorter trips with less transfers in case of tie
+- Arrive-by support
 - Range queries
 - Transfer preferences
+- Route/Trip metadata support
+- Routing filters based on metadata e.g. bicycle support, wheelchair access
+- More routing options (slower/faster transfers, etc.)
+- Improved stop search (sort by stop importance)
+- Real-time timetable support (tripId/routeId mapping)
 - Support for exporting a calendar range as opposed to a single day
 - Support for GTFS `frequencies.txt`
-- Support for more types of transfers
+- Load multiple GTFS archives at once
 - NeTEx support
-- Higher level timetable API for cleaner router code
-- RT-GTFS Support (adding tripId support)
-- More extensive testing

package/dist/__e2e__/router.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli/perf.d.ts

@@ -0,0 +1,28 @@
+import { Query, Router, StopsIndex } from '../router.js';
+type PerformanceResult = {
+    task: Query;
+    meanTimeMs: number;
+    meanMemoryMb: number;
+};
+/**
+ *
+ * @param filePath
+ * @returns
+ */
+export declare const loadQueriesFromJson: (filePath: string) => Query[];
+/**
+ *
+ * @param router
+ * @param stopsIndex
+ * @param tasks
+ * @param iterations
+ * @returns
+ */
+export declare const testRouterPerformance: (router: Router, stopsIndex: StopsIndex, tasks: Query[], iterations: number) => PerformanceResult[];
+/**
+ *
+ * @param results
+ * @returns
+ */
+export declare const prettyPrintPerformanceResults: (results: PerformanceResult[]) => void;
+export {};

package/dist/cli/utils.d.ts

@@ -1,3 +1,7 @@
-import { Result, Route } from '../router.js';
-export declare const prettyPrintRoute: (route: Route) => void;
+import { Result } from '../router.js';
+/**
+ * Plots the graph of the result to a dot file.
+ * @param result - The result object to plot.
+ * @param filePath - The path where the dot file will be saved.
+ */
 export declare const plotGraphToDotFile: (result: Result, filePath: string) => void;