@pdtf/schemas 2.0.0-0 → 2.0.0-1

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 (12) hide show
  1. package/package.json +1 -1
  2. package/src/examples/v2/exampleTransaction.json +60 -16
  3. package/src/schemas/v2/combined.json +87 -37
  4. package/src/schemas/v2/core.json +6 -6
  5. package/src/schemas/v2/merged.json +28693 -0
  6. package/src/schemas/v2/overlays/baspi.json +119 -11
  7. package/src/schemas/v2/overlays/fme1.json +5 -5
  8. package/src/schemas/v2/overlays/lpe1.json +17 -22
  9. package/src/schemas/v2/overlays/nts.json +1 -1
  10. package/src/schemas/v2/overlays/rds.json +3 -2
  11. package/src/schemas/v2/overlays/ta7.json +4 -3
  12. package/src/utils/extractOverlay.js +28 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "2.0.0-0",
3
+ "version": "2.0.0-1",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
package/src/examples/v2/exampleTransaction.json CHANGED
@@ -25,7 +25,6 @@
25
25
  "county": "Herts",
26
26
  "postcode": "AL3 5AF"
27
27
  },
28
-
29
28
  "delayFactors": {
30
29
  "hasDelayFactors": { "yesNo": "No" }
31
30
  },
@@ -34,21 +33,66 @@
34
33
  {
35
34
  "titleNumber": "HD221222",
36
35
  "ownershipType": "Leasehold",
37
- "sharedOwnership": { "isSharedOwnership": "No" },
38
- "startYearOfLease": 1900,
39
- "lengthOfLeaseInYears": 999,
40
- "currentGroundRent": 1750,
41
- "rentIncrease": { "yesNo": "No" },
42
- "annualServiceCharge": 250.23,
43
- "largeAdditionalExpense": { "yesNo": "No" },
44
- "additionalFeesOnSale": 0,
45
- "freeholderContactDetails": {
46
- "nameOrOrganisation": "Fleesum Properties"
47
- },
48
- "managingAgentContactDetails": {
49
- "nameOrOrganisation": "Pricee Living"
50
- },
51
- "managementCompanyDirectorRequirement": { "yesNo": "No" }
36
+ "leaseholdInformation": {
37
+ "contactDetails": {
38
+ "contacts": {
39
+ "landlord": {
40
+ "nameOrOrganisation": "Fleesum Properties",
41
+ "address": {
42
+ "line1": "47 Park Road",
43
+ "postcode": "AL3 5AF"
44
+ },
45
+ "emailAddress": "james@fleesum.com"
46
+ },
47
+ "managingAgent": {
48
+ "nameOrOrganisation": "Pricee Living",
49
+ "address": {
50
+ "line1": "Pricee House",
51
+ "postcode": "AL3 5KK"
52
+ },
53
+ "emailAddress": "marcel@pricee.co.uk"
54
+ }
55
+ }
56
+ },
57
+ "groundRent": {
58
+ "isGroundRentPayable": "Yes",
59
+ "annualGroundRent": 1750,
60
+ "rentSubjectToIncrease": {
61
+ "yesNo": "Yes",
62
+ "rentReviewFrequency": "Annually",
63
+ "rentIncreaseCalculated": "RPI"
64
+ }
65
+ },
66
+ "transferAndRegistration": {
67
+ "requirementsToBeMemberOfManagementCompany": {
68
+ "yesNoNotApplicable": "No"
69
+ }
70
+ },
71
+ "serviceCharge": {
72
+ "sellerContributesToServiceCharge": "Yes",
73
+ "annualServiceCharge": 250.23,
74
+ "largeAdditionalExpense": { "yesNo": "No" },
75
+ "reserveFund": {
76
+ "yesNo": "Yes",
77
+ "details": "There is sinking fund."
78
+ }
79
+ },
80
+ "general": {
81
+ "typeOfLeasehold": {
82
+ "leaseholdType": "Shared ownership",
83
+ "sharedOwnershipPercentage": 50,
84
+ "sharedOwnershipRent": 200,
85
+ "sharedOwnershipRentFrequency": "Monthly"
86
+ },
87
+ "leaseTerm": {
88
+ "startYearOfLease": 1900,
89
+ "lengthOfLeaseInYears": 999
90
+ }
91
+ },
92
+
93
+ "largeAdditionalExpense": { "yesNo": "No" },
94
+ "additionalFeesOnSale": 0
95
+ }
52
96
  }
