@pdtf/schemas 3.6.0-31 → 3.6.0-32

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 (36) hide show
  1. package/docs/sef25-extensions-ui-spec.md +274 -5
  2. package/index.js +9 -0
  3. package/package.json +1 -1
  4. package/src/schemas/v3/combined.json +335 -40
  5. package/src/schemas/v3/compactSkeleton.txt +22 -0
  6. package/src/schemas/v3/overlays/extensions/as.json +4 -2
  7. package/src/schemas/v3/overlays/extensions/dk.json +32 -0
  8. package/src/schemas/v3/overlays/extensions/dr.json +4 -2
  9. package/src/schemas/v3/overlays/extensions/er.json +4 -2
  10. package/src/schemas/v3/overlays/extensions/fd.json +6 -3
  11. package/src/schemas/v3/overlays/extensions/hi.json +6 -3
  12. package/src/schemas/v3/overlays/extensions/hs.json +4 -2
  13. package/src/schemas/v3/overlays/extensions/ic.json +56 -0
  14. package/src/schemas/v3/overlays/extensions/jk.json +4 -2
  15. package/src/schemas/v3/overlays/extensions/la.json +4 -2
  16. package/src/schemas/v3/overlays/extensions/lc.json +86 -0
  17. package/src/schemas/v3/overlays/extensions/ma.json +6 -3
  18. package/src/schemas/v3/overlays/extensions/mc.json +4 -2
  19. package/src/schemas/v3/overlays/extensions/mi.json +52 -0
  20. package/src/schemas/v3/overlays/extensions/nd.json +43 -0
  21. package/src/schemas/v3/overlays/extensions/oa.json +4 -2
  22. package/src/schemas/v3/overlays/extensions/oc.json +4 -2
  23. package/src/schemas/v3/overlays/extensions/pc.json +2 -1
  24. package/src/schemas/v3/overlays/extensions/rw.json +68 -0
  25. package/src/schemas/v3/overlays/extensions/sb.json +4 -2
  26. package/src/schemas/v3/overlays/extensions/sc.json +82 -14
  27. package/src/schemas/v3/overlays/extensions/sd.json +63 -0
  28. package/src/schemas/v3/overlays/extensions/sf.json +4 -2
  29. package/src/schemas/v3/overlays/extensions/sl.json +4 -2
  30. package/src/schemas/v3/overlays/extensions/tf.json +6 -3
  31. package/src/schemas/v3/overlays/extensions/tr.json +73 -0
  32. package/src/schemas/v3/overlays/extensions/wg.json +209 -0
  33. package/src/schemas/v3/pdtf-transaction.json +412 -30
  34. package/src/schemas/v3/skeleton.json +30 -2
  35. package/src/tests/v3/extensionOverlays.test.js +410 -4
  36. package/src/utils/extractExtensionOverlays.js +121 -0
package/src/schemas/v3/compactSkeleton.txt CHANGED
@@ -131,6 +131,11 @@
131
131
  yearOfBuild
132
132
  isNewBuild
133
133
  yesNo
134
+ newBuildDetails
135
+ snaggingCompletion
136
+ adoptionStatus
137
+ conversionConsent
138
+ conversionQuality
134
139
  isHMO
135
140
  isStudentAccommodation
136
141
  roomDimensions
@@ -225,6 +230,9 @@
225
230
  yesNo
226
231
  details
227
232
  amount
233
+ titleRestrictions
234
+ yesNo
235
+ details
228
236
  wholeFreeholdForSale
229
237
  yesNo
230
238
  details
@@ -955,6 +963,8 @@
955
963
  vehicleTypeRestriction
956
964
  yesNo
957
965
  details
966
+ droppedKerbAccess
967
+ yesNo
958
968
  electricVehicleChargingPoint
959
969
  yesNo
960
970
  chargerDetails
@@ -1875,6 +1885,10 @@
1875
1885
  yesNo
1876
1886
  details
1877
1887
  attachments
1888
+ associatedCost
1889
+ hasCost
1890
+ amount
1891
+ frequency
1878
1892
  panelProviderLease
