@pdtf/schemas 3.6.0-9 → 3.6.0-dev.10

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 (85) hide show
  1. package/README.md +57 -33
  2. package/docs/branch-release-workflow.md +138 -0
  3. package/docs/sef25-extensions-ui-spec.md +355 -0
  4. package/index.js +131 -75
  5. package/package.json +14 -2
  6. package/src/schemas/v3/combined.json +7952 -1721
  7. package/src/schemas/v3/compactSkeleton.txt +379 -5
  8. package/src/schemas/v3/overlays/baspi4.json +205 -93
  9. package/src/schemas/v3/overlays/baspi5.json +210 -95
  10. package/src/schemas/v3/overlays/extensions/ac.json +334 -0
  11. package/src/schemas/v3/overlays/extensions/as.json +4 -2
  12. package/src/schemas/v3/overlays/extensions/dk.json +33 -0
  13. package/src/schemas/v3/overlays/extensions/dr.json +9 -9
  14. package/src/schemas/v3/overlays/extensions/er.json +4 -2
  15. package/src/schemas/v3/overlays/extensions/fd.json +6 -3
  16. package/src/schemas/v3/overlays/extensions/hi.json +6 -3
  17. package/src/schemas/v3/overlays/extensions/hs.json +4 -2
  18. package/src/schemas/v3/overlays/extensions/ic.json +94 -0
  19. package/src/schemas/v3/overlays/extensions/jk.json +28 -8
  20. package/src/schemas/v3/overlays/extensions/la.json +4 -2
  21. package/src/schemas/v3/overlays/extensions/lc.json +76 -0
  22. package/src/schemas/v3/overlays/extensions/ma.json +6 -3
  23. package/src/schemas/v3/overlays/extensions/mc.json +4 -2
  24. package/src/schemas/v3/overlays/extensions/mi.json +70 -0
  25. package/src/schemas/v3/overlays/extensions/nd.json +44 -0
  26. package/src/schemas/v3/overlays/extensions/oa.json +4 -2
  27. package/src/schemas/v3/overlays/extensions/oc.json +4 -2
  28. package/src/schemas/v3/overlays/extensions/pc.json +38 -0
  29. package/src/schemas/v3/overlays/extensions/ph.json +195 -0
  30. package/src/schemas/v3/overlays/extensions/rw.json +69 -0
  31. package/src/schemas/v3/overlays/extensions/sb.json +4 -2
  32. package/src/schemas/v3/overlays/extensions/sc.json +133 -0
  33. package/src/schemas/v3/overlays/extensions/sd.json +64 -0
  34. package/src/schemas/v3/overlays/extensions/sf.json +4 -2
  35. package/src/schemas/v3/overlays/extensions/sl.json +4 -2
  36. package/src/schemas/v3/overlays/extensions/ta.json +204 -0
  37. package/src/schemas/v3/overlays/extensions/tf.json +6 -3
  38. package/src/schemas/v3/overlays/extensions/tr.json +74 -0
  39. package/src/schemas/v3/overlays/extensions/wg.json +351 -0
  40. package/src/schemas/v3/overlays/fme1.json +16 -14
  41. package/src/schemas/v3/overlays/llc1.json +1 -2
  42. package/src/schemas/v3/overlays/lpe1.json +61 -31
  43. package/src/schemas/v3/overlays/nts.json +71 -2
  44. package/src/schemas/v3/overlays/nts2.json +71 -5
  45. package/src/schemas/v3/overlays/ntsl.json +71 -2
  46. package/src/schemas/v3/overlays/ntsl2.json +71 -5
  47. package/src/schemas/v3/overlays/piq.json +60 -27
  48. package/src/schemas/v3/overlays/rds.json +139 -57
  49. package/src/schemas/v3/overlays/sef25.json +1653 -0
  50. package/src/schemas/v3/overlays/ta10.json +0 -9
  51. package/src/schemas/v3/overlays/ta6.json +83 -85
  52. package/src/schemas/v3/overlays/ta6ed6.json +6641 -0
  53. package/src/schemas/v3/overlays/ta7.json +70 -6
  54. package/src/schemas/v3/overlays/ta7ed5.json +1597 -0
  55. package/src/schemas/v3/pdtf-transaction.json +4525 -1013
  56. package/src/schemas/v3/skeleton.json +512 -40
  57. package/src/utils/extractExtensionOverlays.js +302 -31
  58. package/src/utils/extractOverlay.js +114 -27
  59. package/src/utils/pathSkeleton.js +1 -1
  60. package/.claude/settings.local.json +0 -42
  61. package/.github/workflows/pages.yml +0 -50
  62. package/CNAME +0 -1
  63. package/_config.yml +0 -1
  64. package/src/examples/v1/exampleAddParticipantVouch.json +0 -32
  65. package/src/examples/v1/exampleDocumentedVouch.json +0 -40
  66. package/src/examples/v1/exampleElectronicRecord.json +0 -30
  67. package/src/examples/v1/exampleTransaction.json +0 -878
  68. package/src/examples/v1/exampleVouch.json +0 -25
  69. package/src/examples/v2/exampleTransaction.json +0 -901
  70. package/src/examples/v3/exampleAddParticipantVouch.json +0 -38
  71. package/src/examples/v3/exampleCustomOverlay.json +0 -55
  72. package/src/examples/v3/exampleCustomOverlay2.json +0 -93
  73. package/src/examples/v3/exampleDocumentedVouch.json +0 -47
  74. package/src/examples/v3/exampleElectronicRecord.json +0 -36
  75. package/src/examples/v3/exampleTransaction.json +0 -1038
  76. package/src/examples/v3/exampleVouch.json +0 -32
  77. package/src/mappings/SendPropertyDetailsRequestSchema.json +0 -1588
  78. package/src/mappings/adf.js +0 -198
  79. package/src/tests/v3/caching.test.js +0 -591
  80. package/src/tests/v3/enquiries.test.js +0 -1096
  81. package/src/tests/v3/extensionOverlays.test.js +0 -525
  82. package/src/tests/v3/offers.test.js +0 -823
  83. package/src/tests/v3/patternProperties.test.js +0 -688
  84. package/src/tests/v3/transactionSchema.test.js +0 -615
  85. package/src/tests/v3/verifiedClaimsValidator.test.js +0 -195
