@pdtf/schemas 3.6.0-dev.1 → 3.6.0-dev.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 (53) hide show
  1. package/package.json +9 -1
  2. package/src/schemas/v3/combined.json +662 -178
  3. package/src/schemas/v3/compactSkeleton.txt +63 -0
  4. package/src/schemas/v3/overlays/baspi4.json +43 -73
  5. package/src/schemas/v3/overlays/baspi5.json +43 -73
  6. package/src/schemas/v3/overlays/extensions/ac.json +2 -1
  7. package/src/schemas/v3/overlays/extensions/dk.json +3 -2
  8. package/src/schemas/v3/overlays/extensions/ic.json +44 -9
  9. package/src/schemas/v3/overlays/extensions/lc.json +3 -2
  10. package/src/schemas/v3/overlays/extensions/mi.json +2 -1
  11. package/src/schemas/v3/overlays/extensions/nd.json +3 -2
  12. package/src/schemas/v3/overlays/extensions/pc.json +3 -2
  13. package/src/schemas/v3/overlays/extensions/ph.json +2 -1
  14. package/src/schemas/v3/overlays/extensions/rw.json +4 -3
  15. package/src/schemas/v3/overlays/extensions/sc.json +8 -4
  16. package/src/schemas/v3/overlays/extensions/sd.json +3 -2
  17. package/src/schemas/v3/overlays/extensions/ta.json +0 -48
  18. package/src/schemas/v3/overlays/extensions/tr.json +3 -2
  19. package/src/schemas/v3/overlays/extensions/wg.json +2 -1
  20. package/src/schemas/v3/overlays/llc1.json +1 -2
  21. package/src/schemas/v3/overlays/lpe1.json +1 -1
  22. package/src/schemas/v3/overlays/nts.json +3 -1
  23. package/src/schemas/v3/overlays/nts2.json +3 -1
  24. package/src/schemas/v3/overlays/ntsl.json +3 -1
  25. package/src/schemas/v3/overlays/ntsl2.json +3 -1
  26. package/src/schemas/v3/overlays/piq.json +23 -24
  27. package/src/schemas/v3/overlays/rds.json +22 -49
  28. package/src/schemas/v3/overlays/sef25.json +16 -2
  29. package/src/schemas/v3/overlays/ta10.json +0 -9
  30. package/src/schemas/v3/overlays/ta6.json +37 -69
  31. package/src/schemas/v3/overlays/ta6ed6.json +248 -140
  32. package/src/schemas/v3/overlays/ta7ed5.json +66 -20
  33. package/src/schemas/v3/pdtf-transaction.json +397 -95
  34. package/src/schemas/v3/skeleton.json +70 -5
  35. package/src/utils/extractExtensionOverlays.js +11 -2
  36. package/src/utils/extractOverlay.js +20 -0
  37. package/CLAUDE.md +0 -101
  38. package/docs/backend-lms-profile-filtering-spec.md +0 -180
  39. package/src/examples/v1/exampleAddParticipantVouch.json +0 -32
  40. package/src/examples/v1/exampleDocumentedVouch.json +0 -40
  41. package/src/examples/v1/exampleElectronicRecord.json +0 -30
  42. package/src/examples/v1/exampleTransaction.json +0 -878
  43. package/src/examples/v1/exampleVouch.json +0 -25
  44. package/src/examples/v2/exampleTransaction.json +0 -901
  45. package/src/examples/v3/exampleAddParticipantVouch.json +0 -38
  46. package/src/examples/v3/exampleCustomOverlay.json +0 -55
  47. package/src/examples/v3/exampleCustomOverlay2.json +0 -93
  48. package/src/examples/v3/exampleDocumentedVouch.json +0 -47
  49. package/src/examples/v3/exampleElectronicRecord.json +0 -36
  50. package/src/examples/v3/exampleTransaction.json +0 -1038
  51. package/src/examples/v3/exampleVouch.json +0 -32
  52. package/src/mappings/SendPropertyDetailsRequestSchema.json +0 -1588
  53. package/src/mappings/adf.js +0 -198
package/src/schemas/v3/overlays/extensions/dk.json CHANGED
@@ -21,9 +21,10 @@
21
21
  "required": [
22
22
  "droppedKerbAccess"
23
23
  ],
24
- "ntsRef": "K1"
24
+ "ntsRef": "B4"
25
25
  }
