@pdtf/schemas 3.0.0-1 → 3.0.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 (33) hide show
  1. package/index.js +15 -13
  2. package/package.json +1 -1
  3. package/src/examples/v3/exampleTransaction.json +23 -22
  4. package/src/schemas/v2/overlays/baspi.json +510 -2331
  5. package/src/schemas/v2/overlays/con29DW.json +36 -125
  6. package/src/schemas/v2/overlays/con29R.json +5 -143
  7. package/src/schemas/v2/overlays/fme1.json +48 -233
  8. package/src/schemas/v2/overlays/lpe1.json +75 -367
  9. package/src/schemas/v2/overlays/nts.json +17 -103
  10. package/src/schemas/v2/overlays/piq.json +146 -693
  11. package/src/schemas/v2/overlays/rds.json +50 -316
  12. package/src/schemas/v2/overlays/ta10.json +540 -1755
  13. package/src/schemas/v2/overlays/ta6.json +241 -1193
  14. package/src/schemas/v2/overlays/ta7.json +106 -440
  15. package/src/schemas/v3/combined.json +762 -683
  16. package/src/schemas/v3/overlays/baspi.json +662 -2571
  17. package/src/schemas/v3/overlays/con29DW.json +46 -127
  18. package/src/schemas/v3/overlays/con29R.json +5 -143
  19. package/src/schemas/v3/overlays/fme1.json +53 -233
  20. package/src/schemas/v3/overlays/lpe1.json +85 -367
  21. package/src/schemas/v3/overlays/nts.json +493 -475
  22. package/src/schemas/v3/overlays/piq.json +225 -827
  23. package/src/schemas/v3/overlays/rds.json +172 -541
  24. package/src/schemas/v3/overlays/ta10.json +540 -1755
  25. package/src/schemas/v3/overlays/ta6.json +346 -1271
  26. package/src/schemas/v3/overlays/ta7.json +220 -462
  27. package/src/schemas/v3/pdtf-transaction.json +628 -600
  28. package/src/schemas/v3/skeleton.json +92 -67
  29. package/src/tests/v3/transactionSchema.test.js +27 -17
  30. package/src/tests/v3/verifiedClaimsValidator.test.js +2 -2
  31. package/src/utils/extractOverlay.js +5 -27
  32. package/src/tests/v2/transactionSchema.test.js +0 -361
  33. package/src/tests/v2/verifiedClaimsValidator.test.js +0 -128
