@pdtf/schemas 3.0.0-12 → 3.0.0-14

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 -4
  3. package/src/schemas/v3/combined.json +98 -203
  4. package/src/schemas/v3/overlays/baspi.json +51 -43
  5. package/src/schemas/v3/overlays/nts.json +59 -42
  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 -39
  9. package/src/schemas/v3/pdtf-transaction.json +72 -181
  10. package/src/schemas/v3/skeleton.json +11 -7
  11. package/src/tests/v3/transactionSchema.test.js +1 -1
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -339,7 +339,7 @@
339
339
  "type": "object",
340
340
  "properties": {
341
341
  "building": {
342
- "title": "Building informatiom",
342
+ "title": "Building information",
343
343
  "type": "object",
344
344
  "properties": {
345
345
  "builtForm": {
@@ -409,8 +409,7 @@
409
409
  "type": "integer"
410
410
  },
411
411
  "hasLift": {
412
- "title": "Entrance floor",
413
- "description": "Is the property served by a lift?",
412
+ "title": "Is the property served by a lift?",
414
413
  "type": "string",
415
414
  "enum": [
416
415
  "Yes",
@@ -418,7 +417,7 @@
418
417
  ]
419
418
  },
420
419
  "overCommercialPremises": {
421
- "title": "Is the property located over commercial premises?",
420
+ "title": "Located over commercial premises?",
422
421
  "type": "object",
423
422
  "properties": {
424
423
  "isLocatedOverCommercialPremises": {
@@ -571,14 +570,6 @@
571
570
  "title": "Any additional description or clarification of the room dimensions",
572
571
  "type": "string",
573
572
  "minLength": 1
574
- },
575
- "photoUrls": {
576
- "title": "The URLs of images which should be associated with this room",
577
- "type": "array",
578
- "items": {
579
- "type": "string",
580
- "format": "uri"
581
- }
582
573
  }
583
574
  }
584
575
  }
@@ -6972,12 +6963,25 @@
6972
6963
  "On Street",
6973
6964
  "Rear",
6974
6965
  "Private",
6975
- "Disabled Parking Available",
6976
- "No Disabled Parking Available",
6977
6966
  "Garage En Bloc"
6978
6967
  ]
6979
6968
  }
6980
6969
  },
