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

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 (71) hide show
  1. package/CLAUDE.md +101 -0
  2. package/README.md +57 -33
  3. package/docs/backend-lms-profile-filtering-spec.md +180 -0
  4. package/docs/branch-release-workflow.md +138 -0
  5. package/docs/sef25-extensions-ui-spec.md +355 -0
  6. package/index.js +134 -66
  7. package/package.json +6 -2
  8. package/src/examples/v3/exampleTransaction.json +3 -3
  9. package/src/schemas/v3/combined.json +6981 -1234
  10. package/src/schemas/v3/compactSkeleton.txt +316 -5
  11. package/src/schemas/v3/overlays/baspi4.json +162 -20
  12. package/src/schemas/v3/overlays/baspi5.json +167 -22
  13. package/src/schemas/v3/overlays/extensions/ac.json +333 -0
  14. package/src/schemas/v3/overlays/extensions/as.json +4 -2
  15. package/src/schemas/v3/overlays/extensions/dk.json +32 -0
  16. package/src/schemas/v3/overlays/extensions/dr.json +9 -9
  17. package/src/schemas/v3/overlays/extensions/er.json +4 -2
  18. package/src/schemas/v3/overlays/extensions/fd.json +6 -3
  19. package/src/schemas/v3/overlays/extensions/hi.json +6 -3
  20. package/src/schemas/v3/overlays/extensions/hs.json +4 -2
  21. package/src/schemas/v3/overlays/extensions/ic.json +59 -0
  22. package/src/schemas/v3/overlays/extensions/jk.json +28 -8
  23. package/src/schemas/v3/overlays/extensions/la.json +4 -2
  24. package/src/schemas/v3/overlays/extensions/lc.json +75 -0
  25. package/src/schemas/v3/overlays/extensions/ma.json +6 -3
  26. package/src/schemas/v3/overlays/extensions/mc.json +4 -2
  27. package/src/schemas/v3/overlays/extensions/mi.json +69 -0
  28. package/src/schemas/v3/overlays/extensions/nd.json +43 -0
  29. package/src/schemas/v3/overlays/extensions/oa.json +4 -2
  30. package/src/schemas/v3/overlays/extensions/oc.json +4 -2
  31. package/src/schemas/v3/overlays/extensions/pc.json +37 -0
  32. package/src/schemas/v3/overlays/extensions/ph.json +194 -0
  33. package/src/schemas/v3/overlays/extensions/rw.json +68 -0
  34. package/src/schemas/v3/overlays/extensions/sb.json +4 -2
  35. package/src/schemas/v3/overlays/extensions/sc.json +129 -0
  36. package/src/schemas/v3/overlays/extensions/sd.json +63 -0
  37. package/src/schemas/v3/overlays/extensions/sf.json +4 -2
  38. package/src/schemas/v3/overlays/extensions/sl.json +4 -2
  39. package/src/schemas/v3/overlays/extensions/ta.json +252 -0
  40. package/src/schemas/v3/overlays/extensions/tf.json +6 -3
  41. package/src/schemas/v3/overlays/extensions/tr.json +73 -0
  42. package/src/schemas/v3/overlays/extensions/wg.json +350 -0
  43. package/src/schemas/v3/overlays/fme1.json +16 -14
  44. package/src/schemas/v3/overlays/lpe1.json +60 -30
  45. package/src/schemas/v3/overlays/nts.json +68 -1
  46. package/src/schemas/v3/overlays/nts2.json +68 -4
  47. package/src/schemas/v3/overlays/ntsl.json +68 -1
  48. package/src/schemas/v3/overlays/ntsl2.json +68 -4
  49. package/src/schemas/v3/overlays/piq.json +37 -3
  50. package/src/schemas/v3/overlays/rds.json +117 -8
  51. package/src/schemas/v3/overlays/sef25.json +1639 -0
  52. package/src/schemas/v3/overlays/ta6.json +46 -16
  53. package/src/schemas/v3/overlays/ta6ed6.json +6533 -0
  54. package/src/schemas/v3/overlays/ta7.json +70 -6
  55. package/src/schemas/v3/overlays/ta7ed5.json +1551 -0
  56. package/src/schemas/v3/pdtf-transaction.json +3896 -686
  57. package/src/schemas/v3/skeleton.json +442 -35
  58. package/src/utils/extractExtensionOverlays.js +293 -31
  59. package/src/utils/extractOverlay.js +94 -27
  60. package/src/utils/pathSkeleton.js +1 -1
  61. package/.claude/settings.local.json +0 -42
  62. package/.github/workflows/pages.yml +0 -50
  63. package/CNAME +0 -1
  64. package/_config.yml +0 -1
  65. package/src/tests/v3/caching.test.js +0 -591
  66. package/src/tests/v3/enquiries.test.js +0 -1096
  67. package/src/tests/v3/extensionOverlays.test.js +0 -525
  68. package/src/tests/v3/offers.test.js +0 -823
  69. package/src/tests/v3/patternProperties.test.js +0 -565
  70. package/src/tests/v3/transactionSchema.test.js +0 -615
  71. package/src/tests/v3/verifiedClaimsValidator.test.js +0 -195
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,8 +75,6 @@
75
75
  "enum": [
76
76
  "Personal Representative for a Deceased Owner",
77
77
  "Under Power of Attorney",
78
- "Company Director",
79
- "Company Secretary",
80
78
  "Trustee",
81
79
  "Assistant",
82
80
  "Other"
@@ -93,6 +91,26 @@
93
91
  "sellersCapacityDetails",
94
92
  "attachments"
95
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
+ ]
96
114
  }