package/src/schemas/v3/overlays/con29DW.json CHANGED
@@ -8,8 +8,6 @@
8
8
  "properties": {
9
9
  "waterAndDrainage": {
10
10
  "con29DWRef": "0",
11
- "title": "Water and Drainage",
12
- "description": "Please describe the water and drainage services that are connected to the property.",
13
11
  "required": [
14
12
  "maps",
15
13
  "water",
@@ -19,25 +17,21 @@
19
17
  "properties": {
20
18
  "maps": {
21
19
  "con29DWRef": "1",
22
- "title": "Maps",
23
20
  "required": [
24
21
  "publicSewerMapAttached",
25
22
  "waterworksMapAttached"
26
23
  ],
27
24
  "properties": {
28
25
  "publicSewerMapAttached": {
29
- "con29DWRef": "1.1",
30
- "title": "Where relevant, please include a copy of an extract from the public sewer map."
26
+ "con29DWRef": "1.1"
31
27
  },
32
28
  "waterworksMapAttached": {
33
- "con29DWRef": "1.2",
34
- "title": "Where relevant, please include a copy of an extract from the map of waterworks."
29
+ "con29DWRef": "1.2"
35
30
  }
36
31
  }
37
32
  },
38
33
  "water": {
39
34
  "con29DWRef": "3",
40
- "title": "Water",
41
35
  "required": [
42
36
  "mainsWater",
43
37
  "waterMainsWithinBoundaries",
@@ -49,7 +43,6 @@
49
43
  "properties": {
50
44
  "mainsWater": {
51
45
  "con29DWRef": "3.1",
52
- "title": "Mains water",
53
46
  "discriminator": {
54
47
  "propertyName": "yesNo"
55
48
  },
@@ -71,8 +64,7 @@
71
64
  ]
72
65
  },
73
66
  "details": {
74
- "con29DWRef": "3.1.2",
75
- "title": "Details"
67
+ "con29DWRef": "3.1.2"
76
68
  }
77
69
  },
78
70
  "required": [
@@ -104,7 +96,6 @@
104
96
  },
105
97
  "waterMainsWithinBoundaries": {
106
98
  "con29DWRef": "3.2",
107
- "title": "Are there any water mains, resource mains or discharge pipes within the boundaries of the property?",
108
99
  "discriminator": {
109
100
  "propertyName": "yesNo"
110
101
  },
@@ -126,8 +117,7 @@
126
117
  ]
127
118
  },
128
119
  "details": {
129
- "con29DWRef": "3.2.2",
130
- "title": "Details"
120
+ "con29DWRef": "3.2.2"
131
121
  }
132
122
  },
133
123
  "required": [
@@ -140,17 +130,12 @@
140
130
  ],
141
131
  "properties": {
142
132
  "yesNo": {
143
- "con29DWRef": "3.2.1",
144
- "enum": [
145
- "Yes",
146
- "No"
147
- ]
133
+ "con29DWRef": "3.2.1"
148
134
  }
149
135
  }
150
136
  },
151
137
  "waterMainsSubjectOfAdoptionAgreement": {
152
138
  "con29DWRef": "3.3",
153
- "title": "Is any water main or service pipe serving or which is proposed to serve the property, the subject of an existing adoption agreement or an application for such an agreement?",
154
139
  "discriminator": {
155
140
  "propertyName": "yesNo"
156
141
  },
@@ -172,8 +157,7 @@
172
157
  ]
173
158
  },
174
159
  "details": {
175
- "con29DWRef": "3.3.2",
176
- "title": "Details"
160
+ "con29DWRef": "3.3.2"
177
161
  }
178
162
  },
179
163
  "required": [
@@ -186,17 +170,12 @@
186
170
  ],
187
171
  "properties": {
188
172
  "yesNo": {
189
- "con29DWRef": "3.3.1",
190
- "enum": [
191
- "Yes",
192
- "No"
193
- ]
173
+ "con29DWRef": "3.3.1"
194
174
  }
195
175
  }
196
176
  },
197
177
  "lowWaterPressureRisk": {
198
178
  "con29DWRef": "3.4",
199
- "title": "Is the property at risk of receiving low water pressure or flow?",
200
179
  "discriminator": {
201
180
  "propertyName": "yesNo"
202
181
  },
@@ -218,8 +197,7 @@
218
197
  ]
219
198
  },
220
199
  "details": {
221
- "con29DWRef": "3.4.2",
222
- "title": "Details"
200
+ "con29DWRef": "3.4.2"
223
201
  }
224
202
  },
225
203
  "required": [
@@ -232,27 +210,20 @@
232
210
  ],
233
211
  "properties": {
234
212
  "yesNo": {
235
- "con29DWRef": "3.4.1",
236
- "enum": [
237
- "Yes",
238
- "No"
239
- ]
213
+ "con29DWRef": "3.4.1"
240
214
  }
241
215
  }
242
216
  },
243
217
  "supplyClassification": {
244
- "con29DWRef": "3.5",
245
- "title": "What is the classification of the water supply for the property?"
218
+ "con29DWRef": "3.5"
246
219
  },
247
220
  "waterMeterLocation": {
248
- "con29DWRef": "3.6",
249
- "title": "Please include details of the location of any water meter serving the property."
221
+ "con29DWRef": "3.6"
250
222
  }
251
223
  }
252
224
  },
