@pdtf/schemas 0.7.6 → 0.9.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.
- package/.github/workflows/pages.yml +50 -0
- package/CNAME +1 -0
- package/index.js +22 -13
- package/package.json +1 -1
- package/src/examples/exampleTransaction.json +133 -5
- package/src/schemas/{GeoJSON.json → v1/GeoJSON.json} +0 -0
- package/src/schemas/{baspiNotes.html → v1/baspiNotes.html} +0 -0
- package/src/schemas/{energy-performance-certificate.json → v1/energy-performance-certificate.json} +1 -1
- package/src/schemas/{legal-information.json → v1/legal-information.json} +93 -43
- package/src/schemas/{material-facts.json → v1/material-facts.json} +69 -152
- package/src/schemas/{pdtf-transaction-search-results.json → v1/pdtf-transaction-search-results.json} +1 -1
- package/src/schemas/{pdtf-transaction.json → v1/pdtf-transaction.json} +13 -105
- package/src/schemas/{pdtf-verified-claims.json → v1/pdtf-verified-claims.json} +1 -1
- package/src/schemas/v1/searches/drainage-and-water.json +269 -0
- package/src/schemas/v1/searches/local-land-charges.json +69 -0
- package/src/schemas/v1/searches/local-searches-required.json +861 -0
- package/src/schemas/v1/searches.json +243 -0
- package/src/schemas/{title-deed.json → v1/title-deed.json} +1 -1
- package/src/tests/pdtfVerifiedClaims.test.js +1 -1
- package/docs/assets/PDTF Orange.png +0 -0
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "https://trust.propdata.org.uk/schemas/v1/searches.json",
|
|
4
|
+
"title": "Search Enquiries",
|
|
5
|
+
"description": "The results of search enquiries",
|
|
6
|
+
"type": "array",
|
|
7
|
+
"items": {
|
|
8
|
+
"type": "object",
|
|
9
|
+
"properties": {
|
|
10
|
+
"displayName": {
|
|
11
|
+
"title": "Human-readable name of instructed search product",
|
|
12
|
+
"type": "string",
|
|
13
|
+
"minLength": 1
|
|
14
|
+
},
|
|
15
|
+
"productCode": {
|
|
16
|
+
"title": "Provider code for instructed search product",
|
|
17
|
+
"type": "string",
|
|
18
|
+
"minLength": 1
|
|
19
|
+
},
|
|
20
|
+
"providerName": {
|
|
21
|
+
"title": "Name of instructed search provider",
|
|
22
|
+
"type": "string",
|
|
23
|
+
"minLength": 1
|
|
24
|
+
},
|
|
25
|
+
"providerReference": {
|
|
26
|
+
"title": "Provider reference",
|
|
27
|
+
"type": "string",
|
|
28
|
+
"minLength": 1
|
|
29
|
+
},
|
|
30
|
+
"description": {
|
|
31
|
+
"title": "Description for instructed search product",
|
|
32
|
+
"type": "string",
|
|
33
|
+
"minLength": 1
|
|
34
|
+
},
|
|
35
|
+
"status": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"title": "Status of the search",
|
|
38
|
+
"enum": ["Ordered", "Delivered"]
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"required": ["displayName", "status"],
|
|
42
|
+
"dependencies": {
|
|
43
|
+
"status": {
|
|
44
|
+
"oneOf": [
|
|
45
|
+
{
|
|
46
|
+
"properties": {
|
|
47
|
+
"status": {
|
|
48
|
+
"enum": ["Ordered"]
|
|
49
|
+
},
|
|
50
|
+
"orderDate": {
|
|
51
|
+
"title": "Date search was ordered",
|
|
52
|
+
"type": "string",
|
|
53
|
+
"format": "date-time"
|
|
54
|
+
},
|
|
55
|
+
"expectedDeliveryDate": {
|
|
56
|
+
"title": "Date search provider indicates to expect delivery",
|
|
57
|
+
"type": "string",
|
|
58
|
+
"format": "date-time"
|
|
59
|
+
},
|
|
60
|
+
"searchContentTypes": {
|
|
61
|
+
"type": "array",
|
|
62
|
+
"items": {
|
|
63
|
+
"$ref": "#/$defs/contentTypes"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"required": ["providerName", "orderDate"]
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"properties": {
|
|
71
|
+
"status": {
|
|
72
|
+
"enum": ["Delivered"]
|
|
73
|
+
},
|
|
74
|
+
"reportDate": {
|
|
75
|
+
"title": "Report date",
|
|
76
|
+
"type": "string",
|
|
77
|
+
"format": "date-time"
|
|
78
|
+
},
|
|
79
|
+
"summary": {
|
|
80
|
+
"title": "Summary of report",
|
|
81
|
+
"type": "string",
|
|
82
|
+
"minLength": 1
|
|
83
|
+
},
|
|
84
|
+
"recommendations": {
|
|
85
|
+
"title": "Report recommendations",
|
|
86
|
+
"type": "string",
|
|
87
|
+
"minLength": 1
|
|
88
|
+
},
|
|
89
|
+
"actionAlertRating": {
|
|
90
|
+
"title": "Action alert rating (1 is Green, 5 is Red)",
|
|
91
|
+
"type": "string",
|
|
92
|
+
"enum": ["1", "2", "3", "4", "5"]
|
|
93
|
+
},
|
|
94
|
+
"complianceStatement": {
|
|
95
|
+
"title": "Statement of methodology and compliance with reporting standards",
|
|
96
|
+
"type": "string",
|
|
97
|
+
"minLength": 1
|
|
98
|
+
},
|
|
99
|
+
"results": {
|
|
100
|
+
"type": "array",
|
|
101
|
+
"items": {
|
|
102
|
+
"type": "object",
|
|
103
|
+
"properties": {
|
|
104
|
+
"contentType": {
|
|
105
|
+
"$ref": "#/$defs/contentTypes"
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"required": ["contentType"],
|
|
109
|
+
"dependencies": {
|
|
110
|
+
"contentType": {
|
|
111
|
+
"oneOf": [
|
|
112
|
+
{
|
|
113
|
+
"properties": {
|
|
114
|
+
"contentType": {
|
|
115
|
+
"enum": ["Local Land Charges"]
|
|
116
|
+
},
|
|
117
|
+
"localLandCharges": {
|
|
118
|
+
"$ref": "https://trust.propdata.org.uk/schemas/v1/searches/local-land-charges.json"
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
"required": ["localLandCharges"]
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"properties": {
|
|
125
|
+
"contentType": {
|
|
126
|
+
"enum": ["Required Local Searches"]
|
|
127
|
+
},
|
|
128
|
+
"requiredLocalSearches": {
|
|
129
|
+
"$ref": "https://trust.propdata.org.uk/schemas/v1/searches/local-searches-required.json"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"required": ["requiredLocalSearches"]
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"properties": {
|
|
136
|
+
"contentType": {
|
|
137
|
+
"enum": ["Drainage and Water Searches"]
|
|
138
|
+
},
|
|
139
|
+
"drainageAndWater": {
|
|
140
|
+
"$ref": "https://trust.propdata.org.uk/schemas/v1/searches/drainage-and-water.json"
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"required": ["con29DW"]
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"properties": {
|
|
147
|
+
"contentType": {
|
|
148
|
+
"enum": [
|
|
149
|
+
"Flood",
|
|
150
|
+
"Contaminated Land",
|
|
151
|
+
"Coal",
|
|
152
|
+
"Bath Stone",
|
|
153
|
+
"Metalliferous (Tin)",
|
|
154
|
+
"Kaolin & Ball Clay",
|
|
155
|
+
"Limestone",
|
|
156
|
+
"Brine",
|
|
157
|
+
"HS2",
|
|
158
|
+
"Crossrail",
|
|
159
|
+
"Energy Exploration",
|
|
160
|
+
"Wind Farms",
|
|
161
|
+
"Renewable Power Plants",
|
|
162
|
+
"Solar Farms",
|
|
163
|
+
"London Underground",
|
|
164
|
+
"Ground Stability",
|
|
165
|
+
"Non Coal Mining",
|
|
166
|
+
"Ground Movement",
|
|
167
|
+
"Mineral",
|
|
168
|
+
"Radon",
|
|
169
|
+
"Other"
|
|
170
|
+
]
|
|
171
|
+
},
|
|
172
|
+
"recommendedActionIndicator": {
|
|
173
|
+
"title": "Recommended action indicator",
|
|
174
|
+
"type": "string",
|
|
175
|
+
"enum": ["Yes", "No"]
|
|
176
|
+
},
|
|
177
|
+
"actionAlertRating": {
|
|
178
|
+
"title": "Action alert rating (1 is Green, 5 is Red)",
|
|
179
|
+
"type": "string",
|
|
180
|
+
"enum": ["1", "2", "3", "4", "5"]
|
|
181
|
+
},
|
|
182
|
+
"summary": {
|
|
183
|
+
"title": "Summary of report",
|
|
184
|
+
"type": "string",
|
|
185
|
+
"minLength": 1
|
|
186
|
+
},
|
|
187
|
+
"recommendations": {
|
|
188
|
+
"title": "Report recommendations",
|
|
189
|
+
"type": "string",
|
|
190
|
+
"minLength": 1
|
|
191
|
+
},
|
|
192
|
+
"complianceStatement": {
|
|
193
|
+
"title": "Statement of methodology and compliance with reporting standards",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"minLength": 1
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
]
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
]
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
},
|
|
210
|
+
"$defs": {
|
|
211
|
+
"contentTypes": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"enum": [
|
|
214
|
+
"Local Land Charges",
|
|
215
|
+
"Required Local Searches",
|
|
216
|
+
"Optional Local Searches Optional",
|
|
217
|
+
"Drainage and Water Searches",
|
|
218
|
+
"Flood",
|
|
219
|
+
"Contaminated Land",
|
|
220
|
+
"Coal",
|
|
221
|
+
"Bath Stone",
|
|
222
|
+
"Metalliferous (Tin)",
|
|
223
|
+
"Kaolin & Ball Clay",
|
|
224
|
+
"Limestone",
|
|
225
|
+
"Brine",
|
|
226
|
+
"HS2",
|
|
227
|
+
"Crossrail",
|
|
228
|
+
"Energy Exploration",
|
|
229
|
+
"Wind Farms",
|
|
230
|
+
"Planning",
|
|
231
|
+
"Utilities",
|
|
232
|
+
"Renewable Power Plants",
|
|
233
|
+
"Solar Farms",
|
|
234
|
+
"London Underground",
|
|
235
|
+
"Ground Stability",
|
|
236
|
+
"Non Coal Mining",
|
|
237
|
+
"Ground Movement",
|
|
238
|
+
"Mineral",
|
|
239
|
+
"Radon"
|
|
240
|
+
]
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"$id": "https://
|
|
3
|
+
"$id": "https://trust.propdata.org.uk/schemas/v1/title-deed.json",
|
|
4
4
|
"title": "HMLR Official Copy Register Extract",
|
|
5
5
|
"description": "A schema mirroring the V2_1 XML version of the HMLR Register Extract web service.",
|
|
6
6
|
"definitions": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Ajv = require("ajv");
|
|
2
2
|
const addFormats = require("ajv-formats");
|
|
3
3
|
|
|
4
|
-
const verifiedClaimsSchema = require("../schemas/pdtf-verified-claims.json");
|
|
4
|
+
const verifiedClaimsSchema = require("../schemas/v1/pdtf-verified-claims.json");
|
|
5
5
|
const exampleElectronicRecord = require("../examples/exampleElectronicRecord.json");
|
|
6
6
|
const exampleVouch = require("../examples/exampleVouch.json");
|
|
7
7
|
const exampleDocumentedVouch = require("../examples/exampleDocumentedVouch.json");
|
|
Binary file
|