package/src/schemas/v3/overlays/baspi5.json CHANGED
@@ -17,16 +17,17 @@
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",
26
26
  "Mortgage Broker",
27
27
  "Lender",
28
28
  "Landlord",
29
- "Tenant"
29
+ "Tenant",
30
+ "Platform Support"
30
31
  ]
31
32
  }
32
33
  }
@@ -75,8 +76,6 @@
75
76
  "enum": [
76
77
  "Personal Representative for a Deceased Owner",
77
78
  "Under Power of Attorney",
78
- "Company Director",
79
- "Company Secretary",
80
79
  "Trustee",
81
80
  "Assistant",
82
81
  "Other"
@@ -93,6 +92,26 @@
93
92
  "sellersCapacityDetails",
94
93
  "attachments"
95
94
  ]
95
+ },
96
+ {
97
+ "properties": {
98
+ "capacity": {
99
+ "enum": [
100
+ "Company Director",
101
+ "Company Secretary"
102
+ ]
103
+ },
104
+ "sellersCapacityDetails": {
105
+ "baspi5Ref": "B1.3.2"
106
+ },
107
+ "attachments": {
108
+ "baspi5Ref": "B1.3.3"
109
+ }
110
+ },
111
+ "required": [
112
+ "sellersCapacityDetails",
113
+ "attachments"
114
+ ]
96
115
  }
97
116
  ],
98
117
  "required": [
@@ -1243,12 +1262,12 @@
1243
1262
  "Yes"
1244
1263
  ]
1245
1264
  },
1246
- "annualCostOfPermit": {
1265
+ "costOfPermit": {
1247
1266
  "baspi5Ref": "A1.6.0.2.2"
1248
1267
  }
1249
1268
  },
1250
1269
  "required": [
1251
- "annualCostOfPermit"
1270
+ "costOfPermit"
1252
1271
  ]
1253
1272
  }
1254
1273
  ],