253
225
  "drainage": {
254
226
  "con29DWRef": "2",
255
- "title": "Drainage",
256
227
  "required": [
257
228
  "mainsSurfaceWaterDrainage",
258
229
  "mainsFoulDrainage",
@@ -269,7 +240,6 @@
269
240
  "properties": {
270
241
  "mainsSurfaceWaterDrainage": {
271
242
  "con29DWRef": "2.2",
272
- "title": "Mains surface water drainage",
273
243
  "discriminator": {
274
244
  "propertyName": "yesNo"
275
245
  },
@@ -292,8 +262,7 @@
292
262
  ]
293
263
  },
294
264
  "details": {
295
- "con29DWRef": "2.2.2",
296
- "title": "Details"
265
+ "con29DWRef": "2.2.2"
297
266
  }
298
267
  },
299
268
  "required": [
@@ -322,7 +291,6 @@
322
291
  },
323
292
  "mainsFoulDrainage": {
324
293
  "con29DWRef": "2.1",
325
- "title": "Mains foul drainage / sweerage",
326
294
  "discriminator": {
327
295
  "propertyName": "yesNo"
328
296
  },
@@ -335,14 +303,22 @@
335
303
  ]
336
304
  },
337
305
  "details": {
338
- "con29DWRef": "2.1.2",
339
- "title": "Details"
306
+ "con29DWRef": "2.1.2"
340
307
  }
341
308
  },
342
309
  "required": [
343
310
  "details"
344
311
  ]
345
312
  },
313
+ {
314
+ "properties": {
315
+ "yesNo": {
316
+ "enum": [
317
+ "Not known"
318
+ ]
319
+ }
320
+ }
321
+ },
346
322
  {
347
323
  "properties": {
348
324
  "yesNo": {
@@ -356,8 +332,7 @@
356
332
  "properties": {
357
333
  "yesNo": {
358
334
  "enum": [
359
- "No",
360
- "Not known"
335
+ "No"
361
336
  ]
362
337
  }
363
338
  }
@@ -374,7 +349,6 @@
374
349
  },
375
350
  "surfaceDrainageCharge": {
376
351
  "con29DWRef": "2.3",
377
- "title": "Is a surface water drainage charge payable?",
378
352
  "discriminator": {
379
353
  "propertyName": "yesNo"
380
354
  },
@@ -396,8 +370,7 @@
396
370
  ]
397
371
  },
398
372
  "details": {
399
- "con29DWRef": "2.3.2",
400
- "title": "Details"
373
+ "con29DWRef": "2.3.2"
401
374
  }
402
375
  },
403
376
  "required": [
@@ -410,17 +383,12 @@
410
383
  ],
411
384
  "properties": {
412
385
  "yesNo": {
413
- "con29DWRef": "2.3.1",
414
- "enum": [
415
- "Yes",
416
- "No"
417
- ]
386
+ "con29DWRef": "2.3.1"
418
387
  }
419
388
  }
420
389
  },
421
390
  "publicDrainWithinBoundaries": {
422
391
  "con29DWRef": "2.4",
423
- "title": "Does the public sewer map indicate any public sewer, disposal main or lateral drain within the boundaries of the property?",
424
392
  "discriminator": {
425
393
  "propertyName": "yesNo"
426
394
  },
@@ -442,8 +410,7 @@
442
410
  ]
443
411
  },
444
412
  "details": {
445
- "con29DWRef": "2.4.0.2",
446
- "title": "Details"
413
+ "con29DWRef": "2.4.0.2"
447
414
  }
448
415
  },
449
416
  "required": [
@@ -456,17 +423,12 @@
456
423
  ],
457
424
  "properties": {
458
425
  "yesNo": {
459
- "con29DWRef": "2.4.0.1",
460
- "enum": [
461
- "Yes",
462
- "No"
463
- ]
426
+ "con29DWRef": "2.4.0.1"
464
427
  }
465
428
  }
466
429
  },
