@pdtf/schemas 3.6.0-1 → 3.6.0-11

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 (28) hide show
  1. package/.claude/settings.local.json +16 -2
  2. package/index.js +92 -58
  3. package/package.json +3 -2
  4. package/src/schemas/v3/combined.json +6463 -1167
  5. package/src/schemas/v3/compactSkeleton.txt +328 -10
  6. package/src/schemas/v3/overlays/baspi4.json +151 -15
  7. package/src/schemas/v3/overlays/baspi5.json +154 -15
  8. package/src/schemas/v3/overlays/fme1.json +16 -14
  9. package/src/schemas/v3/overlays/lpe1.json +48 -30
  10. package/src/schemas/v3/overlays/nts.json +68 -1
  11. package/src/schemas/v3/overlays/nts2.json +68 -1
  12. package/src/schemas/v3/overlays/ntsl.json +68 -1
  13. package/src/schemas/v3/overlays/ntsl2.json +68 -1
  14. package/src/schemas/v3/overlays/piq.json +38 -1
  15. package/src/schemas/v3/overlays/rds.json +118 -6
  16. package/src/schemas/v3/overlays/ta6.json +28 -10
  17. package/src/schemas/v3/overlays/ta6ed6.json +5812 -0
  18. package/src/schemas/v3/overlays/ta7.json +43 -3
  19. package/src/schemas/v3/overlays/ta7ed5.json +1551 -0
  20. package/src/schemas/v3/pdtf-transaction.json +3662 -564
  21. package/src/schemas/v3/skeleton.json +440 -31
  22. package/src/tests/v3/buyerCircumstances.test.js +543 -0
  23. package/src/tests/v3/offers.test.js +37 -40
  24. package/src/tests/v3/patternProperties.test.js +149 -30
  25. package/src/tests/v3/ta6ed6.test.js +2314 -0
  26. package/src/tests/v3/ta7ed5.test.js +567 -0
  27. package/src/utils/extractOverlay.js +76 -10
  28. 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
@@ -635,10 +727,15 @@
635
727
  buildingManagerType
636
728
  details
637
729
  hasTenantCompanyDissolved
730
+ hasTenantCompanyDissolvedDetails
638
731
  isManagingAgentEmployed
732
+ sellerOwnership
733
+ yesNo
734
+ attachments
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
@@ -835,6 +933,9 @@
835
933
  companyAccounts
836
934
  managementCompanyAGMMinutes
837
935
  enforcementNotices
936
+ additionalInformation
937
+ details
938
+ attachments
838
939
  confirmationOfAccuracy
839
940
  confirmation
840
941
  capacity
@@ -852,6 +953,11 @@
852
953
  details
853
954
  electricVehicleChargingPoint
854
955
  yesNo
956
+ chargerDetails
957
+ chargerDetailsAttachments
958
+ cableCrossesPavement
959
+ yesNo
960
+ details
855
961
  locatedInUlez
856
962
  yesNo
857
963
  listingAndConservation
@@ -867,6 +973,7 @@
867
973
  yesNo
868
974
  workCarriedOut
869
975
  yesNo
976
+ details
870
977
  consentsObtained
871
978
  attachments
872
979
  typeOfConstruction
@@ -1056,6 +1163,7 @@
1056
1163
  yesNo
1057
1164
  attachments
1058
1165
  details
1166
+ attachments
1059
1167
  windowReplacementsSince2002
1060
1168
  yesNo
1061
1169
  details
@@ -1076,6 +1184,25 @@
1076
1184
  yesNo
1077
1185
  attachments
1078
1186
  details
1187
+ workCompleted
1188
+ yesNo
1189
+ details
1190
+ documents
1191
+ extension
1192
+ yesNo
1193
+ details
1194
+ workCompleted
1195
+ yesNo
1196
+ details
1197
+ documents
1198
+ planningPermission
1199
+ yesNo
1200
+ attachments
1201
+ details
1202
+ buildingRegApproval
1203
+ yesNo
1204
+ attachments
1205
+ details
1079
1206
  hasAddedConservatory
