@glandais/vcyclist-engine 1.0.0 → 1.1.1

package/README.md

@@ -112,16 +112,42 @@ suspend fun virtualize(xml: String): String {
 `generateTypeScriptDefinitions()` is enabled on both `js(IR)` and `wasmJs`, so you get a
 `.d.ts` next to the bundle in `build/dist/{js,wasmJs}/productionExecutable/vcyclist-engine.d.{ts,mts}`.
 
+The Kotlin/JS variant (`@glandais/vcyclist-engine`, `@glandais/vcyclist-elevation`) runs
+**in both browser and Node.js / Bun**. The Wasm variants (`*-wasm`) are browser-only.
+
+#### Browser
+
 ```js
-import { parseGpx, enhance, writeGpx, pathSize, pathTotalDistance } from './vcyclist-engine.mjs';
+import { parseGpx, enhance, writeGpx, pathSize, pathTotalDistance } from '@glandais/vcyclist-engine';
 
 const handle = parseGpx(gpxXml);
 console.log('input points:', pathSize(handle));
-const out = await enhance(handle, null);
+const out = await enhance(handle, null);                    // physics only, no HTTP
 console.log('output:', pathSize(out), pathTotalDistance(out), 'm');
 const xml = writeGpx(out);
 ```
 
+#### Node.js / Bun (with elevation correction)
+
+```js
+import { parseGpx, enhance, writeGpx } from '@glandais/vcyclist-engine';
+
+const handle = parseGpx(gpxXml);
+const out = await enhance(handle, { fixElevation: true });  // fetches DEM tiles, decodes WebP
+const xml = writeGpx(out);
+```
+
+`enhance(..., { fixElevation: true })` auto-instantiates a default `ElevationProvider`
+(mapterhorn Terrarium tiles) and runs the full pipeline (densify → fix elevation → smooth →
+max speeds → virtualize → resample → simplify).
+
+On Node.js / Bun, tile decoding uses [`@jsquash/webp`](https://www.npmjs.com/package/@jsquash/webp)
+(a pure-WASM WebP decoder, ~50 KB, listed as a runtime `dependency` of
+`@glandais/vcyclist-engine` and `@glandais/vcyclist-elevation`). It is loaded lazily via
+`eval('require')`, so browser bundlers do not pull it into the browser build. Requires
+Node ≥ 18 (`globalThis.fetch` is built-in since Node 18 / Bun) ; Node 22+ recommended for
+ESM `require()` support.
+
 ## Build & test
 
 ```bash
@@ -158,6 +184,12 @@ vcyclist/
   GPX I/O, full physics, simulation, post-processing, `Enhancer`, CLI, `@JsExport` façades.
 - ✅ **Phase 2bis** — pipeline fidelity fixes (tasks 29-31) : `VirtualizeService` last-point
   timestamp, `PointPerDistance` port, integration into `Enhancer`.
+- ✅ **Phase 3** — Node.js / Bun support (tasks 32-33) : runtime-detection in
+  `TileFetcher.js.kt` (browser path unchanged, Node path uses `globalThis.fetch` +
+  `@jsquash/webp` WASM decoder loaded via lazy `eval('require')`), webpack externals to keep
+  the browser bundle free of `@jsquash/webp`, `ElevationProvider` auto-instantiation in
+  `EngineJsApi.enhance` when `opts.fixElevation` is true (JS + Wasm façades), 6 jsTest classes
+  gated by `INTEGRATION=1`.
 
 Total `:engine` test coverage : 32 test classes / ~326 commonTest cases / 4 targets =
 ~1300 green executions, plus JVM-only smoke tests for the CLI and the full pipeline.
@@ -173,8 +205,20 @@ output points covering ~128.6 km / ~5.3 h of simulated ride.
 - [`docs/parity.md`](docs/parity.md) — TS↔Kotlin parity approach and tolerances.
 - [`docs/kotlin-wasm-jvm-webp.md`](docs/kotlin-wasm-jvm-webp.md) — Kotlin/Wasm ↔ JS interop
   guide that underpins the `@JsExport` façades and the WebP tile decoding.
+- [`docs/publishing.md`](docs/publishing.md) — release flow (Maven Central + npm via
+  semantic-release on push to `develop`).
 - [`elevation/README.md`](elevation/README.md) — `:elevation` module details + browser demos.
 
+## Contributing
+
+`develop` is the **default and only long-lived branch** — there is no `main`. Open PRs
+against `develop` using [Conventional Commits](https://www.conventionalcommits.org/) :
+`feat:` triggers a minor release, `fix:` a patch, anything else is a no-op release-wise.
+Every push to `develop` runs the full multi-target test suite via
+`.github/workflows/release.yml` and, if green, lets semantic-release tag a new version,
+publish to Maven Central + npm, and commit the version bump back to `develop` with
+`[skip ci]`. See [`docs/publishing.md`](docs/publishing.md) for the full flow.
+
 ## License
 
 Apache License 2.0, aligned with the upstream `gpx2web` project. See the Maven Central POM

package/kotlin-kotlin-stdlib.js

@@ -46,6 +46,17 @@ if (typeof Array.prototype.fill === 'undefined') {
     Object.defineProperty(TypedArray.prototype, 'fill', {value: Array.prototype.fill});
   }
 });
+if (typeof Math.clz32 === 'undefined') {
+  Math.clz32 = function (log, LN2) {
+    return function (x) {
+      var asUint = x >>> 0;
+      if (asUint === 0) {
+        return 32;
+      }
+      return 31 - (log(asUint) / LN2 | 0) | 0; // the "| 0" acts like math.floor
+    };
+  }(Math.log, Math.LN2);
+}
 if (typeof Math.hypot === 'undefined') {
   Math.hypot = function () {
     var y = 0;
@@ -59,17 +70,6 @@ if (typeof Math.hypot === 'undefined') {
     return Math.sqrt(y);
   };
 }
-if (typeof Math.clz32 === 'undefined') {
-  Math.clz32 = function (log, LN2) {
-    return function (x) {
-      var asUint = x >>> 0;
-      if (asUint === 0) {
-        return 32;
-      }
-      return 31 - (log(asUint) / LN2 | 0) | 0; // the "| 0" acts like math.floor
-    };
-  }(Math.log, Math.LN2);
-}
 //endregion
 (function (factory) {
   if (typeof define === 'function' && define.amd)
@@ -112,12 +112,12 @@ if (typeof Math.clz32 === 'undefined') {
   initMetadataForClass(AbstractCollection, 'AbstractCollection', VOID, VOID, [Collection]);
   initMetadataForClass(AbstractMutableCollection, 'AbstractMutableCollection', VOID, AbstractCollection, [Collection]);
   initMetadataForClass(IteratorImpl, 'IteratorImpl');
-  initMetadataForClass(AbstractMutableList, 'AbstractMutableList', VOID, AbstractMutableCollection, [KtList, Collection]);
+  initMetadataForClass(AbstractMutableList, 'AbstractMutableList', VOID, AbstractMutableCollection, [Collection, KtList]);
   initMetadataForClass(AbstractMap, 'AbstractMap', VOID, VOID, [KtMap]);
   initMetadataForClass(AbstractMutableMap, 'AbstractMutableMap', VOID, AbstractMap, [KtMap]);
   initMetadataForClass(AbstractMutableSet, 'AbstractMutableSet', VOID, AbstractMutableCollection, [KtSet, Collection]);
   initMetadataForCompanion(Companion_2);
-  initMetadataForClass(ArrayList, 'ArrayList', ArrayList_init_$Create$, AbstractMutableList, [KtList, Collection]);
+  initMetadataForClass(ArrayList, 'ArrayList', ArrayList_init_$Create$, AbstractMutableList, [Collection, KtList]);
   initMetadataForClass(HashMap, 'HashMap', HashMap_init_$Create$, AbstractMutableMap, [KtMap]);
   initMetadataForClass(HashMapKeys, 'HashMapKeys', VOID, AbstractMutableSet, [KtSet, Collection]);
   initMetadataForClass(HashMapEntrySetBase, 'HashMapEntrySetBase', VOID, AbstractMutableSet, [KtSet, Collection]);
@@ -192,6 +192,7 @@ if (typeof Math.clz32 === 'undefined') {
   initMetadataForClass(PrimitiveKClassImpl, 'PrimitiveKClassImpl', VOID, KClassImpl);
   initMetadataForObject(NothingKClassImpl, 'NothingKClassImpl', VOID, KClassImpl);
   initMetadataForClass(SimpleKClassImpl, 'SimpleKClassImpl', VOID, KClassImpl);
+  initMetadataForInterface(KProperty0, 'KProperty0');
   initMetadataForInterface(KProperty1, 'KProperty1');
   initMetadataForObject(PrimitiveClasses, 'PrimitiveClasses');
   initMetadataForClass(StringBuilder, 'StringBuilder', StringBuilder_init_$Create$_0, VOID, [CharSequence]);
@@ -522,12 +523,12 @@ if (typeof Math.clz32 === 'undefined') {
     }
     return optimizeReadOnlyList(toMutableList_0(_this__u8e3s4));
   }
-  function toMutableList(_this__u8e3s4) {
-    return ArrayList_init_$Create$_1(_this__u8e3s4);
-  }
   function firstOrNull(_this__u8e3s4) {
     return _this__u8e3s4.n() ? null : _this__u8e3s4.m(0);
   }
+  function toMutableList(_this__u8e3s4) {
+    return ArrayList_init_$Create$_1(_this__u8e3s4);
+  }
   function sorted(_this__u8e3s4) {
     if (isInterface(_this__u8e3s4, Collection)) {
       if (_this__u8e3s4.l() <= 1)
@@ -3982,6 +3983,8 @@ if (typeof Math.clz32 === 'undefined') {
   protoOf(SimpleKClassImpl).e7 = function () {
     return this.l7_1;
   };
+  function KProperty0() {
+  }
   function KProperty1() {
   }
   function get_functionClasses() {
@@ -7877,58 +7880,60 @@ if (typeof Math.clz32 === 'undefined') {
   _.$_$.y4 = initMetadataForObject;
   _.$_$.z4 = isCharSequence;
   _.$_$.a5 = isInterface;
-  _.$_$.b5 = numberToChar;
-  _.$_$.c5 = numberToInt;
-  _.$_$.d5 = objectCreate;
-  _.$_$.e5 = protoOf;
-  _.$_$.f5 = toShort;
-  _.$_$.g5 = toString_1;
-  _.$_$.h5 = roundToInt;
-  _.$_$.i5 = round;
-  _.$_$.j5 = UIntRange;
-  _.$_$.k5 = coerceAtLeast;
-  _.$_$.l5 = coerceIn_0;
-  _.$_$.m5 = coerceIn;
-  _.$_$.n5 = downTo;
-  _.$_$.o5 = until;
-  _.$_$.p5 = getKClassFromExpression;
-  _.$_$.q5 = KProperty1;
-  _.$_$.r5 = StringBuilder;
-  _.$_$.s5 = concatToString;
-  _.$_$.t5 = indexOf_0;
-  _.$_$.u5 = isBlank;
-  _.$_$.v5 = isHighSurrogate;
-  _.$_$.w5 = replace;
-  _.$_$.x5 = substring;
-  _.$_$.y5 = toDoubleOrNull;
-  _.$_$.z5 = toInt;
-  _.$_$.a6 = toInt_0;
-  _.$_$.b6 = toLongOrNull;
-  _.$_$.c6 = toString_6;
-  _.$_$.d6 = toString_3;
-  _.$_$.e6 = trim;
-  _.$_$.f6 = Char;
-  _.$_$.g6 = Enum;
-  _.$_$.h6 = Error_0;
-  _.$_$.i6 = Exception;
-  _.$_$.j6 = IllegalArgumentException;
-  _.$_$.k6 = Long;
-  _.$_$.l6 = Pair;
-  _.$_$.m6 = Result;
-  _.$_$.n6 = RuntimeException;
-  _.$_$.o6 = THROW_CCE;
-  _.$_$.p6 = Unit;
-  _.$_$.q6 = UnsupportedOperationException;
-  _.$_$.r6 = addSuppressed;
-  _.$_$.s6 = createFailure;
-  _.$_$.t6 = ensureNotNull;
-  _.$_$.u6 = isNaN_0;
-  _.$_$.v6 = lazy;
-  _.$_$.w6 = noWhenBranchMatchedException;
-  _.$_$.x6 = stackTraceToString;
-  _.$_$.y6 = throwOnFailure;
-  _.$_$.z6 = toString_0;
-  _.$_$.a7 = uintCompare;
+  _.$_$.b5 = isNumber;
+  _.$_$.c5 = numberToChar;
+  _.$_$.d5 = numberToInt;
+  _.$_$.e5 = objectCreate;
+  _.$_$.f5 = protoOf;
+  _.$_$.g5 = toShort;
+  _.$_$.h5 = toString_1;
+  _.$_$.i5 = roundToInt;
+  _.$_$.j5 = round;
+  _.$_$.k5 = UIntRange;
+  _.$_$.l5 = coerceAtLeast;
+  _.$_$.m5 = coerceIn_0;
+  _.$_$.n5 = coerceIn;
+  _.$_$.o5 = downTo;
+  _.$_$.p5 = until;
+  _.$_$.q5 = getKClassFromExpression;
+  _.$_$.r5 = KProperty0;
+  _.$_$.s5 = KProperty1;
+  _.$_$.t5 = StringBuilder;
+  _.$_$.u5 = concatToString;
+  _.$_$.v5 = indexOf_0;
+  _.$_$.w5 = isBlank;
+  _.$_$.x5 = isHighSurrogate;
+  _.$_$.y5 = replace;
+  _.$_$.z5 = substring;
+  _.$_$.a6 = toDoubleOrNull;
+  _.$_$.b6 = toInt;
+  _.$_$.c6 = toInt_0;
+  _.$_$.d6 = toLongOrNull;
+  _.$_$.e6 = toString_6;
+  _.$_$.f6 = toString_3;
+  _.$_$.g6 = trim;
+  _.$_$.h6 = Char;
+  _.$_$.i6 = Enum;
+  _.$_$.j6 = Error_0;
+  _.$_$.k6 = Exception;
+  _.$_$.l6 = IllegalArgumentException;
+  _.$_$.m6 = Long;
+  _.$_$.n6 = Pair;
+  _.$_$.o6 = Result;
+  _.$_$.p6 = RuntimeException;
+  _.$_$.q6 = THROW_CCE;
+  _.$_$.r6 = Unit;
+  _.$_$.s6 = UnsupportedOperationException;
+  _.$_$.t6 = addSuppressed;
+  _.$_$.u6 = createFailure;
+  _.$_$.v6 = ensureNotNull;
+  _.$_$.w6 = isNaN_0;
+  _.$_$.x6 = lazy;
+  _.$_$.y6 = noWhenBranchMatchedException;
+  _.$_$.z6 = stackTraceToString;
+  _.$_$.a7 = throwOnFailure;
+  _.$_$.b7 = toString_0;
+  _.$_$.c7 = uintCompare;
   //endregion
   return _;
 }));