@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/README.md CHANGED
@@ -7,7 +7,12 @@ The Property Data Trust Framework (PDTF) Schemas provide standardized JSON Schem
7
7
 
8
8
  ## Project Goals & Status
9
9
 
10
- **Current Version:** 3.5.0 (3.5.1-1 available as a pre-release on branch/package-tag `next`)
10
+ **Current Version:** 3.5.0 on `main` / npm `latest`.
11
+
12
+ Additional release channels are available for earlier adoption:
13
+
14
+ - `next` branch / npm `next`: tested capabilities proposed for the next PDTF release.
15
+ - `dev` branch / npm `dev`: fast-moving integration work for Moverly and other early adopters. This channel may include changes that are not yet accepted as PDTF standard capability.
11
16
 
12
17
  This schema framework aims to support the [Home Buying and Selling Group](https://homebuyingandsellinggroup.co.uk) 'Property Pack' initiative, encompassing all requirements starting with the Buyers and Sellers Property Information set ([BASPI v4.0](https://homebuyingandsellinggroup.co.uk/baspi/)).
13
18
 
@@ -62,7 +67,7 @@ if (!isValid) {
62
67
 
63
68
  - **🏗️ Modular Schema System** - Base schemas with flexible overlay composition
64
69
  - **📋 Multiple Form Support** - BASPI, NTS, Law Society TA forms, and more
65
- - **🧩 Extension Overlays** - Granular NTS2 features as individual modules
70
+ - **🧩 Extension Overlays** - Granular NTS2 and SEF25 features as individual modules
66
71
  - **✅ JSON Schema Validation** - Full JSON Schema Draft 07 support with AJV
67
72
  - **🔗 Verified Claims** - Support for verified data provenance tracking
68
73
  - **📚 Comprehensive Documentation** - Detailed usage guides and examples
@@ -82,7 +87,7 @@ if (!isValid) {
82
87
  │ │ │ │ └── extensions/ # Modular NTS2 extensions
83
88
  │ │ │ │ ├── jk.json # Japanese Knotweed
84
89
  │ │ │ │ ├── tf.json # Transfer Fees
85
- │ │ │ │ └── ... # 16 total extensions
90
+ │ │ │ │ └── ... # NTS2 + SEF25 extensions
86
91
  │ │ │ └── combined.json # Master schema for generation
87
92
  │ │ ├── v2/ # Legacy schema version
88
93
  │ │ ├── verifiedClaims/ # Verified claims schemas
@@ -163,31 +168,56 @@ const errors = validateVerifiedClaims(verifiedClaims, schemaId, ["nts2023"]);
163
168
 
164
169
  #### Extension Overlays
165
170
 
166
- Modular NTS2 features for selective adoption:
171
+ Modular features for selective adoption. Extensions are merged on top of an NTS base overlay.
167
172
 
168
173
  ```javascript
169
- // Individual extensions
170
- const schema = getTransactionSchema(schemaId, ["nts2023", "jk", "tf"]);
171
-
172
- // Multiple specialist issues
173
- const schema = getTransactionSchema(schemaId, [
174
- "nts2023",
175
- "as",
176
- "dr",
177
- "jk",
178
- "sb",
179
- ]);
174
+ // NTS2 extensions
175
+ const schema = getTransactionSchema(schemaId, ["nts2023", "jk", "tf", "ma"]);
176
+
177
+ // SEF25 extensions (Seller Enquiry Form)
178
+ const sef25 = ["sc", "pc", "ph", "dk", "rw", "sd", "lc", "wg", "ic", "nd", "mi", "tr"];
179
+ const schema = getTransactionSchema(schemaId, ["nts2023", ...sef25]);
180
180
  ```
181
181
 
182
- | Extension | Code | Description |
183
- | ----------------- | ---- | -------------------------------- |
184
- | Japanese Knotweed | `jk` | Knotweed presence and management |
185
- | Transfer Fees | `tf` | Additional leasehold fees |
186
- | Managing Agent | `ma` | Leasehold managing agent details |
187
- | Solar Panels | `sl` | Solar panel ownership details |
188
- | Asbestos | `as` | Asbestos presence and management |
182
+ **NTS2 Extensions:**
189
183
 
190
- [View all extensions →](src/schemas/v3/overlays/README.md#extension-overlays)
184
+ | Extension | Code | Description |
185
+ | --- | --- | --- |
186
+ | Japanese Knotweed | `jk` | Knotweed presence and management |
187
+ | Asbestos | `as` | Asbestos presence and management |
188
+ | Dry Rot | `dr` | Dry rot treatment |
189
+ | Subsidence | `sb` | Subsidence or structural fault |
190
+ | Health & Safety | `hs` | Ongoing health or safety issues |
191
+ | Outside Areas | `oa` | Outside areas details |
192
+ | Main Construction | `mc` | Construction type if standard form |
193
+ | Loft Access | `la` | Loft access and details |
194
+ | Spray Foam | `sf` | Spray foam insulation |
195
+ | Solar Panels | `sl` | Solar panel ownership details |
196
+ | Heating Installed | `hi` | Central heating installation date |
197
+ | Flood Defences | `fd` | Flood defence information |
198
+ | Estate Rentcharges | `er` | Estate rentcharges for freehold |
199
+ | Managing Agent | `ma` | Leasehold managing agent details |
200
+ | Transfer Fees | `tf` | Additional leasehold fees |
201
+ | Onward Chain | `oc` | Other property in chain |
202
+
203
+ **SEF25 Extensions (Seller Enquiry Form):**
204
+
205
+ | Extension | Code | Description |
206
+ | --- | --- | --- |
207
+ | Supply Costs | `sc` | Private water/sewerage costs |
208
+ | Parking Permit Cost | `pc` | Parking permit frequency |
209
+ | Property Hazards | `ph` | 4 hazard Yes/No questions |
210
+ | Dropped Kerb | `dk` | Dropped kerb access to parking |
211
+ | Private Right of Way | `rw` | Private right of way |
212
+ | Storm/Fire/Flood Damage | `sd` | Storm, fire or flood damage |
213
+ | Solar Lease Costs | `lc` | Solar panel lease costs |
214
+ | Warranties & Guarantees | `wg` | 7 warranty categories upfront |
215
+ | Insurance Claims | `ic` | Insurance claims upfront |
216
+ | Neighbour Development | `nd` | Neighbour development |
217
+ | Material Issue | `mi` | Other material issue upfront |
218
+ | Title Restrictions | `tr` | Title restrictions for freehold |
219
+
220
+ [View full SEF25 UI spec →](docs/sef25-extensions-ui-spec.md) | [View all extensions →](src/schemas/v3/overlays/README.md#extension-overlays)
191
221
 
192
222
  ## Usage Examples
193
223
 
@@ -204,7 +234,7 @@ const legalSchema = getTransactionSchema(schemaId, ["ta6ed4", "ta7ed3"]);
204
234
  const ntsSchema = getTransactionSchema(schemaId, ["nts2023"]);
205
235
  ```
206
236
 
207
- ### Modular NTS2 Features
237
+ ### Modular Extension Features
208
238
 
209
239
  ```javascript
210
240
  // Selective NTS2 adoption
@@ -215,15 +245,9 @@ const partialNts2 = getTransactionSchema(schemaId, [
215
245
  "ma", // Managing Agent
216
246
  ]);
217
247
 
218
- // Full specialist issues
219
- const specialistIssues = getTransactionSchema(schemaId, [
220
- "nts2023",
221
- "as",
222
- "dr",
223
- "jk",
224
- "sb",
225
- "hs",
226
- ]);
248
+ // SEF25 Seller Enquiry Form extensions
249
+ const sef25 = ["sc", "pc", "ph", "dk", "rw", "sd", "lc", "wg", "ic", "nd", "mi", "tr"];
250
+ const sellerEnquiry = getTransactionSchema(schemaId, ["nts2023", ...sef25]);
227
251
  ```
228
252
 
229
253
  ### Data Validation
@@ -0,0 +1,138 @@
1
+ # Branch And Release Workflow
2
+
3
+ This repository uses three long-lived release channels for `@pdtf/schemas`.
4
+
5
+ ## Branches And npm Tags
6
+
7
+ | Branch | npm dist-tag | Purpose |
8
+ | --- | --- | --- |
9
+ | `main` | `latest` | Stable PDTF releases for broad industry use. |
10
+ | `next` | `next` | Tested capabilities intended for the next managed PDTF point release. |
11
+ | `dev` | `dev` | Unstable coal face for faster-moving integration work and early adopters. |
12
+
13
+ `dev` is not the standard. It is a proving ground for changes that may later be
14
+ promoted to `next` through focused PRs. Consumers who need the stable standard
15
+ should use `@pdtf/schemas` from `latest`/`main`.
16
+
17
+ ## Versioning
18
+
19
+ Every npm publish must have a unique semver version.
20
+
21
+ - `main` publishes normal release versions, for example `3.5.0`, on `latest`.
22
+ - `next` publishes prerelease versions on the `next` tag.
23
+ - `dev` publishes prerelease versions on the `dev` tag, using a `-dev.N`
24
+ suffix, for example `3.6.0-dev.0`.
25
+
26
+ Do not publish `dev` or `next` builds to `latest`.
27
+
28
+ ## Dev Fast-Path Workflow
29
+
30
+ Use this workflow when work needs to move faster than the managed PDTF release
31
+ cycle, or when a change needs practical integration testing before it is proposed
32
+ for the standards-track path.
33
+
34
+ 1. Open a PR against `dev`.
35
+ 2. Treat `dev` as the unstable coal face. Keep the change reviewable and, where
36
+ possible, structured so that accepted parts can later be promoted to `next`.
37
+ 3. Change `src/schemas/v3/combined.json` for schema changes, then run both
38
+ extraction scripts:
39
+
40
+ ```bash
41
+ npm run extract-overlays
42
+ npm run extract-extension-overlays
43
+ ```
44
+
45
+ 4. Add or update tests for schema, overlay, path-validation, and utility
46
+ behaviour.
47
+ 5. Bump the package version to the next unique `-dev.N` version if the PR will
48
+ be published from `dev`.
49
+ 6. If the change should not enter the `next` review queue after it has landed in
50
+ `dev`, add the `no-promote-next` label before merging.
51
+ 7. Merge to `dev`.
52
+ 8. If publishing the dev channel, publish from `dev`:
53
+
54
+ ```bash
55
+ npm run publish:dev
56
+ ```
57
+
58
+ 9. Consumers can use `@pdtf/schemas@dev`, or pin the exact dev version in
59
+ lockfiles when deterministic rollout is required.
60
+
61
+ ## Automated Promotion To next
62
+
63
+ The `.github/workflows/promote-dev-to-next.yml` workflow can open the matching
64
+ `next` PR automatically.
65
+
66
+ Trigger:
67
+
68
+ - A PR is merged into `dev`.
69
+ - The merged PR does not have the `no-promote-next` label.
70
+
71
+ Behaviour:
72
+
73
+ 1. Check out `next`.
74
+ 2. Create a branch named `promote/dev-pr-<number>-to-next`.
75
+ 3. Cherry-pick the merged dev PR's effective diff onto that branch.
76
+ 4. Open a PR into `next` with a title and body referencing the original dev PR.
77
+
78
+ If the cherry-pick conflicts, the workflow creates an issue instead of a PR so a
79
+ maintainer can promote the change manually.
80
+
81
+ The promotion PR is intentionally still reviewed. Before merging to `next`,
82
+ maintainers should:
83
+
84
+ - confirm the change is appropriate for the managed release path;
85
+ - remove any dev-only scaffolding;
86
+ - adjust package version metadata from `-dev.N` to the correct `next`
87
+ prerelease version where needed;
88
+ - run tests and schema extraction checks.
89
+
90
+ ## Manual Promotion To next
91
+
92
+ If automation is not used, or if the automated cherry-pick conflicts:
93
+
94
+ 1. Branch from `next`.
95
+ 2. Cherry-pick the merged dev PR commit or recreate the focused diff.
96
+ 3. Remove dev-only changes.
97
+ 4. Bump to the next unique `next` prerelease version if the PR will be published
98
+ from `next`.
99
+ 5. Open a PR into `next` that links back to the original dev PR.
100
+ 6. Merge to `next` after review.
101
+ 7. Publish from `next`:
102
+
103
+ ```bash
104
+ npm run publish:next
105
+ ```
106
+
107
+ The `next` channel should remain tested and coherent. It can be ahead of
108
+ `main`, but it should not contain unrelated experimental work merely because it
109
+ exists on `dev`.
110
+
111
+ ## Promotion To main
112
+
113
+ When the PDTF point-release cycle is ready:
114
+
115
+ 1. Select accepted `next` changes for the point release.
116
+ 2. Merge or cherry-pick the accepted changes into `main`.
117
+ 3. Bump to the release version, for example `3.6.0`.
118
+ 4. Publish from `main`:
119
+
120
+ ```bash
121
+ npm run publish:latest
122
+ ```
123
+
124
+ Long-running `dev` work should not be merged wholesale into `main` unless the
125
+ full contents have been reviewed and accepted for the PDTF release.
126
+
127
+ ## Consumer Compatibility Profiles
128
+
129
+ Consumer-specific compatibility profiles are owned by the consuming application
130
+ or service unless and until they become a reusable PDTF capability.
131
+
132
+ Consumers may pin exact supplied schemas, hash them, and filter outbound API
133
+ calls or webhooks accordingly. That code should not be added to this schema
134
+ package unless the capability is generic and appropriate for PDTF consumers.
135
+
136
+ If a consumer later supports an official PDTF release, its target profile should
137
+ move from the consumer-specific schema to the relevant published
138
+ `@pdtf/schemas` release or prerelease.
@@ -0,0 +1,355 @@
1
+ # SEF25 Extension Overlays — Front-End UI Spec
2
+
3
+ ## Overview
4
+
5
+ Extension overlays add follow-up questions to existing form sections. Each overlay is loaded by passing its key to `getTransactionSchema(schemaId, overlays)`.
6
+
7
+ ### Pre-existing overlays
8
+
9
+ These were added before this PR and are already in production.
10
+
11
+ | Overlay Key | Name | Section | Fields Added |
12
+ |-------------|------|---------|-------------|
13
+ | `sc` | Supply Costs | Water & Drainage | Cost fields for private water and sewerage (restructured to hasCost Yes/No gate) |
14
+ | `pc` | Parking Permit Cost | Parking | 1 frequency field |
15
+ | `ph` | Property Hazards | Specialist Issues | 4 Yes/No + details fields |
16
+
17
+ ### New overlays (this PR)
18
+
19
+ | Overlay Key | Name | Section | Fields Added |
20
+ |-------------|------|---------|-------------|
21
+ | `dk` | Dropped Kerb | Parking | 1 Yes/No field |
22
+ | `rw` | Private Right of Way | Rights & Informal Arrangements | 1 Yes/No + details field |
23
+ | `sd` | Storm/Fire/Flood Damage | Environmental Issues | 1 Yes/No + details field |
24
+ | `lc` | Solar Lease Costs | Utilities (Solar Panels) | 1 cost field (hasCost + amount + frequency) |
25
+ | `wg` | Warranties & Guarantees | Guarantees & Warranties | Marks 7 warranty categories as required |
26
+ | `ic` | Insurance Claims | Insurance | Marks insuranceClaims required (isInsured=Yes branch) |
27
+ | `nd` | Neighbour Development | Notices | Adds sef25Ref to neighbourDevelopment (already required via NTS) |
28
+ | `mi` | Material Issue | Additional Information | Marks otherMaterialIssue required |
29
+ | `tr` | Title Restrictions | Ownership (Freehold) | Adds titleRestrictions field to freehold branch |
30
+
31
+ ### Existing fields with sef25Ref only (no separate overlay needed)
32
+
33
+ | Field | Path | sef25Ref | Notes |
34
+ |-------|------|----------|-------|
35
+ | `hasBeenFlooded` | `environmentalIssues.flooding.historicalFlooding.hasBeenFlooded` | E1.2 | Already required and rendered via NTS flooding section |
36
+
37
+ All fields use `sef25Ref` for reference codes.
38
+
39
+ ---
40
+
41
+ ## Pre-existing overlays (detail)
42
+
43
+ ### 1. Supply Costs (`sc`)
44
+
45
+ #### 1a. Private Water Cost
46
+
47
+ **Trigger:** Show when `propertyPack.waterAndDrainage.water.mainsWater.yesNo` = `"No"`
48
+
49
+ **Path:** `propertyPack.waterAndDrainage.water.mainsWater.associatedCost`
50
+
51
+ **UI:** Render alongside the existing "How is water supplied?" details field. First ask if there are costs, then show amount and frequency if Yes.
52
+
53
+ | Field | Path (relative) | Type | Validation | UI Element |
54
+ |-------|-----------------|------|------------|------------|
55
+ | Has costs? | `associatedCost.hasCost` | `string` | Required, enum | Yes/No radio |
56
+ | Cost (£) | `associatedCost.amount` | `number` | Required when Yes | Numeric input |
57
+ | Payment frequency | `associatedCost.frequency` | `string` | Required when Yes, enum | Dropdown |
58
+
59
+ **Frequency enum values:** `"Per month"`, `"Per year"`
60
+
61
+ **Ref:** `U1.1` (hasCost: `U1.1.1`, amount: `U1.1.2`, frequency: `U1.1.3`)
62
+
63
+ #### 1b. Private Sewerage Cost
64
+
65
+ **Trigger:** Show when `propertyPack.waterAndDrainage.drainage.mainsFoulDrainage.yesNo` = `"No"` or `"Not known"`
66
+
67
+ **Path:** `propertyPack.waterAndDrainage.drainage.mainsFoulDrainage.associatedCost`
68
+
69
+ **UI:** Same hasCost pattern as water cost above.
70
+
71
+ **Ref:** `U1.2` (hasCost: `U1.2.1`, amount: `U1.2.2`, frequency: `U1.2.3`)
72
+
73
+ ### 2. Parking Permit Cost (`pc`)
74
+
75
+ **Trigger:** Show when `propertyPack.parking.controlledParking.yesNo` = `"Yes"`
76
+
77
+ **Path:** `propertyPack.parking.controlledParking.costOfPermitFrequency`
78
+
79
+ **UI:** Render alongside the existing cost of permit field. The frequency dropdown clarifies whether the cost amount is monthly or annual.
80
+
81
+ | Field | Path (relative) | Type | Validation | UI Element |
82
+ |-------|-----------------|------|------------|------------|
83
+ | Payment frequency | `costOfPermitFrequency` | `string` | Enum | Dropdown |
84
+
85
+ **Frequency enum values:** `"Per month"`, `"Per year"`
86
+
87
+ **Ref:** `P1.1`
88
+
89
+ ### 3. Property Hazards (`ph`)
90
+
91
+ **Trigger:** Always shown (standalone questions within Specialist Issues).
92
+
93
+ **Path prefix:** `propertyPack.specialistIssues`
94
+
95
+ All 4 fields follow the same pattern: Yes/No, if Yes show required details.
96
+
97
+ | Property | Title | sef25Ref |
98
+ |----------|-------|----------|
99
+ | `wellsDitchesShaft` | Are there any wells, ditches, or shafts at the property? | H1.1 |
100
+ | `damagedOrExposedElectrics` | Are there any damaged or exposed electrics at the property? | H1.2 |
101
+ | `damageToFlooringOrStaircases` | Is there any damage to flooring and/or staircases? | H1.3 |
102
+ | `knownAreasInPoorCondition` | Are there any known areas in poor condition (internal or external)? | H1.4 |
103
+
104
+ ---
105
+
106
+ ## New overlays (detail)
107
+
108
+ ### 4. Dropped Kerb (`dk`)
109
+
110
+ **Trigger:** Always shown within Parking section.
111
+
112
+ **Path:** `propertyPack.parking.droppedKerbAccess`
113
+
114
+ | Field | Path (relative) | Type | Validation | UI Element |
115
+ |-------|-----------------|------|------------|------------|
116
+ | Dropped kerb? | `droppedKerbAccess.yesNo` | `string` | Required, enum | Yes/No radio |
117
+
118
+ **Ref:** `K1.1` (yesNo: `K1.1.1`)
119
+
120
+ ---
121
+
122
+ ### 5. Private Right of Way (`rw`)
123
+
124
+ **Trigger:** Always shown within Rights & Informal Arrangements, alongside the existing public right of way question.
125
+
126
+ **Path:** `propertyPack.rightsAndInformalArrangements.rightsOrArrangements.privateRightOfWay`
127
+
128
+ **UI:** Same pattern as `publicRightOfWay` — Yes/No, if Yes show details.
129
+
130
+ | Field | Path (relative) | Type | Validation | UI Element |
131
+ |-------|-----------------|------|------------|------------|
132
+ | Private ROW? | `privateRightOfWay.yesNo` | `string` | Required, enum | Yes/No radio |
133
+ | Details | `privateRightOfWay.details` | `string` | Required when Yes, minLength 1 | Text input |
134
+
135
+ **Ref:** `R1.1` (yesNo: `R1.1.1`, details: `R1.1.2`)
136
+
137
+ ---
138
+
139
+ ### 6. Storm, Fire or Flood Damage (`sd`)
140
+
141
+ **Trigger:** Always shown within Environmental Issues section.
142
+
143
+ **Path:** `propertyPack.environmentalIssues.stormFireFloodDamage`
144
+
145
+ | Field | Path (relative) | Type | Validation | UI Element |
146
+ |-------|-----------------|------|------------|------------|
147
+ | Damage? | `stormFireFloodDamage.yesNo` | `string` | Required, enum | Yes/No radio |
148
+ | Details | `stormFireFloodDamage.details` | `string` | Required when Yes, minLength 1 | Text area |
149
+
150
+ **Ref:** `E1.1` (yesNo: `E1.1.1`, details: `E1.1.2`)
151
+
152
+ ---
153
+
154
+ ### 7. Solar Panel Lease Costs (`lc`)
155
+
156
+ **Trigger:** Show when `propertyPack.electricity.solarPanels.panelsOwnedOutright.yesNo` = `"No"` (panels are leased).
157
+
158
+ **Path:** `propertyPack.electricity.solarPanels.panelsOwnedOutright.associatedCost`
159
+
160
+ **UI:** Render alongside existing lease details. First ask if there are costs, then show amount and frequency if Yes.
161
+
162
+ | Field | Path (relative) | Type | Validation | UI Element |
163
+ |-------|-----------------|------|------------|------------|
164
+ | Has costs? | `associatedCost.hasCost` | `string` | Required, enum | Yes/No radio |
165
+ | Amount (£) | `associatedCost.amount` | `number` | Required when Yes | Numeric input |
166
+ | Frequency | `associatedCost.frequency` | `string` | Required when Yes, enum | Dropdown |
167
+
168
+ **Frequency enum values:** `"Per month"`, `"Per year"`
169
+
170
+ **Ref:** `S1.1` (hasCost: `S1.1.1`, amount: `S1.1.2`, frequency: `S1.1.3`)
171
+
172
+ ---
173
+
174
+ ### 8. Warranties & Guarantees Upfront (`wg`)
175
+
176
+ **Trigger:** Always shown when overlay is loaded. Displayed upfront regardless of `hasValidGuaranteesOrWarranties` value.
177
+
178
+ **Path prefix:** `propertyPack.guaranteesWarrantiesAndIndemnityInsurances`
179
+
180
+ **UI:** For SEF25 upfront, show all 7 warranty categories as simple Yes/No questions. No details or "Years Remaining" needed at this stage — the law firm picks up details later.
181
+
182
+ | Property | Title | sef25Ref |
183
+ |----------|-------|----------|
184
+ | `newHomeWarranty` | New Home Warranty (NHBC or similar) | W1.1 |
185
+ | `roofingWork` | Roofing work | W1.2 |
186
+ | `dampProofingTreatment` | Damp proofing treatment | W1.3 |
187
+ | `centralHeatingAndorPlumbing` | Central heating and/or plumbing | W1.4 |
188
+ | `electricalRepairOrInstallation` | Electrical repair or installation | W1.5 |
189
+ | `subsidenceWork` | Underpinning or other preventative work / remedial action relating to subsidence | W1.6 |
190
+ | `otherGuarantees` | Other Guarantees or warranties | W1.7 |
191
+
192
+ **Note:** These fields already exist in the base schema under the `hasValidGuaranteesOrWarranties = "Yes"` branch. The `wg` overlay marks them as required within that branch. The Moverly app shows them upfront for SEF25 users without requiring the parent gate question first.
193
+
194
+ ---
195
+
196
+ ### 9. Insurance Claims (`ic`)
197
+
198
+ **Path:** `propertyPack.insurance.insuranceClaims` (inside `isInsured = "Yes"` branch)
199
+
200
+ **Ref:** `I1.1` (yesNo: `I1.1.1`) — "Have you made any buildings insurance claims?"
201
+
202
+ **Note:** The overlay marks insuranceClaims required within the `isInsured = "Yes"` oneOf branch.
203
+
204
+ ---
205
+
206
+ ### 10. Neighbour Development (`nd`)
207
+
208
+ **Path:** `propertyPack.notices.neighbourDevelopment`
209
+
210
+ **Ref:** `N1.1` — "Is the seller aware of any proposals to develop property or land nearby?"
211
+
212
+ **Note:** `neighbourDevelopment` is already required via `ntsRequired` at the notices level. The `nd` overlay adds `sef25Ref` and `ntsRef` annotations so the field is identifiable as SEF25-relevant.
213
+
214
+ ---
215
+
216
+ ### 11. Material Issue (`mi`)
217
+
218
+ **Path:** `propertyPack.additionalInformation.otherMaterialIssue`
219
+
220
+ **Ref:** `M1.1` (yesNo: `M1.1.1`) — "Are you aware of any other material issue or information which may affect the average person's decision to proceed?"
221
+
222
+ ---
223
+
224
+ ### 12. Title Restrictions (`tr`)
225
+
226
+ **Path:** `propertyPack.ownership.ownershipsToBeTransferred[Freehold].titleRestrictions`
227
+
228
+ **Ref:** `T1.1` (yesNo: `T1.1.1`, details: `T1.1.2`) — "Are there any known restrictions on the title?"
229
+
230
+ New field on the freehold ownership branch, modelled on `leaseRestrictions` for leasehold. Yes/No + details if Yes.
231
+
232
+ ---
233
+
234
+ ## Loading the Extensions
235
+
236
+ ```js
237
+ import { getTransactionSchema, getValidator } from "@pdtf/schemas";
238
+
239
+ const schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json";
240
+
241
+ // Load all SEF25 extensions
242
+ const sef25Extensions = ["sc", "pc", "ph", "dk", "rw", "sd", "lc", "wg", "ic", "nd", "mi", "tr"];
243
+ const schema = getTransactionSchema(schemaId, sef25Extensions);
244
+
245
+ // Or combine with other overlays
246
+ const schema = getTransactionSchema(schemaId, ["baspiV5", ...sef25Extensions]);
247
+
248
+ // Validate data against the merged schema
249
+ const validator = getValidator(schemaId, sef25Extensions);
250
+ ```
251
+
252
+ ---
253
+
254
+ ## Summary of Trigger Conditions
255
+
256
+ | Field | Visible when... |
257
+ |-------|----------------|
258
+ | Water cost | `mainsWater.yesNo` = `"No"` |
259
+ | Sewerage cost | `mainsFoulDrainage.yesNo` = `"No"` or `"Not known"` |
260
+ | Parking permit frequency | `controlledParking.yesNo` = `"Yes"` |
261
+ | Wells/ditches/shaft | Always (within Specialist Issues) |
262
+ | Damaged electrics | Always (within Specialist Issues) |
263
+ | Flooring/staircase damage | Always (within Specialist Issues) |
264
+ | Areas in poor condition | Always (within Specialist Issues) |
265
+ | Dropped kerb access | Always (within Parking) |
266
+ | Private right of way | Always (within Rights & Informal Arrangements) |
267
+ | Storm/fire/flood damage | Always (within Environmental Issues) |
268
+ | Solar panel lease costs | `panelsOwnedOutright.yesNo` = `"No"` |
269
+ | Warranty categories (7) | Always when `wg` overlay loaded (within Guarantees & Warranties) |
270
+ | Insurance claims | `isInsured.yesNo` = `"Yes"` (via `ic` overlay) |
271
+ | Neighbour development | Always (via `nd` overlay) |
272
+ | Other material issue | Always (via `mi` overlay) |
273
+ | Title restrictions | Always (via `tr` overlay, freehold only) |
274
+
275
+ ---
276
+
277
+ ## Moverly propertyPackTasks Changes
278
+
279
+ The following changes are needed in the Moverly app's `propertyPackTasks` configuration to surface the new SEF25 fields in the listing journey.
280
+
281
+ ### Existing tasks to deprecate
282
+
283
+ The flooding and planning tasks should be stepped up to their parent section level to cover the new sibling fields (`stormFireFloodDamage` and `neighbourDevelopment`).
284
+
285
+ ```js
286
+ // Replace existing flooding task with deprecated version
287
+ {
288
+ name: "Flooding",
289
+ path: "/propertyPack/environmentalIssues/flooding",
290
+ category: "listing",
291
+ overlay: "nts2023",
292
+ deprecated: true, // replaced by environmental issues check
293
+ },
294
+
295
+ // Replace existing planning task with deprecated version
296
+ {
297
+ name: "Planning and development",
298
+ path: "/propertyPack/notices/planningApplication",
299
+ category: "listing",
300
+ overlay: "nts2023",
301
+ deprecated: true, // replaced by notices check
302
+ },
303
+ ```
304
+
305
+ ### New listing tasks to add
306
+
307
+ ```js
308
+ {
309
+ name: "Environmental issues",
310
+ checkName: "sef25-environmentalIssues",
311
+ path: "/propertyPack/environmentalIssues",
312
+ category: "listing",
313
+ overlay: "sd",
314
+ },
315
+ {
316
+ name: "Notices",
317
+ checkName: "sef25-notices",
318
+ path: "/propertyPack/notices",
319
+ category: "listing",
320
+ overlay: "nd",
321
+ },
322
+ {
323
+ name: "Guarantees & warranties",
324
+ checkName: "sef25-warranties",
325
+ path: "/propertyPack/guaranteesWarrantiesAndIndemnityInsurances",
326
+ category: "listing",
327
+ overlay: "wg",
328
+ },
329
+ {
330
+ name: "Insurance claims",
331
+ checkName: "sef25-insurance",
332
+ path: "/propertyPack/insurance",
333
+ category: "listing",
334
+ overlay: "ic",
335
+ },
336
+ {
337
+ name: "Additional material information",
338
+ checkName: "sef25-additionalInformation",
339
+ path: "/propertyPack/additionalInformation",
340
+ category: "listing",
341
+ overlay: "mi",
342
+ },
343
+ ```
344
+
345
+ ### Fields covered by existing listing tasks (no new task needed)
346
+
347
+ | Extension | Covered by |
348
+ |-----------|------------|
349
+ | `dk` (dropped kerb) | Parking |
350
+ | `rw` (private right of way) | Rights and easements |
351
+ | `lc` (solar lease costs) | Electricity |
352
+ | `sc` (supply costs) | Water and drainage |
353
+ | `pc` (parking permit cost) | Parking |
354
+ | `ph` (property hazards) | Specialist issues |
355
+ | `tr` (title restrictions) | Ownership |