@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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.0.0-12",
3
+ "version": "3.0.0-14",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
package/src/examples/v3/exampleTransaction.json CHANGED
@@ -119,6 +119,7 @@
119
119
  },
120
120
  "parking": {
121
121
  "parkingArrangements": ["Garage", "Driveway"],
122
+ "disabledParking": { "yesNo": "No" },
122
123
  "electricVehicleChargingPoint": { "yesNo": "No" },
123
124
  "controlledParking": { "yesNo": "No" }
124
125
  },
@@ -466,9 +467,11 @@
466
467
  "riskIndicator": "Yes",
467
468
  "summary": "Likely to flood from surface water"
468
469
  },
469
- "hasBeenFlooded": "Yes",
470
- "details": "Minor basement flood",
471
- "typeOfFlooding": ["Surface water"]
470
+ "historicalFlooding": {
471
+ "hasBeenFlooded": "Yes",
472
+ "details": "Minor basement flood",
473
+ "typeOfFlooding": ["Surface water"]
474
+ }
472
475
  },
473
476
  "radon": {
474
477
  "radonTest": { "yesNo": "No" },
@@ -484,7 +487,7 @@
484
487
  "riskIndicator": "No"
485
488
  },
486
489
  "otherEnvironmental": {
487
- "yesNo": "No"
490
+ "riskIndicator": "No"
488
491
  }
489
492
  },
