vtlab-generic-functions 1.0.4

package/validator/joiSchema.js

@@ -0,0 +1,311 @@
+const Joi = require('joi');
+
+module.exports = {
+  /* /orders/retrieve */
+  'orderRetrieveRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderRetrieveResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      'services': Joi.array().items(Joi.object()).min(1).required(),
+      'currentDeliveryFrameFrom': Joi.string().isoDate().required().trim(),
+      'currentDeliveryFrameTo': Joi.string().isoDate().required().trim(),
+      'currentDeliveryFrameTimezone': Joi.string().min(1).max(50).trim(),
+      'serviceLevel': Joi.string().alphanum().max(50).trim(),
+      'requestOrigin': Joi.string().max(20).trim(),
+      'consumer': Joi.object({
+        'personalId': Joi.string().max(24).trim(),
+        'firstName': Joi.string().max(50).required().trim(),
+        'lastName': Joi.string().max(100).trim().allow(''),
+        'email': Joi.string().pattern(/([\x21-\x7E]+)@(\w+)[.](\w+)(([.](\w+))*)/).trim().allow(''),
+        'countryPrefix': Joi.string().pattern(/\+\d{1,5}/).trim(),
+        'phone': Joi.number().integer().max(99999999999999).required(),
+        'alternativeContactName': Joi.string().max(100).allow('').trim(),
+        'alternativeContactPhonePrefix': Joi.string().pattern(/\+\d{1,5}/).allow('').trim(),
+        'alternativeContactPhone': Joi.number().integer().max(99999999999999).allow(''),
+        'notes': Joi.string().max(300).allow('').trim(),
+        'externalCode': Joi.string().max(40).allow('').trim(),
+      }).required(),
+      'deliveryAddress': Joi.object({
+        'street': Joi.string().max(150).required().trim(),
+        'number': Joi.string().max(10).required().trim(),
+        'city': Joi.string().max(50).required().trim(),
+        'region': Joi.string().max(50).required().trim(),
+        'postalCode': Joi.string().max(10).required().trim(),
+        'country': Joi.string().max(30).required().trim(),
+        'countryCode': Joi.string().pattern(/^[A-Z]{0,5}$/).allow('').trim(),
+        'gps': Joi.object({
+          'latitude': Joi.number().precision(8),
+          'longitude': Joi.number().precision(8),
+        }),
+        'additionalInfo': Joi.string().max(150).allow('').trim(),
+        'extraNotes': Joi.string().max(300).allow('').trim(),
+        'googleMapsExtraData': Joi.object(),
+      }).required(),
+      'docReference': Joi.string().max(50).allow('').trim().optional(),
+      'docReferenceDate': Joi.string().isoDate().trim().optional(),
+      'extraInfo': Joi.object(),
+      'customStatus': Joi.string().max(50).allow('').trim().optional(),
+      'marketplace': Joi.object({
+        'uuid': Joi.string().max(50).allow('').trim(),
+        'order': Joi.string().allow('').trim()
+      }),
+      'jobOrigin': Joi.object({
+        'contact': Joi.object({
+          'personalId': Joi.string().max(24).trim(),
+          'firstName': Joi.string().max(50).required().trim(),
+          'lastName': Joi.string().max(100).trim().allow(''),
+          'email': Joi.string().email({minDomainSegments: 2}).max(150).allow('').trim(),
+          'countryPrefix': Joi.string().pattern(/\+\d{1,5}/).required().trim(),
+          'phone': Joi.number().integer().max(99999999999999).required(),
+          'alternativeContactName': Joi.string().max(100).allow('').trim(),
+          'alternativeContactPhonePrefix': Joi.string().pattern(/\+\d{1,5}/).allow('').trim(),
+          'alternativeContactPhone': Joi.number().integer().max(99999999999999).allow(''),
+          'notes': Joi.string().max(300).allow('').trim(),
+          'externalCode': Joi.string().max(40).allow('').trim(),
+        }).required(),
+        'address': Joi.object({
+          'street': Joi.string().max(150).required().trim(),
+          'number': Joi.string().max(10).required().trim(),
+          'city': Joi.string().max(50).required().trim(),
+          'region': Joi.string().max(50).required().trim(),
+          'postalCode': Joi.string().max(10).required().trim(),
+          'country': Joi.string().max(30).required().trim(),
+          'countryCode': Joi.string().pattern(/^[A-Z]{0,5}$/).trim(),
+          'gps': Joi.object({
+            'latitude': Joi.number().precision(8),
+            'longitude': Joi.number().precision(8),
+          }).optional(),
+          'additionalInfo': Joi.string().max(150).allow('').trim(),
+          'extraNotes': Joi.string().max(300).allow('').trim(),
+          'googleMapsExtraData': Joi.object(),
+        }).required(),
+        'from': Joi.string().isoDate().required().trim(),
+        'to': Joi.string().isoDate().required().trim(),
+        'timezone': Joi.string().min(1).max(50).trim(),
+      }).optional(),
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /orders/confirm */
+  'orderConfirmRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderConfirmResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /orders/tracking */
+  'orderTrackingRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderTrackingResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /orders/cancel */
+  'orderCancelRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderCancelResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'message': Joi.string().max(300).allow('').trim()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /orders/new */
+  'orderNewRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderNewResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'message': Joi.string().allow('').trim()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /orders */
+  'orderListRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'orderListResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'trackingId': Joi.string().required(),
+      'label': Joi.string().allow('').optional()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /labels */
+  'labelsListRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'labelsListResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'label': Joi.string().max(50).required()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /pod */
+  'podListRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'podListResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'pod': Joi.string().required()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* /states */
+  'statesListRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'statesListResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().min(1).max(100).required(),
+      'state': Joi.object({
+        'carrier': Joi.string().min(3).max(50).required(),
+        'name': Joi.string().min(1).required(),
+        'code': Joi.string().allow('').optional(),
+        'description': Joi.string().max(500).allow('').optional(),
+        'date': Joi.string().isoDate().required(),
+        'extraInfo': Joi.object().optional(),
+        'timezone': Joi.string().min(1).max(50).trim().optional(),
+      }),
+      'pod': Joi.string().max(50).optional()
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  'dayCloseRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'dayCloseResponse': Joi.object({
+    'Shipments': Joi.array().items({
+      'Origin': Joi.string().required(),
+      'Customer': Joi.string().max(50).required(),
+      'Year': Joi.string().max(50).required(),
+      'Tracking': Joi.string().max(50).required()
+    }).optional(),
+    'Report': Joi.string().required()
+  }),
+  'dayCloseResponseGeneric': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      'reference': Joi.string().optional(),
+      'message': Joi.string().max(300).allow('').trim().optional()
+    }).optional(),
+    'error': Joi.array().optional(),
+    'billOfLanding': Joi.string().optional()
+  }),
+
+  'incidencesResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      '_id': Joi.string().alphanum().min(24).max(24).required(),
+      'CodIncidencia': Joi.string().allow('').optional(),
+      'Descripcion': Joi.string().required(),
+      'Fecha': Joi.string().isoDate().required().trim(),
+    }).optional(),
+    'error': Joi.array().optional()
+  }),
+
+  /* JobEvent */
+  'jobEvent': Joi.object().keys({
+    job: Joi.string().required(),
+    user: Joi.string().required(),
+    usertype: Joi.string().valid('user', 'auto').required(),
+    account: Joi.string().required(),
+    type: Joi.string().optional(),
+    description: Joi.object().keys({
+      es: Joi.string().optional(),
+      en: Joi.string().optional()
+    }).required(),
+    createdAt: Joi.date().required(),
+    updatedAt: Joi.date().required()
+  }).required(),
+
+
+  /* JobEvent */
+  'integrationMessages': Joi.object().keys({
+    environment: Joi.string().valid('production', 'develop', 'demo', 'staging', 'testing', 'uat').required(),
+    uuid: Joi.string().required(),
+    message: Joi.string().max(300).truncate().required(),
+    code: Joi.string().required(),
+    process: Joi.string().required(),
+    type: Joi.string().valid('error', 'success', 'state').required(),
+    job: Joi.string().optional(),
+    additionalInfo: Joi.string().max(2000).truncate().allow('').optional()
+  }).required(),
+
+  /* generic */
+  'genericRequest': Joi.object({
+    'auth': Joi.object().required(),
+    'logId': Joi.string().max(150).required().trim(),
+    'payload': Joi.array().items().required()
+  }),
+  'genericResponse': Joi.object({
+    'status': Joi.number().optional(),
+    'totalError': Joi.number().optional(),
+    'success': Joi.array().items({
+      'reference': Joi.string().required(),
+      'message': Joi.string().max(300).allow('').trim()
+    }).optional(),
+    'error': Joi.array().optional()
+  })
+};