@weasel-js/labkit 1.6.1 → 1.7.1

package/dist/{chunk-CQLQPQ4P.js → chunk-ZQIHJXP4.js}

@@ -4,5 +4,5 @@ import { createContext } from 'react';
 var CanvasStackContext = createContext(null);
 
 export { CanvasStackContext };
-//# sourceMappingURL=chunk-CQLQPQ4P.js.map
-//# sourceMappingURL=chunk-CQLQPQ4P.js.map
+//# sourceMappingURL=chunk-ZQIHJXP4.js.map
+//# sourceMappingURL=chunk-ZQIHJXP4.js.map

package/dist/chunk-ZQIHJXP4.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/canvas/CanvasStackContext.ts"],"names":[],"mappings":";;;AAgCO,IAAM,kBAAA,GAAqB,cAA8C,IAAI","file":"chunk-ZQIHJXP4.js","sourcesContent":["import { createContext, type RefObject } from 'react';\nimport type { ViewTransform } from '../instrument/types';\nimport type { CanvasLayerDescriptor } from './useLayerScheduler';\nimport type { WorldFrame, WorldSpec } from './worldSpec';\n\n/** The stack's own drawing surface, for an overlay that has to re-draw it at\n *  another camera or read back what it presented — a loupe. */\nexport interface CanvasStackSurface {\n  /** The element the layers are stacked in, and the one pan/zoom listens on. */\n  element: RefObject<HTMLElement | null>;\n  /** Its measured CSS size, and the ratio the backing stores are scaled by. */\n  size: { width: number; height: number; dpr: number };\n  /** The presented `<canvas>` per layer id. */\n  canvases: RefObject<Map<string, HTMLCanvasElement>>;\n  /** The layers as the stack is drawing them, bottom first. */\n  layers: readonly CanvasLayerDescriptor[];\n  /** The coordinate system the stack was given, which `frame` resolves at\n   *  its size — for a re-draw at another size. */\n  worldSpec?: WorldSpec;\n}\n\n/** What a canvas stack publishes to its children: the view, and the resolved\n *  coordinate system it is read in, so DOM overlays can place themselves in the\n *  same coordinates the layers draw in. */\nexport interface CanvasStackContextValue {\n  view: ViewTransform;\n  frame: WorldFrame;\n  /** Absent from a context assembled by hand, which has no stack behind it. */\n  surface?: CanvasStackSurface;\n}\n\n/** Context carrying the surrounding canvas stack's view and world frame. */\nexport const CanvasStackContext = createContext<CanvasStackContextValue | null>(null);\n"]}

package/dist/config/index.d.ts

@@ -1,13 +1,15 @@
-import { a5 as Auto } from '../_dts/types-B7yBTTF9.js';
+import { a4 as Auto } from '../_dts/index-DCMA4Fy1.js';
 import { Instrument } from '../index.js';
-export { aC as auto, aI as isAuto } from '../_dts/types-B7yBTTF9.js';
-import { R as ResolvedConfig, l as ConfigNode, A as Annotations, N as NodeOptions, S as SectionOption, d as ControlRenderer, I as InDialogOptions, n as ConfigOption, p as ConfigShape, h as ConfigBranch, B as BranchAnnotations, e as BranchOptions, b as ConfigSchema, q as InferConfig, i as ConfigEntry, c as ConfigRule, L as LeafPatch, o as ConfigRuleContext } from '../_dts/types-DTuViBvc.js';
+export { aw as auto, aC as isAuto } from '../_dts/index-DCMA4Fy1.js';
+import { R as ResolvedConfig, k as ConfigNode, A as Annotations, N as NodeOptions, S as SectionOption, c as ControlRenderer, I as InDialogOptions, m as ConfigOption, p as ConfigShape, g as ConfigBranch, B as BranchAnnotations, d as BranchOptions, C as ConfigSchema, q as InferConfig, h as ConfigEntry, b as ConfigRule, L as LeafPatch, o as ConfigRuleContext } from '../_dts/types-BUBSIZuV.js';
 import { ConfigField } from '../controls/index.js';
-export { m as ConfigOf, C as ConfigPath, D as DialogSpec, E as EntryValue, r as NodeValue, t as SectionSpec, V as ValueAtPath } from '../_dts/types-DTuViBvc.js';
-import { ToolPrefNumberFormat, ToolPrefNumberUnit, ToolPrefLeaf, ToolPrefGroup } from '@weasel-js/core';
+export { l as ConfigOf, n as ConfigPath, D as DialogSpec, E as EntryValue, r as NodeValue, t as SectionSpec, V as ValueAtPath } from '../_dts/types-BUBSIZuV.js';
+import { Display } from '@weasel-js/quantity';
+import { PrefNumberUnit, PrefLeaf, PrefGroup } from '@weasel-js/ui';
+import '@weasel-js/core';
 import 'react';
