@pdtf/schemas 3.4.1-8 → 3.5.1-1

package/src/schemas/v3/skeleton.json

@@ -32,28 +32,6 @@
       "role": "variant",
       "externalIds": {},
       "participantStatus": "string",
-      "verification": {
-        "identity": {
-          "result": "string",
-          "reports": [
-            {
-              "reportName": "string",
-              "result": "string",
-              "details": "string"
-            }
-          ]
-        },
-        "antiMoneyLaundering": {
-          "result": "string",
-          "reports": [
-            {
-              "reportName": "string",
-              "result": "string",
-              "details": "string"
-            }
-          ]
-        }
-      },
       "sellersCapacity": {
         "capacity": "variant",
         "sellersCapacityDetails": "string",

package/src/schemas/verifiedClaims/README.md

@@ -1,12 +1,21 @@
 ## README
 
 ### About verified claims
-`pdtf-verified-claims.json` describes the schema container in which we store property `claims` and their corresponding `verification`.  
+`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". 
+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: 
+### Terms of Use
+The schema supports an optional `terms_of_use` object to control access to verified claims based on confidentiality levels:
+
+* **Public**: No access restrictions (`allowed_roles: []`)
+* **Restricted**: Requires some participant role but not specifically defined (`allowed_roles: []`)
+* **Confidential**: Specific roles defined for access control (e.g., `allowed_roles: ["Seller's Conveyancer", "Buyer's Conveyancer"]`)
+
+The `allowed_roles` array accepts any of the participant roles defined in [pdtf-transaction.json](../v3/pdtf-transaction.json).
+
+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/verifiedClaims/pdtf-verified-claims.json

@@ -374,6 +374,11 @@
           "description": "The semantic version of the schema used to validate the claims",
           "type": "string"
         },
+        "timestamp": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Unix timestamp in milliseconds when the verified claims were created"
+        },
         "verification": {
           "type": "object",
           "properties": {
@@ -406,6 +411,22 @@
           },
           "minProperties": 1,
           "additionalProperties": false
+        },
+        "terms_of_use": {
+          "type": "object",
+          "properties": {
+            "confidentiality_level": {
+              "type": "string",
+              "enum": ["public", "restricted", "confidential"]
+            },
+            "allowed_roles": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
         }
       },
       "required": ["verification", "claims"],

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

@@ -126,3 +126,70 @@ test("returns an empty array of errors for verified claim with multiple valid pa
   };
   expect(validateVerifiedClaims([clonedVouch], v3SchemaId, null)).toEqual([]);
 });
+
+test("returns an empty array for valid terms_of_use object with confidential level", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "confidential",
+    allowed_roles: ["Seller's Conveyancer", "Buyer's Conveyancer"]
+  };
+  expect(validateVerifiedClaims([clonedVouch])).toEqual([]);
+});
+
+test("returns an empty array for valid terms_of_use with public confidentiality", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "public",
+    allowed_roles: []
+  };
+  expect(validateVerifiedClaims([clonedVouch])).toEqual([]);
+});
+
+test("returns an empty array for valid terms_of_use with restricted level", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "restricted",
+    allowed_roles: []
+  };
+  expect(validateVerifiedClaims([clonedVouch])).toEqual([]);
+});
+
+test("returns errors for invalid confidentiality_level in terms_of_use", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "invalid_level",
+    allowed_roles: ["Seller's Conveyancer"]
+  };
+  const errors = validateVerifiedClaims([clonedVouch]);
+  expect(errors).toHaveLength(1);
+  expect(errors[0]).toHaveLength(1);
+  expect(errors[0][0].instancePath).toBe("/verified_claims/0/terms_of_use/confidentiality_level");
+  expect(errors[0][0].keyword).toBe("enum");
+});
+
+test("returns errors for invalid allowed_roles type in terms_of_use", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "confidential",
+    allowed_roles: "not_an_array"
+  };
+  const errors = validateVerifiedClaims([clonedVouch]);
+  expect(errors).toHaveLength(1);
+  expect(errors[0]).toHaveLength(1);
+  expect(errors[0][0].instancePath).toBe("/verified_claims/0/terms_of_use/allowed_roles");
+  expect(errors[0][0].keyword).toBe("type");
+});
+
+test("returns errors for additional properties in terms_of_use", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.terms_of_use = {
+    confidentiality_level: "confidential",
+    allowed_roles: ["Estate Agent"],
+    extra_property: "should_not_be_allowed"
+  };
+  const errors = validateVerifiedClaims([clonedVouch]);
+  expect(errors).toHaveLength(1);
+  expect(errors[0]).toHaveLength(1);
+  expect(errors[0][0].instancePath).toBe("/verified_claims/0/terms_of_use");
+  expect(errors[0][0].keyword).toBe("additionalProperties");
+});

package/src/utils/extractOverlay.js

@@ -287,4 +287,4 @@ fs.writeFileSync(
   "../schemas/v3/compactSkeleton.txt",
   compactSkeleton
 );
-console.log("Compact Skeleton written to ../schemas/v3/compactSkeleton.txt");
+console.log("Compact Skeleton written to ../schemas/v3/compactSkeleton.txt");

package/src/schemas/v3/property-transaction-milestones.json

@@ -1,91 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Transaction Milestones",
-  "description": "Schema for tracking transaction milestones throughout the conveyancing process",
-  "type": "object",
-  "properties": {
-    "listed": {
-      "type": "object",
-      "properties": {
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "legalForms": {
-      "type": "object",
-      "properties": {
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "soldSubjectToContract": {
-      "type": "object",
-      "properties": {
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "searches": {
-      "type": "object",
-      "properties": {
-        "ordered": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "expected": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "enquiries": {
-      "type": "object",
-      "properties": {
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "exchangeOfContracts": {
-      "type": "object",
-      "properties": {
-        "expected": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "completion": {
-      "type": "object",
-      "properties": {
-        "started": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "expected": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "completed": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    }
-  }
-}