26
- }
26
+ },
27
+ "ntsRef": "0"
27
28
  }
28
29
  },
29
30
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/ic.json CHANGED
@@ -3,9 +3,33 @@
3
3
  "propertyPack": {
4
4
  "properties": {
5
5
  "insurance": {
6
+ "ntsRef": "I1",
7
+ "required": [
8
+ "isInsured"
9
+ ],
10
+ "discriminator": {
11
+ "propertyName": "isInsured"
12
+ },
13
+ "properties": {
14
+ "isInsured": {
15
+ "ntsRef": "I1.2",
16
+ "type": "string"
17
+ }
18
+ },
6
19
  "oneOf": [
7
- null,
8
20
  {
21
+ "properties": {
22
+ "isInsured": {
23
+ "enum": [
24
+ "No"
25
+ ]
26
+ }
27
+ }
28
+ },
29
+ {
30
+ "required": [
31
+ "insuranceClaims"
32
+ ],
9
33
  "properties": {
10
34
  "insuranceClaims": {
11
35
  "ntsRef": "I1.1",
@@ -32,7 +56,15 @@
32
56
  }
33
57
  },
34
58
  {
59
+ "required": [
60
+ "details"
61
+ ],
35
62
  "properties": {
63
+ "details": {
64
+ "ntsRef": "I1.1.2",
65
+ "type": "string",
66
+ "minLength": 1
67
+ },
36
68
  "yesNo": {
37
69
  "enum": [
38
70
  "Yes"
@@ -40,17 +72,20 @@
40
72
  }
41
73
  }
42
74
  }
43
- ],
44
- "type": "object"
75
+ ]
76
+ },
77
+ "isInsured": {
78
+ "enum": [
79
+ "Yes"
80
+ ]
45
81
  }
46
- },
47
- "required": [
48
- "insuranceClaims"
49
- ]
82
+ }
50
83
  }
51
- ]
84
+ ],
85
+ "type": "object"
52
86
  }
53
- }
87
+ },
88
+ "ntsRef": "0"
54
89
  }
55
90
  },
56
91
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/lc.json CHANGED
@@ -64,9 +64,10 @@
64
64
  ]
65
65
  }
66
66
  },
67
- "ntsRef": "S1"
67
+ "ntsRef": "B3.1"
68
68
  }
69
- }
69
+ },
70
+ "ntsRef": "0"
70
71
  }
71
72
  },
72
73
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/mi.json CHANGED
@@ -60,7 +60,8 @@
60
60
  ],
61
61
  "ntsRef": "M1"
62
62
  }
63
- }
63
+ },
64
+ "ntsRef": "0"
64
65
  }
65
66
  },
66
67
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/nd.json CHANGED
@@ -32,9 +32,10 @@
32
32
  "type": "object"
33
33
  }
34
34
  },
35
- "ntsRef": "N1"
35
+ "ntsRef": "C4"
36
36
  }
37
- }
37
+ },
38
+ "ntsRef": "0"
38
39
  }
39
40
  },
40
41
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/pc.json CHANGED
@@ -26,9 +26,10 @@
26
26
  ]
27
27
  }
28
28
  },
29
- "ntsRef": "K1"
29
+ "ntsRef": "B4"
30
30
  }
31
- }
31
+ },
32
+ "ntsRef": "0"
32
33
  }
33
34
  },
34
35
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/ph.json CHANGED
@@ -185,7 +185,8 @@
185
185
  },
186
186
  "type": "object"
187
187
  }
188
- }
188
+ },
189
+ "ntsRef": "0"
189
190
  }
190
191
  },
191
192
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/rw.json CHANGED
@@ -54,12 +54,13 @@
54
54
  "required": [
55
55
  "privateRightOfWay"
56
56
  ],
57
- "ntsRef": "R1"
57
+ "ntsRef": "C2.2.1"
58
58
  }
59
59
  },
60
- "ntsRef": "R1"
60
+ "ntsRef": "C2.2"
61
61
  }
62
- }
62
+ },
63
+ "ntsRef": "0"
63
64
  }
64
65
  },
65
66
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/sc.json CHANGED
@@ -58,7 +58,8 @@
58
58
  }
59
59
  ]
60
60
  }
61
- }
61
+ },
62
+ "ntsRef": "B3.2"
62
63
  },
