geoverse-line-finder 0.1.0

package/CHANGELOG.en.md

@@ -0,0 +1,22 @@
+# Changelog
+
+🌐 [简体中文](CHANGELOG.md) ｜ English
+
+This project follows [Semantic Versioning](https://semver.org/); while in 0.x, minor versions may contain breaking changes.
+
+## 0.1.0 — 2026-09-11
+
+First release, open-sourced under the Apache License 2.0.
+
+### Added
+
+- `LineFinder`: weighted shortest paths on GeoJSON line networks (`LineString` / `MultiLineString`), between two points or through several waypoints in order.
+- Weights: the geojson-path-finder weight-function contract (number / `{ forward, backward }` / falsy = impassable), plus `context.distance`;
+  `createPropertyWeight`, `createSpeedWeight` and `osmDirection` presets; negative weights throw `RangeError`.
+- Engines: `AlgorithmRegistry` with the built-in `astar` and `dijkstra`; custom engines plug in through the `PathAlgorithm` / `SearchGraph` contract; the priority queue is replaceable.
+- Metrics: `haversine` (default), `cheap-ruler`, `euclidean` or a custom `Metric`; the A\* heuristic is admissible for any weight.
+- Connectivity repair: `tolerance` merges vertices by real distance, `snapDangles` connects dangling ends, `splitIntersections` splits crossings; degree-2 vertices are compacted into chains.
+- Snapping: `edge` / `vertex` / `node` / `exact` modes, `maxDistance`, connectivity-aware assignment; a standalone `nearest()`.
+- Results: `legs`, `sections` grouped by source feature, `waypoints`, failure reasons as a discriminated union, `toLineString()`.
+- Builds: ESM, CommonJS, type declarations and an IIFE bundle (global `GeoVerseLineFinder`).
+- Project: GitHub Actions CI (full gate on Node 20 / 22, dist smoke test on Node 18 / 20 / 22) and tag-triggered releases with npm provenance; documentation in Chinese (primary) and English.

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+🌐 简体中文 ｜ [English](CHANGELOG.en.md)
+
+本项目遵循[语义化版本](https://semver.org/lang/zh-CN/)；0.x 期间，次版本号可能包含不兼容变更。
+
+## 0.1.0 — 2026-09-11
+
+首个版本，以 Apache-2.0 协议开源。
+
+### 新增
+
+- `LineFinder`：GeoJSON 线网络（`LineString` / `MultiLineString`）上的带权最短路，支持两点与按顺序的多途经点。
+- 权重：兼容 geojson-path-finder 的权重函数契约（数字 / `{ forward, backward }` / 假值不可通行），额外提供 `context.distance`；
+  `createPropertyWeight`、`createSpeedWeight`、`osmDirection` 预设；负权重抛 `RangeError`。
+- 引擎：`AlgorithmRegistry` 与内置 `astar`、`dijkstra`；`PathAlgorithm` / `SearchGraph` 契约可接入自定义引擎；优先队列可替换。
+- 度量：`haversine`（默认）、`cheap-ruler`、`euclidean` 或自定义 `Metric`；A\* 启发式对任意权重可采纳。
+- 连通修复：`tolerance` 按真实距离合并顶点、`snapDangles` 连接悬挂端点、`splitIntersections` 打断交叉；度 2 顶点压缩成链。
+- 吸附：`edge` / `vertex` / `node` / `exact` 四种模式、`maxDistance`、连通性感知分配；单独的 `nearest()`。
+- 结果：`legs`、按来源要素聚合的 `sections`、`waypoints`、判别联合的失败原因、`toLineString()`。
+- 产物：ESM、CommonJS、类型声明，以及 IIFE（全局 `GeoVerseLineFinder`）。
+- 工程：GitHub Actions 的 CI（Node 20 / 22 全部门禁，Node 18 / 20 / 22 产物冒烟）与打 tag 发布（npm provenance）；中英文文档，中文为主。

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+geoverse-line-finder
+Copyright 2026 DIY Liu
+
+Licensed under the Apache License, Version 2.0; see the LICENSE file.
+
+This product includes code adapted from third-party projects distributed under
+the MIT and ISC licenses (terra-route, geojson-path-finder, cheap-ruler and
+flatbush). Their attributions and license texts are in THIRD_PARTY_NOTICES.md.

package/README.en.md

@@ -0,0 +1,169 @@
+# geoverse-line-finder
+
+🌐 [简体中文](README.md) ｜ English
+
+[![CI](https://github.com/GeoVerseLabs/geoverse-line-finder/actions/workflows/ci.yml/badge.svg)](https://github.com/GeoVerseLabs/geoverse-line-finder/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/geoverse-line-finder)](https://www.npmjs.com/package/geoverse-line-finder)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+A zero-dependency TypeScript library for shortest paths on GeoJSON line networks (`LineString` / `MultiLineString`):
+
+- **Configurable weights**: weight functions fully compatible with geojson-path-finder (the same cost both ways / `{ forward, backward }` per direction / falsy = impassable), plus a length context and declarative presets;
+- **Switchable engines**: built-in A* and Dijkstra, selectable per query by name, and you can register your own;
+- **Snapping and connectivity**: start and end points need not be network vertices (they are projected onto the nearest segment); at build time nearby vertices can be merged, dangling ends repaired and crossings split; at query time waypoints are snapped with the network's connected components in mind;
+- **Two points or many waypoints**: one call returns the whole route, per-leg results and `sections` grouped by source feature.
+
+The routing core follows [terra-route](https://github.com/JamesLMilner/terra-route) (CSR adjacency, 4-ary heap, reusable scratch buffers); the weight configuration follows [geojson-path-finder](https://github.com/perliedman/geojson-path-finder). Works in browsers, Web Workers and Node.
+
+## Install
+
+```bash
+pnpm add geoverse-line-finder
+```
+
+Ships both ESM and CommonJS (Node ≥ 18). Without a bundler, load it with a `<script>` tag; the global is `GeoVerseLineFinder`:
+
+```html
+<script src="https://unpkg.com/geoverse-line-finder@0.1.0"></script>
+<script>
+  const finder = new GeoVerseLineFinder.LineFinder(roads);
+</script>
+```
+
+## Quick start
+
+```ts
+import { LineFinder, toLineString } from 'geoverse-line-finder';
+
+const finder = new LineFinder(roads); // roads: FeatureCollection<LineString>
+
+// Two points: they need not be network vertices; by default they snap to the nearest segment
+const route = finder.route([
+  [116.397, 39.908],
+  [116.41, 39.92],
+]);
+if (route.ok) {
+  console.log(route.distance, 'm'); // length along the network
+  console.log(route.path); // coordinates
+  map.addGeoJSON(toLineString(route)); // GeoJSON LineString
+} else {
+  console.warn(route.reason, route.message); // SNAP_FAILED / DISCONNECTED / UNREACHABLE / INVALID_INPUT
+}
+
+// Several waypoints, visited in the given order
+const tour = finder.route([start, via1, via2, end], { algorithm: 'dijkstra' });
+tour.ok && tour.legs.forEach((leg) => console.log(leg.from, '→', leg.to, leg.weight));
+```
+
+## Weights
+
+The signature matches geojson-path-finder's, plus a `context` argument (`distance` is the precomputed segment length, in the metric's unit):
+
+```ts
+const finder = new LineFinder(roads, {
+  weight: (a, b, props, { distance }) => {
+    if (props.highway === 'footway') return 0; // impassable
+    const seconds = distance / ((props.maxspeed ?? 30) / 3.6);
+    return props.oneway === 'yes' ? { forward: seconds } : seconds; // one-way
+  },
+});
+```
+
+| Return value                                              | Meaning                                                                      |
+| --------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| positive number                                           | the same cost in both directions                                             |
+| `{ forward, backward }`                                   | forward = along the digitised a→b order; a missing direction is impassable   |
+| `0` / `NaN` / `Infinity` / `null` / `undefined` / `false` | impassable                                                                   |
+| negative number                                           | throws `RangeError` (negative costs silently break shortest-path algorithms) |
+
+Presets:
+
+```ts
+import { createPropertyWeight, createSpeedWeight, osmDirection } from 'geoverse-line-finder';
+
+createPropertyWeight({
+  factor: (p) => ({ primary: 0.8, residential: 1.2 })[p.highway] ?? 1,
+  direction: osmDirection,
+});
+createSpeedWeight({ speed: (p) => Number(p.maxspeed) || 30, direction: osmDirection }); // seconds
+```
+
+## Engines
+
+```ts
+finder.route(points, { algorithm: 'astar' }); // default
+finder.route(points, { algorithm: 'dijkstra' });
+
+// Register a custom engine (implement PathAlgorithm, see docs/ARCHITECTURE.en.md §4)
+finder.registerAlgorithm(myBidirectionalDijkstra);
+finder.route(points, { algorithm: 'bidirectional-dijkstra' });
+```
+
+The A* heuristic is admissible for **any** weight (metric embedding × the network-wide minimum cost-per-length ratio), so A* returns the same optimal cost as Dijkstra while expanding fewer nodes.
+
+## Snapping and connectivity
+
+Build time (`new LineFinder(network, options)`):
+
+| Option               | Default       | Description                                                                                                             |
+| -------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `metric`             | `'haversine'` | `'haversine'` (lng/lat degrees, meters), `'cheap-ruler'`, `'euclidean'` (projected coordinates) or a custom metric      |
+| `tolerance`          | `0`           | vertices closer than this are merged into one (by real distance; geojson-path-finder's default of 1e-5° is about 1.1 m) |
+| `snapDangles`        | `0`           | connect dangling ends to the nearest segment within this distance                                                       |
+| `splitIntersections` | `false`       | split lines where they cross or touch without a shared vertex (this also joins overpasses — enable deliberately)        |
+| `compact`            | `true`        | collapse degree-2 vertices into chains: identical results, faster search                                                |
+
+Query time (`route(points, { snap })`):
+
+| Option         | Default       | Description                                                                                                                                                                     |
+| -------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mode`         | `'edge'`      | `'edge'` project onto the nearest segment · `'vertex'` nearest vertex · `'node'` nearest junction / dead end · `'exact'` must be a vertex                                       |
+| `maxDistance`  | `Infinity`    | anything farther fails with `SNAP_FAILED`                                                                                                                                       |
+| `connectivity` | `'connected'` | when the waypoints' nearest locations lie in components that are not connected, use nearby locations in a component all of them can reach; `'nearest'` always takes the nearest |
+
+`finder.nearest(point)` returns the nearest network location on its own, e.g. for interactive snapping hints.
+
+## Result
+
+```ts
+interface RouteSuccess {
+  ok: true;
+  path: Position[]; // the whole route
+  weight: number; // total cost that was minimised
+  distance: number; // total length along the network
+  legs: RouteLeg[]; // per leg: path / weight / distance / sections / settled
+  waypoints: { input; location; distance; component; featureIndex }[];
+  algorithm: string;
+}
+```
+
+`leg.sections` groups the path by source feature (with `properties`, its index range in `leg.path`, length and cost) — handy for listing the streets along a route.
+
+## Migrating from geojson-path-finder
+
+| geojson-path-finder                                    | geoverse-line-finder                                                               |
+| ------------------------------------------------------ | ---------------------------------------------------------------------------------- |
+| `new PathFinder(geojson, { weight, tolerance: 1e-5 })` | `new LineFinder(geojson, { weight, tolerance: 1.1 })` (tolerance is now in meters) |
+| `findPath(a, b)` → `{ path, weight } \| undefined`     | `findPath(a, b)` / `route([a, b])` → `{ ok, path, weight, … }`                     |
+| start and end must be vertices                         | segment snapping by default; `snap: { mode: 'exact' }` restores the old behaviour  |
+| default weight = kilometers                            | default weight = meters (the metric's unit)                                        |
+| `edgeDataReducer` / `edgeDataSeed`                     | `leg.sections` (no configuration needed)                                           |
+| `pathToGeoJSON(path)`                                  | `toLineString(route)`                                                              |
+
+## Performance and correctness
+
+- All structures are flat typed arrays; queries reuse scratch buffers and only touch the nodes they visit.
+- The tests include randomized differential testing against a naive reference implementation, every assertion from geojson-path-finder's own suite, and pair-by-pair comparison with an independent referee on geojson-path-finder's 135k-coordinate one-way OSM network.
+- CI (GitHub Actions) runs the full gate on Node 20 / 22 and loads the built package on Node 18 / 20 / 22; pushing a `vX.Y.Z` tag publishes to npm — see [docs/RELEASE.en.md](docs/RELEASE.en.md).
+- Measurements and how to reproduce them: [docs/BENCHMARK.en.md](docs/BENCHMARK.en.md); design notes: [docs/ARCHITECTURE.en.md](docs/ARCHITECTURE.en.md).
+
+```bash
+pnpm test        # unit + differential + parity tests
+pnpm bench       # three-library benchmark (geojson-path-finder test data, ≥ 3 rounds)
+pnpm bench:gpf   # root-cause experiment for geojson-path-finder's non-shortest routes
+pnpm check       # typecheck + lint + format + tests (coverage ratchet) + build + dist smoke test
+```
+
+## License
+
+[Apache-2.0](LICENSE); copyright and attribution in [NOTICE](NOTICE). Borrowed code and ideas (MIT / ISC) are listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/README.md

@@ -0,0 +1,169 @@
+# geoverse-line-finder
+
+🌐 简体中文 ｜ [English](README.en.md)
+
+[![CI](https://github.com/GeoVerseLabs/geoverse-line-finder/actions/workflows/ci.yml/badge.svg)](https://github.com/GeoVerseLabs/geoverse-line-finder/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/geoverse-line-finder)](https://www.npmjs.com/package/geoverse-line-finder)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+在 GeoJSON 线网络（`LineString` / `MultiLineString`）上求最短路径的零依赖 TypeScript 库：
+
+- **可配置权重**：与 geojson-path-finder 完全兼容的权重函数（双向同价 / `{ forward, backward }` 分方向 / 假值不可通行），外加长度上下文与声明式预设；
+- **可切换引擎**：内置 A* 与 Dijkstra，按名称逐次切换，也可注册自己的引擎；
+- **吸附与连通**：起终点可以不在路网顶点上（投影到最近线段），建图期可合并近点、修复悬挂端点、打断交叉，查询期按连通分量智能吸附；
+- **两点与多途经点**：一次调用得到整条路线、分段结果与按要素聚合的 `sections`。
+
+路径主体借鉴 [terra-route](https://github.com/JamesLMilner/terra-route)（CSR 邻接、四叉堆、scratch 复用），权重配置借鉴 [geojson-path-finder](https://github.com/perliedman/geojson-path-finder)。浏览器、Web Worker、Node 通用。
+
+## 安装
+
+```bash
+pnpm add geoverse-line-finder
+```
+
+同时提供 ESM 与 CommonJS（Node ≥ 18）。不经打包器时可直接用 `<script>` 引入，全局变量为 `GeoVerseLineFinder`：
+
+```html
+<script src="https://unpkg.com/geoverse-line-finder@0.1.0"></script>
+<script>
+  const finder = new GeoVerseLineFinder.LineFinder(roads);
+</script>
+```
+
+## 快速开始
+
+```ts
+import { LineFinder, toLineString } from 'geoverse-line-finder';
+
+const finder = new LineFinder(roads); // roads: FeatureCollection<LineString>
+
+// 两点：起终点不必是路网顶点，默认投影到最近线段
+const route = finder.route([
+  [116.397, 39.908],
+  [116.41, 39.92],
+]);
+if (route.ok) {
+  console.log(route.distance, 'm'); // 沿路网长度
+  console.log(route.path); // 坐标串
+  map.addGeoJSON(toLineString(route)); // GeoJSON LineString
+} else {
+  console.warn(route.reason, route.message); // SNAP_FAILED / DISCONNECTED / UNREACHABLE / INVALID_INPUT
+}
+
+// 多途经点：按给定顺序依次经过
+const tour = finder.route([start, via1, via2, end], { algorithm: 'dijkstra' });
+tour.ok && tour.legs.forEach((leg) => console.log(leg.from, '→', leg.to, leg.weight));
+```
+
+## 权重
+
+权重函数签名与 geojson-path-finder 相同，多一个 `context` 参数（`distance` 为已算好的线段长度，单位同度量）：
+
+```ts
+const finder = new LineFinder(roads, {
+  weight: (a, b, props, { distance }) => {
+    if (props.highway === 'footway') return 0; // 不可通行
+    const seconds = distance / ((props.maxspeed ?? 30) / 3.6);
+    return props.oneway === 'yes' ? { forward: seconds } : seconds; // 单向
+  },
+});
+```
+
+| 返回值                                                    | 含义                                           |
+| --------------------------------------------------------- | ---------------------------------------------- |
+| 正数                                                      | 两个方向同价                                   |
+| `{ forward, backward }`                                   | forward = 沿数字化方向 a→b；缺省的方向不可通行 |
+| `0` / `NaN` / `Infinity` / `null` / `undefined` / `false` | 不可通行                                       |
+| 负数                                                      | 抛 `RangeError`（负权会让最短路算法静默出错）  |
+
+预设：
+
+```ts
+import { createPropertyWeight, createSpeedWeight, osmDirection } from 'geoverse-line-finder';
+
+createPropertyWeight({
+  factor: (p) => ({ primary: 0.8, residential: 1.2 })[p.highway] ?? 1,
+  direction: osmDirection,
+});
+createSpeedWeight({ speed: (p) => Number(p.maxspeed) || 30, direction: osmDirection }); // 秒
+```
+
+## 引擎
+
+```ts
+finder.route(points, { algorithm: 'astar' }); // 默认
+finder.route(points, { algorithm: 'dijkstra' });
+
+// 注册自定义引擎（实现 PathAlgorithm 即可，见 docs/ARCHITECTURE.md §4）
+finder.registerAlgorithm(myBidirectionalDijkstra);
+finder.route(points, { algorithm: 'bidirectional-dijkstra' });
+```
+
+A* 的启发式对**任意**权重都可采纳（度量嵌入 × 全网最小"代价/长度"比），因此与 Dijkstra 给出相同的最优代价，只是展开的节点更少。
+
+## 吸附与连通
+
+建图期（`new LineFinder(network, options)`）：
+
+| 选项                 | 默认          | 说明                                                                                       |
+| -------------------- | ------------- | ------------------------------------------------------------------------------------------ |
+| `metric`             | `'haversine'` | `'haversine'`（经纬度，米）、`'cheap-ruler'`、`'euclidean'`（投影坐标）或自定义            |
+| `tolerance`          | `0`           | 相距不超过该距离的顶点合并为一个（按真实距离判断；geojson-path-finder 默认 1e-5° ≈ 1.1 m） |
+| `snapDangles`        | `0`           | 把悬挂端点接到该距离内最近的线段上                                                         |
+| `splitIntersections` | `false`       | 在未共点的交叉/接触处打断（会把立交也接上，按需开启）                                      |
+| `compact`            | `true`        | 度 2 顶点压缩成链，结果不变、搜索更快                                                      |
+
+查询期（`route(points, { snap })`）：
+
+| 选项           | 默认          | 说明                                                                                          |
+| -------------- | ------------- | --------------------------------------------------------------------------------------------- |
+| `mode`         | `'edge'`      | `'edge'` 投影到最近线段 · `'vertex'` 最近顶点 · `'node'` 最近路口/端点 · `'exact'` 必须是顶点 |
+| `maxDistance`  | `Infinity`    | 超出即 `SNAP_FAILED`                                                                          |
+| `connectivity` | `'connected'` | 途经点最近位置分属不连通的分量时，改用都能到达的分量里的附近位置；`'nearest'` 始终取最近      |
+
+`finder.nearest(point)` 单独返回最近的路网位置，可用于交互式吸附提示。
+
+## 结果
+
+```ts
+interface RouteSuccess {
+  ok: true;
+  path: Position[]; // 整条路线
+  weight: number; // 被最小化的总代价
+  distance: number; // 沿路网总长度
+  legs: RouteLeg[]; // 每段：path / weight / distance / sections / settled
+  waypoints: { input; location; distance; component; featureIndex }[];
+  algorithm: string;
+}
+```
+
+`leg.sections` 把路径按来源要素聚合（含 `properties`、在 `leg.path` 中的下标区间、长度与代价），可直接用来列出途经道路名。
+
+## 从 geojson-path-finder 迁移
+
+| geojson-path-finder                                    | geoverse-line-finder                                                |
+| ------------------------------------------------------ | ------------------------------------------------------------------- |
+| `new PathFinder(geojson, { weight, tolerance: 1e-5 })` | `new LineFinder(geojson, { weight, tolerance: 1.1 })`（容差改为米） |
+| `findPath(a, b)` → `{ path, weight } \| undefined`     | `findPath(a, b)` / `route([a, b])` → `{ ok, path, weight, … }`      |
+| 起终点必须是顶点                                       | 默认线段吸附；要旧行为用 `snap: { mode: 'exact' }`                  |
+| 默认权重 = 公里                                        | 默认权重 = 米（`metric` 单位）                                      |
+| `edgeDataReducer` / `edgeDataSeed`                     | `leg.sections`（无需配置）                                          |
+| `pathToGeoJSON(path)`                                  | `toLineString(route)`                                               |
+
+## 性能与正确性
+
+- 全部结构为扁平 TypedArray；查询复用 scratch 缓冲，只触碰访问到的节点。
+- 测试含与朴素参考实现的随机差分、GPF 自带测试的全部断言，以及在 GPF 的 13.5 万坐标 OSM 单向路网上与独立裁判逐对比对。
+- CI（GitHub Actions）在 Node 20 / 22 上跑全部门禁，并在 Node 18 / 20 / 22 上直接加载构建产物；推送 `vX.Y.Z` tag 自动发布到 npm，见 [docs/RELEASE.md](docs/RELEASE.md)。
+- 实测数据与复现方法见 [docs/BENCHMARK.md](docs/BENCHMARK.md)；设计说明见 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)。
+
+```bash
+pnpm test        # 单元 + 差分 + 对齐测试
+pnpm bench       # 三库基准（geojson-path-finder 测试数据，≥3 轮）
+pnpm bench:gpf   # geojson-path-finder 次优路线的根因实验
+pnpm check       # 类型检查 + lint + 格式 + 测试（覆盖率棘轮）+ 构建 + 产物冒烟
+```
+
+## 许可
+
+[Apache-2.0](LICENSE)，版权与归属说明见 [NOTICE](NOTICE)。借用的代码与思路（MIT / ISC）见 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)。

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,50 @@
+# Third-party notices
+
+geoverse-line-finder is an independent implementation licensed under the Apache License 2.0
+(see `LICENSE` and `NOTICE`). It adapts ideas and, where noted, small pieces of code from the
+projects below; their licenses are reproduced as required and continue to apply to those portions.
+
+| Project                                                                                | License | What was adapted                                                                                                                                             |
+| -------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [terra-route](https://github.com/JamesLMilner/terra-route) — James Milner              | MIT     | 4-ary heap with stable tie-breaking (`src/heap/four-ary-heap.ts`); CSR adjacency layout and generation-stamped scratch buffers used by the search engines    |
+| [geojson-path-finder](https://github.com/perliedman/geojson-path-finder) — Per Liedman | ISC     | Weight-function contract (`number` / `{ forward, backward }` / falsy = impassable), degree-2 compaction idea; small test fixtures under `test/fixtures/gpf/` |
+| [cheap-ruler](https://github.com/mapbox/cheap-ruler) — Mapbox                          | ISC     | Local-scale distance approximation (`src/geo/metric.ts`, `cheapRulerMetric`)                                                                                 |
+| [flatbush](https://github.com/mourner/flatbush) — Vladimir Agafonkin                   | ISC     | Packed Hilbert R-tree layout and the Hilbert-curve index function (`src/spatial/rtree.ts`)                                                                   |
+
+---
+
+## MIT License (terra-route)
+
+Copyright (c) James Milner
+
+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.
+
+## ISC License (geojson-path-finder, cheap-ruler, flatbush)
+
+Copyright (c) Per Liedman; Copyright (c) 2024, Mapbox; Copyright (c) 2018, Vladimir Agafonkin
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with
+or without fee is hereby granted, provided that the above copyright notice and this
+permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.