@pdtf/schemas 0.10.2 → 0.10.3-a

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 (5) hide show
  1. package/package.json +1 -1
  2. package/src/examples/exampleTransaction.json +11 -9
  3. package/src/schemas/v1/legal-information.json +116 -107
  4. package/src/schemas/v1/material-facts.json +71 -31
  5. package/src/tests/transactionSchema.test.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "0.10.2",
3
+ "version": "0.10.3a",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
package/src/examples/exampleTransaction.json CHANGED
@@ -454,15 +454,17 @@
454
454
  },
455
455
  "occupiers": {
456
456
  "sellerLivesAtProperty": { "yesNo": "Yes" },
457
- "hasOthersAged17OrOver": "Yes",
458
- "aged17OrOverNames": [
459
- { "firstName": "Freya", "lastName": "Jones", "age": 21 }
460
- ],
461
- "aged17OrOverTenantsOrLodgers": { "yesNo": "No" },
462
- "vacantPossession": {
463
- "soldWithVacantPossession": "Yes",
464
- "aged17OrOverAgreedToLeave": { "yesNo": "Yes" },
465
- "aged17OrOverWillSignToConfirmWillVacate": { "yesNo": "Yes" }
457
+ "othersAged17OrOver": {
458
+ "hasOthersAged17OrOver": "Yes",
459
+ "aged17OrOverNames": [
460
+ { "firstName": "Freya", "lastName": "Jones", "age": 21 }
461
+ ],
462
+ "aged17OrOverTenantsOrLodgers": { "yesNo": "No" },
463
+ "vacantPossession": {
464
+ "soldWithVacantPossession": "Yes",
465
+ "aged17OrOverAgreedToLeave": { "yesNo": "Yes" },
466
+ "aged17OrOverWillSignToConfirmWillVacate": { "yesNo": "Yes" }
467
+ }
466
468
  }
467
469
  },
468
470
  "completionAndMoving": {
package/src/schemas/v1/legal-information.json CHANGED
@@ -574,7 +574,7 @@
574
574
  "lawSocietyRef": "TA6/11",
575
575
  "title": "Occupiers",
576
576
  "type": "object",
577
- "required": ["sellerLivesAtProperty", "hasOthersAged17OrOver"],
577
+ "required": ["sellerLivesAtProperty", "othersAged17OrOver"],
578
578
  "properties": {
579
579
  "sellerLivesAtProperty": {
580
580
  "baspiRef": "B6.1",
@@ -583,128 +583,137 @@
583
583
  "title": "Does the seller live at the property?",
584
584
  "$ref": "#/$defs/yesNo"
585
585
  },
586
- "hasOthersAged17OrOver": {
586
+ "othersAged17OrOver": {
587
587
  "baspiRef": "B6.2",
588
588
  "RDSRef": "Participants",
589
589
  "lawSocietyRef": "TA6/11.2",
590
- "title": "Does anyone else, aged 17 or over, live at the property?",
591
- "type": "string",
592
- "enum": ["Yes", "No"]
593
- }
594
- },
595
- "dependencies": {
596
- "hasOthersAged17OrOver": {
597
- "oneOf": [
598
- {
599
- "properties": {
600
- "hasOthersAged17OrOver": {
601
- "enum": ["No"]
602
- }
603
- },
604
- "additionalProperties": false
605
- },
606
- {
607
- "properties": {
608
- "hasOthersAged17OrOver": {
609
- "enum": ["Yes"]
610
- },
611
- "aged17OrOverNames": {
612
- "lawSocietyRef": "TA6/11.3",
613
- "title": "Please specify their full names and ages.",
614
- "type": "array",
615
- "minItems": 1,
616
- "items": {
617
- "type": "object",
618
- "properties": {
619
- "firstName": {
620
- "title": "First Name",
621
- "type": "string",
622
- "minLength": 1
623
- },
624
- "middleNames": {
625
- "title": "Middle name(s) if any",
626
- "type": "string"
627
- },
628
- "lastName": {
629
- "title": "Last Name",
630
- "type": "string",
631
- "minLength": 1
632
- },
633
- "age": {
634
- "title": "Age",
635
- "type": "integer"
636
- }
637
- },
638
- "required": ["firstName", "lastName", "age"]
639
- }
640
- },
641
- "aged17OrOverTenantsOrLodgers": {
642
- "baspiRef": "B6.1",
643
- "RDSRef": "Property/Flags",
644
- "lawSocietyRef": "TA6/11.4",
645
- "title": "Are any of them tenants or lodgers?",
646
- "$ref": "#/$defs/yesNo"
647
- },
648
- "vacantPossession": {
649
- "lawSocietyRef": "TA6/11.5",
650
- "type": "object",
651
- "required": ["soldWithVacantPossession"],
590
+ "type": "object",
591
+ "required": ["hasOthersAged17OrOver"],
592
+ "properties": {
593
+ "hasOthersAged17OrOver": {
594
+ "baspiRef": "B6.2",
595
+ "RDSRef": "Participants",
596
+ "lawSocietyRef": "TA6/11.2",
597
+ "title": "Does anyone else, aged 17 or over, live at the property?",
598
+ "type": "string",
599
+ "enum": ["Yes", "No"]
600
+ }
601
+ },
602
+ "dependencies": {
603
+ "hasOthersAged17OrOver": {
604
+ "oneOf": [
605
+ {
652
606
  "properties": {
653
- "soldWithVacantPossession": {
654
- "type": "string",
655
- "title": "Is the property being sold with vacant possession?",
656
- "enum": ["Yes", "No"]
607
+ "hasOthersAged17OrOver": {
608
+ "enum": ["No"]
657
609
  }
658
610
  },
659
- "dependencies": {
660
- "soldWithVacantPossession": {
661
- "oneOf": [
662
- {
663
- "properties": {
664
- "soldWithVacantPossession": {
665
- "enum": ["No"]
666
- }
611
+ "additionalProperties": false
612
+ },
613
+ {
614
+ "properties": {
615
+ "hasOthersAged17OrOver": {
616
+ "enum": ["Yes"]
617
+ },
618
+ "aged17OrOverNames": {
619
+ "lawSocietyRef": "TA6/11.3",
620
+ "title": "Please specify their full names and ages.",
621
+ "type": "array",
622
+ "minItems": 1,
623
+ "items": {
624
+ "type": "object",
625
+ "properties": {
626
+ "firstName": {
627
+ "title": "First Name",
628
+ "type": "string",
629
+ "minLength": 1
630
+ },
631
+ "middleNames": {
632
+ "title": "Middle name(s) if any",
633
+ "type": "string"
667
634
  },
668
- "additionalProperties": false
635
+ "lastName": {
636
+ "title": "Last Name",
637
+ "type": "string",
638
+ "minLength": 1
639
+ },
640
+ "age": {
641
+ "title": "Age",
642
+ "type": "integer"
643
+ }
669
644
  },
670
- {
671
- "properties": {
672
- "soldWithVacantPossession": {
673
- "enum": ["Yes"]
674
- },
675
- "aged17OrOverAgreedToLeave": {
676
- "baspiRef": "B6.4",
677
- "RDSRef": "RightsHolders,TenureAgreements,Notifications",
678
- "lawSocietyRef": "TA6/11.5a",
679
- "title": "Have all occupiers aged 17 or over agreed to leave prior to completion?",
680
- "$ref": "#/$defs/yesNo"
645
+ "required": ["firstName", "lastName", "age"]
646
+ }
647
+ },
648
+ "aged17OrOverTenantsOrLodgers": {
649
+ "baspiRef": "B6.1",
650
+ "RDSRef": "Property/Flags",
651
+ "lawSocietyRef": "TA6/11.4",
652
+ "title": "Are any of them tenants or lodgers?",
653
+ "$ref": "#/$defs/yesNo"
654
+ },
655
+ "vacantPossession": {
656
+ "lawSocietyRef": "TA6/11.5",
657
+ "type": "object",
658
+ "required": ["soldWithVacantPossession"],
659
+ "properties": {
660
+ "soldWithVacantPossession": {
661
+ "type": "string",
662
+ "title": "Is the property being sold with vacant possession?",
663
+ "enum": ["Yes", "No"]
664
+ }
665
+ },
666
+ "dependencies": {
667
+ "soldWithVacantPossession": {
668
+ "oneOf": [
669
+ {
670
+ "properties": {
671
+ "soldWithVacantPossession": {
672
+ "enum": ["No"]
673
+ }
674
+ },
675
+ "additionalProperties": false
681
676
  },
682
- "aged17OrOverWillSignToConfirmWillVacate": {
683
- "baspiRef": "B6.4",
684
- "RDSRef": "RightsHolders,TenureAgreements,Notifications",
685
- "lawSocietyRef": "TA6/11.5b",
686
- "title": "Have all occupiers aged 17 or over, agreed to sign the sale contract?",
687
- "$ref": "#/$defs/yesNoDetailIfNo",
688
- "description": "If 'No', please supply other evidence that the property will be vacant on completion."
677
+ {
678
+ "properties": {
679
+ "soldWithVacantPossession": {
680
+ "enum": ["Yes"]
681
+ },
682
+ "aged17OrOverAgreedToLeave": {
683
+ "baspiRef": "B6.4",
684
+ "RDSRef": "RightsHolders,TenureAgreements,Notifications",
685
+ "lawSocietyRef": "TA6/11.5a",
686
+ "title": "Have all occupiers aged 17 or over agreed to leave prior to completion?",
687
+ "$ref": "#/$defs/yesNo"
688
+ },
689
+ "aged17OrOverWillSignToConfirmWillVacate": {
690
+ "baspiRef": "B6.4",
691
+ "RDSRef": "RightsHolders,TenureAgreements,Notifications",
692
+ "lawSocietyRef": "TA6/11.5b",
693
+ "title": "Have all occupiers aged 17 or over, agreed to sign the sale contract?",
694
+ "$ref": "#/$defs/yesNoDetailIfNo",
695
+ "description": "If 'No', please supply other evidence that the property will be vacant on completion."
696
+ }
697
+ },
698
+ "required": [
699
+ "aged17OrOverAgreedToLeave",
700
+ "aged17OrOverWillSignToConfirmWillVacate"
701
+ ]
689
702
  }
690
- },
691
- "required": [
692
- "aged17OrOverAgreedToLeave",
693
- "aged17OrOverWillSignToConfirmWillVacate"
694
703
  ]
695
704
  }
696
- ]
705
+ }
697
706
  }
698
- }
707
+ },
708
+ "required": [
709
+ "aged17OrOverNames",
710
+ "aged17OrOverTenantsOrLodgers",
711
+ "vacantPossession"
712
+ ]
699
713
  }
700
- },
701
- "required": [
702
- "aged17OrOverNames",
703
- "aged17OrOverTenantsOrLodgers",
704
- "vacantPossession"
705
714
  ]
706
715
  }
707
- ]
716
+ }
708
717
  }
709
718
  }
710
719
  },
package/src/schemas/v1/material-facts.json CHANGED
@@ -45,56 +45,75 @@
45
45
  "$ref": "#/$defs/address"
46
46
  },
47
47
  "propertyType": {
48
+ "title": "Type of property",
48
49
  "type": "string"
49
50
  },
50
51
  "isNewBuild": {
52
+ "title": "Is the property a New Build?",
51
53
  "type": "boolean"
52
54
  },
53
55
  "location": {
54
- "latitude": {
55
- "type": "number",
56
- "minimum": -90,
57
- "maximum": 90
58
- },
59
- "longitude": {
60
- "type": "number",
61
- "minimum": -180,
62
- "maximum": 180
56
+ "title": "Geographical location",
57
+ "type": "object",
58
+ "properties": {
59
+ "latitude": {
60
+ "type": "number",
61
+ "minimum": -90,
62
+ "maximum": 90
63
+ },
64
+ "longitude": {
65
+ "type": "number",
66
+ "minimum": -180,
67
+ "maximum": 180
68
+ }
63
69
  }
64
70
  },
65
71
  "localAuthority": {
66
- "localAuthorityName": {
67
- "type": "string"
68
- },
69
- "localAuthorityReference": {
70
- "type": "string"
72
+ "title": "Geographical location",
73
+ "type": "object",
74
+ "properties": {
75
+ "localAuthorityName": {
76
+ "type": "string"
77
+ },
78
+ "localAuthorityReference": {
79
+ "type": "string"
80
+ }
71
81
  }
72
82
  },
73
83
  "priceInformation": {
74
- "price": {
75
- "type": "number",
76
- "minimum": 1
77
- },
78
- "priceQualifier": {
79
- "type": "string",
80
- "enum": [
81
- "POA",
82
- "Guide price",
83
- "Fixed price",
84
- "Offers in excess of",
85
- "Offers in region of",
86
- "Sale by tender"
87
- ]
84
+ "ntsRef": "A3",
85
+ "title": "Geographical location",
86
+ "type": "object",
87
+ "properties": {
88
+ "price": {
89
+ "ntsRef": "A3.1",
90
+ "title": "Price",
91
+ "type": "number",
92
+ "minimum": 1
93
+ },
94
+ "priceQualifier": {
95
+ "ntsRef": "A3.2",
96
+ "type": "string",
97
+ "enum": [
98
+ "POA",
99
+ "Guide price",
100
+ "Fixed price",
101
+ "Offers in excess of",
102
+ "Offers in region of",
103
+ "Sale by tender"
104
+ ]
105
+ }
88
106
  }
89
107
  },
90
108
  "summaryDescription": {
109
+ "title": "Summary description",
91
110
  "type": "string"
92
111
  },
93
112
  "media": {
113
+ "title": "Media",
94
114
  "type": "array",
95
115
  "items": {
96
116
  "type": "object",
97
- "title": "Media item",
98
117
  "required": ["mediaUrl"],
99
118
  "properties": {
100
119
  "mediaType": {
@@ -136,6 +155,7 @@
136
155
  "ownership": {
137
156
  "baspiRef": "A1.3",
138
157
  "lawSocietyRef": "TA7/1",
158
+ "ntsRef": "A1.1",
139
159
  "title": "Ownership",
140
160
  "type": "object",
141
161
  "required": ["ownershipType"],
@@ -190,24 +210,28 @@
190
210
  },
191
211
  "startYearOfLease": {
192
212
  "baspiRef": "A1.4.1b",
213
+ "ntsRef": "A1.2",
193
214
  "title": "Year that the lease commenced",
194
215
  "type": "integer",
195
216
  "minimum": 1000
196
217
  },
197
218
  "lengthOfLeaseInYears": {
198
219
  "baspiRef": "A1.4.1a",
220
+ "ntsRef": "A1.3",
199
221
  "title": "Length of lease (years)",
200
222
  "type": "integer"
201
223
  },
202
224
  "currentGroundRent": {
203
225
  "baspiRef": "A1.4.2",
226
+ "ntsRef": "A1.4",
204
227
  "RDSRef": "TenureAgreements/RentPayable/Value",
205
- "lawSocietyRef": "TA7/1.2",
228
+ "lawSocietyRef": "TA7/1.2a",
206
229
  "title": "Current annual ground rent (£)",
207
230
  "type": "number"
208
231
  },
209
232
  "rentIncrease": {
210
233
  "baspiRef": "A1.4.3",
234
+ "ntsRef": "A1.5",
211
235
  "RDSRef": "TenureAgreement/isRentChangeable, TenureAgreements/RentChanges",
212
236
  "title": "Does the ground rent increase?",
213
237
  "$ref": "#/$defs/yesNoDetailIfYes",
@@ -215,6 +239,7 @@
215
239
  },
216
240
  "annualServiceCharge": {
217
241
  "baspiRef": "A1.5.1",
242
+ "ntsRef": "A1.6",
218
243
  "RDSRef": "TenureAgreements/ServiceCharges",
219
244
  "title": "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)",
220
245
  "type": "number"
@@ -234,12 +259,14 @@
234
259
  },
235
260
  "freeholderContactDetails": {
236
261
  "baspiRef": "A1.5.4",
262
+ "lawSocietyRef": "TA7/4.1a",
237
263
  "RDSRef": "TenureAgreements/Assignor",
238
264
  "title": "The name, address and email address of the freeholder or rentcharge owner",
239
265
  "$ref": "#/$defs/contactDetails"
240
266
  },
241
267
  "managingAgentContactDetails": {
242
268
  "baspiRef": "A1.5.5",
269
+ "lawSocietyRef": "TA7/4.1b",
243
270
  "RDSRef": "Participants/Role",
244
271
  "title": "The name, address and email address of the managing agent",
245
272
  "$ref": "#/$defs/contactDetails"
@@ -272,6 +299,7 @@
272
299
  "annualServiceCharge": {
273
300
  "baspiRef": "A1.5.1",
274
301
  "lawSocietyRef": "TA6/10.1",
302
+ "ntsRef": "A1.6",
275
303
  "RDSRef": "TenureAgreements/ServiceCharges",
276
304
  "title": "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)",
277
305
  "type": "number"
@@ -293,12 +321,14 @@
293
321
  },
294
322
  "freeholderContactDetails": {
295
323
  "baspiRef": "A1.5.4",
324
+ "lawSocietyRef": "TA7/4.1a",
296
325
  "RDSRef": "TenureAgreements/Assignor",
297
326
  "title": "The contact details of the freeholder or rentcharge owner",
298
327
  "$ref": "#/$defs/contactDetails"
299
328
  },
300
329
  "managingAgentContactDetails": {
301
330
  "baspiRef": "A1.5.5",
331
+ "lawSocietyRef": "TA7/4.1b",
302
332
  "RDSRef": "Participants/Role",
303
333
  "title": "The contact details of the managing agent",
304
334
  "$ref": "#/$defs/contactDetails"
@@ -325,12 +355,14 @@
325
355
  "enum": ["Shared Ownership"]
326
356
  },
327
357
  "sharedOwnershipPercentage": {
358
+ "ntsRef": "A1.7",
328
359
  "title": "Shared ownership percentage",
329
360
  "type": "integer",
330
361
  "minimum": 5,
331
362
  "exclusiveMaximum": 100
332
363
  },
333
364
  "sharedOwnershipRent": {
365
+ "ntsRef": "A1.7",
334
366
  "title": "Shared ownership rent (£)",
335
367
  "type": "number",
336
368
  "minimum": 0
@@ -342,17 +374,20 @@
342
374
  },
343
375
  "startYearOfLease": {
344
376
  "baspiRef": "A1.4.1b",
377
+ "ntsRef": "A1.2",
345
378
  "title": "Year that the lease commenced",
346
379
  "type": "integer",
347
380
  "minimum": 1000
348
381
  },
349
382
  "lengthOfLeaseInYears": {
350
383
  "baspiRef": "A1.4.1a",
384
+ "ntsRef": "A1.3",
351
385
  "title": "Length of lease (years)",
352
386
  "type": "integer"
353
387
  },
354
388
  "currentGroundRent": {
355
389
  "baspiRef": "A1.4.2",
390
+ "ntsRef": "A1.4",
356
391
  "RDSRef": "TenureAgreements/RentPayable/Value",
357
392
  "lawSocietyRef": "TA7/1.2",
358
393
  "title": "Current annual ground rent (£)",
@@ -360,6 +395,7 @@
360
395
  },
361
396
  "rentIncrease": {
362
397
  "baspiRef": "A1.4.3",
398
+ "ntsRef": "A1.5",
363
399
  "RDSRef": "TenureAgreement/isRentChangeable, TenureAgreements/RentChanges",
364
400
  "title": "Does the ground rent increase?",
365
401
  "$ref": "#/$defs/yesNoDetailIfYes",
@@ -367,12 +403,14 @@
367
403
  },
368
404
  "annualServiceCharge": {
369
405
  "baspiRef": "A1.5.1",
406
+ "ntsRef": "A1.6",
370
407
  "RDSRef": "TenureAgreements/ServiceCharges",
371
408
  "title": "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)",
372
409
  "type": "number"
373
410
  },
374
411
  "largeAdditionalExpense": {
375
412
  "baspiRef": "A1.5.2",
413
+ "ntsRef": "A1.8",
376
414
  "RDSRef": "TenureAgreements/Repairs,TenureAgreements/ServicesCharges/Breakdown",
377
415
  "title": "Have you received notice of any large expense in addition to the annual payment?",
378
416
  "$ref": "#/$defs/yesNoDetailIfYes",
@@ -380,6 +418,7 @@
380
418
  },
381
419
  "additionalFeesOnSale": {
382
420
  "baspiRef": "A1.5.3",
421
+ "ntsRef": "A1.9",
383
422
  "RDSRef": "TenureAgreements/LegalCosts/Actual, TenureAgreements/LegalCosts/Estimated",
384
423
  "title": "Additional fees payable on sale or letting (£)",
385
424
  "type": "number"
@@ -642,12 +681,14 @@
642
681
  },
643
682
  "councilTax": {
644
683
  "baspiRef": "A1.9",
684
+ "ntsRef": "A2",
645
685
  "title": "Council Tax",
646
686
  "type": "object",
647
687
  "required": ["councilTaxBand", "councilTaxAffectingAlterations"],
648
688
  "properties": {
649
689
  "councilTaxBand": {
650
690
  "baspiRef": "A1.9.1",
691
+ "ntsRef": "A2.1",
651
692
  "RDSRef": "TenureAgreements/Taxes/{banding=?}",
652
693
  "title": "Which Council Tax band does this property fall within?",
653
694
  "type": "string",
@@ -2126,7 +2167,6 @@
2126
2167
  },
2127
2168
  "address": {
2128
2169
  "title": "Address",
2129
-
2130
2170
  "type": "string",
2131
2171
  "minLength": 1
2132
2172
  }
package/src/tests/transactionSchema.test.js CHANGED
@@ -184,7 +184,7 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
184
184
  expect(
185
185
  getTitleAtPath(
186
186
  transactionSchema,
187
- "/propertyPack/additionalLegalInfo/occupiers/aged17OrOverNames/0/firstName"
187
+ "/propertyPack/additionalLegalInfo/occupiers/othersAged17OrOver/aged17OrOverNames/0/firstName"
188
188
  )
189
189
  ).toBe("First Name");
190
190
  });