index.js

var fs = require('fs');
var path = require('path');
var ig = require('imagemagick');
var colors = require('colors');
var _ = require('underscore');
var Q = require('q');
var nodeFs = require('node-fs');

/**
 * Check which platforms are added to the project and return their icon names and sized
 *
 * @param  {String} projectName
 * @return {Promise} resolves with an array of platforms
 */
var getPlatformIcons = function() {
    var deferred = Q.defer();
    var platforms = [];
    //ok
    platforms.push({
        name: 'ios',
        isAdded: true,
        iconsPath: 'res/icons/ios/',
        icons: [
            // Default icon (avoid Apple submit error ITMS-90032)
            { name: "../../../icon.png", size: 57 },
            // iOS 8.0+, iPhone 6 Plus
            { name:'icon-60-3x.png', size:180 },
            // iOS 7.0+, iPhone / iPod Touch  -->
            { name:'icon-60.png', size:60 },
            { name:'icon-60-2x.png', size:120 },
            // iPad -->
            { name:'icon-76.png', size:76 },
            { name:'icon-76-2x.png', size:152 },
            { name:'icon-76-3x.png', size:228 },
            // iOS 6.1, Spotlight Icon -->
            { name:'icon-40.png', size:40 },
            { name:'icon-40-2x.png', size:80 },
            { name:'icon-40-3x.png', size:120 },
            // iPhone / iPod Touch -->
            { name:'icon-57.png', size:57 },
            { name:'icon-57-2x.png', size:114 },
            { name:'icon-57-3x.png', size:171 },
            // iPad -->
            { name:'icon-72.png', size:72 },
            { name:'icon-72-2x.png', size:144 },
            { name:'icon-72-3x.png', size:216 },
            // iPhone Spotlight and Settings Icon -->
            { name:'icon-small.png', size:29 },
            { name:'icon-small-2x.png', size:58 },
            { name:'icon-small-3x.png', size:87 },
            // iPad Spotlight and Settings Icon -->
            { name:'icon-50.png', size:50 },
            { name:'icon-50-2x.png', size:100 },
            { name:'icon-50-3x.png', size:150 },
            // Other sizes -->
            { name:'icon-48.png', size:48 },
            { name:'icon-48-2x.png', size:96 },
            { name:'icon-58.png', size:58 },
            { name:'icon-58-2x.png', size:116 },
            { name:'icon-58-3x.png', size:174 },
            { name:'icon-64.png', size:64 },
            { name:'icon-64-2x.png', size:128 },
            { name:'icon-64-3x.png', size:192 },
            { name:'icon-83.5.png', size:83.5 },
            { name:'icon-83.5-2x.png', size:167 },
            { name:'icon-320.png', size:320 },
        ]
    });

    //ok
    platforms.push({
        name: 'android',
        iconsPath: 'res/icons/android/',
        isAdded: true,
        icons: [
            { name:'icon-36-ldpi.png', size: 36, density:'ldpi' },
            { name:'icon-48-mdpi.png', size: 48, density:'mdpi' },
            { name:'icon-72-hdpi.png', size: 72, density:'hdpi' },
            { name:'icon-96-xhdpi.png', size: 96, density:'xhdpi' },
            { name:'icon-144-xxhdpi.png', size: 144, density:'xxhdpi' },
            { name:'icon-192-xxxhdpi.png', size: 192, density:'xxxhdpi' },
        ]
    });

    //ok
    platforms.push({
        name: 'wp8',
        iconsPath: 'res/icons/wp8/',
        isAdded: true,
        icons: [
            { name: 'ApplicationIcon.png', size: 99 },
            { name: 'Background.png', size: 159 },
        ]
    });

    //ok
    platforms.push({
        name: 'windows',
        iconsPath: 'res/icons/windows/',
        isAdded: true,
        icons: [
            { name:'Square150x150Logo.scale-100.png', size:150 },
            { name:'Square150x150Logo.scale-240.png', size:360 },
            { name:'Square30x30Logo.scale-100.png', size:30 },
            { name:'Square310x310Logo.scale-100.png', size:310 },
            { name:'Square44x44Logo.scale-240.png', size:106 },
            { name:'Square70x70Logo.scale-100.png', size:70 },
            { name:'Square71x71Logo.scale-240.png', size:170 },
            { name:'StoreLogo.scale-100.png', size:50 },
            { name:'StoreLogo.scale-240.png', size:120 },
            { name:'Wide310x150Logo.scale-100.png', size:310 },
            { name:'Wide310x150Logo.scale-240.png', size:744 },
        ]
    });

    //ok
    platforms.push({
        name: 'store',
        iconsPath: 'store/icons/',
        isAdded: true,
        icons: [
            { path:'./android/', name: "icon-512.png", size: 512 },
            { path:'./wp8/', name: "icon-300.png", size: 300 },
            { path:'./ios/', name: "icon-1024.jpg", size: 1024 } // App Store
        ]
    });

    platforms = settings.ICON_PLATFORMS || platforms

    deferred.resolve(platforms);
    return deferred.promise;
};

