map-zero 0.1.0 → 0.2.0

package/README.md

@@ -54,6 +54,16 @@ Build a package:
 node src/cli.js build ./data/madrid.osm.pbf --out ./madrid.mapzero
 ```
 
+Or build the complete static package directly from a bbox:
+
+```bash
+node src/cli.js from-bbox \
+  --bbox -3.9,40.3,-3.5,40.6 \
+  --out ./madrid.mapzero
+```
+
+`from-bbox` downloads and caches the smallest Geofabrik `.osm.pbf` extract that fully contains the bbox, then runs `build`, `pmtiles`, `3dtiles`, and `package`. The source PBF cache defaults to `~/.cache/map-zero/osm`.
+
 Serve it:
 
 ```bash
@@ -118,7 +128,7 @@ Export Cesium-ready 3D Tiles:
 node src/cli.js 3dtiles ./madrid.mapzero
 ```
 
-Buildings are extruded. Roads, railways, boundaries, water, landuse, and AIP/aeronautical features are exported as flat cartographic meshes. The Cesium viewer is available at:
+Buildings are extruded into streamed Cesium tiles. The default subdivision is tuned for dense cities like Madrid; use `--max-depth` and `--max-features` only when you need coarser or finer tiles. Roads, railways, boundaries, water, landuse, and AIP/aeronautical features are exported as flat cartographic meshes when requested with `--layers`. The Cesium viewer is available at:
 
 ```text
 http://localhost:8080/cesium
@@ -126,8 +136,27 @@ http://localhost:8080/cesium
 
 3D Tiles are also static files. Once exported, they do not need the map-zero Node server; Cesium can load them from any normal static web server.
 
+The Cesium PMTiles context overlay uses a module worker plus `OffscreenCanvas`;
+there is no main-thread rasterization fallback.
+
 Use `map-zero serve` to preview the Cesium output locally; use static hosting to publish the exported `3dtiles/` folder.
 
+## Portable ZIP
+
+Create a zip ready to copy into an app:
+
+```bash
+node src/cli.js package ./madrid.mapzero
+```
+
+By default this writes `madrid.mapzero.zip` next to the package and includes `manifest.json`, the styles referenced by the manifest, `tiles.pmtiles`, and `3dtiles/`. The source GeoPackage is excluded because static OpenLayers/Cesium consumers do not need it.
+
+Include `data.gpkg` explicitly when you want to keep the source package data in the archive:
+
+```bash
+node src/cli.js package ./madrid.mapzero --include-gpkg
+```
+
 ## OpenLayers Usage
 
 Use `@map-zero/ol` to add a package to an existing OpenLayers map:
@@ -168,7 +197,7 @@ const viewer = new Viewer('cesiumContainer');
 const controller = await addMapZeroToCesium(viewer, {
   id: 'huelva',
   manifestUrl: './huelva.mapzero/manifest.json',
-  style: 'cesium'
+  style: 'default'
 });
 
 controller.setOpacity('buildings', 0.8);

package/docs/cesium.md

@@ -11,7 +11,7 @@ const viewer = new Viewer('cesiumContainer');
 const controller = await addMapZeroToCesium(viewer, {
   id: 'huelva',
   manifestUrl: './huelva.mapzero/manifest.json',
-  style: 'cesium'
+  style: 'default'
 });
 ```
 
@@ -21,15 +21,13 @@ const controller = await addMapZeroToCesium(viewer, {
 node src/cli.js 3dtiles ./huelva.mapzero
 ```
 
-By default, the exporter writes all supported 3D layers:
+By default, the exporter writes the building 3D Tiles layer:
 
 - `buildings`
-- `landuse`
-- `water`
-- `aip`
-- `railways`
-- `roads`
-- `boundaries`
+
+The default tiling uses `--max-depth 8 --max-features 1500`, which keeps dense
+city exports split into smaller b3dm files so Cesium can stream and cull them
+instead of parsing a few very large tiles.
 
 Use `--layers` for a smaller export:
 
@@ -54,11 +52,28 @@ Optional tactical defaults:
 ```js
 await addMapZeroToCesium(viewer, {
   manifestUrl: './huelva.mapzero/manifest.json',
-  style: 'cesium',
+  style: 'default',
   applyDefaultSceneStyle: true
 });
 ```
 
