@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/overlays/baspi4.json CHANGED
@@ -17,9 +17,9 @@
17
17
  "properties": {
18
18
  "role": {
19
19
  "enum": [
20
- "Seller's Conveyancer",
21
20
  "Prospective Buyer",
22
21
  "Buyer's Conveyancer",
22
+ "Seller's Conveyancer",
23
23
  "Estate Agent",
24
24
  "Buyer's Agent",
25
25
  "Surveyor",
@@ -75,6 +75,7 @@
75
75
  "enum": [
76
76
  "Personal Representative for a Deceased Owner",
77
77
  "Under Power of Attorney",
78
+ "Trustee",
78
79
  "Assistant",
79
80
  "Other"
80
81
  ]
@@ -90,6 +91,26 @@
90
91
  "sellersCapacityDetails",
91
92
  "attachments"
92
93
  ]
94
+ },
95
+ {
96
+ "properties": {
97
+ "capacity": {
98
+ "enum": [
99
+ "Company Director",
100
+ "Company Secretary"
101
+ ]
102
+ },
103
+ "sellersCapacityDetails": {
104
+ "baspi4Ref": "B1.3.2"
105
+ },
106
+ "attachments": {
107
+ "baspi4Ref": "B1.3.3"
108
+ }
109
+ },
110
+ "required": [
111
+ "sellersCapacityDetails",
112
+ "attachments"
113
+ ]
93
114
  }
94
115
  ],
95
116
  "required": [
@@ -1152,6 +1173,29 @@
1152
1173
  },
1153
1174
  "electricVehicleChargingPoint": {
1154
1175
  "baspi4Ref": "A1.6.1",
1176
+ "discriminator": {
1177
+ "propertyName": "yesNo"
1178
+ },
1179
+ "oneOf": [
1180
+ {
1181
+ "properties": {
1182
+ "yesNo": {
1183
+ "enum": [
1184
+ "No"
1185
+ ]
1186
+ }
1187
+ }
1188
+ },
1189
+ {
1190
+ "properties": {
1191
+ "yesNo": {
1192
+ "enum": [
1193
+ "Yes"
1194
+ ]
1195
+ }
1196
+ }
1197
+ }
1198
+ ],
1155
1199
  "required": [
1156
1200
  "yesNo"
1157
1201
  ],
@@ -3264,13 +3308,20 @@
3264
3308
  },
3265
3309
  "managementPlanInPlace": {
3266
3310
  "baspi4Ref": "A5.3.2"
3267
- },
3268
- "attachments": {
3269
- "baspi4Ref": "A5.3.3"
3270
3311
  }
3271
3312
  },
3272
3313
  "required": [
3273
3314
  "managementPlanInPlace"
3315
+ ],
3316
+ "oneOf": [
3317
+ null,
3318
+ {
3319
+ "properties": {
3320
+ "attachments": {
3321
+ "baspi4Ref": "A5.3.3"
3322
+ }
3323
+ }
3324
+ }
3274
3325
  ]
3275
3326
  }
3276
3327
  ],
@@ -3705,9 +3756,6 @@
3705
3756
  }
3706
3757
  }
3707
3758
  },
3708
- "isConnectedToNationalGrid": {
3709
- "baspi4Ref": "B4.3.6"
3710
- },
3711
3759
  "photovoltaicMeterPanelLocation": {
3712
3760
  "baspi4Ref": "B4.7",
3713
3761
  "properties": {
@@ -3719,14 +3767,72 @@
3719
3767
  }
3720
3768
  }
3721
3769
  },
