@tileflow/core 0.1.0-alpha.35 → 0.1.0-alpha.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -38,9 +38,8 @@ export default defineMap({
38
38
  });
39
39
  ```
40
40
 
41
- Coordinates use `[longitude, latitude]`. The map inherits Streets' themes and asset providers.
42
- A complete root map uses the same `defineMap()` call without `extends`; most applications should
43
- extend an existing map instead of rebuilding its complete visual contract.
41
+ Coordinates use `[longitude, latitude]`. This map inherits Streets' themes and assets.
42
+ A standalone map uses `defineMap()` without `extends`.
44
43
 
45
44
  Validate and preview the file with the project-local CLI:
46
45
 
@@ -101,8 +100,8 @@ Metadata-free RGBA icon packages retain `tileflow-icon-package-v1` identity. SDF
101
100
 
102
101
  These are portable contracts. `@tileflow/dev` composes declared contributors on its normal
103
102
  preparation path, and the `tileflow` CLI owns catalog management and exact lock maintenance.
104
- Importing `iconSet` adds a declaration; it performs no I/O, resolves no revision, and does not by
105
- itself make a Team catalog available to your deployment.
103
+ Importing `iconSet` adds a declaration; it resolves no revision and does not by itself make a
104
+ Team catalog available to your deployment.
106
105
 
107
106
  ## Style with themes and semantic modules
108
107
 
@@ -139,8 +138,8 @@ export default defineMap({
139
138
  `system` is a runtime selection policy, not a stored theme. Builds, captures, static scenes, and
140
139
  receipts must use a concrete theme such as `light` or `dark`.
141
140
 
142
- Because every theme of a map shares one structure, a browser map can cross-fade between themes or
143
- show a continuous blend of them on the same MapLibre instance, with no extra requests. See
141
+ Every theme of a map shares one structure, so a browser map can cross-fade or blend themes on one
142
+ MapLibre instance without extra requests. See
144
143
  [theme transitions, time-of-day presets and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md).
145
144
  The same controller can make chosen modules recede and the map's labels fade so an application's
146
145
  own content reads first; see [map emphasis](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-emphasis.md).
@@ -158,12 +157,11 @@ A theme can describe its sun and sky light (`lighting.sun`, `lighting.ambient`);
158
157
  returns the sun the map shows with `getSun()`, mixed during a blend, for an application's own 3D
159
158
  layers, and `setSun()` places it by direction or by the real sun of a date and place; see
160
159
  [sun and light](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/sun-and-light.md).
161
- `createTileflowBuildings3D` raises the map's buildings with their authored colours and native
162
- extrusion lighting. Height changes are immediate by default; scene sun lighting, shadows,
163
- illuminated edges, colour variation, night lights and animation are explicit options; see
160
+ `createTileflowBuildings3D` enables worker-meshed buildings fading in at zoom 15–15.25, with scene
161
+ sun, cast/contact shadows and 0.8 m rounded corners. Each effect is independently overridable. See
164
162
  [3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/buildings-3d.md).
165
- `createTileflowStreetLights` lights the streets as the sun sets, from the lamps and lit streets the
166
- map's data holds; see
163
+ Street lights default to off, including in Streets. Set `roads.streetLights.enabled: true` and mount
164
+ `createTileflowStreetLights` to enable them; see
167
165
  [street lights](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-lights.md).
168
166
  `createTileflowVegetation` controls all trees using the map's `3d`, `flat` or `auto` policy; see
169
167
  [vegetation controls and 3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md).
@@ -184,15 +182,14 @@ validates the authoring input and throws on failure. `createStyle(map, options)`
184
182
  throws; `createStyleResult(map, options)` returns structured diagnostics and a compilation report.
185
183
  Only a successful result contains `style`.
186
184
 
187
- Core compilation is not asset preparation. A map that references package or local icon/font
188
- directories needs the CLI, a build plugin, or
185
+ Maps with package/local icon or font directories need the CLI, a build plugin, or
189
186
  [`@tileflow/dev/artifacts`](https://github.com/tileflow/tileflow-sdk/blob/main/packages/dev/README.md)
190
- to produce deployable sprites and font files. Browser components consume the resulting manifest;
191
- they do not import executable configs.
187
+ to prepare assets. Browser components consume the resulting manifest.
192
188
 
193
- Use these commands to discover the installed language and inspect a prepared map:
189
+ Discover the language and inspect a prepared map:
194
190
 
195
191
  ```sh
192
+ npx tileflow describe themes --json
196
193
  npx tileflow language manifest --json
197
194
  npx tileflow language schema --json
198
195
  npx tileflow inspect --json
@@ -239,11 +236,11 @@ package uses this contract for its mounted Map; it is not yet published.
239
236
  ## Data, terrain, and browser resources
