@pdtf/schemas 3.6.0-2 → 3.6.0-20

package/.claude/settings.local.json

@@ -15,7 +15,6 @@
       "Bash(git commit:*)",
       "Bash(git push:*)",
       "Bash(git fetch:*)",
-      "Bash(git checkout:*)",
       "Bash(gh pr view:*)",
       "WebFetch(domain:github.com)",
       "Bash(tree:*)",
@@ -35,7 +34,23 @@
       "Bash(base64:*)",
       "Bash(gh issue view:*)",
       "Read(//Users/ed/.claude/**)",
-      "Bash(npm init:*)"
+      "Bash(npm init:*)",
+      "Bash(do echo \"=== printWidth $w ===\")",
+      "Bash(pdftoppm:*)",
+      "Bash(pdftotext:*)",
+      "Bash(/tmp/inspect2.js:*)",
+      "Bash(/tmp/inspect3.js:*)",
+      "Bash(/tmp/inspect4.js:*)",
+      "Bash(/tmp/inspect5.js:*)",
+      "Bash(/tmp/inspect6.js:*)",
+      "Bash(/tmp/final_inspect.js:*)",
+      "Bash(file:*)",
+      "Bash(gh pr create:*)",
+      "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(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

@@ -18,7 +18,7 @@ const cacheStats = {
   hits: 0,
   misses: 0,
   totalQueries: 0,
-  cacheStartTime: Date.now()
+  cacheStartTime: Date.now(),
 };
 
 const verifiedClaimsSchema = require("./src/schemas/verifiedClaims/pdtf-verified-claims.json");
