@pdtf/schemas 3.0.0-3 → 3.0.0-5

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.0.0-3",
3
+ "version": "3.0.0-5",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -39,6 +39,9 @@
39
39
  "town": "HARPENDEN",
40
40
  "postcode": "AL3 5AF"
41
41
  },
42
+ "buildInformation": {
43
+ "building": { "propertyType": "House", "builtForm": "Detached" }
44
+ },
42
45
  "delayFactors": {
43
46
  "hasDelayFactors": { "yesNo": "No" }
44
47
  },
@@ -187,7 +187,7 @@
187
187
  "ownership",
188
188
  "councilTax",
189
189
  "energyEfficiency",
190
- "propertyType",
190
+ "buildInformation",
191
191
  "typeOfConstruction",
192
192
  "connectedUtilities",
193
193
  "waterAndDrainage",
@@ -265,130 +265,6 @@
265
265
  "title": "Unique Property Reference Number ",
266
266
  "type": "integer"
267
267
  },
268
- "propertyType": {
269
- "title": "Type of Property",
270
- "description": "The type or category of the property.",
271
- "type": "string",
272
- "enum": [
273
- "Not Specified",
274
- "Terraced House",
275
- "End of terrace house",
276
- "Semi-detached house",
277
- "Detached house",
278
- "Mews house",
279
- "Cluster house",
280
- "Ground floor flat",
281
- "Flat",
282
- "Studio flat",
283
- "Ground floor maisonette",
284
- "Maisonette",
285
- "Bungalow",
286
- "Terraced bungalow",
287
- "Semi-detached bungalow",
288
- "Detached bungalow",
289
- "Mobile home",
290
- "Land (Residential)",
291
- "Link detached house",
292
- "Town house",
293
- "Cottage",
294
- "Chalet",
295
- "Character Property",
296
- "House (unspecified)",
297
- "Villa",
298
- "Apartment",
299
- "Penthouse",
300
- "Finca",
301
- "Barn Conversion",
302
- "Serviced apartment",
303
- "Parking",
304
- "Sheltered Housing",
305
- "Reteirment property",
306
- "House share",
307
- "Flat share",
308
- "Park home",
309
- "Garages",
310
- "Farm House",
311
- "Equestrian facility",
312
- "Duplex",
313
- "Triplex",
314
- "Longere",
315
- "Gite",
316
- "Barn",
317
- "Trulli",
318
- "Mill",
319
- "Ruins",
320
- "Restaurant",
321
- "Cafe",
322
- "Castle",
323
- "Village House",
324
- "Cave House",
325
- "Cortijo",
326
- "Farm Land",
327
- "Plot",
328
- "Country House",
329
- "Stone House",
330
- "Caravan",
331
- "Lodge",
332
- "Log Cabin",
333
- "Manor House",
334
- "Stately Home",
335
- "Off-Plan",
336
- "Semi-detached Villa",
337
- "Detached Villa",
338
- "Bar/Nightclub",
339
- "Shop",
340
- "Riad",
341
- "House Boat",
342
- "Hotel Room",
343
- "Block of Apartments",
344
- "Private Halls",
345
- "Office",
346
- "Business Park",
347
- "Serviced Office",
348
- "Retail Property (High Street)",
349
- "Retail Property (Out of Town)",
350
- "Convenience Store",
351
- "Hairdresser/Barber Shop",
352
- "Hotel",
353
- "Petrol Station",
354
- "Post Office",
355
- "Pub",
356
- "Workshop & Retail Space",
357
- "Distribution Warehouse",
358
- "Factory",
359
- "Heavy Industrial",
360
- "Industrial Park",
361
- "Light Industrial",
362
- "Storage",
363
- "Showroom",
364
- "Warehouse",
365
- "Land (Commercial)",
366
- "Commercial Development",
367
- "Industrial Development",
368
- "Residential Development",
369
- "Commercial Property",
370
- "Data Centre",
371
- "Farm",
372
- "Healthcare Facility",
373
- "Marine Property",
374
- "Mixed Use",
375
- "Research & Development Facility",
376
- "Science Park",
377
- "Guest House",
378
- "Hospitality",
379
- "Leisure Facility",
380
- "Takeaway",
381
- "Childcare Facility",
382
- "Smallholding",
383
- "Place of Worship",
384
- "Trade Counter",
385
- "Coach House",
386
- "House of Multiple Occupation",
387
- "Sports facilities",
388
- "Spa",
389
- "Campsite & Holiday Village"
390
- ]
391
- },
392
268
  "isNewBuild": {
393
269
  "title": "Is the property a New Build?",
394
270
  "type": "object",
@@ -573,9 +449,104 @@
573
449
  }
