@pdtf/schemas 2.3.0-2 → 2.3.0-3

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": "2.3.0-2",
3
+ "version": "2.3.0-3",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -1013,7 +1013,7 @@
1013
1013
  "ownership": {
1014
1014
  "baspiRef": "A1.3",
1015
1015
  "ta7Ref": "1",
1016
- "ntsRef": "A1.1",
1016
+ "ntsRef": "A1",
1017
1017
  "title": "Ownership",
1018
1018
  "type": "object",
1019
1019
  "baspiRequired": ["ownershipsToBeTransferred"],
@@ -1022,11 +1022,13 @@
1022
1022
  "ownershipsToBeTransferred": {
1023
1023
  "baspiRef": "A1.3",
1024
1024
  "ta7Ref": "1",
1025
+ "ntsRef": "A1",
1025
1026
  "title": "Ownerships to be transferred on sale",
1026
1027
  "type": "array",
1027
1028
  "minItems": 1,
1028
1029
  "items": {
1029
1030
  "baspiRef": "A1.3.0",
1031
+ "ntsRef": "A1.1",
1030
1032
  "title": "Ownership to be transferred",
1031
1033
  "type": "object",
1032
1034
  "baspiRequired": ["ownershipType"],
@@ -1043,6 +1045,7 @@
1043
1045
  "rdsRef": "Tenure/Tenure",
1044
1046
  "ta7Ref": "1.1",
1045
1047
  "piqRef": "A1.2",
1048
+ "ntsRef": "A1.1.1",
1046
1049
  "title": "What type of ownership is the property?",
1047
1050
  "description": "A Managed Freehold is any freehold where there are shared amenities, the maintenance of which you pay for through an estate rentcharge, service charge, informal or formal contribution. Choose Leasehold if your property is under a Shared Ownership arrangement.",
1048
1051
  "type": "string",
@@ -3327,6 +3330,7 @@
3327
3330
  },
3328
3331
  "leaseholdInformation": {
3329
3332
  "baspiRef": "A1.5",
3333
+ "ntsRef": "A1.2",
3330
3334
  "title": "Leasehold information",
3331
3335
  "type": "object",
3332
3336
  "lpe1Required": [
@@ -3349,6 +3353,12 @@
3349
3353
  "transferAndRegistration",
3350
3354
  "serviceCharge"
3351
3355
  ],
3356
+ "ntsRequired": [
3357
+ "typeOfLeasehold",
3358
+ "leaseTerm",
3359
+ "groundRent",
3360
+ "serviceCharge"
3361
+ ],
3352
3362
  "ta7Required": [
3353
3363
  "typeOfLeasehold",
3354
3364
  "leaseTerm",
@@ -3363,9 +3373,11 @@
3363
3373
  "properties": {
3364
3374
  "typeOfLeasehold": {
3365
3375
  "baspiRef": "A1.3.1",
3376
+ "ntsRef": "A1.2",
3366
3377
  "type": "object",
3367
3378
  "lpe1Required": ["leaseholdType"],
3368
3379
  "baspiRequired": ["leaseholdType"],
3380
+ "ntsRequired": ["leaseholdType"],
3369
3381
  "properties": {
3370
3382
  "leaseholdType": {
3371
3383
  "baspiRef": "A1.3.1",
@@ -3439,6 +3451,7 @@
3439
3451
  },
3440
3452
  "leaseTerm": {
3441
3453
  "baspiRef": "A1.4.1",
3454
+ "ntsRef": "A1.2.1",
3442
3455
  "type": "object",
3443
3456
  "baspiRequired": [
3444
3457
  "startYearOfLease",
@@ -3451,13 +3464,13 @@
3451
3464
  "properties": {
3452
3465
  "startYearOfLease": {
3453
3466
  "baspiRef": "A1.4.1.1",
3454
- "ntsRef": "A1.2",
3467
+ "ntsRef": "A1.2.1.1",
3455
3468
  "title": "Year that the lease commenced",
3456
3469
  "type": "integer"
3457
3470
  },
3458
3471
  "lengthOfLeaseInYears": {
3459
3472
  "baspiRef": "A1.4.1.2",
3460
- "ntsRef": "A1.3",
3473
+ "ntsRef": "A1.2.1.2",
3461
3474
  "piqRef": "A1.3.1",
3462
3475
  "title": "Length of lease (years)",
3463
3476
  "type": "integer"
@@ -5365,6 +5378,10 @@
5365
5378
  "baspiRequired": [
5366
5379
  "annualGroundRent",
5367
5380
  "rentSubjectToIncrease"
5381
+ ],
5382
+ "ntsRequired": [
5383
+ "annualGroundRent",
5384
+ "rentSubjectToIncrease"
5368
5385
  ]
5369
5386
  }
5370
5387
  ]
@@ -5495,6 +5512,7 @@
5495
5512
  "serviceCharge": {
5496
5513
  "baspiRef": "A1.5.1",
5497
5514
  "lpe1Ref": "4",
5515
+ "ntsRef": "A1.5",
5498
5516
  "title": "Service Charge",
5499
5517
  "type": "object",
5500
5518
  "lpe1Required": [
@@ -5503,10 +5521,14 @@
5503
5521
  "baspiRequired": [
5504
5522
  "sellerContributesToServiceCharge"
5505
5523
  ],
5524
+ "ntsRequired": [
5525
+ "sellerContributesToServiceCharge"
5526
+ ],
5506
5527
  "properties": {
5507
5528
  "sellerContributesToServiceCharge": {
5508
5529
  "baspiRef": "A1.5.1.1",
5509
5530
  "ta7Ref": "5.4",
5531
+ "ntsRef": "A1.5.1",
5510
5532
  "title": "Does the seller contribute to the cost of maintaining the building (a service charge)?",
5511
5533
  "type": "string",
5512
5534
  "enum": ["Yes", "No"]
@@ -5531,6 +5553,7 @@
5531
5553
  "annualServiceCharge": {
5532
5554
  "baspiRef": "A1.5.1.1.2",
5533
5555
  "lpe1Ref": "4.1.1",
5556
+ "ntsRef": "A1.5.1.1",
5534
5557
  "title": "Amount of current annual service charge (£)",
5535
5558
  "type": "number"
5536
5559
  },
@@ -8234,6 +8257,7 @@
8234
8257
  "energyEfficiency": {
8235
8258
  "baspiRef": "A1.8.3",
8236
8259
  "ta6Ref": "7.6",
8260
+ "ntsRef": "A4",
8237
8261
  "rdsRef": "Certificates/{category='energyEfficiency',standard='EPC',gradeLevelRating=?},Certificates/{category='energyEfficiency',standard='EPC',status='exempt'},",
8238
8262
  "title": "Energy Efficiency",
8239
8263
  "type": "object",
@@ -8249,6 +8273,7 @@
8249
8273
  },
8250
8274
  "certificate": {
8251
8275
  "baspiRef": "A1.8.3.1",
8276
+ "ntsRef": "A4.1",
8252
8277
  "type": "object",
8253
8278
  "baspiRequired": ["currentEnergyRating"],
8254
8279
  "ntsRequired": ["currentEnergyRating"],
@@ -8300,6 +8325,7 @@
8300
8325
  },
8301
8326
  "currentEnergyRating": {
8302
8327
  "baspiRef": "A1.8.3.1.1",
8328
+ "ntsRef": "A4.1.1",
8303
8329
  "title": "Current energy efficiency rating",
8304
8330
  "description": "What is the energy efficiency rating of the property according to the latest Energy Performance Certificate (EPC)?",
8305
8331
  "type": "string",
@@ -44,34 +44,82 @@
44
44
  }
45
45
  },
46
46
  "ownership": {
47
- "ntsRef": "A1.1",
47
+ "ntsRef": "A1",
48
48
  "title": "Ownership",
49
49
  "required": [
50
50
  "ownershipsToBeTransferred"
51
51
  ],
52
52
  "properties": {
53
53
  "ownershipsToBeTransferred": {
54
+ "ntsRef": "A1",
55
+ "title": "Ownerships to be transferred on sale",
56
+ "minItems": 1,
54
57
  "items": {
55
- "required": [
56
- "ownershipType"
57
- ],
58
+ "ntsRef": "A1.1",
59
+ "title": "Ownership to be transferred",
60
+ "discriminator": {
61
+ "propertyName": "ownershipType"
62
+ },
58
63
  "oneOf": [
59
- null,
60
- null,
61
64
  {
62
65
  "properties": {
66
+ "ownershipType": {
67
+ "enum": [
68
+ "Freehold"
69
+ ]
70
+ }
71
+ }
72
+ },
73
+ {
74
+ "properties": {
75
+ "ownershipType": {
76
+ "enum": [
77
+ "Managed Freehold",
78
+ "Commonhold"
79
+ ]
80
+ }
81
+ }
82
+ },
83
+ {
84
+ "properties": {
85
+ "ownershipType": {
86
+ "enum": [
87
+ "Leasehold"
88
+ ]
89
+ },
63
90
  "leaseholdInformation": {
91
+ "ntsRef": "A1.2",
92
+ "title": "Leasehold information",
93
+ "required": [
94
+ "typeOfLeasehold",
95
+ "leaseTerm",
96
+ "groundRent",
97
+ "serviceCharge"
98
+ ],
64
99
  "properties": {
65
100
  "typeOfLeasehold": {
101
+ "ntsRef": "A1.2",
102
+ "discriminator": {
103
+ "propertyName": "leaseholdType"
104
+ },
66
105
  "oneOf": [
67
- null,
68
106
  {
69
- "required": [
70
- "sharedOwnershipPercentage",
71
- "sharedOwnershipRent",
72
- "sharedOwnershipRentFrequency"
73
- ],
74
107
  "properties": {
108
+ "leaseholdType": {
109
+ "enum": [
110
+ "Flat",
111
+ "Long leasehold house"
112
+ ]
113
+ }
114
+ }
115
+ },
116
+ {
117
+ "properties": {
118
+ "leaseholdType": {
119
+ "enum": [
120
+ "Shared ownership"
121
+ ]
122
+ },
75
123
  "sharedOwnershipPercentage": {
76
124
  "ntsRef": "A1.7.1",
77
125
  "title": "Shared ownership percentage"
@@ -89,22 +137,31 @@
89
137
  "Weekly"
90
138
  ]
91
139
  }
92
- }
140
+ },
141
+ "required": [
142
+ "sharedOwnershipPercentage",
143
+ "sharedOwnershipRent",
144
+ "sharedOwnershipRentFrequency"
145
+ ]
93
146
  }
147
+ ],
148
+ "required": [
149
+ "leaseholdType"
94
150
  ]
95
151
  },
96
152
  "leaseTerm": {
153
+ "ntsRef": "A1.2.1",
97
154
  "required": [
98
155
  "startYearOfLease",
99
156
  "lengthOfLeaseInYears"
100
157
  ],
101
158
  "properties": {
102
159
  "startYearOfLease": {
103
- "ntsRef": "A1.2",
160
+ "ntsRef": "A1.2.1.1",
104
161
  "title": "Year that the lease commenced"
105
162
  },
106
163
  "lengthOfLeaseInYears": {
107
- "ntsRef": "A1.3",
164
+ "ntsRef": "A1.2.1.2",
108
165
  "title": "Length of lease (years)"
109
166
  }
110
167
  }
@@ -188,7 +245,11 @@
188
245
  }
189
246
  }
190
247
  }
191
- }
248
+ },
249
+ "required": [
250
+ "annualGroundRent",
251
+ "rentSubjectToIncrease"
252
+ ]
192
253
  }
193
254
  ],
194
255
  "required": [
@@ -204,25 +265,117 @@
204
265
  ]
205
266
  }
206
267
  }
268
+ },
269
+ "serviceCharge": {
270
+ "ntsRef": "A1.5",
271
+ "title": "Service Charge",
272
+ "discriminator": {
273
+ "propertyName": "sellerContributesToServiceCharge"
274
+ },
275
+ "oneOf": [
276
+ {
277
+ "properties": {
278
+ "sellerContributesToServiceCharge": {
279
+ "enum": [
280
+ "No"
281
+ ]
282
+ }
283
+ }
284
+ },
285
+ {
286
+ "properties": {
287
+ "sellerContributesToServiceCharge": {
288
+ "enum": [
289
+ "Yes"
290
+ ]
291
+ },
292
+ "annualServiceCharge": {
293
+ "ntsRef": "A1.5.1.1",
294
+ "title": "Amount of current annual service charge (£)"
295
+ }
296
+ }
297
+ }
298
+ ],
299
+ "required": [
300
+ "sellerContributesToServiceCharge"
301
+ ],
302
+ "properties": {
303
+ "sellerContributesToServiceCharge": {
304
+ "ntsRef": "A1.5.1",
305
+ "title": "Does the seller contribute to the cost of maintaining the building (a service charge)?",
306
+ "enum": [
307
+ "Yes",
308
+ "No"
309
+ ]
310
+ }
311
+ }
207
312
  }
208
313
  }
209
314
  }
210
315
  }
316
+ },
317
+ {
318
+ "properties": {
319
+ "ownershipType": {
320
+ "enum": [
321
+ "Other"
322
+ ]
323
+ }
324
+ }
325
+ }
326
+ ],
327
+ "required": [
328
+ "ownershipType"
329
+ ],
330
+ "properties": {
331
+ "ownershipType": {
332
+ "ntsRef": "A1.1.1",
333
+ "title": "What type of ownership is the property?",
334
+ "description": "A Managed Freehold is any freehold where there are shared amenities, the maintenance of which you pay for through an estate rentcharge, service charge, informal or formal contribution. Choose Leasehold if your property is under a Shared Ownership arrangement.",
335
+ "enum": [
336
+ "Freehold",
337
+ "Managed Freehold",
338
+ "Commonhold",
339
+ "Leasehold",
340
+ "Other"
341
+ ]
211
342
  }
212
- ]
343
+ }
213
344
  }
214
345
  }
215
346
  }
216
347
  },
217
348
  "energyEfficiency": {
349
+ "ntsRef": "A4",
350
+ "title": "Energy Efficiency",
218
351
  "required": [
219
352
  "certificate"
220
353
  ],
221
354
  "properties": {
222
355
  "certificate": {
356
+ "ntsRef": "A4.1",
223
357
  "required": [
224
358
  "currentEnergyRating"
225
- ]
359
+ ],
360
+ "properties": {
361
+ "currentEnergyRating": {
362
+ "ntsRef": "A4.1.1",
363
+ "title": "Current energy efficiency rating",
364
+ "description": "What is the energy efficiency rating of the property according to the latest Energy Performance Certificate (EPC)?",
365
+ "enum": [
366
+ "A",
367
+ "B",
368
+ "C",
369
+ "D",
370
+ "E",
371
+ "F",
372
+ "G",
373
+ "Exempt Property",
374
+ "Survey Instructed",
375
+ "No Certificate"
376
+ ]
377
+ }
378
+ }
226
379
  }
227
380
  }
228
381
  },