467
430
  "publicPumpingStationWithinBoundaries": {
468
431
  "con29DWRef": "2.4.1",
469
- "title": "Does the public sewer map indicate any public pumping station or any other ancillary apparatus within the boundaries of the property?",
470
432
  "discriminator": {
471
433
  "propertyName": "yesNo"
472
434
  },
@@ -488,8 +450,7 @@
488
450
  ]
489
451
  },
490
452
  "details": {
491
- "con29DWRef": "2.4.1.2",
492
- "title": "Details"
453
+ "con29DWRef": "2.4.1.2"
493
454
  }
494
455
  },
495
456
  "required": [
@@ -502,17 +463,12 @@
502
463
  ],
503
464
  "properties": {
504
465
  "yesNo": {
505
- "con29DWRef": "2.4.1.1",
506
- "enum": [
507
- "Yes",
508
- "No"
509
- ]
466
+ "con29DWRef": "2.4.1.1"
510
467
  }
511
468
  }
512
469
  },
513
470
  "publicSewerWithin100ft": {
514
471
  "con29DWRef": "2.5",
515
- "title": "Does the public sewer map indicate any public sewer within 30.48 meters (100 feet) of any buildings within the property?",
516
472
  "discriminator": {
517
473
  "propertyName": "yesNo"
518
474
  },
@@ -534,8 +490,7 @@
534
490
  ]
535
491
  },
536
492
  "details": {
537
- "con29DWRef": "2.5.0.2",
538
- "title": "Details"
493
+ "con29DWRef": "2.5.0.2"
539
494
  }
540
495
  },
541
496
  "required": [
@@ -548,17 +503,12 @@
548
503
  ],
549
504
  "properties": {
550
505
  "yesNo": {
551
- "con29DWRef": "2.5.0.1",
552
- "enum": [
553
- "Yes",
554
- "No"
555
- ]
506
+ "con29DWRef": "2.5.0.1"
556
507
  }
557
508
  }
558
509
  },
559
510
  "publicPumpingStationWithin50mOfBuildings": {
560
511
  "con29DWRef": "2.5.1",
561
- "title": "Does the public sewer map indicate any public pumping station or any other ancillary apparatus within 50 metres of any buildings within the property?",
562
512
  "discriminator": {
563
513
  "propertyName": "yesNo"
564
514
  },
@@ -580,8 +530,7 @@
580
530
  ]
581
531
  },
582
532
  "details": {
583
- "con29DWRef": "2.5.1.2",
584
- "title": "Details"
533
+ "con29DWRef": "2.5.1.2"
585
534
  }
586
535
  },
587
536
  "required": [
@@ -594,17 +543,12 @@
594
543
  ],
595
544
  "properties": {
596
545
  "yesNo": {
597
- "con29DWRef": "2.5.1.1",
598
- "enum": [
599
- "Yes",
600
- "No"
601
- ]
546
+ "con29DWRef": "2.5.1.1"
602
547
  }
603
548
  }
604
549
  },
605
550
  "sewersSubjectOfAdoptionAgreement": {
606
551
  "con29DWRef": "2.6",
607
- "title": "Are any sewers or lateral drains serving, or which are proposed to serve the property, the subject of an existing adoption agreement or an application for such an agreement?",
608
552
  "discriminator": {
609
553
  "propertyName": "yesNo"
610
554
  },
@@ -626,8 +570,7 @@
626
570
  ]
627
571
  },
628
572
  "details": {
629
- "con29DWRef": "2.6.2",
630
- "title": "Details"
573
+ "con29DWRef": "2.6.2"
631
574
  }
632
575
  },
633
576
  "required": [
@@ -640,17 +583,12 @@
640
583
  ],
641
584
  "properties": {
642
585
  "yesNo": {
643
- "con29DWRef": "2.6.1",
644
- "enum": [
645
- "Yes",
646
- "No"
647
- ]
586
+ "con29DWRef": "2.6.1"
648
587
  }
649
588
  }