1080
1207
  yesNo
1081
1208
  details
@@ -1096,6 +1223,100 @@
1096
1223
  yesNo
1097
1224
  attachments
1098
1225
  details
1226
+ workCompleted
1227
+ yesNo
1228
+ details
1229
+ documents
1230
+ loftConversion
1231
+ yesNo
1232
+ details
1233
+ workCompleted
1234
+ yesNo
1235
+ details
1236
+ documents
1237
+ planningPermission
1238
+ yesNo
1239
+ attachments
1240
+ details
1241
+ buildingRegApproval
1242
+ yesNo
1243
+ attachments
1244
+ details
1245
+ garageConversion
1246
+ yesNo
1247
+ details
1248
+ workCompleted
1249
+ yesNo
1250
+ details
1251
+ documents
1252
+ planningPermission
1253
+ yesNo
1254
+ attachments
1255
+ details
1256
+ buildingRegApproval
1257
+ yesNo
1258
+ attachments
1259
+ details
1260
+ removalOfInternalWalls
1261
+ yesNo
1262
+ details
1263
+ workCompleted
1264
+ yesNo
1265
+ details
1266
+ documents
1267
+ planningPermission
1268
+ yesNo
1269
+ attachments
1270
+ details
1271
+ buildingRegApproval
1272
+ yesNo
1273
+ attachments
1274
+ details
1275
+ removalOfChimneyBreast
1276
+ yesNo
1277
+ details
1278
+ workCompleted
1279
+ yesNo
1280
+ details
1281
+ documents
1282
+ planningPermission
1283
+ yesNo
1284
+ attachments
1285
+ details
1286
+ buildingRegApproval
1287
+ yesNo
1288
+ attachments
1289
+ details
1290
+ insulation
1291
+ yesNo
1292
+ details
1293
+ workCompleted
1294
+ yesNo
1295
+ details
1296
+ documents
1297
+ planningPermission
1298
+ yesNo
1299
+ attachments
1300
+ details
1301
+ buildingRegApproval
1302
+ yesNo
1303
+ attachments
1304
+ details
1305
+ otherBuildingWorksOrChangesToTheProperty
1306
+ yesNo
1307
+ details
1308
+ workCompleted
1309
+ yesNo
1310
+ details
1311
+ documents
1312
+ planningPermission
1313
+ yesNo
1314
+ attachments
1315
+ details
1316
+ buildingRegApproval
1317
+ yesNo
1318
+ attachments
1319
+ details
1099
1320
  worksUnfinished
1100
1321
  yesNo
1101
1322
  details
@@ -1150,8 +1371,10 @@
1150
1371
  attachments
1151
1372
  japaneseKnotweed
1152
1373
  yesNo
1374
+ knotweedSurveyCarriedOut
1375
+ yesNo
1376
+ attachments
1153
1377
  managementPlanInPlace
1154
- attachments
1155
1378
  subsidenceOrStructuralFault
1156
1379
  yesNo
1157
1380
  details
@@ -1626,6 +1849,7 @@
1626
1849
  solarPanels
1627
1850
  yesNo
1628
1851
  supplier
1852
+ hotWaterOnly
1629
1853
  yearInstalled
1630
1854
  panelsOwnedOutright
1631
1855
  yesNo
@@ -1639,11 +1863,23 @@
1639
1863
  inGoodWorkingOrder
1640
1864
  yesNo
1641
1865
  details
1642
- isConnectedToNationalGrid
1643
1866
  photovoltaicMeterPanelLocation
1644
1867
  attachments
1645
- photovoltaicBatteriesLocation
1868
+ maintenanceAgreement
1869
+ yesNo
1646
1870
  attachments
1871
+ photovoltaicBatteries
1872
+ yesNo
1873
+ attachments
1874
+ details
1875
+ nationalGrid
1876
+ yesNo
1877
+ fitOrSegInPlace
1878
+ yesNo
1879
+ fitSegAgreementCopy
1880
+ attachments
1881
+ fitSegAssignmentProcedure
1882
+ installationCertificates
1647
1883
  dateToBeConnected
