@weasel-js/labkit 1.4.0-pre.1 → 1.4.1

package/dist/_dts/PrefsForm-BkUJZx0A.d.ts

@@ -1,204 +0,0 @@
-import { ReactNode } from 'react';
-
-/** The value types a built-in pref leaf can hold. */
-type ToolPrefKind = 'number' | 'boolean' | 'string' | 'enum' | 'color' | 'paint' | 'object';
-interface ToolPrefBase<K extends string, Value> {
-    kind: K;
-    /** Human-readable label. */
-    name: string;
-    /** Longer help text — shown in tooltips / a settings pane. */
-    description: string;
-    /** Fallback when nothing is persisted. */
-    default: Value;
-    /** Hide from a host app's settings UI by default. */
-    hidden?: boolean;
-    /** Render full-width with no label row in schema-driven settings UIs
-     *  (weasel-ui `PrefsForm` honors this for leaves whose control brings
-     *  its own chrome). */
-    block?: boolean;
-    /** Glyph naming this leaf in a host UI's icon set (weasel-ui resolves it
-     *  against `ICON_PATHS`). A plain string because core ships no icon set and
-     *  cannot depend on one. Read where a leaf's `name` has nowhere to go — a
-     *  `pair`ed row is labeled by the pair, so its fields have only the glyph
-     *  to tell them apart. */
-    icon?: string;
-    /** Row-pairing hint for compact property UIs (weasel-ui
-     *  `SelectionPanel`): leaves sharing a `pair` id render side-by-side
-     *  on one row labeled with the `pair` string (e.g. `'Position'` for
-     *  `pose.x` / `pose.y`). Purely presentational. */
-    pair?: string;
-}
-/** How a schema-driven UI should present a number pref. */
-type ToolPrefNumberControl = 'input' | 'slider';
-/** How a schema-driven UI should present a boolean pref. */
-type ToolPrefBooleanControl = 'checkbox' | 'switch' | 'toggle';
-/** How a schema-driven UI should present a string pref. */
-type ToolPrefStringControl = 'input' | 'textarea';
-/** How a schema-driven UI should present an enum pref. */
-type ToolPrefEnumControl = 'select' | 'radio' | 'toggle';
-/** Display-unit conversion for number leaves whose stored value uses a
- *  canonical unit the user shouldn't see (e.g. radians stored, degrees
- *  shown). The stored value stays canonical; UIs convert at the edge. */
-interface ToolPrefNumberUnit {
-    toDisplay: (stored: number) => number;
-    fromDisplay: (display: number) => number;
-    /** Shown after the input, e.g. `'°'`. */
-    suffix?: string;
-}
-/** A numeric pref, optionally bounded and stepped, and optionally stored in a
- *  different unit from the one shown. */
-interface ToolPrefNumber extends ToolPrefBase<'number', number> {
-    min?: number;
-    max?: number;
-    step?: number;
-    control?: ToolPrefNumberControl;
-    unit?: ToolPrefNumberUnit;
-}
-/** An on/off pref. */
-interface ToolPrefBoolean extends ToolPrefBase<'boolean', boolean> {
-    control?: ToolPrefBooleanControl;
-    /** The label a `toggle` shows, since a `pair`ed row is named by the pair
-     *  rather than by the leaf. `name` stays the accessible name. */
-    short?: string;
-}
-/** A free-text pref. */
-interface ToolPrefString extends ToolPrefBase<'string', string> {
-    control?: ToolPrefStringControl;
-}
-/**
- * Stored-value bridge for an enum leaf whose value is not the option string —
- * the counterpart of {@link ToolPrefNumberUnit}, which does the same for a
- * number stored in a canonical unit.
- *
- * A dash array is the case that needs it: `Stroke.dash` stores lengths, and
- * the thing a person chooses is a style. The presets scale by the stroke's
- * width, so both directions are given the object's other fields — a style is
- * meaningless without the width it is a multiple of.
- */
-interface ToolPrefEnumEncoding<T extends string = string> {
-    /**
-     * The option `stored` reads as, or `undefined` for none — which a UI shows
-     * the way it shows a mixed selection, by selecting nothing.
-     *
-     * `siblings` is the object the leaf is a field of, or `undefined` when the
-     * node does not hold that object (and for a top-level leaf, which has none).
-     */
-    read: (stored: unknown, siblings: Record<string, unknown> | undefined) => T | undefined;
-    /** What to store for `option`. `undefined` removes the field. */
-    write: (option: T, siblings: Record<string, unknown> | undefined) => unknown;
-}
-/** A pref with a fixed set of labeled choices. */
-interface ToolPrefEnum<T extends string = string> extends ToolPrefBase<'enum', T> {
-    /** `short` is the label a segmented control uses when a full one would not
-     *  fit — a capital or two. `icon` names a glyph in the host UI's set
-     *  (weasel-ui resolves it against `ICON_PATHS`) and outranks `short` where
-     *  it resolves. It is a plain string because core ships no icon set and
-     *  cannot depend on one. The full `label` stays the accessible name, so
-     *  neither the abbreviation nor the glyph becomes the only thing naming
-     *  the option.
-     *
-     *  `disabled` marks an option a control reports but cannot author — the
-     *  value a stored form reads as when it matches nothing offered. Dropping it
-     *  from the list instead would leave the control selecting nothing and
-     *  claiming the field is unset. */
-    options: readonly {
-        value: T;
-        label: string;
-        short?: string;
-        icon?: string;
-        disabled?: boolean;
-    }[];
-    control?: ToolPrefEnumControl;
-    encoding?: ToolPrefEnumEncoding<T>;
-}
-/** A single color, stored as a hex string. For a value that may also be a
- *  gradient or a pattern, use {@link ToolPrefPaint} instead. */
-interface ToolPrefColor extends ToolPrefBase<'color', string> {
-    /** Value is `#rrggbb`, or `#rrggbbaa` when `alpha` is set (UIs then
-     *  offer an opacity control). */
-    alpha?: boolean;
-}
-/**
- * Open leaf: any node with a `kind` outside the built-ins. Schema-driven
- * UIs (weasel-ui `PrefsForm` / `SelectionPanel`) dispatch it to an
- * app-supplied renderer. Deliberately NOT index-signatured so concrete
- * app interfaces stay assignable. Mirrors weasel-ui's `PrefCustom`.
- */
-type ToolPrefCustom = ToolPrefBase<string, unknown>;
-/**
- * A whole `FillStyle`, not a color inside one. Use it wherever the value is
- * the tagged paint union — a solid color, a pattern, a gradient — rather
- * than a hex string.
- *
- * Addressing `…fill.color` instead reads `undefined` off a gradient (so the
- * control shows its default and claims the text is black) and writes a
- * hybrid `{ fill: 'gradient', stops, color }` that the renderer's structural
- * `'color' in paint` checks then paint flat solid. The union has to be
- * edited as a union.
- */
-interface ToolPrefPaint extends ToolPrefBase<'paint', unknown> {
-    /** Offer an opacity control alongside the color. */
-    alpha?: boolean;
-}
-/**
- * A leaf whose value is one object, with its own fields hanging off it.
- *
- * A compound value — a stroke, a shadow, a pattern spec — could be described
- * as several sibling leaves addressing into it (`data.stroke.width`,
- * `data.stroke.cap`). It shouldn't be: each control would then write one field
- * of a value it can only half see, and writing into something that is not an
- * object yet corrupts it. Here the fields are `children` of one leaf, and
- * every edit commits the parent object whole.
- *
- * `children` paths are relative to the object. They are ordinary leaves, so a
- * field that is itself a union (a stroke's `paint`) declares the kind that
- * edits that union. A child may also be a {@link ToolPrefGroup}, which
- * organises the fields under a heading without contributing to the path —
- * the same rule group keys follow at the top level. A `TextStyle` needs it:
- * its character and paragraph fields belong to one value but read as two
- * lists.
- */
-interface ToolPrefObject extends ToolPrefBase<'object', unknown> {
-    children: Record<string, ToolPrefLeaf | ToolPrefGroup>;
-    /**
-     * Lift a non-object value into the object form, for a consumer field that
-     * may also be held as a scalar. Called before a child edit is applied;
-     * without it a scalar-valued leaf shows its children empty and refuses the
-     * edit.
-     */
-    fromScalar?: (value: unknown) => Record<string, unknown>;
-}
-/** One built-in pref leaf. `ToolPrefLeaf` widens this to include
- *  app-defined kinds. */
-type ToolPref = ToolPrefNumber | ToolPrefBoolean | ToolPrefString | ToolPrefEnum | ToolPrefColor | ToolPrefPaint | ToolPrefObject;
-/** Built-in or app-defined leaf. */
-type ToolPrefLeaf = ToolPref | ToolPrefCustom;
-/** Nestable group: branch nodes a tool can use to organize its prefs. */
-interface ToolPrefGroup {
-    /** Heading for the group's rows. **Empty means no heading** — for a group
-     *  that exists to organise, not to name: one whose children are themselves
-     *  groups carrying the labels a reader needs. Give it a name whenever the
-     *  name is the referent (a `Border` group over `Top` / `Right` / `Bottom`
-     *  reads as nothing without it). */
-    name: string;
-    description?: string;
-    children: Record<string, ToolPrefLeaf | ToolPrefGroup>;
-}
-
-/** What a {@link PrefRenderer} is given for the leaf it is rendering. */
-interface PrefRenderContext {
-    /** Dotted path of the leaf within the schema root. */
-    path: string;
-    /** The schema node. App renderers narrow this to their own kind shape. */
-    pref: ToolPrefLeaf;
-    /** Current value — `values` at `path`, falling back to `pref.default`. */
-    value: unknown;
-    setValue: (value: unknown) => void;
-}
-/**
- * Renders the control cell for one preference leaf. Returning `null`
- * collapses the row.
- */
-type PrefRenderer = (ctx: PrefRenderContext) => ReactNode;
-
-export type { PrefRenderer as P, ToolPrefLeaf as T, ToolPrefGroup as a, ToolPref as b, ToolPrefBoolean as c, ToolPrefBooleanControl as d, ToolPrefColor as e, ToolPrefCustom as f, ToolPrefEnum as g, ToolPrefEnumControl as h, ToolPrefEnumEncoding as i, ToolPrefKind as j, ToolPrefNumber as k, ToolPrefNumberControl as l, ToolPrefNumberUnit as m, ToolPrefObject as n, ToolPrefPaint as o, PrefRenderContext as p, ToolPrefString as q, ToolPrefStringControl as r };

