@pdtf/schemas 3.0.0-11 → 3.0.0-13

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 (11) hide show
  1. package/package.json +1 -1
  2. package/src/examples/v3/exampleTransaction.json +7 -5
  3. package/src/schemas/v3/combined.json +163 -183
  4. package/src/schemas/v3/overlays/baspi.json +51 -52
  5. package/src/schemas/v3/overlays/nts.json +107 -113
  6. package/src/schemas/v3/overlays/piq.json +4 -4
  7. package/src/schemas/v3/overlays/rds.json +15 -29
  8. package/src/schemas/v3/overlays/ta6.json +42 -34
  9. package/src/schemas/v3/pdtf-transaction.json +125 -145
  10. package/src/schemas/v3/skeleton.json +15 -16
  11. package/src/tests/v3/transactionSchema.test.js +1 -1
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -342,6 +342,17 @@
342
342
  "title": "Building informatiom",
343
343
  "type": "object",
344
344
  "properties": {
345
+ "builtForm": {
346
+ "title": "Built form",
347
+ "type": "string",
348
+ "enum": [
349
+ "Detached",
350
+ "Semi-detached",
351
+ "Terraced",
352
+ "End of terrace",
353
+ "Other"
354
+ ]
355
+ },
345
356
  "propertyType": {
346
357
  "title": "Property type",
347
358
  "type": "string",
@@ -377,17 +388,6 @@
377
388
  "House",
378
389
  "Bungalow"
379
390
  ]
380
- },
381
- "builtForm": {
382
- "title": "Built form",
383
- "type": "string",
384
- "enum": [
385
- "Detached",
386
- "Semi-detached",
387
- "Terraced",
388
- "End of terrace",
389
- "Other"
390
- ]
391
391
  }
392
392
  }
393
393
  },
@@ -399,17 +399,6 @@
399
399
  "Flat"
400
400
  ]
401
401
  },
402
- "builtForm": {
403
- "title": "Built form",
404
- "type": "string",
405
- "enum": [
406
- "Detached",
407
- "Semi-detached",
408
- "Terraced",
409
- "End of terrace",
410
- "Other"
411
- ]
412
- },
413
402
  "numberOfFloors": {
414
403
  "title": "Number of floors in the building",
415
404
  "type": "integer"
@@ -420,8 +409,7 @@
420
409
  "type": "integer"
421
410
  },
422
411
  "hasLift": {
423
- "title": "Entrance floor",
424
- "description": "Is the property served by a lift?",
412
+ "title": "Is the property served by a lift?",
425
413
  "type": "string",
426
414
  "enum": [
427
415
  "Yes",
@@ -429,7 +417,7 @@
429
417
  ]
430
418
  },
