@pdtf/schemas 3.6.0-2 → 3.6.0-21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/.claude/settings.local.json +17 -2
  2. package/docs/sef25-extensions-ui-spec.md +146 -0
  3. package/index.js +97 -58
  4. package/package.json +4 -2
  5. package/src/schemas/v3/combined.json +7013 -1313
  6. package/src/schemas/v3/compactSkeleton.txt +353 -11
  7. package/src/schemas/v3/overlays/baspi4.json +161 -17
  8. package/src/schemas/v3/overlays/baspi5.json +166 -19
  9. package/src/schemas/v3/overlays/extensions/jk.json +24 -6
  10. package/src/schemas/v3/overlays/extensions/pc.json +36 -0
  11. package/src/schemas/v3/overlays/extensions/ph.json +197 -0
  12. package/src/schemas/v3/overlays/extensions/sc.json +83 -0
  13. package/src/schemas/v3/overlays/fme1.json +16 -14
  14. package/src/schemas/v3/overlays/lpe1.json +60 -30
  15. package/src/schemas/v3/overlays/nts.json +68 -1
  16. package/src/schemas/v3/overlays/nts2.json +68 -1
  17. package/src/schemas/v3/overlays/ntsl.json +68 -1
  18. package/src/schemas/v3/overlays/ntsl2.json +68 -1
  19. package/src/schemas/v3/overlays/piq.json +38 -1
  20. package/src/schemas/v3/overlays/rds.json +118 -6
  21. package/src/schemas/v3/overlays/ta6.json +40 -14
  22. package/src/schemas/v3/overlays/ta6ed6.json +6436 -0
  23. package/src/schemas/v3/overlays/ta7.json +70 -6
  24. package/src/schemas/v3/overlays/ta7ed5.json +1539 -0
  25. package/src/schemas/v3/pdtf-transaction.json +4098 -615
  26. package/src/schemas/v3/skeleton.json +491 -34
  27. package/src/tests/v3/buyerCircumstances.test.js +543 -0
  28. package/src/tests/v3/extensionOverlays.test.js +436 -0
  29. package/src/tests/v3/offers.test.js +37 -40
  30. package/src/tests/v3/patternProperties.test.js +149 -30
  31. package/src/tests/v3/ta6ed6.test.js +2356 -0
  32. package/src/tests/v3/ta7ed5.test.js +567 -0
  33. package/src/utils/extractExtensionOverlays.js +104 -31
  34. package/src/utils/extractOverlay.js +87 -23
  35. package/src/utils/pathSkeleton.js +1 -1
package/src/schemas/v3/compactSkeleton.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  transactionId
2
- externalIds
2
+ externalIds{*}
3
3
  status
