@pdtf/schemas 2.0.0-1 → 2.0.0-11

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 (20) hide show
  1. package/index.js +20 -17
  2. package/package.json +1 -1
  3. package/src/examples/v2/exampleTransaction.json +47 -39
  4. package/src/schemas/v2/combined.json +6819 -440
  5. package/src/schemas/v2/overlays/baspi.json +408 -146
  6. package/src/schemas/v2/overlays/con29R.json +1 -1
  7. package/src/schemas/v2/overlays/fme1.json +49 -37
  8. package/src/schemas/v2/overlays/lpe1.json +68 -58
  9. package/src/schemas/v2/overlays/nts.json +38 -42
  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 +19 -8
  13. package/src/schemas/v2/overlays/ta7.json +97 -32
  14. package/src/schemas/v2/{core.json → pdtf-transaction.json} +6412 -353
  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 +2 -12
  19. package/src/utils/extractProperties.js +44 -0
  20. package/src/schemas/v2/merged.json +0 -28693
package/src/schemas/v2/overlays/con29R.json CHANGED
@@ -415,7 +415,7 @@
415
415
  },
416
416
  "suDsFeaturesWithinTheBoundaryOfTheProperty": {
417
417
  "con29RRef": "3.3(b)",
418
- "title": "Are there SuDS features within the boundary of the property? If yes, is the owner responsible for maintenance?",
418
+ "title": "Are there SuDS features within the boundary of the property?",
419
419
  "discriminator": {
420
420
  "propertyName": "yesNo"
421
421
  },
package/src/schemas/v2/overlays/fme1.json CHANGED
@@ -42,12 +42,14 @@
42
42
  "rentchargeOwner": {
43
43
  "fme1Ref": "1.1",
44
44
  "title": "Rentcharge Owner",
45
+ "required": [
46
+ "contact"
47
+ ],
45
48
  "properties": {
46
49
  "contact": {
47
50
  "required": [
48
51
  "nameOrOrganisation",
49
- "line1",
50
- "postcode",
52
+ "address",
51
53
  "telephone",
52
54
  "emailAddress"
53
55
  ],
@@ -88,12 +90,13 @@
88
90
  "managingAgent": {
89
91
  "fme1Ref": "1.3",
90
92
  "title": "Managing Agent",
93
+ "required": [
94
+ "contact"
95
+ ],
91
96
  "properties": {
92
97
  "contact": {
93
98
  "required": [
94
99
  "nameOrOrganisation",
95
- "line1",
96
- "postcode",
97
100
  "telephone",
98
101
  "emailAddress"
99
102
  ],
@@ -263,7 +266,7 @@
263
266
  "Rentcharge Owner",
264
267
  "Management Company",
265
268
  "Managing Agent",
266
- "N/A"
269
+ "Not applicable"
267
270
  ]
268
271
  },
269
272
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -273,7 +276,7 @@
273
276
  "Rentcharge Owner",
274
277
  "Management Company",
275
278
  "Managing Agent",
276
- "N/A"
279
+ "Not applicable"
277
280
  ]
278
281
  },
279
282
  "organisesManagedAreaInsurance": {
@@ -283,7 +286,7 @@
283
286
  "Rentcharge Owner",
284
287
  "Management Company",
285
288
  "Managing Agent",
286
- "N/A"
289
+ "Not applicable"
287
290
  ]
288
291
  }
289
292
  }
@@ -425,7 +428,7 @@
425
428
  "fme1Ref": "3",
426
429
  "title": "Service Charge",
427
430
  "required": [
428
- "serviceChargePayable",
431
+ "annualServiceCharge",
429
432
  "serviceChargePaidUpToDate",
430
433
  "lastDemandPeriod",
431
434
  "propertiesContribute",
@@ -441,11 +444,28 @@
441
444
  "transferFees"
442
445
  ],
443
446
  "properties": {
444
- "serviceChargePayable": {
447
+ "annualServiceCharge": {
445
448
  "fme1Ref": "3.1",
446
- "title": "What is the annual Service charge payable by this Property?",
449
+ "title": "What is the annual Service Charge payable by this Property?",
447
450
  "description": "This should include any sums payable for the maintenance of the managed area"
448
451
  },
452
+ "hasFixedRentcharge": {
453
+ "fme1Ref": "3.1.1",
454
+ "title": "If there is also a ‘fixed’ Rentcharge, please confirm the amount and explain why."
455
+ },
456
+ "largeAdditionalExpense": {
457
+ "required": [
458
+ "yesNo"
459
+ ],
460
+ "oneOf": [
461
+ null,
462
+ {
463
+ "required": [
464
+ "details"
465
+ ]
466
+ }
467
+ ]
468
+ },
449
469
  "serviceChargePaidUpToDate": {
450
470
  "fme1Ref": "3.2",
451
471
  "title": "Is the Service charge paid up-to-date?",
@@ -704,7 +724,7 @@
704
724
  "properties": {
705
725
  "yesNo": {
706
726
  "enum": [
707
- "N/A"
727
+ "Not applicable"
708
728
  ]
709
729
  }
710
730
  }
@@ -1269,7 +1289,7 @@
1269
1289
  "enum": [
1270
1290
  "Enclosed",
1271
1291
  "To follow",
1272
- "N/A"
1292
+ "Not applicable"
1273
1293
  ]
1274
1294
  },
1275
1295
  "managedAreasInsurancePolicy": {
@@ -1278,7 +1298,7 @@
1278
1298
  "enum": [
1279
1299
  "Enclosed",
1280
1300
  "To follow",
1281
- "N/A"
1301
+ "Not applicable"
1282
1302
  ]
1283
1303
  },
1284
1304
  "serviceChargeEstimatesCurrent": {
@@ -1287,7 +1307,7 @@
1287
1307
  "enum": [
1288
1308
  "Enclosed",
1289
1309
  "To follow",
1290
- "N/A"
1310
+ "Not applicable"
1291
1311
  ]
1292
1312
  },
1293
1313
  "serviceChargeEstimatesPrevious": {
@@ -1296,7 +1316,7 @@
1296
1316
  "enum": [
1297
1317
  "Enclosed",
1298
1318
  "To follow",
1299
- "N/A"
1319
+ "Not applicable"
1300
1320
  ]
1301
1321
  },
1302
1322
  "proposedWorksNotices": {
@@ -1305,7 +1325,7 @@
1305
1325
  "enum": [
1306
1326
  "Enclosed",
1307
1327
  "To follow",
1308
- "N/A"
1328
+ "Not applicable"
1309
1329
  ]
1310
1330
  },
1311
1331
  "additionalRegulationsNotInTransfer": {
@@ -1314,7 +1334,7 @@
1314
1334
  "enum": [
1315
1335
  "Enclosed",
1316
1336
  "To follow",
1317
- "N/A"
1337
+ "Not applicable"
1318
1338
  ]
1319
1339
  },
1320
1340
  "deedOfCovenant": {
@@ -1324,7 +1344,7 @@
1324
1344
  "Enclosed",
1325
1345
  "To follow",
1326
1346
  "Buyer's lawyer to draft",
1327
- "N/A"
1347
+ "Not applicable"
1328
1348
  ]
1329
1349
  },
1330
1350
  "certificateOfCompliance": {
@@ -1334,7 +1354,7 @@
1334
1354
  "Enclosed",
1335
1355
  "To follow",
1336
1356
  "Buyer's lawyer to draft",
1337
- "N/A"
1357
+ "Not applicable"
1338
1358
  ]
1339
1359
  },
1340
1360
  "permissionToAlter": {
@@ -1343,7 +1363,7 @@
1343
1363
  "enum": [
1344
1364
  "Enclosed",
1345
1365
  "To follow",
1346
- "N/A"
1366
+ "Not applicable"
1347
1367
  ]
1348
1368
  },
1349
1369
  "noticesServedOnOwner": {
@@ -1352,7 +1372,7 @@
1352
1372
  "enum": [
1353
1373
  "Enclosed",
1354
1374
  "To follow",
1355
- "N/A"
1375
+ "Not applicable"
1356
1376
  ]
1357
1377
  },
1358
1378
  "asbestosSurvey": {
@@ -1361,7 +1381,7 @@
1361
1381
  "enum": [
1362
1382
  "Enclosed",
1363
1383
  "To follow",
1364
- "N/A"
1384
+ "Not applicable"
1365
1385
  ]
1366
1386
  },
1367
1387
  "managedAreaFireRiskAssessment": {
@@ -1370,7 +1390,7 @@
1370
1390
  "enum": [
1371
1391
  "Enclosed",
1372
1392
  "To follow",
1373
- "N/A"
1393
+ "Not applicable"
1374
1394
  ]
1375
1395
  },
1376
1396
  "memorandumAndArticles": {
@@ -1379,7 +1399,7 @@
1379
1399
  "enum": [
1380
1400
  "Enclosed",
1381
1401
  "To follow",
1382
- "N/A"
1402
+ "Not applicable"
1383
1403
  ]
1384
1404
  },
1385
1405
  "managementCompanyAGMMinutes": {
@@ -1388,7 +1408,7 @@
1388
1408
  "enum": [
1389
1409
  "Enclosed",
1390
1410
  "To follow",
1391
- "N/A"
1411
+ "Not applicable"
1392
1412
  ]
1393
1413
  },
1394
1414
  "feesForAdminServices": {
@@ -1397,7 +1417,7 @@
1397
1417
  "enum": [
1398
1418
  "Enclosed",
1399
1419
  "To follow",
1400
- "N/A"
1420
+ "Not applicable"
1401
1421
  ]
1402
1422
  }
1403
1423
  }
