@pdtf/schemas 3.0.1-6 → 3.0.3-2

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

@@ -19,8 +19,14 @@
       "type": "string",
       "enum": [
         "active",
-        "cancelled",
-        "completed"
+        "For sale",
+        "Under offer",
+        "Sold subject to contract",
+        "Contracts exchanged",
+        "Completed",
+        "Cancelled",
+        "To let",
+        "Let agreed"
       ]
     },
     "participants": {
@@ -118,7 +124,9 @@
               "Buyer's Agent",
               "Surveyor",
               "Mortgage Broker",
-              "Lender"
+              "Lender",
+              "Landlord",
+              "Tenant"
             ]
           },
           "externalIds": {
@@ -351,6 +359,35 @@
             }
           }
         },
+        "lettingInformation": {
+          "title": "Letting information",
+          "type": "object",
+          "properties": {
+            "rent": {
+              "title": "Rent",
+              "type": "number",
+              "minimum": 1
+            },
+            "rentFrequency": {
+              "title": "Rent frequency",
+              "type": "string",
+              "enum": [
+                "Yearly",
+                "Quarterly",
+                "Monthly",
+                "Weekly"
+              ]
+            },
+            "securityDeposit": {
+              "title": "Security deposit",
+              "type": "number"
+            },
+            "holdingDeposit": {
+              "title": "Security deposit",
+              "type": "number"
+            }
+          }
+        },
         "summaryDescription": {
           "title": "Summary description",
           "type": "string"
@@ -7697,7 +7734,6 @@
               "items": {
                 "type": "string",
                 "enum": [
-                  "None",
                   "Level access",
                   "Ramped access",
                   "Lift access",

package/src/schemas/v3/skeleton.json

@@ -64,6 +64,12 @@
       "priceQualifier": {},
       "disposal": {}
     },
+    "lettingInformation": {
+      "rent": {},
+      "rentFrequency": {},
+      "securityDeposit": {},
+      "holdingDeposit": {}
+    },
     "summaryDescription": {},
     "marketingTenure": {},
     "media": {

package/src/tests/v3/transactionSchema.test.js

@@ -43,6 +43,32 @@ test("sample is valid NTS", () => {
   expect(isValid).toBe(true);
 });
 
+test("sample is not valid NTSL (lettings)", () => {
+  const validator = getValidator(schemaId, ["ntsl2023"]);
+  const isValid = validator(exampleTransaction);
+  expect(isValid).toBe(false);
+  expect(validator.errors[0].message).toBe(
+    "must have required property 'lettingInformation'"
+  );
+});
+
+test("sample is valid NTSL if we change it accordingly", () => {
+  const validator = getValidator(schemaId, ["ntsl2023"]);
+  const clonedExampleTransaction = JSON.parse(
+    JSON.stringify(exampleTransaction)
+  );
+  clonedExampleTransaction.propertyPack.lettingInformation = {
+    rent: 3500,
+    rentFrequency: "Monthly",
+    securityDeposit: 5000,
+  };
+  delete clonedExampleTransaction.propertyPack.priceInformation;
+  delete clonedExampleTransaction.propertyPack.ownership;
+  const isValid = validator(clonedExampleTransaction);
+  if (!isValid) console.log(validator.errors);
+  expect(isValid).toBe(true);
+});
+
 test("invalid sample is invalid", () => {
   const clonedExampleTransaction = JSON.parse(
     JSON.stringify(exampleTransaction)

package/src/utils/extractOverlay.js

@@ -9,6 +9,7 @@ const combinedSchema = require("../schemas/v3/combined.json");
 const extractFields = [
   "baspi",
   "nts",
+  "ntsl",
   "ta6",
   "ta7",
   "ta10",
@@ -22,14 +23,6 @@ const extractFields = [
   "oc1",
 ];
 
-const overlayIncludeProperties = [
-  // "title",
-  // "description",
-  // "enum",
-  "discriminator",
-  // "minItems",
-];
-
 const flattenSkeleton = (schema) => {
   if (!schema) return undefined;
   let returnStructure = {};