@pdtf/schemas 2.0.0-1 → 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 (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 +6748 -431
  5. package/src/schemas/v2/overlays/baspi.json +223 -144
  6. package/src/schemas/v2/overlays/con29R.json +1 -1
  7. package/src/schemas/v2/overlays/fme1.json +41 -32
  8. package/src/schemas/v2/overlays/lpe1.json +57 -64
  9. package/src/schemas/v2/overlays/nts.json +38 -42
  10. package/src/schemas/v2/overlays/rds.json +7 -16
  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 +97 -32
  14. package/src/schemas/v2/{core.json → pdtf-transaction.json} +6361 -335
  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
  }
@@ -704,7 +707,7 @@
704
707
  "properties": {
705
708
  "yesNo": {
706
709
  "enum": [
707
- "N/A"
710
+ "Not applicable"
708
711
  ]
709
712
  }
710
713
  }
@@ -1269,7 +1272,7 @@
1269
1272
  "enum": [
1270
1273
  "Enclosed",
1271
1274
  "To follow",
1272
- "N/A"
1275
+ "Not applicable"
1273
1276
  ]
1274
1277
  },
1275
1278
  "managedAreasInsurancePolicy": {
@@ -1278,7 +1281,7 @@
1278
1281
  "enum": [
1279
1282
  "Enclosed",
1280
1283
  "To follow",
1281
- "N/A"
1284
+ "Not applicable"
1282
1285
  ]
1283
1286
  },
1284
1287
  "serviceChargeEstimatesCurrent": {
@@ -1287,7 +1290,7 @@
1287
1290
  "enum": [
1288
1291
  "Enclosed",
1289
1292
  "To follow",
1290
- "N/A"
1293
+ "Not applicable"
1291
1294
  ]
1292
1295
  },
1293
1296
  "serviceChargeEstimatesPrevious": {
@@ -1296,7 +1299,7 @@
1296
1299
  "enum": [
1297
1300
  "Enclosed",
1298
1301
  "To follow",
1299
- "N/A"
1302
+ "Not applicable"
1300
1303
  ]
1301
1304
  },
1302
1305
  "proposedWorksNotices": {
@@ -1305,7 +1308,7 @@
1305
1308
  "enum": [
1306
1309
  "Enclosed",
1307
1310
  "To follow",
1308
- "N/A"
1311
+ "Not applicable"
1309
1312
  ]
1310
1313
  },
1311
1314
  "additionalRegulationsNotInTransfer": {
@@ -1314,7 +1317,7 @@
1314
1317
  "enum": [
1315
1318
  "Enclosed",
1316
1319
  "To follow",
1317
- "N/A"
1320
+ "Not applicable"
1318
1321
  ]
1319
1322
  },
1320
1323
  "deedOfCovenant": {
@@ -1324,7 +1327,7 @@
1324
1327
  "Enclosed",
1325
1328
  "To follow",
1326
1329
  "Buyer's lawyer to draft",
1327
- "N/A"
1330
+ "Not applicable"
1328
1331
  ]
1329
1332
  },
1330
1333
  "certificateOfCompliance": {
@@ -1334,7 +1337,7 @@
1334
1337
  "Enclosed",
1335
1338
  "To follow",
1336
1339
  "Buyer's lawyer to draft",
1337
- "N/A"
1340
+ "Not applicable"
1338
1341
  ]
1339
1342
  },
1340
1343
  "permissionToAlter": {
@@ -1343,7 +1346,7 @@
1343
1346
  "enum": [
1344
1347
  "Enclosed",
1345
1348
  "To follow",
1346
- "N/A"
1349
+ "Not applicable"
1347
1350
  ]
1348
1351
  },
1349
1352
  "noticesServedOnOwner": {
@@ -1352,7 +1355,7 @@
1352
1355
  "enum": [
1353
1356
  "Enclosed",
1354
1357
  "To follow",
1355
- "N/A"
1358
+ "Not applicable"
1356
1359
  ]
1357
1360
  },
1358
1361
  "asbestosSurvey": {
@@ -1361,7 +1364,7 @@
1361
1364
  "enum": [
1362
1365
  "Enclosed",
1363
1366
  "To follow",
1364
- "N/A"
1367
+ "Not applicable"
1365
1368
  ]
1366
1369
  },
