@pdtf/schemas 2.0.0-0 → 2.0.0-10

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 (19) hide show
  1. package/index.js +20 -17
  2. package/package.json +1 -1
  3. package/src/examples/v2/exampleTransaction.json +81 -29
  4. package/src/schemas/v2/combined.json +6803 -436
  5. package/src/schemas/v2/overlays/baspi.json +329 -142
  6. package/src/schemas/v2/overlays/con29R.json +1 -1
  7. package/src/schemas/v2/overlays/fme1.json +44 -35
  8. package/src/schemas/v2/overlays/lpe1.json +65 -77
  9. package/src/schemas/v2/overlays/nts.json +39 -43
  10. package/src/schemas/v2/overlays/rds.json +10 -18
  11. package/src/schemas/v2/overlays/ta10.json +844 -1
  12. package/src/schemas/v2/overlays/ta6.json +14 -6
  13. package/src/schemas/v2/overlays/ta7.json +100 -34
  14. package/src/schemas/v2/{core.json → pdtf-transaction.json} +6365 -339
  15. package/src/tests/v1/transactionSchema.test.js +21 -13
  16. package/src/tests/v2/transactionSchema.test.js +20 -27
  17. package/src/tests/v2/verifiedClaimsValidator.test.js +128 -0
  18. package/src/utils/extractOverlay.js +20 -2
  19. package/src/utils/extractProperties.js +44 -0
package/src/schemas/v2/overlays/lpe1.json CHANGED
@@ -32,6 +32,21 @@
32
32
  "confirmation"
33
33
  ],
