@pdtf/schemas 3.6.0-dev.14 → 3.6.0-dev.16

package/src/schemas/v3/skeleton.json

@@ -5,6 +5,11 @@
       "*": {}
     }
   },
+  "metadata": {
+    "*": {
+      "*": {}
+    }
+  },
   "status": "string",
   "participants": [
     {
@@ -82,6 +87,7 @@
         "attachments": "string",
         "companyName": "string",
         "companyNumber": "string",
+        "directorOrAuthorisedPerson": "string",
         "countryOfIncorporation": "string"
       },
       "dateBecameOwnerOrAuthority": "string"
@@ -162,7 +168,6 @@
         "hasLift": "string",
         "overCommercialPremises": {
           "isLocatedOverCommercialPremises": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         }
       },
@@ -981,7 +986,6 @@
               },
               "excessPaymentAnticipated": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "lastDemandPeriod": {
@@ -994,7 +998,6 @@
               },
               "reserveFund": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string",
                 "contributionIncludedInServiceCharge": "string",
                 "sufficentToCoverSection20Expenditure": {
@@ -1004,24 +1007,22 @@
               },
               "lastDecoratedPeriod": {
                 "externally": {
-                  "year": "integer",
+                  "year": {},
                   "from": "string",
                   "to": "string"
                 },
                 "internally": {
-                  "year": "integer",
+                  "year": {},
                   "from": "string",
                   "to": "string"
                 }
               },
               "section20WorksProposed": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "increaseInServiceChargeAnticipated": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "outstandingServiceChargeConsultation": {
@@ -1105,12 +1106,10 @@
               },
               "unresolvedDisputes": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "breachOfTermsOfLease": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               }
             },
@@ -1130,7 +1129,6 @@
             "alterations": {
               "sellerAwareOfAlterations": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string",
                 "landlordConsentObtained": {
                   "yesNo": "variant",
@@ -1265,7 +1263,6 @@
     "listingAndConservation": {
       "isListed": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1278,7 +1275,6 @@
         "yesNo": "variant",
         "workCarriedOut": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "consentsObtained": "string",
           "attachments": "string"
@@ -1288,13 +1284,11 @@
     "typeOfConstruction": {
       "isStandardForm": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "constructionType": "string",
         "details": "string"
       },
       "buildingSafety": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "workAlreadyDone": "string",
         "workToBeDone": "string",
@@ -1304,14 +1298,12 @@
       },
       "loft": {
         "loftAccess": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "loftBoarded": "string",
         "loftInsulated": "string"
       },
       "sprayFoamInsulation": {
         "hasSprayFoamInstalled": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1447,29 +1439,34 @@
     "disputesAndComplaints": {
       "hasDisputesAndComplaints": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "leadingToDisputesAndComplaints": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
     "alterationsAndChanges": {
       "hasStructuralAlterations": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
+        "alterationTypes": [
+          "string"
+        ],
         "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "approvalsObtained": "string",
+        "approvalsNotRequiredReason": "string",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
         "planningPermission": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1486,12 +1483,10 @@
       },
       "changeOfUse": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1518,12 +1513,10 @@
       },
       "windowReplacementsSince2002": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1569,12 +1562,10 @@
       },
       "hasAddedConservatory": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1715,20 +1706,17 @@
       },
       "worksUnfinished": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
       "planningPermissionBreaches": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "willingToInsure": "string",
         "attachments": "string"
       },
       "unresolvedPlanningIssues": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "willingToInsure": "string",
         "attachments": "string"
@@ -1762,7 +1750,6 @@
       },
       "partyWallAct": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1794,7 +1781,6 @@
       },
       "subsidenceOrStructuralFault": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -2427,7 +2413,6 @@
         "yearInstalled": "integer",
         "panelsOwnedOutright": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string",
           "associatedCost": {
@@ -2437,7 +2422,6 @@
         },
         "panelProviderLease": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string"
         },
