@pdtf/schemas 3.6.0-18 → 3.6.0-19

package/.claude/settings.local.json

@@ -49,7 +49,8 @@
       "Bash(claude --version)",
       "Bash(gh pr list --head ta6ed6 --json number,title,url)",
       "Bash(gh pr:*)",
-      "Bash(sort -t'.' -k1,1n -k2,2n -k3,3n -k4,4n)"
+      "Bash(sort -t'.' -k1,1n -k2,2n -k3,3n -k4,4n)",
+      "Bash(wc -l /Users/ed/Code/schemas/src/schemas/v3/combined.json /Users/ed/Code/schemas/src/schemas/v3/overlays/*.json)"
     ],
     "deny": []
   }

package/docs/sef25-extensions-ui-spec.md

@@ -0,0 +1,146 @@
+# SEF25 Extension Overlays — Front-End UI Spec
+
+## Overview
+
+Three new extension overlays add follow-up questions to existing form sections. Each overlay is loaded by passing its key to `getTransactionSchema(schemaId, overlays)`.
+
+| Overlay Key | Name | Section | Fields Added |
+|-------------|------|---------|-------------|
+| `sc` | Supply Costs | Water & Drainage | 2 cost fields (private water, private sewerage) |
+| `pc` | Parking Permit Cost | Parking | 1 frequency field |
+| `ph` | Property Hazards | Specialist Issues | 4 Yes/No + details fields |
+
+All fields use `sef25Ref` for reference codes.
+
+---
+
+## 1. Supply Costs (`sc`)
+
+### 1a. Private Water Cost
+
+**Trigger:** Show when `propertyPack.waterAndDrainage.water.mainsWater.yesNo` = `"No"`
+
+**Path:** `propertyPack.waterAndDrainage.water.mainsWater.associatedCost`
+
+**UI:** Render alongside the existing "How is water supplied?" details field.
+
+| Field | Path (relative) | Type | Validation | UI Element |
+|-------|-----------------|------|------------|------------|
+| Cost (£) | `associatedCost.amount` | `number` | Required | Numeric input |
+| Payment frequency | `associatedCost.frequency` | `string` | Required, enum | Dropdown |
+
+**Frequency enum values:** `"Per month"`, `"Per year"`
+
+**Ref:** `U1.1` (amount: `U1.1.1`, frequency: `U1.1.2`)
+
+### 1b. Private Sewerage Cost
+
+**Trigger:** Show when `propertyPack.waterAndDrainage.drainage.mainsFoulDrainage.yesNo` = `"No"` or `"Not known"`
+
+**Path:** `propertyPack.waterAndDrainage.drainage.mainsFoulDrainage.associatedCost`
+
+**UI:** Render alongside the existing off-mains drainage system questions.
+
+| Field | Path (relative) | Type | Validation | UI Element |
+|-------|-----------------|------|------------|------------|
+| Cost (£) | `associatedCost.amount` | `number` | Required | Numeric input |
+| Payment frequency | `associatedCost.frequency` | `string` | Required, enum | Dropdown |
+
+**Frequency enum values:** `"Per month"`, `"Per year"`
+
+**Ref:** `U1.2` (amount: `U1.2.1`, frequency: `U1.2.2`)
+
+---
+
+## 2. Parking Permit Cost (`pc`)
+
+**Trigger:** Show when `propertyPack.parking.controlledParking.yesNo` = `"Yes"`
+
+**Path:** `propertyPack.parking.controlledParking.costOfPermitFrequency`
+
+**UI:** Render alongside the existing cost of permit field (previously titled "Annual cost of permit (£)", now retitled to "Cost of permit (£)"). The frequency dropdown clarifies whether the cost amount is monthly or annual.
+
+| Field | Path (relative) | Type | Validation | UI Element |
+|-------|-----------------|------|------------|------------|
+| Payment frequency | `costOfPermitFrequency` | `string` | Enum | Dropdown |
+
+**Frequency enum values:** `"Per month"`, `"Per year"`
+
+**Note:** The existing `annualCostOfPermit` numeric field remains unchanged. The new frequency field sits beside it to indicate whether the entered amount is per month or per year.
+
+**Ref:** `P1.1`
+
+---
+
+## 3. Property Hazards (`ph`)
+
+**Trigger:** Always shown (no conditional trigger — these are standalone questions within Specialist Issues).
+
+**Path prefix:** `propertyPack.specialistIssues`
+
+All 4 fields follow the same pattern:
+
+- **Initial question:** Yes/No radio/toggle
+- **If "Yes":** Show a required free-text "Give details" field
+
+### Fields
+
+| Property | Title | sef25Ref |
+|----------|-------|----------|
+| `wellsDitchesShaft` | Are there any wells, ditches, or shafts at the property? | H1.1 |
+| `damagedOrExposedElectrics` | Are there any damaged or exposed electrics at the property? | H1.2 |
+| `damageToFlooringOrStaircases` | Is there any damage to flooring and/or staircases? | H1.3 |
+| `knownAreasInPoorCondition` | Are there any known areas in poor condition (internal or external)? | H1.4 |
+
+### Data shape per field
+
+```json
+// When "No":
+{ "yesNo": "No" }
+
+// When "Yes":
+{ "yesNo": "Yes", "details": "Free text description..." }
+```
+
+### Validation
+
+- `yesNo` is required (enum: `["Yes", "No"]`)
+- When `yesNo` = `"Yes"`, `details` is required (string, minLength: 1)
+- When `yesNo` = `"No"`, `details` should not be shown or submitted
+
+### UI pattern
+
+These follow the identical pattern to existing specialist issues (dry rot, asbestos, subsidence, health & safety). Render them the same way — group them under "Hazards and Known Issues" within the Specialist Issues section.
+
+---
+
+## Loading the Extensions
+
+```js
+import { getTransactionSchema, getValidator } from "@pdtf/schemas";
+
+const schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json";
+
+// Load with one or more SEF25 extensions
+const schema = getTransactionSchema(schemaId, ["sc", "pc", "ph"]);
+
+// Or combine with other overlays
+const schema = getTransactionSchema(schemaId, ["baspiV5", "sc", "pc", "ph"]);
+
+// Validate data against the merged schema
+const validator = getValidator(schemaId, ["sc", "pc", "ph"]);
+```
+
+---
+
+## Summary of Trigger Conditions
+
+| Field | Visible when... |
+|-------|----------------|
+| Water cost | `mainsWater.yesNo` = `"No"` |
+| Sewerage cost | `mainsFoulDrainage.yesNo` = `"No"` or `"Not known"` |
+| Parking permit frequency | `controlledParking.yesNo` = `"Yes"` |
+| Wells/ditches/shaft | Always (within Specialist Issues) |
+| Damaged electrics | Always (within Specialist Issues) |
+| Flooring/staircase damage | Always (within Specialist Issues) |
+| Areas in poor condition | Always (within Specialist Issues) |

