@pdtf/schemas 3.6.0-dev.1 → 3.6.0-dev.11

package/src/schemas/v3/skeleton.json

@@ -109,6 +109,11 @@
         "easting": "number",
         "northing": "number"
       },
+      "ruralUrbanClassification": "string",
+      "ruralUrbanCode": "string",
+      "region": "string",
+      "parish": "string",
+      "outputArea": "string",
       "googleStreetViewPOV": {
         "heading": "number",
         "pitch": "number",
@@ -157,6 +162,7 @@
         "hasLift": "string",
         "overCommercialPremises": {
           "isLocatedOverCommercialPremises": "variant",
+          "detailsAnalysis": {},
           "details": "string"
         }
       },
@@ -975,6 +981,7 @@
               },
               "excessPaymentAnticipated": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string"
               },
               "lastDemandPeriod": {
@@ -987,6 +994,7 @@
               },
               "reserveFund": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string",
                 "contributionIncludedInServiceCharge": "string",
                 "sufficentToCoverSection20Expenditure": {
@@ -1008,10 +1016,12 @@
               },
               "section20WorksProposed": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string"
               },
               "increaseInServiceChargeAnticipated": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string"
               },
               "outstandingServiceChargeConsultation": {
@@ -1095,10 +1105,12 @@
               },
               "unresolvedDisputes": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string"
               },
               "breachOfTermsOfLease": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string"
               }
             },
@@ -1118,6 +1130,7 @@
             "alterations": {
               "sellerAwareOfAlterations": {
                 "yesNo": "variant",
+                "detailsAnalysis": {},
                 "details": "string",
                 "landlordConsentObtained": {
                   "yesNo": "variant",
@@ -1252,6 +1265,7 @@
     "listingAndConservation": {
       "isListed": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1264,6 +1278,7 @@
         "yesNo": "variant",
         "workCarriedOut": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "details": "string",
           "consentsObtained": "string",
           "attachments": "string"
@@ -1273,11 +1288,13 @@
     "typeOfConstruction": {
       "isStandardForm": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "constructionType": "string",
         "details": "string"
       },
       "buildingSafety": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "workAlreadyDone": "string",
         "workToBeDone": "string",
@@ -1287,12 +1304,14 @@
       },
       "loft": {
         "loftAccess": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "loftBoarded": "string",
         "loftInsulated": "string"
       },
       "sprayFoamInsulation": {
         "hasSprayFoamInstalled": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1428,24 +1447,29 @@
     "disputesAndComplaints": {
       "hasDisputesAndComplaints": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       },
       "leadingToDisputesAndComplaints": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       }
     },
     "alterationsAndChanges": {
       "hasStructuralAlterations": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "buildingRegApproval": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
         "planningPermission": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1462,10 +1486,12 @@
       },
       "changeOfUse": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1492,10 +1518,12 @@
       },
       "windowReplacementsSince2002": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1541,10 +1569,12 @@
       },
       "hasAddedConservatory": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1685,17 +1715,20 @@
       },
       "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"
@@ -1729,6 +1762,7 @@
       },
       "partyWallAct": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1760,6 +1794,7 @@
       },
       "subsidenceOrStructuralFault": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -2392,6 +2427,7 @@
         "yearInstalled": "integer",
         "panelsOwnedOutright": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string",
           "associatedCost": {
@@ -2401,6 +2437,7 @@
         },
         "panelProviderLease": {
           "yesNo": "variant",
+          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string"
         },
@@ -2589,6 +2626,7 @@
     "heating": {
       "heatingSystem": {
         "heatingType": "variant",
+        "detailsAnalysis": {},
         "centralHeatingDetails": {
           "centralHeatingFuel": {
             "centralHeatingFuelType": "variant",
@@ -2695,18 +2733,22 @@
       "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"
         }
       },
@@ -2716,6 +2758,7 @@
       "whoInsures": "string",
       "insuranceClaims": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -3140,23 +3183,27 @@
     "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": {
-        "areBoundariesUniform": "variant",
+        "areBoundariesUniform": "string",
         "uniformBoundaries": {
           "left": "string",
           "right": "string",
@@ -3164,18 +3211,22 @@
           "front": "string"
         },
         "details": "string",
-        "attachments": "string"
+        "attachments": "string",
+        "detailsAnalysis": {}
       },
       "haveBoundaryFeaturesMoved": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       },
       "adjacentLandIncluded": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       },
       "flyingFreehold": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -3204,6 +3255,7 @@
       },
       "electricalWorkSince2005": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "yearWorkCarriedOut": "integer",
         "details": "string",
         "suppliedCertificate": {
@@ -3232,6 +3284,7 @@
       "hasValidGuaranteesOrWarranties": "variant",
       "newHomeWarranty": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3289,6 +3342,7 @@
       },
       "outstandingClaimsOrApplications": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3298,6 +3352,7 @@
       },
       "titleDefectInsurance": {
         "yesNo": "variant",
+        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       }
@@ -4654,9 +4709,18 @@
             "documentTypeCode": "string",
             "documentDate": "string",
             "retrievedOn": "string",