1648
1884
  heatPump
1649
1885
  yesNo
@@ -1651,6 +1887,8 @@
1651
1887
  supplier
1652
1888
  dateInstalled
1653
1889
  attachments
1890
+ makeModel
1891
+ serviceProviderName
1654
1892
  dateToBeConnected
1655
1893
  otherSources
1656
1894
  yesNo
@@ -1708,9 +1946,14 @@
1708
1946
  attachments
1709
1947
  plantDrainsIntoWaterway
1710
1948
  yesNo
1949
+ hasInfiltrationSystem
1950
+ yesNo
1711
1951
  dischargeCompliesWithGBR
1712
1952
  dateReplaced
1713
1953
  dateLastEmptied
1954
+ supplier
1955
+ makeModel
1956
+ serviceProviderName
1714
1957
  dateInstalled
1715
1958
  dateLastServiced
1716
1959
  attachments
@@ -1765,6 +2008,10 @@
1765
2008
  otherCentralHeatingFuelType
1766
2009
  centralHeatingInstalled
1767
2010
  boilerInstallationCertificate
2011
+ yesNo
2012
+ boilerInstallationDate
2013
+ attachments
2014
+ replacementOtherThanBoiler
1768
2015
  yesNo
1769
2016
  attachments
1770
2017
  heatingLastServicedDate
@@ -1774,6 +2021,7 @@
1774
2021
  details
1775
2022
  details
1776
2023
  otherHeatingFeatures[]
2024
+ multipleHeatingSystems
1777
2025
  connectivity
1778
2026
  telephone
1779
2027
  yesNo
@@ -1794,6 +2042,7 @@
1794
2042
  maxUfbbPredictedUp
1795
2043
  maxPredictedDown
1796
2044
  maxPredictedUp
2045
+ providerName
1797
2046
  mobilePhone
1798
2047
  knownSignalIssues
1799
2048
  yesNo
@@ -1831,6 +2080,7 @@
1831
2080
  voDataOutdoorNo4g
1832
2081
  voDataIndoor
1833
2082
  voDataIndoorNo4g
2083
+ otherServices
1834
2084
  insurance
1835
2085
  difficultiesObtainingInsurance
1836
2086
  abnormalRiseInPremiums
@@ -1848,6 +2098,7 @@
1848
2098
  isInsured
1849
2099
  details
1850
2100
  landlordInsuresIfFlat
2101
+ whoInsures
1851
2102
  insuranceClaims
1852
2103
  yesNo
1853
2104
  details
@@ -1888,6 +2139,15 @@
1888
2139
  otherRights
1889
2140
  yesNo
1890
2141
  details
2142
+ disagreementAboutRightsYouExercise
2143
+ yesNo
2144
+ details
2145
+ rightsOverProperty
2146
+ yesNo
2147
+ details
2148
+ askedOthersToContribute
2149
+ yesNo
2150
+ details
1891
2151
  environmentalIssues
1892
2152
  flooding
1893
2153
  floodRiskReport
@@ -2127,6 +2387,14 @@
2127
2387
  details
2128
2388
  attachments
2129
2389
  additionalInformation
2390
+ consents
2391
+ attachments
2392
+ consentsAttached
2393
+ consentsToFollow
2394
+ consentsNotAvailable
2395
+ furtherInformation
2396
+ details
2397
+ attachments
2130
2398
  restrictionsOnUseNotCompliedWith
2131
2399
  yesNo
2132
2400
  details
@@ -2240,12 +2508,23 @@
2240
2508
  doubleGlazing
2241
2509
  yesNo
2242
2510
  attachments
2511
+ fensaCertificates
2512
+ certificates[
2513
+ certificateId
2514
+ numberOfWindows
2515
+ numberOfDoors
2516
+ certificateIssued
2517
+ workCompleted
2518
+ ]
2243
2519
  electricalRepairOrInstallation
