@pdtf/schemas 3.0.0-2 → 3.0.0-21

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 (33) hide show
  1. package/index.js +15 -13
  2. package/package.json +1 -1
  3. package/src/examples/v3/exampleTransaction.json +82 -75
  4. package/src/schemas/v2/overlays/baspi.json +510 -2331
  5. package/src/schemas/v2/overlays/con29DW.json +36 -125
  6. package/src/schemas/v2/overlays/con29R.json +5 -143
  7. package/src/schemas/v2/overlays/fme1.json +48 -233
  8. package/src/schemas/v2/overlays/lpe1.json +75 -367
  9. package/src/schemas/v2/overlays/nts.json +17 -103
  10. package/src/schemas/v2/overlays/piq.json +146 -693
  11. package/src/schemas/v2/overlays/rds.json +50 -316
  12. package/src/schemas/v2/overlays/ta10.json +540 -1755
  13. package/src/schemas/v2/overlays/ta6.json +241 -1193
  14. package/src/schemas/v2/overlays/ta7.json +106 -440
  15. package/src/schemas/v3/combined.json +2434 -2581
  16. package/src/schemas/v3/overlays/baspi.json +1360 -3480
  17. package/src/schemas/v3/overlays/con29DW.json +36 -125
  18. package/src/schemas/v3/overlays/con29R.json +5 -143
  19. package/src/schemas/v3/overlays/fme1.json +53 -233
  20. package/src/schemas/v3/overlays/lpe1.json +85 -367
  21. package/src/schemas/v3/overlays/nts.json +711 -634
  22. package/src/schemas/v3/overlays/piq.json +452 -1190
  23. package/src/schemas/v3/overlays/rds.json +500 -1059
  24. package/src/schemas/v3/overlays/ta10.json +540 -1755
  25. package/src/schemas/v3/overlays/ta6.json +787 -1678
  26. package/src/schemas/v3/overlays/ta7.json +220 -462
  27. package/src/schemas/v3/pdtf-transaction.json +1976 -2286
  28. package/src/schemas/v3/skeleton.json +248 -214
  29. package/src/tests/v3/transactionSchema.test.js +28 -18
  30. package/src/tests/v3/verifiedClaimsValidator.test.js +2 -2
  31. package/src/utils/extractOverlay.js +5 -27
  32. package/src/tests/v2/transactionSchema.test.js +0 -361
  33. package/src/tests/v2/verifiedClaimsValidator.test.js +0 -128
package/src/schemas/v2/overlays/nts.json CHANGED
@@ -19,44 +19,29 @@
19
19
  "properties": {
20
20
  "priceInformation": {
21
21
  "ntsRef": "A3",
22
- "title": "Price information",
23
22
  "required": [
24
23
  "price",
25
24
  "priceQualifier"
26
25
  ],
27
26
  "properties": {
28
27
  "price": {
29
- "ntsRef": "A3.1",
30
- "title": "Price"
28
+ "ntsRef": "A3.1"
31
29
  },
32
30
  "priceQualifier": {
33
- "ntsRef": "A3.2",
34
- "title": "Price type",
35
- "enum": [
36
- "POA",
37
- "Guide price",
38
- "Fixed price",
39
- "Offers in excess of",
40
- "Offers in region of",
41
- "Sale by tender"
42
- ]
31
+ "ntsRef": "A3.2"
43
32
  }
44
33
  }
45
34
  },
46
35
  "ownership": {
47
36
  "ntsRef": "A1",
48
- "title": "Ownership",
49
37
  "required": [
50
38
  "ownershipsToBeTransferred"
51
39
  ],
52
40
  "properties": {
53
41
  "ownershipsToBeTransferred": {
54
42
  "ntsRef": "A1",
55
- "title": "Ownerships to be transferred on sale",
56
- "minItems": 1,
57
43
  "items": {
58
44
  "ntsRef": "A1.1",
59
- "title": "Ownership to be transferred",
60
45
  "discriminator": {
61
46
  "propertyName": "ownershipType"
62
47
  },
@@ -89,7 +74,6 @@
89
74
  },
90
75
  "leaseholdInformation": {
91
76
  "ntsRef": "A1.2",
92
- "title": "Leasehold information",
93
77
  "required": [
94
78
  "typeOfLeasehold",
95
79
  "leaseTerm",
@@ -121,21 +105,13 @@
121
105
  ]
122
106
  },
123
107
  "sharedOwnershipPercentage": {
124
- "ntsRef": "A1.7.1",
125
- "title": "Shared ownership percentage"
108
+ "ntsRef": "A1.7.1"
126
109
  },
127
110
  "sharedOwnershipRent": {
128
- "ntsRef": "A1.7.2",
129
- "title": "Shared ownership rent (£)"
111
+ "ntsRef": "A1.7.2"
130
112
  },
131
113
  "sharedOwnershipRentFrequency": {
132
- "ntsRef": "A1.7.3",
133
- "title": "Shared ownership rent frequency",
134
- "enum": [
135
- "Yearly",
136
- "Monthly",
137
- "Weekly"
138
- ]
114
+ "ntsRef": "A1.7.3"
139
115
  }
140
116
  },
141
117
  "required": [
@@ -157,18 +133,15 @@
157
133
  ],
158
134
  "properties": {
159
135
  "startYearOfLease": {
160
- "ntsRef": "A1.2.1.1",
161
- "title": "Year that the lease commenced"
136
+ "ntsRef": "A1.2.1.1"
162
137
  },
163
138
  "lengthOfLeaseInYears": {
164
- "ntsRef": "A1.2.1.2",
165
- "title": "Length of lease (years)"
139
+ "ntsRef": "A1.2.1.2"
166
140
  }
167
141
  }
168
142
  },
169
143
  "groundRent": {
170
144
  "ntsRef": "A1.4",
171
- "title": "Ground Rent",
172
145
  "discriminator": {
173
146
  "propertyName": "isGroundRentPayable"
174
147
  },
@@ -190,12 +163,10 @@
190
163
  ]
191
164
  },
192
165
  "annualGroundRent": {
193
- "ntsRef": "A1.4.2",
194
- "title": "What is the annual ground rent payable? (£)"
166
+ "ntsRef": "A1.4.2"
195
167
  },
196
168
  "rentSubjectToIncrease": {
197
169
  "ntsRef": "A1.4.3",
198
- "title": "Is the ground rent subject to increase?",
199
170
  "discriminator": {
200
171
  "propertyName": "yesNo"
201
172
  },
@@ -217,13 +188,10 @@
217
188
  ]
218
189
  },
