@loomwork/blueprint-runtime 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/NOTICE

@@ -0,0 +1,8 @@
+Loom
+Copyright 2026 Sushil Chhetri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this project except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -1,3 +1,84 @@
-# Temporary Holding Version
+# @loomwork/blueprint-runtime — the Blueprint rendering IR
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Blueprint is a declarative, JSON-serializable description of a screen: a layout (grid, flex, stack) of
+widgets, each bound to a path in a projection. This package defines that IR and the framework-agnostic
+tools around it: builders, a validator that checks a Blueprint against a catalogue of allowed widgets,
+identity and version-pin checks, and a traversal that every renderer is built on. It draws nothing itself;
+renderers (`@loomwork/plugin-renderer-terminal`, `@loomwork/plugin-renderer-dom`, `@loomwork/plugin-renderer-react`) read the same Blueprint. Use it to compose
+a surface in code, or to check one that a model composed, before rendering or storing it.
+
+```ts
+import {
+  DataTable,
+  MetricCard,
+  blueprint$,
+  builtinCatalog,
+  cell,
+  grid,
+  validateBlueprint,
+} from "@loomwork/blueprint-runtime";
+
+const board = blueprint$({
+  id: "db-health",
+  title: "Database health",
+  projections: ["db"],
+  layout: grid({
+    columns: 3,
+    title: "Overview",
+    children: [
+      // Give a widget an explicit id if a composer will revise it: the default id hashes the props.
+      MetricCard({
+        id: "connections",
+        title: "Connections",
+        binding: { projectionId: "db", path: "connections" },
+      }),
+      cell(2, DataTable({ id: "slow", title: "Slow queries", binding: { projectionId: "db", path: "slow" } })),
+    ],
+  }),
+});
+
+// A blueprint a model composes is data: check it against the catalogue. Never throws.
+const report = validateBlueprint(board, builtinCatalog);
+console.log(report.ok, report.widgets, report.findings); // true 2 []
+```
+
+## Surface
+
+- **Build.** `blueprint$({ id, title, layout, projections, projectionVersions? })`; layouts `grid`, `flex`,
+  `stack` (with `cell(span, node, placement?)` for grid placement); widgets `MetricCard`, `Timeline`,
+  `ApprovalCard`, `StatusBadge`, `ProgressBar`, `DataTable`, `AlertCard`, `StreamingText`, and
+  `customWidget$` for your own kind.
+- **Check.** `validateBlueprint(blueprint, catalog)` returns `{ ok, findings, widgets }`;
+  `defineWidgetCatalog`, `builtinCatalog`, `catalogCoverage`. `blueprintNodeIds`, `blueprintLayoutIds` and
+  `preservesNodes` report which ids a revision dropped. `blueprintPins` and `checkBlueprintPins` compare
+  the projection versions a view recorded with the live ones.
+- **Render.** `traverseBlueprint` and `traverseBlueprintAsync`, `RendererRegistry`, `resolveWidgetValue`,
+  and `describeWidgetStatus` / `describeWidgetFrame`, the single decision about what a widget shows when its
+  binding is pending, stale, empty, errored or redacted.
+- **Versioning.** `BLUEPRINT_IR_VERSION` (currently 2.5.0), `upgradeBlueprint`, `blueprintIrVersion`.
+
+## Behaviour that surprises people
+
+- **A default widget id is a hash of its props.** It changes when any prop changes, so a revised widget is
+  re-identified, remounted, and loses anything keyed on it. Pass `id` for any widget a composer will edit.
+- **The checks report findings and never throw**, so a composer can degrade and record a gap. A report
+  with zero `widgets` is not a pass; `widgets` is the denominator.
+- **Grid reading order is guaranteed only for fully placed or fully unplaced grids.** If some cells have
+  `row` and `column` and others do not, CSS auto-placement (React) and the terminal's absent-last sort can
+  disagree (ADR 0098).
+- **`empty` is not `error`.** A binding that delivered but has nothing to show is its own state (IR 2.3.0,
+  ADR 0100), and a binding's `sensitivity` is read by compilers and delivery, never by renderers.
+- **The IR is pinned.** A test pins the shape digest per version; any shape change needs a version bump.
+  A Blueprint without `irVersion` reads as 1.0.0, and `upgradeBlueprint` is the identity on 2.0.0 through
+  2.5.0.
+
+## Install
+
+Unpublished for now: inside this repo use `workspace:*`; from a sibling checkout use a `link:` override (see [AGENTS.md](../../AGENTS.md)).
+
+## See also
+
+- API reference: section "`@loomwork/blueprint-runtime` — declarative UI" in [docs/api-reference.org](../../docs/api-reference.org).
+- Guides: [composed surfaces](../../docs/composed-surfaces.md), [user guide, section 6: projections and agent surfaces](../../docs/user-guide.md#6-projections--agent-surfaces).
+- ADRs: [0088 blueprint conformance](../../docs/adr/0088-blueprint-conformance.md), [0094 node identity](../../docs/adr/0094-blueprint-node-identity.md), [0095 binding-semantics pin](../../docs/adr/0095-binding-semantics-pin.md), [0096 stable rendering IR](../../docs/adr/0096-blueprint-stable-rendering-ir.md), [0098 placement and titles](../../docs/adr/0098-blueprint-ir-placement-and-titles.md), [0100 empty state](../../docs/adr/0100-blueprint-ir-empty-binding-state.md).
+- Source: `packages/blueprint-runtime/src`.

package/dist/Blueprint.d.ts

@@ -0,0 +1,14 @@
+import type { Blueprint, Layout } from "./types";
+export interface BlueprintConfig {
+    id: string;
+    title: string;
+    layout: Layout;
+    projections: string[];
+    /**
+     * ADR 0095 — the declared versions of the projections this view binds to, at composition.
+     * `projectionRuntime.pins()` is where they come from. See {@link Blueprint.projectionVersions}.
+     */
+    projectionVersions?: Readonly<Record<string, string>>;
+}
+export declare function blueprint$(config: BlueprintConfig): Blueprint;
+//# sourceMappingURL=Blueprint.d.ts.map

package/dist/Blueprint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Blueprint.d.ts","sourceRoot":"","sources":["../src/Blueprint.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACvD;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAY7D"}

package/dist/Blueprint.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.blueprint$ = blueprint$;
+const irVersion_1 = require("./irVersion");
+function blueprint$(config) {
+    return {
+        _tag: "Blueprint",
+        irVersion: irVersion_1.BLUEPRINT_IR_VERSION,
+        id: config.id,
+        title: config.title,
+        layout: config.layout,
+        projections: config.projections,
+        ...(config.projectionVersions !== undefined && {
+            projectionVersions: config.projectionVersions,
+        }),
+    };
+}
+//# sourceMappingURL=Blueprint.js.map

package/dist/Blueprint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Blueprint.js","sourceRoot":"","sources":["../src/Blueprint.ts"],"names":[],"mappings":";;AAeA,gCAYC;AA3BD,2CAAmD;AAenD,SAAgB,UAAU,CAAC,MAAuB;IAChD,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,gCAAoB;QAC/B,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,GAAG,CAAC,MAAM,CAAC,kBAAkB,KAAK,SAAS,IAAI;YAC7C,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;SAC9C,CAAC;KACH,CAAC;AACJ,CAAC"}

package/dist/RendererRegistry.d.ts

@@ -0,0 +1,9 @@
+export declare class RendererRegistry<TRenderer> {
+    private readonly renderers;
+    register(kind: string, renderer: TRenderer): this;
+    get(kind: string): TRenderer | undefined;
+    has(kind: string): boolean;
+    kinds(): string[];
+    merge(other: RendererRegistry<TRenderer>): RendererRegistry<TRenderer>;
+}
+//# sourceMappingURL=RendererRegistry.d.ts.map

package/dist/RendererRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RendererRegistry.d.ts","sourceRoot":"","sources":["../src/RendererRegistry.ts"],"names":[],"mappings":"AAMA,qBAAa,gBAAgB,CAAC,SAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgC;IAE1D,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,GAAG,IAAI;IAKjD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIxC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,KAAK,IAAI,MAAM,EAAE;IAMjB,KAAK,CAAC,KAAK,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,gBAAgB,CAAC,SAAS,CAAC;CASvE"}

package/dist/RendererRegistry.js

@@ -0,0 +1,39 @@
+"use strict";
+// Generic widget registry — framework-agnostic.
+// TRenderer is narrowed by each framework adapter:
+//   React:   RendererRegistry<React.FC<WidgetRendererProps>>
+//   Angular: RendererRegistry<Type<unknown>>
+//   DOM:     RendererRegistry<(el: HTMLElement, props: WidgetRendererProps) => void>
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RendererRegistry = void 0;
+class RendererRegistry {
+    renderers = new Map();
+    register(kind, renderer) {
+        this.renderers.set(kind, renderer);
+        return this;
+    }
+    get(kind) {
+        return this.renderers.get(kind);
+    }
+    has(kind) {
+        return this.renderers.has(kind);
+    }
+    kinds() {
+        return Array.from(this.renderers.keys());
+    }
+    // Returns a new registry that contains all renderers from both registries.
+    // Entries in `other` win on conflicts.
+    merge(other) {
+        const merged = new RendererRegistry();
+        for (const [kind, r] of this.renderers)
+            merged.register(kind, r);
+        for (const kind of other.kinds()) {
+            const r = other.get(kind);
+            if (r !== undefined)
+                merged.register(kind, r);
+        }
+        return merged;
+    }
+}
+exports.RendererRegistry = RendererRegistry;
+//# sourceMappingURL=RendererRegistry.js.map

package/dist/RendererRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RendererRegistry.js","sourceRoot":"","sources":["../src/RendererRegistry.ts"],"names":[],"mappings":";AAAA,gDAAgD;AAChD,mDAAmD;AACnD,6DAA6D;AAC7D,6CAA6C;AAC7C,qFAAqF;;;AAErF,MAAa,gBAAgB;IACV,SAAS,GAAG,IAAI,GAAG,EAAqB,CAAC;IAE1D,QAAQ,CAAC,IAAY,EAAE,QAAmB;QACxC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,KAAK;QACH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,2EAA2E;IAC3E,uCAAuC;IACvC,KAAK,CAAC,KAAkC;QACtC,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAa,CAAC;QACjD,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACjE,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,SAAS;gBAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/BD,4CA+BC"}

package/dist/catalog.d.ts

@@ -0,0 +1,129 @@
+import type { Blueprint } from "./types";
+/**
+ * One component a composer may name.
+ *
+ * Both fields are required. An optional allow-list is the failure mode this
+ * module exists to prevent: an entry that declined to say which props it accepts
+ * would pass the payload check vacuously, and a check that cannot fail reads as
+ * coverage while verifying nothing. `props: []` is a perfectly good answer.
+ */
+export interface CatalogEntry {
+    readonly kind: string;
+    /**
+     * Prop keys this component accepts. `binding` is reserved and always allowed —
+     * the built-in builders duplicate the declared binding into `props` — so it
+     * need not be listed.
+     */
+    readonly props: readonly string[];
+    /**
+     * Whether this component renders bound data.
+     * - `required` — a widget without a `DataBinding` renders nothing, so its
+     *   absence is an error rather than an empty state;
+     * - `optional` — either is legitimate;
+     * - `none` — decorative or structural; a binding on it is a composer mistake.
+     */
+    readonly binding: "required" | "optional" | "none";
+}
+export interface WidgetCatalog {
+    readonly id: string;
+    readonly entries: readonly CatalogEntry[];
+}
+/** Identity helper — declare a catalogue with inferred types. */
+export declare function defineWidgetCatalog(catalog: WidgetCatalog): WidgetCatalog;
+export declare const BUILTIN_CATALOG_ID = "loom.builtin.v1";
+/**
+ * The eight widgets `@loomwork/blueprint-runtime` ships, as a catalogue.
+ *
+ * `props` mirrors each builder's props interface minus `title` (hoisted onto
+ * `Widget.title`) and minus `binding` (reserved). Every built-in requires a
+ * binding — none of them render anything without one.
+ */
+export declare const builtinCatalog: WidgetCatalog;
+export type BlueprintFindingCode = 
+/** A `kind` the catalogue does not define. */
+"unknown-kind"
+/** A `binding: "required"` component with no `DataBinding`. */
+ | "missing-binding"
+/** A `binding: "none"` component carrying one anyway. */
+ | "unexpected-binding"
+/** A prop key outside the catalogue entry's allow-list — the exfiltration check. */
+ | "undeclared-prop"
+/** A binding to a projection the blueprint never declares — renders blank, silently. */
+ | "undeclared-projection"
+/**
+ * Two nodes sharing an id — node identity, and the renderer's key, collide. Widget ids and
+ * layout ids (IR 2.4.0) are ONE namespace: widget↔widget, widget↔layout and layout↔layout all
+ * collide. Reported on the second occurrence in pre-order.
+ */
+ | "duplicate-node-id"
+/** A grid cell's `span` is not an integer in `1..columns`. */
+ | "span-out-of-range"
+/**
+ * A grid cell's placement (IR 2.1.0) cannot be laid out: `row`, `rowSpan` or `column` is not a
+ * positive integer, `column` exceeds `columns`, or `column + span - 1` overflows the grid.
+ */
+ | "placement-out-of-range"
+/**
+ * A layout's `role` (IR 2.2.0) is present but not a well-formed role (`isLayoutRole`): renderers
+ * draw the plain container, so nothing is lost but the custom rendering — a `warn`. An unknown
+ * but well-formed role is NOT a finding: whether a renderer has it registered is not loom's to say.
+ */
+ | "role-invalid"
+/**
+ * A layout's `id` (IR 2.4.0, ADR 0101) is present but not a non-empty string: renderers treat it
+ * as absent and key the container positionally, so nothing is lost but state preservation
+ * across a recompose — a `warn`.
+ */
+ | "layout-id-invalid"
+/** A grid's `columns` is not a positive integer — there is no column count to lay cells into. */
+ | "columns-invalid"
+/** A node that is neither a `Widget` nor a `Layout` (a stray `null`, a string, a stranded `GridCell`). */
+ | "malformed-node"
+/** `binding.status.path` is empty or not a dotted path. */
+ | "status-path-invalid"
+/** `binding.sensitivity` is not a `@loomwork/classify` `DataClass`. */
+ | "sensitivity-unknown"
+/** `widget.source` (or a `degradedFrom` entry) is missing `type` or `version`. */
+ | "source-invalid"
+/**
+ * `source.redacted` (IR 2.5.0, ADR 0097 amendment) is present but not `true`, or is `true` on a
+ * widget that still carries a `binding` or a `degradedFrom` chain — both would leave the
+ * withheld content (a projection id, a path, the original type) on the artifact.
+ */
+ | "redacted-invalid"
+/** `blueprint.irVersion` is set but not a version this module recognizes. */
+ | "ir-version-unknown";
+export interface BlueprintFinding {
+    readonly code: BlueprintFindingCode;
+    readonly severity: "error" | "warn";
+    readonly message: string;
+    /**
+     * The node the finding applies to. For a widget-level finding it is the widget's id. For a
+     * cell-level finding (`span-out-of-range`, `placement-out-of-range`) it is the id of the cell's
+     * OWN node — a widget's id, or a nested layout's well-formed id (IR 2.4.0) — else `"<layout>"`.
+     * For a layout-level finding (`columns-invalid`, `role-invalid`, `duplicate-node-id` on a
+     * layout) it is the layout's well-formed id when it has one, else `"<layout>"`. For
+     * `ir-version-unknown`, `malformed-node` and `layout-id-invalid` it is always `"<layout>"`.
+     */
+    readonly nodeId: string;
+    /** The widget's kind, or `"<layout>"` for a layout-level finding. */
+    readonly kind: string;
+}
+export interface BlueprintValidation {
+    /** True iff there are no `error`-severity findings. */
+    readonly ok: boolean;
+    readonly findings: readonly BlueprintFinding[];
+    /**
+     * Widgets visited. The denominator for a first-attempt validation rate — a
+     * report with zero widgets is not a pass, and this is how a caller tells the
+     * difference.
+     */
+    readonly widgets: number;
+}
+/**
+ * Check a blueprint against a catalogue. Never throws; returns every finding it
+ * can see in one pass, so a caller degrades or records a gap on the whole report
+ * rather than on the first failure.
+ */
+export declare function validateBlueprint(blueprint: Blueprint, catalog: WidgetCatalog): BlueprintValidation;
+//# sourceMappingURL=catalog.d.ts.map

package/dist/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAA4B,MAAM,SAAS,CAAC;AAiCnE;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;CACpD;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED,iEAAiE;AACjE,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAEzE;AAED,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,EAAE,aAY5B,CAAC;AAIF,MAAM,MAAM,oBAAoB;AAC9B,8CAA8C;AAC5C,cAAc;AAChB,+DAA+D;GAC7D,iBAAiB;AACnB,yDAAyD;GACvD,oBAAoB;AACtB,oFAAoF;GAClF,iBAAiB;AACnB,wFAAwF;GACtF,uBAAuB;AACzB;;;;GAIG;GACD,mBAAmB;AACrB,8DAA8D;GAC5D,mBAAmB;AACrB;;;GAGG;GACD,wBAAwB;AAC1B;;;;GAIG;GACD,cAAc;AAChB;;;;GAIG;GACD,mBAAmB;AACrB,iGAAiG;GAC/F,iBAAiB;AACnB,0GAA0G;GACxG,gBAAgB;AAClB,2DAA2D;GACzD,qBAAqB;AACvB,uEAAuE;GACrE,qBAAqB;AACvB,kFAAkF;GAChF,gBAAgB;AAClB;;;;GAIG;GACD,kBAAkB;AACpB,6EAA6E;GAC3E,oBAAoB,CAAC;AAEzB,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC/C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAoKD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,aAAa,GACrB,mBAAmB,CA+RrB"}