mustom-validator/method/misc.js

Lightweight yet powerful, highly extensible validation/sanitization library

// MUSTOM, More Than Custom, https://mustom.com
// Copyright © Ryu Woosik. All rights reserved.

const { errorHandler } = require('../util/error-handler')
const { dataTypeChecker } = require('../util/data-type-checker')

const misc = {
    /**
     * Validates grid options for data retrieval.
     * It used to validate Mustom admin panel grid options.
     */
    gridOption: function () {

        this.criterion = 'gridOption'
        
        if (dataTypeChecker(this.input) !== 'object') {
            errorHandler(this, 'ValidationError', 'The input for gridOption() must be an object.')
        }

        for (const key in this.input) {

            // Uncomment the following lines to enforce strict key checking (Disallow undefined keys)
            // if (!validKeys.includes(key)) {
            //     errorHandler(this, 'ValidationError', `The key '${key}' is not allowed in gridOption(). Allowed keys are: ${validKeys.join(', ')}`)
            // }

            const value = this.input[key]

            const dataType = dataTypeChecker(value)

            switch (key) {
                case 'menu':
                    if (dataType !== 'string') {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be a string.`)
                    }
                    break
                case 'limit':
                    if (dataType !== 'number' || value % 1 !== 0 || value < 1) {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be a positive integer.`)
                    }
                    break
                case 'orderDirection':
                    if (value !== 'asc' && value !== 'desc') {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be either 'asc' or 'desc'.`)
                    }
                    break
                case 'orderBy':
                    if (dataType !== 'string') {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be a string.`)
                    }
                    break
                case 'searchBy':
                    if (dataType !== 'string') {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be a string.`)
                    }
                    break
                case 'offset':
                    if (dataType !== 'number' || value % 1 !== 0 || value < 0) {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be a non-negative integer.`)
                    }
                    break
                case 'attributes':
                    if (dataType !== 'array') {
                        errorHandler(this, 'ValidationError', `The key '${key}' must be an array.`)
                    }
                    break
                default:
                    // Do nothing. Undefined keys can be allowed by default.
                    break
            }
        }

        return this
    },
    /**
     * Specifies that no validation rules are applied to the input data.
     */
    noRules: function () {
        return this
    }
}

module.exports = misc