npm - @pdtf/schemas - Versions diffs - 3.2.1-12 → 3.2.1-14 - Mend

@pdtf/schemas 3.2.1-12 → 3.2.1-14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/package.json +1 -1
package/src/examples/v3/exampleTransaction.json +55 -1
package/src/schemas/v3/combined.json +89 -0
package/src/schemas/v3/pdtf-transaction.json +113 -0
package/src/schemas/v3/skeleton.json +19 -0
package/src/tests/v3/transactionSchema.test.js +7 -0

package/package.json CHANGED Viewed

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

package/src/examples/v3/exampleTransaction.json CHANGED Viewed

@@ -976,5 +976,59 @@
         "contentTypes": ["Environmental Risks"]
       }
     ]
-  }
+  },
+  "contracts": [
+    {
+      "contract": {
+        "template": {
+          "name": "Example Agency Agreement",
+          "url": "https://example.com/example-agency-agreement",
+          "externalIds": {
+            "Moverly": "file123"
+          },
+          "requiredSignatories": [
+            {
+              "role": "Seller",
+              "requiresAll": true
+            }
+          ]
+        },
+        "terms": {
+          "propertyAddress": "123 Maple Street, London, SW1A 1AA",
+          "sellersNames": "Peter and Clarissa Hetherington-Smythe",
+          "sellersContactAddress": "47 Park Road, Harpenden, AL3 5AF",
+          "sellersTelephoneNumber": "07700 900123",
+          "sellersEmail": "peter.hetherington-smyth@email.com",
+          "typeOfAgency": "Sole Agency",
+          "feeAsPercent": "1.5%",
+          "fixedFeeExVat": "£2,500",
+          "estimatedFeeIncludingVat": "£3,000",
+          "includeAdditionalChargeEpc": true,
+          "additionalChargeForEpcExVat": "75",
+          "includeAdditionalChargeForEpcAndFloorplan": true,
+          "additionalChargeForEpcAndFloorplanExVat": "150",
+          "includeAdditionalChargeForEpcFloorplanAndPhotos": true,
+          "additionalChargeForEpcFloorplanAndPhotosExVat": "150",
+          "includeAdditionalChargeForPremiumPhotos ": true,
+          "additionalChargeForPremiumPhotosExVat": "150",
+          "includeAdditionalChargeForBrochure": true,
+          "additionalChargeForBrochureExVat": "150",
+          "includeAdditionalChargeForBespokeAdvertising": true,
+          "additionalChargeForBespokeAdvertisingExVat": "150",
+          "initialMarketingPrice": "£450,000"
+        }
+      },
+      "signatures": [
+        {
+          "name": "Peter Ronald Hetherington-Smythe",
+          "signedOn": "2024-11-29T16:15:02.735Z",
+          "externalIds": {
+            "Moverly": "123434"
+          },
+          "role": "Seller",
+          "contractHash": "IYnBjUI8TauXFop6WCvnPA=="
+        }
+      ]
+    }
+  ]
 }

package/src/schemas/v3/combined.json CHANGED Viewed

@@ -39316,6 +39316,95 @@
           }
         }
       }