63
64
  "drainage": {
64
65
  "properties": {
@@ -116,11 +117,14 @@
116
117
  }
117
118
  ]
118
119
  }
119
- }
120
+ },
121
+ "ntsRef": "B3.3"
120
122
  }
121
- }
123
+ },
124
+ "ntsRef": "B3.2"
122
125
  }
123
- }
126
+ },
127
+ "ntsRef": "0"
124
128
  }
125
129
  },
126
130
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/sd.json CHANGED
@@ -52,9 +52,10 @@
52
52
  "required": [
53
53
  "stormFireFloodDamage"
54
54
  ],
55
- "ntsRef": "E1"
55
+ "ntsRef": "C3.1"
56
56
  }
57
- }
57
+ },
58
+ "ntsRef": "0"
58
59
  }
59
60
  },
60
61
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/ta.json CHANGED
@@ -50,54 +50,6 @@
50
50
  "heating": {
51
51
  "ta6ed6CompatRef": "TA6ED6-COMPAT.11.4",
52
52
  "properties": {
53
- "heatingSystem": {
54
- "discriminator": {
55
- "propertyName": "heatingType"
56
- },
57
- "oneOf": [
58
- {
59
- "properties": {
60
- "heatingType": {
61
- "enum": [
62
- "None",
63
- "Room heaters only"
64
- ]
65
- }
66
- }
67
- },
68
- {
69
- "properties": {
70
- "centralHeatingDetails": {
71
- "properties": {
72
- "heatingLastServicedReport": {
73
- "ta6ed6CompatRef": "TA6ED6-COMPAT.11.4.g2",
74
- "enum": [
75
- "Attached",
76
- "To follow"
77
- ],
78
- "type": "string"
79
- }
80
- },
81
- "type": "object"
82
- },
83
- "heatingType": {
84
- "enum": [
85
- "Central heating"
86
- ]
87
- }
88
- }
89
- },
90
- {
91
- "properties": {
92
- "heatingType": {
93
- "enum": [
94
- "Communal heating system"
95
- ]
96
- }
97
- }
98
- }
99
- ]
100
- },
101
53
  "otherHeatingFeatures": {
102
54
  "ta6ed6CompatRef": "TA6ED6-COMPAT.11.4.other",
103
55
  "items": {
package/src/schemas/v3/overlays/extensions/tr.json CHANGED
@@ -62,9 +62,10 @@
62
62
  }
63
63
  }
64
64
  },
65
- "ntsRef": "T1"
65
+ "ntsRef": "A3"
66
66
  }
67
- }
67
+ },
68
+ "ntsRef": "0"
68
69
  }
69
70
  },
70
71
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/extensions/wg.json CHANGED
@@ -341,7 +341,8 @@
341
341
  ],
342
342
  "type": "object"
343
343
  }
344
- }
344
+ },
345
+ "ntsRef": "0"
345
346
  }
346
347
  },
347
348
  "$schema": "http://json-schema.org/draft-07/schema#",
package/src/schemas/v3/overlays/llc1.json CHANGED
@@ -12,8 +12,7 @@
12
12
  "hmlrReference",
13
13
  "registrationDate",
14
14
  "category",
15
- "location",
16
- "locationDominantBuilding"
15
+ "location"
17
16
  ]
18
17
  }
19
18
  }
package/src/schemas/v3/overlays/lpe1.json CHANGED
@@ -1499,7 +1499,7 @@
1499
1499
  "assessmentsCarriedOut": {
1500
1500
  "enum": [
1501
1501
  "Fire risk assessment",
1502
- "External Wall fire risk assessment",
1502
+ "External wall fire risk assessment",
1503
1503
  "Both"
1504
1504
  ]
1505
1505
  },
package/src/schemas/v3/overlays/nts.json CHANGED
@@ -896,7 +896,9 @@
896
896
  "properties": {
897
897
  "yesNo": {
898
898
  "enum": [
899
- "No"
899
+ "No",
900
+ "Not applicable",
901
+ "Not known"
900
902
  ]
901
903
  }
902
904
  }
package/src/schemas/v3/overlays/nts2.json CHANGED
@@ -1060,7 +1060,9 @@
1060
1060
  "properties": {
1061
1061
  "yesNo": {
1062
1062
  "enum": [
1063
- "No"
1063
+ "No",
1064
+ "Not applicable",
1065
+ "Not known"
1064
1066
  ]
1065
1067
  }
1066
1068
  }