4
4
  participants[
5
5
  name
@@ -26,10 +26,11 @@
26
26
  organisation
27
27
  organisationReference
28
28
  role
29
- externalIds
29
+ externalIds{*}
30
30
  participantStatus
31
31
  verification
32
32
  identity
33
+ status
33
34
  result
34
35
  reports[
35
36
  reportName
@@ -37,6 +38,15 @@
37
38
  details
38
39
  ]
39
40
  antiMoneyLaundering
41
+ status
42
+ result
43
+ reports[
44
+ reportName
45
+ result
46
+ details
47
+ ]
48
+ sourceOfFunds
49
+ status
40
50
  result
41
51
  reports[
42
52
  reportName
@@ -48,6 +58,10 @@
48
58
  capacity
49
59
  sellersCapacityDetails
50
60
  attachments
61
+ companyName
62
+ companyNumber
63
+ countryOfIncorporation
64
+ dateBecameOwnerOrAuthority
51
65
  ]
52
66
  propertyPack
53
67
  address
@@ -198,6 +212,8 @@
198
212
  ownership
199
213
  numberOfSellers
200
214
  numberOfNonUkResidentSellers
215
+ outstandingMortgage
216
+ existingLender
201
217
  hasHelpToBuyEquityLoan
202
218
  isFirstRegistration
203
219
  isLimitedCompanySale
@@ -299,6 +315,17 @@
299
315
  isApplicableParty
300
316
  feeIncludingVAT
301
317
  noticeViaEmail
318
+ contact
319
+ nameOrOrganisation
320
+ address
321
+ line1
322
+ line2
323
+ line3
324
+ town
325
+ postcode
326
+ telephone
327
+ emailAddress
328
+ capacity
302
329
  otherDetailsRequired
303
330
  areOtherDetailsRequired
304
331
  details
@@ -425,6 +452,7 @@
425
452
  leaseholdInformation
426
453
  typeOfLeasehold
427
454
  leaseholdType
455
+ otherLeaseholdType
428
456
  sharedOwnership
429
457
  isSharedOwnership
430
458
  sharedOwnershipPercentage
@@ -486,6 +514,39 @@
486
514
  accountNumber
487
515
  reference
488
516
  feeType
517
+ rightToManageCompany
518
+ contact
519
+ nameOrOrganisation
520
+ address
521
+ line1
522
+ line2
523
+ line3
524
+ town
525
+ postcode
526
+ emailAddress
527
+ telephone
528
+ freeholder
529
+ contact
530
+ nameOrOrganisation
531
+ address
532
+ line1
533
+ line2
534
+ line3
535
+ town
536
+ postcode
537
+ emailAddress
538
+ telephone
539
+ headLeaseHolder
540
+ contact
541
+ nameOrOrganisation
542
+ address
543
+ line1
544
+ line2
545
+ line3
546
+ town
547
+ postcode
548
+ emailAddress
549
+ telephone
489
550
  managingAgent
490
551
  contact
491
552
  nameOrOrganisation
@@ -551,6 +612,17 @@
551
612
  isApplicableParty
552
613
  feeIncludingVAT
553
614
  noticeViaEmail
615
+ contact
616
+ nameOrOrganisation
617
+ address
618
+ line1
619
+ line2
620
+ line3
621
+ town
622
+ postcode
623
+ telephone
624
+ emailAddress
625
+ capacity
554
626
  noticeOfTransferAndCharge
555
627
  rentchargeOwner
556
628
  isApplicableParty
@@ -572,12 +644,27 @@
572
644
  isApplicableParty
573
645
  feeIncludingVAT
574
646
  noticeViaEmail
647
+ contact
648
+ nameOrOrganisation
649
+ address
650
+ line1
651
+ line2
652
+ line3
653
+ town
654
+ postcode
655
+ telephone
656
+ emailAddress
657
+ capacity
575
658
  otherDetailsRequired
576
659
  areOtherDetailsRequired
577
660
  details
578
661
  collectsGroundRent
662
+ collector
663
+ otherCollector
579
664
  collectsServiceCharges
580
665
  collectsbuildingInsurancePremiums
666
+ collector
667
+ otherCollector
581
668
  dealsWithDayToDayMaintenanceOfManagedArea
582
669
  organisesBuildingInsurance
583
670
  dealsWithDayToDayMaintenanceOfBuilding
@@ -597,6 +684,10 @@
597
684
  isSellerAwareOfChanges
598
685
  details
599
686
  attachments
687
+ landlordConsents
688
+ isSellerAwareOfLandlordConsents
689
+ details
690
+ attachments
600
691
  transferAndRegistration
601
692
  deedOfCovenantRequired
602
693
  yesNoNotKnown
@@ -616,6 +707,7 @@
616
707
  isGroundRentPayable
617
708
  annualGroundRent
618
709
  groundRentFrequency
710
+ mostRecentGroundRentDemandStatus
619
711
  rentSubjectToIncrease
620
712
  yesNo
621
713
  rentReviewFrequency
@@ -634,11 +726,16 @@
634
726
  buildingManager
635
727
  buildingManagerType
636
728
  details
637
- hasTenantCompanyDissolved
638
729
  isManagingAgentEmployed
730
+ sellerOwnership
731
+ yesNo
732
+ attachments
733
+ hasTenantCompanyDissolved
734
+ hasTenantCompanyDissolvedDetails
639
735
  serviceCharge
640
736
  sellerContributesToServiceCharge
641
737
  annualServiceCharge
738
+ mostRecentServiceChargeDemandStatus
642
739
  largeAdditionalExpense
643
740
  yesNo
644
741
  details
@@ -712,6 +809,7 @@
712
809
  premiumsPaidUpToDate
713
810
  yesNo
714
811
  details
812
+ mostRecentBuildingsInsuranceDemandStatus
715
813
  lastDemandPeriod
716
814
  from
717
815
  to
@@ -729,6 +827,9 @@
729
827
  riskAssessments
730
828
  assessmentsCarriedOut
731
829
  urgentWorksRecommended
830
+ urgentWorksCarriedOut
831
+ outstandingEnforcementAction
832
+ dateRemedialActionRequired
732
833
  standardTermsAvailable
733
834
  yesNo
734
835
  details
@@ -835,6 +936,9 @@
835
936
  companyAccounts
836
937
  managementCompanyAGMMinutes
837
938
  enforcementNotices
939
+ additionalInformation
940
+ details
941
+ attachments
838
942
  confirmationOfAccuracy
839
943
  confirmation
840
944
  capacity
@@ -846,12 +950,18 @@
846
950
  yesNo
847
951
  controlledParking
848
952
  yesNo
849
- annualCostOfPermit
953
+ costOfPermit
954
+ costOfPermitFrequency
850
955
  vehicleTypeRestriction
851
956
  yesNo
852
957
  details
853
958
  electricVehicleChargingPoint
854
959
  yesNo
960
+ chargerDetails
961
+ chargerDetailsAttachments
962
+ cableCrossesPavement
963
+ yesNo
964
+ details
855
965
  locatedInUlez
856
966
  yesNo
857
967
  listingAndConservation
@@ -867,6 +977,7 @@
867
977
  yesNo
868
978
  workCarriedOut
869
979
  yesNo
980
+ details
870
981
  consentsObtained
871
982
  attachments
872
983
  typeOfConstruction
@@ -1056,6 +1167,10 @@
1056
1167
  yesNo
1057
1168
  attachments
1058
1169
  details
1170
+ nonResidentialPurposes
1171
+ yesNo
1172
+ details
1173
+ attachments
1059
1174
  windowReplacementsSince2002
1060
1175
  yesNo
1061
1176
  details
@@ -1076,6 +1191,25 @@
1076
1191
  yesNo
1077
1192
  attachments
1078
1193
  details
1194
+ workCompleted
1195
+ yesNo
1196
+ details
1197
+ documents
1198
+ extension
1199
+ yesNo
1200
+ details
1201
+ workCompleted
1202
+ yesNo
1203
+ details
1204
+ documents
1205
+ planningPermission
1206
+ yesNo
1207
+ attachments
1208
+ details
1209
+ buildingRegApproval
1210
+ yesNo
1211
+ attachments
1212
+ details
1079
1213
  hasAddedConservatory
1080
1214
  yesNo
1081
1215
  details
@@ -1096,6 +1230,100 @@
1096
1230
  yesNo
1097
1231
  attachments
1098
1232
  details
1233
+ workCompleted
1234
+ yesNo
1235
+ details
1236
+ documents
1237
+ loftConversion
1238
+ yesNo
1239
+ details
1240
+ workCompleted
1241
+ yesNo
1242
+ details
1243
+ documents
1244
+ planningPermission
1245
+ yesNo
1246
+ attachments
1247
+ details
1248
+ buildingRegApproval
1249
+ yesNo
1250
+ attachments
1251
+ details
1252
+ garageConversion
1253
+ yesNo
1254
+ details
1255
+ workCompleted
1256
+ yesNo
1257
+ details
1258
+ documents
1259
+ planningPermission
1260
+ yesNo
1261
+ attachments
1262
+ details
1263
+ buildingRegApproval
1264
+ yesNo
1265
+ attachments
1266
+ details
1267
+ removalOfInternalWalls
1268
+ yesNo
1269
+ details
1270
+ workCompleted
1271
+ yesNo
1272
+ details
1273
+ documents
1274
+ planningPermission
1275
+ yesNo
1276
+ attachments
1277
+ details
1278
+ buildingRegApproval
1279
+ yesNo
1280
+ attachments
1281
+ details
1282
+ removalOfChimneyBreast
1283
+ yesNo
1284
+ details
1285
+ workCompleted
1286
+ yesNo
1287
+ details
1288
+ documents
1289
+ planningPermission
1290
+ yesNo
1291
+ attachments
1292
+ details
1293
+ buildingRegApproval
1294
+ yesNo
1295
+ attachments
1296
+ details
1297
+ insulation
1298
+ yesNo
1299
+ details
1300
+ workCompleted
1301
+ yesNo
1302
+ details
1303
+ documents
1304
+ planningPermission
1305
+ yesNo
1306
+ attachments
1307
+ details
1308
+ buildingRegApproval
1309
+ yesNo
1310
+ attachments
1311
+ details
1312
+ otherBuildingWorksOrChangesToTheProperty
1313
+ yesNo
1314
+ details
1315
+ workCompleted
1316
+ yesNo
1317
+ details
1318
+ documents
1319
+ planningPermission
1320
+ yesNo
1321
+ attachments
1322
+ details
1323
+ buildingRegApproval
1324
+ yesNo
1325
+ attachments
1326
+ details
1099
1327
  worksUnfinished
1100
1328
  yesNo
1101
1329
  details
@@ -1149,6 +1377,9 @@
1149
1377
  details
1150
1378
  attachments
1151
1379
  japaneseKnotweed
1380
+ knotweedSurveyCarriedOut
1381
+ yesNo
1382
+ attachments
1152
1383
  yesNo
1153
1384
  managementPlanInPlace
1154
1385
  attachments
@@ -1160,6 +1391,18 @@
1160
1391
  yesNo
1161
1392
  details
1162
1393
  attachments
1394
+ wellsDitchesShaft
1395
+ yesNo
1396
+ details
1397
+ damagedOrExposedElectrics
1398
+ yesNo
1399
+ details
1400
+ damageToFlooringOrStaircases
1401
+ yesNo
1402
+ details
1403
+ knownAreasInPoorCondition
1404
+ yesNo
1405
+ details
1163
1406
  fixturesAndFittings
1164
1407
  itemsToRemove
1165
1408
  yesNo
@@ -1626,6 +1869,7 @@
1626
1869
  solarPanels
1627
1870
  yesNo
1628
1871
  supplier
1872
+ hotWaterOnly
1629
1873
  yearInstalled
1630
1874
  panelsOwnedOutright
1631
1875
  yesNo
@@ -1639,11 +1883,23 @@
1639
1883
  inGoodWorkingOrder
1640
1884
  yesNo
1641
1885
  details
1642
- isConnectedToNationalGrid
1643
1886
  photovoltaicMeterPanelLocation
1644
1887
  attachments
1645
- photovoltaicBatteriesLocation
1888
+ maintenanceAgreement
1889
+ yesNo
1890
+ attachments
1891
+ photovoltaicBatteries
1892
+ yesNo
1646
1893
  attachments
1894
+ details
1895
+ nationalGrid
1896
+ yesNo
1897
+ fitOrSegInPlace
1898
+ yesNo
1899
+ fitSegAgreementCopy
1900
+ attachments
1901
+ fitSegAssignmentProcedure
1902
+ installationCertificates
1647
1903
  dateToBeConnected
1648
1904
  heatPump
1649
1905
  yesNo
@@ -1651,6 +1907,8 @@
1651
1907
  supplier
1652
1908
  dateInstalled
1653
1909
  attachments
1910
+ makeModel
1911
+ serviceProviderName
1654
1912
  dateToBeConnected
1655
1913
  otherSources
1656
1914
  yesNo
@@ -1665,6 +1923,9 @@
1665
1923
  mainsWater
1666
1924
  yesNo
1667
1925
  details
1926
+ associatedCost
1927
+ amount
1928
+ frequency
1668
1929
  supplier
1669
1930
  stopcock
1670
1931
  location
@@ -1708,13 +1969,21 @@
1708
1969
  attachments
1709
1970
  plantDrainsIntoWaterway
1710
1971
  yesNo
1972
+ hasInfiltrationSystem
1973
+ yesNo
1711
1974
  dischargeCompliesWithGBR
1712
1975
  dateReplaced
1713
1976
  dateLastEmptied
1977
+ supplier
1978
+ makeModel
1979
+ serviceProviderName
1714
1980
  dateInstalled
1715
1981
  dateLastServiced
1716
1982
  attachments
1717
1983
  details
1984
+ associatedCost
1985
+ amount
1986
+ frequency
1718
1987
  surfaceDrainageCharge
1719
1988
  yesNo
1720
1989
  details
@@ -1765,6 +2034,10 @@
1765
2034
  otherCentralHeatingFuelType
1766
2035
  centralHeatingInstalled
1767
2036
  boilerInstallationCertificate
2037
+ yesNo
2038
+ boilerInstallationDate
2039
+ attachments
2040
+ replacementOtherThanBoiler
1768
2041
  yesNo
1769
2042
  attachments
1770
2043
  heatingLastServicedDate
@@ -1774,6 +2047,7 @@
1774
2047
  details
1775
2048
  details
1776
2049
  otherHeatingFeatures[]
2050
+ multipleHeatingSystems
1777
2051
  connectivity
1778
2052
  telephone
1779
2053
  yesNo
@@ -1794,6 +2068,7 @@
1794
2068
  maxUfbbPredictedUp
1795
2069
  maxPredictedDown
1796
2070
  maxPredictedUp
2071
+ providerName
1797
2072
  mobilePhone
1798
2073
  knownSignalIssues
1799
2074
  yesNo
@@ -1831,6 +2106,7 @@
1831
2106
  voDataOutdoorNo4g
1832
2107
  voDataIndoor
1833
2108
  voDataIndoorNo4g
2109
+ otherServices
1834
2110
  insurance
1835
2111
  difficultiesObtainingInsurance
1836
2112
  abnormalRiseInPremiums
@@ -1848,6 +2124,7 @@
1848
2124
  isInsured
1849
2125
  details
1850
2126
  landlordInsuresIfFlat
2127
+ whoInsures
1851
2128
  insuranceClaims
1852
2129
  yesNo
1853
2130
  details
@@ -1855,9 +2132,15 @@
1855
2132
  sharedContributions
1856
2133
  yesNo
1857
2134
  details
2135
+ disagreementOrComplaint
2136
+ yesNo
2137
+ details
1858
2138
  neighbouringLandRights
1859
2139
  yesNo
1860
2140
  details
2141
+ disagreementOrComplaint
2142
+ yesNo
2143
+ details
1861
2144
  attachments
1862
2145
  accessRestrictionAttempts
1863
2146
  yesNo
@@ -1888,6 +2171,15 @@
1888
2171
  otherRights
1889
2172
  yesNo
1890
2173
  details
2174
+ disagreementOrComplaint
2175
+ yesNo
2176
+ details
2177
+ askedOthersToContribute
2178
+ yesNo
2179
+ details
2180
+ disagreementOrComplaint
2181
+ yesNo
2182
+ details
1891
2183
  environmentalIssues
1892
2184
  flooding
1893
2185
  floodRiskReport
@@ -2127,6 +2419,14 @@
2127
2419
  details
2128
2420
  attachments
2129
2421
  additionalInformation
2422
+ consents
2423
+ attachments
2424
+ consentsAttached
2425
+ consentsToFollow
2426
+ consentsNotAvailable
2427
+ furtherInformation
2428
+ details
2429
+ attachments
2130
2430
  restrictionsOnUseNotCompliedWith
2131
2431
  yesNo
2132
2432
  details
@@ -2254,6 +2554,9 @@
2254
2554
  subsidenceWork
2255
2555
  yesNo
2256
2556
  attachments
2557
+ insulation
2558
+ yesNo
2559
+ attachments
2257
2560
  solarPanels
2258
2561
  yesNo
2259
2562
  attachments
@@ -2265,6 +2568,9 @@
2265
2568
  yesNo
2266
2569
  details
2267
2570
  attachments
2571
+ breachOfTermsOrConditions
2572
+ yesNo
2573
+ details
2268
2574
  titleDefectInsurance
2269
2575
  yesNo
2270
2576
  details
@@ -2314,13 +2620,17 @@
2314
2620
  confirmationOfAccuracyByOwners
2315
2621
  confirmWillProvideAdditionalDocumentation
2316
2622
  confirmInformationIsAccurate
2623
+ sellerSignatures[
2624
+ name
2625
+ signedOn
2626
+ ]
2317
2627
  saleReadyDeclarations
2318
2628
  authorisedToActOnBehalfOfAllSellers
2319
2629
  authorisationToShare
2320
2630
  sellerSignatures[
2321
2631
  name
2322
2632
  signedOn
2323
- externalIds
2633
+ externalIds{*}
2324
2634
  ]
2325
2635
  localSearches
2326
2636
  localLandCharges[
@@ -3284,8 +3594,9 @@
3284
3594
  fileName
3285
3595
  mimeType
3286
3596
  documentType
3287
- externalIds
3597
+ externalIds{*}
3288
3598
  isDeleted
3599
+ summary
3289
3600
  ]
3290
3601
  surveys[
3291
3602
  outside
@@ -4032,7 +4343,7 @@
4032
4343
  template
4033
4344
  name
4034
4345
  url
4035
- externalIds
4346
+ externalIds{*}
4036
4347
  requiredSignatories[
4037
4348
  role
4038
4349
  requiresAll
@@ -4041,13 +4352,13 @@
4041
4352
  signatures[
4042
4353
  name
4043
4354
  signedOn
4044
- externalIds
4355
+ externalIds{*}
4045
4356
  ]
4046
4357
  ]
4047
4358
  chain
4048
4359
  onwardPurchase[
4049
4360
  transactionId
4050
- externalIds
4361
+ externalIds{*}
4051
4362
  address
4052
4363
  buildingNumber
4053
4364
  buildingName
@@ -4092,6 +4403,36 @@
4092
4403
  inclusions[]
4093
4404
  exclusions[]
4094
4405
  conditions[]
4406
+ externalIds{*}
4407
+ buyerCircumstances
4408
+ intendedUse
4409
+ firstTimeBuyer
4410
+ rightToBuy
4411
+ ltdCompanyPurchase
4412
+ numberOfOwners
4413
+ numberOfExpats
4414
+ giftedEquity
4415
+ numberOfGiftedDeposits
4416
+ requiresMortgage
4417
+ helpToBuyEquityLoan
4418
+ armedForcesHelpToBuy
4419
+ numberOfHelpToBuyIsas
4420
+ bridgingFinanceRepresentation
4421
+ depositAmount
4422
+ loanToValue
4423
+ numberOfBorrowers
4424
+ jointProprietorSoleMortgagor
4425
+ soleProprietorJointMortgagor
4426
+ deedOfPostponement
4427
+ separateRepresentation
4428
+ oldestBorrowerAge
4429
+ mortgageTerm
4430
+ adverseCredit
4431
+ employmentType
4432
+ existingMortgagedProperties
4433
+ annualIncome
4434
+ residencyStatus
4435
+ nominatedLender
4095
4436
  enquiries{*}
4096
4437
  subject
4097
4438
  status
@@ -4100,4 +4441,5 @@
4100
4441
  originatorRole
4101
4442
  destinationRole
4102
4443
  messageText
4444
+ externalIds{*}
4103
4445
  resolutionCondition