1367
1370
  "managedAreaFireRiskAssessment": {
@@ -1370,7 +1373,7 @@
1370
1373
  "enum": [
1371
1374
  "Enclosed",
1372
1375
  "To follow",
1373
- "N/A"
1376
+ "Not applicable"
1374
1377
  ]
1375
1378
  },
1376
1379
  "memorandumAndArticles": {
@@ -1379,7 +1382,7 @@
1379
1382
  "enum": [
1380
1383
  "Enclosed",
1381
1384
  "To follow",
1382
- "N/A"
1385
+ "Not applicable"
1383
1386
  ]
1384
1387
  },
1385
1388
  "managementCompanyAGMMinutes": {
@@ -1388,7 +1391,7 @@
1388
1391
  "enum": [
1389
1392
  "Enclosed",
1390
1393
  "To follow",
1391
- "N/A"
1394
+ "Not applicable"
1392
1395
  ]
1393
1396
  },
1394
1397
  "feesForAdminServices": {
@@ -1397,7 +1400,7 @@
1397
1400
  "enum": [
1398
1401
  "Enclosed",
1399
1402
  "To follow",
1400
- "N/A"
1403
+ "Not applicable"
1401
1404
  ]
1402
1405
  }
1403
1406
  }
@@ -1420,12 +1423,18 @@
1420
1423
  "contacts": {
1421
1424
  "properties": {
1422
1425
  "rentchargeOwner": {
1423
- "fme1Ref": "1.1",
1424
- "title": "Rentcharge Owner"
1425
- },
1426
- "managementCompany": {
1427
- "fme1Ref": "1.2",
1428
- "title": "Management Company"
1426
+ "properties": {
1427
+ "contact": {
1428
+ "properties": {
1429
+ "address": {
1430
+ "required": [
1431
+ "line1",
1432
+ "postcode"
1433
+ ]
1434
+ }
1435
+ }
1436
+ }
1437
+ }
1429
1438
  },
1430
1439
  "managingAgent": {
1431
1440
  "fme1Ref": "1.3",
@@ -1478,7 +1487,7 @@
1478
1487
  "Landlord",
1479
1488
  "Management Company",
1480
1489
  "Managing Agent",
1481
- "N/A"
1490
+ "Not applicable"
1482
1491
  ]
1483
1492
  },
1484
1493
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -1490,7 +1499,7 @@
1490
1499
  "Management Company",
1491
1500
  "Managing Agent",
1492
1501
  "the Lessees",
1493
- "N/A"
1502
+ "Not applicable"
1494
1503
  ]
1495
1504
  },
1496
1505
  "organisesBuildingInsurance": {
@@ -1502,7 +1511,7 @@
1502
1511
  "Management Company",
1503
1512
  "Managing Agent",
1504
1513
  "the Lessees",
1505
- "N/A"
1514
+ "Not applicable"
1506
1515
  ]
1507
1516
  }
1508
1517
  }
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": [
@@ -76,15 +99,7 @@
76
99
  "address",
77
100
  "telephone",
78
101
  "emailAddress"
79
- ],
80
- "properties": {
81
- "address": {
82
- "required": [
83
- "line1",
84
- "postcode"
85
- ]
86
- }
87
- }
102
+ ]
88
103
  }
89
104
  }
90
105
  },
@@ -434,7 +449,7 @@
434
449
  "Landlord",
435
450
  "Management Company",
436
451
  "Managing Agent",
437
- "N/A"
452
+ "Not applicable"
438
453
  ]
439
454
  },
440
455
  "collectsServiceCharges": {
@@ -445,7 +460,7 @@
445
460
  "Landlord",
446
461
  "Management Company",
447
462
  "Managing Agent",
448
- "N/A"
463
+ "Not applicable"
449
464
  ]
450
465
  },
451
466
  "collectsbuildingInsurancePremiums": {
@@ -455,7 +470,7 @@
455
470
  "Landlord",
456
471
  "Management Company",
457
472
  "Managing Agent",
458
- "N/A"
473
+ "Not applicable"
459
474
  ]
460
475
  },
461
476
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -467,7 +482,7 @@
467
482
  "Management Company",
