@squirrel-forge/ui-util/src/js/Logic/Config.js

A collection of utilities, classes, functions and abstracts made for the browser and babel compatible.

/**
 * Requires
 */
import { Exception } from '../Error/Exception.js';
import { isPojo } from '../Object/isPojo.js';
import { mergeObject } from '../Object/mergeObject.js';
import { cloneObject } from '../Object/cloneObject.js';
import { strCreate } from '../Object/strCreate.js';
import { strAccess } from '../Object/strAccess.js';

/**
 * Config exception
 * @class
 * @extends Exception
 */
class ConfigException extends Exception {}

/**
 * Config
 * @class
 */
export class Config {

    /**
     * Clone object recursive
     * @public
     * @param {Object} data - Data to clone
     * @return {Object|Array} - Cloned object
     */
    static clone( data ) {
        return cloneObject( data, true );
    }

    /**
     * Merge object recursive
     * @public
     * @param {Object} data - Data to merge
     * @param {Object} target - Target to merge to
     * @param {boolean} extend -  Set true to add undefined|null properties
     * @return {void}
     */
    static merge( data, target, extend = false ) {
        mergeObject( target, data, extend, true, true );
    }

    /**
     * Build defaults from inheritance
     * @public
     * @param {Array} extended - Inheritance array
     * @return {null|Object} - Merged configs
     */
    static extendInheritance( extended ) {
        if ( !extended.length ) return null;
        const config = extended.shift();
        for ( let i = 0; i < extended.length; i++ ) {
            if ( !isPojo( extended[ i ] ) ) {
                throw new ConfigException( 'Argument extended must contain only plain Objects' );
            }
            this.merge( extended[ i ], config, true );
        }
        return config;
    }

    /**
     * Config defaults
     * @private
     * @property
     * @type {Object}
     */
    #defaults = {};

    /**
     * Config data
     * @private
     * @property
     * @type {Object}
     */
    #data = {};

    /**
     * Constructor
     * @constructor
     * @param {Object} defaults - Default config values object
     * @param {Array<Object>} extended - Default config extension array for inheritance
     */
    constructor( defaults = {}, extended = [] ) {

        // Check defaults
        if ( !isPojo( defaults ) ) {
            throw new ConfigException( 'Argument defaults must be a plain Object' );
        }
        this.#defaults = defaults;

        // Check extended
        if ( !( extended instanceof Array ) ) {
            throw new ConfigException( 'Argument extended must be an Array' );
        }

        // Update default config with extensions
        const inherited_defaults = this.constructor.extendInheritance( extended );
        if ( inherited_defaults ) this.constructor.merge( inherited_defaults, this.#defaults, true );

        // Setup active config data
        this.#data = this.constructor.clone( this.#defaults );
    }

    /**
     * Defaults getter
     * @public
     * @return {Object} - Defaults data object
     */
    get defaults() {
        return this.constructor.clone( this.#defaults );
    }

    /**
     * Data getter
     * @public
     * @return {Object} - Config data object
     */
    get data() {
        return this.constructor.clone( this.#data );
    }

    /**
     * Direct config access
     * @public
     * @return {Object} - Config data object
     */
    get exposed() {
        return this.#data;
    }

    /**
     * Get config value
     * @public
     * @param {string} name - Value name
     * @return {*|null} - Config value
     */
    get( name ) {
        return strAccess( name, this.#data );
    }

    /**
     * Set config value
     * @public
     * @param {string} name - Value name
     * @param {*} value - Value to set
     * @return {void}
     */
    set( name, value ) {
        strCreate( name, value, this.#data, true );
    }

    /**
     * Merge data into config
     * @public
     * @param {Object} data - Data object to merge
     * @param {boolean} extend -  Set true to add undefined|null properties
     * @return {void}
     */
    merge( data, extend = false ) {
        if ( !isPojo( data ) ) {
            throw new ConfigException( 'Argument data must be a plain Object' );
        }
        this.constructor.merge( data, this.#data, extend );
    }
}