@elaraai/east-ui 1.0.4 → 1.0.6

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

@@ -0,0 +1,204 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+import { ArrayType, BooleanType, DictType, FloatType, NullType, OptionType, StringType, StructType, VariantType, FunctionType, } from "@elaraai/east";
+import { StatusTokenType } from "../../style/interaction.js";
+// ============================================================================
+// Card status
+// ============================================================================
+/**
+ * Status pill on a Library card.
+ *
+ * @remarks
+ * The card's availability/assignment state (`ON ROSTER`, `AT CAP`,
+ * `PTO MAR 4–8`, `IN SERVICE`), rendered as a small pill in the card's top
+ * right using the standard status tone set.
+ *
+ * @property label - Pill text (rendered uppercase)
+ * @property tone - Standard status tone
+ */
+export const LibraryStatusType = StructType({
+    /** Pill text (rendered uppercase) */
+    label: StringType,
+    /** Standard status tone */
+    tone: StatusTokenType,
+});
+// ============================================================================
+// Secondary dimension values
+// ============================================================================
+/**
+ * A secondary dimension's value on one card.
+ *
+ * @remarks
+ * Secondary dimensions are the configurable card facts (hours, skills,
+ * certifications, capacity, range, location) that the toolbar toggles on and
+ * off. Each renders by kind: `meter` (utilisation bar + right-aligned text),
+ * `chips` (a row of small chips), or `text` (a muted caption).
+ *
+ * @property meter - Utilisation bar with optional right-aligned text
+ * @property chips - A row of small chips
+ * @property text - A muted caption line
+ */
+export const LibraryDimValueType = VariantType({
+    /** Utilisation bar with optional right-aligned text */
+    meter: StructType({
+        /** Current value */
+        value: FloatType,
+        /** Full-scale value */
+        max: FloatType,
+        /** Optional right-aligned text (e.g. `38h`) */
+        text: OptionType(StringType),
+    }),
+    /** A row of small chips */
+    chips: ArrayType(StringType),
+    /** A muted caption line */
+    text: StringType,
+});
+// ============================================================================
+// Card / group / dimension metadata
+// ============================================================================
+/**
+ * One card's group placement under a group-by option: the group value it
+ * belongs to plus the (shared) group summary text.
+ *
+ * @property value - The group this card belongs to under the option
+ * @property summary - Right-aligned group-head summary text
+ */
+export const LibraryGroupPlacementType = StructType({
+    /** The group this card belongs to under the option */
+    value: StringType,
+    /** Right-aligned group-head summary text */
+    summary: OptionType(StringType),
+});
+/**
+ * A resolved Library card.
+ *
+ * @remarks
+ * Produced by the `item` accessor plus the dimension / group / search
+ * accessors at authoring time — the renderer never sees the host's row type.
+ *
+ * @property key - Item identity; carried by `LibraryRef` when dragged
+ * @property label - Primary identity line
+ * @property sublabel - Optional muted second line (role / class)
+ * @property icon - Optional Font Awesome solid icon name
+ * @property status - Optional status pill
+ * @property draggable - Whether the card can start a drag
+ * @property search - Optional filter text (card dims when unmatched)
+ * @property groups - Group placement per group-by option key
+ * @property dims - Secondary dimension value per dimension key
+ */
+export const LibraryItemType = StructType({
+    /** Item identity; carried by `LibraryRef` when dragged */
+    key: StringType,
+    /** Primary identity line */
+    label: StringType,
+    /** Optional muted second line (role / class) */
+    sublabel: OptionType(StringType),
+    /** Optional Font Awesome solid icon name */
+    icon: OptionType(StringType),
+    /** Optional status pill */
+    status: OptionType(LibraryStatusType),
+    /** Whether the card can start a drag */
+    draggable: BooleanType,
+    /** Optional filter text (card dims when unmatched) */
+    search: OptionType(StringType),
+    /** Group placement per group-by option key */
+    groups: DictType(StringType, LibraryGroupPlacementType),
+    /** Secondary dimension value per dimension key */
+    dims: DictType(StringType, LibraryDimValueType),
+});
+/**
+ * The card face — the per-item fields produced by the `item` accessor
+ * (via `Library.card`), before the factory merges in dimensions, group
+ * placements, and search text.
+ *
+ * @property key - Item identity; carried by `LibraryRef` when dragged
+ * @property label - Primary identity line
+ * @property sublabel - Optional muted second line
+ * @property icon - Optional Font Awesome solid icon name
+ * @property status - Optional status pill
+ * @property draggable - Whether the card can start a drag
+ */
+export const LibraryCardFaceType = StructType({
+    /** Item identity; carried by `LibraryRef` when dragged */
+    key: StringType,
+    /** Primary identity line */
+    label: StringType,
+    /** Optional muted second line */
+    sublabel: OptionType(StringType),
+    /** Optional Font Awesome solid icon name */
+    icon: OptionType(StringType),
+    /** Optional status pill */
+    status: OptionType(LibraryStatusType),
+    /** Whether the card can start a drag */
+    draggable: BooleanType,
+});
+/**
+ * Toolbar metadata for one group-by option.
+ *
+ * @property key - Option identity (matches each card's `groups` key)
+ * @property label - Segment label in the GROUP BY toolbar
+ */
+export const LibraryGroupMetaType = StructType({
+    /** Option identity (matches each card's `groups` key) */
+    key: StringType,
+    /** Segment label in the GROUP BY toolbar */
+    label: StringType,
+});
+/**
+ * Toolbar metadata for one secondary dimension.
+ *
+ * @property key - Dimension identity (matches each card's `dims` key)
+ * @property label - Toggle label in the SECONDARY toolbar
+ */
+export const LibraryDimMetaType = StructType({
+    /** Dimension identity (matches each card's `dims` key) */
+    key: StringType,
+    /** Toggle label in the SECONDARY toolbar */
+    label: StringType,
+});
+// ============================================================================
+// Root
+// ============================================================================
+/**
+ * East StructType for the Library component.
+ *
+ * @remarks
+ * A draggable palette of things that get assigned onto grid surfaces
+ * (Roster, Blend): people, assets, vehicles, rooms. Declares the DnD
+ * **source** role under `id`; targets connect by listing that id in their
+ * `sources`. Pure source — it never receives drops, except as the
+ * return-to-palette sink for its connected targets.
+ *
+ * @property id - DnD source identity
+ * @property hint - Optional header-right caption (defaults to the drag hint)
+ * @property items - The resolved cards
+ * @property groupOptions - GROUP BY toolbar options (empty = no grouping toolbar)
+ * @property dimOptions - SECONDARY dimension toggles (empty = no toggle toolbar)
+ * @property defaultDimensions - Initially-visible dimension keys
+ * @property searchable - Whether the search input renders
+ * @property addLabel - Optional footer action label
+ * @property onAdd - Optional footer action callback
+ */
+export const LibraryRootType = StructType({
+    /** DnD source identity */
+    id: StringType,
+    /** Optional header-right caption (defaults to the drag hint) */
+    hint: OptionType(StringType),
+    /** The resolved cards */
+    items: ArrayType(LibraryItemType),
+    /** GROUP BY toolbar options (empty = no grouping toolbar) */
+    groupOptions: ArrayType(LibraryGroupMetaType),
+    /** SECONDARY dimension toggles (empty = no toggle toolbar) */
+    dimOptions: ArrayType(LibraryDimMetaType),
+    /** Initially-visible dimension keys */
+    defaultDimensions: ArrayType(StringType),
+    /** Whether the search input renders */
+    searchable: BooleanType,
+    /** Optional footer action label */
+    addLabel: OptionType(StringType),
+    /** Optional footer action callback */
+    onAdd: OptionType(FunctionType([], NullType)),
+});
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/collections/library/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,SAAS,EACT,WAAW,EACX,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,EACX,YAAY,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,qCAAqC;IACrC,KAAK,EAAE,UAAU;IACjB,2BAA2B;IAC3B,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAOH,+EAA+E;AAC/E,6BAA6B;AAC7B,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC;IAC3C,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC;QACd,oBAAoB;QACpB,KAAK,EAAE,SAAS;QAChB,uBAAuB;QACvB,GAAG,EAAE,SAAS;QACd,+CAA+C;QAC/C,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;KAC/B,CAAC;IACF,2BAA2B;IAC3B,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC;IAC5B,2BAA2B;IAC3B,IAAI,EAAE,UAAU;CACnB,CAAC,CAAC;AAOH,+EAA+E;AAC/E,oCAAoC;AACpC,+EAA+E;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC;IAChD,sDAAsD;IACtD,KAAK,EAAE,UAAU;IACjB,4CAA4C;IAC5C,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC;CAClC,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACtC,0DAA0D;IAC1D,GAAG,EAAE,UAAU;IACf,4BAA4B;IAC5B,KAAK,EAAE,UAAU;IACjB,gDAAgD;IAChD,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAChC,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAC5B,2BAA2B;IAC3B,MAAM,EAAE,UAAU,CAAC,iBAAiB,CAAC;IACrC,wCAAwC;IACxC,SAAS,EAAE,WAAW;IACtB,sDAAsD;IACtD,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAC9B,8CAA8C;IAC9C,MAAM,EAAE,QAAQ,CAAC,UAAU,EAAE,yBAAyB,CAAC;IACvD,kDAAkD;IAClD,IAAI,EAAE,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;CAClD,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;IAC1C,0DAA0D;IAC1D,GAAG,EAAE,UAAU;IACf,4BAA4B;IAC5B,KAAK,EAAE,UAAU;IACjB,iCAAiC;IACjC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAChC,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAC5B,2BAA2B;IAC3B,MAAM,EAAE,UAAU,CAAC,iBAAiB,CAAC;IACrC,wCAAwC;IACxC,SAAS,EAAE,WAAW;CACzB,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC;IAC3C,yDAAyD;IACzD,GAAG,EAAE,UAAU;IACf,4CAA4C;IAC5C,KAAK,EAAE,UAAU;CACpB,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,0DAA0D;IAC1D,GAAG,EAAE,UAAU;IACf,4CAA4C;IAC5C,KAAK,EAAE,UAAU;CACpB,CAAC,CAAC;AAOH,+EAA+E;AAC/E,OAAO;AACP,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACtC,0BAA0B;IAC1B,EAAE,EAAE,UAAU;IACd,gEAAgE;IAChE,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC;IAC5B,yBAAyB;IACzB,KAAK,EAAE,SAAS,CAAC,eAAe,CAAC;IACjC,6DAA6D;IAC7D,YAAY,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAC7C,8DAA8D;IAC9D,UAAU,EAAE,SAAS,CAAC,kBAAkB,CAAC;IACzC,uCAAuC;IACvC,iBAAiB,EAAE,SAAS,CAAC,UAAU,CAAC;IACxC,uCAAuC;IACvC,UAAU,EAAE,WAAW;IACvB,mCAAmC;IACnC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAChC,sCAAsC;IACtC,KAAK,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;CAChD,CAAC,CAAC"}