3722
- "photovoltaicBatteriesLocation": {
3770
+ "photovoltaicBatteries": {
3723
3771
  "baspi4Ref": "B4.8",
3724
- "properties": {
3725
- "description": {
3726
- "baspi4Ref": "4.8.1"
3772
+ "discriminator": {
3773
+ "propertyName": "yesNo"
3774
+ },
3775
+ "oneOf": [
3776
+ {
3777
+ "properties": {
3778
+ "yesNo": {
3779
+ "enum": [
3780
+ "No"
3781
+ ]
3782
+ }
3783
+ }
3727
3784
  },
3728
- "attachments": {
3729
- "baspi4Ref": "4.8.2"
3785
+ {
3786
+ "properties": {
3787
+ "yesNo": {
3788
+ "enum": [
3789
+ "Yes"
3790
+ ]
3791
+ },
3792
+ "description": {
3793
+ "baspi4Ref": "4.8.1"
3794
+ },
3795
+ "attachments": {
3796
+ "baspi4Ref": "4.8.2"
3797
+ }
3798
+ },
3799
+ "required": [
3800
+ "description"
3801
+ ]
3802
+ }
3803
+ ]
3804
+ },
3805
+ "nationalGrid": {
3806
+ "baspi4Ref": "B4.3.6",
3807
+ "discriminator": {
3808
+ "propertyName": "yesNo"
3809
+ },
3810
+ "oneOf": [
3811
+ {
3812
+ "properties": {
3813
+ "yesNo": {
3814
+ "enum": [
3815
+ "No"
3816
+ ]
3817
+ }
3818
+ }
3819
+ },
3820
+ {
3821
+ "properties": {
3822
+ "yesNo": {
3823
+ "enum": [
3824
+ "Yes"
3825
+ ]
3826
+ }
3827
+ }
3828
+ }
3829
+ ],
3830
+ "required": [
3831
+ "yesNo"
3832
+ ],
3833
+ "properties": {
3834
+ "yesNo": {
3835
+ "baspi4Ref": "B4.3.6"
3730
3836
  }
3731
3837
  }
3732
3838
  }
@@ -3737,7 +3843,7 @@
3737
3843
  "panelProviderLease",
3738
3844
  "lastMaintained",
3739
3845
  "inGoodWorkingOrder",
3740
- "isConnectedToNationalGrid"
3846
+ "nationalGrid"
3741
3847
  ]
3742
3848
  },
3743
3849
  {
@@ -4808,6 +4914,32 @@
4808
4914
  },
4809
4915
  "broadband": {
4810
4916
  "baspi4Ref": "A7.1.0.7",
4917
+ "discriminator": {
4918
+ "propertyName": "typeOfConnection"
4919
+ },
4920
+ "oneOf": [
4921
+ {
4922
+ "properties": {
4923
+ "typeOfConnection": {
4924
+ "enum": [
4925
+ "None"
4926
+ ]
4927
+ }
4928
+ }
4929
+ },
4930
+ {
4931
+ "properties": {
4932
+ "typeOfConnection": {
4933
+ "enum": [
4934
+ "ADSL copper wire",
4935
+ "Cable",
4936
+ "FTTC (Fibre to the Cabinet)",
4937
+ "FTTP (Fibre to the Premises)"
4938
+ ]
4939
+ }
4940
+ }
4941
+ }
4942
+ ],
4811
4943
  "properties": {
4812
4944
  "typeOfConnection": {
4813
4945
  "baspi4Ref": "A7.1.0.7.2"
@@ -5700,7 +5832,11 @@
5700
5832
  ],
5701
5833
  "properties": {
5702
5834
  "yesNo": {
5703
- "baspi4Ref": "A11.1.3.1"
5835
+ "baspi4Ref": "A11.1.3.1",
5836
+ "enum": [
5837
+ "Yes",
5838
+ "No"
5839
+ ]
5704
5840
  }
5705
5841
  }
5706
5842
  },
@@ -6707,7 +6843,11 @@
6707
6843
  "baspi4Ref": "B4.1.2"
6708
6844
  },
6709
6845
  "attachments": {
6710
- "baspi4Ref": "B4.1.3"
6846
+ "baspi4Ref": "B4.1.3",
6847
+ "enum": [
6848
+ "Attached",
6849
+ "To follow"
6850
+ ]
6711
6851
  }
6712
6852
  },
6713
6853
  "required": [
@@ -6765,7 +6905,11 @@
6765
6905
  "baspi4Ref": "B4.2.3.1"
6766
6906
  },
6767
6907
  "attachments": {
6768
- "baspi4Ref": "B4.2.3.2"
6908
+ "baspi4Ref": "B4.2.3.2",
6909
+ "enum": [
6910
+ "Attached",
6911
+ "To follow"
6912
+ ]
6769
6913
  }
6770
6914
  }
