felicity/lib/index.js

Javascript object instantiation from Joi schema

'use strict';

const Hoek         = require('@hapi/hoek');
const Joi          = require('./joi');
const JoiGenerator = require('./joiGenerator');
const Example      = require('./exampleGenerator');

const entityFor = function (schema, options) {

    if (!schema) {
        throw new Error('You must provide a Joi schema');
    }

    if (!Joi.isSchema(schema)) {
        schema = Joi.compile(schema);
    }

    const schemaDescription = schema.describe();

    if (schemaDescription.type !== 'object') {
        throw new Error('Joi schema must describe an object for constructor functions');
    }


    const validateInput = function (input, callback, override) {

        const baseConfig = {
            abortEarly: false
        };

        const config = Object.assign({}, baseConfig, override);

        const result = Constructor.schema.validate(input, config);

        const validationResult = {
            success: result.error === undefined,
            errors: result.error && result.error.details,
            value: result.value
        };

        if (callback && validationResult.success) {
            callback(null, validationResult);
        }
        else if (callback) {
            callback(validationResult.errors, null);
        }
        else {
            return validationResult;
        }
    };

    class Constructor {

        constructor(input, instanceOptions) {

            const configurations =  Hoek.clone(options) || {};

            if (input) {
                configurations.input = input;
            }

            if (instanceOptions) {
                configurations.config = configurations.config ?
                    Hoek.applyToDefaults(configurations.config, instanceOptions) :
                    instanceOptions;
            }

            if (Hoek.reach(configurations, 'config.strictExample')) {
                Object.defineProperty(this, 'strictExample', {
                    value: true
                });
            }

            JoiGenerator(this, schema, configurations);
        }

        get schema() {

            return schema;
        }

        validate(callback, config) {

            return validateInput(this, callback, config);
        }

        example(config) {

            const configurations = config || {};

            configurations.config = configurations.config || {};
            configurations.config.strictExample = this.strictExample || configurations.config.strictExample;

            return Example(this.schema, configurations);
        }

        static get schema() {

            return schema;
        }

        static validate(input, callback, config) {

            return validateInput(input, callback, config);
        }

        static example(config) {

            const configurations = config || {};

            configurations.config = configurations.config || {};

            return Example(this.schema, configurations);
        }
    }

    return Constructor;
};

const Felicity = {
    example: Example,
    entityFor
};

module.exports = Felicity;