@pdtf/schemas 3.6.0-dev.16 → 3.6.0-dev.17

package/index.js

@@ -225,6 +225,183 @@ const generateOverlayKey = (overlays) => {
   return overlays.join(".");
 };
 
+
+// ---------------------------------------------------------------------------
+// Overlay scoping
+//
+// A composed subschema is the CORE schema merged with the requested overlays,
+// so it carries every field the core schema knows about — including questions
+// the requested overlays never ask. Validating that full shape makes a form's
+// completeness depend on questions it does not render: e.g. the NTS Material
+// Information "Ownership" section validated the TA7 leasehold
+// `ownershipAndManagement` node, so a seller who part-answered TA7 could never
+// complete Material Information, with no field named in the error (the core
+// schema keeps the `oneOf` but `extractOverlay` strips the `discriminator` that
+// disambiguated it, so an absent tag matches EVERY branch: "must match exactly
+// one schema in oneOf", passingSchemas [0,1]).
+//
+// Scoping prunes the composed subschema to the fields the requested overlays
+// actually reference, so a form is validated against exactly what it asks.
+//
+// Discriminator tags are preserved even when unreferenced: they are structural,
+// and removing one leaves AJV compiling a `discriminator` whose tag is gone
+// ("oneOf subschemas must have properties/<tag>"). Tags are inherited into
+// `oneOf` branches and `items`, because that is where the tag property lives.
+// ---------------------------------------------------------------------------
+
+// Every form overlay id -> the marker `extractOverlay` stamps for it. This must
+// cover EVERY id in `overlaysMap`: an id missing here contributes no ref key, so
+// its fields would look unreferenced and be pruned away. `getOverlayRefKeys`
+// returns null if it sees an unknown id, which disables scoping altogether —
+// under-scoping merely preserves today's behaviour, over-scoping would mark
+// sections complete that are not.
+const overlayToRefMapping = {
+  baspiV4: "baspi4Ref",
+  baspiV5: "baspi5Ref",
+  nts2023: "ntsRef",
+  nts2025: "nts2Ref",
+  ntsl2023: "ntslRef",
+  ntsl2025: "ntsl2Ref",
+  ta6ed4: "ta6Ref",
+  ta6ed6: "ta6ed6Ref",
+  ta6ed6v2: "ta6ed6v2Ref",
+  ta7ed3: "ta7Ref",
+  ta7ed5: "ta7ed5Ref",
+  ta10ed3: "ta10Ref",
+  lpe1ed4: "lpe1Ref",
+  fme1ed2: "fme1Ref",
+  llc1v2: "llc1Ref",
+  con29R2019: "con29RRef",
+  con29DW: "con29DWRef",
+  rdsV333: "rdsRef",
+  oc1v21: "oc1Ref",
+  piqV3: "piqRef",
+  sr24: "sr24Ref",
+};
+
+// Extension overlays contribute their host form's ref key(s). `ta` is the TA6
+// compatibility overlay: it exists so TA6 answers can never invalidate the NTS
+// sections, and its marker must therefore count as visible here too — otherwise
+// scoping would prune away the very fields that overlay was added to protect.
+const extensionOverlayToRefs = {
+  as: ["ntsRef"],
+  dr: ["ntsRef"],
+  er: ["ntsRef"],
+  fd: ["ntsRef"],
+  hi: ["ntsRef"],
+  hs: ["ntsRef"],
+  jk: ["ntsRef"],
+  la: ["ntsRef"],
+  ma: ["ntsRef"],
+  mc: ["ntsRef"],
+  oa: ["ntsRef"],
+  oc: ["ntsRef"],
+  sb: ["ntsRef"],
+  sf: ["ntsRef"],
+  sl: ["ntsRef"],
+  tf: ["ntsRef"],
+  dk: ["ntsRef", "sef25Ref"],
+  ic: ["ntsRef", "sef25Ref"],
+  lc: ["ntsRef", "sef25Ref"],
+  mi: ["ntsRef", "sef25Ref"],
+  nd: ["ntsRef", "sef25Ref"],
+  pc: ["ntsRef", "sef25Ref"],
+  ph: ["ntsRef", "sef25Ref"],
+  rw: ["ntsRef", "sef25Ref"],
+  sc: ["ntsRef", "sef25Ref"],
+  sd: ["ntsRef", "sef25Ref"],
+  tr: ["ntsRef", "sef25Ref"],
+  wg: ["ntsRef", "sef25Ref"],
+  ac: ["ntsRef", "sef25Ref"],
+  ta: ["ta6ed6CompatRef"],
+};
+
+// Returns the ref keys these overlays reference, or null when scoping must be
+// skipped: an unrecognised overlay id (whose markers we therefore cannot
+// identify) would otherwise have all of its fields pruned as unreferenced.
+const getOverlayRefKeys = (overlays = []) => {
+  const overlayIds = (Array.isArray(overlays) ? overlays : [overlays]).filter(
+    (id) => id !== null && id !== undefined,
+  );
+  const refKeys = new Set();
+  for (const overlay of overlayIds) {
+    const refKey = overlayToRefMapping[overlay];
+    const extensionRefs = extensionOverlayToRefs[overlay];
+    if (!refKey && !extensionRefs) return null; // unknown id -> do not scope
+    if (refKey) refKeys.add(refKey);
+    (extensionRefs || []).forEach((k) => refKeys.add(k));
+  }
+  return [...refKeys];
+};
+
+// True when this node, or anything beneath it, is referenced by the overlays.
+const schemaHasVisibleOverlayRef = (schema, refKeys = []) => {
+  if (!schema || typeof schema !== "object") return false;
+  if (refKeys.some((refKey) => !!schema[refKey])) return true;
+  if (schema.items && schemaHasVisibleOverlayRef(schema.items, refKeys))
+    return true;
+  if (schema.properties) {
+    if (
+      Object.values(schema.properties).some((p) =>
+        schemaHasVisibleOverlayRef(p, refKeys),
+      )
+    )
+      return true;
+  }
+  if (Array.isArray(schema.oneOf)) {
+    return schema.oneOf.some((b) => schemaHasVisibleOverlayRef(b, refKeys));
+  }
+  return false;
+};
+
+// The property names that discriminate this node's `oneOf`: the declared
+// `discriminator`, plus — for a `oneOf` whose discriminator was stripped when
+// the core schema was built — the enum key every branch constrains.
+const discriminatingTags = (node) => {
+  const tags = new Set();
+  if (node.discriminator?.propertyName) tags.add(node.discriminator.propertyName);
+  if (Array.isArray(node.oneOf)) {
+    const branchKeys = node.oneOf.map(
+      (b) => new Set(Object.keys(b?.properties || {})),
+    );
+    const common = [...(branchKeys[0] || [])].filter((k) =>
+      branchKeys.every((s) => s.has(k)),
+    );
+    const inferred = common.find((k) =>
+      node.oneOf.every((b) => Array.isArray(b.properties[k]?.enum)),
+    );
+    if (inferred) tags.add(inferred);
+  }
+  return tags;
+};
+
+const pruneToOverlayScope = (node, refKeys, inheritedTags = new Set()) => {
+  if (!node || typeof node !== "object") return node;
+  const ownTags = discriminatingTags(node);
+  const keep = new Set([...ownTags, ...inheritedTags]);
+
+  if (node.properties) {
+    for (const [key, propertySchema] of Object.entries(node.properties)) {
+      if (!keep.has(key) && !schemaHasVisibleOverlayRef(propertySchema, refKeys)) {
+        delete node.properties[key];
+        if (Array.isArray(node.required)) {
+          node.required = node.required.filter((r) => r !== key);
+        }
+      } else {
+        pruneToOverlayScope(propertySchema, refKeys, new Set());
+      }
+    }
+  }
+  // Tags live inside branches and array items, so they must be inherited there.
+  if (node.items) pruneToOverlayScope(node.items, refKeys, ownTags);
+  if (Array.isArray(node.oneOf)) {
+    for (const branch of node.oneOf) {
+      pruneToOverlayScope(branch, refKeys, ownTags);
+    }
+  }
+  return node;
+};
+
 // Enhanced caching function that stores both subschemas and validators
 const getCachedSchemaData = (path, schemaId, overlays) => {
   const overlayKey = generateOverlayKey(overlays);
@@ -313,6 +490,17 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
       }, sourceSchema);
     }
 
