@pdtf/schemas 3.5.1-2 → 3.5.1-4

package/README.md

@@ -277,6 +277,9 @@ const verifiedClaims = [
         },
       ],
     },
+    terms_of_use: {
+      confidentiality_level: "public",
+    },
     claims: {
       "/propertyPack/priceInformation/price": 350000,
       "/propertyPack/energyEfficiency/epcRating": "C",
@@ -297,6 +300,61 @@ if (errors.length === 0) {
 - **Provenance Tracking** - Each claim includes verification evidence and source attribution
 - **Trust Framework Integration** - Claims operate within the UK PDTF trust framework
 - **Attachment Support** - Supporting documents can be cryptographically linked to claims
+- **Confidentiality Controls** - Terms of use define access levels and permitted recipients
+
+#### Confidentiality Levels
+
+Verified claims support three confidentiality levels through a pdtf-specific extension: a `terms_of_use` field, enabling fine-grained access control:
+
+**Public Data** - Freely accessible data from official sources or public listing information:
+
+```javascript
+{
+  terms_of_use: {
+    confidentiality_level: "public";
+  }
+}
+```
+
+Examples: Land Registry data, Energy Performance Certificates, planning records, council tax information
+
+**Restricted Data** - Limited to transaction participants:
+
+```javascript
+{
+  terms_of_use: {
+    confidentiality_level: "restricted";
+  }
+}
+```
+
+Examples: Commercial property reports, contents of legal forms
+
+**Confidential Data** - Role-based access with explicit authorization:
+
+```javascript
+{
+  terms_of_use: {
+    confidentiality_level: "confidential",
+    allowed_roles: [
+      "Estate Agent",
+      "Seller's Conveyancer",
+      "Buyer's Conveyancer",
+      "Mortgage Broker",
+      "Lender"
+    ]
+  }
+}
+```
+
+Examples: Identity verification reports, anti-money laundering checks, sensitive personal information
+
+**Guidelines:**
+
+- Use **public** for government/official data sources
+- Use **restricted** for commercial data providers and processed information
+- Use **confidential** for sensitive personal data requiring explicit role authorization
+- Always consider data source and sensitivity when assigning levels
 
 **Roadmap - W3C Verifiable Credentials:**
 The next version of the PDTF framework will migrate to [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) to provide:

package/index.js

@@ -208,9 +208,30 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
     if (pathArray.length >= 1) {
       subSchema = pathArray.reduce((schema, pathElement) => {
         if (!schema) return undefined;
-        const { type, items, properties, oneOf } = schema;
+        const { type, items, properties, patternProperties, oneOf } = schema;
+
+        // Check array type
         if (type === "array") return items;
+
+        // Check explicit properties first
         if (properties?.[pathElement]) return properties[pathElement];
+
+        // Check patternProperties
+        if (patternProperties) {
+          for (const pattern in patternProperties) {
+            try {
+              const regex = new RegExp(pattern);
+              if (regex.test(pathElement)) {
+                return patternProperties[pattern];
+              }
+            } catch (e) {
+              // Invalid regex pattern in schema - skip it
+              console.warn(`Invalid regex pattern in patternProperties: ${pattern}`, e);
+            }
+          }
+        }
+
+        // Check oneOf discriminators
         if (oneOf) {
           let matchingProperty;
           oneOf.forEach((aOneOf) => {
@@ -222,6 +243,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
           });
           if (matchingProperty) return matchingProperty;
         }
+
         return undefined;
       }, sourceSchema);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.5.1-2",
+  "version": "3.5.1-4",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/examples/v3/exampleAddParticipantVouch.json

@@ -20,6 +20,9 @@
       }
     ]
   },
+  "terms_of_use": {
+    "confidentiality_level": "restricted"
+  },
   "claims": {
     "/participants/-": {
       "name": {

package/src/examples/v3/exampleDocumentedVouch.json

@@ -32,6 +32,9 @@
       }
     ]
   },
+  "terms_of_use": {
+    "confidentiality_level": "public"
+  },
   "claims": {
     "/propertyPack/councilTax": {
       "councilTaxBand": "D",

package/src/examples/v3/exampleElectronicRecord.json

@@ -21,6 +21,9 @@
       }
     ]
   },
+  "terms_of_use": {
+    "confidentiality_level": "public"
+  },
   "claims": {
     "/propertyPack/address": {
       "line1": "3 The Hollys",

package/src/examples/v3/exampleVouch.json

@@ -21,6 +21,9 @@
       }
     ]
   },