/**
 * Check which platforms are added to the project and return their splash screen names and sizes
 *
 * @param  {String} projectName
 * @return {Promise} resolves with an array of platforms
 */
var getPlatformSplashs = function() {
    var deferred = Q.defer();
    var platforms = [];

    //ok
    platforms.push({
        name: 'ios',
        isAdded: true,
        splashPath: 'res/screens/ios/',
        splash: [
            { name:"screen-iphone-portrait.png", width:320, height:480 },           // iPhone
            { name:"screen-iphone-portrait-2x.png", width:640, height:960 },        // iPhone Retina
            { name:"screen-ipad-portrait.png", width:768, height:1024 },            // iPad
            { name:"screen-ipad-portrait-2x.png", width:1536, height:2048 },        // iPad Retina
            { name:"screen-ipad-landscape.png", width:1024, height:768 },           // iPad
            { name:"screen-ipad-landscape-2x.png", width:2048, height:1536 },       // iPad Retina
            { name:"screen-iphone-568h-2x.png", width:640, height:1136 },           // iPhone 5 Retina
            { name:"screen-iphone-portrait-667h.png", width:750, height:1334 },     // iPhone 6
            { name:"screen-iphone-portrait-736h.png", width:1242, height:2208 },    // iPhone 6 Plus
            { name:"screen-iphone-landscape-736h.png", width:2208, height:1242 },   // iPhone 6 Plus
        ]
    });

    //ok
    platforms.push({
        name: 'android',
        isAdded: true,
        splashPath: 'res/screens/android/',
        splash: [
            { name:"screen-ldpi-portrait.png", width: 320, height: 426, density:"port-ldpi" }, // 200x320
            { name:"screen-ldpi-landscape.png", width: 426, height: 320, density:"land-ldpi" }, // 320x200
            { name:"screen-hdpi-portrait.png", width: 480, height: 640, density:"port-hdpi" }, // 320x480
            { name:"screen-hdpi-landscape.png", width: 640, height: 480, density:"land-hdpi" }, // 480x320
            { name:"screen-mdpi-portrait.png", width: 320, height: 470, density:"port-mdpi" }, // 480x800
            { name:"screen-mdpi-landscape.png", width: 470, height: 320, density:"land-mdpi" }, // 800x480
            { name:"screen-xhdpi-portrait.png", width: 720, height: 960, density:"port-xhdpi" }, // 720x1280
            { name:"screen-xhdpi-landscape.png", width: 960, height: 720, density:"land-xhdpi" }, // 1280x720
            { name:"screen-xxhdpi-portrait.png", width: 960, height: 1600, density:"port-xxhdpi" }, // 960x1600
            { name:"screen-xxhdpi-landscape.png", width: 1600, height: 960, density:"land-xxhdpi" }, // 1600x960
            { name:"screen-xxxhdpi-portrait.png", width: 1280, height: 1920, density:"port-xxhdpi" }, // 1280x1920
            { name:"screen-xxxhdpi-landscape.png", width: 1920, height: 1280, density:"land-xxhdpi" } // 1920x1280
        ]
    });

    //ok
    // https://msdn.microsoft.com/en-us/library/windows/apps/ff769511(v=vs.105).aspx
    platforms.push({
        name: 'wp8',
        isAdded: true,
        splashPath: 'res/screens/wp8/',
        splash: [
            { width: 768, height: 1280, name:"SplashScreenImage.jpg" },
            { width: 480, height: 800, name:"SplashScreenImage.screen-WVGA.jpg" },
            { width: 768, height: 1280, name:"SplashScreenImage.screen-WXGA.jpg" },
            { width: 720, height: 1280, name:"SplashScreenImage.screen-720p.jpg" }
        ]
    });

    //ok
    platforms.push({
        name: 'windows',
        isAdded: true,
        splashPath: 'res/screens/windows/',
        splash: [
            { width:620, height:300, name:"SplashScreen.scale-100.png" },
            { width:1152, height:1920, name:"SplashScreen.scale-240.png" },
            { width:1152, height:1920, name:"SplashScreenPhone.scale-240.png" },
        ]
    });

    platforms.push({
        name: 'store',
        isAdded: true,
        splashPath: 'store/screens/',
        splash: [
            { path: './android/', name: 'cover-store.png', width: 1024, height: 500 },
        ]
    });

    platforms = settings.SPLASH_PLATFORMS || platforms

    deferred.resolve(platforms);
    return deferred.promise;
};