574
450
  },
575
451
  "buildInformation": {
576
- "title": "Information related to property build",
452
+ "ntsRef": "B1.1",
453
+ "title": "About the property building",
577
454
  "type": "object",
455
+ "ntsRequired": ["building"],
578
456
  "properties": {
457
+ "building": {
458
+ "ntsRef": "B1.1.1",
459
+ "title": "Building informatiom",
460
+ "type": "object",
461
+ "ntsRequired": ["propertyType"],
462
+ "properties": {
463
+ "propertyType": {
464
+ "type": "string",
465
+ "enum": [
466
+ "House",
467
+ "Bungalow",
468
+ "Maisonette",
469
+ "Flat",
470
+ "Park home",
471
+ "Other"
472
+ ]
473
+ }
474
+ },
475
+ "discriminator": {
476
+ "propertyName": "propertyType"
477
+ },
478
+ "oneOf": [
479
+ {
480
+ "properties": {
481
+ "propertyType": {
482
+ "enum": ["Other"]
483
+ },
484
+ "otherType": {
485
+ "ntsRef": "B1.1.1.1",
486
+ "title": "Please describe the other type of property build",
487
+ "type": "string",
488
+ "minLength": 1
489
+ }
490
+ },
491
+ "ntsRequired": ["otherType"]
492
+ },
493
+ {
494
+ "properties": {
495
+ "propertyType": {
496
+ "enum": ["House", "Bungalow"]
497
+ },
498
+ "builtForm": {
499
+ "ntsRef": "B1.1.2",
500
+ "title": "Built form",
501
+ "type": "string",
502
+ "enum": [
503
+ "Detached",
504
+ "Semi-detached",
505
+ "Terraced",
506
+ "End of terrace",
507
+ "Other"
508
+ ]
509
+ }
510
+ },
511
+ "ntsRequired": ["builtForm"]
512
+ },
513
+ {
514
+ "properties": {
515
+ "propertyType": {
516
+ "enum": ["Maisonette", "Flat"]
517
+ },
518
+ "builtForm": {
519
+ "ntsRef": "B1.1.2",
520
+ "title": "Built form",
521
+ "type": "string",
522
+ "enum": [
523
+ "Detached",
524
+ "Semi-detached",
525
+ "Terraced",
526
+ "End of terrace",
527
+ "Other"
528
+ ]
529
+ },
530
+ "numberOfFloors": {
531
+ "ntsRef": "B1.1.3",
532
+ "title": "Number of floors in the building",
533
+ "type": "integer"
534
+ },
535
+ "entranceFloor": {
536
+ "ntsRef": "B1.1.4",
537
+ "title": "Entrance floor",
538
+ "description": "The floor on which the main entrance to the property is located, starting with 1 for the ground floor (0 for a basement)",
539
+ "type": "integer"
540
+ }
541
+ },
542
+ "ntsRequired": [
543
+ "builtForm",
544
+ "numberOfFloors",
545
+ "entranceFloor"
546
+ ]
547
+ }
548
+ ]
549
+ },
579
550
  "internalArea": {
580
551
  "title": "Total internal floor area",
581
552
  "type": "object",
@@ -8104,6 +8075,7 @@
8104
8075
  "enum": ["Yes"]
8105
8076
  },
8106
8077
  "details": {
8078
+ "ntsRef": "C2.1.1.2",
8107
8079
  "baspiRef": "A1.7.1.2",
8108
8080
  "ta6Ref": "4.7a2",
8109
8081
  "title": "Please provide details of the listing and any relevant documents",
@@ -8162,6 +8134,7 @@
8162
8134
  "enum": ["Yes"]
8163
8135
  },
8164
8136
  "details": {
8137
+ "ntsRef": "C2.1.2.2",
8165
8138
  "baspiRef": "A1.7.2.2",
8166
8139
  "ta6Ref": "4.7b2",
8167
8140
  "title": "Please provide details of the listing and any relevant documents",
@@ -8220,6 +8193,7 @@
8220
8193
  "enum": ["Yes"]
8221
8194
  },
8222
8195
  "workCarriedOut": {
8196
+ "ntsRef": "C2.1.3.2",
8223
8197
  "baspiRef": "A1.7.3.2",
8224
8198
  "rdsRef": "WorksAlterationsChanges",
8225
8199
  "ta6Ref": "4.8a",
@@ -8237,6 +8211,7 @@
8237
8211
  }
8238
8212
  },
8239
8213
  "baspiRequired": ["yesNo"],
8214
+ "ntsRequired": ["yesNo"],
8240
8215
  "ta6Required": ["yesNo"],
8241
8216
  "discriminator": {
8242
8217
  "propertyName": "yesNo"
@@ -8255,6 +8230,7 @@
8255
8230
  "enum": ["Yes"]
8256
8231
  },
8257
8232
  "consentsObtained": {
8233
+ "ntsRef": "C2.1.3.3",
8258
8234
  "baspiRef": "A1.7.3.3",
8259
8235
  "ta6Ref": "4.8a2",
8260
8236
  "title": "Were the relevant consents obtained?",
@@ -8263,6 +8239,7 @@
8263
8239
  "enum": ["Yes", "No", "Not known"]
8264
8240
  },
8265
8241
  "attachments": {
8242
+ "ntsRef": "C2.1.3.4",
8266
8243
  "baspiRef": "A1.7.3.4",
8267
8244
  "ta6Ref": "4.8a3",
8268
8245
  "title": "Provide any relevant documentation",
@@ -8270,6 +8247,7 @@
8270
8247
  "enum": ["Attached", "To follow"]
8271
8248
  }
8272
8249
  },