package/index.js

@@ -52,6 +52,11 @@ const extensionOverlays = {
 
   // Transaction Extensions
   oc: require("./src/schemas/v3/overlays/extensions/oc.json"),
+
+  // SEF25 Extensions
+  sc: require("./src/schemas/v3/overlays/extensions/sc.json"),
+  pc: require("./src/schemas/v3/overlays/extensions/pc.json"),
+  ph: require("./src/schemas/v3/overlays/extensions/ph.json"),
 };
 
 const overlaysMap = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-18",
+  "version": "3.6.0-19",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/schemas/v3/combined.json

@@ -10362,8 +10362,14 @@
                     },
                     "annualCostOfPermit": {
                       "baspi5Ref": "A1.6.0.2.2",
-                      "title": "Annual cost of permit (£)",
+                      "title": "Cost of permit (£)",
                       "type": "number"
+                    },
+                    "costOfPermitFrequency": {
+                      "sef25Ref": "P1.1",
+                      "title": "Payment frequency",
+                      "type": "string",
+                      "enum": ["Per month", "Per year"]
                     }
                   },
                   "baspi5Required": ["annualCostOfPermit"]
@@ -16008,6 +16014,166 @@
                   "ntsl2Required": ["details"]
                 }
               ]
+            },
+            "wellsDitchesShaft": {
+              "sef25Ref": "H1.1",
+              "title": "Are there any wells, ditches, or shafts at the property?",
+              "type": "object",
+              "sef25Required": ["yesNo"],
+              "properties": {
+                "yesNo": {
+                  "sef25Ref": "H1.1.1",
+                  "type": "string",
+                  "title": "",
+                  "enum": ["Yes", "No"]
+                }
+              },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
+              "oneOf": [
+                {
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["No"]
+                    }
+                  }
+                },
+                {
+                  "sef25Required": ["details"],
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["Yes"]
+                    },
+                    "details": {
+                      "sef25Ref": "H1.1.2",
+                      "title": "Give details",
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              ]
+            },
+            "damagedOrExposedElectrics": {
+              "sef25Ref": "H1.2",
+              "title": "Are there any damaged or exposed electrics at the property?",
+              "type": "object",
+              "sef25Required": ["yesNo"],
+              "properties": {
+                "yesNo": {
+                  "sef25Ref": "H1.2.1",
+                  "type": "string",
+                  "title": "",
+                  "enum": ["Yes", "No"]
+                }
+              },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
+              "oneOf": [
+                {
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["No"]
+                    }
+                  }
+                },
+                {
+                  "sef25Required": ["details"],
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["Yes"]
+                    },
+                    "details": {
+                      "sef25Ref": "H1.2.2",
+                      "title": "Give details",
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              ]
+            },
+            "damageToFlooringOrStaircases": {
+              "sef25Ref": "H1.3",
+              "title": "Is there any damage to flooring and/or staircases?",
+              "type": "object",
+              "sef25Required": ["yesNo"],
+              "properties": {
+                "yesNo": {
+                  "sef25Ref": "H1.3.1",
+                  "type": "string",
+                  "title": "",
+                  "enum": ["Yes", "No"]
+                }
+              },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
+              "oneOf": [
+                {
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["No"]
+                    }
+                  }
+                },
+                {
+                  "sef25Required": ["details"],
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["Yes"]
+                    },
+                    "details": {
+                      "sef25Ref": "H1.3.2",
+                      "title": "Give details",
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              ]
+            },
+            "knownAreasInPoorCondition": {
+              "sef25Ref": "H1.4",
+              "title": "Are there any known areas in poor condition (internal or external)?",
+              "type": "object",
+              "sef25Required": ["yesNo"],
+              "properties": {
+                "yesNo": {
+                  "sef25Ref": "H1.4.1",
+                  "type": "string",
+                  "title": "",
+                  "enum": ["Yes", "No"]
+                }
+              },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
+              "oneOf": [
+                {
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["No"]
+                    }
+                  }
+                },
+                {
+                  "sef25Required": ["details"],
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["Yes"]
+                    },
+                    "details": {
+                      "sef25Ref": "H1.4.2",
+                      "title": "Give details",
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              ]
             }
           }
         },