53
97
  ]
54
98
  },
package/src/schemas/v2/combined.json CHANGED
@@ -487,6 +487,10 @@
487
487
  "requiredDocuments",
488
488
  "confirmation"
489
489
  ],
490
+ "baspiRequired": [
491
+ "contactDetails",
492
+ "serviceCharge"
493
+ ],
490
494
  "properties": {
491
495
  "contactDetails": {
492
496
  "fme1Ref": "1",
@@ -559,7 +563,7 @@
559
563
  },
560
564
  "fme1Required": [
561
565
  "nameOrOrganisation",
562
- "addressLine1",
566
+ "line1",
563
567
  "postcode",
564
568
  "telephone",
565
569
  "emailAddress"
@@ -660,7 +664,7 @@
660
664
  },
661
665
  "fme1Required": [
662
666
  "nameOrOrganisation",
663
- "addressLine1",
667
+ "line1",
664
668
  "postcode",
665
669
  "telephone",
666
670
  "emailAddress"
@@ -778,7 +782,7 @@
778
782
  },
779
783
  "fme1Required": [
780
784
  "nameOrOrganisation",
781
- "addressLine1",
785
+ "line1",
782
786
  "postcode",
783
787
  "telephone",
784
788
  "emailAddress"
@@ -887,7 +891,7 @@
887
891
  },
888
892
  "fme1Required": [
889
893
  "nameOrOrganisation",
890
- "addressLine1",
894
+ "line1",
891
895
  "postcode",
892
896
  "telephone",
893
897
  "emailAddress"
@@ -1177,7 +1181,7 @@
1177
1181
  },
1178
1182
  "fme1Required": [
1179
1183
  "nameOrOrganisation",
1180
- "addressLine1",
1184
+ "line1",
1181
1185
  "postcode",
1182
1186
  "telephone",
1183
1187
  "emailAddress"
@@ -2526,6 +2530,9 @@
2526
2530
  },
2527
2531
  "fme1Required": [
2528
2532
  "managedFreeholdOrCommonholdInformation"
2533
+ ],
2534
+ "baspiRequired": [
2535
+ "managedFreeholdOrCommonholdInformation"
2529
2536
  ]
2530
2537
  },
2531
2538
  {
@@ -2552,7 +2559,7 @@
2552
2559
  "baspiRequired": [
2553
2560
  "contactDetails",
2554
2561
  "groundRent",
2555
- "ownershipAndManagement",
2562
+ "transferAndRegistration",
2556
2563
  "serviceCharge",
2557
2564
  "general"
2558
2565
  ],
@@ -2567,6 +2574,7 @@
2567
2574
  "contacts",
2568
2575
  "serviceContactAssignments"
2569
2576
  ],
2577
+ "baspiRequired": ["contacts"],
2570
2578
  "properties": {
2571
2579
  "contacts": {
2572
2580
  "baspiRef": "A1.5.4.",
@@ -2575,6 +2583,10 @@
2575
2583
  "type": "object",
2576
2584
  "title": "Contacts",
2577
2585
  "description": "Complete the details for the relevant parties",
2586
+ "baspiRequired": [
2587
+ "landlord",
2588
+ "managingAgent"
2589
+ ],
2578
2590
  "properties": {
2579
2591
  "landlord": {
2580
2592
  "baspiRef": "A1.5.4",
@@ -2583,6 +2595,17 @@
2583
2595
  "title": "Landlord",
2584
2596
  "description": "The landlord (or freeholder) may be, for example, a private individual, a housing association, or a management company owned by the residents",
2585
2597
  "type": "object",
2598
+ "lpe1Required": [
2599
+ "nameOrOrganisation",
2600
+ "address",
2601
+ "telephone",
2602
+ "emailAddress"
2603
+ ],
2604
+ "baspiRequired": [
2605
+ "nameOrOrganisation",
2606
+ "address",
2607
+ "emailAddress"
2608
+ ],
2586
2609
  "properties": {
2587
2610
  "contact": {
2588
2611
  "baspiRef": "A1.5.4.1",
@@ -2631,6 +2654,10 @@
2631
2654
  "lpe1Required": [
2632
2655
  "line1",
2633
2656
  "postcode"
2657
+ ],
2658
+ "baspiRequired": [
2659
+ "line1",
2660
+ "postcode"
2634
2661
  ]
2635
2662
  },
2636
2663
  "telephone": {
@@ -2644,14 +2671,7 @@
2644
2671
  "type": "string",
2645
2672
  "format": "email"
2646
2673
  }
2647
- },
2648
- "lpe1Required": [
2649
- "nameOrOrganisation",
2650
- "addressLine1",
2651
- "postcode",
2652
- "telephone",
2653
- "emailAddress"
2654
- ]
2674
+ }
2655
2675
  },
2656
2676
  "bankDetails": {
2657
2677
  "type": "object",
@@ -2747,8 +2767,7 @@
2747
2767
  },
2748
2768
  "lpe1Required": [
2749
2769
  "nameOrOrganisation",
2750
- "addressLine1",
2751
- "postcode",
2770
+ "address",
2752
2771
  "telephone",
2753
2772
  "emailAddress"
2754
2773
  ]
@@ -2849,8 +2868,7 @@
2849
2868
  },
2850
2869
  "lpe1Required": [
2851
2870
  "nameOrOrganisation",
2852
- "addressLine1",
2853
- "postcode",
2871
+ "address",
2854
2872
  "telephone",
2855
2873
  "emailAddress"
2856
2874
  ]
@@ -2947,6 +2965,10 @@
2947
2965
  "lpe1Required": [
2948
2966
  "line1",
2949
2967
  "postcode"
2968
+ ],
2969
+ "baspiRequired": [
2970
+ "line1",
2971
+ "postcode"
2950
2972
  ]
2951
2973
  },
