@pdtf/schemas 3.6.0-13 → 3.6.0-14

package/package.json

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

package/src/schemas/v3/combined.json

@@ -10481,7 +10481,7 @@
                             },
                             "details": {
                               "ta6ed6Ref": "10.3b2",
-                              "description": "Specify any relevant local authority licence or terms and conditions",
+                              "title": "Specify any relevant local authority licence or terms and conditions",
                               "type": "string",
                               "minLength": 1
                             }
@@ -10490,7 +10490,8 @@
                         }
                       ]
                     }
-                  }
+                  },
+                  "ta6ed6Required": ["chargerDetails", "cableCrossesPavement"]
                 }
               ]
             },
@@ -21156,7 +21157,7 @@
                           "title": "Meter Point Administration Number (MPAN)",
                           "description": "Your MPAN is on your electricity or dual fuel bill, usually in a box marked 'Supply Number'. It's 21 digits long and begins with 'S'. You'll only need the last 12 or 13 digits.",
                           "ta6ed6Description": "Your MPAN is on your electricity or dual fuel bill, usually in a box marked 'Supply Number'. It's 21 digits long and begins with 'S'. You'll only need the last 12 or 13 digits.",
-                          "type": "integer"
+                          "type": "string"
                         }
                       }
                     }
@@ -23809,7 +23810,7 @@
                                       "ta6ed6Ref": "12.2.4",
                                       "title": "Meter Point Reference Number (MPRN)",
                                       "description": "You can find your property's MPRN on your gas or dual fuel bill. It's usually marked 'Meter Point Reference Number' and is between six and 10 digits long.",
-                                      "type": "integer"
+                                      "type": "string"
                                     }
                                   },
                                   "baspi4Required": ["location"],
@@ -25232,6 +25233,7 @@
                               "enum": ["Yes"]
                             },
                             "details": {
+                              "title": "Provide details",
                               "ta6ed6Ref": "9.3.2",
                               "type": "string",
                               "minLength": 1
@@ -29220,7 +29222,7 @@
                     },
                     "suppliedCertificate": {
                       "title": "Please supply one of the following:",
-                      "ta6ed6Title": "Please supply any certificates for electrical installtion work",
+                      "ta6ed6Title": "Please supply any certificates for electrical installation work",
                       "type": "object",
                       "baspi4Ref": "B4.2.4.1",
                       "baspi5Ref": "B4.2.4.1",
@@ -30908,10 +30910,6 @@
                   "type": "string",
                   "title": "",
                   "enum": ["Yes", "No"]
-                },
-                "details": {
-                  "ta6ed6Ref": "13.2.2",
-                  "type": "string"
                 }
               },
               "baspi4Required": ["yesNo"],
@@ -30935,9 +30933,11 @@
                       "enum": ["Yes"]
                     },
                     "details": {
+                      "title": "Please provide details",
                       "baspi4Ref": "B7.3.2",
                       "baspi5Ref": "B7.3.2",
                       "ta6Ref": "14.2.2",
+                      "ta6ed6Ref": "13.2.2",
                       "type": "string"
                     }
                   },

package/src/schemas/v3/compactSkeleton.txt

@@ -827,6 +827,9 @@
               riskAssessments
                 assessmentsCarriedOut
                 urgentWorksRecommended
+                urgentWorksCarriedOut
+                outstandingEnforcementAction
+                dateRemedialActionRequired
             standardTermsAvailable
               yesNo
               details
@@ -1378,6 +1381,7 @@
           attachments
         yesNo
         managementPlanInPlace
+        attachments
       subsidenceOrStructuralFault
         yesNo
         details

package/src/schemas/v3/overlays/ta6ed6.json

@@ -258,7 +258,11 @@
                         }
                       }
                     }
-                  }
+                  },
+                  "required": [
+                    "chargerDetails",
+                    "cableCrossesPavement"
+                  ]
                 }
               ],
               "required": [
@@ -5553,7 +5557,7 @@
                       "required": [
                         "attachments"
                       ],
-                      "title": "Please supply any certificates for electrical installtion work",
+                      "title": "Please supply any certificates for electrical installation work",
                       "properties": {
                         "attachments": {
                           "ta6ed6Ref": "11.2"
@@ -6334,6 +6338,9 @@
                       "enum": [
                         "Yes"
                       ]
+                    },
+                    "details": {
+                      "ta6ed6Ref": "13.2.2"
                     }
                   },
                   "required": [
@@ -6347,9 +6354,6 @@
               "properties": {
                 "yesNo": {
                   "ta6ed6Ref": "13.2.1"
-                },
-                "details": {
-                  "ta6ed6Ref": "13.2.2"
                 }
               }
             },

package/src/schemas/v3/pdtf-transaction.json

@@ -8460,7 +8460,7 @@
                               ]
                             },
                             "details": {
-                              "description": "Specify any relevant local authority licence or terms and conditions",
+                              "title": "Specify any relevant local authority licence or terms and conditions",
                               "type": "string",
                               "minLength": 1
                             }