6771
6915
  }
package/src/schemas/v3/overlays/baspi5.json CHANGED
@@ -17,9 +17,9 @@
17
17
  "properties": {
18
18
  "role": {
19
19
  "enum": [
20
- "Seller's Conveyancer",
21
20
  "Prospective Buyer",
22
21
  "Buyer's Conveyancer",
22
+ "Seller's Conveyancer",
23
23
  "Estate Agent",
24
24
  "Buyer's Agent",
25
25
  "Surveyor",
@@ -75,6 +75,7 @@
75
75
  "enum": [
76
76
  "Personal Representative for a Deceased Owner",
77
77
  "Under Power of Attorney",
78
+ "Trustee",
78
79
  "Assistant",
79
80
  "Other"
80
81
  ]
@@ -90,6 +91,26 @@
90
91
  "sellersCapacityDetails",
91
92
  "attachments"
92
93
  ]
94
+ },
95
+ {
96
+ "properties": {
97
+ "capacity": {
98
+ "enum": [
99
+ "Company Director",
100
+ "Company Secretary"
101
+ ]
102
+ },
103
+ "sellersCapacityDetails": {
104
+ "baspi5Ref": "B1.3.2"
105
+ },
106
+ "attachments": {
107
+ "baspi5Ref": "B1.3.3"
108
+ }
109
+ },
110
+ "required": [
111
+ "sellersCapacityDetails",
112
+ "attachments"
113
+ ]
93
114
  }
94
115
  ],
95
116
  "required": [
@@ -1240,12 +1261,12 @@
1240
1261
  "Yes"
1241
1262
  ]
1242
1263
  },
1243
- "annualCostOfPermit": {
1264
+ "costOfPermit": {
1244
1265
  "baspi5Ref": "A1.6.0.2.2"
1245
1266
  }
1246
1267
  },
1247
1268
  "required": [
1248
- "annualCostOfPermit"
1269
+ "costOfPermit"
1249
1270
  ]
1250
1271
  }
1251
1272
  ],
@@ -1300,6 +1321,29 @@
1300
1321
  },
1301
1322
  "electricVehicleChargingPoint": {
1302
1323
  "baspi5Ref": "A1.6.1",
1324
+ "discriminator": {
1325
+ "propertyName": "yesNo"
1326
+ },
1327
+ "oneOf": [
1328
+ {
1329
+ "properties": {
1330
+ "yesNo": {
1331
+ "enum": [
1332
+ "No"
1333
+ ]
1334
+ }
1335
+ }
1336
+ },
1337
+ {
1338
+ "properties": {
1339
+ "yesNo": {
1340
+ "enum": [
1341
+ "Yes"
1342
+ ]
1343
+ }
1344
+ }
1345
+ }
1346
+ ],
1303
1347
  "required": [
1304
1348
  "yesNo"
1305
1349
  ],
@@ -3415,13 +3459,20 @@
3415
3459
  },
3416
3460
  "managementPlanInPlace": {
3417
3461
  "baspi5Ref": "A5.3.2"
3418
- },
3419
- "attachments": {
3420
- "baspi5Ref": "A5.3.3"
3421
3462
  }
3422
3463
  },
3423
3464
  "required": [
3424
3465
  "managementPlanInPlace"
3466
+ ],
3467
+ "oneOf": [
3468
+ null,
3469
+ {
3470
+ "properties": {
3471
+ "attachments": {
3472
+ "baspi5Ref": "A5.3.3"
3473
+ }
3474
+ }
3475
+ }
3425
3476
  ]