@@ -1303,6 +1322,29 @@
1303
1322
  },
1304
1323
  "electricVehicleChargingPoint": {
1305
1324
  "baspi5Ref": "A1.6.1",
1325
+ "discriminator": {
1326
+ "propertyName": "yesNo"
1327
+ },
1328
+ "oneOf": [
1329
+ {
1330
+ "properties": {
1331
+ "yesNo": {
1332
+ "enum": [
1333
+ "No"
1334
+ ]
1335
+ }
1336
+ }
1337
+ },
1338
+ {
1339
+ "properties": {
1340
+ "yesNo": {
1341
+ "enum": [
1342
+ "Yes"
1343
+ ]
1344
+ }
1345
+ }
1346
+ }
1347
+ ],
1306
1348
  "required": [
1307
1349
  "yesNo"
1308
1350
  ],
@@ -1564,7 +1606,9 @@
1564
1606
  "properties": {
1565
1607
  "yesNo": {
1566
1608
  "enum": [
1567
- "No"
1609
+ "No",
1610
+ "Not applicable",
1611
+ "Not known"
1568
1612
  ]
1569
1613
  }
1570
1614
  }
@@ -3418,13 +3462,20 @@
3418
3462
  },
3419
3463
  "managementPlanInPlace": {
3420
3464
  "baspi5Ref": "A5.3.2"
3421
- },
3422
- "attachments": {
3423
- "baspi5Ref": "A5.3.3"
3424
3465
  }
3425
3466
  },
3426
3467
  "required": [
3427
3468
  "managementPlanInPlace"
3469
+ ],
3470
+ "oneOf": [
3471
+ null,
3472
+ {
3473
+ "properties": {
3474
+ "attachments": {
3475
+ "baspi5Ref": "A5.3.3"
3476
+ }
3477
+ }
3478
+ }
3428
3479
  ]
3429
3480
  }
3430
3481
  ],
@@ -3859,9 +3910,6 @@
3859
3910
  }
3860
3911
  }
3861
3912
  },
3862
- "isConnectedToNationalGrid": {
3863
- "baspi5Ref": "B4.3.6"
3864
- },
3865
3913
  "photovoltaicMeterPanelLocation": {
3866
3914
  "baspi5Ref": "B4.7",
3867
3915
  "properties": {
@@ -3873,14 +3921,72 @@
3873
3921
  }
3874
3922
  }
3875
3923
  },
