@pdtf/schemas 3.0.1-5 → 3.0.3-1

package/src/schemas/v3/skeleton.json

@@ -64,6 +64,12 @@
       "priceQualifier": {},
       "disposal": {}
     },
+    "lettingInformation": {
+      "rent": {},
+      "rentFrequency": {},
+      "securityDeposit": {},
+      "holdingDeposit": {}
+    },
     "summaryDescription": {},
     "marketingTenure": {},
     "media": {
@@ -1447,97 +1453,110 @@
         "otherItems": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
       "kitchen": {
         "hob": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "extractorHood": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "ovenGrill": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "cooker": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "microwave": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "refrigeratorFridgeFreezer": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "freezer": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "dishwasher": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "tumbleDryer": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "washingMachine": {
           "isIncludedExcludedOrNone": {},
-          "comments": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         },
         "otherItems": {
           "itemName": {},
           "isIncludedOrExcluded": {},
           "fittedOrFreestanding": {
-            "fittedOrFreestanding": {}
+            "isFittedOrFreestanding": {},
+            "comments": {}
           },
-          "price": {}
+          "price": {},
+          "comments": {}
         }
       },
       "bathroom": {
@@ -1631,6 +1650,7 @@
         "otherRooms": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
@@ -1674,6 +1694,7 @@
           "otherRooms": {
             "itemName": {},
             "isIncludedOrExcluded": {},
+            "comments": {},
             "price": {}
           }
         },
@@ -1716,6 +1737,7 @@
           "otherRooms": {
             "itemName": {},
             "isIncludedOrExcluded": {},
+            "comments": {},
             "price": {}
           }
         }
@@ -1759,6 +1781,7 @@
         "otherRooms": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
@@ -1801,6 +1824,7 @@
         "otherRooms": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
@@ -1868,6 +1892,7 @@
         "otherItems": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
@@ -1914,6 +1939,7 @@
         "otherItems": {
           "itemName": {},
           "isIncludedOrExcluded": {},
+          "comments": {},
           "price": {}
         }
       },
@@ -3306,7 +3332,7 @@
                 "yesNo": {},
                 "details": {}
               },
-              "theLocalAuthorityReceivedANoticeOfDisposal": {
+              "lheLocalAuthorityReceivedANoticeOfDisposal": {
                 "yesNo": {},
                 "details": {}
               },

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 = {};
@@ -64,60 +57,43 @@ const extractOverlay = (sourceSchema, ref) => {
     if (path === "/") path = "";
     if (element[refName]) {
       jp.set(returnSchema, `${path}/${refName}`, element[refName]);
-
-      if (element.discriminator) {
-        jp.set(returnSchema, `${path}/discriminator`, element.discriminator);
-        const { propertyName } = element.discriminator;
-        element.oneOf.forEach((oneOf, index) => {
-          const discriminatorProperty = oneOf.properties[propertyName];
-          // must be an enum
-          const discriminatorEnumPath = `${path}/oneOf/${index}/properties/${propertyName}/enum`;
-          // if a refEnum use that
-          const refEnum = `${ref}Enum`;
-          if (discriminatorProperty[refEnum]) {
-            jp.set(
-              returnSchema,
-              discriminatorEnumPath,
-              discriminatorProperty[refEnum]
-            );
-          } else {
-            // use the base enum
-            jp.set(
-              returnSchema,
-              discriminatorEnumPath,
-              discriminatorProperty.enum
-            );
-          }
-        });
-      }
-
-      // also handle discriminator properties nested in items
-      if (element.items?.discriminator) {
-        jp.set(
-          returnSchema,
-          `${path}/items/discriminator`,
-          element.items.discriminator
-        );
-        const { propertyName } = element.items.discriminator;
-        element.items.oneOf.forEach((oneOf, index) => {
-          const discriminatorProperty = oneOf.properties[propertyName];
-          // must be an enum
-          const discriminatorEnumPath = `${path}/items/oneOf/${index}/properties/${propertyName}/enum`;
-          // if a refEnum use that
-          const refEnum = `${ref}Enum`;
-          if (discriminatorProperty[refEnum]) {
+      overlayIncludeProperties.forEach((property) => {
+        if (element[property]) {
+          jp.set(returnSchema, `${path}/${property}`, element[property]);
+        }
+      });
+
+      const { discriminator } = element;
+      if (discriminator) {
+        const { propertyName } = discriminator;
+        element.oneOf.forEach((item, index) => {
+          const discriminatorProperty = item.properties[propertyName];
+          // copy const discriminator as-is
+          if (discriminatorProperty.const) {
             jp.set(
               returnSchema,
-              discriminatorEnumPath,
-              discriminatorProperty[refEnum]
+              `${path}/oneOf/${index}/properties/${propertyName}/const`,
+              discriminatorProperty.const
             );
           } else {
-            // use the base enum
-            jp.set(
-              returnSchema,
-              discriminatorEnumPath,
-              discriminatorProperty.enum
-            );
+            // must be an enum
+            const discriminatorEnumPath = `${path}/oneOf/${index}/properties/${propertyName}/enum`;
+            // if a refEnum use that
+            const refEnum = `${ref}Enum`;
+            if (discriminatorProperty[refEnum]) {
+              jp.set(
+                returnSchema,
+                discriminatorEnumPath,
+                discriminatorProperty[refEnum]
+              );
+            } else {
+              // use the base enum
+              jp.set(
+                returnSchema,
+                discriminatorEnumPath,
+                discriminatorProperty.enum
+              );
+            }
           }
         });
       }