431
419
  "overCommercialPremises": {
432
- "title": "Is the property located over commercial premises?",
420
+ "title": "Located over commercial premises?",
433
421
  "type": "object",
434
422
  "properties": {
435
423
  "isLocatedOverCommercialPremises": {
@@ -516,93 +504,79 @@
516
504
  "properties": {
517
505
  "hasFloorplan": {
518
506
  "title": "Is a floorplan available which includes the dimensions of all the rooms?",
519
- "type": "object",
507
+ "type": "string",
508
+ "enum": [
509
+ "Yes",
510
+ "No"
511
+ ]
512
+ }
513
+ },
514
+ "oneOf": [
515
+ {
520
516
  "properties": {
521
- "yesNo": {
522
- "type": "string",
523
- "title": "",
517
+ "hasFloorplan": {
524
518
  "enum": [
525
- "Yes",
526
- "No"
519
+ "Yes"
527
520
  ]
528
521
  }
529
- },
530
- "oneOf": [
531
- {
532
- "properties": {
533
- "yesNo": {
534
- "enum": [
535
- "Yes"
536
- ]
537
- }
538
- }
522
+ }
523
+ },
524
+ {
525
+ "properties": {
526
+ "hasFloorplan": {
527
+ "enum": [
528
+ "No"
529
+ ]
539
530
  },
540
- {
541
- "properties": {
542
- "yesNo": {
543
- "enum": [
544
- "No"
545
- ]
546
- },
547
- "rooms": {
548
- "title": "Rooms",
549
- "description": "Please supply dimensions for each of the rooms.",
550
- "type": "array",
551
- "items": {
552
- "type": "object",
553
- "properties": {
554
- "roomName": {
555
- "type": "string",
556
- "title": "The name of the room",
557
- "minLength": 1
558
- },
559
- "description": {
560
- "type": "string",
561
- "minLength": 1,
562
- "title": "Description of the room"
563
- },
564
- "length": {
565
- "type": "number",
566
- "minimum": 0,
567
- "title": "The length of the room"
568
- },
569
- "width": {
570
- "type": "number",
571
- "minimum": 0,
572
- "title": "The width of the room"
573
- },
574
- "units": {
575
- "title": "The units which the length and width of the room have been provided in",
576
- "type": "string",
577
- "enum": [
578
- "meters",
579
- "centimetres",
580
- "millimetres",
581
- "feet",
582
- "inches"
583
- ]
584
- },
585
- "dimensionDetails": {
586
- "title": "Any additional description or clarification of the room dimensions",
587
- "type": "string",
588
- "minLength": 1
589
- },
590
- "photoUrls": {
591
- "title": "The URLs of images which should be associated with this room",
592
- "type": "array",
593
- "items": {
594
- "type": "string",
595
- "format": "uri"
596
- }
597
- }
598
- }
531
+ "rooms": {
532
+ "title": "Rooms",
533
+ "description": "Please supply dimensions for each of the rooms.",
534
+ "type": "array",
535
+ "items": {
536
+ "type": "object",
537
+ "properties": {
538
+ "roomName": {
539
+ "type": "string",
540
+ "title": "The name of the room",
541
+ "minLength": 1
542
+ },
543
+ "description": {
544
+ "type": "string",
545
+ "minLength": 1,
546
+ "title": "Description of the room"
547
+ },
548
+ "length": {
549
+ "type": "number",
550
+ "minimum": 0,
551
+ "title": "The length of the room"
552
+ },
553
+ "width": {
554
+ "type": "number",
555
+ "minimum": 0,
556
+ "title": "The width of the room"
557
+ },
558
+ "units": {
559
+ "title": "The units which the length and width of the room have been provided in",
560
+ "type": "string",
561
+ "enum": [
562
+ "meters",
563
+ "centimetres",
564
+ "millimetres",
565
+ "feet",
566
+ "inches"
567
+ ]
568
+ },
569
+ "dimensionDetails": {
570
+ "title": "Any additional description or clarification of the room dimensions",
571
+ "type": "string",
572
+ "minLength": 1
599
573
  }
600
574
  }
601
575
  }
602
576
  }
603
- ]
577
+ }
604
578
  }
605
- }
579
+ ]
606
580
  }
607
581
  }
608
582
  },
@@ -18645,55 +18619,61 @@
18645
18619
  }
18646
18620
  ]
18647
18621
  },
18648
- "hasBeenFlooded": {
18649
- "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
18650
- "type": "string",
18651
- "enum": [
18652
- "Yes",
18653
- "No"
18654
- ]
18655
- }
18656
- },
18657
- "oneOf": [
18658
- {
18622
+ "historicalFlooding": {
18623
+ "title": "Historical flooding",
18624
+ "type": "object",
18659
18625
  "properties": {
18660
18626
  "hasBeenFlooded": {
18627
+ "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
18628
+ "type": "string",
18661
18629
  "enum": [
18630
+ "Yes",
18662
18631
  "No"
18663
18632
  ]
18664
18633
  }
18665
- }
18666
- },
18667
- {
18668
- "properties": {
18669
- "hasBeenFlooded": {
18670
- "enum": [
18671
- "Yes"
18672
- ]
18673
- },
18674
- "typeOfFlooding": {
18675
- "title": "What type of flooding occurred?",
18676
- "type": "array",
18677
- "items": {
18678
- "type": "string",
18679
- "enum": [
18680
- "Ground water",
18681
- "Sewer",
18682
- "Surface water",
18683
- "Coastal flooding",
18684
- "River flooding",
18685
- "Other"
18686
- ]
18634
+ },
18635
+ "oneOf": [
18636
+ {
18637
+ "properties": {
18638
+ "hasBeenFlooded": {
18639
+ "enum": [
18640
+ "No"
18641
+ ]
18642
+ }
18687
18643
  }
18688
18644
  },
18689
- "details": {
18690
- "title": "Please state when the flooding occurred and identify the parts that flooded",
18691
- "type": "string",
18692
- "minLength": 1
18645
+ {
18646
+ "properties": {
18647
+ "hasBeenFlooded": {
18648
+ "enum": [
18649
+ "Yes"
18650
+ ]
18651
+ },
18652
+ "typeOfFlooding": {
18653
+ "title": "What type of flooding occurred?",
18654
+ "type": "array",
18655
+ "items": {
18656
+ "type": "string",
18657
+ "enum": [
18658
+ "Ground water",
18659
+ "Sewer",
18660
+ "Surface water",
18661
+ "Coastal flooding",
18662
+ "River flooding",
18663
+ "Other"
18664
+ ]
18665
+ }
18666
+ },
18667
+ "details": {
18668
+ "title": "Please state when the flooding occurred and identify the parts that flooded",
18669
+ "type": "string",
18670
+ "minLength": 1
18671
+ }
18672
+ }
18693
18673
  }
18694
- }
18674
+ ]
18695
18675
  }
18696
- ]
18676
+ }
18697
18677
  },
18698
18678
  "radon": {
18699
18679
  "title": "Radon",
@@ -19838,7 +19818,7 @@
19838
19818
  "title": "To your knowledge, have there been any other environmental issues that affect the property or garden (for example, these could include air pollution, mining, sink holes, quarrying or fracking etc)?",
19839
19819
  "type": "object",
19840
19820
  "properties": {
19841
- "yesNo": {
19821
+ "riskIndicator": {
19842
19822
  "type": "string",
19843
19823
  "title": "",
19844
19824
  "enum": [
@@ -19850,7 +19830,7 @@
19850
19830
  "oneOf": [
19851
19831
  {
19852
19832
  "properties": {
19853
- "yesNo": {
19833
+ "riskIndicator": {
19854
19834
  "enum": [
19855
19835
  "No",
19856
19836
  "Not known"
@@ -19860,12 +19840,12 @@
19860
19840
  },
19861
19841
  {
19862
19842
  "properties": {
19863
- "yesNo": {
19843
+ "riskIndicator": {
19864
19844
  "enum": [
19865
19845
  "Yes"
19866
19846
  ]
19867
19847
  },
19868
- "details": {
19848
+ "summary": {
19869
19849
  "title": "Please provide details. For example the level of air pollution, location of fracking etc, and whether any action has been taken to prevent harm.",
19870
19850
  "type": "string",
19871
19851
  "minLength": 1
package/src/schemas/v3/skeleton.json CHANGED
@@ -69,9 +69,9 @@
69
69
  },
70
70
  "buildInformation": {
71
71
  "building": {
72
+ "builtForm": {},
72
73
  "propertyType": {},
73
74
  "otherType": {},
74
- "builtForm": {},
75
75
  "numberOfFloors": {},
76
76
  "entranceFloor": {},
77
77
  "hasLift": {},
@@ -89,16 +89,13 @@
89
89
  "yesNo": {}
90
90
  },
91
91
  "roomDimensions": {
92
- "hasFloorplan": {
93
- "yesNo": {},
94
- "rooms": {
95
- "roomName": {},
96
- "length": {},
97
- "width": {},
98
- "units": {},
99
- "dimensionDetails": {},
100
- "photoUrls": {}
101
- }
92
+ "hasFloorplan": {},
93
+ "rooms": {
94
+ "roomName": {},
95
+ "length": {},
96
+ "width": {},
97
+ "units": {},
98
+ "dimensionDetails": {}
102
99
  }
103
100
  }
104
101
  },
@@ -2245,9 +2242,11 @@
2245
2242
  "datasetAttribution": {}
2246
2243
  }
2247
2244
  },
2248
- "hasBeenFlooded": {},
2249
- "typeOfFlooding": {},
2250
- "details": {}
2245
+ "historicalFlooding": {
2246
+ "hasBeenFlooded": {},
2247
+ "typeOfFlooding": {},
2248
+ "details": {}
2249
+ }
2251
2250
  },
2252
2251
  "radon": {
2253
2252
  "radonRisk": {
@@ -2442,8 +2441,8 @@
2442
2441
  }
2443
2442
  },
2444
2443
  "otherEnvironmental": {
2445
- "yesNo": {},
2446
- "details": {}
2444
+ "riskIndicator": {},
2445
+ "summary": {}
2447
2446
  }
2448
2447
  },
2449
2448
  "otherIssues": {
package/src/tests/v3/transactionSchema.test.js CHANGED
@@ -148,7 +148,7 @@ test("correctly gets yet, yet another subschema through a dependency", () => {
148
148
 
149
149
  test("correctly gets yet, yet, yet another subschema through a second item dependency", () => {
150
150
  const subschema = getSubschema(
151
- "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding"
151
+ "/propertyPack/materialFacts/environmentalIssues/flooding/historicalFlooding/typeOfFlooding"
152
152
  );
153
153
  expect(subschema.type).toBe("array");
154
154
  });