8250
+ "ntsRequired": ["consentsObtained"],
8273
8251
  "baspiRequired": ["consentsObtained"],
8274
8252
  "ta6Required": ["consentsObtained"]
8275
8253
  }
@@ -17,7 +17,7 @@
17
17
  "ownership",
18
18
  "councilTax",
19
19
  "energyEfficiency",
20
- "propertyType",
20
+ "buildInformation",
21
21
  "typeOfConstruction",
22
22
  "connectedUtilities",
23
23
  "waterAndDrainage",
@@ -67,7 +67,99 @@
67
67
  ]
68
68
  },
69
69
  "buildInformation": {
70
+ "ntsRef": "B1.1",
71
+ "title": "About the property building",
72
+ "required": [
73
+ "building"
74
+ ],
70
75
  "properties": {
76
+ "building": {
77
+ "ntsRef": "B1.1.1",
78
+ "title": "Building informatiom",
79
+ "discriminator": {
80
+ "propertyName": "propertyType"
81
+ },
82
+ "oneOf": [
83
+ {
84
+ "properties": {
85
+ "propertyType": {
86
+ "enum": [
87
+ "Other"
88
+ ]
89
+ },
90
+ "otherType": {
91
+ "ntsRef": "B1.1.1.1",
92
+ "title": "Please describe the other type of property build"
93
+ }
94
+ },
95
+ "required": [
96
+ "otherType"
97
+ ]
98
+ },
99
+ {
100
+ "properties": {
101
+ "propertyType": {
102
+ "enum": [
103
+ "House",
104
+ "Bungalow"
105
+ ]
106
+ },
107
+ "builtForm": {
108
+ "ntsRef": "B1.1.2",
109
+ "title": "Built form",
110
+ "enum": [
111
+ "Detached",
112
+ "Semi-detached",
113
+ "Terraced",
114
+ "End of terrace",
115
+ "Other"
116
+ ]
117
+ }
118
+ },
119
+ "required": [
120
+ "builtForm"
121
+ ]
122
+ },
123
+ {
124
+ "properties": {
125
+ "propertyType": {
126
+ "enum": [
127
+ "Maisonette",
128
+ "Flat"
129
+ ]
130
+ },
131
+ "builtForm": {
132
+ "ntsRef": "B1.1.2",
133
+ "title": "Built form",
134
+ "enum": [
135
+ "Detached",
136
+ "Semi-detached",
137
+ "Terraced",
138
+ "End of terrace",
139
+ "Other"
140
+ ]
141
+ },
142
+ "numberOfFloors": {
143
+ "ntsRef": "B1.1.3",
144
+ "title": "Number of floors in the building"
145
+ },
146
+ "entranceFloor": {
147
+ "ntsRef": "B1.1.4",
148
+ "title": "Entrance floor",
149
+ "description": "The floor on which the main entrance to the property is located, starting with 1 for the ground floor (0 for a basement)"
150
+ }
151
+ },
152
+ "required": [
153
+ "builtForm",
154
+ "numberOfFloors",
155
+ "entranceFloor"
156
+ ]
157
+ }
158
+ ],
159
+ "required": [
160
+ "propertyType"
161
+ ]
162
+ },
71
163
  "rooms": {
72
164
  "ntsRef": "B2",
73
165
  "title": "Rooms",
@@ -463,6 +555,10 @@
463
555
  "enum": [
464
556
  "Yes"
465
557
  ]
558
+ },
559
+ "details": {
560
+ "ntsRef": "C2.1.1.2",
561
+ "title": "Please provide details of the listing and any relevant documents"
466
562
  }
467
563
  }
468
564
  }
