@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/baspi4.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
+ "baspi4Ref": "B1.3.2"
106
+ },
107
+ "attachments": {
108
+ "baspi4Ref": "B1.3.3"
109
+ }
110
+ },
111
+ "required": [
112
+ "sellersCapacityDetails",
113
+ "attachments"
114
+ ]
96
115
  }
97
116
  ],
98
117
  "required": [
@@ -1155,6 +1174,29 @@
1155
1174
  },
1156
1175
  "electricVehicleChargingPoint": {
1157
1176
  "baspi4Ref": "A1.6.1",
1177
+ "discriminator": {
1178
+ "propertyName": "yesNo"
1179
+ },
1180
+ "oneOf": [
1181
+ {
1182
+ "properties": {
1183
+ "yesNo": {
1184
+ "enum": [
1185
+ "No"
1186
+ ]
1187
+ }
1188
+ }
1189
+ },
1190
+ {
1191
+ "properties": {
1192
+ "yesNo": {
1193
+ "enum": [
1194
+ "Yes"
1195
+ ]
1196
+ }
1197
+ }
1198
+ }
1199
+ ],
1158
1200
  "required": [
1159
1201
  "yesNo"
1160
1202
  ],
@@ -1416,7 +1458,9 @@
1416
1458
  "properties": {
1417
1459
  "yesNo": {
1418
1460
  "enum": [
1419
- "No"
1461
+ "No",
1462
+ "Not applicable",
1463
+ "Not known"
1420
1464
  ]
1421
1465
  }
1422
1466
  }
@@ -3267,13 +3311,20 @@
3267
3311
  },
3268
3312
  "managementPlanInPlace": {
3269
3313
  "baspi4Ref": "A5.3.2"
3270
- },
3271
- "attachments": {
3272
- "baspi4Ref": "A5.3.3"
3273
3314
  }
3274
3315
  },
3275
3316
  "required": [
3276
3317
  "managementPlanInPlace"
3318
+ ],
3319
+ "oneOf": [
3320
+ null,
3321
+ {
3322
+ "properties": {
3323
+ "attachments": {
3324
+ "baspi4Ref": "A5.3.3"
3325
+ }
3326
+ }
3327
+ }
3277
3328
  ]
3278
3329
  }
3279
3330
  ],
@@ -3708,9 +3759,6 @@
3708
3759
  }
3709
3760
  }
3710
3761
  },
3711
- "isConnectedToNationalGrid": {
3712
- "baspi4Ref": "B4.3.6"
3713
- },
3714
3762
  "photovoltaicMeterPanelLocation": {
3715
3763
  "baspi4Ref": "B4.7",
3716
3764
  "properties": {
@@ -3722,14 +3770,72 @@
3722
3770
  }
3723
3771
  }
3724
3772
  },
