@tije-syntra/snap-to-line 0.1.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tije-syntra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# @tije-syntra/snap-to-line (TypeScript)
+
+Beta TypeScript port of [github.com/tije-syntra/snap-to-line](https://github.com/tije-syntra/snap-to-line) **v1.2.0** — GPS route snapping with Viterbi segment tracking for live bus dashboards.
+
+Published on npm under [@tije-syntra/snap-to-line](https://www.npmjs.com/package/@tije-syntra/snap-to-line) (org: [tije-syntra](https://www.npmjs.com/org/tije-syntra)).
+
+> **Status: 0.1.0-beta.1** — API names and types mirror the Go library; some advanced stabilizers (full folded-geometry branch lock) are simplified in this release.
+
+## Install
+
+```bash
+npm install @tije-syntra/snap-to-line@beta
+```
+
+## Quick start
+
+```typescript
+import {
+  NewSnapper,
+  LiveBusSnapConfig,
+  MapOffRoute,
+  SnapDegraded,
+  DefaultOffRoutePolicy,
+  type GPSPoint,
+  type LineString,
+  type Stop,
+} from "@tije-syntra/snap-to-line";
+
+const line: LineString = [
+  [106.0, -6.0],
+  [106.05, -6.0],
+  [106.1, -6.0],
+];
+
+const stops: Stop[] = [
+  { ID: "A", Order: 1, Point: line[0] },
+  { ID: "B", Order: 2, Point: line[1] },
+  { ID: "C", Order: 3, Point: line[2] },
+];
+
+const cfg = LiveBusSnapConfig(stops);
+const snapper = NewSnapper(line, stops, cfg);
+
+const point: GPSPoint = {
+  Point: [106.04, -6.0002],
+  Speed: 25,
+  Bearing: 90,
+  Timestamp: Date.now(),
+};
+
+const result = snapper.Snap(point);
+const policy = DefaultOffRoutePolicy();
+const offRoute = MapOffRoute(result, SnapDegraded(result), policy);
+
+console.log(result.SegmentOrder, result.Confidence, offRoute);
+```
+
+## Publish (org maintainers)
+
+```bash
+npm publish --tag beta --access public --otp=XXXXXX
+```
+
+## Build
+
+```bash
+npm install
+npm test
+npm run build
+```
+
+Dual **ESM + CJS** output via [tsup](https://tsup.egoist.dev/).
+
+## License
+
+MIT — see [LICENSE](./LICENSE).