+    // Scope the composed subschema to what these overlays actually ask, so a
+    // form's completeness never depends on questions it does not render.
+    // No overlays (or none carrying ref keys) => no scoping, shape unchanged.
+    const refKeys = getOverlayRefKeys(overlays);
+    if (refKeys && refKeys.length > 0 && subSchema && typeof subSchema === "object") {
+      subSchema = pruneToOverlayScope(
+        JSON.parse(JSON.stringify(subSchema)),
+        refKeys,
+      );
+    }
+
     // Add schema to AJV and get validator
     // Only add valid schemas to AJV
     let validator;
@@ -641,6 +829,9 @@ module.exports = {
   isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
+  getOverlayRefKeys,
+  schemaHasVisibleOverlayRef,
+  pruneToOverlayScope,
   verifiedClaimsSchema,
   validateVerifiedClaims,
   overlaysMap,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-dev.16",
+  "version": "3.6.0-dev.17",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "files": [

package/src/schemas/v3/combined.json

@@ -230,6 +230,7 @@
               "Prospective Buyer",
               "Buyer",
               "Buyer's Conveyancer",
+              "Gift Donor",
               "Estate Agent",
               "Buyer's Agent",
               "Surveyor",
@@ -611,6 +612,58 @@
               "sellersCapacity",
               "dateBecameOwnerOrAuthority"
             ]
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": ["Gift Donor"]
+              },
+              "offerId": {
+                "title": "Reference to an offer in the offers object",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
+              "giftDetails": {
+                "title": "Details of the gift being made towards the purchase",
+                "description": "The terms on which a gift donor is contributing funds. These are the questions a conveyancer must resolve before reporting to a lender: whether the money is truly a gift rather than a loan, and whether the donor acquires any interest in or occupation of the property.",
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "title": "Amount being gifted",
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "currency": {
+                    "title": "Currency of the gift",
+                    "type": "string",
+                    "default": "GBP"
+                  },
+                  "relationshipToBuyer": {
+                    "title": "Donor's relationship to the buyer",
+                    "type": "string"
+                  },
+                  "fundsTransferred": {
+                    "title": "Whether the gift has been paid to the buyer yet",
+                    "type": "string",
+                    "enum": ["None", "Part", "All"]
+                  },
+                  "repayable": {
+                    "title": "Whether the buyer must repay the money",
+                    "description": "If true the funds are a loan rather than a gift, which most lenders treat differently.",
+                    "type": "boolean"
+                  },
+                  "confersBeneficialInterest": {
+                    "title": "Whether the donor acquires an interest in the property",
+                    "type": "boolean"
+                  },
+                  "willOccupyProperty": {
+                    "title": "Whether the donor will live in the property after completion",
+                    "description": "An adult occupier who is not a legal owner may be required to sign a deed of consent or waiver of rights.",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
           }
         ]
       }