@@ -1419,14 +1439,6 @@
1419
1439
  "properties": {
1420
1440
  "contacts": {
1421
1441
  "properties": {
1422
- "rentchargeOwner": {
1423
- "fme1Ref": "1.1",
1424
- "title": "Rentcharge Owner"
1425
- },
1426
- "managementCompany": {
1427
- "fme1Ref": "1.2",
1428
- "title": "Management Company"
1429
- },
1430
1442
  "managingAgent": {
1431
1443
  "fme1Ref": "1.3",
1432
1444
  "title": "Managing Agent",
@@ -1478,7 +1490,7 @@
1478
1490
  "Landlord",
1479
1491
  "Management Company",
1480
1492
  "Managing Agent",
1481
- "N/A"
1493
+ "Not applicable"
1482
1494
  ]
1483
1495
  },
1484
1496
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -1490,7 +1502,7 @@
1490
1502
  "Management Company",
1491
1503
  "Managing Agent",
1492
1504
  "the Lessees",
1493
- "N/A"
1505
+ "Not applicable"
1494
1506
  ]
1495
1507
  },
1496
1508
  "organisesBuildingInsurance": {
@@ -1502,7 +1514,7 @@
1502
1514
  "Management Company",
1503
1515
  "Managing Agent",
1504
1516
  "the Lessees",
1505
- "N/A"
1517
+ "Not applicable"
1506
1518
  ]