1879
1893
  yesNo
1880
1894
  details
@@ -1924,6 +1938,7 @@
1924
1938
  yesNo
1925
1939
  details
1926
1940
  associatedCost
1941
+ hasCost
1927
1942
  amount
1928
1943
  frequency
1929
1944
  supplier
@@ -1983,6 +1998,7 @@
1983
1998
  attachments
1984
1999
  details
1985
2000
  associatedCost
2001
+ hasCost
1986
2002
  amount
1987
2003
  frequency
1988
2004
  surfaceDrainageCharge
@@ -2151,6 +2167,9 @@
2151
2167
  yesNo
2152
2168
  details
2153
2169
  attachments
2170
+ privateRightOfWay
2171
+ yesNo
2172
+ details
2154
2173
  rightsOfLight
2155
2174
  yesNo
2156
2175
  details
@@ -2209,6 +2228,9 @@
2209
2228
  floodDefences
2210
2229
  hasFloodDefences
2211
2230
  details
2231
+ stormFireFloodDamage
2232
+ yesNo
2233
+ details
2212
2234
  radon
2213
2235
  radonRisk
2214
2236
  riskIndicator
package/src/schemas/v3/overlays/extensions/as.json CHANGED
@@ -58,12 +58,14 @@
58
58
  },
59
59
  "required": [
60
60
  "containsAsbestos"
61
- ]
61
+ ],
62
+ "ntsRef": "A5"
62
63
  }
63
64
  },
64
65
  "required": [
65
66
  "specialistIssues"
66
- ]
67
+ ],
68
+ "ntsRef": "0"
67
69
  }
68
70
  },
69
71
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/dk.json ADDED
@@ -0,0 +1,32 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "parking": {
6
+ "properties": {
7
+ "droppedKerbAccess": {
8
+ "ntsRef": "K1.1",
9
+ "required": [
10
+ "yesNo"
11
+ ],
12
+ "properties": {
13
+ "yesNo": {
14
+ "ntsRef": "K1.1.1",
15
+ "type": "string"
16
+ }
17
+ },
18
+ "type": "object"
19
+ }
20
+ },
21
+ "required": [
22
+ "droppedKerbAccess"
23
+ ],
24
+ "ntsRef": "K1"
25
+ }
26
+ }
27
+ }
28
+ },
29
+ "$schema": "http://json-schema.org/draft-07/schema#",
30
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/dk.json",
31
+ "$comment": "Dropped kerb access to parking"
32
+ }
package/src/schemas/v3/overlays/extensions/dr.json CHANGED
@@ -57,12 +57,14 @@
57
57
  },
58
58
  "required": [
59
59
  "dryRotEtcTreatment"
60
- ]
60
+ ],
61
+ "ntsRef": "A5"
61
62
  }
62
63
  },
63
64
  "required": [
64
65
  "specialistIssues"
65
- ]
66
+ ],
67
+ "ntsRef": "0"
66
68
  }
67
69
  },
68
70
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/er.json CHANGED
@@ -69,12 +69,14 @@
69
69
  },
70
70
  "required": [
71
71
  "ownershipsToBeTransferred"
72
- ]
72
+ ],
73
+ "ntsRef": "A3"
73
74
  }
74
75
  },
75
76
  "required": [
76
77
  "ownership"
77
- ]
78
+ ],
79
+ "ntsRef": "0"
78
80
  }
79
81
  },
80
82
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/fd.json CHANGED
@@ -53,17 +53,20 @@
53
53
  },
54
54
  "required": [
55
55
  "floodDefences"
56
- ]
56
+ ],
57
+ "ntsRef": "C3.1.1"
57
58
  }
58
59
  },
59
60
  "required": [
60
61
  "flooding"
61
- ]
62
+ ],
63
+ "ntsRef": "C3.1"
62
64
  }
63
65
  },
64
66
  "required": [
65
67
  "environmentalIssues"
66
- ]
68
+ ],
69
+ "ntsRef": "0"
67
70
  }
68
71
  },
