sgfd.js

/**
 * Class responsible to create an configurable application
 * @param appConfig: the application configuration (an object or path to js file with 'appConfig' variable)
 * @param [optional] options: the options used in initialization, if needed
 */
function Sgfd(appConfig, options) {
    var sgfd = this;
    var options = options || {};

    var _session = {};
    /**
     * Sgfd Session update function
     * @param params: the params object to include all properties into session
     */
    var updateSession = (params) => {
        if (params) {
            _session = _session || {}
            Object.keys(params).forEach((p) => {
                _session[p] = params[p]
            })
        }
    }

    /**
     * Save session existent in Sgfd to localstorage
     */
    var exportSession = () => {
        localStorage.setItem('_session', JSON.stringify(_session))
    }

    if (!options['container']) options.container = window;

    /**
     * Load all needed data here. Chain order is very important!
     */
    var loader = function () {
        with(Sgfd.Base) {
            var loadList = [];

            if (options.externalSettings) {
                loadList.push(options.externalSettings);
            }

            if (typeof appConfig === 'string') loadList.push(appConfig);
            progressiveLoad(loadList, loadScript, function () {
                if (options.container.appConfig) {
                    appConfig = options.container.appConfig;
                }

                with(appConfig) {
                    // verify nullities
                    if (!back['domainClasses']) back['domainClasses'] = [];
                    if (!back['bwfDomains']) back['bwfDomains'] = [];
                    if (!back['controllers']) back['controllers'] = [];
                    if (!back['services']) back['services'] = [];
                    if (!back['views']) back['views'] = [];
                    if (!back['bridges']) back['bridges'] = [];

                    if (!front['externalScripts']) front['externalScripts'] = [];
                    if (!front['externalStyles']) front['externalStyles'] = [];
                    if (!front['scripts']) front['scripts'] = [];
                    if (!front['styles']) front['styles'] = [];

                    if (!conf['dependencies']) conf['dependencies'] = [];
                    if (!conf['bwfDomain']) conf['bwfDomain'] = false;
                    if (!conf['language']) conf['language'] = null;
                    if (!conf['appName']) conf['appName'] = 'New Sgfd Application';

                    // Verifies if has any full loading
                    if (back['full']) {
                        back.full.forEach(function (conf) {
                            back.domainClasses.push(conf);
                            back.bwfDomains.push(conf);
                            back.controllers.push(conf);
                            back.services.push(conf);
                            back.views.push(conf);
                        });
                    }

                    // if not profuction flag, set to false
                    if (conf['production'] === undefined) conf.production = false;

                    // set production flags if true
                    if (conf.production) {
                        conf.bootstrap = false;
                        conf['debug'] = {
                            controllers: false,
                            services: false,
                            bridges: false
                        };
                        conf['transactional'] = {
                            controllers: false,
                            services: false,
                            bridges: false
                        };
                    }

                    // if no container, it will be the window
                    if (!conf['container']) conf.container = window;
                }

                // Then load all things
                with(autoMerge(appConfig.front, appConfig.back, appConfig.conf)) {
                    // Set default app title
                    document.title = appName;

                    // Load bwf domain files
                    if (bwfDomain) {
                        progressiveLoad(bwfDomains, loadBwfDomain);
                    }

                    if (language !== null) {
                        progressiveLoad(['data/languages/' + language + '.js'], loadScript);
                    }

                    // Load project dependencies
                    progressiveLoad(dependencies, loadScript, function () {
                        // Inject 'classLoader'
                        if (appConfig.conf['classLoader']) container['classLoader'] = new container[classLoader]();

                        // Inject 'database' access
                        if (appConfig.conf['dataPool']) container['dataPool'] = new container[dataPool]();

                        // Inject views names
                        container['views'] = [];
                        views.forEach(function (view) {
                            container.views.push(view);
                        });

                        // Inject 'pages' manager
                        if (appConfig.conf['pageLoader']) {
                            container['pages'] = new container[pageLoader](container.views);
                        } else {
                            container['pages'] = new Object();
                        }

                        // Inject 'security' watcher
                        if (appConfig.conf['securityWatcher']) container['watcher'] = new container[securityWatcher]();

                        // Inject '_session'
                        if (appConfig.conf['session']) {
                            /**
                             * Get session existent in localstorage
                             */
                            container.getSession = () => {
                                return JSON.parse(localStorage.getItem('_session'))
                            }

                            /**
                             * Remove session from localstorage
                             */
                            container.cleanSession = () => {
                                localStorage.removeItem('_session')
                            }

                            /**
                             * Sync session from localstorage to Sgfd
                             */
                            container.syncSession = () => {
                                updateSession(container.getSession())
                                exportSession()
                            }

                            /**
                             * Session update function
                             * @param params: the params object to include all properties into localstorage session
                             */
                            container.updateSession = (params) => {
                                container.syncSession()
                                if (params) {
                                    _s = container.getSession() || {}
                                    Object.keys(params).forEach((p) => {
                                        _s[p] = params[p]
                                    })
                                    updateSession(_s)
                                    exportSession()
                                }
                            }
                        }

                        // Load back-end files
                        progressiveLoad(domainClasses, loadDomain, function () {
                            progressiveLoad(bridges, loadBridge, function () {
                                progressiveLoad(services, loadService, function () {
                                    progressiveLoad(controllers, loadController, function () {

                                        // Map the classes to 'database'
                                        // TODO: change how to make this
                                        progressiveLoad(['dataMappings.js'], loadScript, function () {
                                            // If bootstrap data is set on
                                            if (bootstrap) {
                                                progressiveLoad(['bootstrap.js'], loadScript);
                                            }

                                            // Load front-end files
                                            progressiveLoad(externalScripts, loadScript, function () {
                                                progressiveLoad(scripts, loadScriptAsset, function () {
                                                    progressiveLoad(externalStyles, loadStyle, function () {
                                                        progressiveLoad(styles, loadStyleAsset, function () {
                                                            progressiveLoad(views, loadView, function () {
                                                                // Run main script
                                                                progressiveLoad(['main.js'], loadScript, function () {
                                                                    // Set translated app title (if exsists)
                                                                    if (container['__']) document.title = __(appName);
                                                                });
                                                            });
                                                        });
                                                    });
                                                });
                                            });
                                        });
                                    });
                                });
                            });
                        });
                    });
                }
            });
        }
    };

    // instance related things
    sgfd.prototype = {
        /**
         * Initilizes the app
         */
        init: function () {
            return this;
        },
        /**
         * Load the app using given configs
         */
        load: function () {
            loader();
        }
    };

    return sgfd.prototype.init();
}