@@ -17694,7 +17694,7 @@
                         "mpan": {
                           "title": "Meter Point Administration Number (MPAN)",
                           "description": "Your MPAN is on your electricity or dual fuel bill, usually in a box marked 'Supply Number'. It's 21 digits long and begins with 'S'. You'll only need the last 12 or 13 digits.",
-                          "type": "integer"
+                          "type": "string"
                         }
                       }
                     }
@@ -19504,7 +19504,7 @@
                                     "mprn": {
                                       "title": "Meter Point Reference Number (MPRN)",
                                       "description": "You can find your property's MPRN on your gas or dual fuel bill. It's usually marked 'Meter Point Reference Number' and is between six and 10 digits long.",
-                                      "type": "integer"
+                                      "type": "string"
                                     }
                                   }
                                 }
@@ -20462,6 +20462,7 @@
                               ]
                             },
                             "details": {
+                              "title": "Provide details",
                               "type": "string",
                               "minLength": 1
                             }
@@ -24745,9 +24746,6 @@
                     "Yes",
                     "No"
                   ]
-                },
-                "details": {
-                  "type": "string"
                 }
               },
               "oneOf": [
@@ -24768,6 +24766,7 @@
                       ]
                     },
                     "details": {
+                      "title": "Please provide details",
                       "type": "string"
                     }
                   }

package/src/schemas/v3/skeleton.json

@@ -1,7 +1,9 @@
 {
   "transactionId": "string",
   "externalIds": {
-    "*": {}
+    "*": {
+      "*": {}
+    }
   },
   "status": "string",
   "participants": [
@@ -33,7 +35,9 @@
       "organisationReference": "string",
       "role": "variant",
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "participantStatus": "string",
       "verification": {
@@ -1053,7 +1057,10 @@
                 "yesNo": "variant",
                 "riskAssessments": {
                   "assessmentsCarriedOut": "variant",
-                  "urgentWorksRecommended": "string"
+                  "urgentWorksRecommended": "variant",
+                  "urgentWorksCarriedOut": "string",
+                  "outstandingEnforcementAction": "variant",
+                  "dateRemedialActionRequired": "string"
                 }
               },
               "standardTermsAvailable": {
@@ -1740,7 +1747,8 @@
           "attachments": "string"
         },
         "yesNo": "variant",
-        "managementPlanInPlace": "string"
+        "managementPlanInPlace": "variant",
+        "attachments": "string"
       },
       "subsidenceOrStructuralFault": {
         "yesNo": "variant",
@@ -2349,7 +2357,7 @@
         "electricityMeter": {
           "location": "string",
           "attachments": "string",
-          "mpan": "integer"
+          "mpan": "string"
         },
         "dateToBeConnected": "string"
       },
@@ -2551,7 +2559,7 @@
             "gasMeter": {
               "location": "string",
               "attachments": "string",
-              "mprn": "integer"
+              "mprn": "string"
             },
             "otherCentralHeatingFuelType": "string"
           },
@@ -3323,7 +3331,9 @@
           "name": "string",
           "signedOn": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           }
         }
       ]
@@ -4632,7 +4642,9 @@
         "mimeType": "string",
         "documentType": "string",
         "externalIds": {
-          "*": {}
+          "*": {
+            "*": {}
+          }
         },
         "isDeleted": "boolean",
         "summary": {}
@@ -5494,7 +5506,9 @@
           "name": "string",
           "url": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           },
           "requiredSignatories": [
             {
@@ -5510,7 +5524,9 @@
           "name": "string",
           "signedOn": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           }
         }
       ]
@@ -5521,7 +5537,9 @@
       {
         "transactionId": "string",
         "externalIds": {
-          "*": {}
+          "*": {
+            "*": {}
+          }
         },
         "address": {
           "buildingNumber": "string",
@@ -5586,7 +5604,9 @@
         "string"
       ],
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "buyerCircumstances": {
         "intendedUse": "string",
@@ -5633,7 +5653,9 @@
         }
       },
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "resolutionCondition": "string"
     }

package/src/tests/v3/ta6ed6.test.js

@@ -203,14 +203,18 @@ describe("TA6 Edition 6 overlay", () => {
       expect(parkingValidator(data)).toBe(true);
     });
 
