@pdtf/schemas 3.0.0-3 → 3.0.0-4

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 (5) hide show
  1. package/package.json +1 -1
  2. package/src/schemas/v3/combined.json +97 -126
  3. package/src/schemas/v3/overlays/nts.json +142 -1
  4. package/src/schemas/v3/pdtf-transaction.json +85 -125
  5. package/src/schemas/v3/skeleton.json +7 -1
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-4",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
package/src/schemas/v3/combined.json CHANGED
@@ -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,98 @@
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",
578
455
  "properties": {
456
+ "propertyType": {
457
+ "ntsRef": "B1.1.1",
458
+ "title": "Type of property",
459
+ "type": "object",
460
+ "ntsRequired": ["mainType", "builtForm"],
461
+ "properties": {
462
+ "mainType": {
463
+ "type": "string",
464
+ "enum": [
465
+ "House",
466
+ "Bungalow",
467
+ "Maisonette",
468
+ "Flat",
469
+ "Park home",
470
+ "Other"
471
+ ]
472
+ }
473
+ },
474
+ "discriminator": {
475
+ "propertyName": "mainType"
476
+ },
477
+ "oneOf": [
478
+ {
479
+ "properties": {
480
+ "mainType": {
481
+ "enum": ["Other"]
482
+ },
483
+ "otherType": {
484
+ "ntsRef": "B1.1.1.1",
485
+ "title": "Please describe the other type of property build",
486
+ "type": "string",
487
+ "minLength": 1
488
+ }
489
+ },
490
+ "ntsRequired": ["otherType"]
491
+ },
492
+ {
493
+ "properties": {
494
+ "mainType": {
495
+ "enum": ["House", "Bungalow"]
496
+ },
497
+ "builtForm": {
498
+ "ntsRef": "B1.1.2",
499
+ "title": "Built form",
500
+ "type": "string",
501
+ "enum": [
502
+ "Detached",
503
+ "Semi-detached",
504
+ "Terraced",
505
+ "End of terrace",
506
+ "Other"
507
+ ]
508
+ }
509
+ }
510
+ },
511
+ {
512
+ "properties": {
513
+ "mainType": {
514
+ "enum": ["Maisonette", "Flat"]
515
+ },
516
+ "builtForm": {
517
+ "ntsRef": "B1.1.2",
518
+ "title": "Built form",
519
+ "type": "string",
520
+ "enum": [
521
+ "Detached",
522
+ "Semi-detached",
523
+ "Terraced",
524
+ "End of terrace",
525
+ "Other"
526
+ ]
527
+ },
528
+ "numberOfFloors": {
529
+ "ntsRef": "B1.1.3",
530
+ "title": "Number of floors in the building",
531
+ "type": "integer"
532
+ },
533
+ "entranceFloor": {
534
+ "ntsRef": "B1.1.4",
535
+ "title": "Entrance floor",
536
+ "description": "The floor on which the main entrance to the property is located, starting with 1 for the ground floor (0 for a basement)",
537
+ "type": "integer"
538
+ }
539
+ },
540
+ "ntsRequired": ["numberOfFloors", "entranceFloor"]
541
+ }
542
+ ]
543
+ },
579
544
  "internalArea": {
580
545
  "title": "Total internal floor area",
581
546
  "type": "object",
@@ -8104,6 +8069,7 @@
8104
8069
  "enum": ["Yes"]
8105
8070
  },
8106
8071
  "details": {
8072
+ "ntsRef": "C2.1.1.2",
8107
8073
  "baspiRef": "A1.7.1.2",
8108
8074
  "ta6Ref": "4.7a2",
8109
8075
  "title": "Please provide details of the listing and any relevant documents",
@@ -8162,6 +8128,7 @@
8162
8128
  "enum": ["Yes"]
8163
8129
  },
8164
8130
  "details": {
8131
+ "ntsRef": "C2.1.2.2",
8165
8132
  "baspiRef": "A1.7.2.2",
8166
8133
  "ta6Ref": "4.7b2",
8167
8134
  "title": "Please provide details of the listing and any relevant documents",
@@ -8220,6 +8187,7 @@
8220
8187
  "enum": ["Yes"]
8221
8188
  },
8222
8189
  "workCarriedOut": {
8190
+ "ntsRef": "C2.1.3.2",
8223
8191
  "baspiRef": "A1.7.3.2",
8224
8192
  "rdsRef": "WorksAlterationsChanges",
8225
8193
  "ta6Ref": "4.8a",
@@ -8255,6 +8223,7 @@
8255
8223
  "enum": ["Yes"]
8256
8224
  },
8257
8225
  "consentsObtained": {
8226
+ "ntsRef": "C2.1.3.3",
8258
8227
  "baspiRef": "A1.7.3.3",
8259
8228
  "ta6Ref": "4.8a2",
8260
8229
  "title": "Were the relevant consents obtained?",
@@ -8263,6 +8232,7 @@
8263
8232
  "enum": ["Yes", "No", "Not known"]
8264
8233
  },
8265
8234
  "attachments": {
8235
+ "ntsRef": "C2.1.3.4",
8266
8236
  "baspiRef": "A1.7.3.4",
8267
8237
  "ta6Ref": "4.8a3",
8268
8238
  "title": "Provide any relevant documentation",
@@ -8270,6 +8240,7 @@
8270
8240
  "enum": ["Attached", "To follow"]
8271
8241
  }
8272
8242
  },
8243
+ "ntsRequired": ["consentsObtained"],
8273
8244
  "baspiRequired": ["consentsObtained"],