/**
 * Base functions to load a sort of things into app
 */
Sgfd.Base = {
    /**
     * Function responsible to load an Array of files in chain
     * @param lst: the array of files
     * @param func: the load function to be used
     * @param callback: an optional callback to run in the end of the chain
     * 
     * TODO: work for custom containers (now only for window)
     */
    progressiveLoad: function (lst, func, callback) {
        if (lst instanceof Array) {
            if (lst.length > 1) {
                func(lst[0], function () {
                    lst.shift();
                    Sgfd.Base.progressiveLoad(lst, func, callback);
                });
            } else if (lst.length === 1) {
                func(lst[0], callback || function () {});
            } else {
                callback();
            }
        } else {
            if (callback) {
                callback();
            }
        }
    },
    /**
     * Function responsible to fetch a custom file
     */
    loadCustomFile: function (url, type, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/' + type;
        script.src = url;

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch custom files
     */
    loadCustomFiles: function (urls, type, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/' + type;
            script.src = url;

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch scripts
     */
    loadScript: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = url;

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch asset scripts
     */
    loadScriptAsset: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'assets/js/' + url + '.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch asset scripts
     */
    loadScriptAssets: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'assets/js/' + url + '.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //style.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch scripts
     */
    loadScripts: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = url;

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch bridge scripts
     */
    loadBridge: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'data/bridges/' + url + 'bridge.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch service scripts
     */
    loadBridges: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'data/bridges/' + url + 'bridge.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch service scripts
     */
    loadService: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'services/' + url + 'service.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch service scripts
     */
    loadServices: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'services/' + url + 'service.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch controller scripts
     */
    loadController: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'controllers/' + url + 'controller.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch controller scripts
     */
    loadControllers: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'controllers/' + url + 'controller.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch view scripts
     */
    loadView: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'views/' + url + '.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch view scripts
     */
    loadViews: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'views/' + url + '.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch domain scripts
     */
    loadDomain: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/javascript';
        script.src = 'domain/' + url + '.js';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //script.onreadystatechange = callback;
        script.onload = callback;

        // Fire the loading
        head.appendChild(script);
    },
    /**
     * Function responsible to fetch domain scripts
     */
    loadDomains: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/javascript';
            script.src = 'domain/' + url + '.js';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //script.onreadystatechange = callback;
                script.onload = callback;
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch bwf domain scripts
     */
    loadBwfDomain: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var script = document.createElement('script');
        script.type = 'text/beowulf';
        script.src = 'domain/' + url + '.bwf';

        // Fire the loading
        head.appendChild(script);

        // call the callback function
        callback();
    },
    /**
     * Function responsible to fetch bwf domain scripts
     */
    loadBwfDomains: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var script = document.createElement('script');
            script.type = 'text/beowulf';
            script.src = 'domain/' + url + '.bwf';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                // call the callback function
                callback();
            }

            // Fire the loading
            head.appendChild(script);
        });
    },
    /**
     * Function responsible to fetch stylesheets
     */
    loadStyle: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var style = document.createElement('link');
        style.rel = 'stylesheet';
        style.type = 'text/css';
        style.href = url;

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //style.onreadystatechange = callback;
        style.onload = callback;

        // Fire the loading
        head.appendChild(style);
    },
    /**
     * Function responsible to fetch stylesheets
     */
    loadStyles: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var style = document.createElement('link');
            style.rel = 'stylesheet';
            style.type = 'text/css';
            style.href = url;

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //style.onreadystatechange = callback;
                style.onload = callback;
            }

            // Fire the loading
            head.appendChild(style);
        });
    },
    /**
     * Function responsible to fetch asset stylesheets
     */
    loadStyleAsset: function (url, callback) {
        // Adding the script tag to the head as suggested before
        var head = document.getElementsByTagName('head')[0];
        var style = document.createElement('link');
        style.rel = 'stylesheet';
        style.type = 'text/css';
        style.href = 'assets/css/' + url + '.css';

        // Then bind the event to the callback function.
        // There are several events for cross browser compatibility.
        //style.onreadystatechange = callback;
        style.onload = callback;

        // Fire the loading
        head.appendChild(style);
    },
    /**
     * Function responsible to fetch asset stylesheets
     */
    loadStyleAssets: function (urls, callback) {
        urls.forEach(function (url, i) {
            // Adding the script tag to the head as suggested before
            var head = document.getElementsByTagName('head')[0];
            var style = document.createElement('link');
            style.rel = 'stylesheet';
            style.type = 'text/css';
            style.href = 'assets/css/' + url + '.css';

            // Then bind the event to the callback function.
            // There are several events for cross browser compatibility.
            if (i === (urls.length - 1)) {
                //style.onreadystatechange = callback;
                style.onload = callback;
            }

            // Fire the loading
            head.appendChild(style);
        });
    },
    /**
     * Used to merge many objects into a single one
     */
    merge: function () {
        var args = Array.prototype.slice.call(arguments);
        var result = {};

        var merge_options = function (obj1, obj3) {
            for (var attrname in obj1) {
                obj3[attrname] = obj1[attrname];
            }
            return obj3;
        };

        args.forEach(function (argument) {
            result = merge_options(argument, result);
        });

        return result;
    },
    /**
     * Used to merge many objects into a single one adding self
     */
    autoMerge: function () {
        var args = Array.prototype.slice.call(arguments);
        var result = {};

        var merge_options = function (obj1, obj3) {
            for (var attrname in obj1) {
                obj3[attrname] = obj1[attrname];
            }
            return obj3;
        };

        args.forEach(function (argument) {
            result = merge_options(argument, result);
        });

        return merge_options(Sgfd.Base, result);
    },
    /**
     * Used for debug purposes
     */
    trace: function (obj, key, args, callback) {
        var metaName = ((obj.metaName !== undefined) &&
                (obj.metaName !== null) &&
                (obj.metaName !== '')) ?
            obj.metaName : 'NonMetaNamedClass';
        console.log(metaName + '.' + key + '(', args, ')');
        if (callback) callback();
    }
};

