@pdtf/schemas 2.0.0-2 → 2.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 (22) hide show
  1. package/index.js +33 -19
  2. package/package.json +1 -1
  3. package/src/examples/v2/exampleTransaction.json +86 -87
  4. package/src/schemas/v2/combined.json +7432 -1101
  5. package/src/schemas/v2/overlays/baspi.json +1087 -742
  6. package/src/schemas/v2/overlays/con29DW.json +256 -127
  7. package/src/schemas/v2/overlays/con29R.json +1 -1
  8. package/src/schemas/v2/overlays/fme1.json +46 -212
  9. package/src/schemas/v2/overlays/lpe1.json +92 -63
  10. package/src/schemas/v2/overlays/nts.json +39 -43
  11. package/src/schemas/v2/overlays/rds.json +339 -337
  12. package/src/schemas/v2/overlays/ta10.json +844 -1
  13. package/src/schemas/v2/overlays/ta6.json +330 -291
  14. package/src/schemas/v2/overlays/ta7.json +98 -33
  15. package/src/schemas/v2/{core.json → pdtf-transaction.json} +6901 -927
  16. package/src/schemas/v2/skeleton.json +3559 -0
  17. package/src/tests/v1/transactionSchema.test.js +21 -13
  18. package/src/tests/v2/transactionSchema.test.js +6 -4
  19. package/src/tests/v2/verifiedClaimsValidator.test.js +128 -0
  20. package/src/utils/extractOverlay.js +47 -9
  21. package/src/utils/extractProperties.js +44 -0
  22. package/src/schemas/v2/merged.json +0 -28697
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": [
@@ -322,6 +345,9 @@
322
345
  }
323
346
  },
324
347
  "noticeOfTransferAndCharge": {
348
+ "lpe1Ref": "1.5",
349
+ "title": "Who accepts service of the Notice of Transfer & Charge?",
350
+ "description": "Tick the box beside each party and state the total fee including VAT for notice of transfer and charge. Tick 'Notice via email' column to confirm whether you will accept notice via email.",
325
351
  "properties": {
326
352
  "rentchargeOwner": {
327
353
  "required": [
@@ -413,16 +439,32 @@
413
439
  ]
414
440
  },
415
441
  "otherDetailsRequired": {
416
- "required": [
417
- "areOtherDetailsRequired"
418
- ],
442
+ "lpe1Ref": "1.5.1",
443
+ "title": "Are details other than the incoming owner's name, address and lender name required?",
444
+ "discriminator": {
445
+ "propertyName": "areOtherDetailsRequired"
446
+ },
419
447
  "oneOf": [
420
- null,
421
448
  {
449
+ "properties": {
450
+ "areOtherDetailsRequired": {
451
+ "const": "No"
452
+ }
453
+ }
454
+ },
455
+ {
456
+ "properties": {
457
+ "areOtherDetailsRequired": {
458
+ "const": "Yes"
459
+ }
460
+ },
422
461
  "required": [
423
462
  "details"
424
463
  ]
425
464
  }
465
+ ],
466
+ "required": [
467
+ "areOtherDetailsRequired"
426
468
  ]
427
469
  }
428
470
  }
@@ -434,7 +476,7 @@
434
476
  "Landlord",
435
477
  "Management Company",
436
478
  "Managing Agent",
437
- "N/A"
479
+ "Not applicable"
438
480
  ]
439
481
  },
440
482
  "collectsServiceCharges": {
@@ -445,7 +487,7 @@
445
487
  "Landlord",
446
488
  "Management Company",
447
489
  "Managing Agent",
448
- "N/A"
490
+ "Not applicable"
449
491
  ]
450
492
  },
451
493
  "collectsbuildingInsurancePremiums": {
@@ -455,7 +497,7 @@
455
497
  "Landlord",
456
498
  "Management Company",
457
499
  "Managing Agent",
458
- "N/A"
500
+ "Not applicable"
459
501
  ]
460
502
  },
461
503
  "dealsWithDayToDayMaintenanceOfManagedArea": {
@@ -467,7 +509,7 @@
467
509
  "Management Company",
468
510
  "Managing Agent",
469
511
  "the Lessees",
470
- "N/A"
512
+ "Not applicable"
471
513
  ]
472
514
  },
473
515
  "organisesBuildingInsurance": {
@@ -479,7 +521,7 @@
479
521
  "Management Company",
480
522
  "Managing Agent",
481
523
  "the Lessees",
482
- "N/A"
524
+ "Not applicable"
483
525
  ]
484
526
  },
485
527
  "dealsWithDayToDayMaintenanceOfBuilding": {
@@ -649,7 +691,7 @@
649
691
  "yesNoNotApplicable": {
650
692
  "enum": [
651
693
  "No",
652
- "N/A"
694
+ "Not applicable"
653
695
  ]
654
696
  }
655
697
  }
@@ -702,7 +744,7 @@
702
744
  },
