@rubytech/create-maxy-code 0.1.60 → 0.1.62

package/payload/platform/plugins/preval/skills/property-preval/references/template-inputs.schema.json

@@ -1,24 +1,78 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "property-preval inputs",
-  "description": "Single-source contract for render.py. Mirrors the 12 property-data MCP responses for one full UK address.",
+  "description": "Single-source contract for render.py. Mirrors the 12 property-data MCP responses + 1 EPC MCP response for one full UK address, plus operator-supplied brand, subject, market_summary, and agent_listings.",
   "type": "object",
-  "required": ["out_dir", "filename_stem", "address", "postcode", "generated", "valuation", "area", "demand_trend"],
+  "required": [
+    "out_dir", "filename_stem", "address", "postcode", "generated",
+    "brand", "subject", "valuation", "area", "demand_trend",
+    "market_summary", "agent_listings"
+  ],
   "properties": {
-    "out_dir":        { "type": "string", "description": "Absolute path to the output directory (created if missing)." },
-    "filename_stem":  { "type": "string", "description": "PDF filename stem; .pdf appended by the renderer." },
-    "address":        { "type": "string", "description": "Full UK address as the operator gave it." },
-    "postcode":       { "type": "string", "description": "Postcode derived from the address, e.g. 'CM23 2UJ'." },
-    "generated":      { "type": "string", "description": "Human date, e.g. '19 May 2026'." },
+    "out_dir":       { "type": "string", "description": "Absolute path to the output directory (created if missing)." },
+    "filename_stem": { "type": "string", "description": "PDF filename stem; .pdf appended by the renderer." },
+    "address":       { "type": "string", "description": "Full UK address as the operator gave it." },
+    "postcode":      { "type": "string", "description": "Postcode derived from the address, e.g. 'CM23 2UJ'." },
+    "generated":     { "type": "string", "description": "Human date, e.g. '19 May 2026'." },
+
+    "brand": {
+      "type": "object",
+      "required": ["name", "tagline", "primary", "primary_dark", "accent", "paper", "paper_banded", "rule"],
+      "properties": {
+        "name":         { "type": "string" },
+        "tagline":      { "type": "string" },
+        "primary":      { "type": "string", "description": "Hex, e.g. '#064444'." },
+        "primary_dark": { "type": "string" },
+        "accent":       { "type": "string" },
+        "paper":        { "type": "string" },
+        "paper_banded": { "type": "string" },
+        "rule":         { "type": "string" },
+        "logo_light":   { "type": "string", "description": "Optional filesystem path to white-on-transparent logo for the cover." },
+        "logo_dark":    { "type": "string", "description": "Optional filesystem path to full-colour logo for body-page headers." }
+      }
+    },
+
+    "subject": {
+      "type": "object",
+      "required": ["cover_hero", "sqft", "sqft_m2"],
+      "properties": {
+        "cover_hero":     { "type": "string", "description": "Filesystem path or URL to a photo of the subject property — required for the cover. Renderer asserts the file exists, is ≥ 1200×800, and is not symlinked to another property's folder." },
+        "beds":           { "type": ["integer", "null"] },
+        "type":           { "type": ["string", "null"], "description": "e.g. 'Semi-detached', 'Terraced', 'Flat'." },
+        "tenure":         { "type": ["string", "null"], "description": "e.g. 'Freehold', 'Leasehold'." },
+        "condition":      { "type": ["string", "null"], "description": "'well' | 'average' | 'needs work'." },
+        "sqft":           { "type": "integer", "description": "Total internal area in square feet. Required. Pulled from EPC (m² × 10.7639, rounded) when available; operator paste-in is the only override. Null aborts the run." },
+        "sqft_m2":        { "type": "number", "description": "Total internal area in square metres from the EPC register. Required alongside sqft." },
+        "epc_current":    { "type": ["string", "null"], "description": "Current energy rating, e.g. 'C'." },
+        "epc_potential":  { "type": ["string", "null"], "description": "Potential energy rating, e.g. 'B'." },
+        "epc_lodgement":  { "type": ["string", "null"], "description": "ISO date of the EPC lodgement." },
+        "narrative":      { "type": ["string", "null"], "description": "One short paragraph the operator writes about the subject — shown under the valuation panel." },
+        "adjustments": {
+          "type": "array",
+          "description": "Operator-curated esoteric factors that shift the headline range. Deltas sum linearly into the final factor (1 + Σ delta_pct/100).",
+          "items": {
+            "type": "object",
+            "required": ["label", "delta_pct"],
+            "properties": {
+              "label":     { "type": "string" },
+              "delta_pct": { "type": "number", "description": "Percent change, e.g. 3 for +3%, -8 for -8%." }
+            }
+          }
+        }
+      }
+    },
+
     "valuation": {
       "type": "object",
-      "required": ["avg_asking", "asking_psf", "avg_sold", "sold_psf", "sold_comps", "asking_comps"],
+      "required": ["avg_asking", "asking_psf", "avg_sold", "sold_psf", "sold_psf_low", "sold_psf_high", "sold_comps", "asking_comps"],
       "properties": {
-        "avg_asking":   { "type": "integer", "description": "Mean asking £ (from property-data-prices)." },
-        "asking_psf":   { "type": "integer", "description": "Asking £/sqft (from property-data-prices-per-sqf)." },
-        "avg_sold":     { "type": "integer", "description": "Mean sold £ (from property-data-sold-prices)." },
-        "sold_psf":     { "type": "integer", "description": "Sold £/sqft (from property-data-sold-prices-per-sqf)." },
-        "sold_range":   { "type": "array", "items": { "type": "integer" }, "minItems": 2, "maxItems": 2, "description": "Optional 70pc range [low, high]." },
+        "avg_asking":   { "type": "integer", "description": "Mean asking £ from property-data-prices." },
+        "asking_psf":   { "type": "integer", "description": "Mean asking £/sqft." },
+        "avg_sold":     { "type": "integer", "description": "Mean sold £ from property-data-sold-prices." },
+        "sold_psf":     { "type": "integer", "description": "Mean sold £/sqft (midpoint of valuation)." },
+        "sold_psf_low": { "type": "integer", "description": "Lower bound of the sold £/sqft 70pc range." },
+        "sold_psf_high":{ "type": "integer", "description": "Upper bound of the sold £/sqft 70pc range." },
+        "sold_range":   { "type": "array", "items": { "type": "integer" }, "minItems": 2, "maxItems": 2, "description": "Optional 70pc sold-£ range [low, high]." },
         "sold_comps": {
           "type": "array",
           "description": "Nearest sold transactions (≤ 6 rows in the table).",
@@ -26,10 +80,10 @@
             "type": "object",
             "required": ["date", "address", "type", "price"],
             "properties": {
-              "date":     { "type": "string" },
-              "address":  { "type": "string" },
-              "type":     { "type": "string" },
-              "price":    { "type": "integer" }
+              "date":    { "type": "string" },
+              "address": { "type": "string" },
+              "type":    { "type": "string" },
+              "price":   { "type": "integer" }
             }
           }
         },
@@ -40,80 +94,47 @@
             "type": "object",
             "required": ["address", "price"],
             "properties": {
-              "address":  { "type": "string" },
-              "price":    { "type": "integer" },
-              "beds":     { "type": ["integer", "null"] },
-              "type":     { "type": ["string", "null"] }
+              "address": { "type": "string" },
+              "price":   { "type": "integer" },
+              "beds":    { "type": ["integer", "null"] },
+              "type":    { "type": ["string", "null"] }
             }
           }
         }
       }
     },