69
72
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/hi.json CHANGED
@@ -22,7 +22,8 @@
22
22
  },
23
23
  "required": [
24
24
  "centralHeatingInstalled"
25
- ]
25
+ ],
26
+ "ntsRef": "B3.4.3"
26
27
  }
27
28
  },
28
29
  "required": [
@@ -34,12 +35,14 @@
34
35
  },
35
36
  "required": [
36
37
  "heatingSystem"
37
- ]
38
+ ],
39
+ "ntsRef": "B3.4"
38
40
  }
39
41
  },
40
42
  "required": [
41
43
  "heating"
42
- ]
44
+ ],
45
+ "ntsRef": "0"
43
46
  }
44
47
  },
45
48
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/hs.json CHANGED
@@ -57,12 +57,14 @@
57
57
  },
58
58
  "required": [
59
59
  "ongoingHealthOrSafetyIssue"
60
- ]
60
+ ],
61
+ "ntsRef": "A5"
61
62
  }
62
63
  },
63
64
  "required": [
64
65
  "specialistIssues"
65
- ]
66
+ ],
67
+ "ntsRef": "0"
66
68
  }
67
69
  },
68
70
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/ic.json ADDED
@@ -0,0 +1,56 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "insurance": {
6
+ "oneOf": [
7
+ null,
8
+ {
9
+ "properties": {
10
+ "insuranceClaims": {
11
+ "ntsRef": "I1.1",
12
+ "discriminator": {
13
+ "propertyName": "yesNo"
14
+ },
15
+ "properties": {
16
+ "yesNo": {
17
+ "ntsRef": "I1.1.1",
18
+ "type": "string"
19
+ }
20
+ },
21
+ "oneOf": [
22
+ {
23
+ "properties": {
24
+ "yesNo": {
25
+ "enum": [
26
+ "No"
27
+ ]
28
+ }
29
+ }
30
+ },
31
+ {
32
+ "properties": {
33
+ "yesNo": {
34
+ "enum": [
35
+ "Yes"
36
+ ]
37
+ }
38
+ }
39
+ }
40
+ ],
41
+ "type": "object"
42
+ }
43
+ },
44
+ "required": [
45
+ "insuranceClaims"
46
+ ]
47
+ }
48
+ ]
49
+ }
50
+ }
51
+ }
52
+ },
53
+ "$schema": "http://json-schema.org/draft-07/schema#",
54
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/ic.json",
55
+ "$comment": "Insurance claims upfront for SEF25"
56
+ }
package/src/schemas/v3/overlays/extensions/jk.json CHANGED
@@ -80,12 +80,14 @@
80
80
  },
81
81
  "required": [
82
82
  "japaneseKnotweed"
83
- ]
83
+ ],
84
+ "ntsRef": "A5"
84
85
  }
85
86
  },
86
87
  "required": [
87
88
  "specialistIssues"
88
- ]
89
+ ],
90
+ "ntsRef": "0"
89
91
  }
90
92
  },
91
93
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/la.json CHANGED
@@ -69,12 +69,14 @@
69
69
  },
70
70
  "required": [
71
71
  "loft"
72
- ]
72
+ ],
73
+ "ntsRef": "A1.2"
73
74
  }
74
75
  },
75
76
  "required": [
76
77
  "typeOfConstruction"
77
- ]
78
+ ],
79
+ "ntsRef": "0"
78
80
  }
79
81
  },
