@pdtf/schemas 3.6.0-36 → 3.6.0-37

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 (38) hide show
  1. package/README.md +52 -33
  2. package/docs/sef25-extensions-ui-spec.md +258 -49
  3. package/index.js +9 -0
  4. package/package.json +1 -1
  5. package/src/schemas/v3/combined.json +199 -12
  6. package/src/schemas/v3/compactSkeleton.txt +14 -0
  7. package/src/schemas/v3/overlays/extensions/as.json +4 -2
  8. package/src/schemas/v3/overlays/extensions/dk.json +32 -0
  9. package/src/schemas/v3/overlays/extensions/dr.json +4 -2
  10. package/src/schemas/v3/overlays/extensions/er.json +4 -2
  11. package/src/schemas/v3/overlays/extensions/fd.json +6 -3
  12. package/src/schemas/v3/overlays/extensions/hi.json +6 -3
  13. package/src/schemas/v3/overlays/extensions/hs.json +4 -2
  14. package/src/schemas/v3/overlays/extensions/ic.json +59 -0
  15. package/src/schemas/v3/overlays/extensions/jk.json +4 -2
  16. package/src/schemas/v3/overlays/extensions/la.json +4 -2
  17. package/src/schemas/v3/overlays/extensions/lc.json +52 -0
  18. package/src/schemas/v3/overlays/extensions/ma.json +6 -3
  19. package/src/schemas/v3/overlays/extensions/mc.json +4 -2
  20. package/src/schemas/v3/overlays/extensions/mi.json +55 -0
  21. package/src/schemas/v3/overlays/extensions/nd.json +43 -0
  22. package/src/schemas/v3/overlays/extensions/oa.json +4 -2
  23. package/src/schemas/v3/overlays/extensions/oc.json +4 -2
  24. package/src/schemas/v3/overlays/extensions/pc.json +2 -1
  25. package/src/schemas/v3/overlays/extensions/ph.json +11 -14
  26. package/src/schemas/v3/overlays/extensions/rw.json +68 -0
  27. package/src/schemas/v3/overlays/extensions/sb.json +4 -2
  28. package/src/schemas/v3/overlays/extensions/sd.json +63 -0
  29. package/src/schemas/v3/overlays/extensions/sf.json +4 -2
  30. package/src/schemas/v3/overlays/extensions/sl.json +4 -2
  31. package/src/schemas/v3/overlays/extensions/tf.json +6 -3
  32. package/src/schemas/v3/overlays/extensions/tr.json +73 -0
  33. package/src/schemas/v3/overlays/extensions/wg.json +250 -0
  34. package/src/schemas/v3/overlays/sef25.json +639 -0
  35. package/src/schemas/v3/pdtf-transaction.json +150 -0
  36. package/src/schemas/v3/skeleton.json +20 -1
  37. package/src/tests/v3/extensionOverlays.test.js +397 -0
  38. package/src/utils/extractExtensionOverlays.js +116 -4
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,59 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "insurance": {
6
+ "oneOf": [
7
+ null,
8
+ {
9
+ "properties": {
10
+ "insuranceClaims": {
11
+ "ntsRef": "I1.1",
12
+ "required": [
13
+ "yesNo"
14
+ ],
15
+ "discriminator": {
16
+ "propertyName": "yesNo"
17
+ },
18
+ "properties": {
19
+ "yesNo": {
20
+ "ntsRef": "I1.1.1",
21
+ "type": "string"
22
+ }
23
+ },
24
+ "oneOf": [
25
+ {
26
+ "properties": {
27
+ "yesNo": {
28
+ "enum": [
29
+ "No"
30
+ ]
31
+ }
32
+ }
33
+ },
34
+ {
35
+ "properties": {
36
+ "yesNo": {
37
+ "enum": [
38
+ "Yes"
39
+ ]
40
+ }
41
+ }
42
+ }
43
+ ],
44
+ "type": "object"
45
+ }
46
+ },
47
+ "required": [
48
+ "insuranceClaims"
49
+ ]
50
+ }
51
+ ]
52
+ }
53
+ }
54
+ }
55
+ },
56
+ "$schema": "http://json-schema.org/draft-07/schema#",
57
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/ic.json",
58
+ "$comment": "Insurance claims upfront for SEF25"
59
+ }
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,52 @@
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
+ "amount",
21
+ "frequency"
22
+ ],
23
+ "properties": {
24
+ "amount": {
25
+ "ntsRef": "S1.1.1",
26
+ "type": "number"
27
+ },
28
+ "frequency": {
29
+ "ntsRef": "S1.1.2",
30
+ "type": "string"
31
+ }
32
+ },
33
+ "type": "object"
34
+ }
35
+ }
36
+ }
37
+ ]
38
+ }
39
+ }
40
+ }
41
+ ]
42
+ }
43
+ },
44
+ "ntsRef": "S1"
45
+ }
46
+ }
47
+ }
48
+ },
49
+ "$schema": "http://json-schema.org/draft-07/schema#",
50
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/lc.json",
51
+ "$comment": "Solar panel lease costs"
52
+ }
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,55 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "additionalInformation": {
6
+ "properties": {
7
+ "otherMaterialIssue": {
8
+ "ntsRef": "M1.1",
9
+ "required": [
10
+ "yesNo"
11
+ ],
12
+ "discriminator": {
13
+ "propertyName": "yesNo"
14
+ },
15
+ "properties": {
16
+ "yesNo": {
17
+ "ntsRef": "M1.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
+ "otherMaterialIssue"
46
+ ],
47
+ "ntsRef": "M1"
48
+ }
49
+ }
50
+ }
51
+ },
52
+ "$schema": "http://json-schema.org/draft-07/schema#",
53
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/mi.json",
54
+ "$comment": "Other material issue upfront for SEF25"
55
+ }
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/ph.json CHANGED
@@ -3,6 +3,12 @@
3
3
  "propertyPack": {
4
4
  "properties": {
5
5
  "specialistIssues": {
6
+ "required": [
7
+ "wellsDitchesShaft",
8
+ "damagedOrExposedElectrics",
9
+ "damageToFlooringOrStaircases",
10
+ "knownAreasInPoorCondition"
11
+ ],
6
12
  "properties": {
7
13
  "wellsDitchesShaft": {
8
14
  "ntsRef": "H1.1",
@@ -45,8 +51,7 @@
45
51
  }
46
52
  }
47
53
  }
48
- ],
49
- "type": "object"
54
+ ]
50
55
  },