+
     "area": {
       "type": "object",
       "required": ["crime_rating", "flood_risk", "council_tax_band_d", "population", "crime_breakdown", "council_tax_bands", "headline"],
       "properties": {
-        "crime_rating":     { "type": "string", "description": "e.g. 'Below average'." },
-        "flood_risk":       { "type": "string", "description": "e.g. 'Very low'." },
-        "council_tax_band_d": { "type": "integer", "description": "Annual £ at band D." },
-        "population":       { "type": "integer", "description": "Local area population." },
-        "crime_breakdown": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "required": ["category", "count"],
-            "properties": {
-              "category": { "type": "string" },
-              "count":    { "type": "integer" }
-            }
-          }
-        },
-        "council_tax_bands": {
-          "type": "array",
-          "description": "Band → annual £ rows.",
-          "items": {
-            "type": "object",
-            "required": ["band", "amount"],
-            "properties": {
-              "band":   { "type": "string" },
-              "amount": { "type": "integer" }
-            }
-          }
-        },
-        "headline": { "type": "string", "description": "One-sentence area read." }
+        "crime_rating":       { "type": "string" },
+        "flood_risk":         { "type": "string" },
+        "council_tax_band_d": { "type": "integer" },
+        "population":         { "type": "integer" },
+        "crime_breakdown":    { "type": "array", "items": { "type": "object", "required": ["category", "count"], "properties": { "category": {"type":"string"}, "count": {"type":"integer"} } } },
+        "council_tax_bands":  { "type": "array", "items": { "type": "object", "required": ["band", "amount"], "properties": { "band": {"type":"string"}, "amount": {"type":"integer"} } } },
+        "headline":           { "type": "string" }
       }
     },
