@pdtf/schemas 3.2.0-2 → 3.2.0-3

package/src/schemas/v3/skeleton.json

@@ -7,17 +7,23 @@
       "firstName": {},
       "middleName": {},
       "lastName": {},
+      "maidenName": {},
       "preferredName": {}
     },
     "dateOfBirth": {},
     "phone": {},
     "email": {},
     "address": {
+      "buildingNumber": {},
+      "buildingName": {},
+      "subBuilding": {},
+      "street": {},
       "line1": {},
       "line2": {},
       "line 3": {},
       "town": {},
       "postcode": {},
+      "homeNation": {},
       "countryCode": {}
     },
     "organisation": {},
@@ -32,11 +38,17 @@
   },
   "propertyPack": {
     "address": {
+      "buildingNumber": {},
+      "buildingName": {},
+      "subBuilding": {},
+      "street": {},
       "line1": {},
       "line2": {},
       "line3": {},
       "town": {},
-      "postcode": {}
+      "postcode": {},
+      "homeNation": {},
+      "countryCode": {}
     },
     "uprn": {},
     "location": {
@@ -81,6 +93,14 @@
       "mediaUrl": {},
       "caption": {}
     },
+    "saleAtUndervalue": {},
+    "hasHelpToBuyEquityLoan": {},
+    "isHMO": {},
+    "isStudentAccommodation": {},
+    "numberOfSellers": {},
+    "numberOfNonUkResidentSellers": {},
+    "isFirstRegistration": {},
+    "isLimitedCompanySale": {},
     "buildInformation": {
       "building": {
         "builtForm": {},
@@ -782,6 +802,7 @@
             "reserveFund": {
               "yesNo": {},
               "details": {},
+              "contributionIncludedInServiceCharge": {},
               "sufficentToCoverSection20Expenditure": {
                 "yesNo": {},
                 "details": {}
@@ -1007,10 +1028,18 @@
         "yesNo": {}
       },
       "controlledParking": {
-        "yesNo": {}
+        "yesNo": {},
+        "annualCostOfPermit": {}
+      },
+      "vehicleTypeRestriction": {
+        "yesNo": {},
+        "details": {}
       },
       "electricVehicleChargingPoint": {
         "yesNo": {}
+      },
+      "locatedInUlez": {
+        "yesNo": {}
       }
     },
     "listingAndConservation": {
@@ -1970,6 +1999,14 @@
         },
         "dateToBeConnected": {}
       },
+      "heatPump": {
+        "yesNo": {},
+        "details": {},
+        "supplier": {},
+        "dateInstalled": {},
+        "attachments": {},
+        "dateToBeConnected": {}
+      },
       "otherSources": {
         "yesNo": {},
         "details": {},
@@ -2194,9 +2231,6 @@
       }
     },
     "insurance": {
-      "isInsured": {},
-      "details": {},
-      "landlordInsuresIfFlat": {},
       "difficultiesObtainingInsurance": {
         "abnormalRiseInPremiums": {
           "yesNo": {},
@@ -2215,6 +2249,9 @@
           "details": {}
         }
       },
+      "isInsured": {},
+      "details": {},
+      "landlordInsuresIfFlat": {},
       "insuranceClaims": {
         "yesNo": {},
         "details": {}
@@ -3968,6 +4005,13 @@
             }
           }
         }
+      },
+      "additionalDocuments": {
+        "documentType": {},
+        "documentTypeCode": {},
+        "documentDate": {},
+        "retrievedOn": {},
+        "filedUnder": {}
       }
     },
     "searches": {

package/src/schemas/verifiedClaims/README.md

@@ -0,0 +1,12 @@
+## README
+
+### About verified claims
+`pdtf-verified-claims.json` describes the schema container in which we store property `claims` and their corresponding `verification`.  
+
+This schema structure is strongly influenced by OpenID Connect for Identity Assurance 1.0's way of storing "verified claims". 
+
+More Details from the OIDC page which describes the details the nature of `verification` and `claims` objects: https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-representing-verified-claim
+
+Notes: 
+* For PDTF Schema, all data included in the `claims` object must adhere to [pdtf-transaction.json (v3)](../v3/pdtf-transaction.json)
+* For verification, there is more freedom in terms of the type of data that can currently be provided, see the documentation in the OIDC link above for details and examples.

package/src/schemas/{v1 → verifiedClaims}/pdtf-verified-claims.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://trust.propdata.org.uk/schemas/v1/pdtf-verified-claims.json",
+  "$id": "https://trust.propdata.org.uk/schemas/verifiedClaims/pdtf-verified-claims.json",
   "definitions": {
     "date_type": {
       "type": "string",

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

@@ -22,14 +22,14 @@ test("exports a property pack schema, v3 with no overlay by default", () => {
   // expect(testSchema.$id).toEqual(
   //   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json"
   // );
-  expect(testSchema.properties.propertyPack.properties.baspiRef).toEqual(
+  expect(testSchema.properties.propertyPack.properties.baspi5Ref).toEqual(
     undefined
   );
 });
 
 test("sample is valid BASPI", () => {
   const testSchema = getTransactionSchema(schemaId, ["baspiV4"]);
-  expect(testSchema.properties.propertyPack.baspiRef).toEqual("0");
+  expect(testSchema.properties.propertyPack.baspi4Ref).toEqual("0");
   const validator = getValidator(schemaId, ["baspiV4"]);
   const isValid = validator(exampleTransaction);
   if (!isValid) console.log(validator.errors);
@@ -201,9 +201,9 @@ test("correctly gets a subschema with multiple overlays", () => {
   const subschema = getSubschema(
     "/propertyPack/parking/parkingArrangements",
     schemaId,
-    ["baspiV4", "ta6ed4"]
+    ["baspiV5", "ta6ed4"]
   );
-  expect(subschema.baspiRef).toBe("A1.6.0");
+  expect(subschema.baspi5Ref).toBe("A1.6.0");
   expect(subschema.ta6Ref).toBe("9.1");
 });
 

package/src/utils/extractOverlay.js

@@ -7,7 +7,8 @@ const merge = require("deepmerge");
 const combinedSchema = require("../schemas/v3/combined.json");
 
 const extractFields = [
-  "baspi",
+  "baspi4",
+  "baspi5",
   "nts",
   "ntsl",
   "ta6",