minotor 10.1.0 → 11.1.0

package/.cspell.json

@@ -47,6 +47,7 @@
     "Métro",
     "Minotor",
     "minotor",
+    "Mmin",
     "Moléson",
     "moleson",
     "Montjuïc",

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-# [10.1.0](https://github.com/aubryio/minotor/compare/v10.0.1...v10.1.0) (2026-01-26)
+# [11.1.0](https://github.com/aubryio/minotor/compare/v11.0.0...v11.1.0) (2026-04-15)
 
 
 ### Features
 
-* improved extended gtfs support ([#60](https://github.com/aubryio/minotor/issues/60)) ([5fe7d6f](https://github.com/aubryio/minotor/commit/5fe7d6f91cff2aa98b8304d11ba18ea77bdd5444))
+* basic GTFS frequency.txt support (scheduled only) ([#63](https://github.com/aubryio/minotor/issues/63)) ([05cf559](https://github.com/aubryio/minotor/commit/05cf559cd34ba336dae7f35e9eb7901ae23ea7b4)), closes [#50](https://github.com/aubryio/minotor/issues/50)

package/README.md

@@ -84,14 +84,14 @@ Or by location:
 #### Routing (Browser or Node.js)
 
 ```
-import { Query, Router, Time } from 'minotor';
+import { Query, Router } from 'minotor';
 
 const router = new Router(timetable, stopsIndex);
 
 const query = new Query.Builder()
   .from('Parent8504100')
   .to('Parent8504748')
-  .departureTime(Time.fromHMS(8,0,0))
+  .departureTime(8*60)
   .maxTransfers(5)
   .build();
 const result = router.route(query);

package/dist/cli/perf.d.ts

@@ -1,28 +1,66 @@
 import { Query, Router, StopsIndex } from '../router.js';
 type PerformanceResult = {
     task: Query;
-    meanTimeMs: number;
+    meanTimeUs: number;
     meanMemoryMb: number;
 };
 /**
+ * Loads a list of routing queries from a JSON file and resolves the
+ * human-readable stop IDs to the internal numeric IDs used by the router.
  *
- * @param filePath
- * @returns
+ * The file must contain a JSON array whose elements each have the shape:
+ * ```json
+ * { "from": "STOP_A", "to": ["STOP_B", "STOP_C"], "departureTime": "08:30:00" }
+ * ```
+ * An optional `maxTransfers` integer field is also supported.
+ *
+ * @param filePath - Path to the JSON file containing the serialized queries.
+ * @param stopsIndex - The stops index used to resolve source stop IDs to the
+ *   internal numeric IDs expected by the router.
+ * @returns An array of fully constructed {@link Query} objects ready to be
+ *   passed to {@link Router.route}.
+ * @throws If the file cannot be read, the JSON is malformed, or any stop ID
+ *   referenced in the file cannot be found in the stops index.
  */
-export declare const loadQueriesFromJson: (filePath: string) => Query[];
+export declare const loadQueriesFromJson: (filePath: string, stopsIndex: StopsIndex) => Query[];
 /**
+ * Benchmarks {@link Router.route} across a set of queries.
  *
- * @param router
- * @param stopsIndex
- * @param tasks
- * @param iterations
- * @returns
+ * @param router - The router instance to benchmark.
+ * @param tasks - The list of queries to run. One {@link PerformanceResult} is
+ *   produced per query.
+ * @param iterations - Number of times each query is repeated. Higher values
+ *   yield a more stable mean at the cost of longer wall-clock time.
+ * @returns An array of {@link PerformanceResult} objects, one per query, each
+ *   containing the mean wall-clock time (µs) and mean heap delta (MB).
  */
-export declare const testRouterPerformance: (router: Router, stopsIndex: StopsIndex, tasks: Query[], iterations: number) => PerformanceResult[];
+export declare const testRouterPerformance: (router: Router, tasks: Query[], iterations: number) => PerformanceResult[];
 /**
+ * Benchmarks {@link Result.bestRoute} — the path-reconstruction phase —
+ * independently of the routing phase.
+ *
+ * @param router - The router instance used to produce the routing results that
+ *   are then fed into `bestRoute`.
+ * @param tasks - The list of queries to benchmark. One {@link PerformanceResult}
+ *   is produced per query.
+ * @param iterations - Number of times `bestRoute` is called per query.
+ * @returns An array of {@link PerformanceResult} objects, one per query, each
+ *   containing the mean wall-clock time (µs) and mean heap delta (MB) for the
+ *   `bestRoute` call alone.
+ */
+export declare const testBestRoutePerformance: (router: Router, tasks: Query[], iterations: number) => PerformanceResult[];
+/**
+ * Prints a human-readable summary of performance results to stdout.
+ *
+ * Displays an overall mean across all tasks followed by a per-task breakdown.
+ * An optional {@link label} is printed as a section header so that results
+ * from different benchmark phases (e.g. routing vs. reconstruction) can be
+ * told apart when several calls appear in the same run.
  *
- * @param results
- * @returns
+ * @param results - The performance results to display, as returned by
+ *   {@link testRouterPerformance} or {@link testBestRoutePerformance}.
+ * @param label - Optional heading printed above the results block.
+ *   Defaults to `'Performance Results'`.
  */
-export declare const prettyPrintPerformanceResults: (results: PerformanceResult[]) => void;
+export declare const prettyPrintPerformanceResults: (results: PerformanceResult[], label?: string) => void;
 export {};