@pdtf/schemas 3.2.1-8 → 3.3.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 (17) hide show
  1. package/index.js +61 -4
  2. package/package.json +1 -1
  3. package/src/examples/v3/exampleCustomOverlay.json +55 -0
  4. package/src/examples/v3/exampleCustomOverlay2.json +93 -0
  5. package/src/examples/v3/exampleTransaction.json +55 -1
  6. package/src/schemas/v3/combined.json +212 -20
  7. package/src/schemas/v3/overlays/baspi4.json +1 -0
  8. package/src/schemas/v3/overlays/baspi5.json +1 -0
  9. package/src/schemas/v3/overlays/con29R.json +25 -0
  10. package/src/schemas/v3/overlays/nts-sef.json +7 -2
  11. package/src/schemas/v3/overlays/nts.json +15 -4
  12. package/src/schemas/v3/overlays/ntsl.json +1 -2
  13. package/src/schemas/v3/overlays/piq.json +1 -0
  14. package/src/schemas/v3/overlays/rds.json +1 -0
  15. package/src/schemas/v3/pdtf-transaction.json +202 -17
  16. package/src/schemas/v3/skeleton.json +25 -1
  17. package/src/tests/v3/transactionSchema.test.js +244 -0
package/src/schemas/v3/overlays/ntsl.json CHANGED
@@ -48,8 +48,7 @@
48
48
  "buildInformation": {
49
49
  "ntslRef": "B1.1",
50
50
  "required": [
51
- "building",
52
- "roomDimensions"
51
+ "building"
53
52
  ],
54
53
  "properties": {
55
54
  "building": {
package/src/schemas/v3/overlays/piq.json CHANGED
@@ -57,6 +57,7 @@
57
57
  "enum": [
58
58
  "Personal Representative for a Deceased Owner",
59
59
  "Under Power of Attorney",
60
+ "Assistant",
60
61
  "Other"
61
62
  ]
62
63
  }
package/src/schemas/v3/overlays/rds.json CHANGED
@@ -33,6 +33,7 @@
33
33
  "enum": [
34
34
  "Personal Representative for a Deceased Owner",
35
35
  "Under Power of Attorney",
36
+ "Assistant",
36
37
  "Other"
37
38
  ]
38
39
  },
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -182,6 +182,9 @@
182
182
  },
183
183
  "externalIds": {
184
184
  "type": "object"
185
+ },
186
+ "isRemoved": {
187
+ "type": "boolean"
185
188
  }
186
189
  },
187
190
  "oneOf": [
@@ -223,6 +226,7 @@
223
226
  "Personal Representative for a Deceased Owner",
224
227
  "Under Power of Attorney",
225
228
  "Mortgagee in Possession",
229
+ "Assistant",
226
230
  "Other"
227
231
  ]
228
232
  }
@@ -257,6 +261,7 @@
257
261
  "enum": [
258
262
  "Personal Representative for a Deceased Owner",
259
263
  "Under Power of Attorney",
264
+ "Assistant",
260
265
  "Other"
261
266
  ]
262
267
  },
@@ -1090,7 +1095,9 @@
1090
1095
  "Trunk road/motorway",
1091
1096
  "Airport",
1092
1097
  "Helipad",
1093
- "Other"
1098
+ "Other",
1099
+ "Tramway",
1100
+ "Underground/Subway"
1094
1101
  ]
1095
1102
  },
1096
1103
  "latitude": {
@@ -1331,8 +1338,11 @@
1331
1338
  "properties": {
1332
1339
  "titleNumber": {
1333
1340
  "title": "Title number (if registered)",
1334
- "type": "string",
1335
- "minLength": 1
1341
+ "type": "string"
1342
+ },
1343
+ "titlePropertyDescription": {
1344
+ "title": "Title property description",
1345
+ "type": "string"
1336
1346
  },
1337
1347
  "ownershipType": {
1338
1348
  "title": "What type of ownership is the property?",
@@ -1386,7 +1396,7 @@
1386
1396
  ]
1387
1397
  },
1388
1398
  "details": {
1389
- "title": "Describe the share for sale (e.g. Ground floor flat only)",
1399
+ "title": "Describe the part for sale (e.g. Ground floor flat only)",
1390
1400
  "type": "string",
1391
1401
  "minLength": 1
1392
1402
  }
@@ -21688,7 +21698,7 @@
21688
21698
  "type": "boolean"
21689
21699
  },