490
493
  "otherIssues": {
package/src/schemas/v3/combined.json CHANGED
@@ -446,7 +446,7 @@
446
446
  "properties": {
447
447
  "building": {
448
448
  "ntsRef": "B1.1.1",
449
- "title": "Building informatiom",
449
+ "title": "Building information",
450
450
  "type": "object",
451
451
  "ntsRequired": ["builtForm", "propertyType"],
452
452
  "properties": {
@@ -519,14 +519,13 @@
519
519
  },
520
520
  "hasLift": {
521
521
  "ntsRef": "B1.1.5",
522
- "title": "Entrance floor",
523
- "description": "Is the property served by a lift?",
522
+ "title": "Is the property served by a lift?",
524
523
  "type": "string",
525
524
  "enum": ["Yes", "No"]
526
525
  },
527
526
  "overCommercialPremises": {
528
527
  "ntsRef": "B1.1.6",
529
- "title": "Is the property located over commercial premises?",
528
+ "title": "Located over commercial premises?",
530
529
  "type": "object",
531
530
  "properties": {
532
531
  "isLocatedOverCommercialPremises": {
@@ -682,15 +681,6 @@
682
681
  "title": "Any additional description or clarification of the room dimensions",
683
682
  "type": "string",
684
683
  "minLength": 1
685
- },
686
- "photoUrls": {
687
- "ntsRef": "B2.7",
688
- "title": "The URLs of images which should be associated with this room",
689
- "type": "array",
690
- "items": {
691
- "type": "string",
692
- "format": "uri"
693
- }
694
684
  }
695
685
  },
696
686
  "ntsRequired": [
@@ -8028,6 +8018,7 @@
8028
8018
  ],
8029
8019
  "ntsRequired": [
8030
8020
  "parkingArrangements",
8021
+ "disabledParking",
8031
8022
  "controlledParking",
8032
8023
  "electricVehicleChargingPoint"
8033
8024
  ],
@@ -8054,21 +8045,33 @@
8054
8045
  "On Street",
8055
8046
  "Rear",
8056
8047
  "Private",
8057
- "Disabled Parking Available",
8058
- "No Disabled Parking Available",
8059
8048
  "Garage En Bloc"
8060
8049
  ]
8061
8050
  }
8062
8051
  },
8063
- "controlledParking": {
8052
+ "disabledParking": {
8064
8053
  "ntsRef": "B4.2",
8054
+ "title": "Is disabled parking available?",
8055
+ "type": "object",
8056
+ "properties": {
8057
+ "yesNo": {
8058
+ "ntsRef": "B4.2.1",
8059
+ "type": "string",
8060
+ "title": "",
8061
+ "enum": ["Yes", "No", "Not known"]
8062
+ }
8063
+ },
8064
+ "ntsRequired": ["yesNo"]
8065
+ },
8066
+ "controlledParking": {
8067
+ "ntsRef": "B4.3",
8065
8068
  "baspiRef": "A1.6.2",
8066
8069
  "ta6Ref": "9.2",
8067
8070
  "title": "Is the property in a controlled parking zone or within a local authority parking scheme?",
8068
8071
  "type": "object",
8069
8072
  "properties": {
8070
8073
  "yesNo": {
8071
- "ntsRef": "B4.2.1",
8074
+ "ntsRef": "B4.3.1",
8072
8075
  "baspiRef": "A1.6.2.1",
8073
8076
  "ta6Ref": "9.2.1",
8074
8077
  "type": "string",
@@ -8081,13 +8084,13 @@
8081
8084
  "ta6Required": ["yesNo"]
8082
8085
  },
8083
8086
  "electricVehicleChargingPoint": {
8084
- "ntsRef": "B4.3",
8087
+ "ntsRef": "B4.4",
8085
8088
  "baspiRef": "A1.6.1",
8086
8089
  "title": "Is there an electric vehicle charging point belonging to the property?",
8087
8090
  "type": "object",
8088
8091
  "properties": {
8089
8092
  "yesNo": {
8090
- "ntsRef": "B4.2.1",
8093
+ "ntsRef": "B4.4.1",
8091
8094
  "baspiRef": "A1.6.1.1",
8092
8095
  "type": "string",
8093
8096
  "title": "",
@@ -8095,8 +8098,7 @@
8095
8098
  }
8096
8099
  },
8097
8100
  "baspiRequired": ["yesNo"],
8098
- "ntsRequired": ["yesNo"],
8099
- "ta6Required": ["yesNo"]
8101
+ "ntsRequired": ["yesNo"]
8100
8102
  }
8101
8103
  }
8102
8104
  },
@@ -8369,8 +8371,8 @@
8369
8371
  "ntsRef": "A1.2.1",
8370
8372
  "rdsRef": "Buildings,BuildingSections/ConstructionType,ConstructionMaterials",
8371
8373
  "piqRef": "A5.5",
8372
- "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?",
8373
- "description": "Examples of non-standard features which might affect a buyer are are thatched roofs, prefabricated buildings or timber-framed windows",
8374
+ "title": "Is the property built in a standard form of construction?",
8375
+ "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.",
8374
8376
  "type": "object",
8375
8377
  "properties": {
8376
8378
  "yesNo": {
@@ -8565,7 +8567,7 @@
8565
8567
  "accessibilityAndAdaptations": {
8566
8568
  "ntsRef": "C5",
8567
8569
  "title": "Are there any adaptations or features that provide easier access to, and within, the property?",
8568
- "description": "Lateral living is a term used to describe a property that has essential facilites on the entrance level",
8570
+ "description": "Lateral living is where a property has all essential facilities e.g. kitchen, bathroom and bedroom on the entrance level.",
8569
8571
  "type": "array",
8570
8572
  "items": {
8571
8573
  "type": "string",
@@ -20214,7 +20216,7 @@
20214
20216
  "details": {
20215
20217
  "ntsRef": "B3.4.4",
20216
20218
  "title": "Community heating system details",
20217
- "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",
20219
+ "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.",
20218
20220
  "type": "string",
20219
20221
  "minLength": 1
20220
20222
  }
@@ -21349,9 +21351,9 @@
21349
21351
  "ta6Ref": "7.1.0",
21350
21352
  "title": "Flooding",
21351
21353
  "type": "object",
21352
- "baspiRequired": ["hasBeenFlooded"],
21353
- "ntsRequired": ["floodRisk", "hasBeenFlooded"],
21354
- "ta6Required": ["hasBeenFlooded"],
21354
+ "baspiRequired": ["historicalFlooding"],
21355
+ "ntsRequired": ["floodRisk", "historicalFlooding"],
21356
+ "ta6Required": ["historicalFlooding"],
21355
21357
  "properties": {
21356
21358
  "floodRisk": {
21357
21359
  "ntsRef": "C3.1.1.1",
@@ -21462,64 +21464,76 @@
21462
21464
  }
21463
21465
  ]
21464
21466
  },
21465
- "hasBeenFlooded": {
21467
+ "historicalFlooding": {
21466
21468
  "ntsRef": "C3.1.1.2",
21467
21469
  "baspiRef": "A11.1.2",
21468
21470
  "ta6Ref": "7.1.1",
21469
- "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
21470
- "type": "string",
21471
- "enum": ["Yes", "No"]
21472
- }
21473
- },
21474
- "discriminator": {
21475
- "propertyName": "hasBeenFlooded"
21476
- },
21477
- "oneOf": [
21478
- {
21479
- "properties": {
21480
- "hasBeenFlooded": {
21481
- "enum": ["No"]
21482
- }
21483
- }
21484
- },
21485
- {
21471
+ "title": "Historical flooding",
21472
+ "type": "object",
21473
+ "baspiRequired": ["hasBeenFlooded"],
21474
+ "ntsRequired": ["hasBeenFlooded"],
21475
+ "ta6Required": ["hasBeenFlooded"],
21486
21476
  "properties": {
21487
21477
  "hasBeenFlooded": {
21488
- "enum": ["Yes"]
21489
- },
21490
- "typeOfFlooding": {
21491
- "ntsRef": "C3.1.1.3",
21492
- "baspiRef": "A11.1.2.2",
21493
- "rdsRef": "Sustainability/Environmental|Natural|Situational",
21494
- "ta6Ref": "7.2",
21495
- "title": "What type of flooding occurred?",
21496
- "type": "array",
21497
- "items": {
21498
- "type": "string",
21499
- "enum": [
21500
- "Ground water",
21501
- "Sewer",
21502
- "Surface water",
21503
- "Coastal flooding",
21504
- "River flooding",
21505
- "Other"
21506
- ]
21507
- }
21508
- },
21509
- "details": {
21510
- "ntsRef": "C3.1.1.4",
21478
+ "ntsRef": "C3.1.1.2.1",
21511
21479
  "baspiRef": "A11.1.2.1",
21512
- "ta6Ref": "7.1.2",
21513
- "title": "Please state when the flooding occurred and identify the parts that flooded",
21480
+ "ta6Ref": "7.1.1.1",
21481
+ "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
21514
21482
  "type": "string",
21515
- "minLength": 1
21483
+ "enum": ["Yes", "No"]
21516
21484
  }
21517
21485
  },
21518
- "baspiRequired": ["typeOfFlooding", "details"],
21519
- "ntsRequired": ["typeOfFlooding", "details"],
21520
- "ta6Required": ["typeOfFlooding", "details"]
21486
+ "discriminator": {
21487
+ "propertyName": "hasBeenFlooded"
21488
+ },
21489
+ "oneOf": [
21490
+ {
21491
+ "properties": {
21492
+ "hasBeenFlooded": {
21493
+ "enum": ["No"]
21494
+ }
21495
+ }
21496
+ },
21497
+ {
21498
+ "properties": {
21499
+ "hasBeenFlooded": {
21500
+ "enum": ["Yes"]
21501
+ },
21502
+ "typeOfFlooding": {
21503
+ "ntsRef": "C3.1.1.3",
21504
+ "baspiRef": "A11.1.2.2",
21505
+ "rdsRef": "Sustainability/Environmental|Natural|Situational",
21506
+ "ta6Ref": "7.2",
21507
+ "title": "What type of flooding occurred?",
21508
+ "type": "array",
21509
+ "items": {
21510
+ "type": "string",
21511
+ "enum": [
21512
+ "Ground water",
21513
+ "Sewer",
21514
+ "Surface water",
21515
+ "Coastal flooding",
21516
+ "River flooding",
21517
+ "Other"
21518
+ ]
21519
+ }
21520
+ },
21521
+ "details": {
21522
+ "ntsRef": "C3.1.1.4",
21523
+ "baspiRef": "A11.1.2.1",
21524
+ "ta6Ref": "7.1.2",
21525
+ "title": "Please state when the flooding occurred and identify the parts that flooded",
21526
+ "type": "string",
21527
+ "minLength": 1
21528
+ }
21529
+ },
21530
+ "baspiRequired": ["typeOfFlooding", "details"],
21531
+ "ntsRequired": ["typeOfFlooding", "details"],
21532
+ "ta6Required": ["typeOfFlooding", "details"]
21533
+ }
21534
+ ]
21521
21535
  }
21522
- ]
21536
+ }
21523
21537
  },
21524
21538
  "radon": {
21525
21539
  "baspiRef": "A11.1.3",
@@ -22524,7 +22538,7 @@
22524
22538
  "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)?",
22525
22539
  "type": "object",
22526
22540
  "properties": {
22527
- "yesNo": {
22541
+ "riskIndicator": {
22528
22542
  "piqRef": "A11.5.1",
22529
22543
  "baspiRef": "A11.1.4.1",
22530
22544
  "type": "string",
@@ -22532,31 +22546,31 @@
22532
22546
  "enum": ["Yes", "No"]
22533
22547
  }
22534
22548
  },
22535
- "baspiRequired": ["yesNo"],
22549
+ "baspiRequired": ["riskIndicator"],
22536
22550
  "discriminator": {
22537
- "propertyName": "yesNo"
22551
+ "propertyName": "riskIndicator"
22538
22552
  },
22539
22553
  "oneOf": [
22540
22554
  {
22541
22555
  "properties": {
22542
- "yesNo": {
22556
+ "riskIndicator": {
22543
22557
  "enum": ["No", "Not known"]
22544
22558
  }
22545
22559
  }
22546
22560
  },
22547
22561
  {
22548
22562
  "properties": {
22549
- "yesNo": {
22563
+ "riskIndicator": {
22550
22564
  "enum": ["Yes"]
22551
22565
  },
22552
- "details": {
22566
+ "summary": {
22553
22567
  "baspiRef": "A11.1.4.2",
22554
22568
  "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.",
22555
22569
  "type": "string",
22556
22570
  "minLength": 1
22557
22571
  }
22558
22572
  },
22559
- "baspiRequired": ["details"]
22573
+ "baspiRequired": ["summary"]
22560
22574
  }
22561
22575
  ]
22562
22576
  }
@@ -38086,126 +38100,7 @@
38086
38100
  "propertyType": {
38087
38101
  "title": "Type of Property",
38088
38102
  "description": "The type or category of the property.",
38089
- "type": "string",
38090
- "enum": [
38091
- "Not Specified",
38092
- "Terraced House",
38093
- "End of terrace house",
38094
- "Semi-detached house",
38095
- "Detached house",
38096
- "Mews house",
38097
- "Cluster house",
38098
- "Ground floor flat",
38099
- "Flat",
38100
- "Studio flat",
38101
- "Ground floor maisonette",
38102
- "Maisonette",
38103
- "Bungalow",
38104
- "Terraced bungalow",
38105
- "Semi-detached bungalow",
38106
- "Detached bungalow",
38107
- "Mobile home",
38108
- "Land (Residential)",
38109
- "Link detached house",
38110
- "Town house",
38111
- "Cottage",
38112
- "Chalet",
38113
- "Character Property",
38114
- "House (unspecified)",
38115
- "Villa",
38116
- "Apartment",
38117
- "Penthouse",
38118
- "Finca",
38119
- "Barn Conversion",
38120
- "Serviced apartment",
38121
- "Parking",
38122
- "Sheltered Housing",
38123
- "Reteirment property",
38124
- "House share",
38125
- "Flat share",
38126
- "Park home",
38127
- "Garages",
38128
- "Farm House",
38129
- "Equestrian facility",
38130
- "Duplex",
38131
- "Triplex",
38132
- "Longere",
38133
- "Gite",
38134
- "Barn",
38135
- "Trulli",
38136
- "Mill",
38137
- "Ruins",
38138
- "Restaurant",
38139
- "Cafe",
38140
- "Castle",
38141
- "Village House",
38142
- "Cave House",
38143
- "Cortijo",
38144
- "Farm Land",
38145
- "Plot",
38146
- "Country House",
38147
- "Stone House",
38148
- "Caravan",
38149
- "Lodge",
38150
- "Log Cabin",
38151
- "Manor House",
38152
- "Stately Home",
38153
- "Off-Plan",
38154
- "Semi-detached Villa",
38155
- "Detached Villa",
38156
- "Bar/Nightclub",
38157
- "Shop",
38158
- "Riad",
38159
- "House Boat",
38160
- "Hotel Room",
38161
- "Block of Apartments",
38162
- "Private Halls",
38163
- "Office",
38164
- "Business Park",
38165
- "Serviced Office",
38166
- "Retail Property (High Street)",
38167
- "Retail Property (Out of Town)",
38168
- "Convenience Store",
38169
- "Hairdresser/Barber Shop",
38170
- "Hotel",
38171
- "Petrol Station",
38172
- "Post Office",
38173
- "Pub",
38174
- "Workshop & Retail Space",
38175
- "Distribution Warehouse",
38176
- "Factory",
38177
- "Heavy Industrial",
38178
- "Industrial Park",
38179
- "Light Industrial",
38180
- "Storage",
38181
- "Showroom",
38182
- "Warehouse",
38183
- "Land (Commercial)",
38184
- "Commercial Development",
38185
- "Industrial Development",
38186
- "Residential Development",
38187
- "Commercial Property",
38188
- "Data Centre",
38189
- "Farm",
38190
- "Healthcare Facility",
38191
- "Marine Property",
38192
- "Mixed Use",
38193
- "Research & Development Facility",
38194
- "Science Park",
38195
- "Guest House",
38196
- "Hospitality",
38197
- "Leisure Facility",
38198
- "Takeaway",
38199
- "Childcare Facility",
38200
- "Smallholding",
38201
- "Place of Worship",
38202
- "Trade Counter",
38203
- "Coach House",
38204
- "House of Multiple Occupation",
38205
- "Sports facilities",
38206
- "Spa",
38207
- "Campsite & Holiday Village"
38208
- ]
38103
+ "type": "string"
38209
38104
  },
38210
38105
  "marketingTenure": {
38211
38106
  "title": "Marketing Tenure",
package/src/schemas/v3/overlays/baspi.json CHANGED
@@ -5477,41 +5477,8 @@
5477
5477
  "properties": {
5478
5478
  "flooding": {
5479
5479
  "baspiRef": "A11.1.1",
5480
- "discriminator": {
5481
- "propertyName": "hasBeenFlooded"
5482
- },
5483
- "oneOf": [
5484
- {
5485
- "properties": {
5486
- "hasBeenFlooded": {
5487
- "enum": [
5488
- "No"
5489
- ]
5490
- }
5491
- }
5492
- },
5493
- {
5494
- "properties": {
5495
- "hasBeenFlooded": {
5496
- "enum": [
5497
- "Yes"
5498
- ]
5499
- },
5500
- "typeOfFlooding": {
5501
- "baspiRef": "A11.1.2.2"
5502
- },
5503
- "details": {
5504
- "baspiRef": "A11.1.2.1"
5505
- }
5506
- },
5507
- "required": [
5508
- "typeOfFlooding",
5509
- "details"
5510
- ]
5511
- }
5512
- ],
5513
5480
  "required": [
5514
- "hasBeenFlooded"
5481
+ "historicalFlooding"
5515
5482
  ],
5516
5483
  "properties": {
5517
5484
  "floodRisk": {
@@ -5524,8 +5491,49 @@
5524
5491
  }
5525
5492
  }
5526
5493
  },
5527
- "hasBeenFlooded": {
5528
- "baspiRef": "A11.1.2"
5494
+ "historicalFlooding": {
5495
+ "baspiRef": "A11.1.2",
5496
+ "discriminator": {
5497
+ "propertyName": "hasBeenFlooded"
5498
+ },
5499
+ "oneOf": [
5500
+ {
5501
+ "properties": {
5502
+ "hasBeenFlooded": {
5503
+ "enum": [
5504
+ "No"
5505
+ ]
5506
+ }
5507
+ }
5508
+ },
5509
+ {
5510
+ "properties": {
5511
+ "hasBeenFlooded": {
5512
+ "enum": [
5513
+ "Yes"
5514
+ ]
5515
+ },
5516
+ "typeOfFlooding": {
5517
+ "baspiRef": "A11.1.2.2"
5518
+ },
5519
+ "details": {
5520
+ "baspiRef": "A11.1.2.1"
5521
+ }
5522
+ },
5523
+ "required": [
5524
+ "typeOfFlooding",
5525
+ "details"
5526
+ ]
5527
+ }
5528
+ ],
5529
+ "required": [
5530
+ "hasBeenFlooded"
5531
+ ],
5532
+ "properties": {
5533
+ "hasBeenFlooded": {
5534
+ "baspiRef": "A11.1.2.1"
5535
+ }
5536
+ }
5529
5537
  }
5530
5538
  }
5531
5539
  },
@@ -5596,12 +5604,12 @@
5596
5604
  "otherEnvironmental": {
5597
5605
  "baspiRef": "A11.1.4",
5598
5606
  "discriminator": {
5599
- "propertyName": "yesNo"
5607
+ "propertyName": "riskIndicator"
5600
5608
  },
5601
5609
  "oneOf": [
5602
5610
  {
5603
5611
  "properties": {
5604
- "yesNo": {
5612
+ "riskIndicator": {
5605
5613
  "enum": [
5606
5614
  "No",
5607
5615
  "Not known"
@@ -5611,25 +5619,25 @@
5611
5619
  },
5612
5620
  {
5613
5621
  "properties": {
5614
- "yesNo": {
5622
+ "riskIndicator": {
5615
5623
  "enum": [
5616
5624
  "Yes"
5617
5625
  ]
5618
5626
  },
5619
- "details": {
5627
+ "summary": {
5620
5628
  "baspiRef": "A11.1.4.2"
5621
5629
  }
5622
5630
  },
5623
5631
  "required": [
5624
- "details"
5632
+ "summary"
5625
5633
  ]
5626
5634
  }
5627
5635
  ],
5628
5636
  "required": [
5629
- "yesNo"
5637
+ "riskIndicator"
5630
5638
  ],
5631
5639
  "properties": {
5632
- "yesNo": {
5640
+ "riskIndicator": {
5633
5641
  "baspiRef": "A11.1.4.1"
5634
5642
  }
5635
5643
  }