/**
 * @var {Object} settings - names of the confix file and of the icon image
 * TODO: add option to get these values as CLI params
 */
var settings = {};
settings.ICON_FILE = path.join('model', 'icon.png');
settings.SPLASH_FILE = path.join('model', 'splash.png');

/**
 * @var {Object} console utils
 */
var display = {};
display.success = function(str) {
    str = '✓  '.green + str;
    console.log('  ' + str);
};
display.error = function(str) {
    str = '✗  '.red + str;
    console.log('  ' + str);
};
display.header = function(str) {
    console.log('');
    console.log(' ' + str.cyan.underline);
    console.log('');
};

/**
 * Resizes and creates a new icon in the platform's folder.
 *
 * @param  {Object} platform
 * @param  {Object} icon
 * @return {Promise}
 */
var generateIcon = function(platform, icon) {
    var deferred = Q.defer();
    try {
        var filePath = path.join(platform.iconsPath, icon.name);
        var filedirName = path.dirname(filePath);
        if (!fs.existsSync(filedirName)) {
            nodeFs.mkdirSync(filedirName, '0777', true);
        }
        ig.resize({
            srcPath: settings.ICON_FILE,
            dstPath: filePath,
            quality: 1,
            format: icon.name.replace(/.*\.(\w+)$/i, '$1').toLowerCase(),
            width: icon.size,
            height: icon.size,
        }, function(err, stdout, stderr) {
            if (err) {
                deferred.reject(err);
            } else {
                deferred.resolve();
                display.success(icon.name + ' created');
            }
        });
    } catch (error) {
        deferred.reject(err);
    }
    return deferred.promise;
};

/**
 * Generates icons based on the platform object
 *
 * @param  {Object} platform
 * @return {Promise}
 */
var generateIconsForPlatform = function(platform) {
    var deferred = Q.defer();
    display.header('Generating Icons for ' + platform.name);
    var all = [];
    var icons = platform.icons;
    icons.forEach(function(icon) {
        all.push(generateIcon(platform, icon));
    });
    Q.all(all).then(function() {
        deferred.resolve();
    }).catch(function(err) {
        console.log(err);
    });
    return deferred.promise;
};

/**
 * Goes over all the platforms and triggers icon generation
 *
 * @param  {Array} platforms
 * @return {Promise}
 */
var generateIcons = function(platforms) {
    var deferred = Q.defer();
    var sequence = Q();
    var all = [];
    _(platforms).where({
        isAdded: true
    }).forEach(function(platform) {
        sequence = sequence.then(function() {
            return generateIconsForPlatform(platform);
        });
        all.push(sequence);
    });
    Q.all(all).then(function() {
        deferred.resolve();
    });
    return deferred.promise;
};


