model/ModelValidation.js

  1. import { checkType } from '../lib/check'
  2. import Logger from '../logger/Logger'
  3. import Api from '../api/Api'
  4. import { getOwnedPropertyJSON } from './helpers/json'
  6. function extractValidationViolations(webmessage) {
  7.     if (webmessage.response && webmessage.response.errorReports) {
  8.         return webmessage.response.errorReports
  9.     }
  11.     throw new Error('Response was not a WebMessage with the expected format')
  12. }
  14. /**
  15.  * Handles validation of Model objects based on their modelDefinition.
  16.  *
  17.  * @memberof module:model
  18.  */
  19. class ModelValidation {
  20.     constructor(providedLogger) {
  21.         checkType(providedLogger, 'object', 'logger (Logger)')
  22.         this.logger = providedLogger
  23.     }
  25.     /**
  26.      * @deprecated Client side model validation is deprecated in favour of server side validation only.
  27.      *
  28.      * @returns {{status: boolean, messages: Array}} Returns {status: true, messages: []}
  29.      */
  30.     validate() {
  31.         this.logger.warn('Client side model validation is deprecated')
  32.         throw new Error('Client side model validation is deprecated')
  33.     }
  35.     /**
  36.      * Sends a POST request against the `api/schemas` endpoint to check if the model is valid.
  37.      *
  38.      * @param {Model} model The model that should be validated.
  39.      * @returns {Array} Returns an array with validation messages if there are any.
  40.      *
  41.      * @note {warn} Currently only checks
  42.      */
  43.     validateAgainstSchema(model) {
  44.         if (!(model && model.modelDefinition && model.modelDefinition.name)) {
  45.             return Promise.reject('model.modelDefinition.name can not be found')
  46.         }
  48.         const url = `schemas/${model.modelDefinition.name}`
  50.         // TODO: The function getOwnedPropertyJSON should probably not be exposed, perhaps we could have a getJSONForModel(ownedPropertiesOnly=true) method.
  51.         return Api.getApi()
  52.             .post(url, getOwnedPropertyJSON(model))
  53.             .then(webMessage => {
  54.                 if (webMessage.status === 'OK') {
  55.                     return []
  56.                 }
  57.                 return Promise.reject(webMessage)
  58.             })
  59.             .catch(extractValidationViolations)
  60.     }
  62.     /**
  63.      * Returns the `ModelValidation` singleton. Creates a new one if it does not yet exist.
  64.      * Grabs a logger instance by calling `Logger.getLogger`
  65.      *
  66.      * @returns {ModelValidation} New or memoized instance of `ModelInstance`
  67.      */
  68.     static getModelValidation() {
  69.         if (this.modelValidation) {
  70.             return this.modelValidation
  71.         }
  72.         return (this.modelValidation = new ModelValidation(
  73.             Logger.getLogger(console)
  74.         ))
  75.     }
  76. }
  78. export default ModelValidation