@elaraai/e3-ui 1.0.86 → 1.0.87

package/dist/src/plan/pick.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * `Plan.pick` — the Plan's façade over the shared pick contract (#590).
+ *
+ * The contract holds identified things and does not know what they are, so an
+ * adopter supplies what it cannot: how to read identity off one item. For a
+ * Plan that is an eleven-arm match over the series variant — every arm carries
+ * the same four identity fields, and the arm itself picks the kind's icon.
+ *
+ * There are no per-series row counts (#822): a count means something only when
+ * every entry is in hand, and nothing on a Plan may behave differently because
+ * its data is inline or paged.
+ *
+ * @packageDocumentation
+ */
+import { type ExprType, ArrayType } from "@elaraai/east";
+import { type PickHandle, type PickItemType } from "@elaraai/east-ui";
+import { PlanSeriesType, type PlanSeriesArm, type PlanSeriesInput } from "./series.js";
+/**
+ * The FA glyph the library shows for each series kind — the row kind's glyph
+ * for the seven row kinds; the four composites take the marks that read as
+ * "a group per entry", "a titled block", "one entry several ways" and "a
+ * hand-built list". The library pane's Series tab lists a measure and a
+ * Plan's own rows with them too (#1195).
+ *
+ * @internal
+ */
+export declare const KIND_ICONS: Readonly<Record<PlanSeriesArm, string>>;
+/** Options for {@link createPlanPick}. */
+export interface PlanPickOptions {
+    /** Series switched off to begin with; omit ⇒ everything shows. */
+    hidden?: readonly string[];
+}
+/**
+ * Bind a Plan's row series to a persisted pick.
+ *
+ * @remarks
+ * The list is the layout (#822): the canvas shows the series still switched
+ * on, in the order they are listed, one block each — so the order written here
+ * is the order on screen. A section, a group or a views series is the unit a
+ * person picks — "add Presses" — and hiding one takes its whole subtree with
+ * it, because its members are built by its own `derive`.
+ *
+ * Identity is read through ONE match rather than one match per accessor —
+ * every arm carries the same four fields, so matching four times would build
+ * four copies of the same traversal. A TS list is checked here for two series
+ * sharing a key (one switch would wear two labels).
+ *
+ * The handle is STATE (`State.bind` underneath), so it is built inside a
+ * `Reactive`. Pass it to the canvas as `pick`, in place of `series`: the Plan
+ * shows the picked series, and its library's Series tab
+ * (`Plan.library.series()`) lists them, each with its eye. The data flagship,
+ * `planTargetState`, picks its whole series list this way, one hidden to
+ * start.
+ *
+ * @param key - The store key; also the persistence key
+ * @param all - Every series that COULD show, in layout order
+ * @param options - The initial hidden set ({@link PlanPickOptions})
+ * @returns A pick handle over the series type — the canvas's `pick` prop
+ */
+export declare function createPlanPick(key: string, all: PlanSeriesInput, options?: PlanPickOptions): PickHandle<ReturnType<typeof PlanSeriesType>>;
+/**
+ * The library entries for a Plan's series — described, with NO state binding.
+ *
+ * @remarks
+ * {@link createPlanPick} builds its `items` from the same accessors, so proving
+ * this proves the bound path too. Split out because `State.bind` is not
+ * runnable in a `describeEast` spec (`TestImpl` carries no State runtime), and
+ * identity and kind icons are exactly the part worth asserting.
+ *
+ * @param all - Every series that COULD show
+ * @returns One descriptor per series, in declaration order
+ */
+export declare function createPlanPickItems(all: PlanSeriesInput): ExprType<ArrayType<PickItemType>>;
+//# sourceMappingURL=pick.d.ts.map

package/dist/src/plan/pick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.d.ts","sourceRoot":"","sources":["../../../src/plan/pick.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAEH,KAAK,QAAQ,EAEb,SAAS,EAQZ,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAY,KAAK,UAAU,EAAE,KAAK,YAAY,EAAoB,MAAM,kBAAkB,CAAC;AAElG,OAAO,EAAE,cAAc,EAAe,KAAK,aAAa,EAAE,KAAK,eAAe,EAAwB,MAAM,aAAa,CAAC;AAE1H;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAgB9D,CAAC;AAUF,0CAA0C;AAC1C,MAAM,WAAW,eAAe;IAC5B,kEAAkE;IAClE,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B;AAmDD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,cAAc,CAC1B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,eAAe,GAC1B,UAAU,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAO/C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAI3F"}

package/dist/src/plan/pick.js

@@ -0,0 +1,146 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * `Plan.pick` — the Plan's façade over the shared pick contract (#590).
+ *
+ * The contract holds identified things and does not know what they are, so an
+ * adopter supplies what it cannot: how to read identity off one item. For a
+ * Plan that is an eleven-arm match over the series variant — every arm carries
+ * the same four identity fields, and the arm itself picks the kind's icon.
+ *
+ * There are no per-series row counts (#822): a count means something only when
+ * every entry is in hand, and nothing on a Plan may behave differently because
+ * its data is inline or paged.
+ *
+ * @packageDocumentation
+ */
+import { ArrayType, East, Expr, OptionType, StringType, StructType, some, none, } from "@elaraai/east";
+import { IconType } from "@elaraai/east-ui";
+import { createPickBind, pickItems } from "@elaraai/east-ui/internal";
+import { PlanSeriesType, checkSeries } from "./series.js";
+/**
+ * The FA glyph the library shows for each series kind — the row kind's glyph
+ * for the seven row kinds; the four composites take the marks that read as
+ * "a group per entry", "a titled block", "one entry several ways" and "a
+ * hand-built list". The library pane's Series tab lists a measure and a
+ * Plan's own rows with them too (#1195).
+ *
+ * @internal
+ */
+export const KIND_ICONS = {
+    span: "bars-staggered",
+    // `border-all` was a 2x2 grid of squares — the same mark `table-cells-large`
+    // draws for heat, and at 12px the two were indistinguishable (#590 §6.3).
+    // Buckets quantise into COLUMNS with lanes inside them, so a columns mark
+    // says what the row is and separates cleanly from heat's grid.
+    buckets: "table-columns",
+    chart: "chart-line",
+    heat: "table-cells-large",
+    table: "table-list",
+    cards: "user-group",
+    events: "flag",
+    group: "layer-group",
+    section: "heading",
+    views: "clone",
+    rows: "list",
+};
+/** Identity read off ONE series — the whole of what the library needs. */
+const PlanSeriesIdentityType = StructType({
+    key: StringType,
+    title: StringType,
+    subtitle: OptionType(StringType),
+    icon: OptionType(IconType),
+});
+/** The shared accessors — see {@link createPlanPick}. */
+function planPickOptions(allExpr, options) {
+    const itemType = Expr.type(allExpr).value;
+    /** One arm's identity, with the KIND's glyph when the series declares none. */
+    const ident = (v, tag) => East.value({
+        key: v["key"],
+        title: v["title"],
+        subtitle: v["subtitle"],
+        icon: v["icon"].match({
+            some: (_$, ic) => East.value(some(ic), OptionType(IconType)),
+            none: (_$) => East.value(some({ name: KIND_ICONS[tag], prefix: "fas", label: none, style: none }), OptionType(IconType)),
+        }),
+    }, PlanSeriesIdentityType);
+    // ONE reified match, CALLED by each accessor — every arm carries the same
+    // four fields, so matching per accessor would build four copies of the same
+    // traversal (`shared/reify.ts`: reify once, then call). The arms are spelled
+    // out rather than generated, mirroring `applySeriesValue` — an arm added to
+    // the variant should fail this match, not fall through a computed map.
+    const identityOf = East.function([itemType], PlanSeriesIdentityType, (_$, s) => s.match({
+        span: (_$2, v) => ident(v, "span"),
+        buckets: (_$2, v) => ident(v, "buckets"),
+        chart: (_$2, v) => ident(v, "chart"),
+        heat: (_$2, v) => ident(v, "heat"),
+        table: (_$2, v) => ident(v, "table"),
+        cards: (_$2, v) => ident(v, "cards"),
+        events: (_$2, v) => ident(v, "events"),
+        group: (_$2, v) => ident(v, "group"),
+        section: (_$2, v) => ident(v, "section"),
+        views: (_$2, v) => ident(v, "views"),
+        rows: (_$2, v) => ident(v, "rows"),
+    }));
+    return {
+        id: (s) => identityOf(s).key,
+        title: (s) => identityOf(s).title,
+        subtitle: (s) => identityOf(s).subtitle,
+        icon: (s) => identityOf(s).icon,
+        ...(options?.hidden !== undefined ? { hidden: options.hidden } : {}),
+    };
+}
+/**
+ * Bind a Plan's row series to a persisted pick.
+ *
+ * @remarks
+ * The list is the layout (#822): the canvas shows the series still switched
+ * on, in the order they are listed, one block each — so the order written here
+ * is the order on screen. A section, a group or a views series is the unit a
+ * person picks — "add Presses" — and hiding one takes its whole subtree with
+ * it, because its members are built by its own `derive`.
+ *
+ * Identity is read through ONE match rather than one match per accessor —
+ * every arm carries the same four fields, so matching four times would build
+ * four copies of the same traversal. A TS list is checked here for two series
+ * sharing a key (one switch would wear two labels).
+ *
+ * The handle is STATE (`State.bind` underneath), so it is built inside a
+ * `Reactive`. Pass it to the canvas as `pick`, in place of `series`: the Plan
+ * shows the picked series, and its library's Series tab
+ * (`Plan.library.series()`) lists them, each with its eye. The data flagship,
+ * `planTargetState`, picks its whole series list this way, one hidden to
+ * start.
+ *
+ * @param key - The store key; also the persistence key
+ * @param all - Every series that COULD show, in layout order
+ * @param options - The initial hidden set ({@link PlanPickOptions})
+ * @returns A pick handle over the series type — the canvas's `pick` prop
+ */
+export function createPlanPick(key, all, options) {
+    checkSeries(all, "Plan.pick");
+    const allExpr = East.value(all);
+    // Typed at the SERIES shape, not the erased element type: that is what
+    // makes `Pick.active(shown)` assignable straight back to the `series` prop.
+    return createPickBind(key, allExpr, planPickOptions(allExpr, options));
+}
+/**
+ * The library entries for a Plan's series — described, with NO state binding.
+ *
+ * @remarks
+ * {@link createPlanPick} builds its `items` from the same accessors, so proving
+ * this proves the bound path too. Split out because `State.bind` is not
+ * runnable in a `describeEast` spec (`TestImpl` carries no State runtime), and
+ * identity and kind icons are exactly the part worth asserting.
+ *
+ * @param all - Every series that COULD show
+ * @returns One descriptor per series, in declaration order
+ */
+export function createPlanPickItems(all) {
+    checkSeries(all, "Plan.pickItems");
+    const allExpr = East.value(all);
+    return pickItems(allExpr, planPickOptions(allExpr));
+}
+//# sourceMappingURL=pick.js.map

package/dist/src/plan/pick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.js","sourceRoot":"","sources":["../../../src/plan/pick.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAIH,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,UAAU,EACV,UAAU,EACV,UAAU,EACV,IAAI,EACJ,IAAI,GACP,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,QAAQ,EAAwD,MAAM,kBAAkB,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAkE,MAAM,aAAa,CAAC;AAE1H;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAA4C;IAC/D,IAAI,EAAK,gBAAgB;IACzB,6EAA6E;IAC7E,0EAA0E;IAC1E,0EAA0E;IAC1E,+DAA+D;IAC/D,OAAO,EAAE,eAAe;IACxB,KAAK,EAAI,YAAY;IACrB,IAAI,EAAK,mBAAmB;IAC5B,KAAK,EAAI,YAAY;IACrB,KAAK,EAAI,YAAY;IACrB,MAAM,EAAG,MAAM;IACf,KAAK,EAAI,aAAa;IACtB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAI,OAAO;IAChB,IAAI,EAAK,MAAM;CAClB,CAAC;AAEF,0EAA0E;AAC1E,MAAM,sBAAsB,GAAG,UAAU,CAAC;IACtC,GAAG,EAAO,UAAU;IACpB,KAAK,EAAK,UAAU;IACpB,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAChC,IAAI,EAAM,UAAU,CAAC,QAAQ,CAAC;CACjC,CAAC,CAAC;AAQH,yDAAyD;AACzD,SAAS,eAAe,CACpB,OAAsC,EACtC,OAAyB;IAEzB,MAAM,QAAQ,GAAc,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,CAAC,KAAK,CAAC;IAE7E,+EAA+E;IAC/E,MAAM,KAAK,GAAG,CAAC,CAAuB,EAAE,GAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;QACtE,GAAG,EAAO,CAAC,CAAC,KAAK,CAAmC;QACpD,KAAK,EAAK,CAAC,CAAC,OAAO,CAAmC;QACtD,QAAQ,EAAE,CAAC,CAAC,UAAU,CAA+C;QACrE,IAAI,EAAO,CAAC,CAAC,MAAM,CAAoC,CAAC,KAAK,CAAC;YAC1D,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC5D,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CACpB,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EACxE,UAAU,CAAC,QAAQ,CAAC,CAAC;SAC5B,CAAC;KACL,EAAE,sBAAsB,CAAC,CAAC;IAE3B,0EAA0E;IAC1E,4EAA4E;IAC5E,6EAA6E;IAC7E,4EAA4E;IAC5E,uEAAuE;IACvE,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAC1E,CAAgC,CAAC,KAAK,CAAC;QACpC,IAAI,EAAK,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,MAAM,CAAC;QACxE,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,SAAS,CAAC;QAC3E,KAAK,EAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,OAAO,CAAC;QACzE,IAAI,EAAK,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,MAAM,CAAC;QACxE,KAAK,EAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,OAAO,CAAC;QACzE,KAAK,EAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,OAAO,CAAC;QACzE,MAAM,EAAG,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,QAAQ,CAAC;QAC1E,KAAK,EAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,OAAO,CAAC;QACzE,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,SAAS,CAAC;QAC3E,KAAK,EAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,OAAO,CAAC;QACzE,IAAI,EAAK,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAoC,EAAE,MAAM,CAAC;KAC3E,CAAU,CAAC,CAAC;IAEjB,OAAO;QACH,EAAE,EAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG;QAClC,KAAK,EAAK,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK;QACpC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ;QACvC,IAAI,EAAM,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;QACnC,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,cAAc,CAC1B,GAAW,EACX,GAAoB,EACpB,OAAyB;IAEzB,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAA8C,CAAkC,CAAC;IAC5G,uEAAuE;IACvE,4EAA4E;IAC5E,OAAO,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CACpB,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAoB;IACpD,WAAW,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAA8C,CAAkC,CAAC;IAC5G,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AACxD,CAAC"}