97
115
  ],
98
116
  "required": [
@@ -1155,6 +1173,29 @@
1155
1173
  },
1156
1174
  "electricVehicleChargingPoint": {
1157
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
+ ],
1158
1199
  "required": [
1159
1200
  "yesNo"
1160
1201
  ],
@@ -3267,13 +3308,20 @@
3267
3308
  },
3268
3309
  "managementPlanInPlace": {
3269
3310
  "baspi4Ref": "A5.3.2"
3270
- },
3271
- "attachments": {
3272
- "baspi4Ref": "A5.3.3"
3273
3311
  }
3274
3312
  },
3275
3313
  "required": [
3276
3314
  "managementPlanInPlace"
3315
+ ],
3316
+ "oneOf": [
3317
+ null,
3318
+ {
3319
+ "properties": {
3320
+ "attachments": {
3321
+ "baspi4Ref": "A5.3.3"
3322
+ }
3323
+ }
3324
+ }
3277
3325
  ]
3278
3326
  }
3279
3327
  ],
@@ -3708,9 +3756,6 @@
3708
3756
  }
3709
3757
  }
3710
3758
  },
3711
- "isConnectedToNationalGrid": {
3712
- "baspi4Ref": "B4.3.6"
3713
- },
3714
3759
  "photovoltaicMeterPanelLocation": {
3715
3760
  "baspi4Ref": "B4.7",
3716
3761
  "properties": {
@@ -3722,14 +3767,72 @@
3722
3767
  }
3723
3768
  }
3724
3769
  },