3876
- "photovoltaicBatteriesLocation": {
3924
+ "photovoltaicBatteries": {
3877
3925
  "baspi5Ref": "B4.8",
3878
- "properties": {
3879
- "description": {
3880
- "baspi5Ref": "4.8.1"
3926
+ "discriminator": {
3927
+ "propertyName": "yesNo"
3928
+ },
3929
+ "oneOf": [
3930
+ {
3931
+ "properties": {
3932
+ "yesNo": {
3933
+ "enum": [
3934
+ "No"
3935
+ ]
3936
+ }
3937
+ }
3881
3938
  },
3882
- "attachments": {
3883
- "baspi5Ref": "4.8.2"
3939
+ {
3940
+ "properties": {
3941
+ "yesNo": {
3942
+ "enum": [
3943
+ "Yes"
3944
+ ]
3945
+ },
3946
+ "description": {
3947
+ "baspi5Ref": "4.8.1"
3948
+ },
3949
+ "attachments": {
3950
+ "baspi5Ref": "4.8.2"
3951
+ }
3952
+ },
3953
+ "required": [
3954
+ "description"
3955
+ ]
3956
+ }
3957
+ ]
3958
+ },
3959
+ "nationalGrid": {
3960
+ "baspi5Ref": "B4.3.6",
3961
+ "discriminator": {
3962
+ "propertyName": "yesNo"
3963
+ },
3964
+ "oneOf": [
3965
+ {
3966
+ "properties": {
3967
+ "yesNo": {
3968
+ "enum": [
3969
+ "No"
3970
+ ]
3971
+ }
3972
+ }
3973
+ },
3974
+ {
3975
+ "properties": {
3976
+ "yesNo": {
3977
+ "enum": [
3978
+ "Yes"
3979
+ ]
3980
+ }
3981
+ }
3982
+ }
3983
+ ],
3984
+ "required": [
3985
+ "yesNo"
3986
+ ],
3987
+ "properties": {
3988
+ "yesNo": {
3989
+ "baspi5Ref": "B4.3.6"
3884
3990
  }
3885
3991
  }
3886
3992
  }
@@ -3891,7 +3997,7 @@
3891
3997
  "panelProviderLease",
3892
3998
  "lastMaintained",
3893
3999
  "inGoodWorkingOrder",
3894
- "isConnectedToNationalGrid"
4000
+ "nationalGrid"
3895
4001
  ]
3896
4002
  },
3897
4003
  {
@@ -4783,7 +4889,8 @@
4783
4889
  "properties": {
4784
4890
  "yesNo": {
4785
4891
  "enum": [
4786
- "Yes"
4892
+ "Yes",
4893
+ "Not known"
4787
4894
  ]
4788
4895
  }
4789
4896
  }
@@ -4962,6 +5069,32 @@
4962
5069
  },
4963
5070
  "broadband": {
4964
5071
  "baspi5Ref": "A7.1.0.7",
5072
+ "discriminator": {
5073
+ "propertyName": "typeOfConnection"
5074
+ },
5075
+ "oneOf": [
5076
+ {
5077
+ "properties": {
5078
+ "typeOfConnection": {
5079
+ "enum": [
5080
+ "None"
5081
+ ]
5082
+ }
5083
+ }
5084
+ },
5085
+ {
5086
+ "properties": {
5087
+ "typeOfConnection": {
5088
+ "enum": [
5089
+ "ADSL copper wire",
5090
+ "Cable",
5091
+ "FTTC (Fibre to the Cabinet)",
5092
+ "FTTP (Fibre to the Premises)"
5093
+ ]
5094
+ }
5095
+ }
5096
+ }
5097
+ ],
4965
5098
  "properties": {
4966
5099
  "typeOfConnection": {
4967
5100
  "baspi5Ref": "A7.1.0.7.2"
@@ -5287,7 +5420,8 @@
5287
5420
  "properties": {
5288
5421
  "yesNo": {
5289
5422
  "enum": [
5290
- "No"
5423
+ "No",
5424
+ "Not applicable"
5291
5425
  ]
5292
5426
  }
5293
5427
  }
@@ -5371,7 +5505,8 @@
5371
5505
  "properties": {
5372
5506
  "yesNo": {
5373
5507
  "enum": [
5374
- "No"
5508
+ "No",
5509
+ "Not known"
5375
5510
  ]
5376
5511
  }
5377
5512
  }
@@ -5825,7 +5960,8 @@
5825
5960
  "properties": {
5826
5961
  "yesNo": {
5827
5962
  "enum": [
5828
- "No"
5963
+ "No",
5964
+ "Not known"
5829
5965
  ]
5830
5966
  }
5831
5967
  }
@@ -5855,7 +5991,11 @@
5855
5991
  ],
5856
5992
  "properties": {
5857
5993
  "yesNo": {
5858
- "baspi5Ref": "A11.1.3.1"
5994
+ "baspi5Ref": "A11.1.3.1",
5995
+ "enum": [
5996
+ "Yes",
5997
+ "No"
5998
+ ]
5859
5999
  }
5860
6000
  }
5861
6001
  },
@@ -5896,6 +6036,9 @@
5896
6036
  }
5897
6037
  }
5898
6038
  }
6039
+ ],
6040
+ "required": [
6041
+ "riskIndicator"
5899
6042
  ]
5900
6043
  },
5901
6044
  "otherEnvironmental": {
@@ -5908,8 +6051,7 @@
5908
6051
  "properties": {
5909
6052
  "riskIndicator": {
5910
6053
  "enum": [
5911
- "No",
5912
- "Not known"
6054
+ "No"
5913
6055
  ]
5914
6056
  }
5915
6057
  }
@@ -6483,77 +6625,41 @@
6483
6625
  },