@@ -22143,6 +22309,25 @@
                           "description": "e.g. Private well, borehole, springs etc.",
                           "type": "string",
                           "minLength": 1
+                        },
+                        "associatedCost": {
+                          "sef25Ref": "U1.1",
+                          "title": "Associated costs for water",
+                          "type": "object",
+                          "sef25Required": ["amount", "frequency"],
+                          "properties": {
+                            "amount": {
+                              "sef25Ref": "U1.1.1",
+                              "title": "Cost (£)",
+                              "type": "number"
+                            },
+                            "frequency": {
+                              "sef25Ref": "U1.1.2",
+                              "title": "Payment frequency",
+                              "type": "string",
+                              "enum": ["Per month", "Per year"]
+                            }
+                          }
                         }
                       },
                       "ntsRequired": ["details"],
@@ -23156,6 +23341,25 @@
                               "ntsl2Required": ["details"]
                             }
                           ]
+                        },
+                        "associatedCost": {
+                          "sef25Ref": "U1.2",
+                          "title": "Associated costs for sewerage",
+                          "type": "object",
+                          "sef25Required": ["amount", "frequency"],
+                          "properties": {
+                            "amount": {
+                              "sef25Ref": "U1.2.1",
+                              "title": "Cost (£)",
+                              "type": "number"
+                            },
+                            "frequency": {
+                              "sef25Ref": "U1.2.2",
+                              "title": "Payment frequency",
+                              "type": "string",
+                              "enum": ["Per month", "Per year"]
+                            }
+                          }
                         }
                       },
                       "ntsRequired": ["offMainsDrainageSystem"],

package/src/schemas/v3/compactSkeleton.txt

@@ -951,6 +951,7 @@
       controlledParking
         yesNo
         annualCostOfPermit
+        costOfPermitFrequency
       vehicleTypeRestriction
         yesNo
         details
@@ -1390,6 +1391,18 @@
         yesNo
         details
         attachments
+      wellsDitchesShaft
+        yesNo
+        details
+      damagedOrExposedElectrics
+        yesNo
+        details
+      damageToFlooringOrStaircases
+        yesNo
+        details
+      knownAreasInPoorCondition
+        yesNo
+        details
     fixturesAndFittings
       itemsToRemove
         yesNo
@@ -1910,6 +1923,9 @@
         mainsWater
           yesNo
           details
+          associatedCost
+            amount
+            frequency
           supplier
           stopcock
             location
@@ -1965,6 +1981,9 @@
             dateLastServiced
             attachments
             details
+          associatedCost
+            amount
+            frequency
         surfaceDrainageCharge
           yesNo
           details

package/src/schemas/v3/overlays/extensions/jk.json

@@ -33,6 +33,9 @@
                   "required": [
                     "managementPlanInPlace"
                   ],
+                  "discriminator": {
+                    "propertyName": "managementPlanInPlace"
+                  },
                   "properties": {
                     "managementPlanInPlace": {
                       "ntsRef": "A5.3.2",
@@ -47,14 +50,29 @@
                       "enum": [
                         "Yes"
                       ]
+                    }
+                  },
+                  "oneOf": [
+                    {
+                      "properties": {
+                        "managementPlanInPlace": {
+                          "enum": [
+                            "No",
+                            "Not known"
+                          ]
+                        }
+                      }
                     },
-                    "attachments": {
-                      "enum": [
-                        "Attached",
-                        "To follow"
-                      ]
+                    {
+                      "properties": {
+                        "managementPlanInPlace": {
+                          "enum": [
+                            "Yes"
+                          ]
+                        }
+                      }
                     }
-                  }
+                  ]
                 }
               ],
               "type": "object"

package/src/schemas/v3/overlays/extensions/pc.json

@@ -0,0 +1,28 @@
+{
+  "properties": {
+    "propertyPack": {
+      "properties": {
+        "parking": {
+          "properties": {
+            "controlledParking": {
+              "oneOf": [
+                null,
+                {
+                  "properties": {
+                    "costOfPermitFrequency": {
+                      "sef25Ref": "P1.1",
+                      "type": "string"
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/pc.json",
+  "$comment": "Parking permit cost and frequency"
+}