6970
+ "disabledParking": {
6971
+ "title": "Is disabled parking available?",
6972
+ "type": "object",
6973
+ "properties": {
6974
+ "yesNo": {
6975
+ "type": "string",
6976
+ "title": "",
6977
+ "enum": [
6978
+ "Yes",
6979
+ "No",
6980
+ "Not known"
6981
+ ]
6982
+ }
6983
+ }
6984
+ },
6981
6985
  "controlledParking": {
6982
6986
  "title": "Is the property in a controlled parking zone or within a local authority parking scheme?",
6983
6987
  "type": "object",
@@ -7205,8 +7209,8 @@
7205
7209
  "type": "object",
7206
7210
  "properties": {
7207
7211
  "isStandardForm": {
7208
- "title": "Is the property built in a standard form of construction? E.g. brick and/or block with timber-supported roof comprising a tile or slate cover?",
7209
- "description": "Examples of non-standard features which might affect a buyer are are thatched roofs, prefabricated buildings or timber-framed windows",
7212
+ "title": "Is the property built in a standard form of construction?",
7213
+ "description": "Standard construction is brick and/or block with timber-supported roof comprising a tile or slate cover. Examples of non-standard features which might affect a buyer are are thatched roofs, prefabricated buildings or timber-framed windows.",
7210
7214
  "type": "object",
7211
7215
  "properties": {
7212
7216
  "yesNo": {
@@ -7363,7 +7367,7 @@
7363
7367
  },
7364
7368
  "accessibilityAndAdaptations": {
7365
7369
  "title": "Are there any adaptations or features that provide easier access to, and within, the property?",
7366
- "description": "Lateral living is a term used to describe a property that has essential facilites on the entrance level",
7370
+ "description": "Lateral living is where a property has all essential facilities e.g. kitchen, bathroom and bedroom on the entrance level.",
7367
7371
  "type": "array",
7368
7372
  "items": {
7369
7373
  "type": "string",
@@ -17617,7 +17621,7 @@
17617
17621
  },
17618
17622
  "details": {
17619
17623
  "title": "Community heating system details",
17620
- "description": "Please descripbe how the cost of heating supply is charged, whether you have control over the energy supplier and whether you have any control over the heating",
17624
+ "description": "Please describe how the cost of heating supply is charged, whether you have control over the energy supplier and whether you have any control over the heating.",
17621
17625
  "type": "string",
17622
17626
  "minLength": 1
17623
17627
  }
@@ -18628,55 +18632,61 @@
18628
18632
  }
18629
18633
  ]
18630
18634
  },
18631
- "hasBeenFlooded": {
18632
- "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
18633
- "type": "string",
18634
- "enum": [
18635
- "Yes",
18636
- "No"
18637
- ]
18638
- }
18639
- },
18640
- "oneOf": [
18641
- {
18635
+ "historicalFlooding": {
18636
+ "title": "Historical flooding",
18637
+ "type": "object",
18642
18638
  "properties": {
18643
18639
  "hasBeenFlooded": {
18640
+ "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
18641
+ "type": "string",
18644
18642
  "enum": [
18643
+ "Yes",
18645
18644
  "No"
18646
18645
  ]
18647
18646
  }
18648
- }
18649
- },
18650
- {
18651
- "properties": {
18652
- "hasBeenFlooded": {
18653
- "enum": [
18654
- "Yes"
18655
- ]
18656
- },
18657
- "typeOfFlooding": {
18658
- "title": "What type of flooding occurred?",
18659
- "type": "array",
18660
- "items": {
18661
- "type": "string",
18662
- "enum": [
18663
- "Ground water",
18664
- "Sewer",
18665
- "Surface water",
18666
- "Coastal flooding",
18667
- "River flooding",
18668
- "Other"
18669
- ]
18647
+ },
18648
+ "oneOf": [
18649
+ {
18650
+ "properties": {
18651
+ "hasBeenFlooded": {
18652
+ "enum": [
18653
+ "No"
18654
+ ]
18655
+ }
18670
18656
  }
18671
18657
  },
18672
- "details": {
18673
- "title": "Please state when the flooding occurred and identify the parts that flooded",
18674
- "type": "string",
18675
- "minLength": 1
18658
+ {
18659
+ "properties": {
18660
+ "hasBeenFlooded": {
18661
+ "enum": [
18662
+ "Yes"
18663
+ ]
18664
+ },
18665
+ "typeOfFlooding": {
18666
+ "title": "What type of flooding occurred?",
18667
+ "type": "array",
18668
+ "items": {
18669
+ "type": "string",
18670
+ "enum": [
18671
+ "Ground water",
18672
+ "Sewer",
18673
+ "Surface water",
18674
+ "Coastal flooding",
18675
+ "River flooding",
18676
+ "Other"
18677
+ ]
18678
+ }
18679
+ },
18680
+ "details": {
18681
+ "title": "Please state when the flooding occurred and identify the parts that flooded",
18682
+ "type": "string",
18683
+ "minLength": 1
18684
+ }
18685
+ }
18676
18686
  }
18677
- }
18687
+ ]
18678
18688
  }
18679
- ]
18689
+ }
18680
18690
  },
18681
18691
  "radon": {
18682
18692
  "title": "Radon",
@@ -19821,7 +19831,7 @@
19821
19831
  "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)?",
19822
19832
  "type": "object",
19823
19833
  "properties": {
19824
- "yesNo": {
19834
+ "riskIndicator": {
19825
19835
  "type": "string",
19826
19836
  "title": "",
19827
19837
  "enum": [
@@ -19833,7 +19843,7 @@
19833
19843
  "oneOf": [
19834
19844
  {
19835
19845
  "properties": {
19836
- "yesNo": {
19846
+ "riskIndicator": {
19837
19847
  "enum": [
19838
19848
  "No",
19839
19849
  "Not known"
@@ -19843,12 +19853,12 @@
19843
19853
  },
19844
19854
  {
19845
19855
  "properties": {
19846
- "yesNo": {
19856
+ "riskIndicator": {
19847
19857
  "enum": [
19848
19858
  "Yes"
19849
19859
  ]
19850
19860
  },
19851
- "details": {
19861
+ "summary": {
19852
19862
  "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.",
19853
19863
  "type": "string",
19854
19864
  "minLength": 1
@@ -34493,126 +34503,7 @@
34493
34503
  "propertyType": {
34494
34504
  "title": "Type of Property",
34495
34505
  "description": "The type or category of the property.",
34496
- "type": "string",
34497
- "enum": [
34498
- "Not Specified",
34499
- "Terraced House",
34500
- "End of terrace house",
34501
- "Semi-detached house",
34502
- "Detached house",
34503
- "Mews house",
34504
- "Cluster house",
34505
- "Ground floor flat",
34506
- "Flat",
34507
- "Studio flat",
34508
- "Ground floor maisonette",
34509
- "Maisonette",
34510
- "Bungalow",
34511
- "Terraced bungalow",
34512
- "Semi-detached bungalow",
34513
- "Detached bungalow",
34514
- "Mobile home",
34515
- "Land (Residential)",
34516
- "Link detached house",
34517
- "Town house",
34518
- "Cottage",
34519
- "Chalet",
34520
- "Character Property",
34521
- "House (unspecified)",
34522
- "Villa",
34523
- "Apartment",
34524
- "Penthouse",
34525
- "Finca",
34526
- "Barn Conversion",
34527
- "Serviced apartment",
34528
- "Parking",
34529
- "Sheltered Housing",
34530
- "Reteirment property",
34531
- "House share",
34532
- "Flat share",
34533
- "Park home",
34534
- "Garages",
34535
- "Farm House",
34536
- "Equestrian facility",
34537
- "Duplex",
34538
- "Triplex",
34539
- "Longere",
34540
- "Gite",
34541
- "Barn",
34542
- "Trulli",
34543
- "Mill",
34544
- "Ruins",
34545
- "Restaurant",
34546
- "Cafe",
34547
- "Castle",
34548
- "Village House",
34549
- "Cave House",
34550
- "Cortijo",
34551
- "Farm Land",
34552
- "Plot",
34553
- "Country House",
34554
- "Stone House",
34555
- "Caravan",
34556
- "Lodge",
34557
- "Log Cabin",
34558
- "Manor House",
34559
- "Stately Home",
34560
- "Off-Plan",
34561
- "Semi-detached Villa",
34562
- "Detached Villa",
34563
- "Bar/Nightclub",
34564
- "Shop",
34565
- "Riad",
34566
- "House Boat",
34567
- "Hotel Room",
34568
- "Block of Apartments",
34569
- "Private Halls",
34570
- "Office",
34571
- "Business Park",
34572
- "Serviced Office",
34573
- "Retail Property (High Street)",
34574
- "Retail Property (Out of Town)",
34575
- "Convenience Store",
34576
- "Hairdresser/Barber Shop",
34577
- "Hotel",
34578
- "Petrol Station",
34579
- "Post Office",
34580
- "Pub",
34581
- "Workshop & Retail Space",
34582
- "Distribution Warehouse",
34583
- "Factory",
34584
- "Heavy Industrial",
34585
- "Industrial Park",
34586
- "Light Industrial",
34587
- "Storage",
34588
- "Showroom",
34589
- "Warehouse",
34590
- "Land (Commercial)",
34591
- "Commercial Development",
34592
- "Industrial Development",
34593
- "Residential Development",
34594
- "Commercial Property",
34595
- "Data Centre",
34596
- "Farm",
34597
- "Healthcare Facility",
34598
- "Marine Property",
34599
- "Mixed Use",
34600
- "Research & Development Facility",
34601
- "Science Park",
34602
- "Guest House",
34603
- "Hospitality",
34604
- "Leisure Facility",
34605
- "Takeaway",
34606
- "Childcare Facility",
34607
- "Smallholding",
34608
- "Place of Worship",
34609
- "Trade Counter",
34610
- "Coach House",
34611
- "House of Multiple Occupation",
34612
- "Sports facilities",
34613
- "Spa",
34614
- "Campsite & Holiday Village"
34615
- ]
34506
+ "type": "string"
34616
34507
  },
34617
34508
  "marketingTenure": {
34618
34509
  "title": "Marketing Tenure",
package/src/schemas/v3/skeleton.json CHANGED
@@ -95,8 +95,7 @@
95
95
  "length": {},
96
96
  "width": {},
97
97
  "units": {},
98
- "dimensionDetails": {},
99
- "photoUrls": {}
98
+ "dimensionDetails": {}
100
99
  }
101
100
  }
102
101
  },
@@ -995,6 +994,9 @@
995
994
  },
996
995
  "parking": {
997
996
  "parkingArrangements": {},
997
+ "disabledParking": {
998
+ "yesNo": {}
999
+ },
998
1000
  "controlledParking": {
999
1001
  "yesNo": {}
1000
1002
  },
@@ -2243,9 +2245,11 @@
2243
2245
  "datasetAttribution": {}
2244
2246
  }
2245
2247
  },
2246
- "hasBeenFlooded": {},
2247
- "typeOfFlooding": {},
2248
- "details": {}
2248
+ "historicalFlooding": {
2249
+ "hasBeenFlooded": {},
2250
+ "typeOfFlooding": {},
2251
+ "details": {}
2252
+ }
2249
2253
  },
2250
2254
  "radon": {
2251
2255
  "radonRisk": {
@@ -2440,8 +2444,8 @@
2440
2444
  }
2441
2445
  },
2442
2446
  "otherEnvironmental": {
2443
- "yesNo": {},
2444
- "details": {}
2447
+ "riskIndicator": {},
2448
+ "summary": {}
2445
2449
  }
2446
2450
  },
2447
2451
  "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
  });