@pdtf/schemas 3.6.0-dev.33 → 3.6.0-dev.34

package/docs/branch-release-workflow.md

@@ -73,10 +73,17 @@ Behaviour:
 1. Check out `next`.
 2. Create a branch named `promote/dev-pr-<number>-to-next`.
 3. Cherry-pick the merged dev PR's effective diff onto that branch.
-4. Open a PR into `next` with a title and body referencing the original dev PR.
-
-If the cherry-pick conflicts, the workflow creates an issue instead of a PR so a
-maintainer can promote the change manually.
+4. Keep `next`'s `package.json` and `package-lock.json`, because the two
+   channels version independently.
+5. Leave out generated `src/schemas/v4` files that `next` does not have but the
+   dev PR modified. `next` has had no v4 output since PR #160, so every dev PR
+   that regenerates v4 would otherwise conflict. v4 files a dev PR adds are kept
+   for review, and this step does nothing once v4 is back on `next`.
+6. Open a PR into `next` with a title and body referencing the original dev PR.
+   The body says how many v4 files were left out.
+
+If anything else conflicts, the workflow creates an issue instead of a PR,
+listing the conflicting files, so a maintainer can promote the change manually.
 
 The promotion PR is intentionally still reviewed. Before merging to `next`,
 maintainers should:

package/index.js

@@ -52,6 +52,7 @@ const extensionOverlays = {
 
   // Transaction Extensions
   oc: require("./src/schemas/v3/overlays/extensions/oc.json"),
+  rs: require("./src/schemas/v3/overlays/extensions/rs.json"),
 
   // SEF25 Extensions
   sc: require("./src/schemas/v3/overlays/extensions/sc.json"),
@@ -296,6 +297,7 @@ const extensionOverlayToRefs = {
   mc: ["ntsRef"],
   oa: ["ntsRef"],
   oc: ["ntsRef"],
+  rs: ["ntsRef", "rsRef"],
   sb: ["ntsRef"],
   sf: ["ntsRef"],
   sl: ["ntsRef"],

package/package.json

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

package/src/schemas/v3/combined.json

@@ -33087,6 +33087,8 @@
           "ta6ed6Ref": "14",
           "ta6ed6v2Ref": "14",
           "nts2Ref": "A1.5.7",
+          "rsRef": "A1.5.7",
+          "rsRequired": ["reasonForSale"],
           "title": "Completion and Moving",
           "ta6ed6Title": "Completion",
           "ta6ed6v2Title": "Completion",
@@ -33312,6 +33314,11 @@
                 }
               ]
             },
+            "reasonForSale": {
+              "rsRef": "A1.5.7.2",
+              "title": "What is the reason for the sale?",
+              "type": "string"
+            },
             "moveRestrictionDates": {
               "baspi4Ref": "B7.3",
               "baspi5Ref": "B7.3",

package/src/schemas/v3/compactSkeleton.txt

@@ -2711,6 +2711,7 @@
           line3
           town
           postcode
+      reasonForSale
       moveRestrictionDates
         yesNo
         details

package/src/schemas/v3/overlays/README.md

@@ -95,6 +95,7 @@ The `extensions/` directory contains modular overlays that add specific NTS2 fea
 | Extension | String Key | Description | Reference | Usage |
 |-----------|------------|-------------|-----------|-------|
 | `oc.json` | `"oc"` | Other Property Chain | - | Chain dependency information |
+| `rs.json` | `"rs"` | Reason For Sale | A1.5.7.2 | Free-text reason for sale (required when the extension is applied) |
 
 ## Usage Examples
 

package/src/schemas/v3/overlays/extensions/rs.json

@@ -0,0 +1,24 @@
+{
+  "properties": {
+    "propertyPack": {
+      "properties": {
+        "completionAndMoving": {
+          "properties": {
+            "reasonForSale": {
+              "ntsRef": "A1.5.7.2",
+              "type": "string"
+            }
+          },
+          "required": [
+            "reasonForSale"
+          ],
+          "ntsRef": "A1.5.7"
+        }
+      },
+      "ntsRef": "0"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v3/overlays/extensions/rs.json",
+  "$comment": "Reason for sale, asked alongside the onward-chain question"
+}

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

@@ -25917,6 +25917,10 @@
                 }
               ]
             },
+            "reasonForSale": {
+              "title": "What is the reason for the sale?",
+              "type": "string"
+            },
             "moveRestrictionDates": {
               "title": "Are there any dates on which you cannot move?",
               "description": "Note that: the moving date will not be fixed until contracts are exchanged i.e. have become binding, until then you should only make provisional removal arrangements; you do not need to be physically present on the day of completion so long as the property is cleared; timescales to completion vary depending on the complexity of the transaction, length of the chain and requirements of the people involved.",

package/src/schemas/v3/skeleton.json

@@ -3457,6 +3457,7 @@
           "postcode": "string"
         }
       },