6484
6626
  "ownership": {
6485
6627
  "baspi5Ref": "B2.1.0",
6486
- "discriminator": {
6487
- "propertyName": "areBoundariesUniform"
6488
- },
6489
- "oneOf": [
6490
- {
6491
- "properties": {
6492
- "areBoundariesUniform": {
6493
- "enum": [
6494
- "Yes"
6495
- ]
6496
- },
6497
- "uniformBoundaries": {
6498
- "baspi5Ref": "B2.1.0.2",
6499
- "required": [
6500
- "left",
6501
- "right",
6502
- "rear",
6503
- "front"
6504
- ],
6505
- "properties": {
6506
- "left": {
6507
- "baspi5Ref": "B2.1.1"
6508
- },
6509
- "right": {
6510
- "baspi5Ref": "B2.1.2"
6511
- },
6512
- "rear": {
6513
- "baspi5Ref": "B2.1.3"
6514
- },
6515
- "front": {
6516
- "baspi5Ref": "B2.1.4"
6517
- }
6518
- }
6519
- }
6520
- }
6521
- },
6522
- {
6523
- "properties": {
6524
- "areBoundariesUniform": {
6525
- "enum": [
6526
- "No"
6527
- ]
6528
- },
6529
- "details": {
6530
- "baspi5Ref": "B2.1.5"
6531
- },
6532
- "attachments": {
6533
- "baspi5Ref": "B2.1.6"
6534
- }
6535
- },
6536
- "required": [
6537
- "details",
6538
- "attachments"
6539
- ]
6540
- },
6541
- {
6542
- "properties": {
6543
- "areBoundariesUniform": {
6544
- "enum": [
6545
- "Not applicable"
6546
- ]
6547
- }
6548
- }
6549
- }
6550
- ],
6551
6628
  "required": [
6552
6629
  "areBoundariesUniform"
6553
6630
  ],
6554
6631
  "properties": {
6555
6632
  "areBoundariesUniform": {
6556
6633
  "baspi5Ref": "B2.1.0.1"
6634
+ },
6635
+ "uniformBoundaries": {
6636
+ "baspi5Ref": "B2.1.0.2",
6637
+ "required": [
6638
+ "left",
6639
+ "right",
6640
+ "rear",
6641
+ "front"
6642
+ ],
6643
+ "properties": {
6644
+ "left": {
6645
+ "baspi5Ref": "B2.1.1"
6646
+ },
6647
+ "right": {
6648
+ "baspi5Ref": "B2.1.2"
6649
+ },
6650
+ "rear": {
6651
+ "baspi5Ref": "B2.1.3"
6652
+ },
6653
+ "front": {
6654
+ "baspi5Ref": "B2.1.4"
6655
+ }
6656
+ }
6657
+ },
6658
+ "details": {
6659
+ "baspi5Ref": "B2.1.5"
6660
+ },
6661
+ "attachments": {
6662
+ "baspi5Ref": "B2.1.6"
6557
6663
  }
6558
6664
  }
6559
6665
  },
@@ -6650,7 +6756,8 @@
6650
6756
  "yesNo": {
6651
6757
  "enum": [
6652
6758
  "No",
6653
- "Not applicable"
6759
+ "Not applicable",
6760
+ "Not known"
6654
6761
  ]
6655
6762
  }
6656
6763
  }
@@ -6857,7 +6964,11 @@
6857
6964
  "baspi5Ref": "B4.1.2"
6858
6965
  },
6859
6966
  "attachments": {
6860
- "baspi5Ref": "B4.1.3"
6967
+ "baspi5Ref": "B4.1.3",
6968
+ "enum": [
6969
+ "Attached",
6970
+ "To follow"
6971
+ ]
6861
6972
  }
6862
6973
  },
6863
6974
  "required": [
@@ -6915,7 +7026,11 @@
6915
7026
  "baspi5Ref": "B4.2.3.1"
6916
7027
  },
6917
7028
  "attachments": {
6918
- "baspi5Ref": "B4.2.3.2"
7029
+ "baspi5Ref": "B4.2.3.2",
7030
+ "enum": [
7031
+ "Attached",
7032
+ "To follow"
7033
+ ]
6919
7034
  }
6920
7035
  }
6921
7036
  }