3725
- "photovoltaicBatteriesLocation": {
3770
+ "photovoltaicBatteries": {
3726
3771
  "baspi4Ref": "B4.8",
3727
- "properties": {
3728
- "description": {
3729
- "baspi4Ref": "4.8.1"
3772
+ "discriminator": {
3773
+ "propertyName": "yesNo"
3774
+ },
3775
+ "oneOf": [
3776
+ {
3777
+ "properties": {
3778
+ "yesNo": {
3779
+ "enum": [
3780
+ "No"
3781
+ ]
3782
+ }
3783
+ }
3730
3784
  },
3731
- "attachments": {
3732
- "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"
3733
3836
  }
3734
3837
  }
3735
3838
  }
@@ -3740,7 +3843,7 @@
3740
3843
  "panelProviderLease",
3741
3844
  "lastMaintained",
3742
3845
  "inGoodWorkingOrder",
3743
- "isConnectedToNationalGrid"
3846
+ "nationalGrid"
3744
3847
  ]
3745
3848
  },
3746
3849
  {
@@ -4811,6 +4914,32 @@
4811
4914
  },
4812
4915
  "broadband": {
4813
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
+ ],
4814
4943
  "properties": {
4815
4944
  "typeOfConnection": {
4816
4945
  "baspi4Ref": "A7.1.0.7.2"
@@ -5673,7 +5802,8 @@
5673
5802
  "properties": {
5674
5803
  "yesNo": {
5675
5804
  "enum": [
5676
- "No"
5805
+ "No",
5806
+ "Not known"
5677
5807
  ]
5678
5808
  }
5679
5809
  }
@@ -5703,7 +5833,11 @@
5703
5833
  ],
5704
5834
  "properties": {
5705
5835
  "yesNo": {
5706
- "baspi4Ref": "A11.1.3.1"
5836
+ "baspi4Ref": "A11.1.3.1",
5837
+ "enum": [
5838
+ "Yes",
5839
+ "No"
5840
+ ]
5707
5841
  }
5708
5842
  }
5709
5843
  },
@@ -6710,7 +6844,11 @@
6710
6844
  "baspi4Ref": "B4.1.2"
6711
6845
  },
6712
6846
  "attachments": {
6713
- "baspi4Ref": "B4.1.3"
6847
+ "baspi4Ref": "B4.1.3",
6848
+ "enum": [
6849
+ "Attached",
6850
+ "To follow"
6851
+ ]
6714
6852
  }
6715
6853
  },
6716
6854
  "required": [
@@ -6768,7 +6906,11 @@
6768
6906
  "baspi4Ref": "B4.2.3.1"
6769
6907
  },
6770
6908
  "attachments": {
6771
- "baspi4Ref": "B4.2.3.2"
6909
+ "baspi4Ref": "B4.2.3.2",
6910
+ "enum": [
6911
+ "Attached",
6912
+ "To follow"
6913
+ ]
6772
6914
  }
6773
6915
  }
6774
6916
  }
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,8 +75,6 @@
75
75
  "enum": [
76
76
  "Personal Representative for a Deceased Owner",
77
77
  "Under Power of Attorney",
78
- "Company Director",
79
- "Company Secretary",
80
78
  "Trustee",
81
79
  "Assistant",
82
80
  "Other"
@@ -93,6 +91,26 @@
93
91
  "sellersCapacityDetails",
94
92
  "attachments"
95
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
+ ]
96
114
  }
97
115
  ],
98
116
  "required": [
@@ -1243,12 +1261,12 @@
1243
1261
  "Yes"
1244
1262
  ]
1245
1263
  },
1246
- "annualCostOfPermit": {
1264
+ "costOfPermit": {
1247
1265
  "baspi5Ref": "A1.6.0.2.2"
1248
1266
  }
1249
1267
  },
1250
1268
  "required": [
1251
- "annualCostOfPermit"
1269
+ "costOfPermit"
1252
1270
  ]
1253
1271
  }
1254
1272
  ],
@@ -1303,6 +1321,29 @@
1303
1321
  },
1304
1322
  "electricVehicleChargingPoint": {
1305
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
+ ],
1306
1347
  "required": [
1307
1348
  "yesNo"
1308
1349
  ],
@@ -3418,13 +3459,20 @@
3418
3459
  },
3419
3460
  "managementPlanInPlace": {
3420
3461
  "baspi5Ref": "A5.3.2"
3421
- },
3422
- "attachments": {
3423
- "baspi5Ref": "A5.3.3"
3424
3462
  }
3425
3463
  },
3426
3464
  "required": [
3427
3465
  "managementPlanInPlace"
3466
+ ],
3467
+ "oneOf": [
3468
+ null,
3469
+ {
3470
+ "properties": {
3471
+ "attachments": {
3472
+ "baspi5Ref": "A5.3.3"
3473
+ }
3474
+ }
3475
+ }
3428
3476
  ]
