@elaraai/e3-ui 1.0.97 → 1.0.98

package/dist/src/schematic/library.js

@@ -0,0 +1,244 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * `Schematic.library` (#1386, #1401, `Schematic Builder Spec.md` §8): the
+ * library pane's tabs, which `library` lists in order, and their wire, which
+ * the renderer draws (#1389). Like the Calendar's, each covers every kind
+ * (D33).
+ *
+ * - `Schematic.library.templates()`: every kind's templates (§4.6), each
+ *   kind's under its name, then grouped by their `group`, each card a drag
+ *   source. Each kind's cards follow their templates' source of the slice.
+ * - `Schematic.library.backlog()`: every item kind's rows with no position,
+ *   each kind's under its name, each a drag source: the Backlog tab, as the
+ *   Calendar's is.
+ * - `Schematic.library.index()`: the zones, nested by containment, each
+ *   opened listing the items inside it.
+ * - `Schematic.library.layers()`: each layer, with Isolate, Lock and Show or
+ *   Hide: the viewer's view settings.
+ * - `Schematic.library.tab(rows, { … })`: the author's own cards, as
+ *   `Plan.library.tab` takes them. A card's `drop` is a `Schematic.patch(R, …)`
+ *   whose row type names the kind it lands on.
+ *
+ * Left out, or empty, the Schematic has no library pane.
+ *
+ * @packageDocumentation
+ */
+import { ArrayType, East, NullType, VariantType, variant } from "@elaraai/east";
+import { ScheduleAuthorTabType, buildScheduleTab } from "../schedule/library.js";
+export { ScheduleLibraryCardType as SchematicLibraryCardType } from "../schedule/library.js";
+// ============================================================================
+// The wire
+// ============================================================================
+/**
+ * One tab of the library pane on the wire, in the order `library` lists them.
+ *
+ * @property templates - Every kind's templates
+ * @property backlog - Every item kind's rows with no position
+ * @property index - The zones, nested by containment
+ * @property layers - The layers
+ * @property tab - The author's own: its name, its icon, the kind its cards land on, and its cards
+ */
+export const SchematicLibraryTabType = VariantType({
+    templates: NullType,
+    backlog: NullType,
+    index: NullType,
+    layers: NullType,
+    tab: ScheduleAuthorTabType,
+});
+/**
+ * Refuses a slot given to a tab that covers every kind (D33), naming the form
+ * to use.
+ *
+ * @param tab - The tab's factory, as the refusal names it
+ * @param given - What it was given
+ * @throws {Error} When it was given anything
+ */
+function takesNoSlot(tab, given) {
+    if (given.length === 0)
+        return;
+    throw new Error(tab === "templates"
+        ? "Schematic.library.templates() lists every kind's templates, each kind's under its name, as the Calendar's does — leave the slot out"
+        : "Schematic.library.backlog() lists every item kind's rows with no position, each kind's under its name, as the Calendar's does — leave the slot out");
+}
+/**
+ * The library's Templates tab (§8, D33): every kind's templates, each kind's
+ * under its name, then grouped by their `group`, each card a drag source.
+ * Dropped on the canvas, an item template adds an item at the drop point;
+ * dropped on a link, a link template retypes it. Each kind's cards follow
+ * their templates' source of the slice, counting what they show.
+ *
+ * @param given - Nothing: a slot given, as the earlier form took, is refused
+ * @returns The tab
+ * @throws {Error} When given a slot, naming the form to use
+ */
+export function libraryTemplates(...given) {
+    takesNoSlot("templates", given);
+    return { kind: "templates" };
+}
+/**
+ * The library's Backlog tab (§8, D33): every item kind's rows with no
+ * position, each kind's under its name, each a drag source a drop places, as
+ * the Calendar's Backlog is. An item kind whose `x` and `y` are Options of
+ * Float has a backlog.
+ *
+ * @param given - Nothing: a slot given is refused
+ * @returns The tab
+ * @throws {Error} When given a slot, naming the form to use
+ */
+export function libraryBacklog(...given) {
+    takesNoSlot("backlog", given);
+    return { kind: "backlog" };
+}
+/**
+ * `Schematic.library.unplaced(slot)`, removed (D33): refused, naming the
+ * Backlog tab that replaces it.
+ *
+ * @returns Never
+ * @throws {Error} Always, naming `Schematic.library.backlog()`
+ */
+function libraryUnplaced() {
+    throw new Error("Schematic.library.unplaced(slot) is gone — Schematic.library.backlog() lists every item kind's rows with no position, each kind's under its name");
+}
+/**
+ * The library's Index tab (§8): the zones, nested by containment. The zone the
+ * viewport is in is marked, a click flies to a zone and selects it, and an
+ * opened zone lists the items inside it. Hatched zones hold no items.
+ *
+ * @returns The tab
+ */
+export function libraryIndex() {
+    return { kind: "index" };
+}
+/**
+ * The library's Layers tab (§8): each layer's swatch, label and count, with
+ * Isolate, Lock and Show or Hide, and Show all. The viewer's choices are kept
+ * for them; a locked layer's entities never select, and a hidden layer's never
+ * draw.
+ *
+ * @returns The tab
+ */
+export function libraryLayers() {
+    return { kind: "layers" };
+}
+/**
+ * A tab of the author's own cards (§8): one card per row, its label and meta,
+ * grouped by its `group`, searched by its key, label and meta. Given a `drop`
+ * — `Schematic.patch(R, { … })` over one kind's row type, which names that
+ * kind — a card dropped on an entity of that kind sets the fields the patch
+ * sets. Naming a `source` of the slice, the tab follows it.
+ *
+ * @typeParam K - The rows' key type
+ * @typeParam R - Their row type
+ * @typeParam P - The patch `drop` returns
+ * @param rows - The rows: a `Dict<K, R>`, usually a record's `read()`
+ * @param config - The tab's name and icon, and the accessors over a row and its key
+ * @returns The tab
+ */
+export function libraryTab(rows, config) {
+    return { kind: "tab", rows, config: config };
+}
+/**
+ * The library's tabs, each a factory `library` lists: `Schematic.library`.
+ */
+export const SchematicLibraryFactories = {
+    /** Every kind's templates ({@link libraryTemplates}). */
+    templates: libraryTemplates,
+    /** Every item kind's rows with no position ({@link libraryBacklog}). */
+    backlog: libraryBacklog,
+    /** @deprecated Removed (#1401): every item kind's rows with no position are `Schematic.library.backlog()`. */
+    unplaced: libraryUnplaced,
+    /** The zones, nested by containment ({@link libraryIndex}). */
+    index: libraryIndex,
+    /** The layers ({@link libraryLayers}). */
+    layers: libraryLayers,
+    /** The author's own cards ({@link libraryTab}). */
+    tab: libraryTab,
+};
+/** How a tab names itself in a refusal. */
+function tabName(tab) {
+    return tab.kind === "tab" ? `the "${tab.config.name}" tab` : `Schematic.library.${tab.kind}()`;
+}
+/** Whether a value is one of the library's tabs. */
+function isTab(value) {
+    if (typeof value !== "object" || value === null)
+        return false;
+    const kind = value.kind;
+    return kind === "templates" || kind === "backlog" || kind === "index" || kind === "layers" || kind === "tab";
+}
+/**
+ * Builds the library pane on the wire (§8): its tabs in the order `library`
+ * lists them; none when it is left out.
+ *
+ * @param tabs - The tabs, each a `Schematic.library.*` call
+ * @param ctx - What the library is built against
+ * @returns The tabs on the wire
+ * @throws {Error} Naming the tab: a `library` that is no list of `Schematic.library.*` calls; a tab listed twice (an
+ *   author's tab by its name); the Templates tab when no kind has templates; the Backlog tab when no item kind's `x` and
+ *   `y` are Options; the Index tab with no zone kinds; the Layers tab with no layers; and each of an author's tab's
+ *   refusals
+ * @internal
+ */
+export function buildSchematicLibrary(tabs, ctx) {
+    if (tabs === undefined)
+        return East.value([], ArrayType(SchematicLibraryTabType));
+    if (!Array.isArray(tabs) || !tabs.every(isTab)) {
+        throw new Error("Schematic: `library` lists the library pane's tabs, in order, each a Schematic.library.* call — " +
+            "templates(), backlog(), index(), layers() or tab(rows, { … })");
+    }
+    const seen = new Set();
+    for (const tab of tabs) {
+        const id = tab.kind === "tab" ? `tab:${tab.config.name}` : tab.kind;
+        if (seen.has(id)) {
+            throw new Error(tab.kind === "tab"
+                ? `Schematic: the library lists two tabs named "${tab.config.name}" — each tab's name is its own`
+                : `Schematic: the library lists ${tabName(tab)} twice — each tab once`);
+        }
+        seen.add(id);
+        if (tab.kind === "templates" && !ctx.kinds.some((kind) => kind.templates)) {
+            throw new Error(`Schematic: the library lists ${tabName(tab)}, and none of its kinds has templates — give an item, link or net kind templates: ` +
+                "Schematic.templates(templates.read(), { name, values, source })");
+        }
+        if (tab.kind === "backlog" && !ctx.kinds.some((kind) => kind.sort === "items" && kind.backlog)) {
+            const items = ctx.kinds.filter((kind) => kind.sort === "items").map((kind) => `"${kind.slot}"`).join(", ");
+            throw new Error(`Schematic: the library lists ${tabName(tab)}, and every item kind places every row — ${items} take Float \`x\` and \`y\` fields: ` +
+                "make an item kind's Options of Float to give it rows with no position");
+        }
+        if (tab.kind === "index" && !ctx.kinds.some((kind) => kind.sort === "zones")) {
+            throw new Error("Schematic: the library lists Schematic.library.index(), and this Schematic has no zone kinds — the Index tab lists the zones (Schematic.zones), nested by containment");
+        }
+        if (tab.kind === "layers" && !ctx.layers) {
+            throw new Error("Schematic: the library lists Schematic.library.layers(), and this Schematic declares no layers — read them from the app's record: " +
+                "layers={Schematic.layers(systems.read(), { label })}");
+        }
+    }
+    const landsOn = ctx.kinds.map((kind) => [kind.slot, { rowType: kind.rowType }]);
+    const wires = tabs.map((tab) => {
+        switch (tab.kind) {
+            case "templates":
+            case "backlog":
+            case "index":
+            case "layers":
+                return East.value(variant(tab.kind, null), SchematicLibraryTabType);
+            case "tab":
+                return East.value(variant("tab", buildScheduleTab(tab, landsOn, "Schematic", ctx.sources, { kind: "kind", patch: "Schematic.patch" })), SchematicLibraryTabType);
+        }
+    });
+    return East.value(wires, ArrayType(SchematicLibraryTabType));
+}
+/**
+ * The sources of the slice the author's tabs name: each must be one of the
+ * slice's, and is one it may hold.
+ *
+ * @param tabs - The Schematic's `library`
+ * @returns The sources its tabs name, in order
+ * @internal
+ */
+export function schematicTabSources(tabs) {
+    if (!Array.isArray(tabs))
+        return [];
+    return tabs.filter(isTab).flatMap((tab) => tab.kind === "tab" && tab.config.source !== undefined ? [tab.config.source] : []);
+}
+//# sourceMappingURL=library.js.map

package/dist/src/schematic/library.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"library.js","sourceRoot":"","sources":["../../../src/schematic/library.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAyF,MAAM,eAAe,CAAC;AACvK,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAiC,MAAM,wBAAwB,CAAC;AAEhH,OAAO,EAAE,uBAAuB,IAAI,wBAAwB,EAA8D,MAAM,wBAAwB,CAAC;AAEzJ,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC;IAC/C,SAAS,EAAE,QAAQ;IACnB,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,qBAAqB;CAC7B,CAAC,CAAC;AAiBH;;;;;;;GAOG;AACH,SAAS,WAAW,CAAC,GAA4B,EAAE,KAAyB;IACxE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAC/B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW;QAC/B,CAAC,CAAC,qIAAqI;QACvI,CAAC,CAAC,oJAAoJ,CAAC,CAAC;AAChK,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAG,KAAuB;IACvD,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAChC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,GAAG,KAAuB;IACrD,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC9B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe;IACpB,MAAM,IAAI,KAAK,CAAC,kJAAkJ,CAAC,CAAC;AACxK,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY;IACxB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa;IACzB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,UAAU,CACtB,IAAwC,EACxC,MAAyC;IAEzC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAiE,EAAE,CAAC;AAC5G,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACrC,yDAAyD;IACzD,SAAS,EAAE,gBAAgB;IAC3B,wEAAwE;IACxE,OAAO,EAAE,cAAc;IACvB,8GAA8G;IAC9G,QAAQ,EAAE,eAA8C;IACxD,+DAA+D;IAC/D,KAAK,EAAE,YAAY;IACnB,0CAA0C;IAC1C,MAAM,EAAE,aAAa;IACrB,mDAAmD;IACnD,GAAG,EAAE,UAAU;CACT,CAAC;AAqCX,2CAA2C;AAC3C,SAAS,OAAO,CAAC,GAAwB;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,qBAAqB,GAAG,CAAC,IAAI,IAAI,CAAC;AACnG,CAAC;AAED,oDAAoD;AACpD,SAAS,KAAK,CAAC,KAAc;IACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;IAChD,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,KAAK,CAAC;AACjH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAa,EAAE,GAA4B;IAC7E,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAClF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,kGAAkG;YAC9G,+DAA+D,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,GAAG,IAAI,IAAsC,EAAE,CAAC;QACvD,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;QACpE,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK;gBAC9B,CAAC,CAAC,gDAAgD,GAAG,CAAC,MAAM,CAAC,IAAI,gCAAgC;gBACjG,CAAC,CAAC,gCAAgC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,GAAG,CAAC,oFAAoF;gBAC5I,iEAAiE,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7F,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3G,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,GAAG,CAAC,4CAA4C,KAAK,sCAAsC;gBAC/I,uEAAuE,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;YAC3E,MAAM,IAAI,KAAK,CAAC,uKAAuK,CAAC,CAAC;QAC7L,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,oIAAoI;gBAChJ,sDAAsD,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAU,CAAC,CAAC;IACzF,MAAM,KAAK,GAAI,IAAuC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAqC,EAAE;QAClG,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,WAAW,CAAC;YACjB,KAAK,SAAS,CAAC;YACf,KAAK,OAAO,CAAC;YACb,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,uBAAuB,CAAC,CAAC;YACxE,KAAK,KAAK;gBACN,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAC;QACzK,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAa;IAC7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACjI,CAAC"}