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