@nubbin/core 0.1.0-rc.0 → 0.1.0-rc.4

package/README.md

@@ -0,0 +1,37 @@
+# @nubbin/core
+
+The contract every other Nubbin package is built around. It defines what a block is, keeps the
+catalog and the registry apart, and compiles a page document into an immutable artifact.
+
+It has one runtime dependency — [Standard Schema](https://standardschema.dev) — and imports no
+validator, no framework and no node builtin. A build gate fails on any of the three, so the
+claim that it runs in a browser, a worker and a build step is checked rather than asserted.
+
+```bash
+npm install @nubbin/core@rc
+```
+
+```ts
+import { defineBlock, defineCatalog, createRegistry, compile } from "@nubbin/core";
+import { z } from "zod";
+
+const heroSchema = z.object({ title: z.string() });
+
+export const heroBlock = defineBlock({
+  name: "Hero",
+  schema: heroSchema,
+  component: Hero,
+  version: 1,
+  slots: {},
+});
+
+const artifact = compile(documentVersion, catalog, registry, "/promotions/summer");
+```
+
+Props are inferred from the schema with `InferProps<typeof heroSchema>`, so nothing declares a
+block's shape twice.
+
+**Release candidate.** The API is settled enough to build against and not yet stable.
+
+The design record, including the paths not taken, is at
+<https://effekt.github.io/nubbin/>. MIT.

package/dist/index.d.ts

@@ -11,7 +11,7 @@ type UnknownProps = Record<string, unknown>;
  */
 type InferProps<Schema extends StandardSchemaV1> = StandardSchemaV1.InferOutput<Schema>;
 interface SlotConstraint {
-    /** Block names permitted here. Omitted means any registered block. */
+    /** Block names permitted here, each resolved at registration. Omitted means any registered block. */
     allow?: readonly string[];
     min?: number;
     max?: number;
@@ -179,6 +179,9 @@ declare function compile(version: DocumentVersion, catalog: Catalog, registry: R
  * Sorted by name so registration order cannot change the fingerprint, and built from name and
  * version alone so unrelated edits — a slot constraint, a deprecation — do not invalidate every
  * artifact compiled before them.
+ *
+ * Slot `allow` lists resolve once the whole array is ingested, so a block may name a sibling
+ * registered after it.
  */
 declare function createRegistry(blocks: readonly Block[]): Registry;
 

package/dist/index.js

@@ -401,7 +401,7 @@ function validateStructure(version, registry) {
 }
 
 // src/version.constants.ts
-var NUBBIN_VERSION = "0.0.0";
+var NUBBIN_VERSION = "0.1.0-rc.4";
 
 // src/compile.ts
 function compile(version, catalog, registry, route) {
@@ -423,6 +423,24 @@ function compile(version, catalog, registry, route) {
   return { ...content, hash: hashArtifact(content) };
 }
 
+// src/unknownAllowEntries.ts
+function unknownAllowEntries(block, known) {
+  return Object.entries(block.slots).flatMap(
+    ([slot, constraint]) => (constraint.allow ?? []).filter((allowed) => !known.has(allowed)).map((allowed) => `"${allowed}" (${block.name}.${slot})`)
+  );
+}
+
+// src/assertSlotAllows.ts
+function assertSlotAllows(blocks) {
+  const known = new Set(blocks.map((block) => block.name));
+  const unresolved = blocks.flatMap((block) => unknownAllowEntries(block, known));
+  if (unresolved.length > 0) {
+    throw new Error(
+      `Slot allow lists name ${unresolved.join(", ")}, which no registered block defines. Registered blocks: ${[...known].sort().join(", ")}`
+    );
+  }
+}
+
 // src/createRegistry.ts
 function createRegistry(blocks) {
   const byName = /* @__PURE__ */ new Map();
@@ -434,6 +452,7 @@ function createRegistry(blocks) {
     }
     byName.set(block.name, block);
   }
+  assertSlotAllows([...byName.values()]);
   const signature = [...byName.values()].map((block) => `${block.name}@${block.version}`).sort().join("\n");
   const fingerprint = fnv1a(signature);
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nubbin/core",
-  "version": "0.1.0-rc.0",
+  "version": "0.1.0-rc.4",
   "description": "The Nubbin contract: define blocks, split catalog from registry, and compile a page document into an immutable artifact.",
   "keywords": [
     "nubbin",