@flare-engine/pathfinding 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Grzegorz Otto
+
+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,30 @@
+# @flare-engine/pathfinding
+
+Grid pathfinding — A* (`findPath`), Jump-Point Search (`findPathJPS`) for uniform-cost grids, and a polygon navmesh fallback (`findNavMeshPath`). Pure data, no classes. Heuristics (`manhattanDistance`, `octileDistance`, `chebyshevDistance`, `euclideanDistance`) are exported as named functions for tree-shake.
+
+## Install
+
+```sh
+bun add @flare-engine/pathfinding
+```
+
+## Usage
+
+```ts
+import { createGrid, setWalkable, findPathJPS, octileDistance } from '@flare-engine/pathfinding';
+
+const grid = createGrid({ width: 32, height: 32 });
+setWalkable(grid, 5, 5, false);
+
+const result = findPathJPS(grid, { x: 0, y: 0 }, { x: 30, y: 30 }, {
+  heuristic: octileDistance,
+  diagonal: true,
+});
+if (result.found) console.log(result.cells);
+```
+
+See [API spec](../../docs/design/api-specs.md#flare-enginepathfinding--8kb-gzip) and [skill reference](../../.github/skills/flare-pathfinding/SKILL.md).
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,110 @@
+import { Vec2 } from '@flare-engine/math';
+
+/**
+ * Grid data structure for tile-based pathfinding.
+ * Uses a flat Uint8Array: 0 = blocked, 1+ = walkable (value = movement cost).
+ */
+interface Grid {
+    readonly width: number;
+    readonly height: number;
+    readonly data: Uint8Array;
+}
+interface GridConfig {
+    width: number;
+    height: number;
+    /** Pre-filled grid data. Length must equal width * height. */
+    data?: Uint8Array;
+    /** Default cost for all cells when `data` is not provided. 0 = blocked, 1+ = walkable cost. Default 1. */
+    defaultCost?: number;
+}
+declare function createGrid(config: GridConfig): Grid;
+declare function inBounds(grid: Grid, x: number, y: number): boolean;
+declare function isWalkable(grid: Grid, x: number, y: number): boolean;
+declare function getCost(grid: Grid, x: number, y: number): number;
+declare function setWalkable(grid: Grid, x: number, y: number, walkable: boolean): void;
+declare function setCost(grid: Grid, x: number, y: number, cost: number): void;
+
+/**
+ * A* pathfinding on a Grid. Supports 4-directional and 8-directional movement
+ * with weighted costs. Uses a binary min-heap for the open set.
+ */
+
+interface PathResult {
+    /** Grid coordinates from start to end, inclusive. */
+    path: {
+        x: number;
+        y: number;
+    }[];
+    /** Total movement cost. */
+    cost: number;
+    /** Number of nodes explored. */
+    explored: number;
+}
+interface PathOptions {
+    /** Allow diagonal movement. Default: true. */
+    diagonal?: boolean;
+    /** Custom heuristic. Default: octile distance (diagonal) or Manhattan (4-dir). */
+    heuristic?: (ax: number, ay: number, bx: number, by: number) => number;
+    /** Max nodes to explore before giving up. Default: width * height. */
+    maxIterations?: number;
+}
+declare function manhattanDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function octileDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function chebyshevDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function euclideanDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function findPath(grid: Grid, startX: number, startY: number, endX: number, endY: number, options?: PathOptions): PathResult | null;
+
+/**
+ * Jump Point Search — an optimization over A* for uniform-cost grids.
+ * Only works when all walkable tiles have cost 1. Falls back to A* behavior
+ * if weighted costs are detected.
+ *
+ * JPS prunes symmetric paths by "jumping" along directions until hitting
+ * a wall, the goal, or a forced neighbor.
+ */
+
+interface JpsOptions {
+    /** Max nodes to explore before giving up. Default: width * height. */
+    maxIterations?: number;
+    /** Custom heuristic. Default: octile distance. */
+    heuristic?: (ax: number, ay: number, bx: number, by: number) => number;
+}
+declare function findPathJPS(grid: Grid, startX: number, startY: number, endX: number, endY: number, options?: JpsOptions): PathResult | null;
+
+/**
+ * Lightweight navmesh pathfinding for polygon-based environments.
+ * Supports convex polygon navigation with A* over the polygon graph
+ * and the Simple Stupid Funnel Algorithm for path smoothing.
+ */
+
+interface NavMeshPolygon {
+    readonly id: number;
+    /** Convex polygon vertices in winding order. */
+    readonly vertices: readonly Vec2[];
+    /** Ids of neighboring polygons (sharing an edge). */
+    readonly neighbors: readonly number[];
+    /** Shared edge per neighbor: [neighborId] → { a, b } portal endpoints. */
+    readonly portals: readonly Portal[];
+}
+interface Portal {
+    /** Neighbor polygon id. */
+    neighborId: number;
+    /** Left endpoint of the shared edge (from the perspective of travel). */
+    a: Vec2;
+    /** Right endpoint of the shared edge. */
+    b: Vec2;
+}
+interface NavMesh {
+    readonly polygons: readonly NavMeshPolygon[];
+}
+interface NavMeshPathResult {
+    /** Smoothed world-space waypoints. */
+    path: Vec2[];
+    /** Polygon ids traversed. */
+    corridor: number[];
+}
+declare function createNavMesh(polygons: NavMeshPolygon[]): NavMesh;
+declare function findPolygonAt(mesh: NavMesh, x: number, y: number): number;
+declare function findNavMeshPath(mesh: NavMesh, start: Vec2, end: Vec2): NavMeshPathResult | null;
+
+export { type Grid, type GridConfig, type JpsOptions, type NavMesh, type NavMeshPathResult, type NavMeshPolygon, type PathOptions, type PathResult, type Portal, chebyshevDistance, createGrid, createNavMesh, euclideanDistance, findNavMeshPath, findPath, findPathJPS, findPolygonAt, getCost, inBounds, isWalkable, manhattanDistance, octileDistance, setCost, setWalkable };

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import { Vec2 } from '@flare-engine/math';
+
+/**
+ * Grid data structure for tile-based pathfinding.
+ * Uses a flat Uint8Array: 0 = blocked, 1+ = walkable (value = movement cost).
+ */
+interface Grid {
+    readonly width: number;
+    readonly height: number;
+    readonly data: Uint8Array;
+}
+interface GridConfig {
+    width: number;
+    height: number;
+    /** Pre-filled grid data. Length must equal width * height. */
+    data?: Uint8Array;
+    /** Default cost for all cells when `data` is not provided. 0 = blocked, 1+ = walkable cost. Default 1. */
+    defaultCost?: number;
+}
+declare function createGrid(config: GridConfig): Grid;
+declare function inBounds(grid: Grid, x: number, y: number): boolean;
+declare function isWalkable(grid: Grid, x: number, y: number): boolean;
+declare function getCost(grid: Grid, x: number, y: number): number;
+declare function setWalkable(grid: Grid, x: number, y: number, walkable: boolean): void;
+declare function setCost(grid: Grid, x: number, y: number, cost: number): void;
+
+/**
+ * A* pathfinding on a Grid. Supports 4-directional and 8-directional movement
+ * with weighted costs. Uses a binary min-heap for the open set.
+ */
+
+interface PathResult {
+    /** Grid coordinates from start to end, inclusive. */
+    path: {
+        x: number;
+        y: number;
+    }[];
+    /** Total movement cost. */
+    cost: number;
+    /** Number of nodes explored. */
+    explored: number;
+}
+interface PathOptions {
+    /** Allow diagonal movement. Default: true. */
+    diagonal?: boolean;
+    /** Custom heuristic. Default: octile distance (diagonal) or Manhattan (4-dir). */
+    heuristic?: (ax: number, ay: number, bx: number, by: number) => number;
+    /** Max nodes to explore before giving up. Default: width * height. */
+    maxIterations?: number;
+}
+declare function manhattanDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function octileDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function chebyshevDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function euclideanDistance(ax: number, ay: number, bx: number, by: number): number;
+declare function findPath(grid: Grid, startX: number, startY: number, endX: number, endY: number, options?: PathOptions): PathResult | null;
+
+/**
+ * Jump Point Search — an optimization over A* for uniform-cost grids.
+ * Only works when all walkable tiles have cost 1. Falls back to A* behavior
+ * if weighted costs are detected.
+ *
+ * JPS prunes symmetric paths by "jumping" along directions until hitting
+ * a wall, the goal, or a forced neighbor.
+ */
+
+interface JpsOptions {
+    /** Max nodes to explore before giving up. Default: width * height. */
+    maxIterations?: number;
+    /** Custom heuristic. Default: octile distance. */
+    heuristic?: (ax: number, ay: number, bx: number, by: number) => number;
+}
+declare function findPathJPS(grid: Grid, startX: number, startY: number, endX: number, endY: number, options?: JpsOptions): PathResult | null;
+
+/**
+ * Lightweight navmesh pathfinding for polygon-based environments.
+ * Supports convex polygon navigation with A* over the polygon graph
+ * and the Simple Stupid Funnel Algorithm for path smoothing.
+ */
+
+interface NavMeshPolygon {
+    readonly id: number;
+    /** Convex polygon vertices in winding order. */
+    readonly vertices: readonly Vec2[];
+    /** Ids of neighboring polygons (sharing an edge). */
+    readonly neighbors: readonly number[];
+    /** Shared edge per neighbor: [neighborId] → { a, b } portal endpoints. */
+    readonly portals: readonly Portal[];
+}
+interface Portal {
+    /** Neighbor polygon id. */
+    neighborId: number;
+    /** Left endpoint of the shared edge (from the perspective of travel). */
+    a: Vec2;
+    /** Right endpoint of the shared edge. */
+    b: Vec2;
+}
+interface NavMesh {
+    readonly polygons: readonly NavMeshPolygon[];
+}
+interface NavMeshPathResult {
+    /** Smoothed world-space waypoints. */
+    path: Vec2[];
+    /** Polygon ids traversed. */
+    corridor: number[];
+}
+declare function createNavMesh(polygons: NavMeshPolygon[]): NavMesh;
+declare function findPolygonAt(mesh: NavMesh, x: number, y: number): number;
+declare function findNavMeshPath(mesh: NavMesh, start: Vec2, end: Vec2): NavMeshPathResult | null;
+
+export { type Grid, type GridConfig, type JpsOptions, type NavMesh, type NavMeshPathResult, type NavMeshPolygon, type PathOptions, type PathResult, type Portal, chebyshevDistance, createGrid, createNavMesh, euclideanDistance, findNavMeshPath, findPath, findPathJPS, findPolygonAt, getCost, inBounds, isWalkable, manhattanDistance, octileDistance, setCost, setWalkable };