@pdtf/schemas 3.6.0-9 → 3.6.0-dev.10

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 (85) hide show
  1. package/README.md +57 -33
  2. package/docs/branch-release-workflow.md +138 -0
  3. package/docs/sef25-extensions-ui-spec.md +355 -0
  4. package/index.js +131 -75
  5. package/package.json +14 -2
  6. package/src/schemas/v3/combined.json +7952 -1721
  7. package/src/schemas/v3/compactSkeleton.txt +379 -5
  8. package/src/schemas/v3/overlays/baspi4.json +205 -93
  9. package/src/schemas/v3/overlays/baspi5.json +210 -95
  10. package/src/schemas/v3/overlays/extensions/ac.json +334 -0
  11. package/src/schemas/v3/overlays/extensions/as.json +4 -2
  12. package/src/schemas/v3/overlays/extensions/dk.json +33 -0
  13. package/src/schemas/v3/overlays/extensions/dr.json +9 -9
  14. package/src/schemas/v3/overlays/extensions/er.json +4 -2
  15. package/src/schemas/v3/overlays/extensions/fd.json +6 -3
  16. package/src/schemas/v3/overlays/extensions/hi.json +6 -3
  17. package/src/schemas/v3/overlays/extensions/hs.json +4 -2
  18. package/src/schemas/v3/overlays/extensions/ic.json +94 -0
  19. package/src/schemas/v3/overlays/extensions/jk.json +28 -8
  20. package/src/schemas/v3/overlays/extensions/la.json +4 -2
  21. package/src/schemas/v3/overlays/extensions/lc.json +76 -0
  22. package/src/schemas/v3/overlays/extensions/ma.json +6 -3
  23. package/src/schemas/v3/overlays/extensions/mc.json +4 -2
  24. package/src/schemas/v3/overlays/extensions/mi.json +70 -0
  25. package/src/schemas/v3/overlays/extensions/nd.json +44 -0
  26. package/src/schemas/v3/overlays/extensions/oa.json +4 -2
  27. package/src/schemas/v3/overlays/extensions/oc.json +4 -2
  28. package/src/schemas/v3/overlays/extensions/pc.json +38 -0
  29. package/src/schemas/v3/overlays/extensions/ph.json +195 -0
  30. package/src/schemas/v3/overlays/extensions/rw.json +69 -0
  31. package/src/schemas/v3/overlays/extensions/sb.json +4 -2
  32. package/src/schemas/v3/overlays/extensions/sc.json +133 -0
  33. package/src/schemas/v3/overlays/extensions/sd.json +64 -0
  34. package/src/schemas/v3/overlays/extensions/sf.json +4 -2
  35. package/src/schemas/v3/overlays/extensions/sl.json +4 -2
  36. package/src/schemas/v3/overlays/extensions/ta.json +204 -0
  37. package/src/schemas/v3/overlays/extensions/tf.json +6 -3
  38. package/src/schemas/v3/overlays/extensions/tr.json +74 -0
  39. package/src/schemas/v3/overlays/extensions/wg.json +351 -0
  40. package/src/schemas/v3/overlays/fme1.json +16 -14
  41. package/src/schemas/v3/overlays/llc1.json +1 -2
  42. package/src/schemas/v3/overlays/lpe1.json +61 -31
  43. package/src/schemas/v3/overlays/nts.json +71 -2
  44. package/src/schemas/v3/overlays/nts2.json +71 -5
  45. package/src/schemas/v3/overlays/ntsl.json +71 -2
  46. package/src/schemas/v3/overlays/ntsl2.json +71 -5
  47. package/src/schemas/v3/overlays/piq.json +60 -27
  48. package/src/schemas/v3/overlays/rds.json +139 -57
  49. package/src/schemas/v3/overlays/sef25.json +1653 -0
  50. package/src/schemas/v3/overlays/ta10.json +0 -9
  51. package/src/schemas/v3/overlays/ta6.json +83 -85
  52. package/src/schemas/v3/overlays/ta6ed6.json +6641 -0
  53. package/src/schemas/v3/overlays/ta7.json +70 -6
  54. package/src/schemas/v3/overlays/ta7ed5.json +1597 -0
  55. package/src/schemas/v3/pdtf-transaction.json +4525 -1013
  56. package/src/schemas/v3/skeleton.json +512 -40
  57. package/src/utils/extractExtensionOverlays.js +302 -31
  58. package/src/utils/extractOverlay.js +114 -27
  59. package/src/utils/pathSkeleton.js +1 -1
  60. package/.claude/settings.local.json +0 -42
  61. package/.github/workflows/pages.yml +0 -50
  62. package/CNAME +0 -1
  63. package/_config.yml +0 -1
  64. package/src/examples/v1/exampleAddParticipantVouch.json +0 -32
  65. package/src/examples/v1/exampleDocumentedVouch.json +0 -40
  66. package/src/examples/v1/exampleElectronicRecord.json +0 -30
  67. package/src/examples/v1/exampleTransaction.json +0 -878
  68. package/src/examples/v1/exampleVouch.json +0 -25
  69. package/src/examples/v2/exampleTransaction.json +0 -901
  70. package/src/examples/v3/exampleAddParticipantVouch.json +0 -38
  71. package/src/examples/v3/exampleCustomOverlay.json +0 -55
  72. package/src/examples/v3/exampleCustomOverlay2.json +0 -93
  73. package/src/examples/v3/exampleDocumentedVouch.json +0 -47
  74. package/src/examples/v3/exampleElectronicRecord.json +0 -36
  75. package/src/examples/v3/exampleTransaction.json +0 -1038
  76. package/src/examples/v3/exampleVouch.json +0 -32
  77. package/src/mappings/SendPropertyDetailsRequestSchema.json +0 -1588
  78. package/src/mappings/adf.js +0 -198
  79. package/src/tests/v3/caching.test.js +0 -591
  80. package/src/tests/v3/enquiries.test.js +0 -1096
  81. package/src/tests/v3/extensionOverlays.test.js +0 -525
  82. package/src/tests/v3/offers.test.js +0 -823
  83. package/src/tests/v3/patternProperties.test.js +0 -688
  84. package/src/tests/v3/transactionSchema.test.js +0 -615
  85. package/src/tests/v3/verifiedClaimsValidator.test.js +0 -195
