meno-core 1.1.2 → 1.1.3

package/lib/shared/validation/schemas.ts

@@ -126,10 +126,47 @@ export const ListPropDefinitionSchema = z
   .passthrough();
 
 /**
- * Prop definition schema (union of base and list)
- * Validates prop definitions from component interfaces
+ * Prop definition schema — discriminates on `type` instead of a plain
+ * `z.union([List, Base])`.
+ *
+ * Why not a bare union: a `type: "list"` prop with a bad shape (the single most
+ * common authoring mistake — a bare-string `default` and/or a missing
+ * `itemSchema`, e.g. `{ type: "list", default: ["a", "b"] }`) matches NEITHER
+ * union branch (List wants `itemSchema` + an object-array `default`; Base's
+ * `type` enum has no `"list"`). The union then reports a noisy pile of
+ * cross-branch issues (`type` not in the base enum, `default[0]` expected object,
+ * …) — and, worse, when this prop sits inside a component file the outer
+ * `PageDataSchema` union surfaces the *page* branch's refine instead (see
+ * `JSONPageSchema` / `PageDataSchema` below), so the real error reads
+ * "JSONPage must have …root". The codec round-trips it and `astro build`
+ * renders it, so the only place it ever surfaces is here.
+ *
+ * Discriminating on `type` lets a list prop be validated by ONLY
+ * `ListPropDefinitionSchema` and collapses its failure into one actionable
+ * message that names the requirement, at the prop's own path.
  */
-export const PropDefinitionSchema = z.union([ListPropDefinitionSchema, BasePropDefinitionSchema]);
+export const PropDefinitionSchema = z
+  .object({ type: z.string() })
+  .passthrough()
+  .superRefine((val, ctx) => {
+    const branch = val.type === 'list' ? ListPropDefinitionSchema : BasePropDefinitionSchema;
+    const result = branch.safeParse(val);
+    if (result.success) return;
+    if (val.type === 'list') {
+      // Collapse the list-prop failure into one actionable message rather than
+      // replaying zod's per-field noise. `itemSchema` is required and `default`
+      // must be an array of OBJECTS (one `{ field: value }` record per item).
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          'list prop requires `itemSchema` and an object-array `default` ' +
+          '(each item is a `{ field: value }` object, not a bare string)',
+      });
+      return;
+    }
+    // Non-list props keep their precise per-field errors.
+    for (const issue of result.error.issues) ctx.addIssue(issue);
+  });
 
 /**
  * Style mapping schema
@@ -722,6 +759,14 @@ export const JSONPageSchema = z
     // Marks a page whose source is outside the meno-astro dialect (read-only in the editor).
     // Explicit (not just .passthrough()) so it survives a future tightening of this schema.
     _unsupported: z.object({ reason: z.string() }).passthrough().optional(),
+    // A component payload (`{ component: {...} }`) must NEVER validate as a page.
+    // Without this guard the page branch parses structurally (it's `.passthrough()`)
+    // and only trips the refine below — so when both branches of `PageDataSchema`
+    // fail, zod treats this branch as the "closest" (dirty) one and surfaces
+    // "JSONPage must have …root", masking the real component error (e.g. a malformed
+    // list prop). Rejecting a present `component` key makes this branch hard-fail on
+    // component payloads, so `PageDataSchema` reports the component branch instead.
+    component: z.undefined().optional(),
   })
   .passthrough()
   .refine(
@@ -752,8 +797,11 @@ export const PageDataWithComponentSchema = z
   .passthrough();
 
 /**
- * Page data schema - union of JSONPage and PageDataWithComponent
- * PageDataWithComponent checked first because it's more specific
+ * Page data schema - union of JSONPage and PageDataWithComponent.
+ * PageDataWithComponent is checked first because it's more specific; the
+ * `component: z.undefined()` guard on `JSONPageSchema` keeps a component payload
+ * from being mis-reported as a page (see that schema's comment), so a malformed
+ * prop surfaces its own error instead of the page-branch refine.
  */
 export const PageDataSchema = z.union([PageDataWithComponentSchema, JSONPageSchema]);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "meno-core",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "type": "module",
   "bin": {
     "meno": "./dist/bin/cli.js"