@pdtf/schemas 3.6.0-5 → 3.6.0-8

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 (7) hide show
  1. package/package.json +3 -2
  2. package/src/schemas/v3/combined.json +345 -17
  3. package/src/schemas/v3/compactSkeleton.txt +38 -9
  4. package/src/schemas/v3/pdtf-transaction.json +418 -21
  5. package/src/schemas/v3/skeleton.json +57 -9
  6. package/src/tests/v3/offers.test.js +37 -40
  7. package/src/tests/v3/patternProperties.test.js +26 -30
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.6.0-5",
3
+ "version": "3.6.0-8",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -8,7 +8,8 @@
8
8
  },
9
9
  "scripts": {
10
10
  "test": "jest",
11
- "test:watch": "jest --watch"
11
+ "test:watch": "jest --watch",
12
+ "extract-overlays": "cd src/utils && node extractOverlay.js"
12
13
  },
13
14
  "repository": {
14
15
  "type": "git",
package/src/schemas/v3/combined.json CHANGED
@@ -20,7 +20,22 @@
20
20
  "type": "string"
21
21
  },
22
22
  "externalIds": {
23
- "type": "object"
23
+ "type": "object",
24
+ "patternProperties": {
25
+ ".*": {
26
+ "oneOf": [
27
+ { "type": "string" },
28
+ { "type": "number" },
29
+ { "type": "boolean" },
30
+ {
31
+ "type": "object",
32
+ "patternProperties": {
33
+ ".*": {}
34
+ }
35
+ }
36
+ ]
37
+ }
38
+ }
24
39
  },
25
40
  "status": {
26
41
  "type": "string",
@@ -185,7 +200,22 @@
185
200
  ]
186
201
  },
187
202
  "externalIds": {
188
- "type": "object"
203
+ "type": "object",
204
+ "patternProperties": {
205
+ ".*": {
206
+ "oneOf": [
207
+ { "type": "string" },
208
+ { "type": "number" },
209
+ { "type": "boolean" },
210
+ {
211
+ "type": "object",
212
+ "patternProperties": {
213
+ ".*": {}
214
+ }
215
+ }
216
+ ]
217
+ }
218
+ }
189
219
  },
190
220
  "participantStatus": {
191
221
  "type": "string",
@@ -27220,7 +27250,22 @@
27220
27250
  "format": "date-time"
27221
27251
  },
27222
27252
  "externalIds": {
27223
- "type": "object"
27253
+ "type": "object",
27254
+ "patternProperties": {
27255
+ ".*": {
27256
+ "oneOf": [
27257
+ { "type": "string" },
27258
+ { "type": "number" },
27259
+ { "type": "boolean" },
27260
+ {
27261
+ "type": "object",
27262
+ "patternProperties": {
27263
+ ".*": {}
27264
+ }
27265
+ }
27266
+ ]
27267
+ }
27268
+ }
27224
27269
  }
27225
27270
  }
27226
27271
  }
@@ -39929,7 +39974,22 @@
39929
39974
  "minLength": 1
39930
39975
  },
39931
39976
  "externalIds": {
39932
- "type": "object"
39977
+ "type": "object",
39978
+ "patternProperties": {
39979
+ ".*": {
39980
+ "oneOf": [
39981
+ { "type": "string" },
39982
+ { "type": "number" },
39983
+ { "type": "boolean" },
39984
+ {
39985
+ "type": "object",
39986
+ "patternProperties": {
39987
+ ".*": {}
39988
+ }
39989
+ }
39990
+ ]
39991
+ }
39992
+ }
39933
39993
  },