@@ -2627,7 +2611,6 @@
     "heating": {
       "heatingSystem": {
         "heatingType": "variant",
-        "detailsAnalysis": {},
         "centralHeatingDetails": {
           "centralHeatingFuel": {
             "centralHeatingFuelType": "variant",
@@ -2658,6 +2641,18 @@
         },
         "details": "string"
       },
+      "mainHeatingTypes": [
+        "string"
+      ],
+      "mainHeatingTypesOtherDetails": "string",
+      "heatingInstalledDate": {},
+      "boilerInstalledDate": {},
+      "heatingSystemReplaced": "string",
+      "complianceCertificates": "string",
+      "inspectionReport": "string",
+      "inGoodWorkingOrder": "string",
+      "lastServicedYear": {},
+      "lastServicedReport": "string",
       "otherHeatingFeatures": [
         "string"
       ],
@@ -2734,22 +2729,18 @@
       "difficultiesObtainingInsurance": {
         "abnormalRiseInPremiums": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "subjectToHighExcesses": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "subjectToUnusualConditions": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "refused": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         }
       },
@@ -2759,7 +2750,6 @@
       "whoInsures": "string",
       "insuranceClaims": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -3184,23 +3174,19 @@
     "legalBoundaries": {
       "partOutsideLegalOwnership": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "partOnSeparateSiteOrDeed": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "boundariesDifferFromTitlePlan": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
       "boundaryAlterationProposal": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "ownership": {
@@ -3212,22 +3198,18 @@
           "front": "string"
         },
         "details": "string",
-        "attachments": "string",
-        "detailsAnalysis": {}
+        "attachments": "string"
       },
       "haveBoundaryFeaturesMoved": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "adjacentLandIncluded": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "flyingFreehold": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -3256,7 +3238,6 @@
       },
       "electricalWorkSince2005": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "yearWorkCarriedOut": "integer",
         "details": "string",
         "suppliedCertificate": {
@@ -3285,7 +3266,6 @@
       "hasValidGuaranteesOrWarranties": "variant",
       "newHomeWarranty": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3343,7 +3323,6 @@
       },
       "outstandingClaimsOrApplications": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3353,7 +3332,6 @@
       },
       "titleDefectInsurance": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       }

package/src/utils/extractOverlay.js

