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
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@ executable. With another package manager, use its local-execution command and th
|
|
|
23
23
|
do not add a second lockfile or rely on a globally installed CLI.
|
|
24
24
|
|
|
25
25
|
`init` creates a singular `tileflow.config.ts` extending the official Streets map. `preview` opens
|
|
26
|
-
|
|
26
|
+
Inspector with that map, live reload, rendered-feature inspection, compiler attribution, zoom
|
|
27
27
|
curves, a sprite atlas, scene selection, saved captures, and before/after review.
|
|
28
28
|
|
|
29
29
|
Local validation, compilation, and asset preparation require no account or API key. Preview and
|
|
@@ -56,7 +56,7 @@ workspaces are advanced repository orchestration, not a second application autho
|
|
|
56
56
|
Use `describe` for bounded language discovery (`describe themes --json` lists palette requirements
|
|
57
57
|
and optional time-of-day composition), `inspect` for configuration and data, `capture`
|
|
58
58
|
for reproducible evidence, and `compare` for saved captures, semantic edits, styles, references or
|
|
59
|
-
baselines. `preview` opens
|
|
59
|
+
baselines. `preview` opens Inspector. These tools work in independent projects with
|
|
60
60
|
custom maps and data; official maps are optional.
|
|
61
61
|
|
|
62
62
|
See the [map authoring workflow](https://github.com/tileflow/tileflow-sdk/blob/main/packages/cli/docs/map-authoring.md)
|
|
@@ -69,31 +69,31 @@ it does not implicitly expose a public listener. `--theme <name>` selects a conc
|
|
|
69
69
|
`--scene <name>` selects a committed standalone scene.
|
|
70
70
|
|
|
71
71
|
Run `npx tileflow preview` from your project directory to load `tileflow.config.ts`, start the
|
|
72
|
-
watched server, and automatically open
|
|
72
|
+
watched server, and automatically open Inspector in your default browser once the server is
|
|
73
73
|
listening. Use `--config <path>` for another config or `--no-open` to start without opening a tab.
|
|
74
74
|
`--json` and `--renderer native` also keep the browser closed. The CLI always prints the local URL
|
|
75
75
|
in ordinary web preview output, so you can open it manually if browser launch is unavailable.
|
|
76
76
|
|
|
77
|
-
Opening
|
|
77
|
+
Opening Inspector through another loopback name, such as `localhost` instead of `127.0.0.1`,
|
|
78
78
|
redirects to the **Local** origin printed by the CLI, preserving camera and theme query parameters.
|
|
79
79
|
This keeps the map, palette controls, and workbench API on the same origin.
|
|
80
80
|
|
|
81
81
|
Run from the project directory and keep selected configs inside it, so capture commands copied from
|
|
82
|
-
|
|
82
|
+
Inspector resolve the same files. The project itself can live anywhere, independently of this SDK.
|
|
83
83
|
|
|
84
|
-
The default is one
|
|
84
|
+
The default is one Inspector pane, one watched artifact session, and one map renderer. Choose a
|
|
85
85
|
map, theme or configured scene in **Controls**. Map and theme pickers appear when there are multiple choices. **Compare → Compare live maps** adds a reference from the current
|
|
86
86
|
project; `--against-*` also supports a reference from another config. The native renderer retains its assets-only
|
|
87
87
|
preview endpoint.
|
|
88
88
|
|
|
89
|
-
Compare two configs live in
|
|
89
|
+
Compare two configs live in Inspector:
|
|
90
90
|
|
|
91
91
|
```sh
|
|
92
92
|
npx tileflow preview --config candidate/tileflow.config.ts --against-config reference/tileflow.config.ts
|
|
93
93
|
```
|
|
94
94
|
|
|
95
|
-
|
|
96
|
-
|
|
95
|
+
Inspector shares a camera across side-by-side, split, overlay, or blink views. Its inspection panels
|
|
96
|
+
show bounded feature and compiler information; invalid edits keep the last valid generation.
|
|
97
97
|
**Capture as reference** saves a starting point. After editing, **Capture & compare** reuses its
|
|
98
98
|
camera and frame to review the change. The selected reference lasts for this browser session.
|
|
99
99
|
|
|
@@ -112,7 +112,7 @@ npx tileflow inspect session --url http://127.0.0.1:3333 --json
|
|
|
112
112
|
|
|
113
113
|
Use the origin printed by your running preview. This reads browser observations, including their
|
|
114
114
|
age and stale flag; exact source lines and token ownership are not inferred. See the
|
|
115
|
-
[
|
|
115
|
+
[Inspector workflow](https://github.com/tileflow/tileflow-sdk/blob/main/packages/cli/docs/map-authoring.md#work-with-a-person-and-an-agent)
|
|
116
116
|
for storage and context bounds.
|
|
117
117
|
|
|
118
118
|
`--api-base-url` or `TILEFLOW_API_URL` changes the API origin used by the official preview sources.
|
|
@@ -222,13 +222,17 @@ browser bundle, copied prompt, or command-line argument.
|
|
|
222
222
|
```sh
|
|
223
223
|
npx tileflow login
|
|
224
224
|
npx tileflow whoami --json
|
|
225
|
+
npx tileflow deploy --origin https://www.example.com
|
|
225
226
|
npx tileflow deploy --map-id map_AbCdEfGhIjKlMnOp
|
|
226
227
|
npx tileflow status --map-id map_AbCdEfGhIjKlMnOp
|
|
227
228
|
```
|
|
228
229
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
230
|
+
Without `--map-id`, a logged-in `deploy` first creates the Map in the Team you administer (it asks,
|
|
231
|
+
or takes `--team @team`, when several qualify) with the browser access you choose: exact origins
|
|
232
|
+
with `--origin`, or `--any-website`. It prints the Map ID to use for later deploys;
|
|
233
|
+
`tileflow maps create` creates the Map without deploying. The Map ID is a public identifier, not a
|
|
234
|
+
credential or the portable `id` in your config. CI always deploys an existing Map with a deploy key
|
|
235
|
+
for that destination. `logout` removes the saved personal session.
|
|
232
236
|
|
|
233
237
|
Deploy publishes the compiled concrete-theme family and managed icon assets; it does not ask the
|
|
234
238
|
server to compile TypeScript. Repeating an unchanged deployment reuses its version. Build writers
|