@elaraai/east-ui 1.0.4 → 1.0.6

package/dist/src/collections/schematic/types.js

@@ -0,0 +1,247 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+import { ArrayType, BooleanType, FloatType, FunctionType, NullType, OptionType, StringType, StructType, VariantType, } from "@elaraai/east";
+import { StatusTokenType } from "../../style/interaction.js";
+/**
+ * Theme tone for zone strokes, hatching, and links.
+ *
+ * @remarks
+ * Colour stays theme-owned: data selects a tone and the renderer's recipe
+ * maps each tone to its token.
+ *
+ * @property brand - Brand teal
+ * @property ink - Foreground ink
+ * @property muted - Muted foreground
+ * @property success - Status ok
+ * @property warning - Status warn
+ * @property danger - Status bad
+ */
+export const SchematicToneType = VariantType({
+    /** Brand teal */
+    brand: NullType,
+    /** Foreground ink */
+    ink: NullType,
+    /** Muted foreground */
+    muted: NullType,
+    /** Status ok */
+    success: NullType,
+    /** Status warn */
+    warning: NullType,
+    /** Status bad */
+    danger: NullType,
+});
+/**
+ * Zone render pattern — each case carries its style configuration.
+ *
+ * @property outline - Dashed boundary with an eyebrow label (rooms, cells)
+ * @property hatch - Hatched band (walkways, aisles, exclusion strips)
+ */
+export const SchematicZonePatternType = VariantType({
+    /** Dashed boundary with an eyebrow label (rooms, cells) */
+    outline: StructType({
+        /** Stroke tone (default `muted`) */
+        tone: OptionType(SchematicToneType),
+    }),
+    /** Hatched band (walkways, aisles, exclusion strips) */
+    hatch: StructType({
+        /** Hatch-line tone (default `muted`) */
+        tone: OptionType(SchematicToneType),
+        /** Line spacing in pixels (default 8) */
+        spacing: OptionType(FloatType),
+        /** Line angle in degrees (default 45) */
+        angle: OptionType(FloatType),
+    }),
+});
+/**
+ * Link render style — each case carries its stroke configuration.
+ *
+ * @property solid - A physical run (pipe, conveyor)
+ * @property dashed - A routing / logical connection
+ */
+export const SchematicLinkStyleType = VariantType({
+    /** A physical run (pipe, conveyor) */
+    solid: StructType({
+        /** Stroke tone (default `brand`) */
+        tone: OptionType(SchematicToneType),
+        /** Stroke width in pixels (default 2.5) */
+        weight: OptionType(FloatType),
+    }),
+    /** A routing / logical connection */
+    dashed: StructType({
+        /** Stroke tone (default `muted`) */
+        tone: OptionType(SchematicToneType),
+        /** Stroke width in pixels (default 1.5) */
+        weight: OptionType(FloatType),
+    }),
+});
+/**
+ * Link routing mode.
+ *
+ * @remarks
+ * `orthogonal` (the default) routes axis-aligned with rounded corners —
+ * the conventional pipe-diagram look; `direct` draws straight segments
+ * between anchors. `via` waypoints apply in both modes.
+ *
+ * @property orthogonal - Axis-aligned with rounded corners
+ * @property direct - Straight segments between anchors
+ */
+export const SchematicRouteType = VariantType({
+    /** Axis-aligned with rounded corners */
+    orthogonal: StructType({
+        /** Corner radius in pixels (default 8) */
+        corner: OptionType(FloatType),
+    }),
+    /** Straight segments between anchors */
+    direct: NullType,
+});
+/**
+ * A world-coordinate point (used by link waypoints).
+ *
+ * @property x - World x
+ * @property y - World y
+ */
+export const SchematicPointType = StructType({
+    /** World x */
+    x: FloatType,
+    /** World y */
+    y: FloatType,
+});
+/**
+ * A resolved placed item (node card).
+ *
+ * @property key - Item identity — links reference it; `onSelect` returns it
+ * @property x - World x of the card centre
+ * @property y - World y of the card centre
+ * @property label - Primary identity line
+ * @property sublabel - Optional muted second line (kind / capacity)
+ * @property icon - Optional Font Awesome solid icon name
+ * @property status - Optional status dot tone
+ * @property meter - Optional mini utilisation bar
+ * @property metric - Optional live metric text
+ * @property width - Optional world width — renders the wide bar form
+ */
+export const SchematicItemType = StructType({
+    /** Item identity — links reference it; `onSelect` returns it */
+    key: StringType,
+    /** World x of the card centre */
+    x: FloatType,
+    /** World y of the card centre */
+    y: FloatType,
+    /** Primary identity line */
+    label: StringType,
+    /** Optional muted second line (kind / capacity) */
+    sublabel: OptionType(StringType),
+    /** Optional Font Awesome solid icon name */
+    icon: OptionType(StringType),
+    /** Optional status dot tone */
+    status: OptionType(StatusTokenType),
+    /** Optional mini utilisation bar */
+    meter: OptionType(StructType({
+        /** Current value */
+        value: FloatType,
+        /** Full-scale value */
+        max: FloatType,
+    })),
+    /** Optional live metric text */
+    metric: OptionType(StringType),
+    /** Optional world width — renders the wide bar form */
+    width: OptionType(FloatType),
+});
+/**
+ * A resolved annotation zone (room, cell, walkway band).
+ *
+ * @property key - Zone identity
+ * @property label - Mono eyebrow label on the boundary
+ * @property x - World x of the top-left corner
+ * @property y - World y of the top-left corner
+ * @property width - World width
+ * @property height - World height
+ * @property pattern - Render pattern (`outline` / `hatch`)
+ */
+export const SchematicZoneType = StructType({
+    /** Zone identity */
+    key: StringType,
+    /** Mono eyebrow label on the boundary */
+    label: StringType,
+    /** World x of the top-left corner */
+    x: FloatType,
+    /** World y of the top-left corner */
+    y: FloatType,
+    /** World width */
+    width: FloatType,
+    /** World height */
+    height: FloatType,
+    /** Render pattern (`outline` / `hatch`) */
+    pattern: SchematicZonePatternType,
+});
+/**
+ * A resolved link between two placed items.
+ *
+ * @property key - Link identity
+ * @property from - Source item key
+ * @property to - Destination item key
+ * @property style - Render style (`solid` / `dashed`, with stroke config)
+ * @property route - Routing mode (`orthogonal` / `direct`)
+ * @property via - Optional world-coordinate waypoints, in order
+ */
+export const SchematicLinkType = StructType({
+    /** Link identity */
+    key: StringType,
+    /** Source item key */
+    from: StringType,
+    /** Destination item key */
+    to: StringType,
+    /** Render style (`solid` / `dashed`, with stroke config) */
+    style: SchematicLinkStyleType,
+    /** Routing mode (`orthogonal` / `direct`) */
+    route: SchematicRouteType,
+    /** Optional world-coordinate waypoints, in order */
+    via: ArrayType(SchematicPointType),
+});
+/**
+ * East StructType for the Schematic component.
+ *
+ * @remarks
+ * A 2D world-coordinate canvas for placing real-world entities (tanks,
+ * bays, lines, cells) plus annotation zones and links, all from flat data
+ * tables. **Read-only**: single-click selection only — no events, no drag
+ * & drop; editing routes through the linked Library.
+ *
+ * @property extent - World-coordinate bounds (the canvas scales to fit)
+ * @property items - The placed items
+ * @property zones - Annotation zones (rooms, cells, walkway bands)
+ * @property links - Connections between items, addressed by key
+ * @property scaleUnit - Optional unit for the bottom-right scale bar
+ * @property grid - Metric grid aligned to the scale legend
+ * @property navigator - Navigator rail (zones → items TOC)
+ * @property minimap - Minimap with the viewport rectangle
+ * @property onSelect - Optional item-click callback (receives the item key)
+ */
+export const SchematicRootType = StructType({
+    /** World-coordinate bounds (the canvas scales to fit) */
+    extent: StructType({
+        /** World width */
+        width: FloatType,
+        /** World height */
+        height: FloatType,
+    }),
+    /** The placed items */
+    items: ArrayType(SchematicItemType),
+    /** Annotation zones (rooms, cells, walkway bands) */
+    zones: ArrayType(SchematicZoneType),
+    /** Connections between items, addressed by key */
+    links: ArrayType(SchematicLinkType),
+    /** Optional unit for the bottom-right scale bar */
+    scaleUnit: OptionType(StringType),
+    /** Metric grid aligned to the scale legend; default on */
+    grid: OptionType(BooleanType),
+    /** Navigator rail (zones → items TOC); default: shown when zones exist */
+    navigator: OptionType(BooleanType),
+    /** Minimap with the viewport rectangle; default: shown for large canvases */
+    minimap: OptionType(BooleanType),
+    /** Optional item-click callback (receives the item key) */
+    onSelect: OptionType(FunctionType([StringType], NullType)),
+});
+//# sourceMappingURL=types.js.map

