Switch to ESM-only entry point, drop transpiling and IE (#40)

* switch to ESM-only entry point

* readme updates

* clearer language

* try bigger API headings

* bring back smaller headings

* tiny cleanup

* replace broken bundlephobia badge with a static one

* adjust badge color

* readd rollup bundle for browser CDNs

* update cdn links

* cleanup

Author: mourner

.github/workflows/node.yml

@@ -1,11 +1,5 @@
 name: Node
-
-on:
-  push:
-    branches: ['*']
-  pull_request:
-    branches: [master]
-
+on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest

.gitignore

@@ -1,5 +1,4 @@
 flatbush.js
-flatbush.min.js
 yarn.lock
 pnpm-lock.yaml
 node_modules

LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2018, Vladimir Agafonkin
+Copyright (c) 2022, 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

README.md

@@ -13,7 +13,7 @@ Similar to [RBush](https://github.com/mourner/rbush), with the following key dif
 Supports geographic locations with the [geoflatbush](https://github.com/mourner/geoflatbush) extension.
 
 [![Build Status](https://github.com/mourner/flatbush/workflows/Node/badge.svg?branch=master)](https://github.com/mourner/flatbush/actions)
-[![minzipped size](https://badgen.net/bundlephobia/minzip/flatbush)](https://unpkg.com/flatbush)
+[![minzipped size](https://badgen.net/bundlephobia/minzip/flatbush)](https://esm.run/flatbush)
 [![Simply Awesome](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)
 
 ## Usage
@@ -46,42 +46,46 @@ const index = Flatbush.from(e.data);
 
 ## Install
 
-Install using NPM (`npm install flatbush`) or Yarn (`yarn add flatbush`), then:
+Install with NPM: `npm install flatbush`, then import as a module:
 
 ```js
-// import as an ES module
 import Flatbush from 'flatbush';
+```
+
+Or use as a module directly in the browser with [jsDelivr](https://www.jsdelivr.com/esm):
 
-// or require as a CommonJS module
-const Flatbush = require('flatbush');
+```html
+<script type="module">
+    import Flatbush from 'https://cdn.jsdelivr.net/npm/flatbush/+esm';
+</script>
 ```
 
-Or use a browser build directly:
+Alternatively, there's a browser bundle with a `Flatbush` global variable:
 
 ```html
-<script src="https://unpkg.com/flatbush@3.3.1/flatbush.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/flatbush"></script>
 ```
 
 ## API
 
-#### new Flatbush(numItems[, nodeSize, ArrayType])
+#### `new Flatbush(numItems[, nodeSize, ArrayType])`
 
 Creates a Flatbush index that will hold a given number of items (`numItems`). Additionally accepts:
 
 - `nodeSize`: size of the tree node (`16` by default); experiment with different values for best performance (increasing this value makes indexing faster and queries slower, and vise versa).
 - `ArrayType`: the array type used for coordinates storage (`Float64Array` by default);
 other types may be faster in certain cases (e.g. `Int32Array` when your data is integer).
 
-#### index.add(minX, minY, maxX, maxY)
+#### `index.add(minX, minY, maxX, maxY)`
 
 Adds a given rectangle to the index. Returns a zero-based, incremental number that represents the newly added rectangle.
 
-#### index.finish()
+#### `index.finish()`
 
 Performs indexing of the added rectangles.
 Their number must match the one provided when creating a `Flatbush` object.
 
-#### index.search(minX, minY, maxX, maxY[, filterFn])
+#### `index.search(minX, minY, maxX, maxY[, filterFn])`
 
 Returns an array of indices of items intersecting or touching a given bounding box. Item indices refer to the value returned by [`index.add()`](#indexaddminx-miny-maxx-maxy).
 
@@ -96,7 +100,7 @@ and only includes it if the function returned a truthy value.
 const ids = index.search(10, 10, 20, 20, (i) => items[i].foo === 'bar');
 ```
 
-#### index.neighbors(x, y[, maxResults, maxDistance, filterFn])
+#### `index.neighbors(x, y[, maxResults, maxDistance, filterFn])`
 
 Returns an array of item indices in order of distance from the given `x, y`
 (known as K nearest neighbors, or KNN). Item indices refer to the value returned by [`index.add()`](#indexaddminx-miny-maxx-maxy).
@@ -108,13 +112,13 @@ const ids = index.neighbors(10, 10, 5); // returns 5 ids
 `maxResults` and `maxDistance` are `Infinity` by default.
 Also accepts a `filterFn` similar to `index.search`.
 
-#### Flatbush.from(data)
+#### `Flatbush.from(data)`
 
 Recreates a Flatbush index from raw `ArrayBuffer` data
 (that's exposed as `index.data` on a previously indexed Flatbush instance).
 Very useful for transferring indices between threads or storing them in a file.
 
-#### Properties
+### Properties
 
 - `data`: array buffer that holds the index.
 - `minX`, `minY`, `maxX`, `maxY`: bounding box of the data.
@@ -125,14 +129,14 @@ Very useful for transferring indices between threads or storing them in a file.
 
 ## Performance
 
-Running `npm run bench` with Node v10.11.0:
+Running `node bench.js` with Node v14:
 
 bench | flatbush | rbush
 --- | --- | ---
-index 1,000,000 rectangles | 263ms | 1208ms
-1000 searches 10% | 594ms | 1105ms
-1000 searches 1% | 68ms | 213ms
-1000 searches 0.01% | 9ms | 27ms
-1000 searches of 100 neighbors | 29ms | 58ms
-1 search of 1,000,000 neighbors | 148ms | 781ms
-100,000 searches of 1 neighbor | 870ms | 1548ms
+index 1,000,000 rectangles | 273ms | 1143ms
+1000 searches 10% | 575ms | 781ms
+1000 searches 1% | 63ms | 155ms
+1000 searches 0.01% | 6ms | 17ms
+1000 searches of 100 neighbors | 24ms | 43ms
+1 search of 1,000,000 neighbors | 133ms | 280ms
+100,000 searches of 1 neighbor | 710ms | 1170ms

index.js

@@ -180,14 +180,14 @@ export default class Flatbush {
 
             // search through child nodes
             for (let pos = nodeIndex; pos < end; pos += 4) {
-                const index = this._indices[pos >> 2] | 0;
-
                 // check if node bbox intersects with query bbox
                 if (maxX < this._boxes[pos]) continue; // maxX < nodeMinX
                 if (maxY < this._boxes[pos + 1]) continue; // maxY < nodeMinY
                 if (minX > this._boxes[pos + 2]) continue; // minX > nodeMaxX
                 if (minY > this._boxes[pos + 3]) continue; // minY > nodeMaxY
 
+                const index = this._indices[pos >> 2] | 0;
+
                 if (nodeIndex < this.numItems * 4) {
                     if (filterFn === undefined || filterFn(index)) {
                         results.push(index); // leaf item

package.json

@@ -2,23 +2,23 @@
   "name": "flatbush",
   "version": "3.3.1",
   "description": "Fast static spatial index for rectangles",
+  "author": "Vladimir Agafonkin",
+  "license": "ISC",
+  "type": "module",
   "main": "flatbush.js",
   "module": "index.js",
-  "unpkg": "flatbush.min.js",
-  "jsdelivr": "flatbush.min.js",
+  "exports": "./index.js",
+  "sideEffects": false,
   "scripts": {
     "pretest": "eslint index.js test.js bench.js",
-    "test": "node -r esm test.js",
-    "bench": "node -r esm bench.js",
-    "build": "rollup -c",
+    "test": "node test.js",
+    "build": "rollup index.js -o flatbush.js -n Flatbush -f umd -p node-resolve",
     "prepublishOnly": "npm run build"
   },
   "files": [
     "index.js",
-    "flatbush.js",
-    "flatbush.min.js"
+    "flatbush.js"
   ],
-  "@std/esm": "js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mourner/flatbush.git"
@@ -34,25 +34,19 @@
     "rectangle",
     "search"
   ],
-  "author": "Vladimir Agafonkin",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/mourner/flatbush/issues"
+  "engines": {
+    "node": ">= 12.17.0"
+  },
+  "dependencies": {
+    "flatqueue": "^2.0.3"
   },
-  "homepage": "https://github.com/mourner/flatbush#readme",
   "devDependencies": {
-    "@rollup/plugin-buble": "^0.21.3",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "eslint": "^8.12.0",
     "eslint-config-mourner": "^3.0.0",
-    "esm": "^3.2.25",
     "rbush": "^3.0.1",
     "rbush-knn": "^3.0.1",
     "rollup": "^2.70.1",
-    "rollup-plugin-terser": "^7.0.2",
     "tape": "^5.5.2"
-  },
-  "dependencies": {
-    "flatqueue": "^1.2.1"
   }
 }