@tileflow/svelte 0.1.0-alpha.18 → 0.1.0-alpha.20

package/GENERATED_OUTPUT_LICENSE.md

@@ -0,0 +1,21 @@
+# Tileflow generated-output grant
+
+In addition to the rights granted by the Apache License, Version 2.0, Tileflow.dev contributors
+grant recipients a perpetual, worldwide, non-exclusive, no-charge, royalty-free right to use,
+reproduce, modify, display, perform, distribute, sublicense, and commercialize the Tileflow-owned
+parts of output generated by this SDK.
+
+Covered output includes compiled map styles, manifests, receipts, sprites, glyph artifacts, static
+render descriptions, and other build artifacts produced from Tileflow maps or application maps.
+Original Tileflow map definitions, icons, and patterns distributed by `@tileflow/maps` may likewise
+be used, modified, embedded, deployed, and redistributed as part of personal or commercial maps and
+applications.
+
+This grant does not relicense third-party software, fonts, icons, map data, datasets, imagery, or
+other input material. Their licenses, attribution requirements, notices, and use restrictions
+continue to apply to the relevant source and generated output. You are responsible for having the
+rights necessary to process and distribute your own inputs.
+
+This grant does not provide access to Tileflow hosted services or grant rights in Tileflow names,
+logos, or marks. The SDK and generated output are provided without warranties or conditions beyond
+those required by applicable law.

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/NOTICE

@@ -0,0 +1,9 @@
+Tileflow SDK
+Copyright 2026 Tileflow.dev contributors
+
+This product includes software and original map artwork developed by Tileflow.dev contributors.
+
+Third-party materials distributed with a package remain subject to their own license and notice
+files. See THIRD_PARTY_NOTICES.md and asset-adjacent license files where present.
+
+The Tileflow names and marks are not licensed under the Apache License 2.0. See TRADEMARKS.md.

package/README.md

@@ -11,7 +11,8 @@ Install `maplibre-gl` alongside the package and import its CSS once in your app.
 </script>
 
 <TileflowMap
