d2/src/model/ModelValidation.js

Javascript library for DHIS2

import { checkType } from '../lib/check'
import Logger from '../logger/Logger'
import Api from '../api/Api'
import { getOwnedPropertyJSON } from './helpers/json'

function extractValidationViolations(webmessage) {
    if (webmessage.response && webmessage.response.errorReports) {
        return webmessage.response.errorReports
    }

    throw new Error('Response was not a WebMessage with the expected format')
}

/**
 * Handles validation of Model objects based on their modelDefinition.
 *
 * @memberof module:model
 */
class ModelValidation {
    constructor(providedLogger) {
        checkType(providedLogger, 'object', 'logger (Logger)')
        this.logger = providedLogger
    }

    /**
     * @deprecated Client side model validation is deprecated in favour of server side validation only.
     *
     * @returns {{status: boolean, messages: Array}} Returns {status: true, messages: []}
     */
    validate() {
        this.logger.warn('Client side model validation is deprecated')
        throw new Error('Client side model validation is deprecated')
    }

    /**
     * Sends a POST request against the `api/schemas` endpoint to check if the model is valid.
     *
     * @param {Model} model The model that should be validated.
     * @returns {Array} Returns an array with validation messages if there are any.
     *
     * @note {warn} Currently only checks
     */
    validateAgainstSchema(model) {
        if (!(model && model.modelDefinition && model.modelDefinition.name)) {
            return Promise.reject('model.modelDefinition.name can not be found')
        }

        const url = `schemas/${model.modelDefinition.name}`

        // TODO: The function getOwnedPropertyJSON should probably not be exposed, perhaps we could have a getJSONForModel(ownedPropertiesOnly=true) method.
        return Api.getApi()
            .post(url, getOwnedPropertyJSON(model))
            .then(webMessage => {
                if (webMessage.status === 'OK') {
                    return []
                }
                return Promise.reject(webMessage)
            })
            .catch(extractValidationViolations)
    }

    /**
     * Returns the `ModelValidation` singleton. Creates a new one if it does not yet exist.
     * Grabs a logger instance by calling `Logger.getLogger`
     *
     * @returns {ModelValidation} New or memoized instance of `ModelInstance`
     */
    static getModelValidation() {
        if (this.modelValidation) {
            return this.modelValidation
        }
        return (this.modelValidation = new ModelValidation(
            Logger.getLogger(console)
        ))
    }
}

export default ModelValidation