@notionhq/custom-blocks-dev-shell 0.1.1 → 0.1.2

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 CHANGED
@@ -23,6 +23,17 @@ Options:
23
23
  - `--block-base-port <port>` — first port handed to the per-block dev servers
24
24
  (default 9876; blocks count up from there).
25
25
 
26
+ ## Data sources
27
+
28
+ The shell reads local data sources from the worker's `src/data/*.json` — one
29
+ source per file: `{ type: "worker", key, name, icon?, schema, rows }`, where
30
+ `schema` maps property keys to `{ name, type }` and each row carries a unique
31
+ string `id` plus values under the schema's keys. The format is documented in
32
+ full in [`docs/data-sources.md`](docs/data-sources.md), which ships with this
33
+ package. Files are validated at spin-up, and
34
+ a malformed file fails with the file and problem named. The shell shows
35
+ exactly the sources in `src/data/` — none yet means an empty DATA sidebar.
36
+
26
37
  ## Requirements
27
38
 
28
39
  - Node.js >= 20.19 (per Vite's own minimum for dev servers).