34
34
  "properties": {
35
+ "typeOfLeasehold": {
36
+ "required": [
37
+ "leaseholdType"
38
+ ],
39
+ "oneOf": [
40
+ null,
41
+ {
42
+ "required": [
43
+ "sharedOwnershipPercentage",
44
+ "sharedOwnershipRent",
45
+ "sharedOwnershipRentFrequency"
46
+ ]
47
+ }
48
+ ]
49
+ },
35
50
  "contactDetails": {
36
51
  "lpe1Ref": "1",
37
52
  "title": "Contact Details",
@@ -49,12 +64,14 @@
49
64
  "lpe1Ref": "1.1",
50
65
  "title": "Landlord",
51
66
  "description": "The landlord (or freeholder) may be, for example, a private individual, a housing association, or a management company owned by the residents",
67
+ "required": [
68
+ "contact"
69
+ ],
52
70
  "properties": {
53
71
  "contact": {
54
72
  "required": [
55
73
  "nameOrOrganisation",
56
- "addressLine1",
57
- "postcode",
74
+ "address",
58
75
  "telephone",
59
76
  "emailAddress"
60
77
  ],
@@ -70,23 +87,19 @@
70
87
  }
71
88
  },
72
89
  "rentchargeOwner": {
90
+ "lpe1Ref": "1.1",
91
+ "title": "Rentcharge Owner",
92
+ "required": [
93
+ "contact"
94
+ ],
73
95
  "properties": {
74
96
  "contact": {
75
97
  "required": [
76
98
  "nameOrOrganisation",
77
- "addressLine1",
78
- "postcode",
99
+ "address",
79
100
  "telephone",
80
101
  "emailAddress"
81
- ],
82
- "properties": {
83
- "address": {
84
- "required": [
85
- "line1",
86
- "postcode"
87
- ]
88
- }
89
- }
102
+ ]
90
103
  }
91
104
  }
92
105
  },
@@ -97,8 +110,7 @@
97
110
  "contact": {
98
111
  "required": [
99
112
  "nameOrOrganisation",
100
- "addressLine1",
101
- "postcode",
113
+ "address",
102
114
  "telephone",
103
115
  "emailAddress"
104
116
  ],
@@ -121,8 +133,7 @@
121
133
  "contact": {
122
134
  "required": [
123
135
  "nameOrOrganisation",
124
- "addressLine1",
125
- "postcode",
136
+ "address",
126
137
  "telephone",
127
138
  "emailAddress"
128
139
  ],
@@ -144,7 +155,7 @@
144
155
  "contact": {
145
156
  "required": [
146
157
  "nameOrOrganisation",
147
- "addressLine1",
158
+ "line1",
148
159
  "postcode",
149
160
  "telephone",
150
161
  "emailAddress"
@@ -167,7 +178,7 @@
167
178
  "contact": {
168
179
  "required": [
169
180
  "nameOrOrganisation",
170
- "addressLine1",
181
+ "line1",
171
182
  "postcode",
172
183
  "telephone",
173
184
  "emailAddress"
@@ -214,7 +225,7 @@
214
225
  "title": "Please provide contact details of the Lessee in charge",
215
226
  "required": [
216
227
  "nameOrOrganisation",
217
- "addressLine1",
228
+ "line1",
218
229
  "postcode",
219
230
  "telephone",
220
231
  "emailAddress"
@@ -306,7 +317,7 @@
306
317
  "contact": {
307
318
  "required": [
308
319
  "nameOrOrganisation",
309
- "addressLine1",
320
+ "line1",
310
321
  "postcode",
311
322
  "telephone",
312
323
  "emailAddress"
@@ -399,7 +410,7 @@
399
410
  "contact": {
400
411
  "required": [
401
412
  "nameOrOrganisation",
402
- "addressLine1",
413
+ "line1",
403
414
  "postcode",
404
415
  "telephone",
405
416
  "emailAddress"
@@ -438,7 +449,7 @@
438
449
  "Landlord",
439
450
  "Management Company",
440
451
  "Managing Agent",
441
- "N/A"
452
+ "Not applicable"
442
453
  ]
443
454
  },
444
455
  "collectsServiceCharges": {
@@ -449,7 +460,7 @@
449
460
  "Landlord",
450
461
  "Management Company",
451
462
  "Managing Agent",
452
- "N/A"
463
+ "Not applicable"
453
464
  ]
454
465
  },
455
466
  "collectsbuildingInsurancePremiums": {
@@ -459,7 +470,7 @@
459
470
  "Landlord",
460
471
  "Management Company",
461
472
  "Managing Agent",
462
- "N/A"
473
+ "Not applicable"
463
474
  ]
464
475
  },
465
476
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -471,7 +482,7 @@
471
482
  "Management Company",
472
483
  "Managing Agent",
473
484
  "the Lessees",
474
- "N/A"
485
+ "Not applicable"
475
486
  ]
476
487
  },
477
488
  "organisesBuildingInsurance": {
@@ -483,7 +494,7 @@
483
494
  "Management Company",
484
495
  "Managing Agent",
485
496
  "the Lessees",
486
- "N/A"
497
+ "Not applicable"
487
498
  ]
488
499
  },
489
500
  "dealsWithDayToDayMaintenanceOfBuilding": {
@@ -653,7 +664,7 @@
653
664
  "yesNoNotApplicable": {
654
665
  "enum": [
655
666
  "No",
656
- "N/A"
667
+ "Not applicable"
657
668
  ]
658
669
  }
659
670
  }
@@ -716,7 +727,7 @@
716
727
  null,
717
728
  {
718
729
  "required": [
719
- "rentReviewed",
730
+ "rentReviewFrequency",
720
731
  "rentIncreaseCalculated"
721
732
  ]
722
733
  }
@@ -734,7 +745,7 @@
734
745
  "yesNoNotApplicable": {
735
746
  "enum": [
736
747
  "Yes",
737
- "N/A"
748
+ "Not applicable"
738
749
  ]
739
750
  }
740
751
  }
@@ -770,8 +781,7 @@
770
781
  "groundRentFrequency",
771
782
  "rentSubjectToIncrease",
772
783
  "groundRentPaidUpToDate",
773
- "lastDemandPeriod",
774
- "requirementsToBeMemberOfManagementCompany"
784
+ "lastDemandPeriod"
775
785
  ]
776
786
  }
777
787
  ],
@@ -780,13 +790,6 @@
780
790
  ]