@@ -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 = {
@@ -75,7 +80,9 @@ const overlaysMap = {
     baspiV4: require("./src/schemas/v3/overlays/baspi4.json"),
     baspiV5: require("./src/schemas/v3/overlays/baspi5.json"),
     ta6ed4: require("./src/schemas/v3/overlays/ta6.json"),
+    ta6ed6: require("./src/schemas/v3/overlays/ta6ed6.json"),
     ta7ed3: require("./src/schemas/v3/overlays/ta7.json"),
+    ta7ed5: require("./src/schemas/v3/overlays/ta7ed5.json"),
     ta10ed3: require("./src/schemas/v3/overlays/ta10.json"),
     lpe1ed4: require("./src/schemas/v3/overlays/lpe1.json"),
     fme1ed2: require("./src/schemas/v3/overlays/fme1.json"),
@@ -117,21 +124,27 @@ const arrayMerge = (target, source, options) => {
     // Detect if this is a required array by checking the parent key
     // Required arrays are property names (camelCase, no spaces)
     // Enum arrays are values (can contain spaces, capitals, etc.)
-    const isRequiredArray = target.every(
-      (item) =>
-        typeof item === "string" &&
-        item.length > 0 &&
-        // Required field names are typically camelCase without spaces
-        !item.includes(" ") &&
-        // First character is usually lowercase for field names
-        (item[0] === item[0].toLowerCase() || item.startsWith("is") || item.startsWith("has"))
-    ) && source.every(
-      (item) =>
-        typeof item === "string" &&
-        item.length > 0 &&
-        !item.includes(" ") &&
-        (item[0] === item[0].toLowerCase() || item.startsWith("is") || item.startsWith("has"))
-    );
+    const isRequiredArray =
+      target.every(
+        (item) =>
+          typeof item === "string" &&
+          item.length > 0 &&
+          // Required field names are typically camelCase without spaces
+          !item.includes(" ") &&
+          // First character is usually lowercase for field names
+          (item[0] === item[0].toLowerCase() ||
+            item.startsWith("is") ||
+            item.startsWith("has")),
+      ) &&
+      source.every(
+        (item) =>
+          typeof item === "string" &&
+          item.length > 0 &&
+          !item.includes(" ") &&
+          (item[0] === item[0].toLowerCase() ||
+            item.startsWith("is") ||
+            item.startsWith("has")),
+      );
 
     if (isRequiredArray) {
       // Combine required arrays
@@ -176,7 +189,7 @@ const arrayMerge = (target, source, options) => {
 
 const getTransactionSchema = (
   schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
-  overlays
+  overlays,
 ) => {
   const sourceSchema = transactionSchemas[schemaId];
   if (!overlays || overlays.length < 1) return sourceSchema;
@@ -184,7 +197,7 @@ const getTransactionSchema = (
   let mergedSchema = JSON.parse(JSON.stringify(sourceSchema)); // Deep copy
   overlays.forEach((overlay) => {
     const overlaySchema = JSON.parse(
-      JSON.stringify(overlaysMap[schemaId][overlay] || {})
+      JSON.stringify(overlaysMap[schemaId][overlay] || {}),
     ); // Deep copy
     mergedSchema = merge(mergedSchema, overlaySchema, { arrayMerge });
   });
@@ -211,7 +224,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
     const sourceSchema = getTransactionSchema(schemaId, overlays);
     const pathArray = path.split("/").slice(1);
     let subSchema = sourceSchema;
-    
+
     if (pathArray.length >= 1) {
       subSchema = pathArray.reduce((schema, pathElement) => {
         if (!schema) return undefined;
@@ -233,7 +246,10 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
               }
             } catch (e) {
               // Invalid regex pattern in schema - skip it
-              console.warn(`Invalid regex pattern in patternProperties: ${pattern}`, e);
+              console.warn(
+                `Invalid regex pattern in patternProperties: ${pattern}`,
+                e,
+              );
             }
           }
         }
@@ -246,6 +262,18 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
               matchingProperty = aOneOf.items;
             } else if (aOneOf.properties?.[pathElement]) {
               matchingProperty = aOneOf.properties?.[pathElement];
+            } else if (aOneOf.patternProperties) {
+              for (const pattern in aOneOf.patternProperties) {
+                try {
+                  const regex = new RegExp(pattern);
+                  if (regex.test(pathElement)) {
+                    matchingProperty = aOneOf.patternProperties[pattern];
+                    break;
+                  }
+                } catch (e) {
+                  // Invalid regex pattern - skip
+                }
+              }
             }
           });
           if (matchingProperty) return matchingProperty;
@@ -258,7 +286,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
     // Add schema to AJV and get validator
     // Only add valid schemas to AJV
     let validator;
-    if (subSchema && typeof subSchema === 'object') {
+    if (subSchema && typeof subSchema === "object") {
       // Check if schema already exists in AJV to avoid duplicates
       validator = ajv.getSchema(cacheKey);
       if (!validator) {
@@ -275,7 +303,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
       subSchema,
       validator,
       cacheKey,
-      createdAt: Date.now()
+      createdAt: Date.now(),
     };
     schemaCache.set(cacheKey, cached);
   } else {
@@ -341,13 +369,13 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   if (oneOfs) {
     // only single dependency discriminator, oneOf keyword is supported
     const matchingOneOf = oneOfs.find(
-      (oneOf) => oneOf["properties"][propertyName]
+      (oneOf) => oneOf["properties"][propertyName],
     );
     if (matchingOneOf)
       return getTitleAtPath(
         matchingOneOf["properties"][propertyName],
         subPath,
-        rootPath
+        rootPath,
       );
   }
 };
@@ -380,7 +408,7 @@ const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
         }
       } else {
         validationErrorsArr.push(
-          `Path ${path} is not a valid PDTF schema path`
+          `Path ${path} is not a valid PDTF schema path`,
         );
       }
     }
@@ -392,8 +420,11 @@ const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
 // Cache management functions
 const getCacheStats = () => {
   const runtime = Date.now() - cacheStats.cacheStartTime;
-  const hitRate = cacheStats.totalQueries > 0 ? (cacheStats.hits / cacheStats.totalQueries * 100) : 0;
-  
+  const hitRate =
+    cacheStats.totalQueries > 0
+      ? (cacheStats.hits / cacheStats.totalQueries) * 100
+      : 0;
+
   return {
     totalEntries: schemaCache.size,
     hits: cacheStats.hits,
@@ -405,8 +436,8 @@ const getCacheStats = () => {
     memoryUsage: {
       entriesCount: schemaCache.size,
       // Rough estimate of memory usage per entry
-      estimatedSizeKB: Math.round((schemaCache.size * 2) / 1024 * 100) / 100 // Rough estimate
-    }
+      estimatedSizeKB: Math.round(((schemaCache.size * 2) / 1024) * 100) / 100, // Rough estimate
+    },
   };
 };
 
@@ -416,15 +447,17 @@ const getDetailedCacheStats = () => {
     key,
     createdAt: value.createdAt,
     age: Date.now() - value.createdAt,
-    hasValidator: typeof value.validator === 'function',
-    hasSubSchema: value.subSchema !== undefined
+    hasValidator: typeof value.validator === "function",
+    hasSubSchema: value.subSchema !== undefined,
   }));
 
   return {
     ...baseStats,
     entries: entries.sort((a, b) => b.createdAt - a.createdAt), // Most recent first
-    oldestEntry: entries.length > 0 ? Math.max(...entries.map(e => e.age)) : 0,
-    newestEntry: entries.length > 0 ? Math.min(...entries.map(e => e.age)) : 0
+    oldestEntry:
+      entries.length > 0 ? Math.max(...entries.map((e) => e.age)) : 0,
+    newestEntry:
+      entries.length > 0 ? Math.min(...entries.map((e) => e.age)) : 0,
   };
 };
 