2952
2974
  "telephone": {
@@ -2963,10 +2985,14 @@
2963
2985
  },
2964
2986
  "lpe1Required": [
2965
2987
  "nameOrOrganisation",
2966
- "addressLine1",
2967
- "postcode",
2988
+ "address",
2968
2989
  "telephone",
2969
2990
  "emailAddress"
2991
+ ],
2992
+ "baspiRequired": [
2993
+ "nameOrOrganisation",
2994
+ "address",
2995
+ "emailAddress"
2970
2996
  ]
2971
2997
  },
2972
2998
  "appointedBy": {
@@ -3072,10 +3098,15 @@
3072
3098
  },
3073
3099
  "lpe1Required": [
3074
3100
  "nameOrOrganisation",
3075
- "addressLine1",
3101
+ "line1",
3076
3102
  "postcode",
3077
3103
  "telephone",
3078
3104
  "emailAddress"
3105
+ ],
3106
+ "baspiRequired": [
3107
+ "nameOrOrganisation",
3108
+ "line1",
3109
+ "postcode"
3079
3110
  ]
3080
3111
  },
3081
3112
  "bankDetails": {
@@ -3173,7 +3204,7 @@
3173
3204
  },
3174
3205
  "lpe1Required": [
3175
3206
  "nameOrOrganisation",
3176
- "addressLine1",
3207
+ "line1",
3177
3208
  "postcode",
3178
3209
  "telephone",
3179
3210
  "emailAddress"
@@ -3439,7 +3470,7 @@
3439
3470
  },
3440
3471
  "lpe1Required": [
3441
3472
  "nameOrOrganisation",
3442
- "addressLine1",
3473
+ "line1",
3443
3474
  "postcode",
3444
3475
  "telephone",
3445
3476
  "emailAddress"
@@ -3742,7 +3773,7 @@
3742
3773
  },
3743
3774
  "lpe1Required": [
3744
3775
  "nameOrOrganisation",
3745
- "addressLine1",
3776
+ "line1",
3746
3777
  "postcode",
3747
3778
  "telephone",
3748
3779
  "emailAddress"
@@ -3955,7 +3986,7 @@
3955
3986
  },
3956
3987
  "lpe1Required": [
3957
3988
  "nameOrOrganisation",
3958
- "addressLine1",
3989
+ "line1",
3959
3990
  "postcode",
3960
3991
  "telephone",
3961
3992
  "emailAddress"
@@ -3970,6 +4001,7 @@
3970
4001
  },