1507
1519
  }
1508
1520
  }
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",
@@ -50,13 +65,16 @@
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",
52
67
  "required": [
53
- "nameOrOrganisation",
54
- "address",
55
- "telephone",
56
- "emailAddress"
68
+ "contact"
57
69
  ],
58
70
  "properties": {
59
71
  "contact": {
72
+ "required": [
73
+ "nameOrOrganisation",
74
+ "address",
75
+ "telephone",
76
+ "emailAddress"
77
+ ],
60
78
  "properties": {
61
79
  "address": {
62
80
  "required": [
@@ -69,6 +87,11 @@
69
87
  }
70
88
  },
71
89
  "rentchargeOwner": {
90
+ "lpe1Ref": "1.1",
91
+ "title": "Rentcharge Owner",
92
+ "required": [
93
+ "contact"
94
+ ],
72
95
  "properties": {
73
96
  "contact": {
74
97
  "required": [
@@ -434,7 +457,7 @@
434
457
  "Landlord",
435
458
  "Management Company",
436
459
  "Managing Agent",
437
- "N/A"
460
+ "Not applicable"
438
461
  ]
439
462
  },
440
463
  "collectsServiceCharges": {
@@ -445,7 +468,7 @@
445
468
  "Landlord",
446
469
  "Management Company",
447
470
  "Managing Agent",
448
- "N/A"
471
+ "Not applicable"
449
472
  ]
450
473
  },
451
474
  "collectsbuildingInsurancePremiums": {
@@ -455,7 +478,7 @@
455
478
  "Landlord",
456
479
  "Management Company",
457
480
  "Managing Agent",
458
- "N/A"
481
+ "Not applicable"
459
482
  ]
460
483
  },
461
484
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -467,7 +490,7 @@
467
490
  "Management Company",
468
491
  "Managing Agent",
469
492
  "the Lessees",
470
- "N/A"
493
+ "Not applicable"
471
494
  ]
472
495
  },
473
496
  "organisesBuildingInsurance": {
@@ -479,7 +502,7 @@
479
502
  "Management Company",
480
503
  "Managing Agent",
481
504
  "the Lessees",
482
- "N/A"
505
+ "Not applicable"
483
506
  ]
484
507
  },
485
508
  "dealsWithDayToDayMaintenanceOfBuilding": {
@@ -649,7 +672,7 @@
649
672
  "yesNoNotApplicable": {
650
673
  "enum": [
651
674
  "No",
652
- "N/A"
675
+ "Not applicable"
653
676
  ]
654
677
  }
655
678
  }
@@ -730,7 +753,7 @@
730
753
  "yesNoNotApplicable": {
731
754
  "enum": [
732
755
  "Yes",
733
- "N/A"
756
+ "Not applicable"
734
757
  ]
735
758
  }