80
82
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/lc.json ADDED
@@ -0,0 +1,86 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "electricity": {
6
+ "properties": {
7
+ "solarPanels": {
8
+ "oneOf": [
9
+ null,
10
+ {
11
+ "properties": {
12
+ "panelsOwnedOutright": {
13
+ "oneOf": [
14
+ null,
15
+ {
16
+ "properties": {
17
+ "associatedCost": {
18
+ "ntsRef": "S1.1",
19
+ "required": [
20
+ "hasCost"
21
+ ],
22
+ "discriminator": {
23
+ "propertyName": "hasCost"
24
+ },
25
+ "properties": {
26
+ "hasCost": {
27
+ "ntsRef": "S1.1.1",
28
+ "type": "string"
29
+ }
30
+ },
31
+ "oneOf": [
32
+ {
33
+ "properties": {
34
+ "hasCost": {
35
+ "enum": [
36
+ "No"
37
+ ]
38
+ }
39
+ }
40
+ },
41
+ {
42
+ "required": [
43
+ "amount",
44
+ "frequency"
45
+ ],
46
+ "properties": {
47
+ "amount": {
48
+ "ntsRef": "S1.1.2",
49
+ "type": "number"
50
+ },
51
+ "frequency": {
52
+ "ntsRef": "S1.1.3",
53
+ "type": "string",
54
+ "enum": [
55
+ "Per month",
56
+ "Per year"
57
+ ]
58
+ },
59
+ "hasCost": {
60
+ "enum": [
61
+ "Yes"
62
+ ]
63
+ }
64
+ }
65
+ }
66
+ ],
67
+ "type": "object"
68
+ }
69
+ }
70
+ }
71
+ ]
72
+ }
73
+ }
74
+ }
75
+ ]
76
+ }
77
+ },
78
+ "ntsRef": "S1"
79
+ }
80
+ }
81
+ }
82
+ },
83
+ "$schema": "http://json-schema.org/draft-07/schema#",
84
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/lc.json",
85
+ "$comment": "Solar panel lease costs"
86
+ }
package/src/schemas/v3/overlays/extensions/ma.json CHANGED
@@ -60,7 +60,8 @@
60
60
  },
61
61
  "required": [
62
62
  "contactDetails"
63
- ]
63
+ ],
64
+ "ntsRef": "A3.2"
64
65
  }
65
66
  },
66
67
  "required": [
@@ -73,12 +74,14 @@
73
74
  },
74
75
  "required": [
75
76
  "ownershipsToBeTransferred"
76
- ]
77
+ ],
78
+ "ntsRef": "A3"
77
79
  }
78
80
  },
79
81
  "required": [
80
82
  "ownership"
81
- ]
83
+ ],
84
+ "ntsRef": "0"
82
85
  }
83
86
  },
84
87
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/mc.json CHANGED
@@ -22,12 +22,14 @@
22
22
  },
23
23
  "required": [
24
24
  "isStandardForm"
25
- ]
25
+ ],
26
+ "ntsRef": "A1.2"
26
27
  }
27
28
  },
28
29
  "required": [
29
30
  "typeOfConstruction"
30
- ]
31
+ ],
32
+ "ntsRef": "0"
31
33
  }
32
34
  },
33
35
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/mi.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "additionalInformation": {
6
+ "properties": {
7
+ "otherMaterialIssue": {
8
+ "ntsRef": "M1.1",
9
+ "discriminator": {
10
+ "propertyName": "yesNo"
11
+ },
12
+ "properties": {
13
+ "yesNo": {
14
+ "ntsRef": "M1.1.1",
15
+ "type": "string"
16
+ }
17
+ },
18
+ "oneOf": [
19
+ {
20
+ "properties": {
21
+ "yesNo": {
22
+ "enum": [
23
+ "No"
24
+ ]
25
+ }
26
+ }
27
+ },
28
+ {
29
+ "properties": {
30
+ "yesNo": {
31
+ "enum": [
32
+ "Yes"
33
+ ]
34
+ }
35
+ }
36
+ }
37
+ ],
38
+ "type": "object"
39
+ }
40
+ },
41
+ "required": [
42
+ "otherMaterialIssue"
43
+ ],
44
+ "ntsRef": "M1"
45
+ }
46
+ }
47
+ }
48
+ },
49
+ "$schema": "http://json-schema.org/draft-07/schema#",
50
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/mi.json",
51
+ "$comment": "Other material issue upfront for SEF25"
52
+ }
package/src/schemas/v3/overlays/extensions/nd.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "notices": {
6
+ "properties": {
7
+ "neighbourDevelopment": {
8
+ "ntsRef": "N1.1",
9
+ "discriminator": {
10
+ "propertyName": "yesNo"
11
+ },
12
+ "oneOf": [
13
+ {
14
+ "properties": {
15
+ "yesNo": {
16
+ "enum": [
17
+ "No"
18
+ ]
19
+ }
20
+ }
21
+ },
22
+ {
23
+ "properties": {
24
+ "yesNo": {
25
+ "enum": [
26
+ "Yes"
27
+ ]
28
+ }
29
+ }
30
+ }
31
+ ],
32
+ "type": "object"
33
+ }
34
+ },
35
+ "ntsRef": "N1"
36
+ }
37
+ }
38
+ }
39
+ },
40
+ "$schema": "http://json-schema.org/draft-07/schema#",
41
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/nd.json",
42
+ "$comment": "Neighbour development upfront for SEF25"
43
+ }
package/src/schemas/v3/overlays/extensions/oa.json CHANGED
@@ -11,9 +11,11 @@
11
11
  },