package/src/schemas/v3/overlays/extensions/lc.json ADDED
@@ -0,0 +1,76 @@
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
+ "frequency"
21
+ ],
22
+ "discriminator": {
23
+ "propertyName": "frequency"
24
+ },
25
+ "properties": {
26
+ "frequency": {
27
+ "ntsRef": "S1.1.2",
28
+ "type": "string"
29
+ }
30
+ },
31
+ "oneOf": [
32
+ {
33
+ "properties": {
34
+ "frequency": {
35
+ "enum": [
36
+ "Not applicable"
37
+ ]
38
+ }
39
+ }
40
+ },
41
+ {
42
+ "properties": {
43
+ "amount": {
44
+ "ntsRef": "S1.1.1",
45
+ "type": "number"
46
+ },
47
+ "frequency": {
48
+ "enum": [
49
+ "Per month",
50
+ "Per year"
51
+ ]
52
+ }
53
+ }
54
+ }
55
+ ],
56
+ "type": "object"
57
+ }
58
+ }
59
+ }
60
+ ]
61
+ }
62
+ }
63
+ }
64
+ ]
65
+ }
66
+ },
67
+ "ntsRef": "B3.1"
68
+ }
69
+ },
70
+ "ntsRef": "0"
71
+ }
72
+ },
73
+ "$schema": "http://json-schema.org/draft-07/schema#",
74
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/lc.json",
75
+ "$comment": "Solar panel lease costs"
76
+ }
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,70 @@
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
+ "required": [
33
+ "details"
34
+ ],
35
+ "properties": {
36
+ "details": {
37
+ "ntsRef": "M1.1.2",
38
+ "type": "string",
39
+ "minLength": 1
40
+ },
41
+ "yesNo": {
42
+ "enum": [
43
+ "Yes"
44
+ ]
45
+ },
46
+ "attachments": {
47
+ "enum": [
48
+ "Attached",
49
+ "To follow"
50
+ ]
51
+ }
52
+ }
53
+ }
54
+ ],
55
+ "type": "object"
56
+ }
57
+ },
58
+ "required": [
59
+ "otherMaterialIssue"
60
+ ],
61
+ "ntsRef": "M1"
62
+ }
63
+ },
64
+ "ntsRef": "0"
65
+ }
66
+ },
67
+ "$schema": "http://json-schema.org/draft-07/schema#",
68
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/mi.json",
69
+ "$comment": "Other material issue upfront for SEF25"
70
+ }
package/src/schemas/v3/overlays/extensions/nd.json ADDED
@@ -0,0 +1,44 @@
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": "C4"
36
+ }
37
+ },
38
+ "ntsRef": "0"
39
+ }
40
+ },
41
+ "$schema": "http://json-schema.org/draft-07/schema#",
42
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/nd.json",
43
+ "$comment": "Neighbour development upfront for SEF25"
44
+ }
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 ADDED
@@ -0,0 +1,38 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "parking": {
6
+ "properties": {
7
+ "controlledParking": {
8
+ "oneOf": [
9
+ null,
10
+ {
11
+ "properties": {
12
+ "costOfPermit": {
13
+ "ntsRef": "P1.1",
14
+ "type": "number"
15
+ },
16
+ "costOfPermitFrequency": {
17
+ "ntsRef": "P1.2",
18
+ "type": "string"
19
+ }
20
+ },
21
+ "required": [
22
+ "costOfPermit",
23
+ "costOfPermitFrequency"
24
+ ]
25
+ }
26
+ ]
27
+ }
28
+ },
29
+ "ntsRef": "B4"
30
+ }
31
+ },
32
+ "ntsRef": "0"
33
+ }
34
+ },
35
+ "$schema": "http://json-schema.org/draft-07/schema#",
36
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/pc.json",
37
+ "$comment": "Parking permit cost and frequency"
38
+ }
package/src/schemas/v3/overlays/extensions/ph.json ADDED
@@ -0,0 +1,195 @@
1
+ {
2
+ "properties": {
3
+ "propertyPack": {
4
+ "properties": {
5
+ "specialistIssues": {
6
+ "required": [
7
+ "wellsDitchesShaft",
8
+ "damagedOrExposedElectrics",
9
+ "damageToFlooringOrStaircases",
10
+ "knownAreasInPoorCondition"
11
+ ],
12
+ "properties": {
13
+ "wellsDitchesShaft": {
14
+ "ntsRef": "H1.1",
15
+ "required": [
16
+ "yesNo"
17
+ ],
18
+ "discriminator": {
19
+ "propertyName": "yesNo"
20
+ },
21
+ "properties": {
22
+ "yesNo": {
23
+ "ntsRef": "H1.1.1",
24
+ "type": "string"
25
+ }
26
+ },
27
+ "oneOf": [
28
+ {
29
+ "properties": {
30
+ "yesNo": {
31
+ "enum": [
32
+ "No"
33
+ ]
34
+ }
35
+ }
36
+ },
37
+ {
38
+ "required": [
39
+ "details"
40
+ ],
41
+ "properties": {
42
+ "details": {
43
+ "ntsRef": "H1.1.2",
44
+ "type": "string",
45
+ "minLength": 1
46
+ },
47
+ "yesNo": {
48
+ "enum": [
49
+ "Yes"
50
+ ]
51
+ }
52
+ }
53
+ }
54
+ ]
55
+ },
56
+ "damagedOrExposedElectrics": {
57
+ "ntsRef": "H1.2",
58
+ "required": [
59
+ "yesNo"
60
+ ],
61
+ "discriminator": {
62
+ "propertyName": "yesNo"
63
+ },
64
+ "properties": {
65
+ "yesNo": {
66
+ "ntsRef": "H1.2.1",
67
+ "type": "string"
68
+ }
69
+ },
70
+ "oneOf": [
71
+ {
72
+ "properties": {
73
+ "yesNo": {
74
+ "enum": [
75
+ "No"
76
+ ]
77
+ }
78
+ }
79
+ },
80
+ {
81
+ "required": [
82
+ "details"
83
+ ],
84
+ "properties": {
85
+ "details": {
86
+ "ntsRef": "H1.2.2",
87
+ "type": "string",
88
+ "minLength": 1
89
+ },
90
+ "yesNo": {
91
+ "enum": [
92
+ "Yes"
93
+ ]
94
+ }
95
+ }
96
+ }
97
+ ]
98
+ },
99
+ "damageToFlooringOrStaircases": {
100
+ "ntsRef": "H1.3",
101
+ "required": [
102
+ "yesNo"
103
+ ],
104
+ "discriminator": {
105
+ "propertyName": "yesNo"
106
+ },
107
+ "properties": {
108
+ "yesNo": {
109
+ "ntsRef": "H1.3.1",
110
+ "type": "string"
111
+ }
112
+ },
113
+ "oneOf": [
114
+ {
115
+ "properties": {
116
+ "yesNo": {
117
+ "enum": [
118
+ "No"
119
+ ]
120
+ }
121
+ }
122
+ },
123
+ {
124
+ "required": [
125
+ "details"
126
+ ],
127
+ "properties": {
128
+ "details": {
129
+ "ntsRef": "H1.3.2",
130
+ "type": "string",
131
+ "minLength": 1
132
+ },
133
+ "yesNo": {
134
+ "enum": [
135
+ "Yes"
136
+ ]
137
+ }
138
+ }
139
+ }
140
+ ]
141
+ },
142
+ "knownAreasInPoorCondition": {
143
+ "ntsRef": "H1.4",
144
+ "required": [
145
+ "yesNo"
146
+ ],
147
+ "discriminator": {
148
+ "propertyName": "yesNo"
149
+ },
150
+ "properties": {
151
+ "yesNo": {
152
+ "ntsRef": "H1.4.1",
153
+ "type": "string"
154
+ }
155
+ },
156
+ "oneOf": [
157
+ {
158
+ "properties": {
159
+ "yesNo": {
160
+ "enum": [
161
+ "No"
162
+ ]
163
+ }
164
+ }
165
+ },
166
+ {
167
+ "required": [
168
+ "details"
169
+ ],
170
+ "properties": {
171
+ "details": {
172
+ "ntsRef": "H1.4.2",
173
+ "type": "string",
174
+ "minLength": 1
175
+ },
176
+ "yesNo": {
177
+ "enum": [
178
+ "Yes"
179
+ ]
180
+ }
181
+ }
182
+ }
183
+ ]
184
+ }
185
+ },
186
+ "type": "object"
187
+ }
188
+ },
189
+ "ntsRef": "0"
190
+ }
191
+ },
192
+ "$schema": "http://json-schema.org/draft-07/schema#",
193
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/ph.json",
194
+ "$comment": "Property hazards and known issues"
195
+ }
package/src/schemas/v3/overlays/extensions/rw.json ADDED
@@ -0,0 +1,69 @@
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": "C2.2.1"
58
+ }
59
+ },
60
+ "ntsRef": "C2.2"
61
+ }
62
+ },
63
+ "ntsRef": "0"
64
+ }
65
+ },
66
+ "$schema": "http://json-schema.org/draft-07/schema#",
67
+ "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/rw.json",
68
+ "$comment": "Private right of way"
69
+ }
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#",