219
190
  "rentReviewFrequency": {
220
- "ntsRef": "1.4.3.2",
221
- "title": "How often is the rent reviewed?"
191
+ "ntsRef": "1.4.3.2"
222
192
  },
223
193
  "rentIncreaseCalculated": {
224
- "ntsRef": "1.4.3.3",
225
- "title": "How is the increase calculated?",
226
- "description": "e.g. set figure, doubling, in line with Retail Price Index, Consumer Price Index, etc"
194
+ "ntsRef": "1.4.3.3"
227
195
  }
228
196
  },
229
197
  "required": [
@@ -237,11 +205,7 @@
237
205
  ],
238
206
  "properties": {
239
207
  "yesNo": {
240
- "ntsRef": "1.4.3.1",
241
- "enum": [
242
- "Yes",
243
- "No"
244
- ]
208
+ "ntsRef": "1.4.3.1"
245
209
  }
246
210
  }
247
211
  }
@@ -257,18 +221,12 @@
257
221
  ],
258
222
  "properties": {
259
223
  "isGroundRentPayable": {
260
- "ntsRef": "A1.4.1",
261
- "title": "Does the seller pay ground rent for the property?",
262
- "enum": [
263
- "Yes",
264
- "No"
265
- ]
224
+ "ntsRef": "A1.4.1"
266
225
  }
267
226
  }
268
227
  },
269
228
  "serviceCharge": {
270
229
  "ntsRef": "A1.5",
271
- "title": "Service Charge",
272
230
  "discriminator": {
273
231
  "propertyName": "sellerContributesToServiceCharge"
274
232
  },
@@ -290,8 +248,7 @@
290
248
  ]
291
249
  },
292
250
  "annualServiceCharge": {
293
- "ntsRef": "A1.5.1.1",
294
- "title": "Amount of current annual service charge (£)"
251
+ "ntsRef": "A1.5.1.1"
295
252
  }
296
253
  }
297
254
  }
@@ -301,12 +258,7 @@
301
258
  ],
302
259
  "properties": {
303
260
  "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
- ]
261
+ "ntsRef": "A1.5.1"
310
262
  }
311
263
  }
312
264
  }
@@ -329,16 +281,7 @@
329
281
  ],
330
282
  "properties": {
331
283
  "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
- ]
284
+ "ntsRef": "A1.1.1"
342
285
  }
343
286
  }
344
287
  }
@@ -347,7 +290,6 @@
347
290
  },
348
291
  "energyEfficiency": {
349
292
  "ntsRef": "A4",
350
- "title": "Energy Efficiency",
351
293
  "required": [
352
294
  "certificate"
353
295
  ],
@@ -359,21 +301,7 @@
359
301
  ],
360
302
  "properties": {
361
303
  "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
- ]
304
+ "ntsRef": "A4.1.1"
377
305
  }
378
306
  }
379
307
  }
@@ -381,26 +309,12 @@
381
309
  },
382
310
  "councilTax": {
383
311
  "ntsRef": "A2",
384
- "title": "Council Tax",
385
312
  "required": [
386
313
  "councilTaxBand"
387
314
  ],
388
315
  "properties": {
389
316
  "councilTaxBand": {
390
- "ntsRef": "A2.1",
391
- "title": "Which Council Tax band does this property fall within?",
392
- "description": "Band I relates to Wales only",
393
- "enum": [
394
- "A",
395
- "B",
396
- "C",
397
- "D",
398
- "E",
399
- "F",
400
- "G",
401
- "H",
402
- "I"
403
- ]
317
+ "ntsRef": "A2.1"
404
318
  }
405
319
  }
406
320
  }