@pdtf/schemas 3.6.0-dev.22 → 3.6.0-dev.23

package/package.json

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

package/src/schemas/v3/combined.json

@@ -49618,11 +49618,15 @@
                 "intendedUse": {
                   "type": "string",
                   "title": "Intended use of property",
+                  "description": "The primary purpose of the purchase: who will occupy the property, and on what basis. Secondary activities (a home office, a lodger, pets, alterations) are recorded in the separate fields below and are never values of this field, so a home-worker is \"Owner occupied\" with intendsBusiness true.",
                   "enum": [
                     "Owner occupied",
                     "Buy-to-let",
                     "Holiday let",
-                    "Second home"
+                    "Second home",
+                    "Family member occupied",
+                    "Development or renovation",
+                    "Business or mixed-use premises"
                   ]
                 },
                 "firstTimeBuyer": {
@@ -49671,6 +49675,11 @@
                   "title": "Buyer has pets",
                   "description": "Relevant to lease and covenant pet restriction assessment"
                 },
+                "petDetails": {
+                  "type": "string",
+                  "title": "Pets or other animals",
+                  "description": "The pets, horses or other animals the buyer intends to keep at the property, and how many (e.g. \"2 dogs, 1 cat\")"
+                },
                 "intendsSublet": {
                   "type": "boolean",
                   "title": "Buyer intends to sublet",
@@ -49695,6 +49704,16 @@
                   "title": "Buyer intends significant alterations",
                   "description": "Relevant to covenant, planning and building regulations assessment"
                 },