-            "filedUnder": "string"
+            "filedUnder": "string",
+            "summary": {},
+            "availability": "string",
+            "availabilityCode": "string",
+            "entryNumbers": [
+              "string"
+            ],
+            "backdated": "boolean"
           }
-        ]
+        ],
+        "keyFacts": {},
+        "covenantAnalysis": {}
       }
     ],
     "searches": [
@@ -5688,7 +5752,8 @@
           "datetime": "string",
           "originatorRole": "string",
           "destinationRole": "string",
-          "messageText": "string"
+          "messageText": "string",
+          "pdtfPath": "string"
         }
       },
       "externalIds": {

package/src/utils/extractExtensionOverlays.js

@@ -274,7 +274,7 @@ const extensionMappings = {
     description: "Insurance claims upfront for SEF25",
     refType: "sef25Ref",
     paths: [
-      "/properties/propertyPack/properties/insurance/oneOf/1/properties/insuranceClaims",
+      "/properties/propertyPack/properties/insurance",
     ],
   },
 
@@ -575,7 +575,16 @@ function addIntermediateRefs(overlay, schema, refConfig) {
       const schemaPath = "/" + this.path.join("/");
       try {
         const schemaNode = jp.get(schema, schemaPath);
-        if (schemaNode && schemaNode[refConfig.ref]) {
+        if (!schemaNode) return;
+        // When the output key differs from the source key (e.g. sef25Ref -> ntsRef),
+        // prefer the schema's existing outputRef on intermediate parents so we
+        // don't clobber legitimate NTS refs when the extension is later merged.
+        if (
+          refConfig.ref !== refConfig.outputRef &&
+          schemaNode[refConfig.outputRef]
+        ) {
+          node[refConfig.outputRef] = schemaNode[refConfig.outputRef];
+        } else if (schemaNode[refConfig.ref]) {
           node[refConfig.outputRef] = schemaNode[refConfig.ref];
         }
       } catch (err) {

package/src/utils/extractOverlay.js

@@ -220,6 +220,25 @@ const extractOverlay = (sourceSchema, ref) => {
       jp.set(returnSchema, `${path}/enum`, element[refEnum]);
     }
 
+    // Per-overlay display labels for enum values. The underlying enum (the
+    // stored value) is left untouched — we only emit positional `enumNames`
+    // aligned to the effective enum, so a form-facing overlay can present the
+    // form's own wording (e.g. "Ground"/"Surface water") while the data keeps
+    // its canonical value. Invisible to the core/base schema (stripped below).
+    const refEnumNames = `${ref}EnumNames`;
+    if (element[refEnumNames]) {
+      const labelMap = element[refEnumNames];
+      const effectiveEnum = element[refEnum] || element.enum;
+      if (Array.isArray(effectiveEnum)) {
+        const enumNames = effectiveEnum.map((value) =>
+          Object.prototype.hasOwnProperty.call(labelMap, value)
+            ? labelMap[value]
+            : value
+        );
+        jp.set(returnSchema, `${path}/enumNames`, enumNames);
+      }
+    }
+
     const refConst = `${ref}Const`;
     if (Object.prototype.hasOwnProperty.call(element, refConst)) {
       jp.set(returnSchema, `${path}/const`, element[refConst]);
@@ -265,6 +284,7 @@ const coreSchema = deleteProperties(combinedSchema, [
   ...metadataFields.map((item) => `${item}Title`),
   ...metadataFields.map((item) => `${item}Description`),
   ...metadataFields.map((item) => `${item}Enum`),
+  ...metadataFields.map((item) => `${item}EnumNames`),
   ...metadataFields.map((item) => `${item}Type`),
   ...metadataFields.map((item) => `${item}MinLength`),
   ...metadataFields.map((item) => `${item}MaxLength`),

package/CLAUDE.md

@@ -1,101 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance for AI coding agents when working with code in this repository.
-
-## Overview
-
-This repository contains the Property Data Trust Framework (PDTF) schemas - JSON Schema-based definitions for digital residential property data exchange in England and Wales. The framework enables frictionless exchange of property data between software products and services.
-
-## Commands
-
-### Testing
-```bash
-npm test          # Run all tests
-npm run test:watch # Run tests in watch mode
-```
-
-### Development
-```bash
-npm install                       # Install dependencies
-npm run extract-overlays          # Regenerate v3 schemas and overlays from combined.json
-npm run extract-extension-overlays # Regenerate v3 extension overlays from combined.json
-npm run publish:dev               # Publish the dev branch package to npm tag dev
-npm run publish:next              # Publish the next branch package to npm tag next
-npm run publish:latest            # Publish the main branch package to npm tag latest
-```
-
-**Important**: `src/schemas/v3/combined.json` is the source of truth for v3 schema changes. Never edit generated schema artifacts directly; there are no exceptions. Utility/source files may be edited normally. After changing `combined.json`, always run both overlay extraction commands so derived files stay in sync.
-
-## Architecture
-
-### Schema System
-The PDTF uses a flexible overlay system where a base transaction schema can be extended with form-specific overlays:
-
-- **Base Schema**: Core transaction schema at `/src/schemas/v3/pdtf-transaction.json`
-- **Overlays**: Form-specific extensions in `/src/schemas/v3/overlays/` (e.g., baspi5.json, ta6.json)
-- **Merging**: Overlays are merged with the base schema using deepmerge with custom merge strategies
-- **Generated Files**: `pdtf-transaction.json`, `skeleton.json`, `compactSkeleton.txt`, `src/schemas/v3/overlays/*.json`, and `src/schemas/v3/overlays/extensions/*.json` are generated from `combined.json`
-
-### Key Components
-
-1. **index.js**: Main module exposing schema utilities
-   - `getTransactionSchema(schemaId, overlays)`: Merges base schema with overlays
-   - `getValidator(schemaId, overlays)`: Returns AJV validator for schema
-   - `validateVerifiedClaims()`: Validates verified claims structure
-
-2. **Schema Versions**: Currently on v3, with v2 still supported
-   - Use `https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json` for v3
-
-3. **Overlay System**: Supports multiple UK property forms
-   - BASPI (v4 and v5)
-   - Law Society TA forms (TA6, TA7, TA10)
-   - NTS forms (2023 and 2025 versions)
-   - CON29R, PIQ, RDS, and others
-
-### Testing Approach
-Tests in `/src/tests/` validate:
-- Schema structure with different overlay combinations
-- Path validation for nested properties
-- Custom overlay merging
-- Verified claims validation
-
-Use existing test patterns when adding new tests.
-
-## Branch And Release Workflow
-
-This repository publishes `@pdtf/schemas` through three branches and npm
-dist-tags:
-
-- `main` -> npm `latest`: stable PDTF releases for broad industry use.
-- `next` -> npm `next`: tested capabilities proposed for the next managed PDTF
-  point release.
-- `dev` -> npm `dev`: the unstable coal face for faster-moving integration work
-  and early adopters.
-
-PRs may be merged into `dev` to prove out work before it is ready for the managed
-release path. Once a `dev` PR has been tested and is suitable for standards
-review, promote the same change into `next` via a focused PR. Do not treat `dev`
-as the standard, and do not publish `dev` or `next` builds to npm `latest`.
-
-Promotion is automatic by default: after a PR is merged into `dev`,
-`.github/workflows/promote-dev-to-next.yml` creates a matching PR into `next` by
-cherry-picking the merged dev PR. Add the `no-promote-next` label before merging
-a dev PR only when it should stay out of the `next` review queue. Reviewers
-should still inspect the promotion PR, resolve conflicts, and adjust
-release/version metadata if needed before merging to `next`.
-
-Each npm publish needs a unique semver version. Use `-dev.N` versions on `dev`,
-prerelease versions on `next`, and normal release versions on `main`.
-
-Consumer-specific compatibility profiles belong in the consuming application or
-service unless the capability becomes generic PDTF package functionality.
-Consumers should pin/hash supplied schemas and use their own target-profile
-configuration for API calls and webhooks.
-
-See `docs/branch-release-workflow.md` for the full workflow.
-
-## Important Notes
-
-- All schemas use JSON Schema Draft 07
-- The repository publishes to npm as `@pdtf/schemas`
-- Overlays may contain fields from licensed forms (BASPI, PIQ, Law Society) - ensure compliance when rendering data