781
791
  },
782
792
  "ownershipAndManagement": {
783
- "required": [
784
- "freeholdOwner",
785
- "hasHeadlease",
786
- "buildingManager",
787
- "hasTenantCompanyDissolved",
788
- "isManagingAgentEmployed"
789
- ],
790
793
  "properties": {
791
794
  "hasHeadlease": {
792
795
  "required": [
@@ -955,7 +958,7 @@
955
958
  },
956
959
  "excessPaymentAnticipated": {
957
960
  "lpe1Ref": "4.3",
958
- "title": " Is any excess payment anticipated for the Property at the end of the financial year?",
961
+ "title": "Is any excess payment anticipated for the Property at the end of the financial year?",
959
962
  "discriminator": {
960
963
  "propertyName": "yesNo"
961
964
  },
@@ -1120,7 +1123,7 @@
1120
1123
  "properties": {
1121
1124
  "yesNo": {
1122
1125
  "enum": [
1123
- "N/A"
1126
+ "Not applicable"
1124
1127
  ]
1125
1128
  }
1126
1129
  }
@@ -1344,7 +1347,7 @@
1344
1347
  "properties": {
1345
1348
  "yesNoNotApplicable": {
1346
1349
  "enum": [
1347
- "N/A"
1350
+ "Not applicable"
1348
1351
  ]
1349
1352
  }
1350
1353
  }
@@ -1989,21 +1992,6 @@
1989
1992
  "restrictionOnKeepingPets"
1990
1993
  ],
1991
1994
  "properties": {
1992
- "typeOfLeasehold": {
1993
- "required": [
1994
- "leaseholdType"
1995
- ],
1996
- "oneOf": [
1997
- null,
1998
- {
1999
- "required": [
2000
- "sharedOwnershipPercentage",
2001
- "sharedOwnershipRent",
2002
- "sharedOwnershipRentFrequency"
2003
- ]
2004
- }
2005
- ]
2006
- },
2007
1995
  "sellerAwareOfAlterations": {
2008
1996
  "required": [
2009
1997
  "yesNo"
@@ -2211,7 +2199,7 @@
2211
2199
  "enum": [
2212
2200
  "Enclosed",
2213
2201
  "To follow",
2214
- "N/A"
2202
+ "Not applicable"
2215
2203
  ]
2216
2204
  },
2217
2205
  "buildingsInsurancePolicy": {
@@ -2224,7 +2212,7 @@
2224
2212
  "enum": [
2225
2213
  "Enclosed",
2226
2214
  "To follow",
2227
- "N/A"
2215
+ "Not applicable"
2228
2216
  ]
2229
2217
  },
2230
2218
  "serviceChargeEstimatesCurrent": {
@@ -2233,7 +2221,7 @@
2233
2221
  "enum": [
2234
2222
  "Enclosed",
2235
2223
  "To follow",
2236
- "N/A"
2224
+ "Not applicable"
2237
2225
  ]
2238
2226
  },
2239
2227
  "serviceChargeEstimatesPrevious": {
@@ -2242,7 +2230,7 @@
2242
2230
  "enum": [
2243
2231
  "Enclosed",
2244
2232
  "To follow",
2245
- "N/A"
2233
+ "Not applicable"
2246
2234
  ]
2247
2235
  },
2248
2236
  "proposedWorksNotices": {
@@ -2251,7 +2239,7 @@
2251
2239
  "enum": [
2252
2240
  "Enclosed",
2253
2241
  "To follow",
2254
- "N/A"
2242
+ "Not applicable"
2255
2243
  ]
2256
2244
  },
2257
2245
  "forfeitureDocumentation": {
@@ -2260,7 +2248,7 @@
2260
2248
  "enum": [
2261
2249
  "Enclosed",
2262
2250
  "To follow",
2263
- "N/A"
2251
+ "Not applicable"
2264
2252
  ]
2265
2253
  },
2266
2254
  "additionalRegulationsNotInLease": {
@@ -2269,7 +2257,7 @@
2269
2257
  "enum": [
2270
2258
  "Enclosed",
2271
2259
  "To follow",
2272
- "N/A"
2260
+ "Not applicable"
2273
2261
  ]
2274
2262
  },
2275
2263
  "deedsOfVariation": {
@@ -2280,7 +2268,7 @@
2280
2268
  "To follow",
2281
2269
  "Landlord's lawyer provides",
2282
2270
  "Please supply draft",
2283
- "N/A"
2271
+ "Not applicable"
2284
2272
  ]
2285
2273
  },
2286
2274
  "deedOfCovenant": {
@@ -2289,7 +2277,7 @@
2289
2277
  "enum": [
2290
2278
  "Enclosed",
2291
2279
  "To follow",
2292
- "N/A"
2280
+ "Not applicable"
2293
2281
  ]
2294
2282
  },
2295
2283
  "certificateOfCompliance": {
@@ -2298,7 +2286,7 @@
2298
2286
  "enum": [
2299
2287
  "Enclosed",
2300
2288
  "To follow",
2301
- "N/A"
2289
+ "Not applicable"
2302
2290
  ]
2303
2291
  },
2304
2292
  "certificateOfComplianceFee": {
@@ -2313,7 +2301,7 @@
2313
2301
  "To follow",
2314
2302
  "Landlord's lawyer provides",
2315
2303
  "Please supply draft",
2316
- "N/A"
2304
+ "Not applicable"
2317
2305
  ]
2318
2306
  },
2319
2307
  "permissionToAlter": {
@@ -2322,7 +2310,7 @@
2322
2310
  "enum": [
2323
2311
  "Enclosed",
2324
2312
  "To follow",
2325
- "N/A"
2313
+ "Not applicable"
2326
2314
  ]
2327
2315
  },
2328
2316
  "noticesServedOnLessee": {
@@ -2331,7 +2319,7 @@
2331
2319
  "enum": [
2332
2320
  "Enclosed",
2333
2321
  "To follow",
2334
- "N/A"
2322
+ "Not applicable"
2335
2323
  ]
2336
2324
  },
2337
2325
  "asbestosSurvey": {
@@ -2340,7 +2328,7 @@
2340
2328
  "enum": [
2341
2329
  "Enclosed",
2342
2330
  "To follow",
2343
- "N/A"
2331
+ "Not applicable"
2344
2332
  ]
2345
2333
  },
2346
2334
  "managedAreaFireRiskAssessment": {
@@ -2349,7 +2337,7 @@
2349
2337
  "enum": [
2350
2338
  "Enclosed",
2351
2339
  "To follow",
2352
- "N/A"
2340
+ "Not applicable"
2353
2341
  ]
2354
2342
  },
2355
2343
  "memorandumAndArticles": {
@@ -2358,7 +2346,7 @@
2358
2346
  "enum": [
2359
2347
  "Enclosed",
2360
2348
  "To follow",
2361
- "N/A"
2349
+ "Not applicable"
2362
2350
  ]
2363
2351
  },
2364
2352
  "managementCompanyAGMMinutes": {
@@ -2367,7 +2355,7 @@
2367
2355
  "enum": [
2368
2356
  "Enclosed",
2369
2357
  "To follow",
2370
- "N/A"
2358
+ "Not applicable"
2371
2359
  ]
2372
2360
  },
2373
2361
  "deedOfCertificate": {
@@ -2376,7 +2364,7 @@
2376
2364
  "enum": [
2377
2365
  "Enclosed",
2378
2366
  "To follow",
2379
- "N/A"
2367
+ "Not applicable"
2380
2368
  ]
2381
2369
  },
2382
2370
  "landlordsCertificate": {
@@ -2385,7 +2373,7 @@
2385
2373
  "enum": [
2386
2374
  "Enclosed",
2387
2375
  "To follow",
2388
- "N/A"
2376
+ "Not applicable"
2389
2377
  ]
2390
2378
  },
2391
2379
  "enforcementNotices": {
@@ -2394,7 +2382,7 @@
2394
2382
  "enum": [
2395
2383
  "Enclosed",
2396
2384
  "To follow",
2397
- "N/A"
2385
+ "Not applicable"
2398
2386
  ]
2399
2387
  }
2400
2388
  }
package/src/schemas/v2/overlays/nts.json CHANGED
@@ -41,6 +41,44 @@
41
41
  "properties": {
42
42
  "leaseholdInformation": {
43
43
  "properties": {
44
+ "typeOfLeasehold": {
45
+ "oneOf": [
46
+ null,
47
+ {
48
+ "properties": {
49
+ "sharedOwnershipPercentage": {
50
+ "ntsRef": "A1.7.1",
51
+ "title": "Shared ownership percentage"
52
+ },
53
+ "sharedOwnershipRent": {
54
+ "ntsRef": "A1.7.2",
55
+ "title": "Shared ownership rent (£)"
56
+ },
57
+ "sharedOwnershipRentFrequency": {
58
+ "ntsRef": "A1.7.3",
59
+ "title": "Shared ownership rent frequency",
60
+ "enum": [
61
+ "Yearly",
62
+ "Monthly",
63
+ "Weekly"
64
+ ]
65
+ }
66
+ }
67
+ }
68
+ ]
69
+ },
70
+ "leaseTerm": {
71
+ "properties": {
72
+ "startYearOfLease": {
73
+ "ntsRef": "A1.2",
74
+ "title": "Year that the lease commenced"
75
+ },
76
+ "lengthOfLeaseInYears": {
77
+ "ntsRef": "A1.3",
78
+ "title": "Length of lease (years)"
79
+ }
80
+ }
81
+ },
44
82
  "groundRent": {
45
83
  "oneOf": [
46
84
  null,
@@ -52,7 +90,7 @@
52
90
  },
53
91
  "rentSubjectToIncrease": {
54
92
  "ntsRef": "A1.5",
55
- "title": "Is the rent subject to increase?",
93
+ "title": "Is the ground rent subject to increase?",
56
94
  "discriminator": {
57
95
  "propertyName": "yesNo"
58
96
  },
@@ -80,48 +118,6 @@
80
118
  }
81
119
  }
82
120
  ]
83
- },
84
- "general": {
85
- "properties": {
86
- "typeOfLeasehold": {
87
- "oneOf": [
88
- null,
89
- {
90
- "properties": {
91
- "sharedOwnershipPercentage": {
92
- "ntsRef": "A1.7.1",
93
- "title": "Shared ownership percentage"
94
- },
95
- "sharedOwnershipRent": {
96
- "ntsRef": "A1.7.2",
97
- "title": "Shared ownership rent (£)"
98
- },
99
- "sharedOwnershipRentFrequency": {
100
- "ntsRef": "A1.7.3",
101
- "title": "Shared ownership rent frequency",
102
- "enum": [
103
- "Yearly",
104
- "Monthly",
105
- "Weekly"
106
- ]
107
- }
108
- }
109
- }
110
- ]
111
- },
112
- "leaseTerm": {
113
- "properties": {
114
- "startYearOfLease": {
115
- "ntsRef": "A1.2",
116
- "title": "Year that the lease commenced"
117
- },
118
- "lengthOfLeaseInYears": {
119
- "ntsRef": "A1.3",
120
- "title": "Length of lease (years)"
121
- }
122
- }
123
- }
124
- }
125
121
  }
126
122
  }
127
123
  }