12
12
  "required": [
13
13
  "outsideAreas"
14
- ]
14
+ ],
15
+ "ntsRef": "B5"
15
16
  }
16
- }
17
+ },
18
+ "ntsRef": "0"
17
19
  }
18
20
  },
19
21
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/oc.json CHANGED
@@ -44,9 +44,11 @@
44
44
  },
45
45
  "required": [
46
46
  "otherPropertyInChain"
47
- ]
47
+ ],
48
+ "ntsRef": "A1.5.7"
48
49
  }
49
- }
50
+ },
51
+ "ntsRef": "0"
50
52
  }
51
53
  },
52
54
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/pc.json CHANGED
@@ -25,7 +25,8 @@
25
25
  }
26
26
  ]
27
27
  }
28
- }
28
+ },
29
+ "ntsRef": "K1"
29
30
  }
30
31
  }
31
32
  }
package/src/schemas/v3/overlays/extensions/rw.json ADDED
@@ -0,0 +1,68 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "rightsAndInformalArrangements": {
6
+ "properties": {
7
+ "rightsOrArrangements": {
8
+ "properties": {
9
+ "privateRightOfWay": {
10
+ "ntsRef": "R1.1",
11
+ "required": [
12
+ "yesNo"
13
+ ],
14
+ "discriminator": {
15
+ "propertyName": "yesNo"
16
+ },
17
+ "properties": {
18
+ "yesNo": {
19
+ "ntsRef": "R1.1.1",
20
+ "type": "string"
21
+ }
22
+ },
23
+ "oneOf": [
24
+ {
25
+ "properties": {
26
+ "yesNo": {
27
+ "enum": [
28
+ "No"
29
+ ]
30
+ }
31
+ }
32
+ },
33
+ {
34
+ "required": [
35
+ "details"
36
+ ],
37
+ "properties": {
38
+ "details": {
39
+ "ntsRef": "R1.1.2",
40
+ "type": "string",
41
+ "minLength": 1
42
+ },
43
+ "yesNo": {
44
+ "enum": [
45
+ "Yes"
46
+ ]
47
+ }
48
+ }
49
+ }
50
+ ],
51
+ "type": "object"
52
+ }
53
+ },
54
+ "required": [
55
+ "privateRightOfWay"
56
+ ],
57
+ "ntsRef": "R1"
58
+ }
59
+ },
60
+ "ntsRef": "R1"
61
+ }
62
+ }
63
+ }
64
+ },
65
+ "$schema": "http://json-schema.org/draft-07/schema#",
66
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/rw.json",
67
+ "$comment": "Private right of way"
68
+ }
package/src/schemas/v3/overlays/extensions/sb.json CHANGED
@@ -57,12 +57,14 @@
57
57
  },
58
58
  "required": [
59
59
  "subsidenceOrStructuralFault"
60
- ]
60
+ ],
61
+ "ntsRef": "A5"
61
62
  }
62
63
  },
63
64
  "required": [
64
65
  "specialistIssues"
65
- ]
66
+ ],
67
+ "ntsRef": "0"
66
68
  }
67
69
  },
68
70
  "$schema": "http://json-schema.org/draft-07/schema#",