@elaraai/e3-ui 1.0.83 → 1.0.85

package/dist/src/studio/inspector.js

@@ -0,0 +1,155 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * The builder's inspector (#996) — the selected placement's component, what
+ * it reads, its description and its layout, computed in East for the
+ * `StudioBuilder` renderer, which draws the inspector in its pane after the
+ * canvas. It writes no page: a layout edit is a request the canvas takes as
+ * one gesture of the page's editing session, undone, redone, discarded and
+ * applied with the rest.
+ *
+ * @packageDocumentation
+ */
+import { ArrayType, BooleanType, East, FunctionType, IntegerType, NullType, OptionType, SetType, StringType, StructType, none, some, } from "@elaraai/east";
+import { SnapGrid } from "@elaraai/east-ui/internal";
+import { TreePathType } from "@elaraai/e3-types";
+import { StudioComponentType } from "./component.js";
+import { StudioCellType } from "./pages.js";
+// ============================================================================
+// What the inspector shows
+// ============================================================================
+/**
+ * The selected placement's layout, as the canvas draws it.
+ *
+ * @property span - Its span, in columns of 12
+ * @property most - The most span its row leaves it: 12 less the row's other spans
+ * @property row - Its row, counting from 1 in the order the rows first appear
+ * @property rows - How many rows the page has
+ * @property height - Its height in px; `none` is its content's
+ * @property align - Where it sits in a taller row
+ */
+export const InspectorLayoutType = StructType({
+    span: IntegerType,
+    most: IntegerType,
+    row: IntegerType,
+    rows: IntegerType,
+    height: OptionType(IntegerType),
+    align: SnapGrid.Types.Align,
+});
+/**
+ * The selected placement, as the inspector shows it.
+ *
+ * @property key - The placement's key — what a layout request names
+ * @property name - Its title, else its component's name, else its component's key
+ * @property component - Its component's key
+ * @property changed - Its component's code changed since the page went live:
+ *   its fingerprint differs from the one the live version's cell stored
+ * @property reads - The paths of the datasets its component's code reads, whole
+ *   or a window at a time — the renderer prints each as its keypath (`.inputs.sales_daily`)
+ * @property description - Its component's description, fixed by its developer
+ * @property layout - Its layout ({@link InspectorLayoutType})
+ */
+export const InspectorSelectionType = StructType({
+    key: StringType,
+    name: StringType,
+    component: StringType,
+    changed: BooleanType,
+    reads: ArrayType(TreePathType),
+    description: OptionType(StringType),
+    layout: InspectorLayoutType,
+});
+/**
+ * The inspector, as the `StudioBuilder` renderer draws it.
+ *
+ * @property selection - The selected placement; `none` when nothing is selected
+ * @property onRequest - Asks the canvas for a layout change, which it takes as one gesture
+ */
+export const StudioInspectorPayloadType = StructType({
+    selection: OptionType(InspectorSelectionType),
+    onRequest: FunctionType([SnapGrid.Types.Request], NullType),
+});
+/**
+ * The selected placement, as the inspector shows it — `none` when nothing is
+ * selected, or the page has no placement under the selected key.
+ *
+ * @remarks
+ * `cells` are the page's placements as the canvas draws them, its unsaved
+ * drafts in place; `live` the live version's, whose fingerprints say whether a
+ * component's code changed since the page went live — a placement the live
+ * version does not hold has not gone live, and has not changed. A placement
+ * whose component the surface does not list is named by its component's key,
+ * reads nothing and has no description.
+ */
+export const inspectorSelection = East.function([ArrayType(StudioComponentType), ArrayType(StudioCellType), OptionType(ArrayType(StudioCellType)), OptionType(StringType)], OptionType(InspectorSelectionType), ($, listed, cells, live, selected) => {
+    const found = $.let(selected.match({
+        some: (_$2, key) => cells.firstMap((_$3, cell) => cell.key.equal(key).ifElse(() => East.value(some(cell), OptionType(StudioCellType)), () => East.value(none, OptionType(StudioCellType)))),
+        none: (_$2) => East.value(none, OptionType(StudioCellType)),
+    }), OptionType(StudioCellType));
+    $.if(found.hasTag("none"), ($2) => {
+        $2.return(East.value(none, OptionType(InspectorSelectionType)));
+    });
+    const cell = $.let(found.unwrap("some"));
+    const component = $.let(listed.firstMap((_$2, c) => c.key.equal(cell.component).ifElse(() => East.value(some(c), OptionType(StudioComponentType)), () => East.value(none, OptionType(StudioComponentType)))), OptionType(StudioComponentType));
+    const name = $.let(cell.title.match({
+        some: (_$2, title) => title,
+        none: (_$2) => component.match({ some: (_$3, c) => c.name, none: (_$3) => cell.component }),
+    }));
+    // The fingerprint the live version's cell stored, against its code's now.
+    const stored = $.let(live.match({
+        some: (_$2, liveCells) => liveCells.firstMap((_$3, c) => c.key.equal(cell.key).ifElse(() => East.value(some(c.fingerprint), OptionType(StringType)), () => East.value(none, OptionType(StringType)))),
+        none: (_$2) => East.value(none, OptionType(StringType)),
+    }), OptionType(StringType));
+    const changed = $.let(stored.match({
+        some: (_$2, fingerprint) => component.match({
+            some: (_$3, c) => c.fingerprint.notEqual(fingerprint),
+            none: (_$3) => East.value(false),
+        }),
+        none: (_$2) => East.value(false),
+    }));
+    const reads = $.let(component.match({
+        some: (_$2, c) => c.reads.paths.concat(c.reads.pages),
+        none: (_$2) => East.value([], ArrayType(TreePathType)),
+    }), ArrayType(TreePathType));
+    // Its row among the rows, in the order they first appear, and the room
+    // the row's other placements leave it.
+    const rows = $.let([], ArrayType(StringType));
+    const seen = $.let(new Set(), SetType(StringType));
+    const others = $.let(0n);
+    $.for(cells, ($2, c) => {
+        $2.if(seen.has(c.row).not(), ($3) => {
+            $3(seen.insert(c.row));
+            $3(rows.pushLast(c.row));
+        });
+        $2.if(c.row.equal(cell.row).and(() => c.key.notEqual(cell.key)), ($3) => {
+            $3.assign(others, others.add(c.span));
+        });
+    });
+    const row = $.let(0n);
+    $.for(rows, ($2, r, index) => {
+        $2.if(r.equal(cell.row), ($3) => {
+            $3.assign(row, index.add(1n));
+        });
+    });
+    return East.value(some({
+        key: cell.key,
+        name,
+        component: cell.component,
+        changed,
+        reads,
+        description: component.match({
+            some: (_$2, c) => c.description,
+            none: (_$2) => East.value(none, OptionType(StringType)),
+        }),
+        layout: {
+            span: cell.span,
+            most: East.value(12n).subtract(others),
+            row,
+            rows: rows.size(),
+            height: cell.height,
+            align: cell.align,
+        },
+    }), OptionType(InspectorSelectionType));
+});
+//# sourceMappingURL=inspector.js.map