39934
39994
  "isDeleted": {
39935
39995
  "type": "boolean"
@@ -41576,7 +41636,22 @@
41576
41636
  "name": { "type": "string" },
41577
41637
  "url": { "type": "string", "format": "uri" },
41578
41638
  "externalIds": {
41579
- "type": "object"
41639
+ "type": "object",
41640
+ "patternProperties": {
41641
+ ".*": {
41642
+ "oneOf": [
41643
+ { "type": "string" },
41644
+ { "type": "number" },
41645
+ { "type": "boolean" },
41646
+ {
41647
+ "type": "object",
41648
+ "patternProperties": {
41649
+ ".*": {}
41650
+ }
41651
+ }
41652
+ ]
41653
+ }
41654
+ }
41580
41655
  },
41581
41656
  "requiredSignatories": {
41582
41657
  "type": "array",
@@ -41620,7 +41695,22 @@
41620
41695
  "name": { "type": "string" },
41621
41696
  "signedOn": { "type": "string", "format": "date-time" },
41622
41697
  "externalIds": {
41623
- "type": "object"
41698
+ "type": "object",
41699
+ "patternProperties": {
41700
+ ".*": {
41701
+ "oneOf": [
41702
+ { "type": "string" },
41703
+ { "type": "number" },
41704
+ { "type": "boolean" },
41705
+ {
41706
+ "type": "object",
41707
+ "patternProperties": {
41708
+ ".*": {}
41709
+ }
41710
+ }
41711
+ ]
41712
+ }
41713
+ }
41624
41714
  }
41625
41715
  },
41626
41716
  "role": {
@@ -41666,7 +41756,22 @@
41666
41756
  "type": "string"
41667
41757
  },
41668
41758
  "externalIds": {
41669
- "type": "object"
41759
+ "type": "object",
41760
+ "patternProperties": {
41761
+ ".*": {
41762
+ "oneOf": [
41763
+ { "type": "string" },
41764
+ { "type": "number" },
41765
+ { "type": "boolean" },
41766
+ {
41767
+ "type": "object",
41768
+ "patternProperties": {
41769
+ ".*": {}
41770
+ }
41771
+ }
41772
+ ]
41773
+ }
41774
+ }
41670
41775
  },
41671
41776
  "address": {
41672
41777
  "title": "Address",
@@ -41743,7 +41848,22 @@
41743
41848
  "type": "string"
41744
41849
  },
41745
41850
  "externalIds": {
41746
- "type": "object"
41851
+ "type": "object",
41852
+ "patternProperties": {
41853
+ ".*": {
41854
+ "oneOf": [
41855
+ { "type": "string" },
41856
+ { "type": "number" },
41857
+ { "type": "boolean" },
41858
+ {
41859
+ "type": "object",
41860
+ "patternProperties": {
41861
+ ".*": {}
41862
+ }
41863
+ }
41864
+ ]
41865
+ }
41866
+ }
41747
41867
  },
41748
41868
  "address": {
41749
41869
  "title": "Address",
@@ -41941,21 +42061,214 @@
41941
42061
  "status": {
41942
42062
  "type": "string",
41943
42063
  "enum": [
41944
- "pending",
41945
- "withdrawn",
41946
- "rejected",
41947
- "accepted",
41948
- "noteOfInterest"
42064
+ "Pending",
42065
+ "Withdrawn",
42066
+ "Rejected",
42067
+ "Accepted",
42068
+ "Note of Interest"
41949
42069
  ]
41950
42070
  },
41951
42071
  "inclusions": { "type": "array", "items": { "type": "string" } },
41952
42072
  "exclusions": { "type": "array", "items": { "type": "string" } },
41953
42073
  "conditions": { "type": "array", "items": { "type": "string" } },
41954
42074
  "externalIds": {
41955
- "type": "object"
42075
+ "type": "object",
42076
+ "patternProperties": {
42077
+ ".*": {
42078
+ "oneOf": [
42079
+ { "type": "string" },
42080
+ { "type": "number" },
42081
+ { "type": "boolean" },
42082
+ {
42083
+ "type": "object",
42084
+ "patternProperties": {
42085
+ ".*": {}
42086
+ }
42087
+ }
42088
+ ]
42089
+ }
42090
+ }
42091
+ },
42092
+ "buyerCircumstances": {
42093
+ "title": "Buyer circumstances",
42094
+ "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
42095
+ "type": "object",
42096
+ "properties": {
42097
+ "intendedUse": {
42098
+ "type": "string",
42099
+ "title": "Intended use of property",
42100
+ "enum": [
42101
+ "Owner occupied",
42102
+ "Buy-to-let",
42103
+ "Holiday let",
42104
+ "Second home"
42105
+ ]
42106
+ },
42107
+ "firstTimeBuyer": {
42108
+ "type": "boolean",
42109
+ "title": "First-time buyer"
42110
+ },
42111
+ "rightToBuy": {
42112
+ "type": "boolean",
42113
+ "title": "Right to Buy purchase"
42114
+ },
42115
+ "ltdCompanyPurchase": {
42116
+ "type": "boolean",
42117
+ "title": "Limited company purchase"
42118
+ },
42119
+ "numberOfOwners": {
42120
+ "type": "integer",
42121
+ "title": "Number of owners",
42122
+ "nullable": true
42123
+ },
42124
+ "numberOfExpats": {
42125
+ "type": "integer",
42126
+ "title": "Number of expat buyers",
42127
+ "nullable": true
42128
+ },
42129
+ "giftedEquity": {
42130
+ "type": "boolean",
42131
+ "title": "Gifted equity"
42132
+ },
42133
+ "numberOfGiftedDeposits": {
42134
+ "type": "integer",
42135
+ "title": "Number of gifted deposits",
42136
+ "nullable": true
42137
+ },
42138
+ "requiresMortgage": {
42139
+ "type": "string",
42140
+ "title": "Requires mortgage",
42141
+ "enum": ["Yes", "No"]
42142
+ }
42143
+ },
42144
+ "discriminator": {
42145
+ "propertyName": "requiresMortgage"
42146
+ },
42147
+ "required": ["requiresMortgage"],
42148
+ "oneOf": [
42149
+ {
42150
+ "properties": {
42151
+ "requiresMortgage": {
42152
+ "enum": ["No"]
42153
+ }
42154
+ }
42155
+ },
42156
+ {
42157
+ "properties": {
42158
+ "requiresMortgage": {
42159
+ "enum": ["Yes"]
42160
+ },
42161
+ "helpToBuyEquityLoan": {
42162
+ "type": "boolean",
42163
+ "title": "Help to Buy equity loan"
42164
+ },
42165
+ "armedForcesHelpToBuy": {
42166
+ "type": "boolean",
42167
+ "title": "Armed Forces Help to Buy"
42168
+ },
42169
+ "numberOfHelpToBuyIsas": {
42170
+ "type": "integer",
42171
+ "title": "Number of Help to Buy ISAs",
42172
+ "nullable": true
42173
+ },
42174
+ "bridgingFinanceRepresentation": {
42175
+ "type": "string",
42176
+ "title": "Bridging finance representation",
42177
+ "enum": ["Dual", "Separate"],
42178
+ "nullable": true
42179
+ },
42180
+ "depositAmount": {
42181
+ "type": "number",
42182
+ "title": "Deposit amount",
42183
+ "minimum": 0
42184
+ },
42185
+ "loanToValue": {
42186
+ "type": "number",
42187
+ "title": "Loan-to-Value (LTV)",
42188
+ "minimum": 0,
42189
+ "maximum": 100
42190
+ },
42191
+ "numberOfBorrowers": {
42192
+ "type": "integer",
42193
+ "title": "Number of borrowers",
42194
+ "minimum": 1,
42195
+ "maximum": 4,
42196
+ "default": 1
42197
+ },
42198
+ "jointProprietorSoleMortgagor": {
42199
+ "type": "boolean",
42200
+ "title": "Joint proprietor, sole mortgagor"
42201
+ },
42202
+ "soleProprietorJointMortgagor": {
42203
+ "type": "boolean",
42204
+ "title": "Sole proprietor, joint mortgagor"
42205
+ },
42206
+ "deedOfPostponement": {
42207
+ "type": "boolean",
42208
+ "title": "Deed of postponement required"
42209
+ },
42210
+ "separateRepresentation": {
42211
+ "type": "boolean",
42212
+ "title": "Separate legal representation required",
42213
+ "nullable": true
42214
+ },
42215
+ "oldestBorrowerAge": {
42216
+ "type": "integer",
42217
+ "title": "Oldest borrower age",
42218
+ "minimum": 18,
42219
+ "maximum": 85
42220
+ },
42221
+ "mortgageTerm": {
42222
+ "type": "integer",
42223
+ "title": "Mortgage term",
42224
+ "minimum": 5,
42225
+ "maximum": 40
42226
+ },
42227
+ "adverseCredit": {
42228
+ "type": "string",
42229
+ "title": "Adverse credit",
42230
+ "enum": ["No", "Yes", "Prefer not to say"]
42231
+ },
42232
+ "employmentType": {
42233
+ "type": "string",
42234
+ "title": "Employment type",
42235
+ "enum": [
42236
+ "Employed",
42237
+ "Self-employed",
42238
+ "Retired",
42239
+ "Contractor",
42240
+ "Other"
42241
+ ]
42242
+ },
42243
+ "existingMortgagedProperties": {
42244
+ "type": "integer",
42245
+ "title": "Existing mortgaged properties",
42246
+ "minimum": 0
42247
+ },
42248
+ "annualIncome": {
42249
+ "type": "number",
42250
+ "title": "Annual gross income",
42251
+ "minimum": 0
42252
+ },
42253
+ "residencyStatus": {
42254
+ "type": "string",
42255
+ "title": "Residency status",
42256
+ "enum": [
42257
+ "UK citizen",
42258
+ "Permanent resident",
42259
+ "Visa holder",
42260
+ "Non-resident"
42261
+ ]
42262
+ },
42263
+ "nominatedLender": {
42264
+ "type": "string",
42265
+ "title": "Nominated lender"
42266
+ }
42267
+ }
42268
+ }
42269
+ ]
41956
42270
  }
41957
- },
41958
- "required": ["amount", "currency", "status"]
42271
+ }
41959
42272
  }
