@glandais/vcyclist-engine 6.2.0 → 6.4.0

package/index.cjs

@@ -46,6 +46,7 @@ module.exports = {
     pathElevationLossFiltered: ns.pathElevationLossFiltered,
     pathReportedElevationGain: ns.pathReportedElevationGain,
     pathReportedElevationLoss: ns.pathReportedElevationLoss,
+    pathElevationCorrections: ns.pathElevationCorrections,
     pointAt: ns.pointAt,
     writeGpx: ns.writeGpx,
     writeGpxAt: ns.writeGpxAt,

package/index.d.ts

@@ -89,6 +89,15 @@ export type PointFieldProp =
     | 'sourceLongitude'
     | 'sourceElevation';
 
+/** The spellings every door parses, derived from the `ElevationCorrectionStatus` catalogue in `commonMain`. */
+export type ElevationCorrectionStatus =
+    | 'not-run'
+    | 'unavailable'
+    | 'no-coverage'
+    | 'none-found'
+    | 'applied'
+    | 'fetch-failed';
+
 /** The spellings every door parses, derived from the `CornerKind` catalogue in `commonMain`. */
 export type CornerKind =
     | 'GENTLE'
@@ -206,6 +215,22 @@ export interface EnhanceOptionsDto {
      * this smoothing, so the window barely moves it.
      */
     readonly elevationSmoothWindowM?: number | null;
+    /**
+     * **Allow** the bridge-deck correction after `fixElevation`: ride each bridge deck the LiDAR
+     * surface model shows instead of the valley floor the terrain model reads under it. A
+     * permission, not a promise — it runs only with `demSource: "ign-lidar-hd"` at that source's
+     * default zoom, the one provider carrying a surface model, and reports `"unavailable"`
+     * otherwise. `false` saves the surface-model fetches and makes the profile independent of the
+     * network. Defaults to `true`. What it did is read back with `pathElevationCorrections`.
+     */
+    readonly bridgeDecksEnabled?: boolean | null;
+    /**
+     * Allow the tunnel correction after `fixElevation`, on any DEM: flatten each tunnel the terrain
+     * model betrays onto the line between its portals. Its precision is unmeasured on tracks with
+     * steep real knolls (≥ 30 %) and in regions only GLO-30 covers, where a false tunnel flattens a
+     * real climb — turn it off there. Defaults to `true`.
+     */
+    readonly tunnelsEnabled?: boolean | null;
     /**
      * Web-Mercator zoom for the DEM lookup, `0..15`, used only when `fixElevation` is on.
      *
@@ -337,6 +362,20 @@ export interface FieldDefinitionDto {
     readonly anglesInRadians: boolean;
 }
 
+/**
+ * JS view of `ElevationCorrections`. Statuses are `ElevationCorrectionStatus` ids: `"not-run"`,
+ * `"unavailable"`, `"no-coverage"`, `"none-found"`, `"applied"`, `"fetch-failed"`.
+ */
+export interface ElevationCorrectionsDto {
+    readonly bridgeDecks: ElevationCorrectionStatus;
+    readonly bridgeDecksApplied: number;
+    readonly bridgeDecksDropped: number;
+    readonly tunnels: ElevationCorrectionStatus;
+    readonly tunnelsApplied: number;
+    readonly tunnelsDropped: number;
+    readonly warnings: string[];
+}
+
 /**
  * A homogeneous-grade segment of a climb. Distances are absolute along the path, in meters;
  * `grade` is dimensionless (`0.08` = 8 %), matching `averageGrade`.
@@ -525,6 +564,15 @@ export declare function pathReportedElevationGain(path: Path): number;
  */
 export declare function pathReportedElevationLoss(path: Path): number;
 
+/**
+ * What the enhancer's elevation corrections (bridge decks, tunnels) did to `path`, as a plain JS
+ * object; `null` when `path` never went through `enhance` / `enhanceWithCourse`.
+ *
+ * `warnings` holds one sentence per outcome that is knowingly wrong or depends on the network (a
+ * tile that could not be read, a detected deck left on the valley floor) and is empty otherwise.
+ */
+export declare function pathElevationCorrections(path: Path): ElevationCorrectionsDto | null;
+
 export declare function pointAt(path: Path, i: number): PointDto;
 
 /**

package/index.mjs

@@ -27,6 +27,7 @@ export const pathElevationGainFiltered = ns.pathElevationGainFiltered;
 export const pathElevationLossFiltered = ns.pathElevationLossFiltered;
 export const pathReportedElevationGain = ns.pathReportedElevationGain;
 export const pathReportedElevationLoss = ns.pathReportedElevationLoss;
+export const pathElevationCorrections = ns.pathElevationCorrections;
 export const pointAt = ns.pointAt;
 export const writeGpx = ns.writeGpx;
 export const writeGpxAt = ns.writeGpxAt;

package/kotlin-kotlin-stdlib.js

@@ -175,23 +175,23 @@ if (typeof String.prototype.startsWith === 'undefined') {
   initMetadataForClass(AbstractMutableCollection, 'AbstractMutableCollection', VOID, AbstractCollection, [Collection, MutableIterable]);
   initMetadataForClass(IteratorImpl, 'IteratorImpl');
   initMetadataForClass(ListIteratorImpl, 'ListIteratorImpl', VOID, IteratorImpl);
-  initMetadataForClass(AbstractMutableList, 'AbstractMutableList', VOID, AbstractMutableCollection, [Collection, KtList, MutableIterable]);
+  initMetadataForClass(AbstractMutableList, 'AbstractMutableList', VOID, AbstractMutableCollection, [KtList, Collection, MutableIterable]);
   initMetadataForClass(AbstractMap, 'AbstractMap', VOID, VOID, [KtMap]);
   initMetadataForClass(AbstractMutableMap, 'AbstractMutableMap', VOID, AbstractMap, [KtMap]);
-  initMetadataForClass(AbstractMutableSet, 'AbstractMutableSet', VOID, AbstractMutableCollection, [Collection, KtSet, MutableIterable]);
+  initMetadataForClass(AbstractMutableSet, 'AbstractMutableSet', VOID, AbstractMutableCollection, [KtSet, Collection, MutableIterable]);
   initMetadataForCompanion(Companion_2);
   initMetadataForInterface(RandomAccess, 'RandomAccess');
-  initMetadataForClass(ArrayList, 'ArrayList', ArrayList_init_$Create$, AbstractMutableList, [Collection, KtList, MutableIterable, RandomAccess]);
+  initMetadataForClass(ArrayList, 'ArrayList', ArrayList_init_$Create$, AbstractMutableList, [KtList, Collection, MutableIterable, RandomAccess]);
   initMetadataForClass(HashMap, 'HashMap', HashMap_init_$Create$, AbstractMutableMap, [KtMap]);
-  initMetadataForClass(HashMapKeys, 'HashMapKeys', VOID, AbstractMutableSet, [Collection, KtSet, MutableIterable]);
+  initMetadataForClass(HashMapKeys, 'HashMapKeys', VOID, AbstractMutableSet, [KtSet, Collection, MutableIterable]);
   initMetadataForClass(HashMapValues, 'HashMapValues', VOID, AbstractMutableCollection, [Collection, MutableIterable]);
-  initMetadataForClass(HashMapEntrySetBase, 'HashMapEntrySetBase', VOID, AbstractMutableSet, [Collection, KtSet, MutableIterable]);
+  initMetadataForClass(HashMapEntrySetBase, 'HashMapEntrySetBase', VOID, AbstractMutableSet, [KtSet, Collection, MutableIterable]);
   initMetadataForClass(HashMapEntrySet, 'HashMapEntrySet', VOID, HashMapEntrySetBase);
   initMetadataForClass(HashMapKeysDefault$iterator$1);
   initMetadataForClass(HashMapKeysDefault, 'HashMapKeysDefault', VOID, AbstractMutableSet);
   initMetadataForClass(HashMapValuesDefault$iterator$1);
   initMetadataForClass(HashMapValuesDefault, 'HashMapValuesDefault', VOID, AbstractMutableCollection);
-  initMetadataForClass(HashSet, 'HashSet', HashSet_init_$Create$, AbstractMutableSet, [Collection, KtSet, MutableIterable]);
+  initMetadataForClass(HashSet, 'HashSet', HashSet_init_$Create$, AbstractMutableSet, [KtSet, Collection, MutableIterable]);
   initMetadataForCompanion(Companion_3);
   initMetadataForClass(Itr, 'Itr');
   initMetadataForClass(KeysItr, 'KeysItr', VOID, Itr);
@@ -236,7 +236,7 @@ if (typeof String.prototype.startsWith === 'undefined') {
   initMetadataForInterface(InternalMap, 'InternalMap');
   initMetadataForClass(InternalHashMap, 'InternalHashMap', InternalHashMap_init_$Create$, VOID, [InternalMap]);
   initMetadataForClass(LinkedHashMap, 'LinkedHashMap', LinkedHashMap_init_$Create$, HashMap, [KtMap]);
-  initMetadataForClass(LinkedHashSet, 'LinkedHashSet', LinkedHashSet_init_$Create$, HashSet, [Collection, KtSet, MutableIterable]);
+  initMetadataForClass(LinkedHashSet, 'LinkedHashSet', LinkedHashSet_init_$Create$, HashSet, [KtSet, Collection, MutableIterable]);
   initMetadataForInterface(Continuation, 'Continuation');
   initMetadataForClass(InterceptedCoroutine, 'InterceptedCoroutine', VOID, VOID, [Continuation]);
   initMetadataForClass(CoroutineImpl, 'CoroutineImpl', VOID, InterceptedCoroutine, [Continuation]);
@@ -972,20 +972,20 @@ if (typeof String.prototype.startsWith === 'undefined') {
     return _this__u8e3s4 < minimumValue ? minimumValue : _this__u8e3s4;
   }
   function coerceIn(_this__u8e3s4, minimumValue, maximumValue) {
-    if (compare(minimumValue, maximumValue) > 0)
-      throw IllegalArgumentException_init_$Create$_0('Cannot coerce value to an empty range: maximum ' + maximumValue.toString() + ' is less than minimum ' + minimumValue.toString() + '.');
-    if (compare(_this__u8e3s4, minimumValue) < 0)
+    if (minimumValue > maximumValue)
+      throw IllegalArgumentException_init_$Create$_0('Cannot coerce value to an empty range: maximum ' + maximumValue + ' is less than minimum ' + minimumValue + '.');
+    if (_this__u8e3s4 < minimumValue)
       return minimumValue;
-    if (compare(_this__u8e3s4, maximumValue) > 0)
+    if (_this__u8e3s4 > maximumValue)
       return maximumValue;
     return _this__u8e3s4;
   }
   function coerceIn_0(_this__u8e3s4, minimumValue, maximumValue) {
-    if (minimumValue > maximumValue)
-      throw IllegalArgumentException_init_$Create$_0('Cannot coerce value to an empty range: maximum ' + maximumValue + ' is less than minimum ' + minimumValue + '.');
-    if (_this__u8e3s4 < minimumValue)
+    if (compare(minimumValue, maximumValue) > 0)
+      throw IllegalArgumentException_init_$Create$_0('Cannot coerce value to an empty range: maximum ' + maximumValue.toString() + ' is less than minimum ' + minimumValue.toString() + '.');
+    if (compare(_this__u8e3s4, minimumValue) < 0)
       return minimumValue;
-    if (_this__u8e3s4 > maximumValue)
+    if (compare(_this__u8e3s4, maximumValue) > 0)
       return maximumValue;
     return _this__u8e3s4;
   }
@@ -9375,7 +9375,7 @@ if (typeof String.prototype.startsWith === 'undefined') {
   function DelimitedRangesSequence$iterator$1(this$0) {
     this.hf_1 = this$0;
     this.cf_1 = -1;
-    this.df_1 = coerceIn_0(this$0.jf_1, 0, charSequenceLength(this$0.if_1));
+    this.df_1 = coerceIn(this$0.jf_1, 0, charSequenceLength(this$0.if_1));
     this.ef_1 = this.df_1;
     this.ff_1 = null;
     this.gf_1 = 0;
@@ -9995,7 +9995,7 @@ if (typeof String.prototype.startsWith === 'undefined') {
       var tmp$ret$0 = add(this_0, fromInt(1));
       tmp = durationOfMillis(multiply(numberToLong(tmp_0), convertDurationUnitToMilliseconds(abs_0(coerceAtLeast_1(_this__u8e3s4, tmp$ret$0)), unit)));
     } else {
-      tmp = durationOfMillis(coerceIn(convertDurationUnit_0(_this__u8e3s4, unit, DurationUnit_MILLISECONDS_getInstance()), new Long(1, -1073741824), new Long(-1, 1073741823)));
+      tmp = durationOfMillis(coerceIn_0(convertDurationUnit_0(_this__u8e3s4, unit, DurationUnit_MILLISECONDS_getInstance()), new Long(1, -1073741824), new Long(-1, 1073741823)));
     }
     return tmp;
   }
@@ -10056,7 +10056,7 @@ if (typeof String.prototype.startsWith === 'undefined') {
       if (equalsLong(other, new Long(-1, 1073741823)) || equalsLong(other, new Long(1, -1073741824))) {
         tmp = other;
       } else {
-        tmp = coerceIn(add(_this__u8e3s4, other), new Long(1, -1073741824), new Long(-1, 1073741823));
+        tmp = coerceIn_0(add(_this__u8e3s4, other), new Long(1, -1073741824), new Long(-1, 1073741823));
       }
     }
     return tmp;
@@ -10066,7 +10066,7 @@ if (typeof String.prototype.startsWith === 'undefined') {
     if (compare(new Long(1108857478, -1074), millis) <= 0 ? compare(millis, new Long(-1108857478, 1073)) <= 0 : false) {
       tmp = durationOfNanos(millisToNanos(millis));
     } else {
-      tmp = durationOfMillis(coerceIn(millis, new Long(1, -1073741824), new Long(-1, 1073741823)));
+      tmp = durationOfMillis(coerceIn_0(millis, new Long(1, -1073741824), new Long(-1, 1073741823)));
     }
     return tmp;
   }
@@ -11671,8 +11671,8 @@ if (typeof String.prototype.startsWith === 'undefined') {
   _.$_$.q8 = coerceAtLeast;
   _.$_$.r8 = coerceAtMost;
   _.$_$.s8 = coerceIn_1;
-  _.$_$.t8 = coerceIn_0;
-  _.$_$.u8 = coerceIn;
+  _.$_$.t8 = coerceIn;
+  _.$_$.u8 = coerceIn_0;
   _.$_$.v8 = contains_2;
   _.$_$.w8 = downTo;
   _.$_$.x8 = rangeTo;