/**
 * Represents a class to be used in routed objects creation
 * Is used by default to create Controllers, Services etc.
 */
Sgfd.ConfigurableRoutedClass = function (routes, options) {
    var c = this;
    c.prototype = {};
    var cbk = null;

    if (options['callback']) {
        cbk = options.callback;
    }

    c.prototype.init = function (op) {
        Object.keys(routes).forEach(function (key) {
            if (routes[key] instanceof Function) {
                // If is debuggable
                if (op.debug) {
                    // If dumps the database
                    if (op.transactional) {
                        c.prototype[key] = function (args) {
                            Sgfd.Base.trace(this, key, arguments, cbk);
                            //dump(dataPool.export('json'));

                            return routes[key].apply(this, arguments);
                        };
                        // Not dump
                    } else {
                        c.prototype[key] = function (args) {
                            Sgfd.Base.trace(this, key, arguments, cbk);
                            return routes[key].apply(this, arguments);
                        };
                    }
                    // Not debuggable
                } else {
                    // transactional
                    if (op.transactional) {
                        c.prototype[key] = function (args) {
                            //dump(dataPool.export('json'));

                            return routes[key].apply(this, arguments);
                        };
                        // not transactional
                    } else {
                        c.prototype[key] = routes[key];
                    }
                }
            } else {
                c.prototype[key] = routes[key];
            }
        });
        return this;
    }

    return c.prototype.init(options);
};

