@pdtf/schemas 0.5.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 (16) hide show
  1. package/README.md +9 -0
  2. package/babel.config.js +3 -0
  3. package/docs/assets/PDTF Orange.png +0 -0
  4. package/jest.config.js +194 -0
  5. package/package.json +39 -0
  6. package/src/index.js +54 -0
  7. package/src/schemas/GeoJSON.json +1279 -0
  8. package/src/schemas/baspi-a-material-facts.json +1609 -0
  9. package/src/schemas/baspi-b-legal-information.json +809 -0
  10. package/src/schemas/energy-performance-certificate.json +118 -0
  11. package/src/schemas/pdtf-claim.json +27 -0
  12. package/src/schemas/property-pack.json +99 -0
  13. package/src/schemas/title-deed.json +773 -0
  14. package/src/schemas/verified_claims-12.json +637 -0
  15. package/src/tests/examplePropertyPack.json +363 -0
  16. package/src/tests/propertyPackSchema.test.js +44 -0
package/src/schemas/energy-performance-certificate.json ADDED
@@ -0,0 +1,118 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$id": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate-0.1.0.json",
4
+ "type": "object",
5
+ "title": "Energy Performance Certificate and Recommendations Schema, supporting data retrieved from https://epc.opendatacommunities.org ",
6
+ "description": "Mirrors the Domestic EPC Glossary at https://epc.opendatacommunities.org/docs/guidance#glossary",
7
+ "properties": {
8
+ "certificate": {
9
+ "type": "object",
10
+ "properties": {
11
+ "address": { "type": "string" },
12
+ "address1": { "type": "string" },
13
+ "address2": { "type": "string" },
14
+ "address3": { "type": "string" },
15
+ "building-reference-number": { "type": "string" },
16
+ "built-form": { "type": "string" },
17
+ "co2-emiss-curr-per-floor-area": { "type": "number" },
18
+ "co2-emissions-current": { "type": "number" },
19
+ "co2-emissions-potential": { "type": "number" },
20
+ "constituency-label": { "type": "string" },
21
+ "constituency": { "type": "string" },
22
+ "construction-age-band": { "type": "string" },
23
+ "county": { "type": "string" },
24
+ "current-energy-efficiency": { "type": "integer" },
25
+ "current-energy-rating": { "type": "string" },
26
+ "energy-consumption-current": { "type": "integer" },
27
+ "energy-consumption-potential": { "type": "integer" },
28
+ "energy-tariff": { "type": "string" },
29
+ "environment-impact-current": { "type": "integer" },
30
+ "environment-impact-potential": { "type": "integer" },
31
+ "extension-count": { "type": "integer" },
32
+ "fixed-lighting-outlets-count": { "type": "integer" },
33
+ "flat-storey-count": { "type": "integer" },
34
+ "flat-top-storey": { "type": "string" },
35
+ "floor-description": { "type": "string" },
36
+ "floor-energy-eff": { "type": "string" },
37
+ "floor-env-eff": { "type": "string" },
38
+ "floor-height": { "type": "number" },
39
+ "floor-level": { "type": "string" },
40
+ "glazed-area": { "type": "string" },
41
+ "glazed-type": { "type": "string" },
42
+ "heat-loss-corridor": { "type": "string" },
43
+ "heating-cost-current": { "type": "integer" },
44
+ "heating-cost-potential": { "type": "integer" },
45
+ "hot-water-cost-current": { "type": "integer" },
46
+ "hot-water-cost-potential": { "type": "integer" },
47
+ "hot-water-energy-eff": { "type": "string" },
48
+ "hot-water-env-eff": { "type": "string" },
49
+ "hotwater-description": { "type": "string" },
50
+ "inspection-date": { "type": "string", "format": "date" },
51
+ "lighting-cost-current": { "type": "integer" },
52
+ "lighting-cost-potential": { "type": "integer" },
53
+ "lighting-description": { "type": "string" },
54
+ "lighting-energy-eff": { "type": "string" },
55
+ "lighting-env-eff": { "type": "string" },
56
+ "lmk-key": { "type": "string" },
57
+ "local-authority-label": { "type": "string" },
58
+ "local-authority": { "type": "string" },
59
+ "lodgement-date": { "type": "string", "format": "date" },
60
+ "lodgement-datetime": { "type": "string", "format": "date-time" },
61
+ "low-energy-fixed-light-count": { "type": "integer" },
62
+ "low-energy-lighting": { "type": "integer" },
63
+ "main-fuel": { "type": "string" },
64
+ "main-heating-controls": { "type": "string" },
65
+ "mainheat-description": { "type": "string" },
66
+ "mainheat-energy-eff": { "type": "string" },
67
+ "mainheat-env-eff": { "type": "string" },
68
+ "mainheatc-energy-eff": { "type": "string" },
69
+ "mainheatc-env-eff": { "type": "string" },
70
+ "mainheatcont-description": { "type": "string" },
71
+ "mains-gas-flag": { "type": "string" },
72
+ "mechanical-ventilation": { "type": "string" },
73
+ "multi-glaze-proportion": { "type": "integer" },
74
+ "number-habitable-rooms": { "type": "integer" },
75
+ "number-heated-rooms": { "type": "integer" },
76
+ "number-open-fireplaces": { "type": "integer" },
77
+ "photo-supply": { "type": "integer" },
78
+ "postcode": { "type": "string" },
79
+ "posttown": { "type": "string" },
80
+ "potential-energy-efficiency": { "type": "integer" },
81
+ "potential-energy-rating": { "type": "string" },
82
+ "property-type": { "type": "string" },
83
+ "roof-description": { "type": "string" },
84
+ "roof-energy-eff": { "type": "string" },
85
+ "roof-env-eff": { "type": "string" },
86
+ "secondheat-description": { "type": "string" },
87
+ "sheating-energy-eff": { "type": "string" },
88
+ "sheating-env-eff": { "type": "string" },
89
+ "solar-water-heating-flag": { "type": "string" },
90
+ "tenure": { "type": "string" },
91
+ "total-floor-area": { "type": "number" },
92
+ "transaction-type": { "type": "string" },
93
+ "unheated-corridor-length": { "type": "number" },
94
+ "uprn-source": { "type": "string" },
95
+ "uprn": { "type": "integer" },
96
+ "walls-description": { "type": "string" },
97
+ "walls-energy-eff": { "type": "string" },
98
+ "walls-env-eff": { "type": "string" },
99
+ "wind-turbine-count": { "type": "integer" },
100
+ "windows-description": { "type": "string" },
101
+ "windows-energy-eff": { "type": "string" },
102
+ "windows-env-eff": { "type": "string" }
103
+ }
104
+ },
105
+ "recommendations": {
106
+ "type": "object",
107
+ "properties": {
108
+ "lmk-key": { "type": "string" },
109
+ "improvement-item": { "type": "integer" },
110
+ "indicative-cost": { "type": "string" },
111
+ "improvement-summary-text": { "type": "string" },
112
+ "improvement-descr-text": { "type": "string" },
113
+ "improvement-id": { "type": "string" },
114
+ "improvement-id-text": { "type": "string" }
115
+ }
116
+ }
117
+ }
118
+ }
package/src/schemas/pdtf-claim.json ADDED
@@ -0,0 +1,27 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$id": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-claim-0.1.0.json",
4
+ "type": "object",
5
+ "title": "Property Data Trust Framework Claim",
6
+ "description": "PDTF verified claims are implemented in accordance with the OpenID Connect Verified Claims model, within which the actual claims object should conform to this schema to ensure the necessary metadata is attached",
7
+ "properties": {
8
+ "schema": {
9
+ "type": "string",
10
+ "format": "uri",
11
+ "description": "The $id of the JSONSchema against which the path and data have been generated, for example https://homebuyingandsellinggroup.co.uk/schemas/0.1.0/pdtf.json"
12
+ },
13
+ "path": {
14
+ "type": "string",
15
+ "description": "The JSON Pointer reference to the location in the schema corresponding to the new data as defined at https://datatracker.ietf.org/doc/html/rfc6901, for example /propertyPack/propertyToBeSold/address"
16
+ },
17
+ "data": {
18
+ "type": "string",
19
+ "description": "A JSON object representing the segment of the overall data structure which is being provided."
20
+ },
21
+ "attribution": {
22
+ "type": "string",
23
+ "description": "Details of any attribution, copyright or licencing requirements relating to the provided data"
24
+ }
25
+ },
26
+ "required": ["schema", "path", "data"]
27
+ }
package/src/schemas/property-pack.json ADDED
@@ -0,0 +1,99 @@
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 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
+ "materialFacts": {
23
+ "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
24
+ },
25
+ "additionalLegalInfo": {
26
+ "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json"
27
+ },
28
+ "titlesToBeSold": {
29
+ "RDSRef": "",
30
+ "title": "Title(s) as registered with HMLR which are included in the sale",
31
+ "type": "array",
32
+ "items": {
33
+ "type": "object",
34
+ "title": "Registered Title",
35
+ "properties": {
36
+ "titleNumber": {
37
+ "RDSRef": "",
38
+ "title": "Title Number",
39
+ "type": "string"
40
+ },
41
+ "classTitleCode": {
42
+ "RDSRef": "",
43
+ "title": "Class of Title",
44
+ "type": "string",
45
+ "enum": [
46
+ "AF",
47
+ "QF",
48
+ "PF",
49
+ "AL",
50
+ "GL",
51
+ "QL",
52
+ "PL",
53
+ "SF",
54
+ "CF",
55
+ "SL",
56
+ "CL",
57
+ "AR",
58
+ "PR",
59
+ "QR",
60
+ "CN"
61
+ ]
62
+ },
63
+ "estateInterestCode": {
64
+ "RDSRef": "",
65
+ "title": "Estate Interest",
66
+ "type": "string",
67
+ "enum": ["EL", "FA", "FC", "MA", "PG", "RC", "RP", "RT"]
68
+ },
69
+ "registeredStatus": {
70
+ "RDSRef": "",
71
+ "title": "Registered Status",
72
+ "type": "string",
73
+ "enum": ["", "Pending"]
74
+ },
75
+ "titleExtents": {
76
+ "RDSRef": "",
77
+ "title": "Title Extents",
78
+ "description": "One or more index polygons describing indicative location of registered title from National Polygon Dataset",
79
+ "type": "array",
80
+ "items": {
81
+ "$ref": "https://geojson.org/schema/GeoJSON.json"
82
+ }
83
+ },
84
+ "registerExtract": {
85
+ "title": "HMLR Register Extract",
86
+ "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json"
87
+ }
88
+ }
89
+ }
90
+ },
91
+ "energyPerformanceCertificate": {
92
+ "RDSRef": "",
93
+ "title": "Energy Performance Certificate",
94
+ "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
95
+ }
96
+ }
97
+ }
98
+ }
99
+ }