@@ -16093,6 +16146,8 @@
                       "baspi4Ref": "A4.6.3",
                       "baspi5Ref": "A4.6.3",
                       "ta6Ref": "1.6.3",
+                      "ta6ed6Ref": "2.5.3",
+                      "ta6ed6v2Ref": "2.5.3",
                       "title": "Attachments",
                       "type": "string",
                       "enum": ["Attached", "To follow"]
@@ -26711,20 +26766,14 @@
                       "minLength": 1
                     },
                     "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.3",
-                      "ta6ed6v2Ref": "9.3",
                       "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
                       "type": "object",
                       "properties": {
                         "yesNo": {
-                          "ta6ed6Ref": "9.3.1",
-                          "ta6ed6v2Ref": "9.3.1",
                           "type": "string",
                           "enum": ["Yes", "No", "Not known"]
                         }
                       },
-                      "ta6ed6Required": ["yesNo"],
-                      "ta6ed6v2Required": ["yesNo"],
                       "discriminator": {
                         "propertyName": "yesNo"
                       },
@@ -26743,14 +26792,10 @@
                             },
                             "details": {
                               "title": "Provide details",
-                              "ta6ed6Ref": "9.3.2",
-                              "ta6ed6v2Ref": "9.3.2",
                               "type": "string",
                               "minLength": 1
                             }