+                "alterationDescription": {
+                  "type": "string",
+                  "title": "Planned alterations",
+                  "description": "What the buyer intends to alter, extend or develop"
+                },
+                "vehicleRequirements": {
+                  "type": "string",
+                  "title": "Vehicles to keep at the property",
+                  "description": "Any caravan, motorhome, commercial vehicle or boat the buyer intends to keep at the property. Relevant to parking and use covenants"
+                },
                 "financingMethod": {
                   "type": "string",
                   "title": "Primary financing method",

package/src/schemas/v3/compactSkeleton.txt

@@ -4518,11 +4518,14 @@
       requiresMortgage
       isAdditionalProperty
       hasPets
+      petDetails
       intendsSublet
       subletType
       intendsBusiness
       businessType
       intendsAlterations
+      alterationDescription
+      vehicleRequirements
       financingMethod
       helpToBuyEquityLoan
       armedForcesHelpToBuy

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

@@ -41645,11 +41645,15 @@
                 "intendedUse": {
                   "type": "string",
                   "title": "Intended use of property",
+                  "description": "The primary purpose of the purchase: who will occupy the property, and on what basis. Secondary activities (a home office, a lodger, pets, alterations) are recorded in the separate fields below and are never values of this field, so a home-worker is \"Owner occupied\" with intendsBusiness true.",
                   "enum": [
                     "Owner occupied",
                     "Buy-to-let",
                     "Holiday let",
-                    "Second home"
+                    "Second home",
+                    "Family member occupied",
+                    "Development or renovation",
+                    "Business or mixed-use premises"
                   ]
                 },
                 "firstTimeBuyer": {
@@ -41701,6 +41705,11 @@
                   "title": "Buyer has pets",
                   "description": "Relevant to lease and covenant pet restriction assessment"
                 },
+                "petDetails": {
+                  "type": "string",
+                  "title": "Pets or other animals",
+                  "description": "The pets, horses or other animals the buyer intends to keep at the property, and how many (e.g. \"2 dogs, 1 cat\")"
+                },
                 "intendsSublet": {
                   "type": "boolean",
                   "title": "Buyer intends to sublet",
@@ -41732,6 +41741,16 @@
                   "title": "Buyer intends significant alterations",
                   "description": "Relevant to covenant, planning and building regulations assessment"
                 },
+                "alterationDescription": {
+                  "type": "string",
+                  "title": "Planned alterations",
+                  "description": "What the buyer intends to alter, extend or develop"
+                },
+                "vehicleRequirements": {
+                  "type": "string",
+                  "title": "Vehicles to keep at the property",
+                  "description": "Any caravan, motorhome, commercial vehicle or boat the buyer intends to keep at the property. Relevant to parking and use covenants"
+                },
                 "financingMethod": {
                   "type": "string",
                   "title": "Primary financing method",

package/src/schemas/v3/skeleton.json

@@ -5780,11 +5780,14 @@
         "requiresMortgage": "variant",
         "isAdditionalProperty": "boolean",
         "hasPets": "boolean",
+        "petDetails": "string",
         "intendsSublet": "boolean",
         "subletType": "string",
         "intendsBusiness": "boolean",
         "businessType": "string",
         "intendsAlterations": "boolean",
+        "alterationDescription": "string",
+        "vehicleRequirements": "string",
         "financingMethod": "string",
         "helpToBuyEquityLoan": "boolean",
         "armedForcesHelpToBuy": "boolean",

package/src/schemas/v4/Gift.json

@@ -6,10 +6,10 @@
   "description": "A gift of funds towards a purchase, made by a gift donor. Implies the Gift Donor role.",
   "x-pdtf-source": {
     "packageName": "@pdtf/schemas",
-    "packageVersion": "3.6.0-dev.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "properties": {
     "id": {
@@ -130,11 +130,15 @@
         "intendedUse": {
           "type": "string",
           "title": "Intended use of property",
+          "description": "The primary purpose of the purchase: who will occupy the property, and on what basis. Secondary activities (a home office, a lodger, pets, alterations) are recorded in the separate fields below and are never values of this field, so a home-worker is \"Owner occupied\" with intendsBusiness true.",
           "enum": [
             "Owner occupied",
             "Buy-to-let",
             "Holiday let",
-            "Second home"
+            "Second home",
+            "Family member occupied",
+            "Development or renovation",
+            "Business or mixed-use premises"
           ]
         },
         "firstTimeBuyer": {
@@ -186,6 +190,11 @@
           "title": "Buyer has pets",
           "description": "Relevant to lease and covenant pet restriction assessment"
         },
+        "petDetails": {
+          "type": "string",
+          "title": "Pets or other animals",
+          "description": "The pets, horses or other animals the buyer intends to keep at the property, and how many (e.g. \"2 dogs, 1 cat\")"
+        },
         "intendsSublet": {
           "type": "boolean",
           "title": "Buyer intends to sublet",
@@ -217,6 +226,16 @@
           "title": "Buyer intends significant alterations",
           "description": "Relevant to covenant, planning and building regulations assessment"
         },
+        "alterationDescription": {
+          "type": "string",
+          "title": "Planned alterations",
+          "description": "What the buyer intends to alter, extend or develop"
+        },
+        "vehicleRequirements": {
+          "type": "string",
+          "title": "Vehicles to keep at the property",
+          "description": "Any caravan, motorhome, commercial vehicle or boat the buyer intends to keep at the property. Relevant to parking and use covenants"
+        },
         "financingMethod": {
           "type": "string",
           "title": "Primary financing method",

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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "properties": {
     "address": {

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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "properties": {
     "transactionId": {
@@ -984,11 +984,15 @@
                 "intendedUse": {
                   "type": "string",
                   "title": "Intended use of property",
+                  "description": "The primary purpose of the purchase: who will occupy the property, and on what basis. Secondary activities (a home office, a lodger, pets, alterations) are recorded in the separate fields below and are never values of this field, so a home-worker is \"Owner occupied\" with intendsBusiness true.",
                   "enum": [
                     "Owner occupied",
                     "Buy-to-let",
                     "Holiday let",
-                    "Second home"
+                    "Second home",
+                    "Family member occupied",
+                    "Development or renovation",
+                    "Business or mixed-use premises"
                   ]
                 },
                 "firstTimeBuyer": {
@@ -1040,6 +1044,11 @@
                   "title": "Buyer has pets",
                   "description": "Relevant to lease and covenant pet restriction assessment"
                 },
+                "petDetails": {
+                  "type": "string",
+                  "title": "Pets or other animals",
+                  "description": "The pets, horses or other animals the buyer intends to keep at the property, and how many (e.g. \"2 dogs, 1 cat\")"
+                },
                 "intendsSublet": {
                   "type": "boolean",
                   "title": "Buyer intends to sublet",
@@ -1071,6 +1080,16 @@
                   "title": "Buyer intends significant alterations",
                   "description": "Relevant to covenant, planning and building regulations assessment"
                 },
+                "alterationDescription": {
+                  "type": "string",
+                  "title": "Planned alterations",
+                  "description": "What the buyer intends to alter, extend or develop"
+                },
+                "vehicleRequirements": {
+                  "type": "string",
+                  "title": "Vehicles to keep at the property",
+                  "description": "Any caravan, motorhome, commercial vehicle or boat the buyer intends to keep at the property. Relevant to parking and use covenants"
+                },
                 "financingMethod": {
                   "type": "string",
                   "title": "Primary financing method",

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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "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.22",
+    "packageVersion": "3.6.0-dev.23",
     "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
     "combinedPath": "src/schemas/v3/combined.json",
-    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+    "combinedSha256": "21df4c6fb2117e9913eb9b16e48c9e6fe5f9ae9988af99e22bfcd4ef4bc6ceab"
   },
   "entities": {
     "Property": {