736
759
  }
@@ -775,13 +798,6 @@
775
798
  ]
776
799
  },
777
800
  "ownershipAndManagement": {
778
- "required": [
779
- "freeholdOwner",
780
- "hasHeadlease",
781
- "buildingManager",
782
- "hasTenantCompanyDissolved",
783
- "isManagingAgentEmployed"
784
- ],
785
801
  "properties": {
786
802
  "hasHeadlease": {
787
803
  "required": [
@@ -1115,7 +1131,7 @@
1115
1131
  "properties": {
1116
1132
  "yesNo": {
1117
1133
  "enum": [
1118
- "N/A"
1134
+ "Not applicable"
1119
1135
  ]
1120
1136
  }
1121
1137
  }
@@ -1278,7 +1294,7 @@
1278
1294
  ]
1279
1295
  },
1280
1296
  "details": {
1281
- "lpe1Ref": "4.12.1",
1297
+ "lpe1Ref": "4.12.2",
1282
1298
  "title": "Provide details."
1283
1299
  }
1284
1300
  },
@@ -1289,7 +1305,16 @@
1289
1305
  ],
1290
1306
  "required": [
1291
1307
  "yesNo"
1292
- ]
1308
+ ],
1309
+ "properties": {
1310
+ "yesNo": {
1311
+ "lpe1Ref": "4.12.1",
1312
+ "enum": [
1313
+ "Yes",
1314
+ "No"
1315
+ ]
1316
+ }
1317
+ }
1293
1318
  },
1294
1319
  "allPropertiesContribute": {
1295
1320
  "lpe1Ref": "4.13",
@@ -1339,7 +1364,7 @@
1339
1364
  "properties": {
1340
1365
  "yesNoNotApplicable": {
1341
1366
  "enum": [
1342
- "N/A"
1367
+ "Not applicable"
1343
1368
  ]
1344
1369
  }
1345
1370
  }
@@ -1387,7 +1412,7 @@
1387
1412
  "difficultyInCollectingServiceCharge",
1388
1413
  "serviceChargeOwed",
1389
1414
  "propertiesContributingToMaintenanceOfManagedArea",
1390
- "serviceChargePayable",
1415
+ "adHocExpenses",
1391
1416
  "serviceChargePaidUpToDate",
1392
1417
  "excessPaymentAnticipated",
1393
1418
  "lastDemandPeriod",
@@ -1984,21 +2009,6 @@
1984
2009
  "restrictionOnKeepingPets"
1985
2010
  ],
1986
2011
  "properties": {
1987
- "typeOfLeasehold": {
1988
- "required": [
1989
- "leaseholdType"
1990
- ],
1991
- "oneOf": [
1992
- null,
1993
- {
1994
- "required": [
1995
- "sharedOwnershipPercentage",
1996
- "sharedOwnershipRent",
1997
- "sharedOwnershipRentFrequency"
1998
- ]
1999
- }
2000
- ]
2001
- },
2002
2012
  "sellerAwareOfAlterations": {
2003
2013
  "required": [
2004
2014
  "yesNo"
@@ -2206,7 +2216,7 @@
2206
2216
  "enum": [
2207
2217
  "Enclosed",
2208
2218
  "To follow",
2209
- "N/A"
2219
+ "Not applicable"
2210
2220
  ]
2211
2221
  },
2212
2222
  "buildingsInsurancePolicy": {
@@ -2219,7 +2229,7 @@
2219
2229
  "enum": [
2220
2230
  "Enclosed",
2221
2231
  "To follow",
2222
- "N/A"
2232
+ "Not applicable"
2223
2233
  ]
2224
2234
  },
2225
2235
  "serviceChargeEstimatesCurrent": {
@@ -2228,7 +2238,7 @@
2228
2238
  "enum": [
2229
2239
  "Enclosed",
2230
2240
  "To follow",
2231
- "N/A"
2241
+ "Not applicable"
2232
2242
  ]
2233
2243
  },
2234
2244
  "serviceChargeEstimatesPrevious": {
@@ -2237,7 +2247,7 @@
2237
2247
  "enum": [
2238
2248
  "Enclosed",
2239
2249
  "To follow",
2240
- "N/A"
2250
+ "Not applicable"
2241
2251
  ]
2242
2252
  },
2243
2253
  "proposedWorksNotices": {
@@ -2246,7 +2256,7 @@
2246
2256
  "enum": [
2247
2257
  "Enclosed",
2248
2258
  "To follow",
2249
- "N/A"
2259
+ "Not applicable"
2250
2260
  ]
2251
2261
  },
2252
2262
  "forfeitureDocumentation": {
@@ -2255,7 +2265,7 @@
2255
2265
  "enum": [
2256
2266
  "Enclosed",
2257
2267
  "To follow",
2258
- "N/A"
2268
+ "Not applicable"
2259
2269
  ]
2260
2270
  },
2261
2271
  "additionalRegulationsNotInLease": {
@@ -2264,7 +2274,7 @@
2264
2274
  "enum": [
2265
2275
  "Enclosed",
2266
2276
  "To follow",
2267
- "N/A"
2277
+ "Not applicable"
2268
2278
  ]
2269
2279
  },
2270
2280
  "deedsOfVariation": {
@@ -2275,7 +2285,7 @@
2275
2285
  "To follow",
2276
2286
  "Landlord's lawyer provides",
2277
2287
  "Please supply draft",
2278
- "N/A"
2288
+ "Not applicable"
2279
2289
  ]
2280
2290
  },
2281
2291
  "deedOfCovenant": {
@@ -2284,7 +2294,7 @@
2284
2294
  "enum": [
2285
2295
  "Enclosed",
2286
2296
  "To follow",
2287
- "N/A"
2297
+ "Not applicable"
2288
2298
  ]
2289
2299
  },
2290
2300
  "certificateOfCompliance": {
@@ -2293,7 +2303,7 @@
2293
2303
  "enum": [
2294
2304
  "Enclosed",
2295
2305
  "To follow",
2296
- "N/A"
2306
+ "Not applicable"
2297
2307
  ]
2298
2308
  },
2299
2309
  "certificateOfComplianceFee": {
@@ -2308,7 +2318,7 @@
2308
2318
  "To follow",
2309
2319
  "Landlord's lawyer provides",
2310
2320
  "Please supply draft",
2311
- "N/A"
2321
+ "Not applicable"
2312
2322
  ]
2313
2323
  },
