@glandais/vcyclist-engine 6.0.1 → 6.2.0

package/index.d.ts

@@ -25,6 +25,11 @@ export type ElevationGainPreset =
     | 'dem'
     | 'gps';
 
+/** The spellings every door parses, derived from the `ElevationSource` catalogue in `commonMain`. */
+export type ElevationSource =
+    | 'mapterhorn'
+    | 'ign-lidar-hd';
+
 /** The spellings every door parses, derived from the `RoadCondition` catalogue in `commonMain`. */
 export type RoadCondition =
     | 'dry'
@@ -196,8 +201,9 @@ export interface EnhanceOptionsDto {
     /**
      * Triangular-kernel half-width for the elevation smoother, in metres.
      *
-     * The single largest determinant of both the reported climbing and the gradients the
-     * simulation rides — it costs a clean route ~1.7 % and a noisy GPS trace ~49 %.
+     * It decides the gradients the simulation rides, and so the duration (17.6 % on a switchback
+     * climb between 10 and 300 m, about 1 % elsewhere). The reported climbing is measured before
+     * this smoothing, so the window barely moves it.
      */
     readonly elevationSmoothWindowM?: number | null;
     /**
@@ -207,6 +213,12 @@ export interface EnhanceOptionsDto {
      * where the provider is built rather than in `toEnhanceOptions`.
      */
     readonly demZoom?: number | null;
+    /**
+     * The DEM `fixElevation` reads, by `ElevationSource` id: `"mapterhorn"` (the default) or
+     * `"ign-lidar-hd"` (France only, falling back to Mapterhorn where IGN has no data). Read
+     * where the provider is built, like `demZoom`; `demZoom` then defaults to the source's own.
+     */
+    readonly demSource?: ElevationSource | null;
 }
 
 /**
@@ -552,7 +564,7 @@ export declare function enhance(path: Path, options: EnhanceOptionsDto | null):
  * (see `CyclistDto`, `BikeDto`, `WindDto`, `PowerProviderDto` KDoc for specifics).
  *
  * Like `enhance`, when `options.fixElevation == true` a default `ElevationProvider` is
- * auto-instantiated (Terrarium tiles via HTTP).
+ * auto-instantiated (`demSource`'s tiles via HTTP).
  */
 export declare function enhanceWithCourse(path: Path, cyclist: CyclistDto | null, bike: BikeDto | null, wind: WindDto | null, power: PowerProviderDto | null, options: EnhanceOptionsDto | null): Promise<Path>;