3725
- "photovoltaicBatteriesLocation": {
3773
+ "photovoltaicBatteries": {
3726
3774
  "baspi4Ref": "B4.8",
3727
- "properties": {
3728
- "description": {
3729
- "baspi4Ref": "4.8.1"
3775
+ "discriminator": {
3776
+ "propertyName": "yesNo"
3777
+ },
3778
+ "oneOf": [
3779
+ {
3780
+ "properties": {
3781
+ "yesNo": {
3782
+ "enum": [
3783
+ "No"
3784
+ ]
3785
+ }
3786
+ }
3730
3787
  },
3731
- "attachments": {
3732
- "baspi4Ref": "4.8.2"
3788
+ {
3789
+ "properties": {
3790
+ "yesNo": {
3791
+ "enum": [
3792
+ "Yes"
3793
+ ]
3794
+ },
3795
+ "description": {
3796
+ "baspi4Ref": "4.8.1"
3797
+ },
3798
+ "attachments": {
3799
+ "baspi4Ref": "4.8.2"
3800
+ }
3801
+ },
3802
+ "required": [
3803
+ "description"
3804
+ ]
3805
+ }
3806
+ ]
3807
+ },
3808
+ "nationalGrid": {
3809
+ "baspi4Ref": "B4.3.6",
3810
+ "discriminator": {
3811
+ "propertyName": "yesNo"
3812
+ },
3813
+ "oneOf": [
3814
+ {
3815
+ "properties": {
3816
+ "yesNo": {
3817
+ "enum": [
3818
+ "No"
3819
+ ]
3820
+ }
3821
+ }
3822
+ },
3823
+ {
3824
+ "properties": {
3825
+ "yesNo": {
3826
+ "enum": [
3827
+ "Yes"
3828
+ ]
3829
+ }
3830
+ }
3831
+ }
3832
+ ],
3833
+ "required": [
3834
+ "yesNo"
3835
+ ],
3836
+ "properties": {
3837
+ "yesNo": {
3838
+ "baspi4Ref": "B4.3.6"
3733
3839
  }
3734
3840
  }
3735
3841
  }
@@ -3740,7 +3846,7 @@
3740
3846
  "panelProviderLease",
3741
3847
  "lastMaintained",
3742
3848
  "inGoodWorkingOrder",
3743
- "isConnectedToNationalGrid"
3849
+ "nationalGrid"
3744
3850
  ]
3745
3851
  },
3746
3852
  {
@@ -4632,7 +4738,8 @@
4632
4738
  "properties": {
4633
4739
  "yesNo": {
4634
4740
  "enum": [
4635
- "Yes"
4741
+ "Yes",
4742
+ "Not known"
4636
4743
  ]
4637
4744
  }
4638
4745
  }
@@ -4811,6 +4918,32 @@
4811
4918
  },
4812
4919
  "broadband": {
4813
4920
  "baspi4Ref": "A7.1.0.7",
4921
+ "discriminator": {
4922
+ "propertyName": "typeOfConnection"
4923
+ },
4924
+ "oneOf": [
4925
+ {
4926
+ "properties": {
4927
+ "typeOfConnection": {
4928
+ "enum": [
4929
+ "None"
4930
+ ]
4931
+ }
4932
+ }
4933
+ },
4934
+ {
4935
+ "properties": {
4936
+ "typeOfConnection": {
4937
+ "enum": [
4938
+ "ADSL copper wire",
4939
+ "Cable",
4940
+ "FTTC (Fibre to the Cabinet)",
4941
+ "FTTP (Fibre to the Premises)"
4942
+ ]
4943
+ }
4944
+ }
4945
+ }
4946
+ ],
4814
4947
  "properties": {
4815
4948
  "typeOfConnection": {
4816
4949
  "baspi4Ref": "A7.1.0.7.2"
@@ -5136,7 +5269,8 @@
5136
5269
  "properties": {
5137
5270
  "yesNo": {
5138
5271
  "enum": [
5139
- "No"
5272
+ "No",
5273
+ "Not applicable"
5140
5274
  ]
5141
5275
  }
5142
5276
  }
@@ -5220,7 +5354,8 @@
5220
5354
  "properties": {
5221
5355
  "yesNo": {
5222
5356
  "enum": [
5223
- "No"
5357
+ "No",
5358
+ "Not known"
5224
5359
  ]
5225
5360
  }
5226
5361
  }
@@ -5673,7 +5808,8 @@
5673
5808
  "properties": {
5674
5809
  "yesNo": {
5675
5810
  "enum": [
5676
- "No"
5811
+ "No",
5812
+ "Not known"
5677
5813
  ]
5678
5814
  }
5679
5815
  }
@@ -5703,7 +5839,11 @@
5703
5839
  ],
5704
5840
  "properties": {
5705
5841
  "yesNo": {
5706
- "baspi4Ref": "A11.1.3.1"
5842
+ "baspi4Ref": "A11.1.3.1",
5843
+ "enum": [
5844
+ "Yes",
5845
+ "No"
5846
+ ]
5707
5847
  }
5708
5848
  }
5709
5849
  },
@@ -5730,8 +5870,7 @@
5730
5870
  "properties": {
5731
5871
  "riskIndicator": {
5732
5872
  "enum": [
5733
- "No",
5734
- "Not known"
5873
+ "No"
5735
5874
  ]
5736
5875
  }
5737
5876
  }
@@ -6336,77 +6475,41 @@
6336
6475
  },
6337
6476
  "ownership": {
6338
6477
  "baspi4Ref": "B2.1.0",
6339
- "discriminator": {
6340
- "propertyName": "areBoundariesUniform"
6341
- },
6342
- "oneOf": [
6343
- {
6344
- "properties": {
6345
- "areBoundariesUniform": {
6346
- "enum": [
6347
- "Yes"
6348
- ]
6349
- },
6350
- "uniformBoundaries": {
6351
- "baspi4Ref": "B2.1.0.2",
6352
- "required": [
6353
- "left",
6354
- "right",
6355
- "rear",
6356
- "front"
6357
- ],
6358
- "properties": {
6359
- "left": {
6360
- "baspi4Ref": "B2.1.1"
6361
- },
6362
- "right": {
6363
- "baspi4Ref": "B2.1.2"
6364
- },
6365
- "rear": {
6366
- "baspi4Ref": "B2.1.3"
6367
- },
6368
- "front": {
6369
- "baspi4Ref": "B2.1.4"
6370
- }
6371
- }
6372
- }
6373
- }
6374
- },
6375
- {
6376
- "properties": {
6377
- "areBoundariesUniform": {
6378
- "enum": [
6379
- "No"
6380
- ]
6381
- },
6382
- "details": {
6383
- "baspi4Ref": "B2.1.5"
6384
- },
6385
- "attachments": {
6386
- "baspi4Ref": "B2.1.6"
6387
- }
6388
- },
6389
- "required": [
6390
- "details",
6391
- "attachments"
6392
- ]
6393
- },
6394
- {
6395
- "properties": {
6396
- "areBoundariesUniform": {
6397
- "enum": [
6398
- "Not applicable"
6399
- ]
6400
- }
6401
- }
6402
- }
6403
- ],
6404
6478
  "required": [
6405
6479
  "areBoundariesUniform"
6406
6480
  ],
6407
6481
  "properties": {
6408
6482
  "areBoundariesUniform": {
6409
6483
  "baspi4Ref": "B2.1.0.1"
6484
+ },
6485
+ "uniformBoundaries": {
6486
+ "baspi4Ref": "B2.1.0.2",
6487
+ "required": [
6488
+ "left",
6489
+ "right",
6490
+ "rear",
6491
+ "front"
6492
+ ],
6493
+ "properties": {
6494
+ "left": {
6495
+ "baspi4Ref": "B2.1.1"
6496
+ },
6497
+ "right": {
6498
+ "baspi4Ref": "B2.1.2"
6499
+ },
6500
+ "rear": {
6501
+ "baspi4Ref": "B2.1.3"
6502
+ },
6503
+ "front": {
6504
+ "baspi4Ref": "B2.1.4"
6505
+ }
6506
+ }
6507
+ },
6508
+ "details": {
6509
+ "baspi4Ref": "B2.1.5"
6510
+ },
6511
+ "attachments": {
6512
+ "baspi4Ref": "B2.1.6"
6410
6513
  }
6411
6514
  }
6412
6515
  },
@@ -6503,7 +6606,8 @@
6503
6606
  "yesNo": {
6504
6607
  "enum": [
6505
6608
  "No",
6506
- "Not applicable"
6609
+ "Not applicable",
6610
+ "Not known"
6507
6611
  ]
6508
6612
  }
6509
6613
  }
@@ -6710,7 +6814,11 @@
6710
6814
  "baspi4Ref": "B4.1.2"
6711
6815
  },
6712
6816
  "attachments": {
6713
- "baspi4Ref": "B4.1.3"
6817
+ "baspi4Ref": "B4.1.3",
6818
+ "enum": [
6819
+ "Attached",
6820
+ "To follow"
6821
+ ]
6714
6822
  }
6715
6823
  },
6716
6824
  "required": [
@@ -6768,7 +6876,11 @@
6768
6876
  "baspi4Ref": "B4.2.3.1"
6769
6877
  },
6770
6878
  "attachments": {
6771
- "baspi4Ref": "B4.2.3.2"
6879
+ "baspi4Ref": "B4.2.3.2",
6880
+ "enum": [
6881
+ "Attached",
6882
+ "To follow"
6883
+ ]
6772
6884
  }
6773
6885
  }
6774
6886
  }