-                          },
-                          "ta6ed6Required": ["details"],
-                          "ta6ed6v2Required": ["details"]
+                          }
                         }
                       ]
                     }
@@ -26758,8 +26803,8 @@
                   "baspi4Required": ["details"],
                   "baspi5Required": ["details"],
                   "ta6Required": ["details"],
-                  "ta6ed6Required": ["details", "disagreementOrComplaint"],
-                  "ta6ed6v2Required": ["details", "disagreementOrComplaint"]
+                  "ta6ed6Required": ["details"],
+                  "ta6ed6v2Required": ["details"]
                 }
               ]
             },
@@ -26786,6 +26831,49 @@
                   "type": "string",
                   "title": "",
                   "enum": ["Yes", "No"]
+                },
+                "disagreementOrComplaint": {
+                  "ta6ed6Ref": "9.3",
+                  "ta6ed6v2Ref": "9.3",
+                  "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
+                  "type": "object",
+                  "properties": {
+                    "yesNo": {
+                      "ta6ed6Ref": "9.3.1",
+                      "ta6ed6v2Ref": "9.3.1",
+                      "type": "string",
+                      "enum": ["Yes", "No", "Not known"]
+                    }
+                  },
+                  "ta6ed6Required": ["yesNo"],
+                  "ta6ed6v2Required": ["yesNo"],
+                  "discriminator": {
+                    "propertyName": "yesNo"
+                  },
+                  "oneOf": [
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": ["No", "Not known"]
+                        }
+                      }
+                    },
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": ["Yes"]
+                        },
+                        "details": {
+                          "ta6ed6Ref": "9.3.2",
+                          "ta6ed6v2Ref": "9.3.2",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "ta6ed6Required": ["details"],
+                      "ta6ed6v2Required": ["details"]
+                    }
+                  ]
                 }
               },
               "baspi4Required": ["yesNo"],
@@ -26822,49 +26910,6 @@
                       "type": "string",
                       "minLength": 1
                     },
-                    "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.3",
-                      "ta6ed6v2Ref": "9.3",
-                      "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
-                      "type": "object",
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6Ref": "9.3.1",
-                          "ta6ed6v2Ref": "9.3.1",
-                          "type": "string",
-                          "enum": ["Yes", "No", "Not known"]
-                        }
-                      },
-                      "ta6ed6Required": ["yesNo"],
-                      "ta6ed6v2Required": ["yesNo"],
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": ["No", "Not known"]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": ["Yes"]
-                            },
-                            "details": {
-                              "ta6ed6Ref": "9.3.2",
-                              "ta6ed6v2Ref": "9.3.2",
-                              "type": "string",
-                              "minLength": 1
-                            }
-                          },
-                          "ta6ed6Required": ["details"],
-                          "ta6ed6v2Required": ["details"]
-                        }
-                      ]
-                    },
                     "attachments": {
                       "baspi4Ref": "A10.2.3",
                       "baspi5Ref": "A10.2.3",
@@ -27667,22 +27712,14 @@
                       "minLength": 1
                     },
                     "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.6",
-                      "ta6ed6v2Ref": "9.6",
                       "title": "Are you aware of any disagreement or complaint about any such arrangements?",
-                      "ta6ed6Title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
-                      "ta6ed6v2Title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
                       "type": "object",
                       "properties": {
                         "yesNo": {
-                          "ta6ed6Ref": "9.6.1",
-                          "ta6ed6v2Ref": "9.6.1",
                           "type": "string",
                           "enum": ["Yes", "No", "Not known"]
                         }
                       },
-                      "ta6ed6Required": ["yesNo"],
-                      "ta6ed6v2Required": ["yesNo"],
                       "discriminator": {
                         "propertyName": "yesNo"
                       },