703
745
  "annualGroundRent": {
704
746
  "lpe1Ref": "3.1",
705
- "title": "What is the annual ground rent payable?"
747
+ "title": "What is the annual ground rent payable? (£)"
706
748
  },
707
749
  "rentSubjectToIncrease": {
708
750
  "required": [
@@ -730,7 +772,7 @@
730
772
  "yesNoNotApplicable": {
731
773
  "enum": [
732
774
  "Yes",
733
- "N/A"
775
+ "Not applicable"
734
776
  ]
735
777
  }
736
778
  }
@@ -775,13 +817,6 @@
775
817
  ]
776
818
  },
777
819
  "ownershipAndManagement": {
778
- "required": [
779
- "freeholdOwner",
780
- "hasHeadlease",
781
- "buildingManager",
782
- "hasTenantCompanyDissolved",
783
- "isManagingAgentEmployed"
784
- ],
785
820
  "properties": {
786
821
  "hasHeadlease": {
787
822
  "required": [
@@ -1115,7 +1150,7 @@
1115
1150
  "properties": {
1116
1151
  "yesNo": {
1117
1152
  "enum": [
1118
- "N/A"
1153
+ "Not applicable"
1119
1154
  ]
1120
1155
  }
1121
1156
  }
@@ -1278,7 +1313,7 @@
1278
1313
  ]
1279
1314
  },
1280
1315
  "details": {
1281
- "lpe1Ref": "4.12.1",
1316
+ "lpe1Ref": "4.12.2",
1282
1317
  "title": "Provide details."
1283
1318
  }
1284
1319
  },
@@ -1289,7 +1324,16 @@
1289
1324
  ],
1290
1325
  "required": [
1291
1326
  "yesNo"
1292
- ]
1327
+ ],
1328
+ "properties": {
1329
+ "yesNo": {
1330
+ "lpe1Ref": "4.12.1",
1331
+ "enum": [
1332
+ "Yes",
1333
+ "No"
1334
+ ]
1335
+ }
1336
+ }
1293
1337
  },
1294
1338
  "allPropertiesContribute": {
1295
1339
  "lpe1Ref": "4.13",
@@ -1339,7 +1383,7 @@
1339
1383
  "properties": {
1340
1384
  "yesNoNotApplicable": {
1341
1385
  "enum": [
1342
- "N/A"
1386
+ "Not applicable"
1343
1387
  ]
1344
1388
  }
1345
1389
  }
@@ -1387,7 +1431,7 @@
1387
1431
  "difficultyInCollectingServiceCharge",
1388
1432
  "serviceChargeOwed",
1389
1433
  "propertiesContributingToMaintenanceOfManagedArea",
1390
- "serviceChargePayable",
1434
+ "adHocExpenses",
1391
1435
  "serviceChargePaidUpToDate",
1392
1436
  "excessPaymentAnticipated",
1393
1437
  "lastDemandPeriod",
@@ -1984,21 +2028,6 @@
1984
2028
  "restrictionOnKeepingPets"
1985
2029
  ],
1986
2030
  "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
2031
  "sellerAwareOfAlterations": {
2003
2032
  "required": [
2004
2033
  "yesNo"
@@ -2206,7 +2235,7 @@
2206
2235
  "enum": [
2207
2236
  "Enclosed",
2208
2237
  "To follow",
2209
- "N/A"
2238
+ "Not applicable"
2210
2239
  ]
2211
2240
  },
2212
2241
  "buildingsInsurancePolicy": {
@@ -2219,7 +2248,7 @@
2219
2248
  "enum": [
2220
2249
  "Enclosed",
2221
2250
  "To follow",
2222
- "N/A"
2251
+ "Not applicable"
2223
2252
  ]
2224
2253
  },
2225
2254
  "serviceChargeEstimatesCurrent": {
@@ -2228,7 +2257,7 @@
2228
2257
  "enum": [
2229
2258
  "Enclosed",
2230
2259
  "To follow",
2231
- "N/A"
2260
+ "Not applicable"
2232
2261
  ]
2233
2262
  },
2234
2263
  "serviceChargeEstimatesPrevious": {
@@ -2237,7 +2266,7 @@
2237
2266
  "enum": [
2238
2267
  "Enclosed",
2239
2268
  "To follow",
2240
- "N/A"
2269
+ "Not applicable"
2241
2270
  ]
2242
2271
  },
2243
2272
  "proposedWorksNotices": {
@@ -2246,7 +2275,7 @@
2246
2275
  "enum": [
2247
2276
  "Enclosed",
2248
2277
  "To follow",
2249
- "N/A"
2278
+ "Not applicable"
2250
2279
  ]
2251
2280
  },
2252
2281
  "forfeitureDocumentation": {
@@ -2255,7 +2284,7 @@
2255
2284
  "enum": [
2256
2285
  "Enclosed",
2257
2286
  "To follow",
2258
- "N/A"
2287
+ "Not applicable"
2259
2288
  ]
2260
2289
  },
2261
2290
  "additionalRegulationsNotInLease": {
@@ -2264,7 +2293,7 @@
2264
2293
  "enum": [
2265
2294
  "Enclosed",
2266
2295
  "To follow",
2267
- "N/A"
2296
+ "Not applicable"
2268
2297
  ]
2269
2298
  },
2270
2299
  "deedsOfVariation": {
@@ -2275,7 +2304,7 @@
2275
2304
  "To follow",
2276
2305
  "Landlord's lawyer provides",
2277
2306
  "Please supply draft",
2278
- "N/A"
2307
+ "Not applicable"
2279
2308
  ]
2280
2309
  },