@@ -504,6 +600,10 @@
504
600
  "enum": [
505
601
  "Yes"
506
602
  ]
603
+ },
604
+ "details": {
605
+ "ntsRef": "C2.1.2.2",
606
+ "title": "Please provide details of the listing and any relevant documents"
507
607
  }
508
608
  }
509
609
  }
@@ -545,6 +645,56 @@
545
645
  "enum": [
546
646
  "Yes"
547
647
  ]
648
+ },
649
+ "workCarriedOut": {
650
+ "ntsRef": "C2.1.3.2",
651
+ "title": "Has work been carried out to any trees which are protected by the order?",
652
+ "discriminator": {
653
+ "propertyName": "yesNo"
654
+ },
655
+ "oneOf": [
656
+ {
657
+ "properties": {
658
+ "yesNo": {
659
+ "enum": [
660
+ "No"
661
+ ]
662
+ }
663
+ }
664
+ },
665
+ {
666
+ "properties": {
667
+ "yesNo": {
668
+ "enum": [
669
+ "Yes"
670
+ ]
671
+ },
672
+ "consentsObtained": {
673
+ "ntsRef": "C2.1.3.3",
674
+ "title": "Were the relevant consents obtained?",
675
+ "enum": [
676
+ "Yes",
677
+ "No",
678
+ "Not known"
679
+ ]
680
+ },
681
+ "attachments": {
682
+ "ntsRef": "C2.1.3.4",
683
+ "title": "Provide any relevant documentation",
684
+ "enum": [
685
+ "Attached",
686
+ "To follow"
687
+ ]
688
+ }
689
+ },
690
+ "required": [
691
+ "consentsObtained"
692
+ ]
693
+ }
694
+ ],
695
+ "required": [
696
+ "yesNo"
697
+ ]
548
698
  }
549
699
  }
550
700
  }
@@ -164,130 +164,6 @@
164
164
  "title": "Unique Property Reference Number ",
165
165
  "type": "integer"
166
166
  },
167
- "propertyType": {
168
- "title": "Type of Property",
169
- "description": "The type or category of the property.",
170
- "type": "string",
171
- "enum": [
172
- "Not Specified",
173
- "Terraced House",
174
- "End of terrace house",
175
- "Semi-detached house",
176
- "Detached house",
177
- "Mews house",
178
- "Cluster house",
179
- "Ground floor flat",
180
- "Flat",
181
- "Studio flat",
182
- "Ground floor maisonette",
183
- "Maisonette",
184
- "Bungalow",
185
- "Terraced bungalow",
186
- "Semi-detached bungalow",
187
- "Detached bungalow",
188
- "Mobile home",
189
- "Land (Residential)",
190
- "Link detached house",
191
- "Town house",
192
- "Cottage",
193
- "Chalet",
194
- "Character Property",
195
- "House (unspecified)",
196
- "Villa",
197
- "Apartment",
198
- "Penthouse",
199
- "Finca",
200
- "Barn Conversion",
201
- "Serviced apartment",
202
- "Parking",
203
- "Sheltered Housing",
204
- "Reteirment property",
205
- "House share",
206
- "Flat share",
207
- "Park home",
208
- "Garages",
209
- "Farm House",
210
- "Equestrian facility",
211
- "Duplex",
212
- "Triplex",
213
- "Longere",
214
- "Gite",
215
- "Barn",
216
- "Trulli",
217
- "Mill",
218
- "Ruins",
219
- "Restaurant",
220
- "Cafe",
221
- "Castle",
222
- "Village House",
223
- "Cave House",
224
- "Cortijo",
225
- "Farm Land",
226
- "Plot",
227
- "Country House",
228
- "Stone House",
229
- "Caravan",
230
- "Lodge",
231
- "Log Cabin",
232
- "Manor House",
233
- "Stately Home",
234
- "Off-Plan",
235
- "Semi-detached Villa",
236
- "Detached Villa",
237
- "Bar/Nightclub",
238
- "Shop",
239
- "Riad",
240
- "House Boat",
241
- "Hotel Room",
242
- "Block of Apartments",
243
- "Private Halls",
244
- "Office",
245
- "Business Park",
246
- "Serviced Office",
247
- "Retail Property (High Street)",
248
- "Retail Property (Out of Town)",
249
- "Convenience Store",
250
- "Hairdresser/Barber Shop",
251
- "Hotel",
252
- "Petrol Station",
253
- "Post Office",
254
- "Pub",
255
- "Workshop & Retail Space",
256
- "Distribution Warehouse",
257
- "Factory",
258
- "Heavy Industrial",
259
- "Industrial Park",
260
- "Light Industrial",
261
- "Storage",
262
- "Showroom",
263
- "Warehouse",
264
- "Land (Commercial)",
265
- "Commercial Development",
266
- "Industrial Development",
267
- "Residential Development",
268
- "Commercial Property",
269
- "Data Centre",
270
- "Farm",
271
- "Healthcare Facility",
272
- "Marine Property",
273
- "Mixed Use",
274
- "Research & Development Facility",
275
- "Science Park",
276
- "Guest House",
277
- "Hospitality",
278
- "Leisure Facility",
279
- "Takeaway",
280
- "Childcare Facility",
281
- "Smallholding",
282
- "Place of Worship",
283
- "Trade Counter",
284
- "Coach House",
285
- "House of Multiple Occupation",
286
- "Sports facilities",
287
- "Spa",
288
- "Campsite & Holiday Village"
289
- ]
290
- },
291
167
  "isNewBuild": {
292
168
  "title": "Is the property a New Build?",
293
169
  "type": "object",
@@ -472,9 +348,93 @@
472
348
  }