package/dist/_dts/fitViewToBounds-dZ2UDB6e.d.ts

@@ -1,21 +0,0 @@
-/**
- * Axis-aligned rectangle in world space. Kit-wide `Bounds` shape used by
- * selection, group, and viewport helpers. The optional `rotation` field
- * (radians, around the AABB center) lets selection chrome attach a rotated
- * orientation to an otherwise axis-aligned rect without needing a parallel
- * type.
- */
-interface Bounds {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    rotation?: number;
-}
-/** Pixel dimensions of the canvas viewport. */
-interface ViewportDims {
-    width: number;
-    height: number;
-}
-
-export type { Bounds as B, ViewportDims as V };

package/dist/_dts/shapeKinds-Cx_rxwsa.d.ts

@@ -1,87 +0,0 @@
-/**
- * The kit's built-in shape kinds — one table, every other spelling derived.
- *
- * Lives in `core/` rather than beside the shape tools because both layers ask
- * questions of the same set: the interactions layer decides whether
- * `insertAction` can paint a live preview for a kind, and the canvas layer
- * decides which shape tools `useBuiltinShapeTools` mounts and what
- * `BUNDLE_TOOLS` / `defaultNodeRouting` / `defaultNodeProperties` enumerate.
- *
- * This module imports nothing on purpose: `useBuiltinShapeTools` imports the
- * package barrel, so anything barrel-reachable that needs these lists at
- * module-evaluation time must not route through it.
- */
-/** What the kit knows about one built-in shape kind. */
-interface ShapeKindDescriptor {
-    /** Mounted as a built-in shape tool by `useBuiltinShapeTools`, and so a
-     *  member of `BuiltinShapeToolId` / `KIT_SHAPE_KINDS`. `image` is false:
-     *  `useImageTool` needs a `src` and can't be auto-mounted. */
-    readonly tool: boolean;
-    /** `insertAction` emits an `insertPreview` overlay for this kind, and the
-     *  dispatcher overlay layer knows how to draw it. Kinds without one still
-     *  commit; they just have no live drag preview (`pen` and `lasso` don't
-     *  route through `insertAction` at all). */
-    readonly insertPreview: boolean;
-}
-/**
- * Declaration order is the enumeration order of every derived list —
- * `KIT_SHAPE_KINDS`, and through it `defaultNodeRouting` /
- * `defaultNodeProperties` / `BUNDLE_TOOLS.exhaustive`.
- */
-declare const SHAPE_KINDS: {
-    readonly rect: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly ellipse: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly line: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly polygon: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly star: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly pen: {
-        readonly tool: true;
-        readonly insertPreview: false;
-    };
-    readonly pencil: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly lasso: {
-        readonly tool: true;
-        readonly insertPreview: false;
-    };
-    readonly text: {
-        readonly tool: true;
-        readonly insertPreview: true;
-    };
-    readonly image: {
-        readonly tool: false;
-        readonly insertPreview: true;
-    };
-};
-/** The keys of a shape-kind table whose descriptor sets `F` to `true`. */
-type ShapeKindsWhere<T, F extends keyof ShapeKindDescriptor> = {
-    [K in keyof T]: T[K] extends Record<F, true> ? K : never;
-}[keyof T];
-/**
- * Built-in shape tool ids handled by `useBuiltinShapeTools`. Each maps to a
- * kit tool hook + a default `create` that produces a leaf node compatible
- * with `PATH_PAINTER`.
- */
-type BuiltinShapeToolId = ShapeKindsWhere<typeof SHAPE_KINDS, 'tool'>;
-/** The insert kinds the kit's dispatcher overlay layer knows how to render.
- *  Consumer-defined kinds fall outside it: no live preview, commit unaffected. */
-type KitInsertShape = ShapeKindsWhere<typeof SHAPE_KINDS, 'insertPreview'>;
-
-export type { BuiltinShapeToolId as B, KitInsertShape as K };