+    },
+    "contracts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "contract": {
+            "type": "object",
+            "required": ["template", "terms"],
+            "properties": {
+              "template": {
+                "type": "object",
+                "required": ["name", "url", "requiredSignatories"],
+                "properties": {
+                  "name": { "type": "string" },
+                  "url": { "type": "string", "format": "uri" },
+                  "externalIds": {
+                    "type": "object"
+                  },
+                  "requiredSignatories": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "role": {
+                          "type": "string",
+                          "enum": [
+                            "Seller",
+                            "Seller's Conveyancer",
+                            "Prospective Buyer",
+                            "Buyer",
+                            "Buyer's Conveyancer",
+                            "Estate Agent",
+                            "Buyer's Agent",
+                            "Surveyor",
+                            "Mortgage Broker",
+                            "Lender",
+                            "Landlord",
+                            "Tenant"
+                          ]
+                        },
+                        "requiresAll": { "type": "boolean" }
+                      }
+                    }
+                  }
+                }
+              },
+              "terms": {
+                "type": "object"
+              }
+            }
+          },
+          "signatures": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["name", "signedOn", "role", "contractHash"],
+              "properties": {
+                "name": { "type": "string" },
+                "signedOn": { "type": "string", "format": "date-time" },
+                "externalIds": {
+                  "type": "object"
+                }
+              },
+              "role": {
+                "type": "string",
+                "enum": [
+                  "Seller",
+                  "Seller's Conveyancer",
+                  "Prospective Buyer",
+                  "Buyer",
+                  "Buyer's Conveyancer",
+                  "Estate Agent",
+                  "Buyer's Agent",
+                  "Surveyor",
+                  "Mortgage Broker",
+                  "Lender",
+                  "Landlord",
+                  "Tenant"
+                ]
+              },
+              "contractHash": {
+                "title": "An MD5 hash of the stable-stringified contract object being signed",
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
     }
   }
 }

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

@@ -34120,6 +34120,119 @@
           }
         }
       }
+    },
+    "contracts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "contract": {
+            "type": "object",
+            "required": [
+              "template",
+              "terms"
+            ],
+            "properties": {
+              "template": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "url",
+                  "requiredSignatories"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "url": {
+                    "type": "string",
+                    "format": "uri"
+                  },
+                  "externalIds": {
+                    "type": "object"
+                  },
+                  "requiredSignatories": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "role": {
+                          "type": "string",
+                          "enum": [
+                            "Seller",
+                            "Seller's Conveyancer",
+                            "Prospective Buyer",
+                            "Buyer",
+                            "Buyer's Conveyancer",
+                            "Estate Agent",
+                            "Buyer's Agent",
+                            "Surveyor",
+                            "Mortgage Broker",
+                            "Lender",
+                            "Landlord",
+                            "Tenant"
+                          ]
+                        },
+                        "requiresAll": {
+                          "type": "boolean"
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "terms": {
+                "type": "object"
+              }
+            }
+          },
+          "signatures": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "name",
+                "signedOn",
+                "role",
+                "contractHash"
+              ],
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "signedOn": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "externalIds": {
+                  "type": "object"
+                }
+              },
+              "role": {
+                "type": "string",
+                "enum": [
+                  "Seller",
+                  "Seller's Conveyancer",
+                  "Prospective Buyer",
+                  "Buyer",
+                  "Buyer's Conveyancer",
+                  "Estate Agent",
+                  "Buyer's Agent",
+                  "Surveyor",
+                  "Mortgage Broker",
+                  "Lender",
+                  "Landlord",
+                  "Tenant"
+                ]
+              },
+              "contractHash": {
+                "title": "An MD5 hash of the stable-stringified contract object being signed",
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
     }
   }
 }

package/src/schemas/v3/skeleton.json CHANGED Viewed

@@ -4095,5 +4095,24 @@
         "pricingMethodology": {}
       }
     }
+  },
+  "contracts": {
+    "contract": {
+      "template": {
+        "name": {},
+        "url": {},
+        "externalIds": {},
+        "requiredSignatories": {
+          "role": {},
+          "requiresAll": {}
+        }
+      },
+      "terms": {}
+    },
+    "signatures": {
+      "name": {},
+      "signedOn": {},
+      "externalIds": {}
+    }
   }
 }

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

@@ -396,3 +396,10 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
     )
   ).toBe("Please provide their full names and ages.");
 });
+test("validates a valid contract", () => {
+  const path = "/contracts";
+  const data = jp.get(exampleTransaction, path);
+  const validator = getSubschemaValidator(path, exampleTransaction.$schema);
+  const isValid = validator(data);
+  expect(isValid).toBe(true);
+});