+
     "demand_trend": {
       "type": "object",
       "required": ["demand_rating", "dom", "turnover_pct", "for_sale", "growth_series", "growth_psf_series", "rental", "type_dist"],
       "properties": {
-        "demand_rating": { "type": "string", "description": "e.g. 'Balanced market'." },
-        "dom":           { "type": "integer", "description": "Days on market." },
-        "turnover_pct":  { "type": "integer", "description": "Turnover percent per month." },
-        "for_sale":      { "type": "integer", "description": "Current for-sale count." },
+        "demand_rating":  { "type": "string" },
+        "dom":            { "type": "integer" },
+        "turnover_pct":   { "type": "integer" },
+        "for_sale":       { "type": "integer" },
+        "sales_per_month":{ "type": "integer" },
+        "yoy_growth_pct": { "type": "number" },
         "growth_series": {
           "type": "array",
-          "description": "7-year £ series, oldest first.",
-          "items": {
-            "type": "object",
-            "required": ["label", "price"],
-            "properties": {
-              "label": { "type": "string" },
-              "price": { "type": "integer" }
-            }
-          }
+          "items": { "type": "object", "required": ["label", "price"], "properties": { "label": {"type":"string"}, "price": {"type":"integer"} } }
         },
         "growth_psf_series": {
           "type": "array",
-          "description": "7-year £/sqft series, oldest first.",
-          "items": {
-            "type": "object",
-            "required": ["label", "psf"],
-            "properties": {
-              "label": { "type": "string" },
-              "psf":   { "type": "integer" }
-            }
-          }
+          "items": { "type": "object", "required": ["label", "psf"], "properties": { "label": {"type":"string"}, "psf": {"type":"integer"} } }
         },
         "rental": {
           "type": "object",
@@ -127,15 +148,40 @@
         },
         "type_dist": {
           "type": "array",
-          "description": "Property-type mix doughnut rows.",
-          "items": {
-            "type": "object",
-            "required": ["name", "pct"],
-            "properties": {
-              "name": { "type": "string" },
-              "pct":  { "type": "number" }
-            }
-          }
+          "items": { "type": "object", "required": ["name", "pct"], "properties": { "name": {"type":"string"}, "pct": {"type":"number"} } }
+        }
+      }
+    },
+
+    "market_summary": {
+      "type": "object",
+      "required": ["headline", "paragraphs", "demand_gauge_position", "price_growth_note", "demand_note"],
+      "properties": {
+        "headline":              { "type": "string", "description": "One-line display-italic h2 for the market context page." },
+        "paragraphs":            { "type": "array", "minItems": 2, "items": { "type": "string" }, "description": "2–3 short paragraphs. First gets a drop cap. Fewer than 2 aborts the run." },
+        "demand_gauge_position": { "type": "string", "description": "Percentage string for the gauge marker position, e.g. '62%'." },
+        "price_growth_note":     { "type": "string" },
+        "demand_note":           { "type": "string" }
+      }
+    },
+
+    "agent_listings": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 6,
+      "description": "Agent's own recent listings to feature on the closing page. Operator paste-in (not the PropertyData sample). Empty array aborts the run.",
+      "items": {
+        "type": "object",
+        "required": ["address", "price", "status", "slug"],
+        "properties": {
+          "url":     { "type": ["string", "null"], "description": "Source URL — listing card becomes an <a> when present." },
+          "address": { "type": "string" },
+          "price":   { "type": "integer" },
+          "beds":    { "type": ["integer", "null"] },
+          "type":    { "type": ["string", "null"] },
+          "image":   { "type": ["string", "null"], "description": "Path or URL to a tile photo for the card." },
+          "status":  { "type": "string", "description": "'Sold' | 'Under offer' | 'For sale'." },
+          "slug":    { "type": "string", "description": "Used to name the copied image file under img/." }
         }
       }
     }