-import '../_dts/PrefsRow.d-DFpPIeIC.js';
 import '@weasel-js/theme';
+import '@weasel-js/geom';
 import '../_dts/types-DJ79Tg5J.js';
 
 /** The dotted paths a schema declares as starting auto — every leaf that said
@@ -73,6 +75,7 @@ declare abstract class BaseNode<T> implements ConfigNode<T> {
     /** Never auto. The row's label does not toggle. */
     manual(): this;
 }
+/** A numeric leaf, built by `f.number`. */
 declare class NumberNode extends BaseNode<number> {
     readonly kind = "number";
     /** Bound the value. A number with both bounds renders as a slider. */
@@ -81,26 +84,28 @@ declare class NumberNode extends BaseNode<number> {
     /** A display suffix for the value — `'px'`, `'ms'`, `'°'`. Presentation only:
      *  it is never parsed, and the stored value stays a plain number. */
     suffix(suffix: string): this;
-    /** Show the value in a named format — `'compact'` reads `2.00M`. Presentation
-     *  only: the stored value stays a plain number, and a typed `2.5m` reads back. */
-    format(format: ToolPrefNumberFormat): this;
+    /** Show, speak and read the value through a display — `compact()` reads
+     *  `2.00M`. Presentation only: the stored value stays a plain number. */
+    display(display: Display): this;
     /**
      * Store the value in one unit and edit it in another — radians stored,
      * degrees typed. `min`, `max` and `step` are declared in the stored unit
      * alongside the value, and convert with it. `prefUnit` builds one from a
      * `UnitSystem`.
      */
-    unit(unit: ToolPrefNumberUnit): this;
+    unit(unit: PrefNumberUnit): this;
     /** Force a slider even without both bounds. */
     slider(): this;
     /** Force a typed input even when both bounds are set. */
     input(): this;
 }
+/** A true/false leaf, built by `f.boolean`; a checkbox unless `.toggle()`. */
 declare class BooleanNode extends BaseNode<boolean> {
     readonly kind = "boolean";
     /** Ask for a switch rather than a checkbox. */
     toggle(): this;
 }
+/** A text leaf, built by `f.string`. */
 declare class StringNode extends BaseNode<string> {
     readonly kind = "string";
     placeholder(placeholder: string): this;
@@ -108,17 +113,20 @@ declare class StringNode extends BaseNode<string> {
     /** Milliseconds to debounce live writes. 0 commits every keystroke. */
     debounce(debounceMs: number): this;
 }
+/** A string-list leaf, built by `f.list`. */
 declare class ListNode extends BaseNode<string[]> {
     readonly kind = "list";
     /** Shown in an empty entry. */
     placeholder(placeholder: string): this;
 }
+/** A color leaf holding a hex string, built by `f.color`. */
 declare class ColorNode extends BaseNode<string> {
     readonly kind = "color";
     /** The value carries alpha as `#rrggbbaa`, and the row gets an opacity
      *  track beside the swatch. */
     alpha(): this;
 }
+/** A fixed-choice leaf, built by `f.enum`; a select unless `.radio()`. */
 declare class EnumNode<T extends string> extends BaseNode<T> {
     readonly kind = "enum";
     /** Render as a segmented control rather than a select. */
@@ -158,6 +166,9 @@ declare class GroupNode<S extends ConfigShape> implements ConfigBranch<S> {
     /** Show this group only while the predicate holds. Presentational — every
      *  value beneath it stays in config and the instrument still reads it. */
     showIf(predicate: (config: Record<string, unknown>) => boolean): GroupNode<S>;
+    /** Put a button on the group's heading that returns every value beneath it
+     *  to its default, leaving the rest of the config alone. */
+    resettable(): GroupNode<S>;
 }
 /**
  * Builds an instrument's config: the values, their types, and how each is
@@ -192,7 +203,7 @@ declare const f: {
      *  Groups nest as deeply as the schema wants. */
     group: <const S extends ConfigShape>(children: S) => GroupNode<S>;
     /** A leaf of a kind a lab supplies the control for, through `controls`. */
-    custom: <T>(kind: string, def: T, validate?: (leaf: ToolPrefLeaf, config: Record<string, unknown>) => string[]) => CustomNode<T>;
+    custom: <T>(kind: string, def: T, validate?: (leaf: PrefLeaf, config: Record<string, unknown>) => string[]) => CustomNode<T>;
     /** Collect leaves and groups into an instrument's config. */
     schema<S extends ConfigShape>(nodes: S): ConfigSchema<InferConfig<S>>;
 };
@@ -203,6 +214,10 @@ declare const f: {
  *
  * Rules do not run here: a hand-written `ConfigField` already states its label
  * and control, which is everything the rule chain would have inferred.
+ *
+ * A dotted `key` is a config path, as it is to every read and write, so its
+ * leaf is filed under headless groups at that path rather than as one child
+ * whose name contains dots — which no path lookup would find.
  */
 declare function fromConfigFields(fields: readonly ConfigField[]): ResolvedConfig;
 
@@ -227,7 +242,7 @@ declare function withValueAtPath<T>(config: T, path: string, value: unknown): T;
 declare function fillConfigDefaults<T>(stored: unknown, defaults: T): T;
 /** A node in a resolved schema tree, by dotted path. Structural rather than
  *  `isPrefLeaf` so this stays free of a runtime import. */
-declare function schemaNodeAtPath(group: ToolPrefGroup, path: string): ToolPrefLeaf | ToolPrefGroup | undefined;
+declare function schemaNodeAtPath(group: PrefGroup, path: string): PrefLeaf | PrefGroup | undefined;
 
 /**
  * Resolve a schema into the vocabulary weasel-ui renders, running each leaf
@@ -269,7 +284,7 @@ declare function applyRules(seed: LeafPatch, ctx: Omit<ConfigRuleContext, 'leaf'
 interface SectionTree {
     /** The rail's schema. Top-level children are the schema's root sections,
      *  followed by any root node no section claimed. */
-    group: ToolPrefGroup;
+    group: PrefGroup;
     /** `config` renested to mirror `group` — the value tree `PrefsForm` takes. */
     values: Record<string, unknown>;
     /** The config path a path within `group` stands for. */

package/dist/config/index.js

@@ -1,7 +1,7 @@
-export { sectionTree, useConfigSchema } from '../chunk-GHGO52SO.js';
+export { sectionTree, useConfigSchema } from '../chunk-E6NARGU7.js';
 import '../chunk-Z76KEZAX.js';
-export { BaseNode, BooleanNode, ColorNode, CustomNode, EnumNode, GroupNode, ListNode, NumberNode, StringNode, ValueNode, applyRules, builtinRules, f, isConfigBranch, resolveConfigSchema, titleCase, useResolvedConfig } from '../chunk-O6FFFOHS.js';
-export { fromConfigFields, isLeafVisible } from '../chunk-IRTGUQ5O.js';
-export { auto, autoPathsOf, fillConfigDefaults, hasConfigPath, isAuto, resolveAutoConfig, schemaNodeAtPath, valueAtPath, withValueAtPath } from '../chunk-TJ77A4A3.js';
+export { BaseNode, BooleanNode, ColorNode, CustomNode, EnumNode, GroupNode, ListNode, NumberNode, StringNode, ValueNode, applyRules, builtinRules, f, isConfigBranch, resolveConfigSchema, titleCase, useResolvedConfig } from '../chunk-YCFKW5RX.js';
+export { fromConfigFields, isLeafVisible } from '../chunk-WLMDTI2Q.js';
+export { auto, autoPathsOf, fillConfigDefaults, hasConfigPath, isAuto, resolveAutoConfig, schemaNodeAtPath, valueAtPath, withValueAtPath } from '../chunk-READTDQX.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/controls/index.d.ts

@@ -1,13 +1,10 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { StanceProps } from '../passthrough/weasel-ui.js';
-import { PropertyRowLayout } from '../index.js';
-import { PropertyDensity, PropertyAlign } from '../passthrough/weasel-ui.js';
-import { a as ConfigField, I as InDialogOptions } from '../_dts/types-DTuViBvc.js';
+import { StanceProps, PropertyRowLayout, PropertyDensity, PropertyAlign } from '@weasel-js/ui';
+import { a as ConfigField, I as InDialogOptions } from '../_dts/types-BUBSIZuV.js';
 import { ResolvedConfig, ControlRenderer } from '../config/index.js';
-export { f as CheckboxField, g as ColorField, k as ConfigFieldType, s as NumberField, u as SelectField, v as SelectOption, w as SliderField, T as TextField } from '../_dts/types-DTuViBvc.js';
-import '@weasel-js/theme';
-import '@weasel-js/core';
+export { e as CheckboxField, f as ColorField, j as ConfigFieldType, s as NumberField, u as SelectField, v as SelectOption, w as SliderField, T as TextField } from '../_dts/types-BUBSIZuV.js';
+import '@weasel-js/quantity';
 
 /** How a panel packs its rows into the two-column property grid.
  *   - `'auto'`: narrow controls (numbers, checkboxes, dropdowns, colors) sit

package/dist/controls/index.js

@@ -1,7 +1,8 @@
-export { ControlPanel, inDialog, summarizeValue } from '../chunk-ASOK76ZH.js';
-import '../chunk-IRTGUQ5O.js';
-import '../chunk-TJ77A4A3.js';
-import '../chunk-TYN6MLXX.js';
-import '../chunk-QGMOA2YE.js';
+export { ControlPanel, inDialog, summarizeValue } from '../chunk-JFOJESJF.js';
+import '../chunk-WLMDTI2Q.js';
+import '../chunk-READTDQX.js';
+import '../chunk-4KSC7NXL.js';
+import '../chunk-E23Q6A3Y.js';
+import '../chunk-XVUKDSYV.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/dragdrop/index.d.ts

@@ -1,19 +1,25 @@
-import { n as PaletteItem, o as DragFeedback, q as DragDropCapability } from '../_dts/types-B7yBTTF9.js';
+import { l as PaletteItem, m as DragFeedback, n as DragDropCapability } from '../_dts/index-DCMA4Fy1.js';
 import { WorldSpec } from '../canvas/index.js';
 import { Point, ViewTransform } from '../index.js';
 import * as react from 'react';
 import { RefObject, PointerEvent, ReactPortal } from 'react';
+import '@weasel-js/ui';
 import '@weasel-js/core';
-import '../_dts/PrefsRow.d-DFpPIeIC.js';
 import '@weasel-js/theme';
-import '../_dts/types-DTuViBvc.js';
+import '../_dts/types-BUBSIZuV.js';
+import '@weasel-js/quantity';
+import '@weasel-js/geom';
 import '../_dts/types-DJ79Tg5J.js';
 
+/** A palette drag in progress. `screenPos` is in client pixels; `feedback` is
+ *  the last `onDragOver` answer — `null` off the canvas or without one. */
 interface DragState {
     item: PaletteItem;
     screenPos: Point;
     feedback: DragFeedback | null;
 }
+/** Inputs to `useDragDrop`: the capability, the element that counts as the
+ *  drop target, and the trial state a drop rewrites. */
 interface UseDragDropArgs<TS, TC> {
     capability: DragDropCapability<TS, TC>;
     canvasContainerRef: RefObject<HTMLElement | null>;
@@ -26,27 +32,41 @@ interface UseDragDropArgs<TS, TC> {
     setState: (next: TS | ((prev: TS) => TS)) => void;
     emit: (event: string) => void;
 }
+/** The live drag, and the handler a palette item calls on pointerdown. */
 interface UseDragDropResult {
     drag: DragState | null;
     startDrag: (item: PaletteItem, e: PointerEvent) => void;
 }
+/**
+ * Run palette-to-canvas drags for a `DragDropCapability`. Releasing over the
+ * container converts the pointer to world coordinates, applies `onDrop`'s
+ * state and emits `'canvas.itemAdded'`; releasing anywhere else, or a canceled
+ * gesture, drops nothing. `onDragOver` is probed at most once per frame.
+ */
 declare function useDragDrop<TS, TC>({ capability, canvasContainerRef, view, state, config, setState, emit, worldSpec, }: UseDragDropArgs<TS, TC>): UseDragDropResult;
+/** Props for `DragOverlay`. */
 interface DragOverlayProps {
     drag: DragState | null;
 }
+/** The ghost for `drag`, or nothing when no drag is live. */
 declare function DragOverlay({ drag }: DragOverlayProps): react.JSX.Element | null;
 
+/** Props for `DragGhost`. `screenPos` is in client pixels. */
 interface DragGhostProps {
     item: PaletteItem;
     screenPos: Point;
 }
+/** The dragged item's label, portaled to `document.body` just below-right of
+ *  `screenPos`. Renders nothing until mounted, so it is SSR-safe. */
 declare function DragGhost({ item, screenPos }: DragGhostProps): ReactPortal | null;
 
+/** Props for `Palette`. `onDragStart` is usually `useDragDrop`'s `startDrag`. */
 interface PaletteProps {
     items: PaletteItem[];
     onDragStart: (item: PaletteItem, e: PointerEvent) => void;
     className?: string;
 }
+/** One button per item, each starting a drag on pointerdown. */
 declare function Palette({ items, onDragStart, className }: PaletteProps): react.JSX.Element;
 
 export { DragDropCapability, DragFeedback, DragGhost, DragOverlay, Palette, PaletteItem, useDragDrop };

package/dist/dragdrop/index.js

@@ -1,5 +1,6 @@
-export { DragGhost, DragOverlay, Palette, useDragDrop } from '../chunk-WPLAANH4.js';
-import '../chunk-AWQG7FCC.js';
-import '../chunk-24W5VEJW.js';
+export { DragGhost, DragOverlay, Palette, useDragDrop } from '../chunk-2N7UBSS2.js';
+import '../chunk-FG3EXZDV.js';
+import '../chunk-ULYYNWGP.js';
+import '../chunk-XVUKDSYV.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map