3971
4002
  "transferAndRegistration": {
3972
4003
  "lpe1Ref": "2",
4004
+ "baspiRef": "A1.5.6",
3973
4005
  "title": "Transfer and Registration",
3974
4006
  "type": "object",
3975
4007
  "lpe1Required": [
@@ -3979,6 +4011,9 @@
3979
4011
  "requirementsToBeMemberOfManagementCompany",
3980
4012
  "procedureForObtainingCertificate"
3981
4013
  ],
4014
+ "baspiRequired": [
4015
+ "requirementsToBeMemberOfManagementCompany"
4016
+ ],
3982
4017
  "properties": {
3983
4018
  "deedOfCovenantRequired": {
3984
4019
  "lpe1Ref": "2.1",
@@ -4258,7 +4293,7 @@
4258
4293
  "ntsRef": "A1.5",
4259
4294
  "ta7Ref": "1.2c",
4260
4295
  "type": "object",
4261
- "title": "Is the rent subject to increase?",
4296
+ "title": "Is the ground rent subject to increase?",
4262
4297
  "properties": {
4263
4298
  "yesNo": {
4264
4299
  "type": "string",
@@ -4284,7 +4319,7 @@
4284
4319
  "yesNo": {
4285
4320
  "enum": ["Yes"]
4286
4321
  },
4287
- "rentReviewed": {
4322
+ "rentReviewFrequency": {
4288
4323
  "baspiRef": "A1.4.2.3.1",
4289
4324
  "ta7Ref": "1.2d",
4290
4325
  "title": "How often is the rent reviewed?",
@@ -4299,11 +4334,11 @@
4299
4334
  }
4300
4335
  },
4301
4336
  "lpe1Required": [
4302
- "rentReviewed",
4337
+ "rentReviewFrequency",
4303
4338
  "rentIncreaseCalculated"
4304
4339
  ],
4305
4340
  "baspiRequired": [
4306
- "rentReviewed",
4341
+ "rentReviewFrequency",
4307
4342
  "rentIncreaseCalculated"
4308
4343
  ]
4309
4344
  }
@@ -4369,8 +4404,11 @@
4369
4404
  "groundRentFrequency",
4370
4405
  "rentSubjectToIncrease",
4371
4406
  "groundRentPaidUpToDate",
4372
- "lastDemandPeriod",
4373
- "requirementsToBeMemberOfManagementCompany"
4407
+ "lastDemandPeriod"
4408
+ ],
4409
+ "baspiRequired": [
4410
+ "annualGroundRent",
4411
+ "rentSubjectToIncrease"
4374
4412
  ]
4375
4413
  }
4376
4414
  ]
@@ -4785,7 +4823,7 @@
4785
4823
  "excessPaymentAnticipated": {
4786
4824
  "lpe1Ref": "4.3",
4787
4825
  "type": "object",
4788
- "title": " Is any excess payment anticipated for the Property at the end of the financial year?",
4826
+ "title": "Is any excess payment anticipated for the Property at the end of the financial year?",
4789
4827
  "properties": {
4790
4828
  "yesNo": {
4791
4829
  "type": "string",
@@ -4878,17 +4916,21 @@
4878
4916
  ]
4879
4917
  },
4880
4918
  "reserveFund": {
4919
+ "baspiRef": "1.5.2.1",
4881
4920
  "lpe1Ref": "4.6",
4882
4921
  "type": "object",
4883
4922
  "title": "Does a Reserve Fund apply to the Managed Area?",
4884
4923
  "properties": {
4885
4924
  "yesNo": {
4925
+ "baspiRef": "1.5.2.1.1",
4926
+
4886
4927
  "type": "string",
4887
4928
  "title": "",
4888
4929
  "enum": ["Yes", "No"]
4889
4930
  }
4890
4931
  },
4891
4932
  "lpe1Required": ["yesNo"],
4933
+ "baspiRequired": ["yesNo"],
4892
4934
  "discriminator": {
4893
4935
  "propertyName": "yesNo"
4894
4936
  },
@@ -4906,6 +4948,7 @@
4906
4948
  "enum": ["Yes"]
4907
4949
  },
4908
4950
  "details": {
4951
+ "baspiRef": "1.5.2.1.2",
4909
4952
  "lpe1Ref": "4.6.1",
4910
4953
  "title": "Provide details",
4911
4954
  "type": "string",
@@ -4951,7 +4994,8 @@
4951
4994
  ]
4952
4995
  }
4953
4996
  },
4954
- "lpe1Required": ["details"]
4997
+ "lpe1Required": ["details"],
4998
+ "baspiRequired": ["details"]
4955
4999
  }
4956
5000
  ]
4957
5001
  },
