@procedures/geo 0.6.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @procedures/geo
 
+## 0.8.0
+
+### Patch Changes
+
+- 715ce03: Two additions for maps and forecasts.
+  
+  - `@procedures/weather`: new `weatherCodeGroup(code)` gives the group of a WMO weather code, for example `clear`, `fog`, `rain-showers` or `thunderstorm`. It gives `undefined` for a code that Open-Meteo does not use.
+  - `@procedures/geo`: new Node entry `@procedures/geo/tiles` with `cachedTile`, `isTile`, `tileUrl` and `OSM_TILES`. `cachedTile` gets a map tile one time with a real `User-Agent`, keeps it in a folder, and gives the kept file after that. The root of the package stays safe for a browser.
+- Updated dependencies [4b09a03]
+- Updated dependencies [4b09a03]
+- Updated dependencies [aa6e3aa]
+- Updated dependencies [698e24d]
+- Updated dependencies [4b09a03]
+- Updated dependencies [600c497]
+- Updated dependencies [7c2e7f7]
+- Updated dependencies [90ea741]
+- Updated dependencies [c4cfa34]
+- Updated dependencies [d25805a]
+  - @procedures/client@0.8.0
+
+## 0.7.0
+
+### Minor Changes
+
+- 01dce14: The Web Mercator helpers of the slippy maps: `project(lat, lon, zoom)` gives the pixel of a point, `fitZoom(points, width, height)` the zoom that fits the points into a box, and `tilesFor(topLeft, width, height, zoom)` the tiles of a view. They are pure, so a browser bundle can use them.
+
+### Patch Changes
+
+- Updated dependencies [841d083]
+- Updated dependencies [389b054]
+  - @procedures/client@0.7.0
+
 ## 0.6.0
 
 ### Patch Changes

package/README.md

@@ -50,3 +50,22 @@ decodeGeohash("u09tunq"); // { south, west, north, east, center }
 ## The policy of the public servers
 
 The Nominatim policy permits at most one request each second. A `User-Agent` that names your application is necessary, so `geo.geocode` has the field `userAgent`. The OSRM demonstration server has a fair-use limit. Give `baseUrl` to use your own server of either kind.
+
+## Map tiles on disk
+
+The entry `@procedures/geo/tiles` is for Node only. The root of the package stays safe for a browser.
+
+```ts
+import { cachedTile, isTile } from "@procedures/geo/tiles";
+
+const tile = { z: 12, x: 1205, y: 1539 };
+if (isTile(tile)) {
+  const png = await cachedTile(tile, { dir: "var/tiles", userAgent: "my-app/1.0 (me@example.com)" });
+}
+```
+
+- `cachedTile` gets a tile from the server one time and keeps it as `<dir>/<z>/<x>/<y>.png`. After that, it gives the kept file without a request.
+- The default server is `OSM_TILES`, the standard tiles of OpenStreetMap. Their policy asks for a real `User-Agent` and for a cache, so `userAgent` is necessary.
+- The options `source`, `extension`, `timeoutMs`, `maxBytes` and `fetch` change the server, the file extension, the time limit, the largest tile and the fetch function.
+- An HTTP error, no answer, or a body larger than `maxBytes` throws an error, and nothing is kept. Each file is written to a temporary name and then renamed.
+- `isTile(tile, maxZoom)` tells if a tile exists at its zoom level. `tileUrl(template, tile)` fills `{z}`, `{x}` and `{y}`.