package/src/schemas/v3/overlays/ntsl.json CHANGED
@@ -557,7 +557,9 @@
557
557
  "properties": {
558
558
  "yesNo": {
559
559
  "enum": [
560
- "No"
560
+ "No",
561
+ "Not applicable",
562
+ "Not known"
561
563
  ]
562
564
  }
563
565
  }
package/src/schemas/v3/overlays/ntsl2.json CHANGED
@@ -586,7 +586,9 @@
586
586
  "properties": {
587
587
  "yesNo": {
588
588
  "enum": [
589
- "No"
589
+ "No",
590
+ "Not applicable",
591
+ "Not known"
590
592
  ]
591
593
  }
592
594
  }
package/src/schemas/v3/overlays/piq.json CHANGED
@@ -22,7 +22,8 @@
22
22
  "Mortgage Broker",
23
23
  "Lender",
24
24
  "Landlord",
25
- "Tenant"
25
+ "Tenant",
26
+ "Platform Support"
26
27
  ]
27
28
  }
28
29
  }
@@ -1633,7 +1634,8 @@
1633
1634
  "properties": {
1634
1635
  "yesNo": {
1635
1636
  "enum": [
1636
- "Yes"
1637
+ "Yes",
1638
+ "Not known"
1637
1639
  ]
1638
1640
  }
1639
1641
  }
@@ -1948,7 +1950,8 @@
1948
1950
  "properties": {
1949
1951
  "yesNo": {
1950
1952
  "enum": [
1951
- "No"
1953
+ "No",
1954
+ "Not applicable"
1952
1955
  ]
1953
1956
  }
1954
1957
  }
@@ -2016,7 +2019,8 @@
2016
2019
  "properties": {
2017
2020
  "yesNo": {
2018
2021
  "enum": [
2019
- "No"
2022
+ "No",
2023
+ "Not known"
2020
2024
  ]
2021
2025
  }
2022
2026
  }
@@ -2340,8 +2344,7 @@
2340
2344
  "properties": {
2341
2345
  "riskIndicator": {
2342
2346
  "enum": [
2343
- "No",
2344
- "Not known"
2347
+ "No"
2345
2348
  ]
2346
2349
  }
2347
2350
  }
@@ -2637,28 +2640,24 @@
2637
2640
  }
2638
2641
  },