-    test("electricVehicleChargingPoint Yes without additional details is valid", () => {
-      // The ta6ed6 overlay does not require chargerDetails etc. in the Yes branch
+    test("electricVehicleChargingPoint Yes without additional details is invalid", () => {
       const data = {
         parkingArrangements: ["Driveway"],
         controlledParking: { yesNo: "No" },
         electricVehicleChargingPoint: { yesNo: "Yes" },
       };
-      expect(parkingValidator(data)).toBe(true);
+      expect(parkingValidator(data)).toBe(false);
+      expect(
+        parkingValidator.errors.some((e) =>
+          e.message.includes("'chargerDetails'")
+        )
+      ).toBe(true);
     });
 
     test("electricVehicleChargingPoint Yes with all required details is valid", () => {
@@ -1626,7 +1630,7 @@ describe("TA6 Edition 6 overlay", () => {
         mainsElectricity: {
           yesNo: "Yes",
           supplier: "British Gas",
-          electricityMeter: { location: "Hall cupboard", mpan: 1234567890123 },
+          electricityMeter: { location: "Hall cupboard", mpan: "1234567890123" },
         },
         solarPanels: { yesNo: "No" },
       };
@@ -1638,7 +1642,7 @@ describe("TA6 Edition 6 overlay", () => {
         mainsElectricity: {
           yesNo: "Yes",
           supplier: "British Gas",
-          electricityMeter: { location: "Hall cupboard", mpan: 1234567890123 },
+          electricityMeter: { location: "Hall cupboard", mpan: "1234567890123" },
         },
         solarPanels: { yesNo: "Yes" },
       };
@@ -1655,7 +1659,7 @@ describe("TA6 Edition 6 overlay", () => {
         mainsElectricity: {
           yesNo: "Yes",
           supplier: "British Gas",
-          electricityMeter: { location: "Hall cupboard", mpan: 1234567890123 },
+          electricityMeter: { location: "Hall cupboard", mpan: "1234567890123" },
         },
         solarPanels: {
           yesNo: "Yes",
@@ -1677,7 +1681,7 @@ describe("TA6 Edition 6 overlay", () => {
         mainsElectricity: {
           yesNo: "Yes",
           supplier: "British Gas",
-          electricityMeter: { location: "Hall cupboard", mpan: 1234567890123 },
+          electricityMeter: { location: "Hall cupboard", mpan: "1234567890123" },
         },
         solarPanels: {
           yesNo: "Yes",

package/src/utils/extractOverlay.js

@@ -85,23 +85,21 @@ const flattenSkeleton = (schema) => {
     });
   }
 
-  // Handle oneOf - merge all possible properties
+  // Handle oneOf - merge all possible properties (recursively handles nested oneOf)
   if (schema.oneOf) {
     schema.oneOf.forEach((aOneOf) => {
-      if (aOneOf.properties) {
-        Object.entries(aOneOf.properties).forEach(([key, value]) => {
-          // If property already exists and differs, mark as variant
-          const newValue = flattenSkeleton(value);
-          if (returnStructure[key] && JSON.stringify(returnStructure[key]) !== JSON.stringify(newValue)) {
-            // For primitive types, just mark as variant type
-            if (typeof returnStructure[key] === "string" || typeof newValue === "string") {
+      const variantResult = flattenSkeleton(aOneOf);
+      if (variantResult && typeof variantResult === "object" && !Array.isArray(variantResult)) {
+        Object.entries(variantResult).forEach(([key, value]) => {
+          if (key === "_variants") return;
+          if (returnStructure[key] && JSON.stringify(returnStructure[key]) !== JSON.stringify(value)) {
+            if (typeof returnStructure[key] === "string" || typeof value === "string") {
               returnStructure[key] = "variant";
             } else {
-              // For complex types, merge properties
-              returnStructure[key] = { ...returnStructure[key], ...newValue, _variants: true };
+              returnStructure[key] = { ...returnStructure[key], ...value, _variants: true };
             }
           } else {
-            returnStructure[key] = newValue;
+            returnStructure[key] = value;
           }
         });
       }
@@ -333,8 +331,8 @@ const toCompact = (obj, indent = "") => {
     // Check if this is a keyed object (has "*" key)
     if (keys.length === 1 && keys[0] === "*") {
       const inner = toCompact(obj["*"], indent);
-      if (inner === "") {
-        return "{*}"; // Keyed object of primitives
+      if (inner === "" || inner === "{*}") {
+        return "{*}"; // Keyed object of primitives (or nested keyed objects with no structure)
       }
       return `{*}\n${inner}`;
     }