@preset.nz/pom 0.1.5 → 0.1.6

package/README.md

@@ -37,6 +37,24 @@ await channel.run('value.set', { at: '/threads/warp', key: 'thread.tension', val
 - **Hooks**, through `useSyncExternalStore`: `useNode(id)`, `useNodeAt(path)`, `useChildren(id, order)` and `useStatus()`, under a `<PomProvider mirror={mirror}>`. A hook returns the same object until its own node changes.
 - **Wire types** (`Row`, `View`, `Update`, `Status`, `Ran`, ...) follow the Rust structs. The tests read the Rust goldens, so a shape that moves in one half fails the other's build.
 
+## Words for people
+
+A type and its values may carry words for people. The core stores them and never reads them; they reach `Schema` (and `wire.ts`) only when given.
+
+```rust
+NodeType::new("echo")
+    .label("Echo")
+    .summary("Repeats what it hears, quieter each time.")
+    .group("effect")
+    .float("echo.time", 1.0..=2000.0, 250.0)
+    .described("Time", "How long before it repeats.") // the value just added
+    .unit("ms")
+```
+
+`ValueSpec` has the same `label`, `description`, `described` and `unit` builders, for values passed whole (`.value(...)`, `.bindable([...])`). An int value can also carry `.names(&["Off", "Half", "Full"])`, display names for its steps from the range's minimum; the docs show them as the range and the default. The docs scale a `%` value ×100 (stored 0.3 reads "30%") and show `Hz` and `ms` from 1000 up as `kHz` and `s`. Read them back from `NodeType::label_text`, `summary_text` and `group_tag`, or from `ValueSpec`'s fields.
+
+The pages themselves come from [preset-docs](https://github.com/preset-nz/preset-docs), which reads a `Schema` with its `rhizome` feature (`Catalogue::from(&schema)`). It moved out of this repo on 2026-10-14, so a change to how pages read doesn't wait on a rhizome release.
+
 ## Tests
 
 `just check` runs `check-rust` (fmt, clippy and every suite) and `check-ts` (tsc, Biome and vitest), then the licence check.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@preset.nz/pom",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "The webview client of rhizome-pom-tauri: an ordered command channel, a read-only mirror of the document and React hooks over it.",
   "license": "MIT",
   "repository": {
@@ -28,12 +28,12 @@
     "@testing-library/react": "^16",
     "@types/node": "^24",
     "@types/react": "^19",
+    "@types/react-dom": "^19",
     "jsdom": "^27",
     "lefthook": "^2.1.17",
     "react": "^19",
     "react-dom": "^19",
-    "@types/react-dom": "^19",
-    "typescript": "^5.8.3",
+    "typescript": "^7.0.2",
     "vitest": "^4.1.11"
   }
 }

package/src-ts/wire.ts

@@ -95,6 +95,16 @@ export interface ValueSchema {
   shape?: Shape;
   /** The range's max is a control's end, not a limit. Absent when false. */
   soft_max?: boolean;
+  /** What a person calls the value. Absent when the app gave none. */
+  label?: string;
+  /** One sentence on what the value does. */
+  description?: string;
+  /** A short unit shown after the number, such as `Hz`. */
+  unit?: string;
+  /** Display names for an int value's steps, in order from the range's minimum. */
+  names?: string[];
+  /** Display labels for some of the choices, by choice. Absent when none. */
+  choice_labels?: Record<string, string>;
 }
 
 /** rhizome-core `CategorySchema`. */
@@ -106,6 +116,14 @@ export interface CategorySchema {
 /** rhizome-core `TypeSchema`. */
 export interface TypeSchema {
   name: string;
+  /** What a person calls the type. Absent when the app gave none. */
+  label?: string;
+  /** One sentence on what a node of this type is. */
+  summary?: string;
+  /** The app's free tag for sorting its types, such as `effect`. */
+  group?: string;
+  /** What the node is to someone browsing, such as `colour`; beside `group`. Absent when the app gave none. */
+  category?: string;
   categories?: string[];
   values?: ValueSchema[];
   refs?: string[];