package/dist/src/collections/schematic/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/collections/schematic/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,GACd,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW,CAAC;IACzC,iBAAiB;IACjB,KAAK,EAAE,QAAQ;IACf,qBAAqB;IACrB,GAAG,EAAE,QAAQ;IACb,uBAAuB;IACvB,KAAK,EAAE,QAAQ;IACf,gBAAgB;IAChB,OAAO,EAAE,QAAQ;IACjB,kBAAkB;IAClB,OAAO,EAAE,QAAQ;IACjB,iBAAiB;IACjB,MAAM,EAAE,QAAQ;CACnB,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,WAAW,CAAC;IAChD,2DAA2D;IAC3D,OAAO,EAAE,UAAU,CAAC;QAChB,oCAAoC;QACpC,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC;KACtC,CAAC;IACF,wDAAwD;IACxD,KAAK,EAAE,UAAU,CAAC;QACd,wCAAwC;QACxC,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC;QACnC,yCAAyC;QACzC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC;QAC9B,yCAAyC;QACzC,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC;KAC/B,CAAC;CACL,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAAC;IAC9C,sCAAsC;IACtC,KAAK,EAAE,UAAU,CAAC;QACd,oCAAoC;QACpC,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC;QACnC,2CAA2C;QAC3C,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC;KAChC,CAAC;IACF,qCAAqC;IACrC,MAAM,EAAE,UAAU,CAAC;QACf,oCAAoC;QACpC,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC;QACnC,2CAA2C;QAC3C,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC;KAChC,CAAC;CACL,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC;IAC1C,wCAAwC;IACxC,UAAU,EAAE,UAAU,CAAC;QACnB,0CAA0C;QAC1C,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC;KAChC,CAAC;IACF,wCAAwC;IACxC,MAAM,EAAE,QAAQ;CACnB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,cAAc;IACd,CAAC,EAAE,SAAS;IACZ,cAAc;IACd,CAAC,EAAE,SAAS;CACf,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,gEAAgE;IAChE,GAAG,EAAE,UAAU;IACf,iCAAiC;IACjC,CAAC,EAAE,SAAS;IACZ,iCAAiC;IACjC,CAAC,EAAE,SAAS;IACZ,4BAA4B;IAC5B,KAAK,EAAE,UAAU;IACjB,mDAAmD;IACnD,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAChC,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAC5B,+BAA+B;IAC/B,MAAM,EAAE,UAAU,CAAC,eAAe,CAAC;IACnC,oCAAoC;IACpC,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC;QACzB,oBAAoB;QACpB,KAAK,EAAE,SAAS;QAChB,uBAAuB;QACvB,GAAG,EAAE,SAAS;KACjB,CAAC,CAAC;IACH,gCAAgC;IAChC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAC9B,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,oBAAoB;IACpB,GAAG,EAAE,UAAU;IACf,yCAAyC;IACzC,KAAK,EAAE,UAAU;IACjB,qCAAqC;IACrC,CAAC,EAAE,SAAS;IACZ,qCAAqC;IACrC,CAAC,EAAE,SAAS;IACZ,kBAAkB;IAClB,KAAK,EAAE,SAAS;IAChB,mBAAmB;IACnB,MAAM,EAAE,SAAS;IACjB,2CAA2C;IAC3C,OAAO,EAAE,wBAAwB;CACpC,CAAC,CAAC;AAOH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,oBAAoB;IACpB,GAAG,EAAE,UAAU;IACf,sBAAsB;IACtB,IAAI,EAAE,UAAU;IAChB,2BAA2B;IAC3B,EAAE,EAAE,UAAU;IACd,4DAA4D;IAC5D,KAAK,EAAE,sBAAsB;IAC7B,6CAA6C;IAC7C,KAAK,EAAE,kBAAkB;IACzB,oDAAoD;IACpD,GAAG,EAAE,SAAS,CAAC,kBAAkB,CAAC;CACrC,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,yDAAyD;IACzD,MAAM,EAAE,UAAU,CAAC;QACf,kBAAkB;QAClB,KAAK,EAAE,SAAS;QAChB,mBAAmB;QACnB,MAAM,EAAE,SAAS;KACpB,CAAC;IACF,uBAAuB;IACvB,KAAK,EAAE,SAAS,CAAC,iBAAiB,CAAC;IACnC,qDAAqD;IACrD,KAAK,EAAE,SAAS,CAAC,iBAAiB,CAAC;IACnC,kDAAkD;IAClD,KAAK,EAAE,SAAS,CAAC,iBAAiB,CAAC;IACnC,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC;IACjC,0DAA0D;IAC1D,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC;IAC7B,0EAA0E;IAC1E,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC;IAClC,6EAA6E;IAC7E,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC;IAChC,2DAA2D;IAC3D,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;CAC7D,CAAC,CAAC"}