650
589
  },
651
590
  "sewerageUndertakerApproval": {
652
591
  "con29DWRef": "2.7",
653
- "title": "Has the sewerage undertaker approved or been consulted about any plans to erect a building or extension on the property over, or in the vicinity of, a public sewer, disposal main or drain?",
654
592
  "discriminator": {
655
593
  "propertyName": "yesNo"
656
594
  },
@@ -672,8 +610,7 @@
672
610
  ]
673
611
  },
674
612
  "details": {
675
- "con29DWRef": "2.7.2",
676
- "title": "Details"
613
+ "con29DWRef": "2.7.2"
677
614
  }
678
615
  },
679
616
  "required": [
@@ -686,17 +623,12 @@
686
623
  ],
687
624
  "properties": {
688
625
  "yesNo": {
689
- "con29DWRef": "2.7.1",
690
- "enum": [
691
- "Yes",
692
- "No"
693
- ]
626
+ "con29DWRef": "2.7.1"
694
627
  }
695
628
  }
696
629
  },
697
630
  "riskOfInternalFlooding": {
698
631
  "con29DWRef": "2.8",
699
- "title": "Is any building which is or forms part of the property, at risk of internal flooding due to overloaded public sewers?",
700
632
  "discriminator": {
701
633
  "propertyName": "yesNo"
702
634
  },
@@ -718,8 +650,7 @@
718
650
  ]
719
651
  },
720
652
  "details": {
721
- "con29DWRef": "2.8.2",
722
- "title": "Details"
653
+ "con29DWRef": "2.8.2"
723
654
  }
724
655
  },
725
656
  "required": [
@@ -732,23 +663,17 @@
732
663
  ],
733
664
  "properties": {
734
665
  "yesNo": {
735
- "con29DWRef": "2.8.1",
736
- "enum": [
737
- "Yes",
738
- "No"
739
- ]
666
+ "con29DWRef": "2.8.1"
740
667
  }
741
668
  }
742
669
  },
743
670
  "distanceToNearestSewerageTreatment": {
744
- "con29DWRef": "2.9",
745
- "title": "Please state the distance from the property to the nearest boundary of the nearest sewage treatment works."
671
+ "con29DWRef": "2.9"
746
672
  }
747
673
  }
748
674
  },
749
675
  "charging": {
750
676
  "con29DWRef": "4",
751
- "title": "Charging",
752
677
  "required": [
753
678
  "sewerageProvider",
754
679
  "waterProvider",
@@ -759,28 +684,22 @@
759
684
  ],
760
685
  "properties": {
761
686
  "sewerageProvider": {
762
- "con29DWRef": "4.1.1",
763
- "title": "Who are the sewerage undertakers for the property?"
687
+ "con29DWRef": "4.1.1"
764
688
  },
765
689
  "waterProvider": {
766
- "con29DWRef": "4.1.2",
767
- "title": "Who are the water undertakers for the property?"
690
+ "con29DWRef": "4.1.2"
768
691
  },
769
692
  "sewerageBills": {
770
- "con29DWRef": "4.2",
771
- "title": "Who bills the property for sewerage services?"
693
+ "con29DWRef": "4.2"
772
694
  },
773
695
  "waterBills": {
774
- "con29DWRef": "4.3",
775
- "title": "Who bills the property for water services?"
696
+ "con29DWRef": "4.3"
776
697
  },
777
698
  "currentChargingBasis": {
778
- "con29DWRef": "4.4",
779
- "title": "What is the current basis for charging for sewerage and/or water services at the property?"
699
+ "con29DWRef": "4.4"
780
700
  },
781
701
  "consequentialChargingBasis": {
782
- "con29DWRef": "4.5",
783
- "title": "Will the basis for charging for sewerage and water services at the property change as a consequence of a change of occupation?"
702
+ "con29DWRef": "4.5"
784
703
  }
785
704
  }
786
705
  }