+The Cesium PMTiles context overlay rasterizes in a module worker with
+`OffscreenCanvas`. Browsers must support `Worker`, `OffscreenCanvas`, and
+`createImageBitmap`; there is no main-thread rasterization fallback.
+
+The worker is exported as `@map-zero/cesium/imagery-worker.js`. Most bundlers
+can copy or fingerprint that file and pass the final URL to the helper:
+
+```js
+await addMapZeroToCesium(viewer, {
+  manifestUrl: './huelva.mapzero/manifest.json',
+  contextWorkerUrl: new URL('@map-zero/cesium/imagery-worker.js', import.meta.url)
+});
+```
+
+If your framework uses a different asset convention, resolve the worker however
+that framework expects and pass the resulting URL as `contextWorkerUrl`.
+
 You can also provide your own scene hook:
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "map-zero",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Offline vector map packages from OSM, ready for GeoPackage, PMTiles, and 3D Tiles.",
   "type": "module",
   "license": "MIT",
@@ -10,7 +10,7 @@
   "scripts": {
     "dev": "node src/cli.js --help",
     "start": "node src/cli.js",
-    "check": "node --check src/cli.js && node --check src/build.js && node --check src/osm.js && node --check src/gpkg.js && node --check src/gpkg-read.js && node --check src/geometry-read.js && node --check src/html.js && node --check src/server.js && node --check src/mvt.js && node --check src/pmtiles.js && node --check src/pmtiles-worker.js && node --check src/export-pmtiles.js && node --check src/3dtiles/b3dm.js && node --check src/3dtiles/glb.js && node --check src/3dtiles/extrude.js && node --check src/3dtiles/flat.js && node --check src/3dtiles/clipper-surfaces.js && node --check src/3dtiles/gpkg-buildings.js && node --check src/3dtiles/gpkg-features.js && node --check src/3dtiles/tileset.js && node --check src/3dtiles/export.js && node --check test-3dtiles/generate-clipper-roads.mjs && node --check test-3dtiles/generate-clipper-roads-from-gpkg.mjs && node --check src/tile-cache.js && node --check src/style-filters.js && node --check src/style-command.js && node --check src/style-presets.js && node --check src/style-themes.js && node --check src/ol.js && node --check packages/ol/src/index.js && node --check packages/ol/src/labels.js && node --check packages/cesium/src/index.js && node --check src/layers.js && node --check src/style.js && node --check src/manifest.js && node --check src/utils.js"
+    "check": "node --check src/cli.js && node --check src/build.js && node --check src/osm.js && node --check src/gpkg.js && node --check src/gpkg-read.js && node --check src/geometry-read.js && node --check src/html.js && node --check src/server.js && node --check src/mvt.js && node --check src/pmtiles.js && node --check src/pmtiles-worker.js && node --check src/export-pmtiles.js && node --check src/package.js && node --check src/from-bbox.js && node --check src/3dtiles/b3dm.js && node --check src/3dtiles/glb.js && node --check src/3dtiles/extrude.js && node --check src/3dtiles/flat.js && node --check src/3dtiles/clipper-surfaces.js && node --check src/3dtiles/gpkg-buildings.js && node --check src/3dtiles/gpkg-features.js && node --check src/3dtiles/tileset.js && node --check src/3dtiles/export.js && node --check test-3dtiles/generate-clipper-roads.mjs && node --check test-3dtiles/generate-clipper-roads-from-gpkg.mjs && node --check src/tile-cache.js && node --check src/style-filters.js && node --check src/style-command.js && node --check src/style-presets.js && node --check src/style-themes.js && node --check src/ol.js && node --check packages/ol/src/index.js && node --check packages/ol/src/labels.js && node --check packages/cesium/src/index.js && node --check packages/cesium/src/imagery.js && node --check packages/cesium/src/imagery-worker.js && node --check src/layers.js && node --check src/style.js && node --check src/manifest.js && node --check src/utils.js"
   },
   "engines": {
     "node": ">=20"
@@ -41,6 +41,7 @@
     "commander": "^14.0.0",
     "earcut": "^3.0.2",
     "fastify": "^5.8.5",
+    "fflate": "^0.8.2",
     "geojson-vt": "^4.0.2",
     "js-angusj-clipper": "^1.3.1",
     "osm-pbf-parser": "^2.3.0",

package/packages/cesium/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@map-zero/cesium",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "Cesium integration helper for map-zero 3D Tiles packages.",
   "main": "./src/index.js",
   "exports": {
-    ".": "./src/index.js"
+    ".": "./src/index.js",
+    "./imagery-worker.js": "./src/imagery-worker.js"
   },
   "peerDependencies": {
-    "cesium": "^1.141.0"
+    "cesium": "^1.141.0",
+    "ol": "^10.9.0",
+    "pmtiles": "^4.4.1"
   }
 }