@pdtf/schemas 3.0.0-15 → 3.0.0-16

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 (10) hide show
  1. package/package.json +1 -1
  2. package/src/examples/v3/exampleTransaction.json +21 -19
  3. package/src/schemas/v3/combined.json +257 -237
  4. package/src/schemas/v3/overlays/baspi.json +163 -155
  5. package/src/schemas/v3/overlays/nts.json +86 -78
  6. package/src/schemas/v3/overlays/piq.json +63 -58
  7. package/src/schemas/v3/overlays/rds.json +91 -112
  8. package/src/schemas/v3/overlays/ta6.json +157 -149
  9. package/src/schemas/v3/pdtf-transaction.json +176 -170
  10. package/src/schemas/v3/skeleton.json +20 -18
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.0.0-15",
3
+ "version": "3.0.0-16",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
package/src/examples/v3/exampleTransaction.json CHANGED
@@ -374,25 +374,27 @@
374
374
  }
375
375
  },
376
376
  "heating": {
377
- "heatingType": "Central heating",
378
- "otherHeatingFeatures": ["Underfloor Heating"],
379
- "centralHeatingDetails": {
380
- "boilerInstallationCertificate": {
381
- "yesNo": "Yes",
382
- "details": "Certified installation",
383
- "attachments": "To follow"
384
- },
385
- "heatingInGoodWorkingOrder": {
386
- "yesNo": "Yes"
387
- },
388
- "centralHeatingFuel": {
389
- "centralHeatingFuelType": "Other",
390
- "otherCentralHeatingFuelType": "Ground-source Heat Pump"
391
- },
392
- "centralHeatingInstalled": "2016-04-20",
393
- "heatingLastServicedDate": "2021-03-26",
394
- "heatingLastServicedReport": "To follow"
395
- }
377
+ "heatingSystem": {
378
+ "heatingType": "Central heating",
379
+ "centralHeatingDetails": {
380
+ "boilerInstallationCertificate": {
381
+ "yesNo": "Yes",
382
+ "details": "Certified installation",
383
+ "attachments": "To follow"
384
+ },
385
+ "heatingInGoodWorkingOrder": {
386
+ "yesNo": "Yes"
387
+ },
388
+ "centralHeatingFuel": {
389
+ "centralHeatingFuelType": "Other",
390
+ "otherCentralHeatingFuelType": "Ground-source Heat Pump"
391
+ },
392
+ "centralHeatingInstalled": "2016-04-20",
393
+ "heatingLastServicedDate": "2021-03-26",
394
+ "heatingLastServicedReport": "To follow"
395
+ }
396
+ },
397
+ "otherHeatingFeatures": ["Underfloor Heating"]
396
398
  },
397
399
  "insurance": {
398
400
  "isInsured": "Yes",
package/src/schemas/v3/combined.json CHANGED
@@ -395,7 +395,7 @@
395
395
  },