21690
21700
  "sellerSignatures": {
21691
- "title": "I/we confirm that all information provided is accurate to the best of our knowledge and if we become aware of any change to/changes which alter the information supplied/provided prior to exchange of contracts for the sale of the property, I/we will update immediately notify the person marketing the property as well as my/our property lawyer.",
21701
+ "title": "I confirm that all information provided is accurate to the best of my knowledge and if I become aware of any change to/changes which alter the information supplied/provided prior to exchange of contracts for the sale of the property, I will immediately notify the person marketing the property as well as my property lawyer.",
21692
21702
  "type": "array",
21693
21703
  "items": {
21694
21704
  "type": "object",
@@ -21937,9 +21947,17 @@
21937
21947
  "type": "object",
21938
21948
  "title": "Planning application",
21939
21949
  "properties": {
21950
+ "address": {
21951
+ "type": "string",
21952
+ "title": "Location of the property to which the application relates"
21953
+ },
21940
21954
  "refNumber": {
21941
21955
  "type": "string",
21942
- "title": "Reference number for the planning application; optional for proposals"
21956
+ "title": "Reference number for the planning application"
21957
+ },
21958
+ "description": {
21959
+ "type": "string",
21960
+ "title": "Description of the application"
21943
21961
  },
21944
21962
  "isProposal": {
21945
21963
  "title": "Is this a proposal?",
@@ -21968,6 +21986,16 @@
21968
21986
  "title": "What type of application was this?",
21969
21987
  "type": "string",
21970
21988
  "minLength": 1
21989
+ },
21990
+ "status": {
21991
+ "title": "Application status",
21992
+ "type": "string",
21993
+ "minLength": 1
21994
+ },
21995
+ "url": {
21996
+ "title": "Link to application on council planning portal",
21997
+ "type": "string",
21998
+ "format": "uri"
21971
21999
  }
21972
22000
  }
21973
22001
  }
@@ -21981,7 +22009,11 @@
21981
22009
  "properties": {
21982
22010
  "refNumber": {
21983
22011
  "type": "string",
21984
- "title": "Reference number for the planning application; optional for proposals"
22012
+ "title": "Reference number for the planning application"
22013
+ },
22014
+ "description": {
22015
+ "type": "string",
22016
+ "title": "Description of the application"
21985
22017
  },
21986
22018
  "isProposal": {
21987
22019
  "title": "Is this a proposal?",
@@ -22023,7 +22055,11 @@
22023
22055
  "properties": {
22024
22056
  "refNumber": {
22025
22057
  "type": "string",
22026
- "title": "Reference number for the planning application; optional for proposals"
22058
+ "title": "Reference number for the planning application"
22059
+ },
22060
+ "description": {
22061
+ "type": "string",
22062
+ "title": "Description of the application"
22027
22063
  },
22028
22064
  "isProposal": {
22029
22065
  "title": "Is this a proposal?",
@@ -22065,7 +22101,11 @@
22065
22101
  "properties": {
22066
22102
  "refNumber": {
22067
22103
  "type": "string",
22068
- "title": "Reference number for the planning application; optional for proposals"
22104
+ "title": "Reference number for the planning application"
22105
+ },
22106
+ "description": {
22107
+ "type": "string",
22108
+ "title": "Description of the application"
22069
22109
  },
22070
22110
  "isProposal": {
22071
22111
  "title": "Is this a proposal?",
@@ -22107,7 +22147,11 @@
22107
22147
  "properties": {
22108
22148
  "refNumber": {
22109
22149
  "type": "string",
22110
- "title": "Reference number for the planning application; optional for proposals"
22150
+ "title": "Reference number for the planning application"
22151
+ },
22152
+ "description": {
22153
+ "type": "string",
22154
+ "title": "Description of the application"
22111
22155
  },
22112
22156
  "isProposal": {
22113
22157
  "title": "Is this a proposal?",
@@ -22149,7 +22193,11 @@
22149
22193
  "properties": {
22150
22194
  "refNumber": {
22151
22195
  "type": "string",
22152
- "title": "Reference number for the planning application; optional for proposals"
22196
+ "title": "Reference number for the planning application"
22197
+ },
22198
+ "description": {
22199
+ "type": "string",
22200
+ "title": "Description of the application"
22153
22201
  },
22154
22202
  "isProposal": {
22155
22203
  "title": "Is this a proposal?",
@@ -22191,7 +22239,11 @@
22191
22239
  "properties": {
22192
22240
  "refNumber": {
22193
22241
  "type": "string",
22194
- "title": "Reference number for the planning application; optional for proposals"
22242
+ "title": "Reference number for the planning application"
22243
+ },
22244
+ "description": {
22245
+ "type": "string",
22246
+ "title": "Description of the application"
22195
22247
  },
22196
22248
  "isProposal": {
22197
22249
  "title": "Is this a proposal?",
@@ -22233,7 +22285,11 @@
22233
22285
  "properties": {
22234
22286
  "refNumber": {
22235
22287
  "type": "string",
22236
- "title": "Reference number for the planning application; optional for proposals"
22288
+ "title": "Reference number for the planning application"
22289
+ },
22290
+ "description": {
22291
+ "type": "string",
22292
+ "title": "Description of the application"
22237
22293
  },
22238
22294
  "isProposal": {
22239
22295
  "title": "Is this a proposal?",
@@ -22275,7 +22331,11 @@
22275
22331
  "properties": {
22276
22332
  "refNumber": {
22277
22333
  "type": "string",
22278
- "title": "Reference number for the planning application; optional for proposals"
22334
+ "title": "Reference number for the planning application"
22335
+ },
22336
+ "description": {
22337
+ "type": "string",
22338
+ "title": "Description of the application"
22279
22339
  },
22280
22340
  "isProposal": {
22281
22341
  "title": "Is this a proposal?",
@@ -22317,7 +22377,11 @@
22317
22377
  "properties": {
22318
22378
  "refNumber": {
22319
22379
  "type": "string",
22320
- "title": "Reference number for the planning application; optional for proposals"
22380
+ "title": "Reference number for the planning application"
22381
+ },
22382
+ "description": {
22383
+ "type": "string",
22384
+ "title": "Description of the application"
22321
22385
  },
22322
22386
  "isProposal": {
22323
22387
  "title": "Is this a proposal?",
@@ -22359,7 +22423,11 @@
22359
22423
  "properties": {
22360
22424
  "refNumber": {
22361
22425
  "type": "string",
22362
- "title": "Reference number for the planning application; optional for proposals"
22426
+ "title": "Reference number for the planning application"
22427
+ },
22428
+ "description": {
22429
+ "type": "string",
22430
+ "title": "Description of the application"
22363
22431
  },
22364
22432
  "isProposal": {
22365
22433
  "title": "Is this a proposal?",
@@ -22401,7 +22469,11 @@
22401
22469
  "properties": {
22402
22470
  "refNumber": {
22403
22471
  "type": "string",
22404
- "title": "Reference number for the planning application; optional for proposals"
22472
+ "title": "Reference number for the planning application"
22473
+ },
22474
+ "description": {
22475
+ "type": "string",
22476
+ "title": "Description of the application"
22405
22477
  },
22406
22478
  "isProposal": {
22407
22479
  "title": "Is this a proposal?",
@@ -34050,6 +34122,119 @@
34050
34122
  }
34051
34123
  }
34052
34124
  }
34125
+ },
34126
+ "contracts": {
34127
+ "type": "array",
34128
+ "items": {
34129
+ "type": "object",
34130
+ "properties": {
34131
+ "contract": {
34132
+ "type": "object",
34133
+ "required": [
34134
+ "template",
34135
+ "terms"
34136
+ ],
34137
+ "properties": {
34138
+ "template": {
34139
+ "type": "object",
34140
+ "required": [
34141
+ "name",
34142
+ "url",
34143
+ "requiredSignatories"
34144
+ ],
34145
+ "properties": {
34146
+ "name": {
34147
+ "type": "string"
34148
+ },
34149
+ "url": {
34150
+ "type": "string",
34151
+ "format": "uri"
34152
+ },
34153
+ "externalIds": {
34154
+ "type": "object"
34155
+ },
34156
+ "requiredSignatories": {
34157
+ "type": "array",
34158
+ "items": {
34159
+ "type": "object",
34160
+ "properties": {
34161
+ "role": {
34162
+ "type": "string",
34163
+ "enum": [
34164
+ "Seller",
34165
+ "Seller's Conveyancer",
34166
+ "Prospective Buyer",
34167
+ "Buyer",
34168
+ "Buyer's Conveyancer",
34169
+ "Estate Agent",
34170
+ "Buyer's Agent",
34171
+ "Surveyor",
34172
+ "Mortgage Broker",
34173
+ "Lender",
34174
+ "Landlord",
34175
+ "Tenant"
34176
+ ]
34177
+ },
34178
+ "requiresAll": {
34179
+ "type": "boolean"
34180
+ }
34181
+ }
34182
+ }
34183
+ }
34184
+ }
34185
+ },
34186
+ "terms": {
34187
+ "type": "object"
34188
+ }
34189
+ }
34190
+ },
34191
+ "signatures": {
34192
+ "type": "array",
34193
+ "items": {
34194
+ "type": "object",
34195
+ "required": [
34196
+ "name",
34197
+ "signedOn",
34198
+ "role",
34199
+ "contractHash"
34200
+ ],
34201
+ "properties": {
34202
+ "name": {
34203
+ "type": "string"
34204
+ },
34205
+ "signedOn": {
34206
+ "type": "string",
34207
+ "format": "date-time"
34208
+ },
34209
+ "externalIds": {
34210
+ "type": "object"
34211
+ }
34212
+ },
34213
+ "role": {
34214
+ "type": "string",
34215
+ "enum": [
34216
+ "Seller",
34217
+ "Seller's Conveyancer",
34218
+ "Prospective Buyer",
34219
+ "Buyer",
34220
+ "Buyer's Conveyancer",
34221
+ "Estate Agent",
34222
+ "Buyer's Agent",
34223
+ "Surveyor",
34224
+ "Mortgage Broker",
34225
+ "Lender",
34226
+ "Landlord",
34227
+ "Tenant"
34228
+ ]
34229
+ },
34230
+ "contractHash": {
34231
+ "title": "An MD5 hash of the stable-stringified contract object being signed",
34232
+ "type": "string"
34233
+ }
34234
+ }
34235
+ }
34236
+ }
34237
+ }
34053
34238
  }
34054
34239
  }
34055
34240
  }
package/src/schemas/v3/skeleton.json CHANGED
@@ -30,6 +30,7 @@
30
30
  "organisationReference": {},
31
31
  "role": {},
32
32
  "externalIds": {},
33
+ "isRemoved": {},
33
34
  "sellersCapacity": {
34
35
  "capacity": {},
35
36
  "sellersCapacityDetails": {},
@@ -212,6 +213,7 @@
212
213
  "isLimitedCompanySale": {},
213
214
  "ownershipsToBeTransferred": {
214
215
  "titleNumber": {},
216
+ "titlePropertyDescription": {},
215
217
  "ownershipType": {},
216
218
  "wholeFreeholdForSale": {
217
219
  "yesNo": {},
@@ -2879,12 +2881,15 @@
2879
2881
  "planningAndBuildingRegulations": {
2880
2882
  "decisionsAndPendingApplications": {
2881
2883
  "planningPermission": {
2884
+ "address": {},
2882
2885
  "refNumber": {},
2883
2886
  "isProposal": {},
2884
2887
  "applicationDate": {},
2885
2888
  "decision": {},
2886
2889
  "decisionDate": {},
2887
- "applicationType": {}
2890
+ "applicationType": {},
2891
+ "status": {},
2892
+ "url": {}
2888
2893
  },
2889
2894
  "listedBuildingConsent": {
2890
2895
  "refNumber": {},
@@ -4090,5 +4095,24 @@
4090
4095
  "pricingMethodology": {}
4091
4096
  }
4092
4097
  }
4098
+ },
4099
+ "contracts": {
4100
+ "contract": {
4101
+ "template": {
4102
+ "name": {},
4103
+ "url": {},
4104
+ "externalIds": {},
4105
+ "requiredSignatories": {
4106
+ "role": {},
4107
+ "requiresAll": {}
4108
+ }
4109
+ },
4110
+ "terms": {}
4111
+ },
4112
+ "signatures": {
4113
+ "name": {},
4114
+ "signedOn": {},
4115
+ "externalIds": {}
4116
+ }
4093
4117
  }
4094
4118
  }