473
349
  },
474
350
  "buildInformation": {
475
- "title": "Information related to property build",
351
+ "title": "About the property building",
476
352
  "type": "object",
477
353
  "properties": {
354
+ "building": {
355
+ "title": "Building informatiom",
356
+ "type": "object",
357
+ "properties": {
358
+ "propertyType": {
359
+ "type": "string",
360
+ "enum": [
361
+ "House",
362
+ "Bungalow",
363
+ "Maisonette",
364
+ "Flat",
365
+ "Park home",
366
+ "Other"
367
+ ]
368
+ }
369
+ },
370
+ "oneOf": [
371
+ {
372
+ "properties": {
373
+ "propertyType": {
374
+ "enum": [
375
+ "Other"
376
+ ]
377
+ },
378
+ "otherType": {
379
+ "title": "Please describe the other type of property build",
380
+ "type": "string",
381
+ "minLength": 1
382
+ }
383
+ }
384
+ },
385
+ {
386
+ "properties": {
387
+ "propertyType": {
388
+ "enum": [
389
+ "House",
390
+ "Bungalow"
391
+ ]
392
+ },
393
+ "builtForm": {
394
+ "title": "Built form",
395
+ "type": "string",
396
+ "enum": [
397
+ "Detached",
398
+ "Semi-detached",
399
+ "Terraced",
400
+ "End of terrace",
401
+ "Other"
402
+ ]
403
+ }
404
+ }
405
+ },
406
+ {
407
+ "properties": {
408
+ "propertyType": {
409
+ "enum": [
410
+ "Maisonette",
411
+ "Flat"
412
+ ]
413
+ },
414
+ "builtForm": {
415
+ "title": "Built form",
416
+ "type": "string",
417
+ "enum": [
418
+ "Detached",
419
+ "Semi-detached",
420
+ "Terraced",
421
+ "End of terrace",
422
+ "Other"
423
+ ]
424
+ },
425
+ "numberOfFloors": {
426
+ "title": "Number of floors in the building",
427
+ "type": "integer"
428
+ },
429
+ "entranceFloor": {
430
+ "title": "Entrance floor",
431
+ "description": "The floor on which the main entrance to the property is located, starting with 1 for the ground floor (0 for a basement)",
432
+ "type": "integer"
433
+ }
434
+ }
435
+ }
436
+ ]
437
+ },
478
438
  "internalArea": {
479
439
  "title": "Total internal floor area",
480
440
  "type": "object",
@@ -34,7 +34,6 @@
34
34
  "postcode": {}
35
35
  },
36
36
  "uprn": {},
37
- "propertyType": {},
38
37
  "isNewBuild": {
39
38
  "yesNo": {}
40
39
  },
@@ -72,6 +71,13 @@
72
71
  "caption": {}
73
72
  },
74
73
  "buildInformation": {
74
+ "building": {
75
+ "propertyType": {},
76
+ "otherType": {},
77
+ "builtForm": {},
78
+ "numberOfFloors": {},
79
+ "entranceFloor": {}
80
+ },
75
81
  "internalArea": {
76
82
  "area": {},
77
83
  "units": {}