396
396
  "marketingTenure": {
397
397
  "ntsRef": "A3",
398
- "title": "Type of tenure being marketed",
398
+ "title": "What tenure is the property being marketed as?",
399
399
  "type": "string",
400
400
  "enum": [
401
401
  "Commonhold",
@@ -19947,283 +19947,303 @@
19947
19947
  "piqRef": "A7.3",
19948
19948
  "title": "Heating",
19949
19949
  "type": "object",
19950
- "baspiRequired": ["heatingType"],
19951
- "ta6Required": ["heatingType"],
19952
- "ntsRequired": ["heatingType"],
19950
+ "baspiRequired": ["heatingSystem"],
19951
+ "ta6Required": ["heatingSystem"],
19952
+ "ntsRequired": ["heatingSystem"],
19953
19953
  "properties": {
19954
- "heatingType": {
19954
+ "heatingSystem": {
19955
19955
  "ntsRef": "B3.4.1",
19956
19956
  "baspiRef": "A7.4.0",
19957
19957
  "ta6Ref": "12.3.1",
19958
19958
  "piqRef": "A7.3.1",
19959
- "title": "What type of heating system does the property have?",
19960
- "type": "string",
19961
- "enum": ["Central heating", "Communal heating system", "None"]
19962
- },
19963
- "otherHeatingFeatures": {
19964
- "ntsRef": "B3.4.2",
19965
- "title": "What other heating features does the property have?",
19966
- "type": "array",
19967
- "items": {
19968
- "type": "string",
19969
- "enum": [
19970
- "Air Conditioning",
19971
- "Double Glazing",
19972
- "Eco-Friendly",
19973
- "Night Storage",
19974
- "Solar Water",
19975
- "Underfloor Heating",
19976
- "Wood Burner",
19977
- "Open Fire",
19978
- "Ground Source Heat Pump",
19979
- "Air Source Heat Pump",
19980
- "Solar Thermal"
19981
- ]
19982
- }
19983
- }
19984
- },
19985
- "discriminator": {
19986
- "propertyName": "heatingType"
19987
- },
19988
- "oneOf": [
19989
- {
19959
+ "type": "object",
19960
+ "title": "Heating system",
19961
+ "baspiRequired": ["heatingType"],
19962
+ "ta6Required": ["heatingType"],
19963
+ "ntsRequired": ["heatingType"],
19990
19964
  "properties": {
19991
19965
  "heatingType": {
19992
- "enum": ["None"]
19966
+ "ntsRef": "B3.4.1",
19967
+ "baspiRef": "A7.4.0",
19968
+ "ta6Ref": "12.3.1",
19969
+ "piqRef": "A7.3.1",
19970
+ "title": "What type of heating system does the property have?",
19971
+ "type": "string",
19972
+ "enum": [
19973
+ "Central heating",
19974
+ "Communal heating system",
19975
+ "None"
19976
+ ]
19993
19977
  }
19994
- }
19995
- },
19996
- {
19997
- "properties": {
19998
- "heatingType": {
19999
- "enum": ["Central heating"]
19978
+ },
19979
+ "discriminator": {
19980
+ "propertyName": "heatingType"
19981
+ },
19982
+ "oneOf": [
19983
+ {
19984
+ "properties": {
19985
+ "heatingType": {
19986
+ "enum": ["None"]
19987
+ }
19988
+ }
20000
19989
  },
20001
- "centralHeatingDetails": {
20002
- "ntsRef": "B3.4.3",
20003
- "baspiRef": "A7.4.0.0",
20004
- "ta6Ref": "12.3.2",
20005
- "piqRef": "A7.3.1.1",
20006
- "type": "object",
20007
- "title": "Central Heating Details",
20008
- "baspiRequired": [
20009
- "centralHeatingFuel",
20010
- "centralHeatingInstalled",
20011
- "boilerInstallationCertificate",
20012
- "heatingLastServicedDate",
20013
- "heatingLastServicedReport",
20014
- "heatingInGoodWorkingOrder"
20015
- ],
20016
- "ntsRequired": ["centralHeatingFuel"],
20017
- "ta6Required": [
20018
- "centralHeatingFuel",
20019
- "centralHeatingInstalled",
20020
- "boilerInstallationCertificate",
20021
- "heatingLastServicedDate",
20022
- "heatingLastServicedReport",
20023
- "heatingInGoodWorkingOrder"
20024
- ],
19990
+ {
20025
19991
  "properties": {
20026
- "centralHeatingFuel": {
20027
- "ntsRef": "B3.4.3.1",
20028
- "baspiRef": "A7.4.0.1",
20029
- "ta6Ref": "12.3.3",
20030
- "rdsRef": "Buildings|BuildingSections/Heating/isGas=no|yes|true|false",
19992
+ "heatingType": {
19993
+ "enum": ["Central heating"]
19994
+ },
19995
+ "centralHeatingDetails": {
19996
+ "ntsRef": "B3.4.3",
19997
+ "baspiRef": "A7.4.0.0",
19998
+ "ta6Ref": "12.3.2",
19999
+ "piqRef": "A7.3.1.1",
20031
20000
  "type": "object",
20032
- "title": "Central Heating Fuel",
20033
- "ntsRequired": ["centralHeatingFuelType"],
20034
- "baspiRequired": ["centralHeatingFuelType"],
20035
- "ta6Required": ["centralHeatingFuelType"],
20036
- "properties": {
20037
- "centralHeatingFuelType": {
20038
- "ntsRef": "B3.4.3.1.1",
20039
- "baspiRef": "A7.4.0.2",
20040
- "ta6Ref": "12.3a1",
20041
- "title": "What type of fuel does the system run on?",
20042
- "type": "string",
20043
- "enum": [
20044
- "Mains gas",
20045
- "Electricity",
20046
- "Oil",
20047
- "LPG",
20048
- "Biomass",
20049
- "Other"
20050
- ]
20051
- }
20052
- },
20053
- "discriminator": {
20054
- "propertyName": "centralHeatingFuelType"
20055
- },
20056
- "oneOf": [
20057
- {
20001
+ "title": "Central Heating Details",
20002
+ "baspiRequired": [
20003
+ "centralHeatingFuel",
20004
+ "centralHeatingInstalled",
20005
+ "boilerInstallationCertificate",
20006
+ "heatingLastServicedDate",
20007
+ "heatingLastServicedReport",
20008
+ "heatingInGoodWorkingOrder"
20009
+ ],
20010
+ "ntsRequired": ["centralHeatingFuel"],
20011
+ "ta6Required": [
20012
+ "centralHeatingFuel",
20013
+ "centralHeatingInstalled",
20014
+ "boilerInstallationCertificate",
20015
+ "heatingLastServicedDate",
20016
+ "heatingLastServicedReport",
20017
+ "heatingInGoodWorkingOrder"
20018
+ ],
20019
+ "properties": {
20020
+ "centralHeatingFuel": {
20021
+ "ntsRef": "B3.4.3.1",
20022
+ "baspiRef": "A7.4.0.1",
20023
+ "ta6Ref": "12.3.3",
20024
+ "rdsRef": "Buildings|BuildingSections/Heating/isGas=no|yes|true|false",
20025
+ "type": "object",
20026
+ "title": "Central Heating Fuel",
20027
+ "ntsRequired": ["centralHeatingFuelType"],
20028
+ "baspiRequired": ["centralHeatingFuelType"],
20029
+ "ta6Required": ["centralHeatingFuelType"],
20058
20030
  "properties": {
20059
20031
  "centralHeatingFuelType": {
20032
+ "ntsRef": "B3.4.3.1.1",
20033
+ "baspiRef": "A7.4.0.2",
20034
+ "ta6Ref": "12.3a1",
20035
+ "title": "What type of fuel does the system run on?",
20036
+ "type": "string",
20060
20037
  "enum": [
20061
20038
  "Mains gas",
20062
20039
  "Electricity",
20063
20040
  "Oil",
20064
20041
  "LPG",
20065
- "Biomass"
20042
+ "Biomass",
20043
+ "Other"
20066
20044
  ]
20067
20045
  }
20068
- }
20069
- },
20070
- {
20071
- "properties": {
20072
- "centralHeatingFuelType": {
20073
- "enum": ["Other"]
20046
+ },
20047
+ "discriminator": {
20048
+ "propertyName": "centralHeatingFuelType"
20049
+ },
20050
+ "oneOf": [
20051
+ {
20052
+ "properties": {
20053
+ "centralHeatingFuelType": {
20054
+ "enum": [
20055
+ "Mains gas",
20056
+ "Electricity",
20057
+ "Oil",
20058
+ "LPG",
20059
+ "Biomass"
20060
+ ]
20061
+ }
20062
+ }
20074
20063
  },
20075
- "otherCentralHeatingFuelType": {
20076
- "baspiRef": "A7.4.0.3",
20077
- "ta6Ref": "12.3a2",
20078
- "title": "Please describe the other fuel type",
20079
- "type": "string",
20080
- "minLength": 1
20064
+ {
20065
+ "properties": {
20066
+ "centralHeatingFuelType": {
20067
+ "enum": ["Other"]
20068
+ },
20069
+ "otherCentralHeatingFuelType": {
20070
+ "baspiRef": "A7.4.0.3",
20071
+ "ta6Ref": "12.3a2",
20072
+ "title": "Please describe the other fuel type",
20073
+ "type": "string",
20074
+ "minLength": 1
20075
+ }
20076
+ },
20077
+ "baspiRequired": [
20078
+ "otherCentralHeatingFuelType"
20079
+ ],
20080
+ "ta6Required": ["otherCentralHeatingFuelType"]
20081
20081
  }
20082
- },
20083
- "baspiRequired": ["otherCentralHeatingFuelType"],
20084
- "ta6Required": ["otherCentralHeatingFuelType"]
20085
- }
20086
- ]
20087
- },
20088
- "centralHeatingInstalled": {
20089
- "baspiRef": "A7.4.1",
20090
- "rdsRef": "Objects/Installed",
20091
- "ta6Ref": "12.3b1",
20092
- "piqRef": "A7.4.1",
20093
- "title": "When was the heating system installed?",
20094
- "type": "string",
20095
- "format": "date"
20096
- },
20097
- "boilerInstallationCertificate": {
20098
- "baspiRef": "A7.4.1.1",
20099
- "rdsRef": "Objects/Installation,Objects/Certificates",
20100
- "ta6Ref": "12.3b2",
20101
- "title": "Was a gas boiler installed after 1st April 2005, or a solid fuel or oil boiler installed after 1st October 2010?",
20102
- "type": "object",
20103
- "properties": {
20104
- "yesNo": {
20105
- "baspiRef": "A10.1.1",
20106
- "ta6Ref": "12.3b3",
20082
+ ]
20083
+ },
20084
+ "centralHeatingInstalled": {
20085
+ "baspiRef": "A7.4.1",
20086
+ "rdsRef": "Objects/Installed",
20087
+ "ta6Ref": "12.3b1",
20088
+ "piqRef": "A7.4.1",
20089
+ "title": "When was the heating system installed?",
20107
20090
  "type": "string",
20108
- "title": "",
20109
- "enum": ["Yes", "No"]
20110
- }
20111
- },
20112
- "baspiRequired": ["yesNo"],
20113
- "ta6Required": ["yesNo"],
20114
- "discriminator": {
20115
- "propertyName": "yesNo"
20116
- },
20117
- "oneOf": [
20118
- {
20119
- "properties": {
20120
- "yesNo": {
20121
- "enum": ["No"]
20122
- }
20123
- }
20091
+ "format": "date"
20124
20092
  },
20125
- {
20093
+ "boilerInstallationCertificate": {
20094
+ "baspiRef": "A7.4.1.1",
20095
+ "rdsRef": "Objects/Installation,Objects/Certificates",
20096
+ "ta6Ref": "12.3b2",
20097
+ "title": "Was a gas boiler installed after 1st April 2005, or a solid fuel or oil boiler installed after 1st October 2010?",
20098
+ "type": "object",
20126
20099
  "properties": {
20127
20100
  "yesNo": {
20128
- "enum": ["Yes"]
20129
- },
20130
- "attachments": {
20131
- "baspiRef": "A7.4.1.2",
20132
- "ta6Ref": "12.3b4",
20133
- "title": "Please supply a copy of the installation completion certificate from a competent person qualified under the relevant self-certification scheme e.g. HETAS etc",
20101
+ "baspiRef": "A10.1.1",
20102
+ "ta6Ref": "12.3b3",
20134
20103
  "type": "string",
20135
- "enum": ["Attached", "To follow"]
20104
+ "title": "",
20105
+ "enum": ["Yes", "No"]
20136
20106
  }
20137
20107
  },
20138
- "baspiRequired": ["attachments"],
20139
- "ta6Required": ["attachments"]
20140
- }
20141
- ]
20142
- },
20143
- "heatingLastServicedDate": {
20144
- "baspiRef": "A7.4.2.1",
20145
- "rdsRef": "Objects/Maintenance",
20146
- "ta6Ref": "12.3d1",
20147
- "piqRef": "A7.5.1",
20148
- "title": "When was the heating system last serviced or maintained?",
20149
- "type": "string",
20150
- "format": "date"
20151
- },
20152
- "heatingLastServicedReport": {
20153
- "baspiRef": "A7.4.2.2",
20154
- "ta6Ref": "12.3d2",
20155
- "title": "Please provide a copy of the service or maintenance works report.",
20156
- "type": "string",
20157
- "enum": ["Attached", "To follow", "Not available"]
20158
- },
20159
- "heatingInGoodWorkingOrder": {
20160
- "baspiRef": "A7.4.3",
20161
- "rdsRef": "Objects/Condition=?",
20162
- "ta6Ref": "12.3c",
20163
- "piqRef": "A7.6",
20164
- "title": "Is the heating system in good working order to your satisfaction?",
20165
- "type": "object",
20166
- "properties": {
20167
- "yesNo": {
20168
- "baspiRef": "A7.4.3.1",
20169
- "ta6Ref": "12.3c1",
20170
- "type": "string",
20171
- "title": "",
20172
- "enum": ["Yes", "No"]
20173
- }
20174
- },
20175
- "baspiRequired": ["yesNo"],
20176
- "ta6Required": ["yesNo"],
20177
- "discriminator": {
20178
- "propertyName": "yesNo"
20179
- },
20180
- "oneOf": [
20181
- {
20182
- "properties": {
20183
- "yesNo": {
20184
- "enum": ["Yes"]
20108
+ "baspiRequired": ["yesNo"],
20109
+ "ta6Required": ["yesNo"],
20110
+ "discriminator": {
20111
+ "propertyName": "yesNo"
20112
+ },
20113
+ "oneOf": [
20114
+ {
20115
+ "properties": {
20116
+ "yesNo": {
20117
+ "enum": ["No"]
20118
+ }
20119
+ }
20120
+ },
20121
+ {
20122
+ "properties": {
20123
+ "yesNo": {
20124
+ "enum": ["Yes"]
20125
+ },
20126
+ "attachments": {
20127
+ "baspiRef": "A7.4.1.2",
20128
+ "ta6Ref": "12.3b4",
20129
+ "title": "Please supply a copy of the installation completion certificate from a competent person qualified under the relevant self-certification scheme e.g. HETAS etc",
20130
+ "type": "string",
20131
+ "enum": ["Attached", "To follow"]
20132
+ }
20133
+ },
20134
+ "baspiRequired": ["attachments"],
20135
+ "ta6Required": ["attachments"]
20185
20136
  }
20186
- }
20137
+ ]
20187
20138
  },
20188
- {
20139
+ "heatingLastServicedDate": {
20140
+ "baspiRef": "A7.4.2.1",
20141
+ "rdsRef": "Objects/Maintenance",
20142
+ "ta6Ref": "12.3d1",
20143
+ "piqRef": "A7.5.1",
20144
+ "title": "When was the heating system last serviced or maintained?",
20145
+ "type": "string",
20146
+ "format": "date"
20147
+ },
20148
+ "heatingLastServicedReport": {
20149
+ "baspiRef": "A7.4.2.2",
20150
+ "ta6Ref": "12.3d2",
20151
+ "title": "Please provide a copy of the service or maintenance works report.",
20152
+ "type": "string",
20153
+ "enum": ["Attached", "To follow", "Not available"]
20154
+ },
20155
+ "heatingInGoodWorkingOrder": {
20156
+ "baspiRef": "A7.4.3",
20157
+ "rdsRef": "Objects/Condition=?",
20158
+ "ta6Ref": "12.3c",
20159
+ "piqRef": "A7.6",
20160
+ "title": "Is the heating system in good working order to your satisfaction?",
20161
+ "type": "object",
20189
20162
  "properties": {
20190
20163
  "yesNo": {
20191
- "enum": ["No"]
20192
- },
20193
- "details": {
20194
- "baspiRef": "A7.4.3.2",
20195
- "title": "Please provide details",
20164
+ "baspiRef": "A7.4.3.1",
20165
+ "ta6Ref": "12.3c1",
20196
20166
  "type": "string",
20197
- "minLength": 1
20167
+ "title": "",
20168
+ "enum": ["Yes", "No"]
20198
20169
  }
20199
20170
  },
20200
- "baspiRequired": ["details"]
20171
+ "baspiRequired": ["yesNo"],
20172
+ "ta6Required": ["yesNo"],
20173
+ "discriminator": {
20174
+ "propertyName": "yesNo"
20175
+ },
20176
+ "oneOf": [
20177
+ {
20178
+ "properties": {
20179
+ "yesNo": {
20180
+ "enum": ["Yes"]
20181
+ }
20182
+ }
20183
+ },
20184
+ {
20185
+ "properties": {
20186
+ "yesNo": {
20187
+ "enum": ["No"]
20188
+ },
20189
+ "details": {
20190
+ "baspiRef": "A7.4.3.2",
20191
+ "title": "Please provide details",
20192
+ "type": "string",
20193
+ "minLength": 1
20194
+ }
20195
+ },
20196
+ "baspiRequired": ["details"]
20197
+ }
20198
+ ]
20201
20199
  }
20202
- ]
20200
+ }
20203
20201
  }
20204
- }
20205
- }
20206
- },
20207
- "baspiRequired": ["centralHeatingDetails"],
20208
- "ntsRequired": ["centralHeatingDetails"],
20209
- "ta6Required": ["centralHeatingDetails"]
20210
- },
20211
- {
20212
- "properties": {
20213
- "heatingType": {
20214
- "enum": ["Community heating system"]
20202
+ },
20203
+ "baspiRequired": ["centralHeatingDetails"],
20204
+ "ntsRequired": ["centralHeatingDetails"],
20205
+ "ta6Required": ["centralHeatingDetails"]
20215
20206
  },
20216
- "details": {
20217
- "ntsRef": "B3.4.4",
20218
- "title": "Community heating system details",
20219
- "description": "Please describe how the cost of heating supply is charged, whether you have control over the energy supplier and whether you have any control over the heating.",
20220
- "type": "string",
20221
- "minLength": 1
20207
+ {
20208
+ "properties": {
20209
+ "heatingType": {
20210
+ "enum": ["Community heating system"]
20211
+ },
20212
+ "details": {
20213
+ "ntsRef": "B3.4.4",
20214
+ "title": "Community heating system details",
20215
+ "description": "Please describe how the cost of heating supply is charged, whether you have control over the energy supplier and whether you have any control over the heating.",
20216
+ "type": "string",
20217
+ "minLength": 1
20218
+ }
20219
+ },
20220
+ "ntsRequired": ["details"]
20222
20221
  }
20223
- },
20224
- "ntsRequired": ["details"]
20222
+ ]
20223
+ },
20224
+
20225
+ "otherHeatingFeatures": {
20226
+ "ntsRef": "B3.4.2",
20227
+ "title": "What other heating features does the property have?",
20228
+ "type": "array",
20229
+ "items": {
20230
+ "type": "string",
20231
+ "enum": [
20232
+ "Air Conditioning",
20233
+ "Double Glazing",
20234
+ "Eco-Friendly",
20235
+ "Night Storage",
20236
+ "Solar Water",
20237
+ "Underfloor Heating",
20238
+ "Wood Burner",
20239
+ "Open Fire",
20240
+ "Ground Source Heat Pump",
20241
+ "Air Source Heat Pump",
20242
+ "Solar Thermal"
20243
+ ]
20244
+ }
20225
20245
  }
20226
- ]
20246
+ }
20227
20247
  },
20228
20248
  "insurance": {
20229
20249
  "baspiRef": "A8",