2639
2642
  "ownership": {
2640
- "oneOf": [
2641
- {
2643
+ "properties": {
2644
+ "uniformBoundaries": {
2642
2645
  "properties": {
2643
- "uniformBoundaries": {
2644
- "properties": {
2645
- "left": {
2646
- "piqRef": "B3.1.1"
2647
- },
2648
- "right": {
2649
- "piqRef": "B3.1.2"
2650
- },
2651
- "rear": {
2652
- "piqRef": "B3.1.3"
2653
- },
2654
- "front": {
2655
- "piqRef": "B3.1.4"
2656
- }
2657
- }
2646
+ "left": {
2647
+ "piqRef": "B3.1.1"
2648
+ },
2649
+ "right": {
2650
+ "piqRef": "B3.1.2"
2651
+ },
2652
+ "rear": {
2653
+ "piqRef": "B3.1.3"
2654
+ },
2655
+ "front": {
2656
+ "piqRef": "B3.1.4"
2658
2657
  }
2659
2658
  }
2660
2659
  }
2661
- ]
2660
+ }
2662
2661
  },
2663
2662
  "haveBoundaryFeaturesMoved": {
2664
2663
  "piqRef": "B3.3",
package/src/schemas/v3/overlays/rds.json CHANGED
@@ -1946,7 +1946,8 @@
1946
1946
  "properties": {
1947
1947
  "yesNo": {
1948
1948
  "enum": [
1949
- "Yes"
1949
+ "Yes",
1950
+ "Not known"
1950
1951
  ]
1951
1952
  }
1952
1953
  }
@@ -2128,7 +2129,8 @@
2128
2129
  "properties": {
2129
2130
  "yesNo": {
2130
2131
  "enum": [
2131
- "No"
2132
+ "No",
2133
+ "Not applicable"
2132
2134
  ]
2133
2135
  }
2134
2136
  }
@@ -2180,7 +2182,8 @@
2180
2182
  "properties": {
2181
2183
  "yesNo": {
2182
2184
  "enum": [
2183
- "No"
2185
+ "No",
2186
+ "Not known"
2184
2187
  ]
2185
2188
  }
2186
2189
  }
@@ -2572,8 +2575,7 @@
2572
2575
  "properties": {
2573
2576
  "riskIndicator": {
2574
2577
  "enum": [
2575
- "No",
2576
- "Not known"
2578
+ "No"
2577
2579
  ]
2578
2580
  }
2579
2581
  }
@@ -2895,54 +2897,24 @@
2895
2897
  },
2896
2898
  "ownership": {
2897
2899
  "rdsRef": "Tenure/Boundaries",
2898
- "discriminator": {
2899
- "propertyName": "areBoundariesUniform"
2900
- },
2901
- "oneOf": [
2902
- {
2900
+ "properties": {
2901
+ "uniformBoundaries": {
2903
2902
  "properties": {
2904
- "areBoundariesUniform": {
2905
- "enum": [
2906
- "Yes"
2907
- ]
2903
+ "left": {
2904
+ "rdsRef": "Tenure/Boundaries"
2908
2905
  },
2909
- "uniformBoundaries": {
2910
- "properties": {
2911
- "left": {
2912
- "rdsRef": "Tenure/Boundaries"
2913
- },
2914
- "right": {
2915
- "rdsRef": "Tenure/Boundaries"
2916
- },
2917
- "rear": {
2918
- "rdsRef": "Tenure/Boundaries"
2919
- },
2920
- "front": {
2921
- "rdsRef": "Tenure/Boundaries"
2922
- }
2923
- }
2924
- }
2925
- }
2926
- },
2927
- {
2928
- "properties": {
2929
- "areBoundariesUniform": {
2930
- "enum": [
2931
- "No"
2932
- ]
2933
- }
2934
- }
2935
- },
2936
- {
2937
- "properties": {
2938
- "areBoundariesUniform": {
2939
- "enum": [
2940
- "Not applicable"
2941
- ]
2906
+ "right": {
2907
+ "rdsRef": "Tenure/Boundaries"
2908
+ },
2909
+ "rear": {
2910
+ "rdsRef": "Tenure/Boundaries"
2911
+ },
2912
+ "front": {
2913
+ "rdsRef": "Tenure/Boundaries"
2942
2914
  }
2943
2915
  }
2944
2916
  }
2945
- ]
2917
+ }
2946
2918
  },
2947
2919
  "haveBoundaryFeaturesMoved": {
2948
2920
  "rdsRef": "Tenure/Boundaries",
@@ -3009,7 +2981,8 @@
3009
2981
  "yesNo": {
3010
2982
  "enum": [
3011
2983
  "No",
3012
- "Not applicable"
2984
+ "Not applicable",
2985
+ "Not known"
3013
2986
  ]
3014
2987
  }
3015
2988
  }
package/src/schemas/v3/overlays/sef25.json CHANGED
@@ -1132,8 +1132,14 @@
1132
1132
  "enum": [
1133
1133
  "Yes"
1134
1134
  ]
1135
+ },
1136
+ "details": {
1137
+ "sef25Ref": "I1.1.2"
1135
1138
  }
1136
- }
1139
+ },
1140
+ "required": [
1141
+ "details"
1142
+ ]
1137
1143
  }
1138
1144
  ],
1139
1145
  "required": [
@@ -1150,7 +1156,15 @@
1150
1156
  "insuranceClaims"
1151
1157
  ]
1152
1158
  }
1153
- ]
1159
+ ],
1160
+ "required": [
1161
+ "isInsured"
1162
+ ],
1163
+ "properties": {
1164
+ "isInsured": {
1165
+ "sef25Ref": "I1.2"
1166
+ }
1167
+ }
1154
1168
  },
1155
1169
  "rightsAndInformalArrangements": {
1156
1170
  "sef25Ref": "R1",
package/src/schemas/v3/overlays/ta10.json CHANGED
@@ -1498,15 +1498,6 @@
1498
1498
  }
1499
1499
  }
1500
1500
  }
1501
- },
1502
- {
1503
- "properties": {
1504
- "isIncludedOrExcluded": {
1505
- "enum": [
1506
- "None"
1507
- ]
1508
- }
1509
- }
1510
1501
  }
1511
1502
  ],
1512
1503
  "required": [