51
56
  "damagedOrExposedElectrics": {
52
57
  "ntsRef": "H1.2",
@@ -89,8 +94,7 @@
89
94
  }
90
95
  }
91
96
  }
92
- ],
93
- "type": "object"
97
+ ]
94
98
  },
95
99
  "damageToFlooringOrStaircases": {
96
100
  "ntsRef": "H1.3",
@@ -133,8 +137,7 @@
133
137
  }
134
138
  }
135
139
  }
136
- ],
137
- "type": "object"
140
+ ]
138
141
  },
139
142
  "knownAreasInPoorCondition": {
140
143
  "ntsRef": "H1.4",
@@ -177,16 +180,10 @@
177
180
  }
178
181
  }
179
182
  }
180
- ],
181
- "type": "object"
183
+ ]
182
184
  }
183
185
  },
184
- "required": [
185
- "wellsDitchesShaft",
186
- "damagedOrExposedElectrics",
187
- "damageToFlooringOrStaircases",
188
- "knownAreasInPoorCondition"
189
- ]
186
+ "type": "object"
190
187
  }
191
188
  }
192
189
  }
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#",
package/src/schemas/v3/overlays/extensions/sd.json ADDED
@@ -0,0 +1,63 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "environmentalIssues": {
6
+ "properties": {
7
+ "stormFireFloodDamage": {
8
+ "ntsRef": "E1.1",
9
+ "required": [
10
+ "yesNo"
11
+ ],
12
+ "discriminator": {
13
+ "propertyName": "yesNo"
14
+ },
15
+ "properties": {
16
+ "yesNo": {
17
+ "ntsRef": "E1.1.1",
18
+ "type": "string"
19
+ }
20
+ },
21
+ "oneOf": [
22
+ {
23
+ "properties": {
24
+ "yesNo": {
25
+ "enum": [
26
+ "No"
27
+ ]
28
+ }
29
+ }
30
+ },
31
+ {
32
+ "required": [
33
+ "details"
34
+ ],
35
+ "properties": {
36
+ "details": {
37
+ "ntsRef": "E1.1.2",
38
+ "type": "string",
39
+ "minLength": 1
40
+ },
41
+ "yesNo": {
42
+ "enum": [
43
+ "Yes"
44
+ ]
45
+ }
46
+ }
47
+ }
48
+ ],
49
+ "type": "object"
50
+ }
51
+ },
52
+ "required": [
53
+ "stormFireFloodDamage"
54
+ ],
55
+ "ntsRef": "E1"
56
+ }
57
+ }
58
+ }
59
+ },
60
+ "$schema": "http://json-schema.org/draft-07/schema#",
61
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/sd.json",
62
+ "$comment": "Storm, fire or flood damage"
63
+ }
package/src/schemas/v3/overlays/extensions/sf.json CHANGED
@@ -58,12 +58,14 @@
58
58
  },
59
59
  "required": [
60
60
  "sprayFoamInsulation"
61
- ]
61
+ ],
62
+ "ntsRef": "A1.2"
62
63
  }
63
64
  },
64
65
  "required": [
65
66
  "typeOfConstruction"
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/sl.json CHANGED
@@ -52,12 +52,14 @@
52
52
  },
53
53
  "required": [
54
54
  "solarPanels"
55
- ]
55
+ ],
56
+ "ntsRef": "B3.1"
56
57
  }
57
58
  },
58
59
  "required": [
59
60
  "electricity"
60
- ]
61
+ ],
62
+ "ntsRef": "0"
61
63
  }
62
64
  },
63
65
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/tf.json CHANGED
@@ -73,7 +73,8 @@
73
73
  },
74
74
  "required": [
75
75
  "serviceCharge"
76
- ]
76
+ ],
77
+ "ntsRef": "A3.2"
77
78
  }
78
79
  },
79
80
  "required": [
@@ -86,12 +87,14 @@
86
87
  },
87
88
  "required": [
88
89
  "ownershipsToBeTransferred"
89
- ]
90
+ ],
91
+ "ntsRef": "A3"
90
92
  }
91
93
  },
92
94
  "required": [
93
95
  "ownership"
94
- ]
96
+ ],
97
+ "ntsRef": "0"
95
98
  }
96
99
  },
97
100
  "$schema": "http://json-schema.org/draft-07/schema#",