41960
42273
  }
41961
42274
  },
@@ -42039,7 +42352,22 @@
42039
42352
  }
42040
42353
  },
42041
42354
  "externalIds": {
42042
- "type": "object"
42355
+ "type": "object",
42356
+ "patternProperties": {
42357
+ ".*": {
42358
+ "oneOf": [
42359
+ { "type": "string" },
42360
+ { "type": "number" },
42361
+ { "type": "boolean" },
42362
+ {
42363
+ "type": "object",
42364
+ "patternProperties": {
42365
+ ".*": {}
42366
+ }
42367
+ }
42368
+ ]
42369
+ }
42370
+ }
42043
42371
  }
42044
42372
  },
42045
42373
  "required": ["subject", "status", "messages"],
package/src/schemas/v3/compactSkeleton.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  transactionId
2
- externalIds
2
+ externalIds{*}
3
3
  status
4
4
  participants[
5
5
  name
@@ -26,7 +26,7 @@
26
26
  organisation
27
27
  organisationReference
28
28
  role
29
- externalIds
29
+ externalIds{*}
30
30
  participantStatus
31
31
  verification
32
32
  identity
@@ -2330,7 +2330,7 @@
2330
2330
  sellerSignatures[
2331
2331
  name
2332
2332
  signedOn
2333
- externalIds
2333
+ externalIds{*}
2334
2334
  ]
2335
2335
  localSearches
2336
2336
  localLandCharges[
@@ -3294,7 +3294,7 @@
3294
3294
  fileName
3295
3295
  mimeType
3296
3296
  documentType
3297
- externalIds
3297
+ externalIds{*}
3298
3298
  isDeleted
3299
3299
  summary
3300
3300
  ]
@@ -4043,7 +4043,7 @@
4043
4043
  template
4044
4044
  name
4045
4045
  url
4046
- externalIds
4046
+ externalIds{*}
4047
4047
  requiredSignatories[
4048
4048
  role
4049
4049
  requiresAll
@@ -4052,13 +4052,13 @@
4052
4052
  signatures[
4053
4053
  name
4054
4054
  signedOn
4055
- externalIds
4055
+ externalIds{*}
4056
4056
  ]
4057
4057
  ]
4058
4058
  chain
4059
4059
  onwardPurchase[
4060
4060
  transactionId
4061
- externalIds
4061
+ externalIds{*}
4062
4062
  address
4063
4063
  buildingNumber
4064
4064
  buildingName
@@ -4103,7 +4103,36 @@
4103
4103
  inclusions[]
4104
4104
  exclusions[]
4105
4105
  conditions[]
4106
- externalIds
4106
+ externalIds{*}
4107
+ buyerCircumstances
4108
+ intendedUse
4109
+ firstTimeBuyer
4110
+ rightToBuy
4111
+ ltdCompanyPurchase
4112
+ numberOfOwners
4113
+ numberOfExpats
4114
+ giftedEquity
4115
+ numberOfGiftedDeposits
4116
+ requiresMortgage
4117
+ helpToBuyEquityLoan
4118
+ armedForcesHelpToBuy
4119
+ numberOfHelpToBuyIsas
4120
+ bridgingFinanceRepresentation
4121
+ depositAmount
4122
+ loanToValue
4123
+ numberOfBorrowers
4124
+ jointProprietorSoleMortgagor
4125
+ soleProprietorJointMortgagor
4126
+ deedOfPostponement
4127
+ separateRepresentation
4128
+ oldestBorrowerAge
4129
+ mortgageTerm
4130
+ adverseCredit
4131
+ employmentType
4132
+ existingMortgagedProperties
4133
+ annualIncome
4134
+ residencyStatus
4135
+ nominatedLender
4107
4136
  enquiries{*}
4108
4137
  subject
4109
4138
  status
@@ -4112,5 +4141,5 @@
4112
4141
  originatorRole
4113
4142
  destinationRole
4114
4143
  messageText
4115
- externalIds
4144
+ externalIds{*}
4116
4145
  resolutionCondition