-  map="madrid"
+  source={{kind: 'tileflow', map: 'madrid'}}
+  theme="system"
   center={[-3.7038, 40.4168]}
   zoom={12}
   mapOptions={{
@@ -22,25 +23,169 @@ Install `maplibre-gl` alongside the package and import its CSS once in your app.
 ```
 
 `mapOptions` accepts native MapLibre options except `container` and `style`, which
-Tileflow resolves from the map name, manifest, or explicit style props. Direct
+Tileflow resolves from `source`. Direct
 Tileflow props such as `center`, `zoom`, and `interactive` take priority when
-provided.
+provided. Camera resolution is the same in interactive and image modes: direct props, then
+`mapOptions`, then the published manifest view, then Tileflow's shared runtime defaults.
+
+Every map has exactly one discriminated `source`. Use `kind: 'tileflow'` with `map` and an optional
+`manifestUrl` for published delivery. `kind: 'maplibre'` is an unmanaged escape hatch for one direct
+style object or URL; it has no Tileflow theme identity, `system` selection, switching, or manifest
+traceability. Browser components do not compile `tileflow.config.ts`.
+
+Without `manifestUrl`, the exact default is `/tileflow/manifest.json`. If a bundler, framework base
+path, reverse proxy, or Tileflow plugin publishes it elsewhere, set the final public URL explicitly;
+the component does not guess it. Manifest 404s, unknown map IDs, unresolved styles, and unresolved
+image URLs enter `data-tileflow-state="error"`.
+
+`theme` selects a published theme name. Omission uses `defaultTheme`; `"system"` requires the map's
+explicit light/dark mapping. Switching preserves the MapLibre instance, camera, and interactions,
+and rolls back a failed style. `onThemeChange` receives transition state.
+
+```svelte
+<TileflowMap
+  source={{
+    kind: 'tileflow',
+    map: 'madrid',
+    manifestUrl: 'https://cdn.example.com/tileflow/manifest.json',
+  }}
+/>
+
+<TileflowMap
+  source={{
+    kind: 'maplibre',
+    style: 'https://cdn.example.com/tileflow/styles/madrid/dark.json',
+  }}
+/>
+```
+
+`mode="image"` resolves an explicit or published image URL and renders an `<img>` without loading
+or evaluating MapLibre. All environments follow the same published manifest contract.
 
 Hosted maps automatically preflight a short-lived commercial session grant before eligible
 resources. Setting `analytics={{enabled: false}}` disables the optional beacon only; it does not
 remove hosted authorization or override a user `mapOptions.transformRequest` callback.
+Direct Tileflow World maps keep early `GRACE` silent, show a compact accessible owner-action pill
+when late `GRACE` is activated, and show a stronger banner in `CLAIM_REQUIRED`. Missing tiles and
+MapLibre failures do not remove that recovery path.
+
+## Annotations and overlays
+
+Use `annotations` for keyed markers with optional tooltips and popups. Tileflow supplies accessible,
+text-only defaults; Svelte snippets can replace any surface and are mounted into the DOM containers
+owned by the shared MapLibre interaction runtime.
+
+```svelte
+<script lang="ts">
+  import {TileflowMap} from '@tileflow/svelte';
+  import type {
+    TileflowAnnotation,
+    TileflowInteractionBinding,
+    TileflowInteractionState,
+  } from '@tileflow/interactions';
+
+  const annotations: TileflowAnnotation[] = [
+    {
+      ariaLabel: 'Madrid',
+      coordinate: [-3.7038, 40.4168],
+      id: 'madrid',
+      kind: 'marker',
+      marker: {content: {kind: 'text', text: 'Madrid'}},
+      popup: {content: {kind: 'view', name: 'city-card'}},
+      tooltip: {content: {kind: 'text', text: 'Open Madrid'}},
+    },
+  ];
+
+  const interactions: TileflowInteractionBinding[] = [
+    {
+      id: 'poi-details',
+      popup: {content: {kind: 'view', name: 'poi-card'}},
+      target: {categories: ['food-drink'], domain: 'poi', kind: 'semantic-feature'},
+      tooltip: {content: {field: 'name', fallback: 'Restaurant', kind: 'field'}},
+    },
+  ];
+
+  let interactionState: TileflowInteractionState = {popup: null};
+</script>
+
+{#snippet marker(context)}
+  <span>{context.annotation.ariaLabel}</span>
+{/snippet}
+
+{#snippet tooltip(context)}
+  {#if context.target.kind === 'annotation'}
+    <span>{context.target.annotation.ariaLabel}</span>
+  {:else}
+    <span>Point of interest</span>
+  {/if}
+{/snippet}
+
+{#snippet popup(context)}
+  <article>
+    {#if context.target.kind === 'annotation'}
+      <h2>{context.target.annotation.ariaLabel}</h2>
+    {:else if context.target.kind === 'semantic-feature'}
+      <h2>POI details</h2>
+    {/if}
+    <button type="button" onclick={context.close}>Close</button>
+  </article>
+{/snippet}
+
+<TileflowMap
+  source={{kind: 'tileflow', map: 'madrid'}}
+  {annotations}
+  {interactions}
+  {interactionState}
+  onInteractionStateChange={(next) => (interactionState = next)}
+  onInteractionEvent={(event) => console.log(event.type)}
+  onInteractionDiagnostic={(diagnostic) => console.error(diagnostic)}
+  {marker}
+  {tooltip}
+  {popup}
+/>
+```
+
+`annotations` and the legacy `markers` prop are mutually exclusive. So are controlled
+`interactionState` and uncontrolled `defaultInteractionState`. `interactions` binds tooltips and
+popups to semantic POIs exposed by the compiled style metadata; applications select the stable
+`poi` domain and optional categories rather than physical style-layer IDs.
+
+Snippet callbacks are read at the time an interaction occurs, and adding or removing a snippet
+switches between custom and default rendering without recreating the map or its keyed markers.
+`marker` receives the annotation-only context. `tooltip` and `popup` receive the general interaction
+context and therefore handle both annotation and semantic-feature targets. Each context includes
+resolved content, the target, optional view name, and `close()`.
+
+Both runtimes are controlled by one interaction-state coordinator. Replacing an annotation popup
+with a POI popup (or the reverse) closes the previous owner before opening the next one, so event
+order remains `popup:close` followed by `popup:open`.
+
+Annotations and semantic interactions are interactive-only. The TypeScript API excludes
+annotations, legacy markers, interactions, interaction state, snippets, and interaction callbacks
+from the `mode="image"` branch. Untyped JavaScript that supplies them still receives an
+`UNSUPPORTED_MODE` diagnostic and capture readiness `error`, rather than pretending the static image
+contains live overlays.
 
 ## Headless capture readiness
 
 Use `captureId` to disambiguate repeated named maps:
 
 ```svelte
-<TileflowMap map="madrid" captureId="checkout-map" />
+<TileflowMap source={{kind: 'tileflow', map: 'madrid'}} captureId="checkout-map" />
 ```
 
 The root exposes `data-tileflow-map`, optional `data-tileflow-capture-id`, and
 `data-tileflow-state="loading|idle|error"`. It becomes idle only after MapLibre idle plus two
-animation frames (or image decode/load in image mode), returns to loading for new style/data work,
-and marks terminal load errors. Application capture selects exactly one ready target.
+animation frames and, for custom interaction snippets, the Svelte DOM commit plus two current
+animation frames. It returns to loading when either surface changes and marks map or interaction
+errors. In image mode, readiness follows image decode/load when no interaction configuration is
+present. Application capture selects exactly one ready target.
+
+## Compatibility
+
+The supported peer window is Svelte 5.x and MapLibre GL JS 5-6. Compatibility smoke tests install
+Svelte 5.0.0 with the first release of both MapLibre majors from packed Tileflow tarballs, typecheck
+the public declarations, and compile real Svelte consumers. Future Svelte majors stay outside the
+peer range until that matrix passes.
 
 Docs: https://tileflow.dev/docs

package/TRADEMARKS.md

@@ -0,0 +1,10 @@
+# Tileflow trademarks
+
+The Apache License, Version 2.0, and the Tileflow generated-output grant do not grant permission to
+use the Tileflow name, `tileflow.dev`, logos, service marks, product names, or other Tileflow brand
+features except for reasonable and customary use that truthfully describes the origin of the SDK or
+compatibility with Tileflow, and for reproducing required notices.
+
+You may not use Tileflow brand features in a way that suggests sponsorship, endorsement, or an
+official Tileflow product when none exists. Third-party names and marks remain the property of their
+respective owners.

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@tileflow/svelte",
-  "version": "0.1.0-alpha.18",
+  "version": "0.1.0-alpha.20",
+  "license": "Apache-2.0",
   "description": "Svelte component for rendering Tileflow maps with MapLibre.",
   "type": "module",
   "sideEffects": false,
@@ -23,7 +24,11 @@
   ],
   "types": "./src/index.d.ts",
   "files": [
-    "src"
+    "src",
+    "LICENSE",
+    "NOTICE",
+    "GENERATED_OUTPUT_LICENSE.md",
+    "TRADEMARKS.md"
   ],
   "exports": {
     ".": {
@@ -33,7 +38,7 @@
       "default": "./src/index.js"
     },
     "./TileflowMap.svelte": {
-      "types": "./src/TileflowMap.svelte.d.ts",
+      "types": "./src/index.d.ts",
       "svelte": "./src/TileflowMap.svelte",
       "default": "./src/TileflowMap.svelte"
     }
@@ -42,11 +47,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@tileflow/core": ">=0.1.0-alpha.18 <0.1.0-beta.0"
+    "@tileflow/core": ">=0.1.0-alpha.21 <0.1.0-beta.0",
+    "@tileflow/interactions": ">=0.1.0-alpha.0 <0.1.0-beta.0"
   },
   "peerDependencies": {
-    "maplibre-gl": ">=5",
-    "svelte": ">=5"
+    "maplibre-gl": ">=5 <7",
+    "svelte": ">=5 <6"
   },
   "devDependencies": {
     "maplibre-gl": "^5.24.0",
@@ -56,8 +62,8 @@
   "scripts": {
     "build": "svelte-check --tsconfig ./tsconfig.json",
     "test": "node --test test/*.test.js",
-    "verify": "pnpm run build && pnpm run test",
-    "typecheck": "svelte-check --tsconfig ./tsconfig.json",
-    "lint": "svelte-check --tsconfig ./tsconfig.json"
+    "verify": "pnpm run typecheck && pnpm run test",
+    "typecheck": "svelte-check --tsconfig ./tsconfig.json && tsc -p tsconfig.contract.json",
+    "lint": "pnpm run typecheck"
   }
 }