240
237
 
241
238
  Tileflow World is the hosted primary source. `vectorTiles()` with `openMapTiles()` supports
242
- external local/self-hosted data; hosted eligibility is separate. `hostedTileset()` and semantic
243
- overlays add named sources. Local PMTiles inputs are tooling-only.
239
+ external local/self-hosted data; hosted eligibility is separate. `hostedTileset()`, `boundaryAreas`
240
+ and semantic overlays add named sources. Local PMTiles inputs are tooling-only.
244
241
 
245
- `bathymetry({vectorLayers: {...}})` declares compatible contour/name layers; omission retains
246
- legacy band geometry.
242
+ `bathymetry({vectorLayers: {...}})` declares compatible contour/name layers. `marine: 'nautical'`
243
+ adds navigation marks and a "Not for navigation" notice.
247
244
 
248
245
  World attribution links to Tileflow's source notice, OpenMapTiles, and OpenStreetMap. External
249
246
  vector data retains the attribution supplied by its owner.
@@ -257,9 +254,9 @@ before loading a style. See the
257
254
 
258
255
  Set `projection: 'globe'` and `atmosphere: true` in `tileflow.config.ts` for a blue globe rim,
259
256
  space background, and stars. Use `atmosphere: false` to disable an inherited atmosphere, or an
260
- options object for theme-aware colors and bounded star brightness/motion. React, Vue, Svelte, and
261
- standalone capture apply the browser effect automatically. Direct MapLibre integrations call
262
- `attachTileflowAtmosphere(map)` from `@tileflow/core/browser`. See
257
+ options object for theme-aware colors and bounded star brightness/motion. Frameworks and capture
258
+ apply it; direct MapLibre integrations call `attachTileflowAtmosphere(map)` from
259
+ `@tileflow/core/browser`. See
263
260
  [globe atmosphere](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/globe-atmosphere.md).
264
261
 
265
262
  Applications that need the map's data themselves, such as streets to route over or the place
@@ -271,8 +268,8 @@ In a 3D scene, `createTileflowDepthMarkers` from `@tileflow/core/browser` draws
271
268
  that nearer buildings hide, facing the viewer or lying on the ground. See
272
269
  [depth markers](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/depth-markers.md).
273
270
 
274
- A map with text must declare exactly one text provider. Streets, Ferraris, Härad, Soundings,
275
- and Blueprint use URL glyph providers. Baedeker and Siegfried use packaged Cormorant
271
+ A map with text must declare exactly one text provider. Streets, Soundings,
272
+ and Blueprint use URL glyph providers. Baedeker, 1777, and Siegfried use packaged Cormorant
276
273
  fonts, and Cívica uses its packaged lettering. Hosted deployment currently rejects
277
274
  package/local font bundles; use self-hosted output or explicitly replace the provider with compatible
278
275
  public glyphs. Tile URLs and font providers do not establish redistribution rights.
@@ -288,8 +285,8 @@ for exact options. Prefer the installed CLI's generated contracts when using a p
288
285
 
289
286
  ## Detailed guides
290
287
 
291
- These guides are also included in the installed package under `docs/`. They describe this source
292
- revision; prefer the installed copy when working with an older release.
288
+ These guides also ship in the installed package under `docs/` and describe this source revision;
289
+ prefer the installed copy for an older release.
293
290
 
294
291
  - [Globe atmosphere](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/globe-atmosphere.md)
295
292
  - [Map and terrain examples](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-and-terrain-examples.md)
@@ -297,6 +294,7 @@ revision; prefer the installed copy when working with an older release.
297
294
  - [Shared visual primitives](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/shared-visual-primitives.md)
298
295
  - [Compiled-style performance](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/compiled-style-performance.md)
299
296
  - [Camera moves and the tile cache](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/camera-moves-and-tile-cache.md)
297
+ - [Cartographic defaults and overrides](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/cartographic-defaults.md)
300
298
  - [Themes and module styles](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/themes-and-module-styles.md)
301
299
  - [Theme transitions and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md)
302
300
  - [Map emphasis](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-emphasis.md)
@@ -306,6 +304,8 @@ revision; prefer the installed copy when working with an older release.
306
304
  - [3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/buildings-3d.md)
307
305
  - [Street lights](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-lights.md)
308
306
  - [3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md)
307
+ - [Boundary areas and choropleths](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/boundary-areas-and-choropleths.md)
308
+ - [Nautical marks](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/nautical-marks.md)
309
309
  - [Data is separate from design](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/data-is-separate-from-design.md)
310
310
  - [Capture scenes](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/capture-scenes.md)
311
311
  - [Capture shots](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/capture-shots.md)