@gridworkjs/query 1.0.0 → 1.1.0

package/README.md

@@ -62,12 +62,12 @@ const primary = targets[0]?.item
 
 ### Ray - "What does this line hit?"
 
-Cast a ray from the player eastward. A bullet, a line of sight check, or a laser:
+Cast a ray from the player toward an enemy. A bullet, a line of sight check, or a laser:
 
 ```js
-const hits = ray(tree, { x: 100, y: 200 }, { x: 1, y: 0 })
-// => [{ item: { id: 'chest', ... }, distance: 5 },
-//     { item: { id: 'enemy-2', ... }, distance: 300 }]
+const hits = ray(tree, { x: 100, y: 200 }, { x: 1, y: 0.5 })
+// => [{ item: { id: 'chest', ... }, distance: 5.59 },
+//     { item: { id: 'enemy-1', ... }, distance: 22.36 }]
 
 const firstHit = hits[0]?.item
 ```
@@ -113,10 +113,10 @@ Cast a ray and find all items it intersects. Returns `{ item, distance }[]` sort
 
 ### `within(index, region)`
 
-Find all items fully contained within a region. Unlike `search()` which returns items that intersect, `within()` requires complete containment. Returns plain items (no distance annotation).
+Find all items fully contained within a region's bounding box. Unlike `search()` which returns items that intersect, `within()` requires complete containment. Returns plain items (no distance annotation).
 
 - `index` - any spatial index implementing the gridwork protocol
-- `region` - bounds object, or any gridwork geometry (point, rect, circle)
+- `region` - bounds object, or any gridwork geometry (point, rect, circle). Circles and other geometries are converted to their axis-aligned bounding box
 
 ## Works with Any Gridwork Index
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gridworkjs/query",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Higher-level spatial queries against any gridwork index",
   "type": "module",
   "main": "src/index.js",
@@ -38,7 +38,7 @@
     "@gridworkjs/core": "^1.0.0"
   },
   "devDependencies": {
-    "@gridworkjs/quadtree": "file:../quadtree",
+    "@gridworkjs/quadtree": "^1.1.0",
     "typescript": "^5.9.3"
   }
 }

package/src/knn.js

@@ -62,5 +62,6 @@ export function knn(index, point, k, options) {
     }
   }
 
+  results.sort((a, b) => a.distance - b.distance)
   return results
 }

package/src/ray.js

@@ -24,11 +24,11 @@ export function ray(index, origin, direction, options) {
   const dx = direction.x / len
   const dy = direction.y / len
 
-  const maxDist = (options && options.maxDistance) || Infinity
   if (options && options.maxDistance !== undefined) {
     validateFiniteNumber(options.maxDistance, 'maxDistance')
     if (options.maxDistance < 0) throw new Error('maxDistance must be non-negative')
   }
+  const maxDist = (options && options.maxDistance !== undefined) ? options.maxDistance : Infinity
 
   const indexBounds = index.bounds
   if (!indexBounds) return []
@@ -55,9 +55,11 @@ export function ray(index, origin, direction, options) {
 function raySearchBounds(origin, dx, dy, maxDist, indexBounds) {
   let endDist = maxDist
   if (!Number.isFinite(endDist)) {
-    const w = indexBounds.maxX - indexBounds.minX
-    const h = indexBounds.maxY - indexBounds.minY
-    endDist = Math.sqrt(w * w + h * h) * 2
+    const farX = dx >= 0 ? indexBounds.maxX : indexBounds.minX
+    const farY = dy >= 0 ? indexBounds.maxY : indexBounds.minY
+    const dfx = farX - origin.x
+    const dfy = farY - origin.y
+    endDist = Math.sqrt(dfx * dfx + dfy * dfy) * 1.5
   }
 
   const endX = origin.x + dx * endDist