@@ -437,17 +470,17 @@ const clearSchemaCache = (pattern) => {
         keysToDelete.push(key);
       }
     });
-    keysToDelete.forEach(key => schemaCache.delete(key));
-    
+    keysToDelete.forEach((key) => schemaCache.delete(key));
+
     // Also remove matching schemas from AJV
-    keysToDelete.forEach(key => {
+    keysToDelete.forEach((key) => {
       try {
         ajv.removeSchema(key);
       } catch (e) {
         // Schema might not exist in AJV, ignore
       }
     });
-    
+
     return keysToDelete.length;
   } else {
     // Clear all cache
@@ -458,20 +491,24 @@ const clearSchemaCache = (pattern) => {
     cacheStats.misses = 0;
     cacheStats.totalQueries = 0;
     cacheStats.cacheStartTime = Date.now();
-    
+
     // Also clear AJV's internal cache to prevent duplicates
     ajv.removeSchema();
-    
+
     return entriesCleared;
   }
 };
 
-const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json", overlaysList = []) => {
+const warmupCache = (
+  paths,
+  schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+  overlaysList = [],
+) => {
   const warmupStats = {
     totalAttempted: 0,
     successful: 0,
     failed: 0,
-    errors: []
+    errors: [],
   };
 
   // Default common paths if none provided
@@ -483,7 +520,7 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
     "/propertyPack/valuations",
     "/propertyPack/waterAndDrainage",
     "/propertyPack/ownership",
-    "/propertyPack/notices"
+    "/propertyPack/notices",
   ];
 
   // Default common overlays if none provided
@@ -492,14 +529,15 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
     ["baspiV5"],
     ["ta6ed4"],
     ["nts2023"],
-    ["baspiV5", "ta6ed4"]
+    ["baspiV5", "ta6ed4"],
   ];
 
   const pathsToWarm = paths || defaultPaths;
-  const overlaysToWarm = overlaysList.length > 0 ? overlaysList : defaultOverlays;
+  const overlaysToWarm =
+    overlaysList.length > 0 ? overlaysList : defaultOverlays;
 
-  pathsToWarm.forEach(path => {
-    overlaysToWarm.forEach(overlays => {
+  pathsToWarm.forEach((path) => {
+    overlaysToWarm.forEach((overlays) => {
       warmupStats.totalAttempted++;
       try {
         // This will populate the cache
@@ -511,7 +549,7 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
         warmupStats.errors.push({
           path,
           overlays,
-          error: error.message
+          error: error.message,
         });
       }
     });
@@ -523,14 +561,14 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
 const pruneCacheByAge = (maxAgeMs) => {
   const now = Date.now();
   const keysToDelete = [];
-  
+
   schemaCache.forEach((value, key) => {
     if (now - value.createdAt > maxAgeMs) {
       keysToDelete.push(key);
     }
   });
-  
-  keysToDelete.forEach(key => {
+
+  keysToDelete.forEach((key) => {
     schemaCache.delete(key);
     try {
       ajv.removeSchema(key);
@@ -538,21 +576,22 @@ const pruneCacheByAge = (maxAgeMs) => {
       // Schema might not exist in AJV, ignore
     }
   });
-  
+
   return keysToDelete.length;
 };
 
 const setCacheMaxSize = (maxSize) => {
   if (schemaCache.size <= maxSize) return 0;
-  
+
   // Get entries sorted by creation time (oldest first)
-  const entries = Array.from(schemaCache.entries())
-    .sort((a, b) => a[1].createdAt - b[1].createdAt);
-  
+  const entries = Array.from(schemaCache.entries()).sort(
+    (a, b) => a[1].createdAt - b[1].createdAt,
+  );
+
   const toRemove = schemaCache.size - maxSize;
   const keysToDelete = entries.slice(0, toRemove).map(([key]) => key);
-  
-  keysToDelete.forEach(key => {
+
+  keysToDelete.forEach((key) => {
     schemaCache.delete(key);
     try {
       ajv.removeSchema(key);
@@ -560,7 +599,7 @@ const setCacheMaxSize = (maxSize) => {
       // Schema might not exist in AJV, ignore
     }
   });
-  
+
   return keysToDelete.length;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-2",
+  "version": "3.6.0-20",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {
@@ -8,7 +8,8 @@
   },
   "scripts": {
     "test": "jest",
-    "test:watch": "jest --watch"
+    "test:watch": "jest --watch",
+    "extract-overlays": "cd src/utils && node extractOverlay.js"
   },
   "repository": {
     "type": "git",