@@ -30,6 +30,7 @@ const extractFields = [
   "ntsl2",
   "ta6",
   "ta6ed6",
+  "ta6ed6v2",
   "ta7",
   "ta7ed5",
   "ta10",

package/src/utils/syncTa6ed6v2Markers.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+/**
+ * Sync ta6ed6v2 markers from ta6ed6 across combined.json.
+ *
+ * ta6ed6v2 is a "full marker set" twin of ta6ed6: every shared field carries its
+ * own `ta6ed6v2*` markers so that inclusion is presence and suppression is the
+ * ABSENCE of a v2 ref (see src/tests/v3/ta6ed6v2.test.js — the drift-lint).
+ *
+ * Two subtrees intentionally diverge (their v2 shape is hand-authored) and are
+ * excluded from sync: propertyPack.heating and propertyPack.alterationsAndChanges.
+ *
+ * For every OTHER node, this tool guarantees each `ta6ed6<Suffix>` marker has a
+ * matching `ta6ed6v2<Suffix>` marker of equal value — adding missing twins and
+ * repairing drifted values. Edits are minimal text splices that preserve the
+ * file's existing formatting.
+ *
+ *   node src/utils/syncTa6ed6v2Markers.js          # apply (write)
+ *   node src/utils/syncTa6ed6v2Markers.js --check   # exit 1 if out of sync (CI)
+ *
+ * After running, regenerate overlays: node src/utils/extractOverlay.js
+ */
+const fs = require("fs");
+const path = require("path");
+
+const FILE = process.env.COMBINED_PATH || path.resolve(__dirname, "../schemas/v3/combined.json");
+const CHECK = process.argv.includes("--check");
+
+const MARKER_RE = /^ta6ed6(Ref|Required|Title|Description|Enum|EnumNames)$/;
+const v2Of = (k) => k.replace(/^ta6ed6/, "ta6ed6v2");
+// NOTE: array indices are numbers in the tokenizer path (strict-equal), so use 2 not "2".
+const COMPANY = ["properties", "participants", "items", "oneOf", 2, "properties", "sellersCapacity", "oneOf", 2, "properties"];
+const EXCLUDED_PREFIXES = [
+  ["properties", "propertyPack", "properties", "heating"],
+  ["properties", "propertyPack", "properties", "alterationsAndChanges"],
+  // §1.6 company seller fields: v2 realigns refs to the form (companyNumber→1.6.1,
+  // directorOrAuthorisedPerson→1.6.2) while ed6 keeps its existing refs — hand-authored.
+  [...COMPANY, "companyName"],
+  [...COMPANY, "companyNumber"],
+  [...COMPANY, "directorOrAuthorisedPerson"],
+];
+const isExcluded = (p) => EXCLUDED_PREFIXES.some((pre) => pre.every((seg, i) => p[i] === seg));
+
+// minimal position-tracking JSON tokenizer
+function tokenize(text) {
+  let i = 0; const n = text.length; const members = [];
+  const ws = () => { while (i < n && /\s/.test(text[i])) i++; };
+  const str = () => { i++; while (i < n) { const c = text[i]; if (c === "\\") { i += 2; continue; } if (c === '"') { i++; break; } i++; } };
+  const val = (p) => { ws(); const c = text[i]; if (c === "{") obj(p); else if (c === "[") arr(p); else if (c === '"') str(); else { while (i < n && !/[,}\]\s]/.test(text[i])) i++; } };
+  function obj(p) { i++; ws(); if (text[i] === "}") { i++; return; } while (i < n) { ws(); const ks = i; str(); const key = JSON.parse(text.slice(ks, i)); ws(); i++; ws(); const vs = i; val(p.concat(key)); members.push({ path: p.concat(key), key, keyStart: ks, valueStart: vs, valueEnd: i }); ws(); if (text[i] === ",") { i++; continue; } if (text[i] === "}") { i++; break; } break; } }
+  function arr(p) { i++; ws(); if (text[i] === "]") { i++; return; } let k = 0; while (i < n) { ws(); val(p.concat(k)); k++; ws(); if (text[i] === ",") { i++; continue; } if (text[i] === "]") { i++; break; } break; } }
+  ws(); val([]); return members;
+}
+
+let text = fs.readFileSync(FILE, "utf8");
+const members = tokenize(text);
+const owner = (m) => m.path.slice(0, -1).join("/");
+const keysByOwner = new Map();
+for (const m of members) { const o = owner(m); if (!keysByOwner.has(o)) keysByOwner.set(o, new Map()); keysByOwner.get(o).set(m.key, m); }
+const indentAt = (off) => text.slice(text.lastIndexOf("\n", off - 1) + 1, off);
+
+const edits = []; // {at, end, text}  (end omitted => pure insert)
+const adds = [], fixes = [];
+for (const m of members) {
+  if (!MARKER_RE.test(m.key)) continue;
+  if (isExcluded(m.path)) continue;
+  const v2 = v2Of(m.key);
+  const siblings = keysByOwner.get(owner(m));
+  const ed6Val = text.slice(m.valueStart, m.valueEnd);
+  if (!siblings.has(v2)) {
+    const indent = indentAt(m.keyStart);
+    edits.push({ at: m.valueEnd, text: `,\n${indent}"${v2}": ${ed6Val}` });
+    adds.push("/" + m.path.join("/"));
+  } else {
+    const tw = siblings.get(v2);
+    const v2Val = text.slice(tw.valueStart, tw.valueEnd);
+    if (JSON.stringify(JSON.parse(v2Val)) !== JSON.stringify(JSON.parse(ed6Val))) {
+      edits.push({ at: tw.valueStart, end: tw.valueEnd, text: ed6Val });
+      fixes.push("/" + tw.path.join("/"));
+    }
+  }
+}
+
+if (!edits.length) { console.log("ta6ed6v2 markers in sync — nothing to do."); process.exit(0); }
+console.log(`Out of sync: ${adds.length} missing twin(s), ${fixes.length} drifted value(s).`);
+[...adds, ...fixes].slice(0, 20).forEach((p) => console.log("  " + p));
+if (CHECK) process.exit(1);
+
+edits.sort((a, b) => b.at - a.at);
+for (const e of edits) text = text.slice(0, e.at) + e.text + text.slice(e.end ?? e.at);
+JSON.parse(text); // guard
+fs.writeFileSync(FILE, text);
+console.log(`Applied ${edits.length} edit(s) to ${FILE}. Now run: node src/utils/extractOverlay.js`);