@@ -5339,6 +5383,11 @@
5339
5383
  "allPropertiesContribute",
5340
5384
  "deedOfCertificateServed",
5341
5385
  "landlordsCertificateServed"
5386
+ ],
5387
+ "baspiRequired": [
5388
+ "annualServiceCharge",
5389
+ "largeAdditionalExpense",
5390
+ "reserveFund"
5342
5391
  ]
5343
5392
  }
5344
5393
  ]
@@ -6054,7 +6103,7 @@
6054
6103
  "type": "string",
6055
6104
  "enum": [
6056
6105
  "Flat",
6057
- "Shared Ownership",
6106
+ "Shared ownership",
6058
6107
  "Long leasehold house"
6059
6108
  ]
6060
6109
  }
@@ -6076,7 +6125,7 @@
6076
6125
  {
6077
6126
  "properties": {
6078
6127
  "leaseholdType": {
6079
- "enum": ["Shared Ownership"]
6128
+ "enum": ["Shared ownership"]
6080
6129
  },
6081
6130
  "sharedOwnershipPercentage": {
6082
6131
  "baspiRef": "A1.3.1.1",
@@ -6672,7 +6721,8 @@
6672
6721
  }
6673
6722
  }
6674
6723
  },
6675
- "lpe1Required": ["leaseholdInformation"]
6724
+ "lpe1Required": ["leaseholdInformation"],
6725
+ "baspiRequired": ["leaseholdInformation"]
6676
6726
  },
6677
6727
  {
6678
6728
  "properties": {
@@ -13966,7 +14016,7 @@
13966
14016
  "baspiRef": "B5.3",
13967
14017
  "rdsRef": "Certificates",
13968
14018
  "title": "Do you have any title defect insurance policies?",
13969
- "description": " e.g. for breach of planning permission, buildings regulations, restrictions, chancel repair etc",
14019
+ "description": "e.g. for breach of planning permission, buildings regulations, restrictions, chancel repair etc",
13970
14020
  "type": "object",
13971
14021
  "properties": {
13972
14022
  "yesNo": {
package/src/schemas/v2/core.json CHANGED
@@ -3781,7 +3781,7 @@
3781
3781
  },
3782
3782
  "rentSubjectToIncrease": {
3783
3783
  "type": "object",
3784
- "title": "Is the rent subject to increase?",
3784
+ "title": "Is the ground rent subject to increase?",
3785
3785
  "properties": {
3786
3786
  "yesNo": {
3787
3787
  "type": "string",
@@ -3809,7 +3809,7 @@
3809
3809
  "Yes"
3810
3810
  ]
3811
3811
  },
3812
- "rentReviewed": {
3812
+ "rentReviewFrequency": {
3813
3813
  "title": "How often is the rent reviewed?",
3814
3814
  "type": "string"
3815
3815
  },
@@ -4278,7 +4278,7 @@
4278
4278
  },
4279
4279
  "excessPaymentAnticipated": {
4280
4280
  "type": "object",
4281
- "title": " Is any excess payment anticipated for the Property at the end of the financial year?",
4281
+ "title": "Is any excess payment anticipated for the Property at the end of the financial year?",
4282
4282
  "properties": {
4283
4283
  "yesNo": {
4284
4284
  "type": "string",
@@ -5462,7 +5462,7 @@
5462
5462
  "type": "string",
5463
5463
  "enum": [
5464
5464
  "Flat",
5465
- "Shared Ownership",
5465
+ "Shared ownership",
5466
5466
  "Long leasehold house"
5467
5467
  ]
5468
5468
  }
@@ -5482,7 +5482,7 @@
5482
5482
  "properties": {
5483
5483
  "leaseholdType": {
5484
5484
  "enum": [
5485
- "Shared Ownership"
5485
+ "Shared ownership"
5486
5486
  ]
5487
5487
  },
5488
5488
  "sharedOwnershipPercentage": {
@@ -12917,7 +12917,7 @@
12917
12917
  },
12918
12918
  "titleDefectInsurance": {
12919
12919
  "title": "Do you have any title defect insurance policies?",
12920
- "description": " e.g. for breach of planning permission, buildings regulations, restrictions, chancel repair etc",
12920
+ "description": "e.g. for breach of planning permission, buildings regulations, restrictions, chancel repair etc",
12921
12921
  "type": "object",
12922
12922
  "properties": {
12923
12923
  "yesNo": {