@@ -27700,22 +27737,16 @@
                               "enum": ["Yes"]
                             },
                             "details": {
-                              "ta6ed6Ref": "9.6.2",
-                              "ta6ed6v2Ref": "9.6.2",
-                              "ta6ed6Title": "Please give details",
-                              "ta6ed6v2Title": "Please give details",
                               "type": "string",
                               "minLength": 1
                             }
-                          },
-                          "ta6ed6Required": ["details"],
-                          "ta6ed6v2Required": ["details"]
+                          }
                         }
                       ]
                     }
                   },
-                  "ta6ed6Required": ["details", "disagreementOrComplaint"],
-                  "ta6ed6v2Required": ["details", "disagreementOrComplaint"]
+                  "ta6ed6Required": ["details"],
+                  "ta6ed6v2Required": ["details"]
                 }
               ]
             }

package/src/schemas/v3/compactSkeleton.txt

@@ -64,6 +64,14 @@
       directorOrAuthorisedPerson
       countryOfIncorporation
     dateBecameOwnerOrAuthority
+    giftDetails
+      amount
+      currency
+      relationshipToBuyer
+      fundsTransferred
+      repayable
+      confersBeneficialInterest
+      willOccupyProperty
   ]
   propertyPack
     address
@@ -2171,10 +2179,10 @@
           details
       neighbouringLandRights
         yesNo
-        details
         disagreementOrComplaint
           yesNo
           details
+        details
         attachments
       accessRestrictionAttempts
         yesNo

package/src/schemas/v3/overlays/baspi4.json

@@ -127,6 +127,15 @@
             "required": [
               "sellersCapacity"
             ]
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              }
+            }
           }
         ],
         "required": [

package/src/schemas/v3/overlays/baspi5.json

@@ -127,6 +127,15 @@
             "required": [
               "sellersCapacity"
             ]
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              }
+            }
           }
         ],
         "required": [

package/src/schemas/v3/overlays/piq.json

@@ -86,6 +86,15 @@
                 ]
               }
             }
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              }
+            }
           }
         ]
       }

package/src/schemas/v3/overlays/ta6ed6.json

@@ -130,6 +130,15 @@
               "sellersCapacity",
               "dateBecameOwnerOrAuthority"
             ]
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              }
+            }
           }
         ],
         "required": [
@@ -2665,6 +2674,9 @@
                     "details": {
                       "ta6ed6Ref": "2.5.2",
                       "title": "Supply a copy and give details of any works carried out or agreed"
+                    },
+                    "attachments": {
+                      "ta6ed6Ref": "2.5.3"
                     }
                   },
                   "required": [
@@ -4540,52 +4552,10 @@
                     "details": {
                       "ta6ed6Ref": "9.2.2",
                       "title": "Please give details of how much, how often and who you pay"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.3",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6Ref": "9.3.2"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6Ref": "9.3.1"
-                        }
-                      }
                     }
                   },
                   "required": [
-                    "details",
-                    "disagreementOrComplaint"
+                    "details"
                   ]
                 }
               ],
@@ -4625,47 +4595,6 @@
                     "details": {
                       "ta6ed6Ref": "9.1.2",
                       "title": "Please give details"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.3",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6Ref": "9.3.2"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6Ref": "9.3.1"
-                        }
-                      }
                     }
                   },
                   "required": [
@@ -4681,6 +4610,47 @@
               "properties": {
                 "yesNo": {
                   "ta6ed6Ref": "9.1.1"
+                },
+                "disagreementOrComplaint": {
+                  "ta6ed6Ref": "9.3",
+                  "discriminator": {
+                    "propertyName": "yesNo"
+                  },
+                  "oneOf": [
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "No",
+                            "Not known"
+                          ]
+                        }
+                      }
+                    },
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "Yes"
+                          ]
+                        },
+                        "details": {
+                          "ta6ed6Ref": "9.3.2"
+                        }
+                      },
+                      "required": [
+                        "details"
+                      ]
+                    }
+                  ],
+                  "required": [
+                    "yesNo"
+                  ],
+                  "properties": {
+                    "yesNo": {
+                      "ta6ed6Ref": "9.3.1"
+                    }
+                  }
                 }
               }
             },
