@pdtf/schemas 3.0.0-16 → 3.0.0-17

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 (11) hide show
  1. package/package.json +1 -1
  2. package/src/examples/v3/exampleTransaction.json +11 -9
  3. package/src/schemas/v3/combined.json +212 -196
  4. package/src/schemas/v3/overlays/baspi.json +158 -150
  5. package/src/schemas/v3/overlays/nts.json +134 -126
  6. package/src/schemas/v3/overlays/piq.json +112 -107
  7. package/src/schemas/v3/overlays/rds.json +69 -64
  8. package/src/schemas/v3/overlays/ta6.json +49 -41
  9. package/src/schemas/v3/pdtf-transaction.json +161 -155
  10. package/src/schemas/v3/skeleton.json +18 -16
  11. package/src/tests/v3/transactionSchema.test.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.0.0-16",
3
+ "version": "3.0.0-17",
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
@@ -336,9 +336,17 @@
336
336
  }
337
337
  },
338
338
  "connectedUtilities": {
339
- "mainsElectricity": {
340
- "yesNo": "Yes",
341
- "supplier": "Octopus Energy"
339
+ "electricity": {
340
+ "mainsElectricity": {
341
+ "yesNo": "Yes",
342
+ "supplier": "Octopus Energy"
343
+ },
344
+ "solarPanels": {
345
+ "yesNo": "No"
346
+ },
347
+ "otherSources": {
348
+ "yesNo": "No"
349
+ }
342
350
  },
343
351
  "mainsGas": {
344
352
  "yesNo": "Yes",
@@ -363,12 +371,6 @@
363
371
  "supplier": "BT",
364
372
  "typeOfConnection": "FTTC (Fibre to the Cabinet)"
365
373
  },
366
- "solarPanels": {
367
- "yesNo": "No"
368
- },
369
- "otherServices": {
370
- "yesNo": "No"
371
- },
372
374
  "maintenanceAgreements": {
373
375
  "yesNo": "No"
374
376
  }
package/src/schemas/v3/combined.json CHANGED
@@ -18030,105 +18030,254 @@
18030
18030
  "description": "Please indicate which utilities are are connected to the property.",
18031
18031
  "type": "object",
18032
18032
  "baspiRequired": [
18033
- "mainsElectricity",
18033
+ "electricity",
18034
18034
  "mainsGas",
18035
18035
  "lpg",
18036
18036
  "oil",
18037
18037
  "telephone",
18038
18038
  "cableSatelliteTV",
18039
18039
  "broadband",
18040
- "solarPanels",
18041
- "otherServices",
18042
18040
  "maintenanceAgreements"
18043
18041
  ],
18044
- "ntsRequired": [
18045
- "mainsElectricity",
18046
- "broadband",
18047
- "solarPanels",
18048
- "otherServices"
18049
- ],
18042
+ "ntsRequired": ["electricity", "broadband"],
18050
18043
  "ta6Required": [
18051
- "mainsElectricity",
18044
+ "electricity",
18052
18045
  "mainsGas",
18053
18046
  "telephone",
18054
18047
  "cableSatelliteTV"
18055
18048
  ],
18056
18049
  "properties": {
18057
- "mainsElectricity": {
18050
+ "electricity": {
18058
18051
  "baspiRef": "A7.1.0.1",
18059
18052
  "ntsRef": "B3.1",
18060
18053
  "ta6Ref": "13.1",
18061
18054
  "rdsRef": "Services/Electricity",
18062
18055
  "piqRef": "A7.1.1",
18063
- "title": "Mains electricity",
18056
+ "title": "Electricity supply",
18064
18057
  "type": "object",
18058
+ "ntsRequired": [
18059
+ "mainsElectricity",
18060
+ "solarPanels",
18061
+ "otherSources"
18062
+ ],
18063
+ "baspiRequired": [
18064
+ "mainsElectricity",
18065
+ "solarPanels",
18066
+ "otherSources"
18067
+ ],
18068
+ "ta6Required": ["mainsElectricity"],
18065
18069
  "properties": {
18066
- "yesNo": {
18067
- "ntsRef": "B3.1.1",
18068
- "baspiRef": "A7.1.0.1.1",
18069
- "ta6Ref": "13.1.1",
18070
- "type": "string",
18071
- "title": "",
18072
- "enum": ["Yes", "To be connected", "No"],
18073
- "ntsEnum": ["Yes", "No"]
18074
- }
18075
- },
18076
- "baspiRequired": ["yesNo"],
18077
- "ntsRequired": ["yesNo"],
18078
- "ta6Required": ["yesNo"],
18079
- "discriminator": {
18080
- "propertyName": "yesNo"
18081
- },
18082
- "oneOf": [
18083
- {
18070
+ "mainsElectricity": {
18071
+ "baspiRef": "A7.1.0.1",
18072
+ "ntsRef": "B3.1",
18073
+ "ta6Ref": "13.1",
18074
+ "rdsRef": "Services/Electricity",
18075
+ "piqRef": "A7.1.1",
18076
+ "title": "Mains electricity",
18077
+ "type": "object",
18084
18078
  "properties": {
18085
18079
  "yesNo": {
18086
- "enum": ["No"]
18080
+ "ntsRef": "B3.1.1",
18081
+ "baspiRef": "A7.1.0.1.1",
18082
+ "ta6Ref": "13.1.1",
18083
+ "type": "string",
18084
+ "title": "",
18085
+ "enum": ["Yes", "To be connected", "No"],
18086
+ "ntsEnum": ["Yes", "No"]
18087
18087
  }
18088
- }
18088
+ },
18089
+ "baspiRequired": ["yesNo"],
18090
+ "ntsRequired": ["yesNo"],
18091
+ "ta6Required": ["yesNo"],
18092
+ "discriminator": {
18093
+ "propertyName": "yesNo"
18094
+ },
18095
+ "oneOf": [
18096
+ {
18097
+ "properties": {
18098
+ "yesNo": {
18099
+ "enum": ["No"]
18100
+ }
18101
+ }
18102
+ },
18103
+ {
18104
+ "properties": {
18105
+ "yesNo": {
18106
+ "enum": ["Yes"]
18107
+ },
18108
+ "supplier": {
18109
+ "baspiRef": "A7.1.0.1.2",
18110
+ "ta6Ref": "13.1.2",
18111
+ "piqRef": "A7.1.2",
18112
+ "title": "Supplier",
18113
+ "type": "string"
18114
+ },
18115
+ "mpan": {
18116
+ "title": "Meter Point Administration Number (MPAN)",
18117
+ "description": "Your MPAN is on your electricity or dual fuel bill, usually in a box marked ‘Supply Number’. It’s 21 digits long and begins with ‘S’. You’ll only need the last 12 or 13 digits.",
18118
+ "type": "integer"
18119
+ }
18120
+ },
18121
+ "ta6Required": ["supplier"]
18122
+ },
18123
+ {
18124
+ "properties": {
18125
+ "yesNo": {
18126
+ "enum": ["To be connected"]
18127
+ },
18128
+ "dateToBeConnected": {
18129
+ "baspiRef": "A7.1.0.1.3",
18130
+ "title": "Date to be connected",
18131
+ "type": "string",
18132
+ "format": "date"
18133
+ },
18134
+ "supplier": {
18135
+ "baspiRef": "A7.1.0.1.2",
18136
+ "ta6Ref": "13.1.2",
18137
+ "piqRef": "A7.1.2",
18138
+ "title": "Supplier",
18139
+ "type": "string"
18140
+ }
18141
+ },
18142
+ "baspiRequired": ["dateToBeConnected"]
18143
+ }
18144
+ ]
18089
18145
  },
18090
- {
18146
+ "solarPanels": {
18147
+ "ntsRef": "B3.7",
18148
+ "baspiRef": "A7.1.0.8",
18149
+ "piqRef": "A7.1.17",
18150
+ "title": "Solar or photovoltaic panels",
18151
+ "type": "object",
18091
18152
  "properties": {
18092
18153
  "yesNo": {
18093
- "enum": ["Yes"]
18154
+ "ntsRef": "B3.7.1",
18155
+ "baspiRef": "A7.1.0.8.1",
18156
+ "type": "string",
18157
+ "title": "",
18158
+ "enum": ["Yes", "To be connected", "No"],
18159
+ "ntsEnum": ["Yes", "No"]
18160
+ }
18161
+ },
18162
+ "baspiRequired": ["yesNo"],
18163
+ "ntsRequired": ["yesNo"],
18164
+ "discriminator": {
18165
+ "propertyName": "yesNo"
18166
+ },
18167
+ "oneOf": [
18168
+ {
18169
+ "properties": {
18170
+ "yesNo": {
18171
+ "enum": ["No"]
18172
+ }
18173
+ }
18094
18174
  },
18095
- "supplier": {
18096
- "baspiRef": "A7.1.0.1.2",
18097
- "ta6Ref": "13.1.2",
18098
- "piqRef": "A7.1.2",
18099
- "title": "Supplier",
18100
- "type": "string"
18175
+ {
18176
+ "properties": {
18177
+ "yesNo": {
18178
+ "enum": ["Yes"]
18179
+ },
18180
+ "supplier": {
18181
+ "baspiRef": "A7.1.0.8.2",
18182
+ "title": "Supplier",
18183
+ "type": "string"
18184
+ }
18185
+ }
18101
18186
  },
18102
- "mpan": {
18103
- "title": "Meter Point Administration Number (MPAN)",
18104
- "description": "Your MPAN is on your electricity or dual fuel bill, usually in a box marked ‘Supply Number’. It’s 21 digits long and begins with ‘S’. You’ll only need the last 12 or 13 digits.",
18105
- "type": "integer"
18187
+ {
18188
+ "properties": {
18189
+ "yesNo": {
18190
+ "enum": ["To be connected"]
18191
+ },
18192
+ "dateToBeConnected": {
18193
+ "baspiRef": "A7.1.0.8.3",
18194
+ "title": "Date to be connected",
18195
+ "type": "string",
18196
+ "format": "date"
18197
+ },
18198
+ "supplier": {
18199
+ "baspiRef": "A7.1.0.8.2",
18200
+ "piqRef": "A7.1.18",
18201
+ "title": "Supplier",
18202
+ "type": "string"
18203
+ }
18204
+ },
18205
+ "baspiRequired": ["dateToBeConnected"]
18106
18206
  }
18107
- },
18108
- "ta6Required": ["supplier"]
18207
+ ]
18109
18208
  },
18110
- {
18209
+ "otherSources": {
18210
+ "ntsRef": "B3.8",
18211
+ "baspiRef": "A7.1.0.9",
18212
+ "rdsRef": "Services/Other",
18213
+ "piqRef": "A7.1.19",
18214
+ "title": "Other sources",
18215
+ "description": "Other sources include wind turbines, generators and other renewable technologies, for example ground source heat pumps. If you receive Renewable Heat Incentives please provide details and note that you will need to advise Ofgem when you complete the sale",
18216
+ "type": "object",
18111
18217
  "properties": {
18112
18218
  "yesNo": {
18113
- "enum": ["To be connected"]
18114
- },
18115
- "dateToBeConnected": {
18116
- "baspiRef": "A7.1.0.1.3",
18117
- "title": "Date to be connected",
18219
+ "ntsRef": "B3.8.1",
18220
+ "baspiRef": "A7.1.0.9.1",
18118
18221
  "type": "string",
18119
- "format": "date"
18120
- },
18121
- "supplier": {
18122
- "baspiRef": "A7.1.0.1.2",
18123
- "ta6Ref": "13.1.2",
18124
- "piqRef": "A7.1.2",
18125
- "title": "Supplier",
18126
- "type": "string"
18222
+ "title": "",
18223
+ "enum": ["Yes", "To be connected", "No"],
18224
+ "ntsEnum": ["Yes", "No"]
18127
18225
  }
18128
18226
  },
18129
- "baspiRequired": ["dateToBeConnected"]
18227
+ "baspiRequired": ["yesNo"],
18228
+ "ntsRequired": ["yesNo"],
18229
+ "discriminator": {
18230
+ "propertyName": "yesNo"
18231
+ },
18232
+ "oneOf": [
18233
+ {
18234
+ "properties": {
18235
+ "yesNo": {
18236
+ "enum": ["No"]
18237
+ }
18238
+ }
18239
+ },
18240
+ {
18241
+ "properties": {
18242
+ "yesNo": {
18243
+ "enum": ["Yes"]
18244
+ },
18245
+ "details": {
18246
+ "ntsRef": "3.8.2",
18247
+ "title": "Details",
18248
+ "type": "string"
18249
+ },
18250
+ "supplier": {
18251
+ "baspiRef": "A7.1.0.9.2",
18252
+ "title": "Supplier",
18253
+ "type": "string"
18254
+ }
18255
+ },
18256
+ "ntsRequired": ["details"]
18257
+ },
18258
+ {
18259
+ "properties": {
18260
+ "yesNo": {
18261
+ "enum": ["To be connected"]
18262
+ },
18263
+ "dateToBeConnected": {
18264
+ "baspiRef": "A7.1.0.9.3",
18265
+ "title": "Date to be connected",
18266
+ "type": "string",
18267
+ "format": "date"
18268
+ },
18269
+ "supplier": {
18270
+ "baspiRef": "A7.1.0.9.2",
18271
+ "piqRef": "A7.1.20",
18272
+ "title": "Supplier",
18273
+ "type": "string"
18274
+ }
18275
+ },
18276
+ "baspiRequired": ["dateToBeConnected"]
18277
+ }
18278
+ ]
18130
18279
  }
18131
- ]
18280
+ }
18132
18281
  },
18133
18282
  "mainsGas": {
18134
18283
  "baspiRef": "A7.1.0.2",
@@ -18536,140 +18685,7 @@
18536
18685
  }
18537
18686
  ]
18538
18687
  },
18539
- "solarPanels": {
18540
- "ntsRef": "B3.7",
18541
- "baspiRef": "A7.1.0.8",
18542
- "piqRef": "A7.1.17",
18543
- "title": "Solar or photovoltaic panels",
18544
- "type": "object",
18545
- "properties": {
18546
- "yesNo": {
18547
- "ntsRef": "B3.7.1",
18548
- "baspiRef": "A7.1.0.8.1",
18549
- "type": "string",
18550
- "title": "",
18551
- "enum": ["Yes", "To be connected", "No"],
18552
- "ntsEnum": ["Yes", "No"]
18553
- }
18554
- },
18555
- "baspiRequired": ["yesNo"],
18556
- "ntsRequired": ["yesNo"],
18557
- "discriminator": {
18558
- "propertyName": "yesNo"
18559
- },
18560
- "oneOf": [
18561
- {
18562
- "properties": {
18563
- "yesNo": {
18564
- "enum": ["No"]
18565
- }
18566
- }
18567
- },
18568
- {
18569
- "properties": {
18570
- "yesNo": {
18571
- "enum": ["Yes"]
18572
- },
18573
- "supplier": {
18574
- "baspiRef": "A7.1.0.8.2",
18575
- "title": "Supplier",
18576
- "type": "string"
18577
- }
18578
- }
18579
- },
18580
- {
18581
- "properties": {
18582
- "yesNo": {
18583
- "enum": ["To be connected"]
18584
- },
18585
- "dateToBeConnected": {
18586
- "baspiRef": "A7.1.0.8.3",
18587
- "title": "Date to be connected",
18588
- "type": "string",
18589
- "format": "date"
18590
- },
18591
- "supplier": {
18592
- "baspiRef": "A7.1.0.8.2",
18593
- "piqRef": "A7.1.18",
18594
- "title": "Supplier",
18595
- "type": "string"
18596
- }
18597
- },
18598
- "baspiRequired": ["dateToBeConnected"]
18599
- }
18600
- ]
18601
- },
18602
- "otherServices": {
18603
- "ntsRef": "B3.8",
18604
- "baspiRef": "A7.1.0.9",
18605
- "rdsRef": "Services/Other",
18606
- "piqRef": "A7.1.19",
18607
- "title": "Other services",
18608
- "description": "Other services include wind turbines, generators and other renewable technologies, for example ground source heat pumps. If you receive Renewable Heat Incentives please provide details and note that you will need to advise Ofgem when you complete the sale",
18609
- "type": "object",
18610
- "properties": {
18611
- "yesNo": {
18612
- "ntsRef": "B3.8.1",
18613
- "baspiRef": "A7.1.0.9.1",
18614
- "type": "string",
18615
- "title": "",
18616
- "enum": ["Yes", "To be connected", "No"],
18617
- "ntsEnum": ["Yes", "No"]
18618
- }
18619
- },
18620
- "baspiRequired": ["yesNo"],
18621
- "ntsRequired": ["yesNo"],
18622
- "discriminator": {
18623
- "propertyName": "yesNo"
18624
- },
18625
- "oneOf": [
18626
- {
18627
- "properties": {
18628
- "yesNo": {
18629
- "enum": ["No"]
18630
- }
18631
- }
18632
- },
18633
- {
18634
- "properties": {
18635
- "yesNo": {
18636
- "enum": ["Yes"]
18637
- },
18638
- "details": {
18639
- "ntsRef": "3.8.2",
18640
- "title": "Details",
18641
- "type": "string"
18642
- },
18643
- "supplier": {
18644
- "baspiRef": "A7.1.0.9.2",
18645
- "title": "Supplier",
18646
- "type": "string"
18647
- }
18648
- },
18649
- "ntsRequired": ["details"]
18650
- },
18651
- {
18652
- "properties": {
18653
- "yesNo": {
18654
- "enum": ["To be connected"]
18655
- },
18656
- "dateToBeConnected": {
18657
- "baspiRef": "A7.1.0.9.3",
18658
- "title": "Date to be connected",
18659
- "type": "string",
18660
- "format": "date"
18661
- },
18662
- "supplier": {
18663
- "baspiRef": "A7.1.0.9.2",
18664
- "piqRef": "A7.1.20",
18665
- "title": "Supplier",
18666
- "type": "string"
18667
- }
18668
- },
18669
- "baspiRequired": ["dateToBeConnected"]
18670
- }
18671
- ]
18672
- },
18688
+
18673
18689
  "maintenanceAgreements": {
18674
18690
  "baspiRef": "A7.2",
18675
18691
  "rdsRef": "Services/Certificates,Services/OtherServices/Certificates",