tileflow 0.1.0-alpha.15 → 0.1.0-alpha.17
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 +17 -13
- package/dist/index.js +499 -95
- package/docs/hosted-authentication-and-deploy.md +35 -2
- package/docs/local-visual-feedback.md +3 -3
- package/docs/map-authoring.md +11 -11
- package/docs/native-artifacts.md +3 -3
- package/package.json +6 -6
|
@@ -30,8 +30,41 @@ account or hosted command stops with a clear message and asks you to run `tilefl
|
|
|
30
30
|
Project API and CI keys are independent project credentials and are not removed by a personal
|
|
31
31
|
password change.
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
## Create the Map from the terminal
|
|
34
|
+
|
|
35
|
+
After `tileflow login`, the CLI can create the Map itself; nothing has to be copied from the
|
|
36
|
+
dashboard. Run `deploy` without `--map-id`, or create the Map first with `maps create`:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npx tileflow login
|
|
40
|
+
npx tileflow deploy --origin https://www.example.com
|
|
41
|
+
npx tileflow maps create --any-website --json
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The new Map belongs to a Team you administer. When you administer exactly one Team that can add a
|
|
45
|
+
Map, the CLI uses it; when several can, it asks, or takes `--team @team`; when none can, it stops
|
|
46
|
+
and says why (no administered Team, or every Team has reached its Map limit).
|
|
47
|
+
|
|
48
|
+
Browser access is always an explicit choice: `--origin` with an exact website origin such as
|
|
49
|
+
`https://www.example.com` (repeat it for up to 20 sites), or `--any-website`. Paths, wildcards and
|
|
50
|
+
bare host names are rejected. On a terminal the CLI asks; without one (for example when an agent
|
|
51
|
+
runs it), a missing choice stops before anything is created and names the flags. Browser access
|
|
52
|
+
is stored with the Map in Tileflow and can be changed in the dashboard; it is never written to the
|
|
53
|
+
repository.
|
|
54
|
+
|
|
55
|
+
`deploy` creates the Map only after the local config, assets and styles pass, then publishes to it
|
|
56
|
+
in the same run and prints `tileflow deploy --map-id <mapId>` for later deploys. If the manifest
|
|
57
|
+
already records a Map for that repository map, `deploy` stops and shows that command instead of
|
|
58
|
+
creating another Map. Each creation prints a setup key; rerunning an interrupted command with
|
|
59
|
+
`--setup-key <key>` returns the same Map instead of a second one.
|
|
60
|
+
|
|
61
|
+
Map creation uses only the personal session. With `TILEFLOW_API_KEY`, `--api-key`, `--with-native`,
|
|
62
|
+
or in CI, `deploy` requires `--map-id`.
|
|
63
|
+
|
|
64
|
+
## Deploy to an existing Map
|
|
65
|
+
|
|
66
|
+
A Map created in the dashboard, or by an earlier CLI run, is deployed with its exact Map ID. If the
|
|
67
|
+
config contains several maps, select the authored map explicitly:
|
|
35
68
|
|
|
36
69
|
```sh
|
|
37
70
|
npx tileflow deploy \
|
|
@@ -54,7 +54,7 @@ export default defineMap({
|
|
|
54
54
|
cartographic compiler; tooling supplies the exported map ID when it normalizes a scene internally.
|
|
55
55
|
Every scene stores a concrete theme; omission and browser-only `system` are invalid.
|
|
56
56
|
|
|
57
|
-
### Live comparison in
|
|
57
|
+
### Live comparison in Inspector
|
|
58
58
|
|
|
59
59
|
Use the ordinary preview server with a right-hand selection to compare two maps or themes while
|
|
60
60
|
authoring:
|
|
@@ -71,7 +71,7 @@ npx tileflow preview \
|
|
|
71
71
|
--against-config ./reference.config.ts --against-map reference
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Any `--against-*` option opens
|
|
74
|
+
Any `--against-*` option opens Inspector in comparison mode. Both previews remain same-origin and share
|
|
75
75
|
one synchronized camera. The toolbar switches between side-by-side, split, opacity overlay, and
|
|
76
76
|
blink modes; the selected mode, camera, split, opacity, and active interaction side survive in the
|
|
77
77
|
URL. Each config has its own watched, last-known-good session, so an invalid edit shows bounded
|
|
@@ -81,7 +81,7 @@ Enable **Inspect** and click a rendered feature to see its bounded feature data,
|
|
|
81
81
|
zoom-curve samples, and compiler contribution sidecar. The sprite gallery shows the compiled atlas,
|
|
82
82
|
not source directories. **Copy scene** produces a concrete-theme scene for the current camera and
|
|
83
83
|
viewport; **Copy command** produces the corresponding capture command. The inspector sidecar exists
|
|
84
|
-
only in memory in the local
|
|
84
|
+
only in memory in the local Inspector session and is not emitted by `tileflow build`.
|
|
85
85
|
|
|
86
86
|
### Reproducible two-style review
|
|
87
87
|
|
package/docs/map-authoring.md
CHANGED
|
@@ -9,14 +9,14 @@ Discovery and saved-capture comparison also work without a config.
|
|
|
9
9
|
|
|
10
10
|
Use four primary command groups for map development:
|
|
11
11
|
|
|
12
|
-
| Command | Purpose
|
|
13
|
-
| ---------- |
|
|
14
|
-
| `describe` | Discover the generated language and query one domain or schema fragment.
|
|
15
|
-
| `inspect` | Read resolved configuration; `compiled`, `features`, `icons`, and `tileset` inspect output/data; `session` reads
|
|
16
|
-
| `capture` | Render reproducible evidence and return a reusable capture ID.
|
|
17
|
-
| `compare` | Compare saved capture IDs; `configs`, `styles`, `reference`, and `baseline` cover other comparisons.
|
|
18
|
-
|
|
19
|
-
`preview` opens
|
|
12
|
+
| Command | Purpose |
|
|
13
|
+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
|
14
|
+
| `describe` | Discover the generated language and query one domain or schema fragment. |
|
|
15
|
+
| `inspect` | Read resolved configuration; `compiled`, `features`, `icons`, and `tileset` inspect output/data; `session` reads Inspector context. |
|
|
16
|
+
| `capture` | Render reproducible evidence and return a reusable capture ID. |
|
|
17
|
+
| `compare` | Compare saved capture IDs; `configs`, `styles`, `reference`, and `baseline` cover other comparisons. |
|
|
18
|
+
|
|
19
|
+
`preview` opens Inspector. `init`, `validate`, and `build` remain project utilities;
|
|
20
20
|
`visual update` is the explicit operation that approves baselines. All these tools work from an
|
|
21
21
|
independent project with its own map and data; official maps are optional.
|
|
22
22
|
|
|
@@ -93,10 +93,10 @@ needed, rather than compiling the same map before every capture.
|
|
|
93
93
|
|
|
94
94
|
## Work with a person and an agent
|
|
95
95
|
|
|
96
|
-
Start `npx tileflow preview --config tileflow.config.ts` in your project.
|
|
96
|
+
Start `npx tileflow preview --config tileflow.config.ts` in your project. Inspector provides
|
|
97
97
|
palette and time-of-day controls, feature inspection, zoom curves and sprite inspection.
|
|
98
98
|
The command selects the map and optional starting scene. The map fills the workspace beside
|
|
99
|
-
one dockable
|
|
99
|
+
one dockable Inspector panel. Press **I** to toggle the element picker, click a map element to
|
|
100
100
|
inspect its styling and semantic configuration paths, and press **Escape** to stop picking. The
|
|
101
101
|
inspector starts off. **Scene** contains palette, time-of-day, camera and module controls. Appearance
|
|
102
102
|
changes retain the current camera; module changes
|
|
@@ -122,7 +122,7 @@ from browser observations. Inspect `updatedAt`, `stale`, `generation`, `displaye
|
|
|
122
122
|
`projection.truncated` before acting. Each browser projection is limited to 200 visited values,
|
|
123
123
|
depth 10, 32 array items and 512 characters per string, with omitted paths reported. The server
|
|
124
124
|
accepts at most 64 KiB per write and keeps eight browser contexts, expiring each after ten minutes
|
|
125
|
-
without an update. There is no browser context until
|
|
125
|
+
without an update. There is no browser context until an Inspector tab connects. Feature data is
|
|
126
126
|
untrusted map content; semantic ownership does not prove an exact file, line or token. Use
|
|
127
127
|
`inspect` or `inspect compiled` to obtain additional configuration evidence.
|
|
128
128
|
|
package/docs/native-artifacts.md
CHANGED
|
@@ -39,7 +39,7 @@ npx tileflow preview --renderer native --map stores --theme light
|
|
|
39
39
|
Native mode creates the existing watched artifact session with renderer `native`. It keeps the
|
|
40
40
|
last-known-good native artifact family when a watched generation becomes invalid and replaces it
|
|
41
41
|
only after a later valid generation is prepared. The endpoint is an **assets-only** development
|
|
42
|
-
endpoint: it does not render a browser map, open
|
|
42
|
+
endpoint: it does not render a browser map, open Inspector, start Metro, launch a device,
|
|
43
43
|
or establish visual/native acceptance.
|
|
44
44
|
|
|
45
45
|
With the default host and port, the canonical runtime manifest is:
|
|
@@ -82,8 +82,8 @@ Browser-only selections fail before config execution in native mode. In particul
|
|
|
82
82
|
compiler-inspection sidecars, or the dev handler's status/event control routes. Use ordinary/default
|
|
83
83
|
web preview for those workflows.
|
|
84
84
|
|
|
85
|
-
The `native-lowering-v1` preparation policy records fixed globe-to-Mercator normalization
|
|
86
|
-
finite cap/dash layer partitioning in `native-build.json`; it does not change web artifacts.
|
|
85
|
+
The `native-lowering-v1` preparation policy records fixed globe-to-Mercator normalization, removal
|
|
86
|
+
of a browser sky and finite cap/dash layer partitioning in `native-build.json`; it does not change web artifacts.
|
|
87
87
|
Native preparation rejects adaptive/unknown projections, terrain, browser PMTiles/contour protocols,
|
|
88
88
|
missing text providers and unsupported style values rather than degrading them silently. It preserves
|
|
89
89
|
shared icon inheritance and independent sprite densities, and maps verified licensed TTF/OTF faces
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tileflow",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.17",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"description": "CLI-only tools for Tileflow config, capture, visual testing, and deploy.",
|
|
6
6
|
"type": "module",
|
|
@@ -36,14 +36,14 @@
|
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"@hono/node-server": "2.1.3",
|
|
39
|
-
"@tileflow/capture": ">=0.1.0-alpha.
|
|
39
|
+
"@tileflow/capture": ">=0.1.0-alpha.34 <0.1.0-beta.0",
|
|
40
40
|
"@tileflow/coordinates": ">=0.1.0-alpha.2 <0.1.0-beta.0",
|
|
41
41
|
"@tileflow/coordinates-runtime": ">=0.1.0-alpha.5 <0.1.0-beta.0",
|
|
42
|
-
"@tileflow/core": ">=0.1.0-alpha.
|
|
43
|
-
"@tileflow/dev": ">=0.1.0-alpha.
|
|
44
|
-
"@tileflow/maps": ">=0.1.0-alpha.
|
|
42
|
+
"@tileflow/core": ">=0.1.0-alpha.40 <0.1.0-beta.0",
|
|
43
|
+
"@tileflow/dev": ">=0.1.0-alpha.37 <0.1.0-beta.0",
|
|
44
|
+
"@tileflow/maps": ">=0.1.0-alpha.14 <0.1.0-beta.0",
|
|
45
45
|
"commander": "^15.0.0",
|
|
46
|
-
"hono": "4.13.
|
|
46
|
+
"hono": "4.13.13",
|
|
47
47
|
"picocolors": "^1.1.1",
|
|
48
48
|
"zod": "^4.4.3"
|
|
49
49
|
},
|