@pdtf/schemas 0.5.13 → 0.6.0

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 (15) hide show
  1. package/index.js +20 -12
  2. package/package.json +1 -1
  3. package/src/examples/exampleDocumentedVouch.json +1 -1
  4. package/src/examples/exampleElectronicRecord.json +7 -3
  5. package/src/examples/exampleTransaction.json +670 -0
  6. package/src/examples/exampleVouch.json +1 -1
  7. package/src/schemas/baspi-a-material-facts.json +6 -0
  8. package/src/schemas/energy-performance-certificate.json +3 -0
  9. package/src/schemas/pdtf-transaction.json +167 -0
  10. package/src/schemas/pdtf-verified-claims.json +8 -7
  11. package/src/schemas/title-deed.json +168 -105
  12. package/src/tests/pdtfVerifiedClaims.test.js +2 -5
  13. package/src/tests/{propertyPackSchema.test.js → transactionSchema.test.js} +53 -27
  14. package/src/examples/examplePropertyPack.json +0 -376
  15. package/src/schemas/property-pack.json +0 -193
package/src/examples/examplePropertyPack.json DELETED
@@ -1,376 +0,0 @@
1
- {
2
- "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
3
- "uprn": 100000059583,
4
- "propertyPack": {
5
- "sellers": {
6
- "sellerInformation": [
7
- {
8
- "name": { "firstName": "John", "lastName": "Davies" },
9
- "dateOfBirth": "1975-12-25",
10
- "mobileNumber": "07777 222333",
11
- "email": "john@theseller.com",
12
- "address": { "address1": "10 Downend Park", "postcode": "BS7 9PU" }
13
- }
14
- ]
15
- },
16
- "materialFacts": {
17
- "address": {
18
- "address1": "10 Downend Park",
19
- "address2": "",
20
- "town": "BRISTOLS",
21
- "county": "Avon",
22
- "postcode": "BS7 9PU"
23
- },
24
- "energyEfficiency": {
25
- "energyEfficiencyRating": "A"
26
- },
27
- "delayFactors": {
28
- "hasDelayFactors": {
29
- "yesNo": "No"
30
- }
31
- },
32
- "ownership": {
33
- "ownershipType": "Freehold"
34
- },
35
- "parking": {
36
- "parkingArrangements": {
37
- "parkingArrangementsType": "Other",
38
- "otherParkingType": "Garage and double width driveway"
39
- },
40
- "electricVehicleChargingPoint": { "yesNo": "No" }
41
- },
42
- "listingAndConservation": {
43
- "isListed": {
44
- "yesNo": "No"
45
- },
46
- "isConservationArea": {
47
- "yesNo": "No"
48
- },
49
- "hasTreePreservationOrder": {
50
- "yesNo": "No"
51
- }
52
- },
53
- "flammableExternalWallSystem": {
54
- "hasFlammableExternalWallSystem": "No"
55
- },
56
- "councilTax": {
57
- "councilTaxBand": "A",
58
- "councilTaxAffectingAlterations": {
59
- "yesNo": "No"
60
- }
61
- },
62
- "disputesAndComplaints": {
63
- "hasDisputesAndComplaints": {
64
- "yesNo": "No"
65
- }
66
- },
67
- "alterationsAndChanges": {
68
- "hasStructuralAlterations": {
69
- "buildingRegApproval": {
70
- "yesNo": "Yes"
71
- },
72
- "planningPermission": {
73
- "yesNo": "Yes"
74
- },
75
- "listedBuildingConsent": {
76
- "yesNo": "Not required",
77
- "reasons": "Not listed building\n"
78
- },
79
- "deedRestrictionConsent": {
80
- "yesNo": "Not required",
81
- "reasons": "Retrospective consent obtained from leasehold provider but property now freehold"
82
- },
83
- "unfinished": {
84
- "yesNo": "No"
85
- },
86
- "yesNo": "Yes",
87
- "details": "Bedroom and ensuite shower room extension 2005"
88
- },
89
- "windowReplacementsSince2002": {
90
- "buildingRegApproval": {
91
- "yesNo": "Not required",
92
- "reasons": "Not required"
93
- },
94
- "planningPermission": {
95
- "yesNo": "Not required",
96
- "reasons": "Not required"
97
- },
98
- "listedBuildingConsent": {
99
- "yesNo": "Not required",
100
- "reasons": "Not listed building"
101
- },
102
- "deedRestrictionConsent": {
103
- "yesNo": "Not required",
104
- "reasons": "None required"
105
- },
106
- "unfinished": {
107
- "yesNo": "No"
108
- },
109
- "yesNo": "Yes",
110
- "details": "New front door added 2016"
111
- },
112
- "hasAddedConservatory": {
113
- "buildingRegApproval": {
114
- "yesNo": "Not required",
115
- "reasons": "Added as part of initial build"
116
- },
117
- "planningPermission": {
118
- "yesNo": "Not required",
119
- "reasons": "Added as part of initial build"
120
- },
121
- "listedBuildingConsent": {
122
- "yesNo": "Not required",
123
- "reasons": "Not listed building"
124
- },
125
- "deedRestrictionConsent": {
126
- "yesNo": "Not required",
127
- "reasons": "Added as part of initial build and deeds"
128
- },
129
- "unfinished": {
130
- "yesNo": "No"
131
- },
132
- "yesNo": "Yes",
133
- "details": "Conservatory added during house build in 1990 and exterior quality door separates the conservatory from the kitchen/dining room"
134
- },
135
- "planningPermissionBreaches": {
136
- "yesNo": "No"
137
- },
138
- "unresolvedPlanningIssues": {
139
- "yesNo": "No"
140
- }
141
- },
142
- "notices": {
143
- "neighbourDevelopment": {
144
- "yesNo": "No"
145
- },
146
- "planningApplication": {
147
- "yesNo": "No"
148
- },
149
- "requiredMaintenance": {
150
- "yesNo": "No"
151
- },
152
- "listedBuildingApplication": {
153
- "yesNo": "No"
154
- },
155
- "infrastructureProject": {
156
- "yesNo": "No"
157
- },
158
- "partyWallAct": {
159
- "yesNo": "No"
160
- },
161
- "otherNotices": {
162
- "yesNo": "No"
163
- }
164
- },
165
- "specialistIssues": {
166
- "dryRotEtcTreatment": {
167
- "yesNo": "No"
168
- },
169
- "containsAsbestos": {
170
- "yesNo": "No"
171
- },
172
- "japaneseKnotweed": {
173
- "yesNo": "No"
174
- },
175
- "subsidenceOrStructuralFault": {
176
- "yesNo": "No"
177
- },
178
- "ongoingHealthOrSafetyIssue": {
179
- "yesNo": "No"
180
- }
181
- },
182
- "fixturesAndFittings": {
183
- "itemsToRemove": {
184
- "yesNo": "No"
185
- },
186
- "itemsToInclude": {
187
- "yesNo": "No"
188
- }
189
- },
190
- "waterAndDrainage": {
191
- "mainsWater": {
192
- "maintenanceAgreements": {
193
- "yesNo": "No"
194
- },
195
- "yesNo": "Yes",
196
- "connected": "Yes",
197
- "supplier": "Northumbria Water"
198
- },
199
- "mainsSurfaceWaterDrainage": {
200
- "maintenanceAgreements": {
201
- "yesNo": "No"
202
- },
203
- "yesNo": "Yes",
204
- "connected": "Yes",
205
- "supplier": "Northumbria Water"
206
- },
207
- "mainsFoulDrainage": {
208
- "maintenanceAgreements": {
209
- "yesNo": "No"
210
- },
211
- "yesNo": "Yes",
212
- "connected": "Yes",
213
- "supplier": "Northumbria Water"
214
- }
215
- },
216
- "utilities": {
217
- "electricity": {
218
- "maintenanceAgreements": {
219
- "yesNo": "No"
220
- },
221
- "yesNo": "Yes",
222
- "connected": "Yes",
223
- "supplier": "Octopus Energy"
224
- },
225
- "gas": {
226
- "maintenanceAgreements": {
227
- "yesNo": "No"
228
- },
229
- "yesNo": "Yes",
230
- "connected": "Yes",
231
- "supplier": "Octopus Energy"
232
- },
233
- "lpg": {
234
- "yesNo": "No"
235
- },
236
- "oil": {
237
- "yesNo": "No"
238
- },
239
- "telephone": {
240
- "maintenanceAgreements": {
241
- "yesNo": "No"
242
- },
243
- "yesNo": "Yes",
244
- "connected": "Yes",
245
- "supplier": "EE"
246
- },
247
- "cableSatelliteTV": {
248
- "maintenanceAgreements": {
249
- "yesNo": "No"
250
- },
251
- "yesNo": "Yes",
252
- "connected": "Yes",
253
- "supplier": "Sky"
254
- },
255
- "broadband": {
256
- "maintenanceAgreements": {
257
- "yesNo": "No"
258
- },
259
- "yesNo": "Yes",
260
- "connected": "Yes",
261
- "supplier": "EE"
262
- },
263
- "solarPanels": {
264
- "yesNo": "No"
265
- },
266
- "otherServices": {
267
- "yesNo": "No"
268
- }
269
- },
270
- "greenDealLoan": {
271
- "hasGreenDealLoan": {
272
- "yesNo": "No"
273
- }
274
- },
275
- "centralHeating": {
276
- "hasCentralHeating": {
277
- "boilerInstallationCertificate": {
278
- "yesNo": "Yes",
279
- "details": "Certified installation"
280
- },
281
- "heatingInGoodWorkingOrder": {
282
- "yesNo": "Yes"
283
- },
284
- "yesNo": "Yes",
285
- "centralHeatingFuel": "Gas boiler",
286
- "centralHeatingInstalled": "2016-04-20",
287
- "heatingServiceReport": "Full service history available from Whickham Plumbing & Heating ",
288
- "heatingLastServiced": "2021-03-26"
289
- }
290
- },
291
- "insurance": {
292
- "difficultiesObtainingInsurance": {
293
- "yesNo": "No"
294
- },
295
- "insuranceClaims": {
296
- "yesNo": "No"
297
- },
298
- "isInsured": "Yes"
299
- },
300
- "boundaries": {
301
- "partOutsideLegalOwnership": {
302
- "yesNo": "No"
303
- },
304
- "partOnSeparateSiteOrDeed": {
305
- "yesNo": "No"
306
- },
307
- "boundariesDifferFromTitlePlan": {
308
- "yesNo": "No"
309
- },
310
- "boundaryAlterationProposal": {
311
- "yesNo": "No"
312
- }
313
- },
314
- "rightsAndInformalArrangements": {
315
- "sharedContributions": {
316
- "yesNo": "No"
317
- },
318
- "neighbouringLandRights": {
319
- "yesNo": "No"
320
- },
321
- "accessRestrictionAttempts": {
322
- "yesNo": "No"
323
- },
324
- "rightsOrArrangements": {
325
- "publicRightOfWay": {
326
- "yesNo": "No"
327
- },
328
- "rightsofLightOrSupport": {
329
- "yesNo": "No"
330
- },
331
- "rightsCreatedThroughCustom": {
332
- "yesNo": "No"
333
- },
334
- "minesAndMinerals": {
335
- "yesNo": "No"
336
- },
337
- "churchChancel": {
338
- "yesNo": "No"
339
- },
340
- "otherRights": {
341
- "yesNo": "No"
342
- }
343
- }
344
- },
345
- "otherIssues": {
346
- "environmental": {
347
- "yesNo": "No"
348
- },
349
- "excessiveNoise": {
350
- "yesNo": "No"
351
- },
352
- "crime": {
353
- "yesNo": "No"
354
- },
355
- "cautionOrConviction": {
356
- "yesNo": "No"
357
- },
358
- "failedTransactionsInLast12Months": {
359
- "yesNo": "No"
360
- },
361
- "comments": "Not applicable"
362
- },
363
- "additionalInformation": {
364
- "restrictionsOnUseNotCompliedWith": {
365
- "yesNo": "No"
366
- },
367
- "otherMaterialIssue": {
368
- "yesNo": "No"
369
- }
370
- },
371
- "consumerProtectionRegulationsDeclaration": {
372
- "consumerProtectionRegulationsResponse": true
373
- }
374
- }
375
- }
376
- }
package/src/schemas/property-pack.json DELETED
@@ -1,193 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
4
- "type": "object",
5
- "title": "Property Data Trust Framework Schema",
6
- "description": "A schema defining the PDTF Property Pack data structure, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",
7
- "required": ["$schema", "uprn", "propertyPack"],
8
- "properties": {
9
- "$schema": {
10
- "title": "The version reference ($id) of the PDTF Schema used",
11
- "type": "string"
12
- },
13
- "uprn": {
14
- "RDSRef": "Property/GUID/{name='UPRN',id=?}",
15
- "title": "Unique Property Reference Number ",
16
- "type": "integer"
17
- },
18
- "propertyPack": {
19
- "title": "Property Pack",
20
- "type": "object",
21
- "properties": {
22
- "sellers": {
23
- "RDSRef": "",
24
- "title": "Information about the sellers",
25
- "type": "object",
26
- "required": ["sellerInformation"],
27
- "properties": {
28
- "sellerInformation": {
29
- "title": "",
30
- "type": "array",
31
- "minItems": 1,
32
- "items": {
33
- "type": "object",
34
- "title": "Seller Details",
35
- "required": [
36
- "name",
37
- "dateOfBirth",
38
- "mobileNumber",
39
- "email",
40
- "address"
41
- ],
42
- "properties": {
43
- "name": {
44
- "title": "",
45
- "type": "object",
46
- "required": ["firstName", "lastName"],
47
- "properties": {
48
- "firstName": {
49
- "RDSRef": "",
50
- "title": "First name",
51
- "type": "string"
52
- },
53
- "middleNames": {
54
- "title": "Middle name(s)",
55
- "type": "string"
56
- },
57
- "lastName": {
58
- "title": "Last name",
59
- "type": "string"
60
- }
61
- }
62
- },
63
- "dateOfBirth": {
64
- "title": "Date of birth",
65
- "type": "string",
66
- "format": "date"
67
- },
68
- "mobileNumber": {
69
- "title": "Mobile number",
70
- "type": "string"
71
- },
72
- "email": {
73
- "title": "Email address",
74
- "type": "string",
75
- "format": "email"
76
- },
77
- "address": {
78
- "title": "Address",
79
- "$ref": "#/$defs/address"
80
- }
81
- }
82
- }
83
- }
84
- }
85
- },
86
- "materialFacts": {
87
- "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
88
- },
89
- "additionalLegalInfo": {
90
- "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json"
91
- },
92
- "titlesToBeSold": {
93
- "RDSRef": "",
94
- "title": "Title(s) as registered with HMLR which are included in the sale",
95
- "type": "array",
96
- "items": {
97
- "type": "object",
98
- "title": "Registered Title",
99
- "properties": {
100
- "titleNumber": {
101
- "RDSRef": "",
102
- "title": "Title Number",
103
- "type": "string"
104
- },
105
- "classTitleCode": {
106
- "RDSRef": "",
107
- "title": "Class of Title",
108
- "type": "string",
109
- "enum": [
110
- "AF",
111
- "QF",
112
- "PF",
113
- "AL",
114
- "GL",
115
- "QL",
116
- "PL",
117
- "SF",
118
- "CF",
119
- "SL",
120
- "CL",
121
- "AR",
122
- "PR",
123
- "QR",
124
- "CN"
125
- ]
126
- },
127
- "estateInterestCode": {
128
- "RDSRef": "",
129
- "title": "Estate Interest",
130
- "type": "string",
131
- "enum": ["EL", "FA", "FC", "MA", "PG", "RC", "RP", "RT"]
132
- },
133
- "registeredStatus": {
134
- "RDSRef": "",
135
- "title": "Registered Status",
136
- "type": "string",
137
- "enum": ["", "Pending"]
138
- },
139
- "titleExtents": {
140
- "RDSRef": "",
141
- "title": "Title Extents",
142
- "description": "One or more index polygons describing indicative location of registered title from National Polygon Dataset",
143
- "type": "array",
144
- "items": {
145
- "$ref": "https://geojson.org/schema/GeoJSON.json"
146
- }
147
- },
148
- "registerExtract": {
149
- "title": "HMLR Register Extract",
150
- "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json"
151
- }
152
- }
153
- }
154
- },
155
- "energyPerformanceCertificate": {
156
- "RDSRef": "",
157
- "title": "Energy Performance Certificate",
158
- "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
159
- }
160
- }
161
- }
162
- },
163
- "$defs": {
164
- "address": {
165
- "type": "object",
166
- "properties": {
167
- "address1": {
168
- "title": "Address 1",
169
- "type": "string",
170
- "minLength": 1
171
- },
172
- "address2": {
173
- "title": "Address 2",
174
- "type": "string"
175
- },
176
- "town": {
177
- "title": "Town",
178
- "type": "string"
179
- },
180
- "county": {
181
- "title": "County",
182
- "type": "string"
183
- },
184
- "postcode": {
185
- "title": "Postcode",
186
- "type": "string",
187
- "minLength": 1
188
- }
189
- },
190
- "required": ["address1", "postcode"]
191
- }
192
- }
193
- }