pwa-asset-generator/dist/main.js

Automates PWA asset generation and image declaration. Automatically generates icon and splash screen images, favicons and mstile images. Updates manifest.json and index.html files with the generated images according to Web App Manifest specs and Apple Hum

import meta from './helpers/meta.js';
import puppets from './helpers/puppets.js';
import flags from './helpers/flags.js';
import preLogger from './helpers/logger.js';
import constants from './config/constants.js';
/**
 Generates PWA assets based on a source input and saves generated images in the output folder provided

 @param source - A local image file, a local HTML file, a remote image or remote HTML file path
 @param outputFolderPath - The path of the folder to save the images in
 @param options - Option flags of the library in an object, keeps default values
 @param loggerFn - An optional logger function to log the output
 @returns A promise of result object that resolves when all images are generated and file updates are finalized

 @example
 ```javascript
 import pwaAssetGenerator = require('pwa-asset-generator');

 (async () => {
    const { savedImages, htmlMeta, manifestJsonContent } = await pwaAssetGenerator.generateImages(
      'https://raw.githubusercontent.com/onderceylan/pwa-asset-generator/HEAD/static/logo.png',
      './temp',
       {
          scrape: false,
          background: "linear-gradient(to right, #fa709a 0%, #fee140 100%)",
          splashOnly: true,
          portraitOnly: true,
          log: false
       });
  })();
 ```
 */
async function generateImages(source, outputFolderPath, options, loggerFn) {
    let modOptions;
    const logger = loggerFn || preLogger(generateImages.name, options);
    if (!source) {
        throw Error('Please specify a URL or file path as a source');
    }
    if (options) {
        modOptions = {
            ...flags.getDefaultOptions(),
            ...options,
            ...flags.normalizeOnlyFlagPairs('splashOnly', 'iconOnly', options, logger),
            ...flags.normalizeOnlyFlagPairs('landscapeOnly', 'portraitOnly', options, logger),
            ...flags.normalizeSandboxOption(options.noSandbox, logger),
        };
    }
    else {
        modOptions = {
            ...flags.getDefaultOptions(),
        };
    }
    const output = flags.normalizeOutput(outputFolderPath);
    const savedImages = await puppets.generateImages(source, output, modOptions);
    const manifestJsonContent = meta.generateIconsContentForManifest(savedImages, modOptions);
    const htmlMeta = meta.generateHtmlForIndexPage(savedImages, modOptions);
    if (!modOptions.splashOnly) {
        if (modOptions.manifest) {
            await meta.addIconsToManifest(manifestJsonContent, modOptions.manifest);
            logger.success(`Icons are saved to Web App Manifest file ${modOptions.manifest}`);
        }
        else if (!modOptions.splashOnly) {
            logger.warn('Web App Manifest file is not specified, printing out the content to console instead');
            logger.success('Below is the icons content for your manifest.json file. You can copy/paste it manually');
            logger.raw(`\n${JSON.stringify(manifestJsonContent, null, 2)}\n\n`);
        }
    }
    if (modOptions.index) {
        await meta.addMetaTagsToIndexPage(htmlMeta, modOptions.index, modOptions.xhtml);
        logger.success(`iOS meta tags are saved to index html file ${modOptions.index}`);
    }
    else {
        logger.warn('Index html file is not specified, printing out the content to console instead');
        logger.success('Below is the iOS meta tags content for your index.html file. You can copy/paste it manually');
        logger.raw(`\n${meta.formatMetaTags(htmlMeta)}\n`);
    }
    return {
        savedImages,
        htmlMeta,
        manifestJsonContent,
    };
}
/**
 Static data for Apple Device specs that are used for generating launch images
 */
const appleDeviceSpecsForLaunchImages = constants.APPLE_HIG_SPLASH_SCREEN_FALLBACK_DATA;
export { generateImages, appleDeviceSpecsForLaunchImages };
//# sourceMappingURL=main.js.map