8274
8245
  "ta6Required": ["consentsObtained"]
8275
8246
  }
package/src/schemas/v3/overlays/nts.json CHANGED
@@ -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,93 @@
67
67
  ]
68
68
  },
69
69
  "buildInformation": {
70
+ "ntsRef": "B1.1",
71
+ "title": "About the property building",
70
72
  "properties": {
73
+ "propertyType": {
74
+ "ntsRef": "B1.1.1",
75
+ "title": "Type of property",
76
+ "discriminator": {
77
+ "propertyName": "mainType"
78
+ },
79
+ "oneOf": [
80
+ {
81
+ "properties": {
82
+ "mainType": {
83
+ "enum": [
84
+ "Other"
85
+ ]
86
+ },
87
+ "otherType": {
88
+ "ntsRef": "B1.1.1.1",
89
+ "title": "Please describe the other type of property build"
90
+ }
91
+ },
92
+ "required": [
93
+ "otherType"
94
+ ]
95
+ },
96
+ {
97
+ "properties": {
98
+ "mainType": {
99
+ "enum": [
100
+ "House",
101
+ "Bungalow"
102
+ ]
103
+ },
104
+ "builtForm": {
105
+ "ntsRef": "B1.1.2",
106
+ "title": "Built form",
107
+ "enum": [
108
+ "Detached",
109
+ "Semi-detached",
110
+ "Terraced",
111
+ "End of terrace",
112
+ "Other"
113
+ ]
114
+ }
115
+ }
116
+ },
117
+ {
118
+ "properties": {
119
+ "mainType": {
120
+ "enum": [
121
+ "Maisonette",
122
+ "Flat"
123
+ ]
124
+ },
125
+ "builtForm": {
126
+ "ntsRef": "B1.1.2",
127
+ "title": "Built form",
128
+ "enum": [
129
+ "Detached",
130
+ "Semi-detached",
131
+ "Terraced",
132
+ "End of terrace",
133
+ "Other"
134
+ ]
135
+ },
136
+ "numberOfFloors": {
137
+ "ntsRef": "B1.1.3",
138
+ "title": "Number of floors in the building"
139
+ },
140
+ "entranceFloor": {
141
+ "ntsRef": "B1.1.4",
142
+ "title": "Entrance floor",
143
+ "description": "The floor on which the main entrance to the property is located, starting with 1 for the ground floor (0 for a basement)"
144
+ }
145
+ },
146
+ "required": [
147
+ "numberOfFloors",
148
+ "entranceFloor"
149
+ ]
150
+ }
151
+ ],
152
+ "required": [
153
+ "mainType",
154
+ "builtForm"
155
+ ]
156
+ },
71
157
  "rooms": {
72
158
  "ntsRef": "B2",
73
159
  "title": "Rooms",
@@ -463,6 +549,10 @@
463
549
  "enum": [
464
550
  "Yes"
465
551
  ]
552
+ },
553
+ "details": {
554
+ "ntsRef": "C2.1.1.2",
555
+ "title": "Please provide details of the listing and any relevant documents"
466
556
  }
467
557
  }
468
558
  }
@@ -504,6 +594,10 @@
504
594
  "enum": [
505
595
  "Yes"
506
596
  ]
597
+ },
598
+ "details": {
599
+ "ntsRef": "C2.1.2.2",
600
+ "title": "Please provide details of the listing and any relevant documents"
507
601
  }
508
602
  }
509
603
  }
@@ -545,6 +639,53 @@
545
639
  "enum": [
546
640
  "Yes"
547
641
  ]
642
+ },
643
+ "workCarriedOut": {
644
+ "ntsRef": "C2.1.3.2",
645
+ "title": "Has work been carried out to any trees which are protected by the order?",
646
+ "discriminator": {
647
+ "propertyName": "yesNo"
648
+ },
649
+ "oneOf": [
650
+ {
651
+ "properties": {
652
+ "yesNo": {
653
+ "enum": [
654
+ "No"
655
+ ]
656
+ }
657
+ }
658
+ },
659
+ {
660
+ "properties": {
661
+ "yesNo": {
662
+ "enum": [
663
+ "Yes"
664
+ ]
665
+ },
666
+ "consentsObtained": {
667
+ "ntsRef": "C2.1.3.3",
668
+ "title": "Were the relevant consents obtained?",
669
+ "enum": [
670
+ "Yes",
671
+ "No",
672
+ "Not known"
673
+ ]
674
+ },
675
+ "attachments": {
676
+ "ntsRef": "C2.1.3.4",
677
+ "title": "Provide any relevant documentation",
678
+ "enum": [
679
+ "Attached",
680
+ "To follow"
681
+ ]
682
+ }
683
+ },
684
+ "required": [
685
+ "consentsObtained"
686
+ ]
687
+ }
688
+ ]
548
689
  }
549
690
  }
550
691
  }
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -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
+ "propertyType": {
355
+ "title": "Type of property",
356
+ "type": "object",
357
+ "properties": {
358
+ "mainType": {
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
+ "mainType": {
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
+ "mainType": {
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
+ "mainType": {
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",
package/src/schemas/v3/skeleton.json CHANGED
@@ -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
+ "propertyType": {
75
+ "mainType": {},
76
+ "otherType": {},
77
+ "builtForm": {},
78
+ "numberOfFloors": {},
79
+ "entranceFloor": {}
80
+ },
75
81
  "internalArea": {
76
82
  "area": {},
77
83
  "units": {}