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

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,28 @@
     "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",
+        "detailsAnalysis": {},
         "uniformBoundaries": {
           "left": "string",
           "right": "string",
@@ -3168,14 +3216,17 @@
       },
       "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/docs/backend-lms-profile-filtering-spec.md

@@ -1,180 +0,0 @@
-# Backend LMS Profile Filtering Spec
-
-## Context
-
-Moverly will consume `@pdtf/schemas@dev` for early access to schema changes, but
-LMS should only receive data shaped to the `pdtf-transaction.json` profile they
-currently support.
-
-This compatibility layer belongs in Moverly backend services because it is an
-integration-boundary concern. The PDTF schema package should not carry
-LMS-specific profile code unless the capability later becomes generic and useful
-to PDTF consumers.
-
-## Target Profile
-
-Initial LMS profile:
-
-- Source: LMS-supplied `pdtf-transaction.json`
-- Profile id: `lms-2026-05-08`
-- Schema id: `https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json`
-- Raw SHA-256:
-  `5135ffd6158bbe48955ae630cf9cae42ba18f6cd522daed771cd3e44136283d7`
-- Canonical SHA-256:
-  `98aeebe4231557c1aa7bc5182cbb5318d28af32cdcbe3b293feb61dca1e8d6f5`
-
-The LMS profile is not an official PDTF release. It is a pinned recipient
-profile supplied by LMS. When LMS can support an official PDTF release, move the
-target profile to that release artifact instead.
-
-## Configuration
-
-Add a backend environment variable:
-
-```bash
-LMS_PDTF_TARGET_PROFILE=lms-2026-05-08
-```
-
-Behaviour:
-
-- Non-production may default to `lms-2026-05-08`.
-- Production must fail startup or alert loudly if the variable is missing or
-  unknown.
-- Logs and telemetry must include the selected profile id.
-
-## Scope
-
-Apply LMS profile filtering to:
-
-- backend endpoints that expose PDTF transaction data to LMS;
-- webhooks sent to LMS;
-- verified claim payloads included in LMS-facing API responses or webhooks.
-
-Do not apply LMS filtering to:
-
-- stored/source Moverly verified claims;
-- internal Moverly workflows;
-- non-LMS partners;
-- frontend schema rendering, except where frontend displays backend-provided
-  compatibility metadata.
-
-## Filtering Rules
-
-Treat the target profile as closed for outbound LMS payloads, even though PDTF
-schemas generally do not declare `additionalProperties: false`.
-
-For transaction payloads:
-
-1. Build the normal internal Moverly/PDTF payload.
-2. Filter unknown top-level and nested fields against the selected LMS target
-   schema.
-3. Validate the filtered payload against the selected LMS target schema.
-4. Send only the filtered payload.
-
-For verified claims:
-
-1. Iterate each verified claim envelope.
-2. Inspect each `claims` path/value pair independently.
-3. Keep the line item only if:
-   - the path exists in the selected LMS target schema; and
-   - the value validates against that path's subschema.
-4. Drop unsupported or invalid line items.
-5. Preserve the verified claim envelope if at least one line item remains.
-6. Drop the envelope only if all line items are suppressed.
-7. Preserve envelope metadata such as `id`, `transactionId`, `schemaVersion`,
-   `verification`, and `terms_of_use`.
-8. Do not mutate the source verified claim.
-
-Do not map paths or transform values. If a field needs structural mapping, that
-is a separate business/product decision and should not happen implicitly in this
-filtering layer.
-
-## Selective Disclosure Semantics
-
-Suppression means "not disclosed to LMS under this profile".
-
-It does not mean "the seller/source did not assert this". Any backend feature
-answering questions such as "did the seller make an assertion about flooding?"
-must query the source verified claims or explicit suppression metadata, not the
-LMS-filtered payload.
-
-## Suggested Backend Module
-
-Create a small backend-owned module, for example:
-
-```text
-src/integrations/lms/pdtfProfile/
-  lms-2026-05-08/pdtf-transaction.json
-  lms-2026-05-08/metadata.json
-  filterTransactionForProfile.ts
-  filterVerifiedClaimsForProfile.ts
-  profileRegistry.ts
-```
-
-The implementation should:
-
-- load the selected profile by id;
-- verify the pinned file hash in tests;
-- use JSON Schema parsing rather than hand-maintained path allowlists;
-- compile validators with the same AJV draft/settings used for PDTF validation;
-- cache subschema validators by `profileId:path`;
-- return suppression metadata without logging claim values.
-
-## Observability
-
-Record:
-
-- partner: `LMS`;
-- target profile id;
-- profile raw/canonical hash;
-- endpoint or webhook name;
-- transaction id;
-- claim line items before filtering;
-- claim line items after filtering;
-- verified claim envelopes before filtering;
-- verified claim envelopes after filtering;
-- envelopes dropped;
-- unsupported path count;
-- invalid value count;
-- suppressed paths, where safe;
-- validation errors, without sensitive values.
-
-## Tests
-
-Backend tests should cover:
-
-- selected profile id is read from env;
-- unknown production profile id fails loudly;
-- profile metadata hashes match the bundled LMS schema file;
-- transaction filtering removes unknown top-level fields;
-- transaction filtering removes unknown nested fields;
-- filtered transaction validates against the LMS target profile;
-- a field valid in `@pdtf/schemas@dev` but absent from LMS is suppressed;
-- verified claim line items are filtered independently;
-- verified claim envelope metadata is preserved;
-- envelopes are dropped only when all line items are suppressed;
-- source verified claims are not mutated;
-- suppression metadata is returned and contains no claim values.
-
-## Rollout
-
-1. Publish and install `@pdtf/schemas@dev` in Moverly backend.
-2. Add the LMS target profile module and tests.
-3. Set `LMS_PDTF_TARGET_PROFILE=lms-2026-05-08` in non-production.
-4. Run LMS endpoint and webhook regression tests.
-5. Deploy on Monday morning behind normal backend release controls.
-6. Monitor suppression and validation telemetry.
-7. Set the production env var and complete go-live.
-8. Keep the previous behaviour available for rollback until LMS confirms the new
-   payloads are accepted.
-
-## Future Profiles
-
-For a new LMS-supported PDTF release:
-
-1. Add the official released `pdtf-transaction.json` artifact or reference.
-2. Give it a clear profile id, for example `pdtf-3.6.0`.
-3. Add metadata and hash tests.
-4. Update `LMS_PDTF_TARGET_PROFILE`.
-5. Deploy backend and monitor telemetry.
-6. Retain the previous profile until rollback is no longer needed.