468
483
  "Managing Agent",
469
484
  "the Lessees",
470
- "N/A"
485
+ "Not applicable"
471
486
  ]
472
487
  },
473
488
  "organisesBuildingInsurance": {
@@ -479,7 +494,7 @@
479
494
  "Management Company",
480
495
  "Managing Agent",
481
496
  "the Lessees",
482
- "N/A"
497
+ "Not applicable"
483
498
  ]
484
499
  },
485
500
  "dealsWithDayToDayMaintenanceOfBuilding": {
@@ -649,7 +664,7 @@
649
664
  "yesNoNotApplicable": {
650
665
  "enum": [
651
666
  "No",
652
- "N/A"
667
+ "Not applicable"
653
668
  ]
654
669
  }
655
670
  }
@@ -730,7 +745,7 @@
730
745
  "yesNoNotApplicable": {
731
746
  "enum": [
732
747
  "Yes",
733
- "N/A"
748
+ "Not applicable"
734
749
  ]
735
750
  }
736
751
  }
@@ -775,13 +790,6 @@
775
790
  ]
776
791
  },
777
792
  "ownershipAndManagement": {
778
- "required": [
779
- "freeholdOwner",
780
- "hasHeadlease",
781
- "buildingManager",
782
- "hasTenantCompanyDissolved",
783
- "isManagingAgentEmployed"
784
- ],
785
793
  "properties": {
786
794
  "hasHeadlease": {
787
795
  "required": [
@@ -1115,7 +1123,7 @@
1115
1123
  "properties": {
1116
1124
  "yesNo": {
1117
1125
  "enum": [
1118
- "N/A"
1126
+ "Not applicable"
1119
1127
  ]
1120
1128
  }
1121
1129
  }
@@ -1339,7 +1347,7 @@
1339
1347
  "properties": {
1340
1348
  "yesNoNotApplicable": {
1341
1349
  "enum": [
1342
- "N/A"
1350
+ "Not applicable"
1343
1351
  ]
1344
1352
  }
1345
1353
  }
@@ -1984,21 +1992,6 @@
1984
1992
  "restrictionOnKeepingPets"
1985
1993
  ],
1986
1994
  "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
1995
  "sellerAwareOfAlterations": {
2003
1996
  "required": [
2004
1997
  "yesNo"
@@ -2206,7 +2199,7 @@
2206
2199
  "enum": [
2207
2200
  "Enclosed",
2208
2201
  "To follow",
2209
- "N/A"
2202
+ "Not applicable"
2210
2203
  ]
2211
2204
  },
2212
2205
  "buildingsInsurancePolicy": {
@@ -2219,7 +2212,7 @@
2219
2212
  "enum": [
2220
2213
  "Enclosed",
2221
2214
  "To follow",
2222
- "N/A"
2215
+ "Not applicable"
2223
2216
  ]
2224
2217
  },
2225
2218
  "serviceChargeEstimatesCurrent": {
@@ -2228,7 +2221,7 @@
2228
2221
  "enum": [
2229
2222
  "Enclosed",
2230
2223
  "To follow",
2231
- "N/A"
2224
+ "Not applicable"
2232
2225
  ]
2233
2226
  },
2234
2227
  "serviceChargeEstimatesPrevious": {
@@ -2237,7 +2230,7 @@
2237
2230
  "enum": [
2238
2231
  "Enclosed",
2239
2232
  "To follow",
2240
- "N/A"
2233
+ "Not applicable"
2241
2234
  ]
2242
2235
  },
2243
2236
  "proposedWorksNotices": {
@@ -2246,7 +2239,7 @@
2246
2239
  "enum": [
2247
2240
  "Enclosed",
2248
2241
  "To follow",
2249
- "N/A"
2242
+ "Not applicable"
2250
2243
  ]
2251
2244
  },
2252
2245
  "forfeitureDocumentation": {
@@ -2255,7 +2248,7 @@
2255
2248
  "enum": [
2256
2249
  "Enclosed",
2257
2250
  "To follow",
2258
- "N/A"
2251
+ "Not applicable"
2259
2252
  ]
2260
2253
  },
2261
2254
  "additionalRegulationsNotInLease": {
@@ -2264,7 +2257,7 @@
2264
2257
  "enum": [
2265
2258
  "Enclosed",
2266
2259
  "To follow",
2267
- "N/A"
2260
+ "Not applicable"
2268
2261
  ]
2269
2262
  },
2270
2263
  "deedsOfVariation": {
@@ -2275,7 +2268,7 @@
2275
2268
  "To follow",
2276
2269
  "Landlord's lawyer provides",
2277
2270
  "Please supply draft",
2278
- "N/A"
2271
+ "Not applicable"
2279
2272
  ]
2280
2273
  },
2281
2274
  "deedOfCovenant": {
@@ -2284,7 +2277,7 @@
2284
2277
  "enum": [
2285
2278
  "Enclosed",
2286
2279
  "To follow",
2287
- "N/A"
2280
+ "Not applicable"
2288
2281
  ]
2289
2282
  },
2290
2283
  "certificateOfCompliance": {
@@ -2293,7 +2286,7 @@
2293
2286
  "enum": [
2294
2287
  "Enclosed",
2295
2288
  "To follow",
2296
- "N/A"
2289
+ "Not applicable"
2297
2290
  ]
2298
2291
  },
2299
2292
  "certificateOfComplianceFee": {
@@ -2308,7 +2301,7 @@
2308
2301
  "To follow",
2309
2302
  "Landlord's lawyer provides",
2310
2303
  "Please supply draft",
2311
- "N/A"
2304
+ "Not applicable"
2312
2305
  ]
2313
2306
  },
2314
2307
  "permissionToAlter": {
@@ -2317,7 +2310,7 @@
2317
2310
  "enum": [
2318
2311
  "Enclosed",
2319
2312
  "To follow",
2320
- "N/A"
2313
+ "Not applicable"
2321
2314
  ]
2322
2315
  },
2323
2316
  "noticesServedOnLessee": {
@@ -2326,7 +2319,7 @@
2326
2319
  "enum": [
2327
2320
  "Enclosed",
2328
2321
  "To follow",
2329
- "N/A"
2322
+ "Not applicable"
2330
2323
  ]
2331
2324
  },
2332
2325
  "asbestosSurvey": {
@@ -2335,7 +2328,7 @@
2335
2328
  "enum": [
2336
2329
  "Enclosed",
2337
2330
  "To follow",
2338
- "N/A"
2331
+ "Not applicable"
2339
2332
  ]
2340
2333
  },
2341
2334
  "managedAreaFireRiskAssessment": {
@@ -2344,7 +2337,7 @@
2344
2337
  "enum": [
2345
2338
  "Enclosed",
2346
2339
  "To follow",
2347
- "N/A"
2340
+ "Not applicable"
2348
2341
  ]
2349
2342
  },
2350
2343
  "memorandumAndArticles": {
@@ -2353,7 +2346,7 @@
2353
2346
  "enum": [
2354
2347
  "Enclosed",
2355
2348
  "To follow",
2356
- "N/A"
2349
+ "Not applicable"
2357
2350
  ]
2358
2351
  },
2359
2352
  "managementCompanyAGMMinutes": {
@@ -2362,7 +2355,7 @@
2362
2355
  "enum": [
2363
2356
  "Enclosed",
2364
2357
  "To follow",
2365
- "N/A"
2358
+ "Not applicable"
2366
2359
  ]
2367
2360
  },
2368
2361
  "deedOfCertificate": {
@@ -2371,7 +2364,7 @@
2371
2364
  "enum": [
2372
2365
  "Enclosed",
2373
2366
  "To follow",
2374
- "N/A"
2367
+ "Not applicable"
2375
2368
  ]
2376
2369
  },
2377
2370
  "landlordsCertificate": {
@@ -2380,7 +2373,7 @@
2380
2373
  "enum": [
2381
2374
  "Enclosed",
2382
2375
  "To follow",
2383
- "N/A"
2376
+ "Not applicable"
2384
2377
  ]
2385
2378
  },
2386
2379
  "enforcementNotices": {
@@ -2389,7 +2382,7 @@
2389
2382
  "enum": [
2390
2383
  "Enclosed",
2391
2384
  "To follow",
2392
- "N/A"
2385
+ "Not applicable"
2393
2386
  ]
2394
2387
  }
2395
2388
  }