@dvsa/cvs-type-definitions 1.0.11

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 (33) hide show
  1. package/README.md +53 -0
  2. package/json-schemas/.DS_Store +0 -0
  3. package/json-schemas/activity/index.json +62 -0
  4. package/json-schemas/defect-category-reference-data/index.json +440 -0
  5. package/json-schemas/defect-details/index.json +265 -0
  6. package/json-schemas/defect-location/index.json +49 -0
  7. package/json-schemas/reason-item/index.json +17 -0
  8. package/json-schemas/tech-record/index.json +639 -0
  9. package/json-schemas/test/index.json +1843 -0
  10. package/json-schemas/test-result/index.json +636 -0
  11. package/json-schemas/test-station/index.json +67 -0
  12. package/json-schemas/test-type/index.json +479 -0
  13. package/json-schemas/vehicle/index.json +1804 -0
  14. package/json-schemas/vehicle-tech-record/index.json +683 -0
  15. package/json-schemas/visit/index.json +1895 -0
  16. package/lib/schemas.d.ts +1 -0
  17. package/lib/schemas.js +18 -0
  18. package/lib/src/schema-validation/schema-validator.d.ts +3 -0
  19. package/lib/src/schema-validation/schema-validator.js +22 -0
  20. package/package.json +35 -0
  21. package/types/activity/index.d.ts +23 -0
  22. package/types/defect-category-reference-data/index.d.ts +52 -0
  23. package/types/defect-details/index.d.ts +53 -0
  24. package/types/defect-location/index.d.ts +16 -0
  25. package/types/reason-item/index.d.ts +11 -0
  26. package/types/tech-record/index.d.ts +202 -0
  27. package/types/test/index.d.ts +353 -0
  28. package/types/test-result/index.d.ts +136 -0
  29. package/types/test-station/index.d.ts +23 -0
  30. package/types/test-type/index.d.ts +98 -0
  31. package/types/vehicle/index.d.ts +345 -0
  32. package/types/vehicle-tech-record/index.d.ts +212 -0
  33. package/types/visit/index.d.ts +366 -0
