@tileflow/react 0.1.0-alpha.19 → 0.1.0-alpha.20

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.
@@ -0,0 +1,21 @@
1
+ # Tileflow generated-output grant
2
+
3
+ In addition to the rights granted by the Apache License, Version 2.0, Tileflow.dev contributors
4
+ grant recipients a perpetual, worldwide, non-exclusive, no-charge, royalty-free right to use,
5
+ reproduce, modify, display, perform, distribute, sublicense, and commercialize the Tileflow-owned
6
+ parts of output generated by this SDK.
7
+
8
+ Covered output includes compiled map styles, manifests, receipts, sprites, glyph artifacts, static
9
+ render descriptions, and other build artifacts produced from Tileflow maps or application maps.
10
+ Original Tileflow map definitions, icons, and patterns distributed by `@tileflow/maps` may likewise
11
+ be used, modified, embedded, deployed, and redistributed as part of personal or commercial maps and
12
+ applications.
13
+
14
+ This grant does not relicense third-party software, fonts, icons, map data, datasets, imagery, or
15
+ other input material. Their licenses, attribution requirements, notices, and use restrictions
16
+ continue to apply to the relevant source and generated output. You are responsible for having the
17
+ rights necessary to process and distribute your own inputs.
18
+
19
+ This grant does not provide access to Tileflow hosted services or grant rights in Tileflow names,
20
+ logos, or marks. The SDK and generated output are provided without warranties or conditions beyond
21
+ those required by applicable law.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,9 @@
1
+ Tileflow SDK
2
+ Copyright 2026 Tileflow.dev contributors
3
+
4
+ This product includes software and original map artwork developed by Tileflow.dev contributors.
5
+
6
+ Third-party materials distributed with a package remain subject to their own license and notice
7
+ files. See THIRD_PARTY_NOTICES.md and asset-adjacent license files where present.
8
+
9
+ The Tileflow names and marks are not licensed under the Apache License 2.0. See TRADEMARKS.md.
package/README.md CHANGED
@@ -11,7 +11,8 @@ import 'maplibre-gl/dist/maplibre-gl.css';
11
11
  export function App() {
12
12
  return (
13
13
  <Map
14
- map="madrid"
14
+ source={{kind: 'tileflow', map: 'madrid'}}
15
+ theme="system"
15
16
  center={[-3.7038, 40.4168]}
16
17
  zoom={12}
17
18
  mapOptions={{
@@ -23,37 +24,200 @@ export function App() {
23
24
  }
24
25
  ```
25
26
 
27
+ ## Annotations, tooltips, and popups
28
+
29
+ Use `annotations` for small application-owned marker sets. Annotation data is serializable, while
30
+ `renderMarker`, `renderTooltip`, and `renderPopup` render native React UI through portals into the
31
+ MapLibre-owned marker and overlay hosts.
32
+
33
+ ```tsx
34
+ import {Map} from '@tileflow/react';
35
+ import {useState} from 'react';
36
+ import type {TileflowAnnotation, TileflowInteractionState} from '@tileflow/interactions';
37
+
38
+ type Property = {
39
+ price: number;
40
+ title: string;
41
+ };
42
+
43
+ const annotations = [
44
+ {
45
+ ariaLabel: 'Apartment in Madrid',
46
+ coordinate: [-3.7038, 40.4168],
47
+ data: {price: 320_000, title: 'Apartment in Madrid'},
48
+ id: 'property-42',
49
+ kind: 'marker',
50
+ marker: {content: {kind: 'field', field: 'price'}},
51
+ tooltip: {content: {kind: 'field', field: 'title'}},
52
+ popup: {content: {kind: 'view', name: 'property-card'}},
53
+ },
54
+ ] satisfies readonly TileflowAnnotation<Property>[];
55
+
56
+ export function PropertyMap() {
57
+ const [interactionState, setInteractionState] = useState<TileflowInteractionState>({popup: null});
58
+
59
+ return (
60
+ <Map
61
+ source={{kind: 'tileflow', map: 'madrid'}}
62
+ annotations={annotations}
63
+ interactionState={interactionState}
64
+ onInteractionStateChange={setInteractionState}
65
+ onInteractionDiagnostic={(diagnostic) => console.error(diagnostic)}
66
+ onInteractionEvent={(event) => console.log(event.type, event.target)}
67
+ renderMarker={({annotation}) => <strong>EUR {annotation.data.price.toLocaleString()}</strong>}
68
+ renderPopup={({annotation, close}) => (
69
+ <article>
70
+ <h2>{annotation.data.title}</h2>
71
+ <p>EUR {annotation.data.price.toLocaleString()}</p>
72
+ <button type="button" onClick={close}>
73
+ Close
74
+ </button>
75
+ </article>
76
+ )}
77
+ />
78
+ );
79
+ }
80
+ ```
81
+
82
+ Omit `interactionState` and use `defaultInteractionState` for uncontrolled popup state. Callback and
83
+ renderer identity changes, annotation updates, and popup state changes do not recreate the MapLibre
84
+ map. Updating an annotation with the same ID preserves its compatible Marker instance and portal
85
+ host.
86
+
87
+ `renderMarker` is always annotation-only. Without `interactions`, `renderTooltip` and `renderPopup`
88
+ also infer the annotation-specific context, including typed `annotation.data`. When `interactions`
89
+ is present, they receive the common `TileflowInteractionViewContext`; narrow `context.target.kind`
90
+ (or check `annotation in context`) when one renderer serves both annotation and semantic targets.
91
+
92
+ ## Semantic POI interactions
93
+
94
+ Use `interactions` to attach tooltip or popup behavior to POIs already rendered by a finalized
95
+ Tileflow style. Application code names the `poi` domain, never compiler-generated MapLibre layer
96
+ IDs. The runtime queries only manifest-declared layers and mounts DOM only for the active overlay.
97
+
98
+ ```tsx
99
+ import {Map} from '@tileflow/react';
100
+ import type {TileflowInteractionBinding} from '@tileflow/interactions';
101
+
102
+ const interactions = [
103
+ {
104
+ id: 'poi-details',
105
+ target: {kind: 'semantic-feature', domain: 'poi', categories: ['food-drink', 'retail']},
106
+ tooltip: {content: {kind: 'field', field: 'name', fallback: 'Point of interest'}},
107
+ popup: {content: {kind: 'view', name: 'poi-card'}},
108
+ },
109
+ ] satisfies readonly TileflowInteractionBinding[];
110
+
111
+ export function PoiMap() {
112
+ return (
113
+ <Map
114
+ source={{kind: 'tileflow', map: 'madrid'}}
115
+ interactions={interactions}
116
+ renderPopup={(context) =>
117
+ context.target.kind === 'semantic-feature' ? (
118
+ <article>
119
+ <h2>{String(context.target.feature.properties.name ?? 'Point of interest')}</h2>
120
+ <button type="button" onClick={context.close}>
121
+ Close
122
+ </button>
123
+ </article>
124
+ ) : null
125
+ }
126
+ />
127
+ );
128
+ }
129
+ ```
130
+
131
+ Bindings and popup state are validated before reconciliation. An invalid replacement leaves the
132
+ last valid runtime state active and reports structured diagnostics. `interactionState` and
133
+ `defaultInteractionState` are mutually exclusive. Annotation and semantic overlays share one popup
134
+ state, so replacing either target closes the previous popup before opening the next.
135
+
136
+ `MapProps` also rejects `annotations` together with legacy `markers`, and rejects controlled and
137
+ default interaction state together. Its `mode="image"` branch excludes annotations, markers,
138
+ semantic bindings, interaction state, renderers, and interaction callbacks. JavaScript callers and
139
+ widened inputs still receive the corresponding runtime diagnostics.
140
+
141
+ `onInteractionDiagnostic` receives each newly reported structured runtime diagnostic. Changing any
142
+ callback identity does not resubscribe the runtime or recreate MapLibre.
143
+
144
+ Custom portal targets move capture readiness to `loading` until React commits the target and two
145
+ current animation frames complete. Removing or replacing a target invalidates pending frames.
146
+
147
+ When no render prop is present, text and safe field descriptors use the shared unbranded DOM
148
+ defaults. A `view` descriptor is a dispatch name for an application renderer; it is not HTML or a
149
+ serialized component tree. Tooltip content remains non-interactive, while popup content may contain
150
+ normal React controls.
151
+
152
+ The legacy `markers` prop remains available during the alpha migration and is normalized through the
153
+ same keyed runtime. Its `label` keeps the existing marker `title`; do not pass `markers` and
154
+ `annotations` together. `mode="image"` cannot render interaction configuration and shows an
155
+ explicit `UNSUPPORTED_MODE` diagnostic without loading MapLibre.
156
+
26
157
  `mapOptions` accepts native MapLibre options except `container` and `style`, which
27
- Tileflow resolves from the map name, manifest, or explicit style props. Direct
158
+ Tileflow resolves from `source`. Direct
28
159
  Tileflow props such as `center`, `zoom`, and `interactive` take priority when
29
- provided.
160
+ provided. Camera resolution is the same in interactive and image modes: direct props, then
161
+ `mapOptions`, then the published manifest view, then Tileflow's shared runtime defaults.
162
+
163
+ Every map has exactly one discriminated `source`. Use `kind: 'tileflow'` for a map published in a
164
+ Tileflow manifest. `kind: 'maplibre'` is the unmanaged MapLibre escape hatch for one direct style
165
+ object or URL: it deliberately has no Tileflow theme identity, `system` selection, switching, or
166
+ manifest traceability. Browser components do not compile `tileflow.config.ts`.
167
+
168
+ Without `manifestUrl`, the exact default is `/tileflow/manifest.json`. If Vite, Webpack, Next, a
169
+ reverse proxy, or the Tileflow plugin publishes it anywhere else, set the final public URL
170
+ explicitly; the component does not attempt runtime base-path discovery. Manifest 404s, unknown map
171
+ IDs, unresolved styles, and unresolved image URLs enter `data-tileflow-state="error"`.
172
+
173
+ `theme` selects a published theme name. Omitting it uses the map's `defaultTheme`; `"system"` is
174
+ available only when the map declares explicit light and dark mappings. Changes preload fonts, diff
175
+ the style on the existing MapLibre instance, preserve camera and interactions, and roll back if the
176
+ new style fails. `onThemeChange` reports preloading, applying, ready, and error transitions.
30
177
 
31
178
  To reuse one published map across multiple repos, point every app at the same
32
179
  manifest:
33
180
 
34
181
  ```tsx
35
- <Map map="madrid" manifestUrl="https://cdn.example.com/tileflow/manifest.json" />
182
+ <Map
183
+ source={{
184
+ kind: 'tileflow',
185
+ map: 'madrid',
186
+ manifestUrl: 'https://cdn.example.com/tileflow/manifest.json',
187
+ }}
188
+ />
36
189
  ```
37
190
 
38
- Or bypass the manifest and load a hosted style directly:
191
+ Or deliberately leave the Tileflow theme contract and load one concrete Style JSON directly:
39
192
 
40
193
  ```tsx
41
- <Map styleUrl="https://api.tileflow.dev/maps/map_1234567890abcdef/style.json" />
194
+ <Map
195
+ source={{
196
+ kind: 'maplibre',
197
+ style: 'https://cdn.example.com/tileflow/styles/madrid/dark.json',
198
+ }}
199
+ />
42
200
  ```
43
201
 
44
- For simple hosted static images, use image mode:
202
+ For a lightweight display of an already hosted static image, use image mode:
45
203
 
46
204
  ```tsx
47
- <Map map="madrid" mode="image" center={[-3.7038, 40.4168]} zoom={12} />
205
+ <Map
206
+ source={{kind: 'tileflow', map: 'madrid'}}
207
+ mode="image"
208
+ center={[-3.7038, 40.4168]}
209
+ zoom={12}
210
+ />
48
211
  ```
49
212
 
50
- When `mode="image"` does not include an explicit `imageUrl`, local development
51
- hosts render the interactive map while `preferLocalDev` is enabled. Production
52
- hosts render the deployed static image. Set `preferLocalDev={false}` to preview
53
- the production image behavior locally.
213
+ `Map mode="image"` only resolves an existing image URL (explicitly or from the published map
214
+ manifest) and renders an `<img>`; it does not submit a render scene, create an operation, poll, or
215
+ apply `StaticMap` overlays. This path does not load or evaluate MapLibre. Without an explicit
216
+ `imageUrl`, all environments use the image URL published for the Tileflow source.
54
217
 
55
- For full static scenes with bounds, overlays, and server-side precache, use
56
- `StaticMap` from `@tileflow/react/static` or helpers from `@tileflow/static`.
218
+ For a new, fully specified render with exact size, center/bounds camera, overlays, idempotency, and
219
+ asynchronous create/poll behavior, use `StaticMap` from `@tileflow/react/static` or helpers from
220
+ `@tileflow/static`.
57
221
 
58
222
  ```tsx
59
223
  import {StaticMap} from '@tileflow/react/static';
@@ -83,13 +247,16 @@ consumer aborts its in-flight request.
83
247
  Hosted interactive maps automatically preflight a short-lived commercial session grant before
84
248
  eligible resources. Setting `analytics={{enabled: false}}` disables the optional beacon only; it
85
249
  does not remove hosted authorization or override a user `mapOptions.transformRequest` callback.
250
+ Direct Tileflow World maps keep early `GRACE` silent, show a compact accessible owner-action pill
251
+ when late `GRACE` is activated, and show a stronger banner in `CLAIM_REQUIRED`. Missing tiles and
252
+ MapLibre failures do not remove that recovery path.
86
253
 
87
254
  ## Headless capture readiness
88
255
 
89
256
  Use `captureId` to disambiguate multiple maps with the same configured name:
90
257
 
91
258
  ```tsx
92
- <Map map="madrid" captureId="checkout-map" />
259
+ <Map source={{kind: 'tileflow', map: 'madrid'}} captureId="checkout-map" />
93
260
  ```
94
261
 
95
262
  The root element exposes `data-tileflow-map`, optional `data-tileflow-capture-id`, and
@@ -98,4 +265,11 @@ and two animation frames; style/data work returns it to loading. Image mode wait
98
265
  successful load fallback, including cached hydration. `tileflow capture` uses these markers for
99
266
  application scenes and requires exactly one target.
100
267
 
268
+ ## Compatibility
269
+
270
+ The supported peer window is React 18-19 and MapLibre GL JS 5-6. Compatibility smoke tests install
271
+ the exact lower bound and the first release of every accepted major from packed Tileflow tarballs,
272
+ typecheck a consumer, and render the image/SSR path while rejecting any MapLibre import. Future
273
+ majors stay outside the peer range until that matrix passes.
274
+
101
275
  Docs: https://tileflow.dev/docs
package/TRADEMARKS.md ADDED
@@ -0,0 +1,10 @@
1
+ # Tileflow trademarks
2
+
3
+ The Apache License, Version 2.0, and the Tileflow generated-output grant do not grant permission to
4
+ use the Tileflow name, `tileflow.dev`, logos, service marks, product names, or other Tileflow brand
5
+ features except for reasonable and customary use that truthfully describes the origin of the SDK or
6
+ compatibility with Tileflow, and for reproducing required notices.
7
+
8
+ You may not use Tileflow brand features in a way that suggests sponsorship, endorsement, or an
9
+ official Tileflow product when none exists. Third-party names and marks remain the property of their
10
+ respective owners.
package/dist/index.d.ts CHANGED
@@ -1,22 +1,23 @@
1
1
  import * as react from 'react';
2
- import { CSSProperties, ImgHTMLAttributes } from 'react';
2
+ import { CSSProperties, ImgHTMLAttributes, ReactNode } from 'react';
3
3
  import { MapOptions, Map as Map$1 } from 'maplibre-gl';
4
- import { TileflowConfig, MapLibreStyle, TileflowProjectThemes, TileflowMapMarker, TileflowAnalytics } from '@tileflow/core';
4
+ import { TileflowThemeTransition } from '@tileflow/core/browser';
5
+ import { TileflowRuntimeSource, TileflowThemeSelection, TileflowAnalytics, TileflowMapMarker } from '@tileflow/core/runtime';
6
+ import { TileflowAnnotation, TileflowInteractionState, TileflowAnnotationViewContext, TileflowInteractionBinding, TileflowInteractionViewContext, TileflowInteractionDiagnostic, TileflowInteractionEvent } from '@tileflow/interactions';
7
+
8
+ type TileflowMapStyleSourceProps = {
9
+ source: TileflowRuntimeSource;
10
+ theme?: TileflowThemeSelection;
11
+ };
5
12
 
6
13
  type MapMarker = TileflowMapMarker;
14
+ type TileflowMapSource = TileflowRuntimeSource;
7
15
  type TileflowMapOptions = Omit<MapOptions, 'container' | 'style'>;
8
- type MapProps = {
16
+ type TileflowAnnotationRenderer<TAnnotation extends TileflowAnnotation = TileflowAnnotation> = (context: TileflowAnnotationViewContext<TAnnotation>) => ReactNode;
17
+ type TileflowInteractionRenderer<TAnnotation extends TileflowAnnotation = TileflowAnnotation> = (context: TileflowInteractionViewContext<TAnnotation>) => ReactNode;
18
+ type MapSharedProps = {
9
19
  captureId?: string;
10
- map?: string;
11
- mode?: 'interactive' | 'image';
12
- config?: TileflowConfig;
13
- style?: MapLibreStyle;
14
- styleUrl?: string;
15
20
  imageUrl?: string;
16
- styleBaseUrl?: string;
17
- themes?: TileflowProjectThemes;
18
- manifestUrl?: string;
19
- preferLocalDev?: boolean;
20
21
  alt?: string;
21
22
  center?: [number, number];
22
23
  zoom?: number;
@@ -25,10 +26,55 @@ type MapProps = {
25
26
  imageLoading?: ImgHTMLAttributes<HTMLImageElement>['loading'];
26
27
  interactive?: boolean;
27
28
  mapOptions?: TileflowMapOptions;
28
- markers?: MapMarker[];
29
29
  analytics?: TileflowAnalytics;
30
30
  onLoad?: (map: Map$1) => void;
31
+ onThemeChange?: (transition: TileflowThemeTransition) => void;
32
+ };
33
+ type TileflowAnnotationInputProps<TAnnotation extends TileflowAnnotation> = Readonly<{
34
+ annotations?: readonly TAnnotation[];
35
+ markers?: never;
36
+ }> | Readonly<{
37
+ annotations?: never;
38
+ markers?: readonly MapMarker[];
39
+ }>;
40
+ type TileflowInteractionStateInputProps = Readonly<{
41
+ defaultInteractionState?: never;
42
+ interactionState?: TileflowInteractionState;
43
+ }> | Readonly<{
44
+ defaultInteractionState?: TileflowInteractionState;
45
+ interactionState?: never;
46
+ }>;
47
+ type TileflowInteractionRendererProps<TAnnotation extends TileflowAnnotation> = Readonly<{
48
+ interactions?: never;
49
+ renderPopup?: TileflowAnnotationRenderer<TAnnotation>;
50
+ renderTooltip?: TileflowAnnotationRenderer<TAnnotation>;
51
+ }> | Readonly<{
52
+ interactions: readonly TileflowInteractionBinding[];
53
+ renderPopup?: TileflowInteractionRenderer<TAnnotation>;
54
+ renderTooltip?: TileflowInteractionRenderer<TAnnotation>;
55
+ }>;
56
+ type MapInteractiveProps<TAnnotation extends TileflowAnnotation> = MapSharedProps & TileflowAnnotationInputProps<TAnnotation> & TileflowInteractionStateInputProps & TileflowInteractionRendererProps<TAnnotation> & {
57
+ mode?: 'interactive';
58
+ onInteractionDiagnostic?: (diagnostic: TileflowInteractionDiagnostic) => void;
59
+ onInteractionEvent?: (event: TileflowInteractionEvent<TAnnotation>) => void;
60
+ onInteractionStateChange?: (state: TileflowInteractionState) => void;
61
+ renderMarker?: TileflowAnnotationRenderer<TAnnotation>;
62
+ };
63
+ type MapImageProps = MapSharedProps & {
64
+ annotations?: never;
65
+ defaultInteractionState?: never;
66
+ interactionState?: never;
67
+ interactions?: never;
68
+ markers?: never;
69
+ mode: 'image';
70
+ onInteractionDiagnostic?: never;
71
+ onInteractionEvent?: never;
72
+ onInteractionStateChange?: never;
73
+ renderMarker?: never;
74
+ renderPopup?: never;
75
+ renderTooltip?: never;
31
76
  };
32
- declare function Map({ captureId, map: mapName, mode, config, style, styleUrl, imageUrl, styleBaseUrl, themes, manifestUrl, preferLocalDev, alt, center, zoom, className, height, imageLoading, interactive, mapOptions, markers, analytics, onLoad, }: MapProps): react.JSX.Element;
77
+ type MapProps<TAnnotation extends TileflowAnnotation = TileflowAnnotation> = (MapInteractiveProps<TAnnotation> | MapImageProps) & TileflowMapStyleSourceProps;
78
+ declare function Map<TAnnotation extends TileflowAnnotation = TileflowAnnotation>(props: MapProps<TAnnotation>): react.JSX.Element;
33
79
 
34
- export { Map, type MapMarker, type MapProps, type TileflowMapOptions };
80
+ export { Map, type MapMarker, type MapProps, type TileflowAnnotationRenderer, type TileflowInteractionRenderer, type TileflowMapOptions, type TileflowMapSource };