+      "reasonForSale": "string",
       "moveRestrictionDates": {
         "yesNo": "variant",
         "details": "string"

package/src/schemas/v4/Gift.json

@@ -6,10 +6,10 @@
   "description": "A gift of funds towards a purchase, made by a giftor. Implies the Giftor role.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/Offer.json

@@ -6,10 +6,10 @@
   "description": "An offer made by a prospective buyer in a property transaction.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/Organisation.json

@@ -6,10 +6,10 @@
   "description": "A legal entity (company, firm, partnership) participating in a property transaction.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/Person.json

@@ -6,10 +6,10 @@
   "description": "A natural person participating in a property transaction — name, contact details, address, verification status.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "name": {

package/src/schemas/v4/Property.json

@@ -6,10 +6,10 @@
   "description": "Physical and environmental facts about a property — address, construction, fixtures, services, searches, documents. Excludes ownership, titles, and participants.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "address": {
@@ -20351,6 +20351,10 @@
             }
           ]
         },
+        "reasonForSale": {
+          "title": "What is the reason for the sale?",
+          "type": "string"
+        },
         "moveRestrictionDates": {
           "title": "Are there any dates on which you cannot move?",
           "ta6ed6Title": "Do you have any special requirements about a moving date?",

package/src/schemas/v4/PropertyTitleLink.json

@@ -6,10 +6,10 @@
   "description": "A standing assertion that a property (UPRN) is related to a title. Many-to-many: one UPRN can sit on several titles, and one title (a block freehold, say) can cover many UPRNs. Issued by HM Land Registry for a registered title, and by the seller's conveyancer, on the epitome of title, for unregistered land. References no Transaction: a Transaction selects the titles being sold from the linked titles through titlesToBeSold, and a linked title it does not select is related but not sold.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/Representation.json

@@ -6,10 +6,10 @@
   "description": "A professional representation relationship — one party instructed by another, e.g. a conveyancer acting for a seller. One entity per (representative, represented party) pair: a conveyancer instructed jointly by two sellers yields two, and sellers who instruct separate conveyancers yield one each.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/SellerCapacity.json

@@ -6,10 +6,10 @@
   "description": "The legal capacity in which a seller is selling a given title. Derived from the V3 participants 'Seller' branch (sellersCapacity, dateBecameOwnerOrAuthority).",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/Title.json

@@ -6,10 +6,10 @@
   "description": "HM Land Registry title — register extract, tenure type, and legal interest details for a single title number.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "titleNumber": {

package/src/schemas/v4/Transaction.json

@@ -6,10 +6,10 @@
   "description": "Transaction-level metadata — status, milestones, chain, contracts, offers, enquiries, and sale context.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "transactionId": {

package/src/schemas/v4/TransactionRole.json

@@ -6,10 +6,10 @@
   "description": "A party's role in a transaction, where no more specific relationship credential applies. Asserts participation in a role, not a relationship to another named party.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "properties": {
     "id": {

package/src/schemas/v4/mapping.json

@@ -5,10 +5,10 @@
   "generator": "src/utils/generateV4Schemas.js",
   "source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.33",
+    "packageVersion": "3.6.0-dev.34",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "52ce2e5cb67b32ad9e80d6aae2bb7f5baf842d2ea7190ded5e23df72a0dae91b"
+    "combinedSha256": "f8c2923c6622efd0082de3da056fa305e0463f43dba4f679509c3d82715f5e39"
   },
   "entities": {
     "Property": {

package/src/utils/extractExtensionOverlays.js

@@ -29,6 +29,18 @@ function getRefConfig(refType) {
       enumKey: "sef25Enum",
     };
   }
+  if (refType === "rsRef") {
+    // Reason-for-sale extension (not on any published form) also appears as
+    // ntsRef in output, so it scopes alongside nts2023 + oc
+    return {
+      ref: "rsRef",
+      outputRef: "ntsRef",
+      required: "rsRequired",
+      title: "rsTitle",
+      description: "rsDescription",
+      enumKey: "rsEnum",
+    };
+  }
   // For other ref types, derive keys by replacing "Ref" suffix
   return {
     ref: refType,
@@ -186,6 +198,16 @@ const extensionMappings = {
     ],
   },
 
+  // Reason for sale (opt-in, alongside the onward-chain question)
+  rs: {
+    name: "reasonForSale",
+    description: "Reason for sale, asked alongside the onward-chain question",
+    refType: "rsRef",
+    paths: [
+      "/properties/propertyPack/properties/completionAndMoving/properties/reasonForSale",
+    ],
+  },
+
   // Private supply costs (water & sewerage)
   sc: {
     name: "supplyCosts",

package/src/utils/extractOverlay.js

@@ -46,7 +46,7 @@ const extractFields = [
   "sef25",
 ];
 
-const metadataFields = [...extractFields, "ta6ed6Compat"];
+const metadataFields = [...extractFields, "ta6ed6Compat", "rs"];
 
 const flattenSkeleton = (schema) => {
   if (!schema) return undefined;