3429
3477
  }
3430
3478
  ],
@@ -3859,9 +3907,6 @@
3859
3907
  }
3860
3908
  }
3861
3909
  },
3862
- "isConnectedToNationalGrid": {
3863
- "baspi5Ref": "B4.3.6"
3864
- },
3865
3910
  "photovoltaicMeterPanelLocation": {
3866
3911
  "baspi5Ref": "B4.7",
3867
3912
  "properties": {
@@ -3873,14 +3918,72 @@
3873
3918
  }
3874
3919
  }
3875
3920
  },
3876
- "photovoltaicBatteriesLocation": {
3921
+ "photovoltaicBatteries": {
3877
3922
  "baspi5Ref": "B4.8",
3878
- "properties": {
3879
- "description": {
3880
- "baspi5Ref": "4.8.1"
3923
+ "discriminator": {
3924
+ "propertyName": "yesNo"
3925
+ },
3926
+ "oneOf": [
3927
+ {
3928
+ "properties": {
3929
+ "yesNo": {
3930
+ "enum": [
3931
+ "No"
3932
+ ]
3933
+ }
3934
+ }
3881
3935
  },
3882
- "attachments": {
3883
- "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"
3884
3987
  }
3885
3988
  }
3886
3989
  }
@@ -3891,7 +3994,7 @@
3891
3994
  "panelProviderLease",
3892
3995
  "lastMaintained",
3893
3996
  "inGoodWorkingOrder",
3894
- "isConnectedToNationalGrid"
3997
+ "nationalGrid"
3895
3998
  ]
3896
3999
  },
3897
4000
  {
@@ -4962,6 +5065,32 @@
4962
5065
  },
4963
5066
  "broadband": {
4964
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
+ ],
4965
5094
  "properties": {
4966
5095
  "typeOfConnection": {
4967
5096
  "baspi5Ref": "A7.1.0.7.2"
@@ -5825,7 +5954,8 @@
5825
5954
  "properties": {
5826
5955
  "yesNo": {
5827
5956
  "enum": [
5828
- "No"
5957
+ "No",
5958
+ "Not known"
5829
5959
  ]
5830
5960
  }
5831
5961
  }
@@ -5855,7 +5985,11 @@
5855
5985
  ],
5856
5986
  "properties": {
5857
5987
  "yesNo": {
5858
- "baspi5Ref": "A11.1.3.1"
5988
+ "baspi5Ref": "A11.1.3.1",
5989
+ "enum": [
5990
+ "Yes",
5991
+ "No"
5992
+ ]
5859
5993
  }
5860
5994
  }
5861
5995
  },
@@ -5896,6 +6030,9 @@
5896
6030
  }
5897
6031
  }
5898
6032
  }
6033
+ ],
6034
+ "required": [
6035
+ "riskIndicator"
5899
6036
  ]
5900
6037
  },
5901
6038
  "otherEnvironmental": {
@@ -6857,7 +6994,11 @@
6857
6994
  "baspi5Ref": "B4.1.2"
6858
6995
  },
6859
6996
  "attachments": {
6860
- "baspi5Ref": "B4.1.3"
6997
+ "baspi5Ref": "B4.1.3",
6998
+ "enum": [
6999
+ "Attached",
7000
+ "To follow"
7001
+ ]
6861
7002
  }
6862
7003
  },
6863
7004
  "required": [
@@ -6915,7 +7056,11 @@
6915
7056
  "baspi5Ref": "B4.2.3.1"
6916
7057
  },
6917
7058
  "attachments": {
6918
- "baspi5Ref": "B4.2.3.2"
7059
+ "baspi5Ref": "B4.2.3.2",
7060
+ "enum": [
7061
+ "Attached",
7062
+ "To follow"
7063
+ ]
6919
7064
  }
6920
7065
  }
6921
7066
  }