@@ -5112,54 +5082,10 @@
                     },
                     "details": {
                       "ta6ed6Ref": "9.5.2"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6Ref": "9.6",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6Ref": "9.6.2",
-                              "title": "Please give details"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6Ref": "9.6.1"
-                        }
-                      }
                     }
                   },
                   "required": [
-                    "details",
-                    "disagreementOrComplaint"
+                    "details"
                   ]
                 }
               ],

package/src/schemas/v3/overlays/ta6ed6v2.json

@@ -130,6 +130,15 @@
               "sellersCapacity",
               "dateBecameOwnerOrAuthority"
             ]
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              }
+            }
           }
         ],
         "required": [
@@ -1011,6 +1020,9 @@
                     "details": {
                       "ta6ed6v2Ref": "2.5.2",
                       "title": "Supply a copy and give details of any works carried out or agreed"
+                    },
+                    "attachments": {
+                      "ta6ed6v2Ref": "2.5.3"
                     }
                   },
                   "required": [
@@ -2634,52 +2646,10 @@
                     "details": {
                       "ta6ed6v2Ref": "9.2.2",
                       "title": "Please give details of how much, how often and who you pay"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6v2Ref": "9.3",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6v2Ref": "9.3.2"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6v2Ref": "9.3.1"
-                        }
-                      }
                     }
                   },
                   "required": [
-                    "details",
-                    "disagreementOrComplaint"
+                    "details"
                   ]
                 }
               ],
@@ -2719,47 +2689,6 @@
                     "details": {
                       "ta6ed6v2Ref": "9.1.2",
                       "title": "Please give details"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6v2Ref": "9.3",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6v2Ref": "9.3.2"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6v2Ref": "9.3.1"
-                        }
-                      }
                     }
                   },
                   "required": [
@@ -2775,6 +2704,47 @@
               "properties": {
                 "yesNo": {
                   "ta6ed6v2Ref": "9.1.1"
+                },
+                "disagreementOrComplaint": {
+                  "ta6ed6v2Ref": "9.3",
+                  "discriminator": {
+                    "propertyName": "yesNo"
+                  },
+                  "oneOf": [
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "No",
+                            "Not known"
+                          ]
+                        }
+                      }
+                    },
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "Yes"
+                          ]
+                        },
+                        "details": {
+                          "ta6ed6v2Ref": "9.3.2"
+                        }
+                      },
+                      "required": [
+                        "details"
+                      ]
+                    }
+                  ],
+                  "required": [
+                    "yesNo"
+                  ],
+                  "properties": {
+                    "yesNo": {
+                      "ta6ed6v2Ref": "9.3.1"
+                    }
+                  }
                 }
               }
             },
@@ -3206,54 +3176,10 @@
                     },
                     "details": {
                       "ta6ed6v2Ref": "9.5.2"
-                    },
-                    "disagreementOrComplaint": {
-                      "ta6ed6v2Ref": "9.6",
-                      "discriminator": {
-                        "propertyName": "yesNo"
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "ta6ed6v2Ref": "9.6.2",
-                              "title": "Please give details"
-                            }
-                          },
-                          "required": [
-                            "details"
-                          ]
-                        }
-                      ],
-                      "required": [
-                        "yesNo"
-                      ],
-                      "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
-                      "properties": {
-                        "yesNo": {
-                          "ta6ed6v2Ref": "9.6.1"
-                        }
-                      }
                     }
                   },
                   "required": [
-                    "details",
-                    "disagreementOrComplaint"
+                    "details"
                   ]
                 }
               ],

package/src/schemas/v3/pdtf-transaction.json

@@ -218,6 +218,7 @@
               "Prospective Buyer",
               "Buyer",
               "Buyer's Conveyancer",
+              "Gift Donor",
               "Estate Agent",
               "Buyer's Agent",
               "Surveyor",
@@ -561,6 +562,64 @@
                 "format": "date"
               }
             }
