AeroGear.js Core with AMD

aerogear.core.js

define("src/aerogear.core", 
  ["exports"],
  function(__exports__) {
    "use strict";
    /* AeroGear JavaScript Library
    * https://github.com/aerogear/aerogear-js
    * JBoss, Home of Professional Open Source
    * Copyright Red Hat, Inc., and individual contributors
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.apache.org/licenses/LICENSE-2.0
    * Unless required by applicable law or agreed to in writing, software
    * distributed under the License is distributed on an "AS IS" BASIS,
    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    * See the License for the specific language governing permissions and
    * limitations under the License.
    */
    /**
        The AeroGear namespace provides a way to encapsulate the library's properties and methods away from the global namespace
        @namespace
     */

    /**
        AeroGear.Core is a base for all of the library modules to extend. It is not to be instantiated and will throw an error when attempted
        @class
        @private
     */
    function Core() {
        // Prevent instantiation of this base class
        if ( this instanceof AeroGear.Core ) {
            throw "Invalid instantiation of base class AeroGear.Core";
        }

        /**
            This function is used by the different parts of AeroGear to add a new Object to its respective collection.
            @name AeroGear.add
            @method
            @param {String|Array|Object} config - This can be a variety of types specifying how to create the object. See the particular constructor for the object calling .add for more info.
            @returns {Object} The object containing the collection that was updated
         */
        this.add = function( config ) {
            var i,
                current,
                collection = this[ this.collectionName ] || {};
            this[ this.collectionName ] = collection;

            if ( !config ) {
                return this;
            } else if ( typeof config === "string" ) {
                // config is a string so use default adapter type
                collection[ config ] = AeroGear[ this.lib ].adapters[ this.type ]( config, this.config );
            } else if ( Array.isArray( config ) ) {
                // config is an array so loop through each item in the array
                for ( i = 0; i < config.length; i++ ) {
                    current = config[ i ];

                    if ( typeof current === "string" ) {
                        collection[ current ] = AeroGear[ this.lib ].adapters[ this.type ]( current, this.config );
                    } else {
                        if( current.name ) {

                            // Merge the Module( pipeline, datamanger, ... )config with the adapters settings
                            current.settings = AeroGear.extend( current.settings || {}, this.config );

                            collection[ current.name ] = AeroGear[ this.lib ].adapters[ current.type || this.type ]( current.name, current.settings );
                        }
                    }
                }
            } else {
                if( !config.name ) {
                    return this;
                }

                // Merge the Module( pipeline, datamanger, ... )config with the adapters settings
                // config is an object so use that signature
                config.settings = AeroGear.extend( config.settings || {}, this.config );

                collection[ config.name ] = AeroGear[ this.lib ].adapters[ config.type || this.type ]( config.name, config.settings );
            }

            // reset the collection instance
            this[ this.collectionName ] = collection;

            return this;
        };
        /**
            This function is used internally by pipeline, datamanager, etc. to remove an Object (pipe, store, etc.) from the respective collection.
            @name AeroGear.remove
            @method
            @param {String|String[]|Object[]|Object} config - This can be a variety of types specifying how to remove the object. See the particular constructor for the object calling .remove for more info.
            @returns {Object} The object containing the collection that was updated
         */
        this.remove = function( config ) {
            var i,
                current,
                collection = this[ this.collectionName ] || {};

            if ( typeof config === "string" ) {
                // config is a string so delete that item by name
                delete collection[ config ];
            } else if ( Array.isArray( config ) ) {
                // config is an array so loop through each item in the array
                for ( i = 0; i < config.length; i++ ) {
                    current = config[ i ];

                    if ( typeof current === "string" ) {
                        delete collection[ current ];
                    } else {
                        delete collection[ current.name ];
                    }
                }
            } else if ( config ) {
                // config is an object so use that signature
                delete collection[ config.name ];
            }

            // reset the collection instance
            this[ this.collectionName ] = collection;

            return this;
        };
    };
    __exports__.Core = Core;
    /**
        Utility function to test if an object is an Array
        @private
        @method
        @deprecated
        @param {Object} obj - This can be any object to test
    */
    Core.isArray = function( obj ) {
        return Array.isArray( obj );
    };

    /**
        Utility function to merge many Objects in one target Object which is the first object in arguments list.
        @private
        @method
    */
    Core.extend = function() {
        var name, i, source,
            target = arguments[ 0 ];
        for( i=1; i<arguments.length; i++ ) {
            source = arguments[ i ];
            for( name in source ) {
                target[ name ] = source[ name ];
            }
        }
        return target;
    };

    /**
        This callback is executed when an HTTP request completes whether it was successful or not.
        @callback AeroGear~completeCallbackREST
        @param {Object} jqXHR - The jQuery specific XHR object
        @param {String} textStatus - The text status message returned from the server
     */
    /**
        This callback is executed when an HTTP error is encountered during a request.
        @callback AeroGear~errorCallbackREST
        @param {Object} jqXHR - The jQuery specific XHR object
        @param {String} textStatus - The text status message returned from the server
        @param {Object} errorThrown - The HTTP error thrown which caused the is callback to be called
     */
    /**
        This callback is executed when an HTTP success message is returned during a request.
        @callback AeroGear~successCallbackREST
        @param {Object} data - The data, if any, returned in the response
        @param {String} textStatus - The text status message returned from the server
        @param {Object} jqXHR - The jQuery specific XHR object
     */
     /**
        This callback is executed when an HTTP progress message is returned during a request.
        @callback AeroGear~progressCallbackREST
        @param {Object} XMLHttpRequestProgressEvent - The progress event
     */
    /**
        This callback is executed when an error is encountered saving to local or session storage.
        @callback AeroGear~errorCallbackStorage
        @param {Object} errorThrown - The HTTP error thrown which caused the is callback to be called
        @param {Object|Array} data - An object or array of objects representing the data for the failed save attempt.
     */
    /**
        This callback is executed when data is successfully saved to session or local storage.
        @callback AeroGear~successCallbackStorage
        @param {Object} data - The updated data object after the new saved data has been added
     */
  });