3426
3477
  }
3427
3478
  ],
@@ -3856,9 +3907,6 @@
3856
3907
  }
3857
3908
  }
3858
3909
  },
3859
- "isConnectedToNationalGrid": {
3860
- "baspi5Ref": "B4.3.6"
3861
- },
3862
3910
  "photovoltaicMeterPanelLocation": {
3863
3911
  "baspi5Ref": "B4.7",
3864
3912
  "properties": {
@@ -3870,14 +3918,72 @@
3870
3918
  }
3871
3919
  }
3872
3920
  },
3873
- "photovoltaicBatteriesLocation": {
3921
+ "photovoltaicBatteries": {
3874
3922
  "baspi5Ref": "B4.8",
3875
- "properties": {
3876
- "description": {
3877
- "baspi5Ref": "4.8.1"
3923
+ "discriminator": {
3924
+ "propertyName": "yesNo"
3925
+ },
3926
+ "oneOf": [
3927
+ {
3928
+ "properties": {
3929
+ "yesNo": {
3930
+ "enum": [
3931
+ "No"
3932
+ ]
3933
+ }
3934
+ }
3878
3935
  },
3879
- "attachments": {
3880
- "baspi5Ref": "4.8.2"
3936
+ {
3937
+ "properties": {
3938
+ "yesNo": {
3939
+ "enum": [
3940
+ "Yes"
3941
+ ]
3942
+ },
3943
+ "description": {
3944
+ "baspi5Ref": "4.8.1"
3945
+ },
3946
+ "attachments": {
3947
+ "baspi5Ref": "4.8.2"
3948
+ }
3949
+ },
3950
+ "required": [
3951
+ "description"
3952
+ ]
3953
+ }
3954
+ ]
3955
+ },
3956
+ "nationalGrid": {
3957
+ "baspi5Ref": "B4.3.6",
3958
+ "discriminator": {
3959
+ "propertyName": "yesNo"
3960
+ },
3961
+ "oneOf": [
3962
+ {
3963
+ "properties": {
3964
+ "yesNo": {
3965
+ "enum": [
3966
+ "No"
3967
+ ]
3968
+ }
3969
+ }
3970
+ },
3971
+ {
3972
+ "properties": {
3973
+ "yesNo": {
3974
+ "enum": [
3975
+ "Yes"
3976
+ ]
3977
+ }
3978
+ }
3979
+ }
3980
+ ],
3981
+ "required": [
3982
+ "yesNo"
3983
+ ],
3984
+ "properties": {
3985
+ "yesNo": {
3986
+ "baspi5Ref": "B4.3.6"
3881
3987
  }
3882
3988
  }
3883
3989
  }
@@ -3888,7 +3994,7 @@
3888
3994
  "panelProviderLease",
3889
3995
  "lastMaintained",
3890
3996
  "inGoodWorkingOrder",
3891
- "isConnectedToNationalGrid"
3997
+ "nationalGrid"
3892
3998
  ]
3893
3999
  },
3894
4000
  {
@@ -4959,6 +5065,32 @@
4959
5065
  },
4960
5066
  "broadband": {
4961
5067
  "baspi5Ref": "A7.1.0.7",
5068
+ "discriminator": {
5069
+ "propertyName": "typeOfConnection"
5070
+ },
5071
+ "oneOf": [
5072
+ {
5073
+ "properties": {
5074
+ "typeOfConnection": {
5075
+ "enum": [
5076
+ "None"
5077
+ ]
5078
+ }
5079
+ }
5080
+ },
5081
+ {
5082
+ "properties": {
5083
+ "typeOfConnection": {
5084
+ "enum": [
5085
+ "ADSL copper wire",
5086
+ "Cable",
5087
+ "FTTC (Fibre to the Cabinet)",
5088
+ "FTTP (Fibre to the Premises)"
5089
+ ]
5090
+ }
5091
+ }
5092
+ }
5093
+ ],
4962
5094
  "properties": {
4963
5095
  "typeOfConnection": {
4964
5096
  "baspi5Ref": "A7.1.0.7.2"
@@ -5852,7 +5984,11 @@
5852
5984
  ],
5853
5985
  "properties": {
5854
5986
  "yesNo": {
5855
- "baspi5Ref": "A11.1.3.1"
5987
+ "baspi5Ref": "A11.1.3.1",
5988
+ "enum": [
5989
+ "Yes",
5990
+ "No"
5991
+ ]
5856
5992
  }
5857
5993
  }
5858
5994
  },
@@ -5893,6 +6029,9 @@
5893
6029
  }
5894
6030
  }
5895
6031
  }
