@tileflow/core 0.1.0-alpha.4 → 0.1.0-alpha.41

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,34 +1,326 @@
 # @tileflow/core
 
-Typed Tileflow config helpers and the MapLibre style compiler.
+Define, validate, and compile Tileflow maps into MapLibre Style JSON. Core owns the map language;
+it does not start a server, prepare files on disk, render a browser map, or deploy a hosted map.
+
+> Related packages and guides: [documentation index](https://raw.githubusercontent.com/tileflow/tileflow-sdk/main/llms.txt).
+
+## Install
+
+```sh
+npm install @tileflow/core@alpha @tileflow/maps@alpha
+```
+
+`@tileflow/maps` is needed for the official map used below, not for every Core application. Use
+ES module imports. For config loading and asset preparation, use the Node.js 22+ CLI or a build
+integration. Browser applications should use a framework adapter with prepared assets.
+
+## Define a map
+
+Create `tileflow.config.ts`. Every public config exports one map:
+
+<!-- docs:check -->
 
 ```ts
-import {defineTileflow, osm, roads} from '@tileflow/core';
-
-export default defineTileflow({
-  themes: {
-    light: {
-      mode: 'light',
-      colors: {
-        water: '#8ED6E8',
-        park: '#C3F1D5',
-        road: '#D8E0E7',
-        text: '#566371',
-      },
-    },
-  },
-  maps: {
-    madrid: {
-      basemap: osm(),
-      theme: 'light',
-      modules: [roads({preset: 'modern', density: 'balanced'})],
-      view: {
-        center: [-3.7038, 40.4168],
-        zoom: 12,
-      },
-    },
+import {defineMap, labels, roads} from '@tileflow/core';
+import {streets} from '@tileflow/maps';
+
+export default defineMap({
+  id: 'madrid',
+  name: 'Madrid',
+  version: 1,
+  extends: streets,
+  modules: {
+    roads: roads({detail: 'streets', hierarchy: 'clear'}),
+    labels: labels({roads: 'major'}),
   },
+  view: {center: [-3.7038, 40.4168], zoom: 12},
+});
+```
+
+Coordinates use `[longitude, latitude]`. This map inherits Streets' themes and assets.
+A standalone map uses `defineMap()` without `extends`.
+
+Validate and preview the file with the project-local CLI:
+
+```sh
+npm install --save-dev --save-exact tileflow@alpha
+npx tileflow validate --json
+npx tileflow preview
+```
+
+Loading a config executes its imports. Treat it as trusted code, not as sandboxed JSON.
+
+## Understand inheritance
+
+Omitted fields inherit, but declaring a field does not imply a recursive merge:
+
+- `view` deep-merges; nested arrays replace.
+- `modules` merges by domain. Declaring `roads(...)` replaces that domain's inherited request and
+  render contributions. Use `refine(...)` to patch it, `disable()` to remove it, and `reset()` for
+  an explicit reset inside a supported patch.
+- `themes` replaces the complete collection and clears inherited `systemThemes` and `timeOfDay` mappings.
+  `defaultTheme` can select an inherited concrete theme; `systemThemes` replaces its complete mapping.
+- `icons` replaces the ordered contributor list. Omission inherits it; `[]` disables it. Local and
+  package directories can be combined with explicit locked `iconSet('@team/set')` descriptors.
+  Spread the parent's list explicitly when composing contributors. Later contributors win for an
+  exact icon ID.
+- `fonts` and `glyphs` are mutually exclusive text providers. Declaring either replaces the inherited
+  provider. `atmosphere`, `data`, `projection`, `sky`, `terrain`, and `marine` are also atomic.
+
+Identity (`id`, `name`, `version`) and tooling `scenes` and `shots` belong to the leaf map and do not inherit.
+Module object order does not determine rendering order. See the
+[map inheritance contract](https://github.com/tileflow/tileflow-sdk/blob/main/docs/contracts/map-inheritance.md)
+for the complete merge rules.
+
+## Team Icon Sets foundations
+
+`iconSet('@team/set')` is an explicit icon contributor alongside local and package-owned directories.
+It performs no I/O. A resolved map accepts at most 32 contributors, and the same set reference may
+appear only once. Shared sets use the same explicit array order and later-wins semantics as ordinary
+icon directories.
+
+An exact `tileflow.icons.lock.json` identifies immutable set revisions and generated artifacts. The
+lock parser rejects duplicate JSON keys, stale reference sets, mixed Teams, invalid IDs, floating
+versions, unsafe URLs, and manifest/hash mismatches. Serialization is canonical. Hashes are internal
+integrity machinery, not identifiers that application authors manage.
+
+Shared-set content identifies the effective published artifact. Git owns original artwork history;
+source-only SVG edits producing the same artifact are not shared content changes. No original-source
+hash, source format, or filesystem path is added to a shared package. Local/package originals retain
+their existing source identity. Shared winners use explicit `rendered-icon` identity, while an
+ordered versioned icon-composition receipt records consumed revisions separately, including
+fully shadowed sets and dependency changes that preserve rendered pixels.
+
+Map revision hashing preserves the existing v1 result for maps without shared sets. Maps with sets
+require a complete receipt and use the domain-separated v2 revision contract. Build-manifest map
+entries identify that contract with `mapRevisionSchemaVersion: 2`; omission means legacy v1. The
+Metadata-free RGBA icon packages retain `tileflow-icon-package-v1` identity. SDF appearance or text-fitting metadata uses
+`tileflow-icon-package-v2` and v2 composition receipts; defaults and layout participate in identity.
+
+These are portable contracts. `@tileflow/dev` composes declared contributors on its normal
+preparation path, and the `tileflow` CLI owns catalog management and exact lock maintenance.
+Importing `iconSet` adds a declaration; it resolves no revision and does not by itself make a
+Team catalog available to your deployment.
+
+## Style with themes and semantic modules
+
+Themes are complete appearance documents, not loose color overrides. Every theme must supply the
+same token schema. Use `token.color(...)`, `token.number(...)`, `token.image(...)`, and typed font
+roles for theme-dependent values. Use `fixed(value, {reason})` for an intentionally invariant visual
+value. Structural controls, such as visibility and zoom gates, remain ordinary literals.
+
+Extend a theme without changing the inherited map structure:
+
+<!-- docs:check -->
+
+```ts
+import {defineMap, defineTheme} from '@tileflow/core';
+import {streets, streetsThemes} from '@tileflow/maps';
+
+const dark = defineTheme(streetsThemes.dark, {
+  id: 'madrid-dark',
+  version: 1,
+  colorScheme: 'dark',
+  tokens: {color: {'surface.land': '#0d1320', 'surface.water': '#081e2e'}},
+});
+
+export default defineMap({
+  id: 'madrid',
+  version: 1,
+  extends: streets,
+  themes: {light: streetsThemes.light, dark},
+  defaultTheme: 'light',
+  systemThemes: {light: 'light', dark: 'dark'},
 });
 ```
 
-Docs: https://tileflow.dev/docs
+`system` is a runtime selection policy, not a stored theme. Builds, captures, static scenes, and
+receipts must use a concrete theme such as `light` or `dark`.
+
+Theme and `timeOfDay` changes animate over 450 ms by default, respecting reduced motion. See
+[theme transitions, time-of-day presets and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md).
+The same controller can make chosen modules recede and the map's labels fade so an application's
+own content reads first; see [map emphasis](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-emphasis.md).
+It also sets the style-wide states that themes read with `expr.globalState`, easing numbers so the
+values a theme interpolates on them move smoothly; see
+[style states](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/style-states.md).
+For application-drawn RGBA symbols, it also manages fixed-size
+[dynamic style images](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/dynamic-style-images.md),
+including state refresh, theme changes and restoration without changing layer placement.
+Applications draw their own routes in the theme's inks, read with `getRouteInks()`, and draw them
+on with `createTileflowLineProgress`. `createTileflowGroundLayers` keeps them under 3D buildings,
+which hide them where they stand in front, and can show the hidden stretches faintly; see
+[route drawing](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/route-drawing.md).
+A theme can describe its sun and sky light (`lighting.sun`, `lighting.ambient`); the controller
+returns the sun the map shows with `getSun()`, mixed during a blend, for an application's own 3D
+layers, and `setSun()` places it by direction or by the real sun of a date and place; see
+[sun and light](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/sun-and-light.md).
+`createTileflowBuildings3D` enables worker-meshed buildings rising in at zoom 15–15.3, with scene
+sun, cast/contact shadows and 0.8 m rounded corners. Each effect is independently overridable. See
+[3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/buildings-3d.md).
+Street lights default to off, including in Streets. Set `roads.streetLights.enabled: true` and mount
+`createTileflowStreetLights` to enable them; see
+[street lights](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-lights.md).
+`createTileflowVegetation` controls all trees using the map's `3d`, `flat` or `auto` policy; see
+[vegetation controls and 3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md).
+
+Labels use native placement. POI icons and names place together by default;
+`placement.coupleIconAndLabel: false` separates them.
+
+The semantic domains are `land`, `water`, `nautical`, `roads`, `buildings`, `boundaries`, `labels`,
+`poi`, `aeroways`, `transit`, `vegetation`, `addresses`, and `landforms`. Style stable geographic
+targets rather than compiler-generated MapLibre layer IDs. Shared primitives cover fills, lines,
+text, icons, circles, and extrusions. `zoom.*` supplies zoom curves; `expr.*` and `field(...)` supply
+the closed data-expression language. `renderPass`, `refineRenderTarget`, and `withRenderStack` add
+owner-local rendering behavior without bypassing the compiler. A pass, or a target its module moves,
+is placed at a band edge such as `'above-relief'` or `'below-labels'`, or `{above}` / `{below}` one
+semantic target.
+
+## Compile and inspect
+
+`validateTileflowMap(input)` returns `{valid, messages}`. `parseTileflowMap(map)` resolves and
+validates the authoring input and throws on failure. `createStyle(map, options)` returns a style or
+throws; `createStyleResult(map, options)` returns structured diagnostics and a compilation report.
+Only a successful result contains `style`.
+
+Maps with package/local icon or font directories need the CLI, a build plugin, or
+[`@tileflow/dev/artifacts`](https://github.com/tileflow/tileflow-sdk/blob/main/packages/dev/README.md)
+to prepare assets. Browser components consume the resulting manifest.
+
+Discover the language and inspect a prepared map:
+
+```sh
+npx tileflow describe themes --json
+npx tileflow language manifest --json
+npx tileflow language schema --json
+npx tileflow inspect --json
+npx tileflow explain --theme dark --json
+npx tileflow semantic-diff --from-config before/tileflow.config.ts --to-config after/tileflow.config.ts --json
+```
+
+The language manifest is also exported as `tileflowAuthoringManifest`, with
+`tileflowAuthoringManifestSchemaVersion`. The generated schema distinguishes authoring input from
+resolved compiler input. `diffTileflowMaps(before, after)` returns deterministic semantic changes
+at JSON Pointer paths. Physical inspection IDs and indexes are diagnostic observations, not stable
+application targets.
+
+## Select a prepared map
+
+React, Vue and Svelte accept a required `source` object, `{map, manifestUrl?}`. `map` is the portable
+name in the manifest, not a Hosted `map_...` identifier. An omitted web `manifestUrl` means exactly
+`/tileflow/manifest.json`; custom paths and external hosts must be explicit. The native Core and
+React Native type contracts use `{map, manifestUrl}` with an explicit absolute URL. They do not
+infer an application origin, Metro host or manifest location.
+
+<!-- docs:check -->
+
+```ts
+import type {TileflowNativeSource} from '@tileflow/core/native';
+import type {TileflowRuntimeSource} from '@tileflow/core/runtime';
+
+const webSource = {map: 'madrid'} satisfies TileflowRuntimeSource;
+const nativeSource = {
+  map: 'madrid',
+  manifestUrl: 'https://maps.example.com/tileflow/native/manifest.json',
+} satisfies TileflowNativeSource;
+```
+
+These objects select existing prepared maps; they do not compile or render one. Every Tileflow
+framework Map is manifest-backed, without a renderer discriminator or direct-style mode. The
+obsolete source fields `kind` and `style` are rejected. Completely unmanaged maps use upstream
+MapLibre directly. Omitted themes use the manifest default, concrete themes select exact names,
+and `system` requires the manifest's explicit light/dark mapping and a supplied runtime color scheme.
+See the [native source guide](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/native-resource-urls.md)
+for source coordination, bounded acquisition and safe diagnostics. The pre-release React Native
+package uses this contract for its mounted Map; it is not yet published.
+
+## Data, terrain, and browser resources
+
+Tileflow World is the hosted primary source. `vectorTiles()` with `openMapTiles()` supports
+external local/self-hosted data; hosted eligibility is separate. `hostedTileset()`, `boundaryAreas`
+and semantic overlays add named sources. Local PMTiles inputs are tooling-only.
+
+`bathymetry({vectorLayers: {...}})` declares contour/name layers. `marine: 'nautical'` adds
+navigation marks, flashing lights, and a "Not for navigation" notice.
+
+World attribution links to Tileflow's source notice, OpenMapTiles, and OpenStreetMap. External
+vector data retains the attribution supplied by its owner.
+
+`projection` accepts `mercator` or `globe`. Terrain supports `none`, `hillshade`, `3d`, and an object
+form for explicit hillshade and contour configuration. Browser-derived contours require a DEM tile
+template, zoom limits, thresholds, and the Tileflow contour protocol. Framework adapters and local
+tooling prepare browser resources; direct MapLibre integrations must register required protocols
+before loading a style. See the
+[browser runtime contract](https://github.com/tileflow/tileflow-sdk/blob/main/docs/contracts/framework-browser-runtime.md).
+
+With `projection: 'globe'`, `atmosphere: true` adds a halo and stars; an object configures colors, star count and size.
+`sky` follows the sun at street level. Frameworks and capture attach both; direct
+MapLibre consumers call `attachTileflowAtmosphere(map)` from `@tileflow/core/browser`.
+See
+[globe atmosphere](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/globe-atmosphere.md)
+and [street sky](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-sky.md).
+
+Applications that need the map's data themselves, such as streets to route over or the place
+under the camera, read chosen layers of a vector source for an area at a fixed zoom with
+`createTileflowTileReader` from `@tileflow/core/browser`, which also runs in a module worker. See
+[application tile reading](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/application-tile-reading.md).
+
+In a 3D scene, `createTileflowDepthMarkers` from `@tileflow/core/browser` draws application markers
+that nearer buildings hide, facing the viewer or lying on the ground. See
+[depth markers](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/depth-markers.md).
+
+Text requires exactly one provider. Soundings and Blueprint use URL glyphs; Streets packages DINish
+and Noto Sans; Baedeker, 1777 and Siegfried package Cormorant; Cívica packages its lettering. Hosted
+rejects packaged/local fonts: self-host or replace them with compatible public glyphs. Tile and font
+URLs do not grant redistribution rights.
+
+## Reference
+
+Use the [generated language schema](https://github.com/tileflow/tileflow-sdk/blob/main/docs/modules-api-reference.json),
+[cartographic authoring contract](https://github.com/tileflow/tileflow-sdk/blob/main/docs/contracts/cartographic-authoring.md),
+and [public exports](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/src/index.ts)
+for exact options. Prefer the installed CLI's generated contracts when using a published release;
+`main` can contain unreleased changes. Report defects in the
+[issue tracker](https://github.com/tileflow/tileflow-sdk/issues).
+
+## Detailed guides
+
+These guides also ship in the installed package under `docs/` and describe this source revision;
+prefer the installed copy for an older release.
+
+- [Globe atmosphere](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/globe-atmosphere.md)
+- [Map and terrain examples](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-and-terrain-examples.md)
+- [Authoring model](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/authoring-model.md)
+- [Shared visual primitives](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/shared-visual-primitives.md)
+- [Compiled-style performance](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/compiled-style-performance.md)
+- [Camera moves and the tile cache](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/camera-moves-and-tile-cache.md)
+- [Cartographic defaults and overrides](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/cartographic-defaults.md)
+- [Themes and module styles](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/themes-and-module-styles.md)
+- [Theme transitions and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md)
+- [Map emphasis](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-emphasis.md)
+- [Style states](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/style-states.md)
+- [Route drawing](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/route-drawing.md)
+- [Sun and light](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/sun-and-light.md)
+- [3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/buildings-3d.md)
+- [Street lights](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-lights.md)
+- [3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md)
+- [Boundary areas and choropleths](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/boundary-areas-and-choropleths.md)
+- [Nautical marks](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/nautical-marks.md)
+- [Data is separate from design](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/data-is-separate-from-design.md)
+- [Capture scenes](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/capture-scenes.md)
+- [Capture shots](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/capture-shots.md)
+- [Public API and browser subpath](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/public-api-and-browser-subpath.md)
+- [Application tile reading](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/application-tile-reading.md)
+- [Depth markers](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/depth-markers.md)
+- [Hosted session authorization](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/hosted-session-authorization.md)
+- [Native resource URLs](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/native-resource-urls.md)
+- [Native artifact profile](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/native-artifact-profile.md)
+
+## Native icon capabilities
+
+Prepared icon metadata identifies SDF assets and their default fill and halo. Core rejects any
+symbol layer that can select both SDF and RGBA, including fallbacks and effective local overrides,
+with `TF_ICON_REPRESENTATION_MIXED`. It preserves layers, collisions and interaction IDs. Omitted
+SDF paint follows the resolved image selection; supplied map paint stays independent from asset
+defaults. See [Author recolorable and adaptable icons](https://github.com/tileflow/tileflow-sdk/blob/main/packages/dev/docs/native-icons.md).