2244
2520
  yesNo
2245
2521
  attachments
2246
2522
  subsidenceWork
2247
2523
  yesNo
2248
2524
  attachments
2525
+ insulation
2526
+ yesNo
2527
+ attachments
2249
2528
  solarPanels
2250
2529
  yesNo
2251
2530
  attachments
@@ -2257,6 +2536,9 @@
2257
2536
  yesNo
2258
2537
  details
2259
2538
  attachments
2539
+ breachOfTermsOrConditions
2540
+ yesNo
2541
+ details
2260
2542
  titleDefectInsurance
2261
2543
  yesNo
2262
2544
  details
@@ -2306,13 +2588,17 @@
2306
2588
  confirmationOfAccuracyByOwners
2307
2589
  confirmWillProvideAdditionalDocumentation
2308
2590
  confirmInformationIsAccurate
2591
+ sellerSignatures[
2592
+ name
2593
+ signedOn
2594
+ ]
2309
2595
  saleReadyDeclarations
2310
2596
  authorisedToActOnBehalfOfAllSellers
2311
2597
  authorisationToShare
2312
2598
  sellerSignatures[
2313
2599
  name
2314
2600
  signedOn
2315
- externalIds
2601
+ externalIds{*}
2316
2602
  ]
2317
2603
  localSearches
2318
2604
  localLandCharges[
@@ -3276,8 +3562,9 @@
3276
3562
  fileName
3277
3563
  mimeType
3278
3564
  documentType
3279
- externalIds
3565
+ externalIds{*}
3280
3566
  isDeleted
3567
+ summary
3281
3568
  ]
3282
3569
  surveys[
3283
3570
  outside
@@ -4024,7 +4311,7 @@
4024
4311
  template
4025
4312
  name
4026
4313
  url
4027
- externalIds
4314
+ externalIds{*}
4028
4315
  requiredSignatories[
4029
4316
  role
4030
4317
  requiresAll
@@ -4033,13 +4320,13 @@
4033
4320
  signatures[
4034
4321
  name
4035
4322
  signedOn
4036
- externalIds
4323
+ externalIds{*}
4037
4324
  ]
4038
4325
  ]
4039
4326
  chain
4040
4327
  onwardPurchase[
4041
4328
  transactionId
4042
- externalIds
4329
+ externalIds{*}
4043
4330
  address
4044
4331
  buildingNumber
4045
4332
  buildingName
@@ -4084,6 +4371,36 @@
4084
4371
  inclusions[]
4085
4372
  exclusions[]
4086
4373
  conditions[]
4374
+ externalIds{*}
4375
+ buyerCircumstances
4376
+ intendedUse
4377
+ firstTimeBuyer
4378
+ rightToBuy
4379
+ ltdCompanyPurchase
4380
+ numberOfOwners
4381
+ numberOfExpats
4382
+ giftedEquity
4383
+ numberOfGiftedDeposits
4384
+ requiresMortgage
4385
+ helpToBuyEquityLoan
4386
+ armedForcesHelpToBuy
4387
+ numberOfHelpToBuyIsas
4388
+ bridgingFinanceRepresentation
4389
+ depositAmount
4390
+ loanToValue
4391
+ numberOfBorrowers
4392
+ jointProprietorSoleMortgagor
4393
+ soleProprietorJointMortgagor
4394
+ deedOfPostponement
4395
+ separateRepresentation
4396
+ oldestBorrowerAge
4397
+ mortgageTerm
4398
+ adverseCredit
4399
+ employmentType
4400
+ existingMortgagedProperties
4401
+ annualIncome
4402
+ residencyStatus
4403
+ nominatedLender
4087
4404
  enquiries{*}
4088
4405
  subject
4089
4406
  status
@@ -4092,4 +4409,5 @@
4092
4409
  originatorRole
4093
4410
  destinationRole
4094
4411
  messageText
4412
+ externalIds{*}
4095
4413
  resolutionCondition