2314
2324
  "permissionToAlter": {
@@ -2317,7 +2327,7 @@
2317
2327
  "enum": [
2318
2328
  "Enclosed",
2319
2329
  "To follow",
2320
- "N/A"
2330
+ "Not applicable"
2321
2331
  ]
2322
2332
  },
2323
2333
  "noticesServedOnLessee": {
@@ -2326,7 +2336,7 @@
2326
2336
  "enum": [
2327
2337
  "Enclosed",
2328
2338
  "To follow",
2329
- "N/A"
2339
+ "Not applicable"
2330
2340
  ]
2331
2341
  },
2332
2342
  "asbestosSurvey": {
@@ -2335,7 +2345,7 @@
2335
2345
  "enum": [
2336
2346
  "Enclosed",
2337
2347
  "To follow",
2338
- "N/A"
2348
+ "Not applicable"
2339
2349
  ]
2340
2350
  },
2341
2351
  "managedAreaFireRiskAssessment": {
@@ -2344,7 +2354,7 @@
2344
2354
  "enum": [
2345
2355
  "Enclosed",
2346
2356
  "To follow",
2347
- "N/A"
2357
+ "Not applicable"
2348
2358
  ]
2349
2359
  },
2350
2360
  "memorandumAndArticles": {
@@ -2353,7 +2363,7 @@
2353
2363
  "enum": [
2354
2364
  "Enclosed",
2355
2365
  "To follow",
2356
- "N/A"
2366
+ "Not applicable"
2357
2367
  ]
2358
2368
  },
2359
2369
  "managementCompanyAGMMinutes": {
@@ -2362,7 +2372,7 @@
2362
2372
  "enum": [
2363
2373
  "Enclosed",
2364
2374
  "To follow",
2365
- "N/A"
2375
+ "Not applicable"
2366
2376
  ]
2367
2377
  },
2368
2378
  "deedOfCertificate": {
@@ -2371,7 +2381,7 @@
2371
2381
  "enum": [
2372
2382
  "Enclosed",
2373
2383
  "To follow",
2374
- "N/A"
2384
+ "Not applicable"
2375
2385
  ]
2376
2386
  },
2377
2387
  "landlordsCertificate": {
@@ -2380,7 +2390,7 @@
2380
2390
  "enum": [
2381
2391
  "Enclosed",
2382
2392
  "To follow",
2383
- "N/A"
2393
+ "Not applicable"
2384
2394
  ]
2385
2395
  },
2386
2396
  "enforcementNotices": {
@@ -2389,7 +2399,7 @@
2389
2399
  "enum": [
2390
2400
  "Enclosed",
2391
2401
  "To follow",
2392
- "N/A"
2402
+ "Not applicable"
2393
2403
  ]
2394
2404
  }
2395
2405
  }