/**
 * Checks if a valid icon file exists
 *
 * @return {Promise} resolves if exists, rejects otherwise
 */
var validIconExists = function() {
    var deferred = Q.defer();
    fs.exists(settings.ICON_FILE, function(exists) {
        if (exists) {
            display.success(settings.ICON_FILE + ' exists');
            deferred.resolve(true);
        } else {
            display.error(settings.ICON_FILE + ' does not exist in the root folder');
            deferred.resolve(false);
        }
    });
    return deferred.promise;
};


/**
 * Crops and creates a new splash in the platform's folder.
 *
 * @param  {Object} platform
 * @param  {Object} splash
 * @return {Promise}
 */
var generateSplash = function(platform, splash) {
    var deferred = Q.defer();
    try {
        var filePath = path.join(platform.splashPath, splash.name);
        var filedirName = path.dirname(filePath);
        if (!fs.existsSync(filedirName)) {
            nodeFs.mkdirSync(filedirName, '0777', true);
        }
        ig.crop({
            srcPath: settings.SPLASH_FILE,
            dstPath: filePath,
            quality: 1,
            format: splash.name.replace(/.*\.(\w+)$/i, '$1').toLowerCase(),
            width: splash.width,
            height: splash.height,
        }, function(err, stdout, stderr) {
            if (err) {
                deferred.reject(err);
            } else {
                deferred.resolve();
                display.success(splash.name + ' created');
            }
        });
    } catch (error) {
        deferred.reject(err);
    }
    return deferred.promise;
};

/**
 * Generates splash based on the platform object
 *
 * @param  {Object} platform
 * @return {Promise}
 */
var generateSplashForPlatform = function(platform) {
    var deferred = Q.defer();
    display.header('Generating splash screen for ' + platform.name);
    var all = [];
    var splashes = platform.splash;
    splashes.forEach(function(splash) {
        all.push(generateSplash(platform, splash));
    });
    Q.all(all).then(function() {
        deferred.resolve();
    }).catch(function(err) {
        console.log(err);
    });
    return deferred.promise;
};

/**
 * Goes over all the platforms and triggers splash screen generation
 *
 * @param  {Array} platforms
 * @return {Promise}
 */
var generateSplashes = function(platforms) {
    var deferred = Q.defer();
    var sequence = Q();
    var all = [];
    _(platforms).where({
        isAdded: true
    }).forEach(function(platform) {
        sequence = sequence.then(function() {
            return generateSplashForPlatform(platform);
        });
        all.push(sequence);
    });
    Q.all(all).then(function() {
        deferred.resolve();
    });
    return deferred.promise;
};
/**
 * Checks if a valid splash file exists
 *
 * @return {Promise} resolves if exists, rejects otherwise
 */
var validSplashExists = function() {
    var deferred = Q.defer();
    fs.exists(settings.SPLASH_FILE, function(exists) {
        if (exists) {
            display.success(settings.SPLASH_FILE + ' exists');
            deferred.resolve(true);
        } else {
            display.error(settings.SPLASH_FILE + ' does not exist in the root folder');
            deferred.resolve(false);
        }
    });
    return deferred.promise;
};


function generate(options) {
    settings = options || settings;
    display.header('Checking Splash & Icon');
    return Q.all([validIconExists(), validSplashExists()])
        .then(function(results) {
            var hasIcon = results[0] === true;
            var hasSplash = results[1] === true;
            var promise;

            if (!hasIcon && !hasSplash) {
                //console.log(arguments);
                promise = Q.reject();
            }

            if (hasIcon) {
                promise = Q.when(promise)
                    .then(getPlatformIcons)
                    .then(generateIcons);
            }

            if (hasSplash) {
                promise = Q.when(promise)
                    .then(getPlatformSplashs)
                    .then(generateSplashes);
            }

            return Q.when(promise);
        })
        .catch(function(err) {
            if (err) {
                console.log(err);
            }
        }).then(function() {
            console.log('');
        });
}

module.exports = {
    generate: generate
};