2281
2310
  "deedOfCovenant": {
@@ -2284,7 +2313,7 @@
2284
2313
  "enum": [
2285
2314
  "Enclosed",
2286
2315
  "To follow",
2287
- "N/A"
2316
+ "Not applicable"
2288
2317
  ]
2289
2318
  },
2290
2319
  "certificateOfCompliance": {
@@ -2293,7 +2322,7 @@
2293
2322
  "enum": [
2294
2323
  "Enclosed",
2295
2324
  "To follow",
2296
- "N/A"
2325
+ "Not applicable"
2297
2326
  ]
2298
2327
  },
2299
2328
  "certificateOfComplianceFee": {
@@ -2308,7 +2337,7 @@
2308
2337
  "To follow",
2309
2338
  "Landlord's lawyer provides",
2310
2339
  "Please supply draft",
2311
- "N/A"
2340
+ "Not applicable"
2312
2341
  ]
2313
2342
  },
2314
2343
  "permissionToAlter": {
@@ -2317,7 +2346,7 @@
2317
2346
  "enum": [
2318
2347
  "Enclosed",
2319
2348
  "To follow",
2320
- "N/A"
2349
+ "Not applicable"
2321
2350
  ]
2322
2351
  },
2323
2352
  "noticesServedOnLessee": {
@@ -2326,7 +2355,7 @@
2326
2355
  "enum": [
2327
2356
  "Enclosed",
2328
2357
  "To follow",
2329
- "N/A"
2358
+ "Not applicable"
2330
2359
  ]
2331
2360
  },
2332
2361
  "asbestosSurvey": {
@@ -2335,7 +2364,7 @@
2335
2364
  "enum": [
2336
2365
  "Enclosed",
2337
2366
  "To follow",
2338
- "N/A"
2367
+ "Not applicable"
2339
2368
  ]
2340
2369
  },
2341
2370
  "managedAreaFireRiskAssessment": {
@@ -2344,7 +2373,7 @@
2344
2373
  "enum": [
2345
2374
  "Enclosed",
2346
2375
  "To follow",
2347
- "N/A"
2376
+ "Not applicable"
2348
2377
  ]
2349
2378
  },
2350
2379
  "memorandumAndArticles": {
@@ -2353,7 +2382,7 @@
2353
2382
  "enum": [
2354
2383
  "Enclosed",
2355
2384
  "To follow",
2356
- "N/A"
2385
+ "Not applicable"
2357
2386
  ]
2358
2387
  },
2359
2388
  "managementCompanyAGMMinutes": {
@@ -2362,7 +2391,7 @@
2362
2391
  "enum": [
2363
2392
  "Enclosed",
2364
2393
  "To follow",
2365
- "N/A"
2394
+ "Not applicable"
2366
2395
  ]
2367
2396
  },
2368
2397
  "deedOfCertificate": {
@@ -2371,7 +2400,7 @@
2371
2400
  "enum": [
2372
2401
  "Enclosed",
2373
2402
  "To follow",
2374
- "N/A"
2403
+ "Not applicable"
2375
2404
  ]
2376
2405
  },
2377
2406
  "landlordsCertificate": {
@@ -2380,7 +2409,7 @@
2380
2409
  "enum": [
2381
2410
  "Enclosed",
2382
2411
  "To follow",
2383
- "N/A"
2412
+ "Not applicable"
2384
2413
  ]
2385
2414
  },
2386
2415
  "enforcementNotices": {
@@ -2389,7 +2418,7 @@
2389
2418
  "enum": [
2390
2419
  "Enclosed",
2391
2420
  "To follow",
2392
- "N/A"
2421
+ "Not applicable"
2393
2422
  ]
2394
2423
  }
2395
2424
  }
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,
@@ -48,7 +86,7 @@
48
86
  "properties": {
49
87
  "annualGroundRent": {
50
88
  "ntsRef": "A1.4",
51
- "title": "What is the annual ground rent payable?"
89
+ "title": "What is the annual ground rent payable? (£)"
52
90
  },
53
91
  "rentSubjectToIncrease": {
54
92
  "ntsRef": "A1.5",
@@ -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
  }