+          },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Gift Donor"
+                ]
+              },
+              "offerId": {
+                "title": "Reference to an offer in the offers object",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
+              "giftDetails": {
+                "title": "Details of the gift being made towards the purchase",
+                "description": "The terms on which a gift donor is contributing funds. These are the questions a conveyancer must resolve before reporting to a lender: whether the money is truly a gift rather than a loan, and whether the donor acquires any interest in or occupation of the property.",
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "title": "Amount being gifted",
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "currency": {
+                    "title": "Currency of the gift",
+                    "type": "string",
+                    "default": "GBP"
+                  },
+                  "relationshipToBuyer": {
+                    "title": "Donor's relationship to the buyer",
+                    "type": "string"
+                  },
+                  "fundsTransferred": {
+                    "title": "Whether the gift has been paid to the buyer yet",
+                    "type": "string",
+                    "enum": [
+                      "None",
+                      "Part",
+                      "All"
+                    ]
+                  },
+                  "repayable": {
+                    "title": "Whether the buyer must repay the money",
+                    "description": "If true the funds are a loan rather than a gift, which most lenders treat differently.",
+                    "type": "boolean"
+                  },
+                  "confersBeneficialInterest": {
+                    "title": "Whether the donor acquires an interest in the property",
+                    "type": "boolean"
+                  },
+                  "willOccupyProperty": {
+                    "title": "Whether the donor will live in the property after completion",
+                    "description": "An adult occupier who is not a legal owner may be required to sign a deed of consent or waiver of rights.",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
           }
         ]
       }
@@ -21223,6 +21282,45 @@
                     "Yes",
                     "No"
                   ]
+                },
+                "disagreementOrComplaint": {
+                  "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
+                  "type": "object",
+                  "properties": {
+                    "yesNo": {
+                      "type": "string",
+                      "enum": [
+                        "Yes",
+                        "No",
+                        "Not known"
+                      ]
+                    }
+                  },
+                  "oneOf": [
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "No",
+                            "Not known"
+                          ]
+                        }
+                      }
+                    },
+                    {
+                      "properties": {
+                        "yesNo": {
+                          "enum": [
+                            "Yes"
+                          ]
+                        },
+                        "details": {
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      }
+                    }
+                  ]
                 }
               },
               "oneOf": [
@@ -21247,45 +21345,6 @@
                       "type": "string",
                       "minLength": 1
                     },
-                    "disagreementOrComplaint": {
-                      "title": "Are you aware of any disagreement or complaint about any such right or arrangement?",
-                      "type": "object",
-                      "properties": {
-                        "yesNo": {
-                          "type": "string",
-                          "enum": [
-                            "Yes",
-                            "No",
-                            "Not known"
-                          ]
-                        }
-                      },
-                      "oneOf": [
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "No",
-                                "Not known"
-                              ]
-                            }
-                          }
-                        },
-                        {
-                          "properties": {
-                            "yesNo": {
-                              "enum": [
-                                "Yes"
-                              ]
-                            },
-                            "details": {
-                              "type": "string",
-                              "minLength": 1
-                            }
-                          }
-                        }
-                      ]
-                    },
                     "attachments": {
                       "title": "Attachments",
                       "type": "string",

package/src/schemas/v3/skeleton.json

@@ -90,7 +90,16 @@
         "directorOrAuthorisedPerson": "string",
         "countryOfIncorporation": "string"
       },
-      "dateBecameOwnerOrAuthority": "string"
+      "dateBecameOwnerOrAuthority": "string",
+      "giftDetails": {
+        "amount": "number",
+        "currency": "string",
+        "relationshipToBuyer": "string",
+        "fundsTransferred": "string",
+        "repayable": "boolean",
+        "confersBeneficialInterest": "boolean",
+        "willOccupyProperty": "boolean"
+      }
     }
   ],
   "propertyPack": {
@@ -2764,11 +2773,11 @@
       },
       "neighbouringLandRights": {
         "yesNo": "variant",
-        "details": "string",
         "disagreementOrComplaint": {
           "yesNo": "variant",
           "details": "string"
         },
+        "details": "string",
         "attachments": "string"
       },
       "accessRestrictionAttempts": {