+  "terms_of_use": {
+    "confidentiality_level": "restricted"
+  },
   "claims": {
     "/propertyPack/delayFactors/hasDelayFactors": {
       "yesNo": "No"

package/src/schemas/v3/combined.json

@@ -259,7 +259,6 @@
             "properties": {
               "role": {
                 "enum": [
-                  "Buyer",
                   "Seller's Conveyancer",
                   "Prospective Buyer",
                   "Buyer's Conveyancer",
@@ -274,6 +273,18 @@
               }
             }
           },
+          {
+            "properties": {
+              "role": {
+                "enum": ["Buyer"]
+              },
+              "offerId": {
+                "title": "Reference to an offer in the offers object",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              }
+            }
+          },
           {
             "properties": {
               "role": {
@@ -41777,6 +41788,36 @@
           }
         }
       }
+    },
+    "offers": {
+      "title": "Offers for purchase of the property",
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+      },
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "properties": {
+            "amount": { "type": "number", "minimum": 0 },
+            "currency": { "type": "string", "pattern": "^[A-Z]{3}$" },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "withdrawn",
+                "rejected",
+                "accepted",
+                "noteOfInterest"
+              ]
+            },
+            "inclusions": { "type": "array", "items": { "type": "string" } },
+            "exclusions": { "type": "array", "items": { "type": "string" } },
+            "conditions": { "type": "array", "items": { "type": "string" } }
+          },
+          "required": ["amount", "currency", "status"]
+        }
+      }
     }
   }
 }

package/src/schemas/v3/compactSkeleton.txt

@@ -43,6 +43,7 @@
           result
           details
         ]
+    offerId
     sellersCapacity
       capacity
       sellersCapacityDetails
@@ -4070,4 +4071,5 @@
     completion
       started
       expected
-      completed
+      completed
+  offers

package/src/schemas/v3/overlays/baspi4.json

@@ -17,7 +17,6 @@
             "properties": {
               "role": {
                 "enum": [
-                  "Buyer",
                   "Seller's Conveyancer",
                   "Prospective Buyer",
                   "Buyer's Conveyancer",
@@ -32,6 +31,15 @@
               }
             }
           },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Buyer"
+                ]
+              }
+            }
+          },
           {
             "properties": {
               "role": {

package/src/schemas/v3/overlays/baspi5.json

@@ -17,7 +17,6 @@
             "properties": {
               "role": {
                 "enum": [
-                  "Buyer",
                   "Seller's Conveyancer",
                   "Prospective Buyer",
                   "Buyer's Conveyancer",
@@ -32,6 +31,15 @@
               }
             }
           },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Buyer"
+                ]
+              }
+            }
+          },
           {
             "properties": {
               "role": {

package/src/schemas/v3/overlays/piq.json

@@ -13,7 +13,6 @@
             "properties": {
               "role": {
                 "enum": [
-                  "Buyer",
                   "Seller's Conveyancer",
                   "Prospective Buyer",
                   "Buyer's Conveyancer",
@@ -28,6 +27,15 @@
               }
             }
           },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Buyer"
+                ]
+              }
+            }
+          },
           {
             "properties": {
               "role": {

package/src/schemas/v3/overlays/rds.json

@@ -5,6 +5,7 @@
     "participants": {
       "items": {
         "oneOf": [
+          null,
           null,
           {
             "properties": {

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

@@ -273,7 +273,6 @@
             "properties": {
               "role": {
                 "enum": [
-                  "Buyer",
                   "Seller's Conveyancer",
                   "Prospective Buyer",
                   "Buyer's Conveyancer",
@@ -288,6 +287,20 @@
               }
             }
           },
+          {
+            "properties": {
+              "role": {
+                "enum": [
+                  "Buyer"
+                ]
+              },
+              "offerId": {
+                "title": "Reference to an offer in the offers object",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              }
+            }
+          },
           {
             "properties": {
               "role": {
@@ -37292,6 +37305,61 @@
           }
         }
       }
+    },
+    "offers": {
+      "title": "Offers for purchase of the property",
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+      },
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "properties": {
+            "amount": {
+              "type": "number",
+              "minimum": 0
+            },
+            "currency": {
+              "type": "string",
+              "pattern": "^[A-Z]{3}$"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "withdrawn",
+                "rejected",
+                "accepted",
+                "noteOfInterest"
+              ]
+            },
+            "inclusions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "exclusions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "conditions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "required": [
+            "amount",
+            "currency",
+            "status"
+          ]
+        }
+      }
     }
   }
 }

package/src/schemas/v3/skeleton.json

@@ -54,6 +54,7 @@
           ]
         }
       },
+      "offerId": "string",
       "sellersCapacity": {
         "capacity": "variant",
         "sellersCapacityDetails": "string",
@@ -5178,5 +5179,6 @@
       "expected": "string",
       "completed": "string"
     }
-  }
+  },
+  "offers": {}
 }