package/dist/src/studio/inspector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.js","sourceRoot":"","sources":["../../../src/studio/inspector.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;GASG;AAEH,OAAO,EACH,SAAS,EACT,WAAW,EACX,IAAI,EACJ,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,UAAU,EACV,OAAO,EACP,UAAU,EACV,UAAU,EACV,IAAI,EACJ,IAAI,GACP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,+EAA+E;AAC/E,2BAA2B;AAC3B,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;IAC1C,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,WAAW;IACjB,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK;CAC9B,CAAC,CAAC;AAKH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC;IAC7C,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,UAAU;IAChB,SAAS,EAAE,UAAU;IACrB,OAAO,EAAE,WAAW;IACpB,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC;IAC9B,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC;IACnC,MAAM,EAAE,mBAAmB;CAC9B,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAAC;IACjD,SAAS,EAAE,UAAU,CAAC,sBAAsB,CAAC;IAC7C,SAAS,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;CAC9D,CAAC,CAAC;AAKH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAC3C,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,EAC1H,UAAU,CAAC,sBAAsB,CAAC,EAClC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;IACjC,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC/B,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CACxE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC,EACxD,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC,CACrD,CAAC;QACF,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;KAC9D,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC;IAChC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE;QAC9B,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAClF,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,EAC1D,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAC1D,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAChC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK;QAC3B,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;KAC9F,CAAC,CAAC,CAAC;IACJ,0EAA0E;IAC1E,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B,IAAI,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CACjF,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,EAC7D,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CACjD,CAAC;QACF,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;KAC1D,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5B,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;QAC/B,IAAI,EAAE,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;YACxC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;SACnC,CAAC;QACF,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;KACnC,CAAC,CAAC,CAAC;IACJ,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC;QAChC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QACrD,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;KACzD,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAC7B,uEAAuE;IACvE,uCAAuC;IACvC,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9C,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,EAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;QACnB,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;YAChC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACvB,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE;YACpE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;QACzB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE;YAC5B,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACnB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI;QACJ,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO;QACP,KAAK;QACL,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC;YACzB,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW;YAC/B,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;SAC1D,CAAC;QACF,MAAM,EAAE;YACJ,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YACtC,GAAG;YACH,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB;KACJ,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC;AAC5C,CAAC,CACJ,CAAC"}