6032
+ ],
6033
+ "required": [
6034
+ "riskIndicator"
5896
6035
  ]
5897
6036
  },
5898
6037
  "otherEnvironmental": {
@@ -6854,7 +6993,11 @@
6854
6993
  "baspi5Ref": "B4.1.2"
6855
6994
  },
6856
6995
  "attachments": {
6857
- "baspi5Ref": "B4.1.3"
6996
+ "baspi5Ref": "B4.1.3",
6997
+ "enum": [
6998
+ "Attached",
6999
+ "To follow"
7000
+ ]
6858
7001
  }
6859
7002
  },
6860
7003
  "required": [
@@ -6912,7 +7055,11 @@
6912
7055
  "baspi5Ref": "B4.2.3.1"
6913
7056
  },
6914
7057
  "attachments": {
6915
- "baspi5Ref": "B4.2.3.2"
7058
+ "baspi5Ref": "B4.2.3.2",
7059
+ "enum": [
7060
+ "Attached",
7061
+ "To follow"
7062
+ ]
6916
7063
  }
6917
7064
  }
6918
7065
  }
package/src/schemas/v3/overlays/extensions/jk.json CHANGED
@@ -33,6 +33,9 @@
33
33
  "required": [
34
34
  "managementPlanInPlace"
35
35
  ],
36
+ "discriminator": {
37
+ "propertyName": "managementPlanInPlace"
38
+ },
36
39
  "properties": {
37
40
  "managementPlanInPlace": {
38
41
  "ntsRef": "A5.3.2",
@@ -47,14 +50,29 @@
47
50
  "enum": [
48
51
  "Yes"
49
52
  ]
53
+ }
54
+ },
55
+ "oneOf": [
56
+ {
57
+ "properties": {
58
+ "managementPlanInPlace": {
59
+ "enum": [
60
+ "No",
61
+ "Not known"
62
+ ]
63
+ }
64
+ }
50
65
  },
51
- "attachments": {
52
- "enum": [
53
- "Attached",
54
- "To follow"
55
- ]
66
+ {
67
+ "properties": {
68
+ "managementPlanInPlace": {
69
+ "enum": [
70
+ "Yes"
71
+ ]
72
+ }
73
+ }
56
74
  }
57
- }
75
+ ]
58
76
  }
59
77
  ],
60
78
  "type": "object"
package/src/schemas/v3/overlays/extensions/pc.json ADDED
@@ -0,0 +1,36 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "parking": {
6
+ "properties": {
7
+ "controlledParking": {
8
+ "oneOf": [
9
+ null,
10
+ {
11
+ "properties": {
12
+ "costOfPermit": {
13
+ "ntsRef": "P1.1",
14
+ "type": "number"
15
+ },
16
+ "costOfPermitFrequency": {
17
+ "ntsRef": "P1.2",
18
+ "type": "string"
19
+ }
20
+ },
21
+ "required": [
22
+ "costOfPermit",
23
+ "costOfPermitFrequency"
24
+ ]
25
+ }
26
+ ]
27
+ }
28
+ }
29
+ }
30
+ }
31
+ }
32
+ },
33
+ "$schema": "http://json-schema.org/draft-07/schema#",
34
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/pc.json",
35
+ "$comment": "Parking permit cost and frequency"
36
+ }