/**
 * Create a controller object based in ConfigurableRoutedClass
 */
Sgfd.Controller = function (routes, options) {
    var _debug = undefined
    var _trans = undefined
    if (appConfig['conf']) {
        if (appConfig.conf['debug']) {
            if (appConfig.conf.debug['controllers']) {
                _debug = appConfig.conf.debug.controllers
            }
        }
    }
    if (appConfig['conf']) {
        if (appConfig.conf['transactional']) {
            if (appConfig.conf.transactional['controllers']) {
                _debug = appConfig.conf.transactional.controllers
            }
        }
    }
    var defaultOp = {
        debug: _debug || false,
        transactional: _trans || false
    };
    if ((options === null) || (options === undefined)) options = defaultOp;

    return new Sgfd.ConfigurableRoutedClass(routes, options);
};

/**
 * Create a service object based in ConfigurableRoutedClass
 */
Sgfd.Service = function (routes, options) {
    var _debug = undefined
    var _trans = undefined
    if (appConfig['conf']) {
        if (appConfig.conf['debug']) {
            if (appConfig.conf.debug['services']) {
                _debug = appConfig.conf.debug.services
            }
        }
    }
    if (appConfig['conf']) {
        if (appConfig.conf['transactional']) {
            if (appConfig.conf.transactional['services']) {
                _debug = appConfig.conf.transactional.services
            }
        }
    }
    var defaultOp = {
        debug: _debug || false,
        transactional: _trans || false
    };
    if ((options === null) || (options === undefined)) options = defaultOp;

    return new Sgfd.ConfigurableRoutedClass(routes, options);
};

/**
 * Create a controller object based in ConfigurableRoutedClass
 */
Sgfd.Bridge = function (routes, options) {
    var _debug = undefined
    var _trans = undefined
    if (appConfig['conf']) {
        if (appConfig.conf['debug']) {
            if (appConfig.conf.debug['bridges']) {
                _debug = appConfig.conf.debug.bridges
            }
        }
    }
    if (appConfig['conf']) {
        if (appConfig.conf['transactional']) {
            if (appConfig.conf.transactional['bridges']) {
                _debug = appConfig.conf.transactional.bridges
            }
        }
    }
    var defaultOp = {
        debug: _debug || false,
        transactional: _trans || false
    };
    if ((options === null) || (options === undefined)) options = defaultOp;

    return new Sgfd.ConfigurableRoutedClass(routes, options);
};

/**
 * @Override: Avoid others to get the code by this function
 */
Sgfd.toString = function () {
    return 'function Sgfd() { [native code] }';
};