@pdtf/schemas 3.5.1-9 → 3.6.0-10

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 (16) hide show
  1. package/.claude/settings.local.json +6 -1
  2. package/index.js +12 -0
  3. package/package.json +3 -2
  4. package/src/schemas/v3/combined.json +569 -15
  5. package/src/schemas/v3/compactSkeleton.txt +75 -8
  6. package/src/schemas/v3/overlays/baspi4.json +3 -0
  7. package/src/schemas/v3/overlays/baspi5.json +3 -0
  8. package/src/schemas/v3/overlays/piq.json +3 -0
  9. package/src/schemas/v3/overlays/rds.json +3 -0
  10. package/src/schemas/v3/pdtf-transaction.json +658 -16
  11. package/src/schemas/v3/skeleton.json +117 -10
  12. package/src/tests/v3/buyerCircumstances.test.js +543 -0
  13. package/src/tests/v3/enquiries.test.js +1096 -0
  14. package/src/tests/v3/offers.test.js +37 -40
  15. package/src/tests/v3/patternProperties.test.js +149 -30
  16. package/src/utils/extractOverlay.js +37 -13
package/src/schemas/v3/skeleton.json CHANGED
@@ -1,6 +1,8 @@
1
1
  {
2
2
  "transactionId": "string",
3
- "externalIds": {},
3
+ "externalIds": {
4
+ "*": {}
5
+ },
4
6
  "status": "string",
5
7
  "participants": [
6
8
  {
@@ -30,10 +32,13 @@
30
32
  "organisation": "string",
31
33
  "organisationReference": "string",
32
34
  "role": "variant",
33
- "externalIds": {},
35
+ "externalIds": {
36
+ "*": {}
37
+ },
34
38
  "participantStatus": "string",
35
39
  "verification": {
36
40
  "identity": {
41
+ "status": "string",
37
42
  "result": "string",
38
43
  "reports": [
39
44
  {
@@ -44,6 +49,18 @@
44
49
  ]
45
50
  },
46
51
  "antiMoneyLaundering": {
52
+ "status": "string",
53
+ "result": "string",
54
+ "reports": [
55
+ {
56
+ "reportName": "string",
57
+ "result": "string",
58
+ "details": "string"
59
+ }
60
+ ]
61
+ },
62
+ "sourceOfFunds": {
63
+ "status": "string",
47
64
  "result": "string",
48
65
  "reports": [
49
66
  {
@@ -249,6 +266,8 @@
249
266
  "ownership": {
250
267
  "numberOfSellers": "integer",
251
268
  "numberOfNonUkResidentSellers": "integer",
269
+ "outstandingMortgage": "string",
270
+ "existingLender": "string",
252
271
  "hasHelpToBuyEquityLoan": "string",
253
272
  "isFirstRegistration": "string",
254
273
  "isLimitedCompanySale": "string",
@@ -2851,7 +2870,18 @@
2851
2870
  },
2852
2871
  "doubleGlazing": {
2853
2872
  "yesNo": "variant",
2854
- "attachments": "string"
2873
+ "attachments": "string",
2874
+ "fensaCertificates": {
2875
+ "certificates": [
2876
+ {
2877
+ "certificateId": "string",
2878
+ "numberOfWindows": "integer",
2879
+ "numberOfDoors": "integer",
2880
+ "certificateIssued": "string",
2881
+ "workCompleted": "string"
2882
+ }
2883
+ ]
2884
+ }
2855
2885
  },
2856
2886
  "electricalRepairOrInstallation": {
2857
2887
  "yesNo": "variant",
@@ -2948,7 +2978,9 @@
2948
2978
  {
2949
2979
  "name": "string",
2950
2980
  "signedOn": "string",
2951
- "externalIds": {}
2981
+ "externalIds": {
2982
+ "*": {}
2983
+ }
2952
2984
  }
2953
2985
  ]
2954
2986
  },
@@ -4255,8 +4287,11 @@
4255
4287
  "fileName": "string",
4256
4288
  "mimeType": "string",
4257
4289
  "documentType": "string",
4258
- "externalIds": {},
4259
- "isDeleted": "boolean"
4290
+ "externalIds": {
4291
+ "*": {}
4292
+ },
4293
+ "isDeleted": "boolean",
4294
+ "summary": {}
4260
4295
  }
4261
4296
  ],
4262
4297
  "surveys": [
@@ -5114,7 +5149,9 @@
5114
5149
  "template": {
5115
5150
  "name": "string",
5116
5151
  "url": "string",
5117
- "externalIds": {},
5152
+ "externalIds": {
5153
+ "*": {}
5154
+ },
5118
5155
  "requiredSignatories": [
5119
5156
  {
5120
5157
  "role": "string",
@@ -5128,7 +5165,9 @@
5128
5165
  {
5129
5166
  "name": "string",
5130
5167
  "signedOn": "string",
5131
- "externalIds": {}
5168
+ "externalIds": {
5169
+ "*": {}
5170
+ }
5132
5171
  }
5133
5172
  ]
5134
5173
  }
@@ -5137,7 +5176,9 @@
5137
5176
  "onwardPurchase": [
5138
5177
  {
5139
5178
  "transactionId": "string",
5140
- "externalIds": {},
5179
+ "externalIds": {
5180
+ "*": {}
5181
+ },
5141
5182
  "address": {
5142
5183
  "buildingNumber": "string",
5143
5184
  "buildingName": "string",
@@ -5186,5 +5227,71 @@
5186
5227
  "completed": "string"
5187
5228
  }
5188
5229
  },
5189
- "offers": {}
5230
+ "offers": {
5231
+ "*": {
5232
+ "amount": "number",
5233
+ "currency": "string",
5234
+ "status": "string",
5235
+ "inclusions": [
5236
+ "string"
5237
+ ],
5238
+ "exclusions": [
5239
+ "string"
5240
+ ],
5241
+ "conditions": [
5242
+ "string"
5243
+ ],
5244
+ "externalIds": {
5245
+ "*": {}
5246
+ },
5247
+ "buyerCircumstances": {
5248
+ "intendedUse": "string",
5249
+ "firstTimeBuyer": "boolean",
5250
+ "rightToBuy": "boolean",
5251
+ "ltdCompanyPurchase": "boolean",
5252
+ "numberOfOwners": "integer",
5253
+ "numberOfExpats": "integer",
5254
+ "giftedEquity": "boolean",
5255
+ "numberOfGiftedDeposits": "integer",
5256
+ "requiresMortgage": "variant",
5257
+ "helpToBuyEquityLoan": "boolean",
5258
+ "armedForcesHelpToBuy": "boolean",
5259
+ "numberOfHelpToBuyIsas": "integer",
5260
+ "bridgingFinanceRepresentation": "string",
5261
+ "depositAmount": "number",
5262
+ "loanToValue": "number",
5263
+ "numberOfBorrowers": "integer",
5264
+ "jointProprietorSoleMortgagor": "boolean",
5265
+ "soleProprietorJointMortgagor": "boolean",
5266
+ "deedOfPostponement": "boolean",
5267
+ "separateRepresentation": "boolean",
5268
+ "oldestBorrowerAge": "integer",
5269
+ "mortgageTerm": "integer",
5270
+ "adverseCredit": "string",
5271
+ "employmentType": "string",
5272
+ "existingMortgagedProperties": "integer",
5273
+ "annualIncome": "number",
5274
+ "residencyStatus": "string",
5275
+ "nominatedLender": "string"
5276
+ }
5277
+ }
5278
+ },
5279
+ "enquiries": {
5280
+ "*": {
5281
+ "subject": "string",
5282
+ "status": "variant",
5283
+ "messages": {
5284
+ "*": {
5285
+ "datetime": "string",
5286
+ "originatorRole": "string",
5287
+ "destinationRole": "string",
5288
+ "messageText": "string"
5289
+ }
5290
+ },
5291
+ "externalIds": {
5292
+ "*": {}
5293
+ },
5294
+ "resolutionCondition": "string"
5295
+ }
5296
+ }
5190
5297
  }