package/json-schemas/tech-record/index.json ADDED
@@ -0,0 +1,639 @@
1
+ {
2
+ "title": "Tech Record Schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "bodyType": {
6
+ "properties": {
7
+ "code": {
8
+ "type": "string"
9
+ },
10
+ "description": {
11
+ "type": "string"
12
+ }
13
+ },
14
+ "additionalProperties": false,
15
+ "required": [
16
+ "code",
17
+ "description"
18
+ ]
19
+ },
20
+ "manufactureYear": {
21
+ "type": "integer"
22
+ },
23
+ "regnDate": {
24
+ "type": "string"
25
+ },
26
+ "ntaNumber": {
27
+ "type": "string"
28
+ },
29
+ "conversionRefNo": {
30
+ "type": "string"
31
+ },
32
+ "speedLimiterMrk": {
33
+ "type": "boolean"
34
+ },
35
+ "tachoExemptMrk": {
36
+ "type": "boolean"
37
+ },
38
+ "reasonForCreation": {
39
+ "type": "string"
40
+ },
41
+ "statusCode": {
42
+ "type": "string"
43
+ },
44
+ "grossKerbWeight": {
45
+ "type": "integer"
46
+ },
47
+ "grossLadenWeight": {
48
+ "type": "integer"
49
+ },
50
+ "noOfAxles": {
51
+ "type": "integer"
52
+ },
53
+ "brakeCode": {
54
+ "type": "string"
55
+ },
56
+ "vehicleType": {
57
+ "type": "string"
58
+ },
59
+ "euVehicleCategory": {
60
+ "type": "string"
61
+ },
62
+ "axles": {
63
+ "type": "array",
64
+ "items": {
65
+ "title": "Axle Schema",
66
+ "type": "object",
67
+ "properties": {
68
+ "parkingBrakeMrk": {
69
+ "type": "boolean"
70
+ },
71
+ "axleNumber": {
72
+ "type": "integer"
73
+ },
74
+ "weights": {
75
+ "title": "Weights Schema",
76
+ "type": "object",
77
+ "properties": {
78
+ "kerbWeight": {
79
+ "type": "integer"
80
+ },
81
+ "ladenWeight": {
82
+ "type": "integer"
83
+ },
84
+ "gbWeight": {
85
+ "type": "integer"
86
+ },
87
+ "designWeight": {
88
+ "type": "integer"
89
+ }
90
+ },
91
+ "additionalProperties": false,
92
+ "required": [
93
+ "gbWeight",
94
+ "designWeight"
95
+ ]
96
+ },
97
+ "tyres": {
98
+ "title": "Tyres Schema",
99
+ "type": "object",
100
+ "properties": {
101
+ "tyreSize": {
102
+ "type": "string"
103
+ },
104
+ "plyRating": {
105
+ "type": "string"
106
+ },
107
+ "fitmentCode": {
108
+ "type": "string"
109
+ },
110
+ "dataTrPsvAxles": {
111
+ "type": "integer"
112
+ },
113
+ "tyreCode": {
114
+ "type": "number"
115
+ },
116
+ "dataTrAxles": {
117
+ "type": "number"
118
+ },
119
+ "speedCategorySymbol": {
120
+ "description": "PSV only",
121
+ "type": "string"
122
+ }
123
+ },
124
+ "additionalProperties": false,
125
+ "required": [
126
+ "tyreSize",
127
+ "plyRating",
128
+ "fitmentCode",
129
+ "tyreCode"
130
+ ]
131
+ },
132
+ "brakes": {
133
+ "title": "Axle Brake Properties Schema",
134
+ "type": "object",
135
+ "properties": {
136
+ "brakeActuator": {
137
+ "type": "integer"
138
+ },
139
+ "leverLength": {
140
+ "type": "integer"
141
+ },
142
+ "springBrakeParking": {
143
+ "type": "boolean"
144
+ }
145
+ },
146
+ "required": [
147
+ "brakeActuator",
148
+ "leverLength",
149
+ "springBrakeParking"
150
+ ],
151
+ "additionalProperties": false
152
+ }
153
+ },
154
+ "required": [
155
+ "axleNumber",
156
+ "tyres"
157
+ ],
158
+ "additionalProperties": false
159
+ },
160
+ "additionalProperties": false
161
+ },
162
+ "vehicleClass": {
163
+ "title": "Vehicle Class Schema",
164
+ "type": "object",
165
+ "properties": {
166
+ "code": {
167
+ "type": "string"
168
+ },
169
+ "description": {
170
+ "type": "string"
171
+ }
172
+ },
173
+ "additionalProperties": false,
174
+ "required": [
175
+ "code",
176
+ "description"
177
+ ]
178
+ },
179
+ "vehicleSubclass": {
180
+ "type": "array",
181
+ "items": {
182
+ "type": "string"
183
+ }
184
+ },
185
+ "vehicleConfiguration": {
186
+ "type": "string"
187
+ },
188
+ "recordCompleteness": {
189
+ "type": "string"
190
+ },
191
+ "chassisMake": {
192
+ "type": "string"
193
+ },
194
+ "chassisModel": {
195
+ "type": "string"
196
+ },
197
+ "bodyMake": {
198
+ "type": "string"
199
+ },
200
+ "bodyModel": {
201
+ "type": "string"
202
+ },
203
+ "vehicleSize": {
204
+ "type": "string"
205
+ },
206
+ "coifDate": {
207
+ "type": "string"
208
+ },
209
+ "unladenWeight": {
210
+ "type": "integer"
211
+ },
212
+ "grossGbWeight": {
213
+ "type": "integer"
214
+ },
215
+ "grossDesignWeight": {
216
+ "type": "integer"
217
+ },
218
+ "grossUnladenWeight": {
219
+ "type": "integer"
220
+ },
221
+ "seatsLowerDeck": {
222
+ "type": "integer"
223
+ },
224
+ "seatsUpperDeck": {
225
+ "type": "integer"
226
+ },
227
+ "standingCapacity": {
228
+ "type": "integer"
229
+ },
230
+ "speedRestriction": {
231
+ "type": "integer"
232
+ },
233
+ "dispensations": {
234
+ "type": "string"
235
+ },
236
+ "remarks": {
237
+ "type": "string"
238
+ },
239
+ "brakes": {
240
+ "title": "Brake",
241
+ "type": "object",
242
+ "properties": {
243
+ "brakeCode": {
244
+ "type": "string"
245
+ },
246
+ "dataTrBrakeOne": {
247
+ "type": "string"
248
+ },
249
+ "dataTrBrakeTwo": {
250
+ "type": "string"
251
+ },
252
+ "dataTrBrakeThree": {
253
+ "type": "string"
254
+ },
255
+ "retarderBrakeOne": {
256
+ "type": "string"
257
+ },
258
+ "retarderBrakeTwo": {
259
+ "type": "string"
260
+ },
261
+ "brakeCodeOriginal": {
262
+ "type": "string"
263
+ },
264
+ "brakeForceWheelsNotLocked": {
265
+ "title": "Brake Force Wheel",
266
+ "type": "object",
267
+ "properties": {
268
+ "serviceBrakeForce": {
269
+ "type": "integer"
270
+ },
271
+ "secondaryBrakeForce": {
272
+ "type": "integer"
273
+ },
274
+ "parkingBrakeForce": {
275
+ "type": "integer"
276
+ }
277
+ },
278
+ "required": [
279
+ "serviceBrakeForce",
280
+ "secondaryBrakeForce",
281
+ "parkingBrakeForce"
282
+ ],
283
+ "additionalProperties": false
284
+ },
285
+ "brakeForceWheelsUpToHalfLocked": {
286
+ "title": "Brake Force Wheel",
287
+ "type": "object",
288
+ "properties": {
289
+ "serviceBrakeForce": {
290
+ "type": "integer"
291
+ },
292
+ "secondaryBrakeForce": {
293
+ "type": "integer"
294
+ },
295
+ "parkingBrakeForce": {
296
+ "type": "integer"
297
+ }
298
+ },
299
+ "required": [
300
+ "serviceBrakeForce",
301
+ "secondaryBrakeForce",
302
+ "parkingBrakeForce"
303
+ ],
304
+ "additionalProperties": false
305
+ },
306
+ "dtpNumber": {
307
+ "type": "string"
308
+ },
309
+ "loadSensingValve": {
310
+ "type": "boolean"
311
+ },
312
+ "antilockBrakingSystem": {
313
+ "type": "boolean"
314
+ }
315
+ },
316
+ "additionalProperties": false
317
+ },
318
+ "make": {
319
+ "type": "string"
320
+ },
321
+ "model": {
322
+ "type": "string"
323
+ },
324
+ "functionCode": {
325
+ "type": "string"
326
+ },
327
+ "typeUseCode": {
328
+ "type": "string"
329
+ },
330
+ "roadFriendly": {
331
+ "type": "boolean"
332
+ },
333
+ "drawbarCouplingFitted": {
334
+ "type": "boolean"
335
+ },
336
+ "dimensions": {
337
+ "title": "Dimensions Schema",
338
+ "type": "object",
339
+ "properties": {
340
+ "length": {
341
+ "type": "integer"
342
+ },
343
+ "width": {
344
+ "type": "integer"
345
+ },
346
+ "axleSpacing": {
347
+ "type": "array",
348
+ "items": {
349
+ "properties": {
350
+ "axles": {
351
+ "type": "string"
352
+ },
353
+ "value": {
354
+ "type": "integer"
355
+ }
356
+ },
357
+ "required": [
358
+ "axles",
359
+ "value"
360
+ ],
361
+ "additionalProperties": false
362
+ },
363
+ "minItems": 1,
364
+ "maxItems": 1
365
+ }
366
+ },
367
+ "required": [
368
+ "length",
369
+ "width",
370
+ "axleSpacing"
371
+ ],
372
+ "additionalProperties": false
373
+ },
374
+ "notes": {
375
+ "type": "string"
376
+ },
377
+ "adrDetails": {
378
+ "title": "ADR Details Schema",
379
+ "type": "object",
380
+ "properties": {
381
+ "vehicleDetails": {
382
+ "type": "object",
383
+ "properties": {
384
+ "type": {
385
+ "type": "string"
386
+ },
387
+ "approvalDate": {
388
+ "type": "string"
389
+ }
390
+ },
391
+ "additionalProperties": false
392
+ },
393
+ "listStatementApplicable": {
394
+ "type": "boolean"
395
+ },
396
+ "batteryListNumber": {
397
+ "type": "string"
398
+ },
399
+ "permittedDangerousGoods": {
400
+ "type": "array",
401
+ "items": {
402
+ "type": "string"
403
+ }
404
+ },
405
+ "additionalExaminerNotes": {
406
+ "type": "string"
407
+ },
408
+ "applicantDetails": {
409
+ "title": "Applicant Details Schema",
410
+ "type": "object",
411
+ "properties": {
412
+ "name": {
413
+ "type": "string"
414
+ },
415
+ "street": {
416
+ "type": "string"
417
+ },
418
+ "town": {
419
+ "type": "string"
420
+ },
421
+ "city": {
422
+ "type": "string"
423
+ },
424
+ "postcode": {
425
+ "type": "string"
426
+ }
427
+ },
428
+ "additionalProperties": false
429
+ },
430
+ "memosApply": {
431
+ "type": "array",
432
+ "items": {
433
+ "type": "string"
434
+ }
435
+ },
436
+ "additionalNotes": {
437
+ "type": "object",
438
+ "properties": {
439
+ "number": {
440
+ "type": "array",
441
+ "items": {
442
+ "type": "string"
443
+ }
444
+ },
445
+ "guidanceNotes": {
446
+ "type": "array",
447
+ "items": {
448
+ "type": "string"
449
+ }
450
+ }
451
+ },
452
+ "additionalProperties": false
453
+ },
454
+ "adrTypeApprovalNo": {
455
+ "type": "string"
456
+ },
457
+ "compatibilityGroupJ": {
458
+ "type": "boolean"
459
+ },
460
+ "tank": {
461
+ "title": "Tank Schema",
462
+ "type": "object",
463
+ "properties": {
464
+ "tankDetails": {
465
+ "title": "Tank Details Schema",
466
+ "type": "object",
467
+ "properties": {
468
+ "tankManufacturer": {
469
+ "type": "string"
470
+ },
471
+ "tc2Details": {
472
+ "title": "TC2 Details Schema",
473
+ "type": "object",
474
+ "properties": {
475
+ "tc2Type": {
476
+ "type": "string"
477
+ },
478
+ "tc2IntermediateApprovalNo": {
479
+ "type": "string"
480
+ },
481
+ "tc2IntermediateExpiryDate": {
482
+ "type": "string"
483
+ }
484
+ },
485
+ "additionalProperties": false
486
+ },
487
+ "tc3Details": {
488
+ "type": "array",
489
+ "items": {
490
+ "title": "TC3 Details Schema",
491
+ "type": "object",
492
+ "properties": {
493
+ "tc3Type": {
494
+ "type": "string"
495
+ },
496
+ "tc3IntermediateApprovalNo": {
497
+ "type": "string"
498
+ },
499
+ "tc3IntermediateExpiryDate": {
500
+ "type": "string"
501
+ }
502
+ },
503
+ "additionalProperties": false
504
+ }
505
+ },
506
+ "yearOfManufacture": {
507
+ "type": "string"
508
+ },
509
+ "tankCode": {
510
+ "type": "string"
511
+ },
512
+ "specialProvisions": {
513
+ "type": "string"
514
+ },
515
+ "tankManufacturerSerialNo": {
516
+ "type": "string"
517
+ },
518
+ "tankTypeAppNo": {
519
+ "type": "string"
520
+ }
521
+ },
522
+ "additionalProperties": false
523
+ },
524
+ "tankStatement": {
525
+ "title": "Tank Statement Schema",
526
+ "type": "object",
527
+ "properties": {
528
+ "substancesPermitted": {
529
+ "type": "string"
530
+ },
531
+ "statement": {
532
+ "type": "string"
533
+ },
534
+ "productList": {
535
+ "type": "string"
536
+ },
537
+ "productListRefNo": {
538
+ "type": "string"
539
+ },
540
+ "productListUnNo": {
541
+ "type": "array",
542
+ "items": {
543
+ "type": "string"
544
+ }
545
+ }
546
+ },
547
+ "additionalProperties": false
548
+ }
549
+ },
550
+ "additionalProperties": false
551
+ }
552
+ },
553
+ "additionalProperties": false
554
+ },
555
+ "trainGbWeight": {
556
+ "type": "integer"
557
+ },
558
+ "trainDesignWeight": {
559
+ "type": "integer"
560
+ },
561
+ "maxTrainGbWeight": {
562
+ "type": "integer"
563
+ },
564
+ "maxTrainDesignWeight": {
565
+ "type": "integer"
566
+ },
567
+ "euroStandard": {
568
+ "type": "integer"
569
+ },
570
+ "frontAxleTo5thWheelMin": {
571
+ "type": "integer"
572
+ },
573
+ "frontAxleTo5thWheelMax": {
574
+ "type": "integer"
575
+ },
576
+ "frontAxleTo5thWheelCouplingMin": {
577
+ "type": "integer"
578
+ },
579
+ "frontAxleTo5thWheelCouplingMax": {
580
+ "type": "integer"
581
+ },
582
+ "firstUseDate": {
583
+ "type": "string"
584
+ },
585
+ "maxLoadOnCoupling": {
586
+ "type": "integer"
587
+ },
588
+ "suspensionType": {
589
+ "type": "string"
590
+ },
591
+ "couplingType": {
592
+ "type": "string"
593
+ },
594
+ "frontAxleToRearAxle": {
595
+ "type": "integer"
596
+ },
597
+ "rearAxleToRearTrl": {
598
+ "type": "integer"
599
+ },
600
+ "couplingCenterToRearAxleMin": {
601
+ "type": "integer"
602
+ },
603
+ "couplingCenterToRearAxleMax": {
604
+ "type": "integer"
605
+ },
606
+ "couplingCenterToRearTrlMin": {
607
+ "type": "integer"
608
+ },
609
+ "couplingCenterToRearTrlMax": {
610
+ "type": "integer"
611
+ },
612
+ "numberOfWheelsDriven": {
613
+ "type": "integer"
614
+ }
615
+ },
616
+ "additionalProperties": false,
617
+ "required": [
618
+ "bodyType",
619
+ "regnDate",
620
+ "manufactureYear",
621
+ "ntaNumber",
622
+ "conversionRefNo",
623
+ "speedLimiterMrk",
624
+ "tachoExemptMrk",
625
+ "reasonForCreation",
626
+ "statusCode",
627
+ "grossKerbWeight",
628
+ "grossLadenWeight",
629
+ "noOfAxles",
630
+ "brakeCode",
631
+ "vehicleType",
632
+ "euVehicleCategory",
633
+ "axles",
634
+ "vehicleClass",
635
+ "vehicleSubclass",
636
+ "vehicleConfiguration",
637
+ "notes"
638
+ ]
639
+ }