Merge pull request #77 from pwa-builder/master

Merging master into outdated dev

Author: JudahGabriel

lib/fileTools.js

@@ -150,6 +150,60 @@ function searchFile (dir, fileName, callback) {
   });
 }
 
+// uses the folderScanSync to grab absolute paths of all files and folders, deleting folders (deepest first) and moving files to the target
+// requires an absolute path for sourcePath and targetFolderPath.
+function flattenFolderStructureSync(sourcePath, targetFolderPath, callback) {
+  return Q.resolve().then(function () {
+    var output = folderScanSync(sourcePath);
+
+    // move/copy files
+    output.files.forEach(file => {
+      fs.renameSync(file, path.resolve(targetFolderPath, path.parse(file).base), (err) => {
+        return callback(err);
+      });
+    });
+
+    // remove directories
+    output.folders.forEach(folder => {
+      fs.rmdirSync(folder, (err) => {
+        callback(err);
+      });
+    });
+
+    return Q.resolve();
+  }).nodeify(callback);
+}
+
+// queues new entries into the unexplored paths, and iterates through it, execution stops when all reaches end.
+// output is an object: { files: [], folders: [] }, the order of the files and object is reversed of traversal order
+function folderScanSync(directory) {
+  const unexplored = [directory];
+  const folders = [];
+  const files = [];
+
+  for (let i = 0; i < unexplored.length; i++) {
+    const currentPath = unexplored[i];
+    fs.readdirSync(currentPath)
+      .forEach(function (fileEntry) {
+        var fileEntryPath = path.join(currentPath, fileEntry);
+
+        if (fs.statSync(fileEntryPath).isDirectory()) {
+          unexplored.push(fileEntryPath);
+          folders.push(fileEntryPath);
+        } else {
+          files.push(fileEntryPath);
+        }
+    });
+  }
+
+  return {
+    folders: folders.reverse(),
+    files: files.reverse()
+  };
+}
+
+// Copies the 'source' file to 'target' if it's missing after creating the
+// required directory structure.
 function syncFile (source, target, callback) {
 
   return stat(target).then(function (info) {
@@ -276,5 +330,7 @@ module.exports = {
   createShortcut: createShortcut,
   replaceFileContent: replaceFileContent,
   searchFile: searchFile,
-  syncFiles: syncFiles
+  syncFiles: syncFiles,
+  flattenFolderStructure: flattenFolderStructureSync,
+  folderScanSync: folderScanSync
 };

lib/manifestTools/assets/web-manifest.json

@@ -39,7 +39,7 @@
       "format": "uri"
     },
     "theme_color": {
-      "description": "background color for splash screen and icons",
+      "description": "The default theme color for the browsing contexts of an application",
       "type": "string"
     },
     "dir": {
@@ -68,8 +68,29 @@
     "prefer_related_applications": {
       "description": "A boolean value that is used as a hint for the user agent to say that related applications should be preferred over the web application.",
       "type": "boolean"
+    },
+    "categories": {
+      "description": "An array of strings defining the expected application categories to which the web application belongs. While any string is considered valid, W3C maintains a list of known category strings at https://github.com/w3c/manifest/wiki/Categories",
+      "type": "array"
+    },
+    "screenshots": {
+      "description": "An array of images representing the application in common usage scenarios.",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/icon"
+      }
+    },
+    "iarc_rating_id": {
+      "description": "The International Age Rating Coalition (IARC) certification code of the web application. It is intended to be used to determine which ages the web application is appropriate for.",
+      "type": "string"
+    },
+    "shortcuts": {
+      "description": "An array of shortcut items that provide access to key tasks within a web application.",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/shortcutItem"
+      }
     }
-    
   },
 
   "definitions": {
@@ -97,6 +118,15 @@
           "description": "The type member of an icon is a hint as to the media type of the icon.",
           "type": "string",
           "pattern": "^[\\sa-z0-9\\-+;\\.=\\/]+$"
+        },
+        "purpose": {
+          "description": "An unordered set of unique space-separated tokens that are ASCII case-insensitive. The allowed values are the icon purposes.",
+          "type": "string",
+          "enum": [ "badge", "maskable", "any" ]
+        },
+        "platform": {
+          "description": "The platform to which a containing object applies.",
+          "type": "string"
         }
       }
     },
@@ -117,6 +147,35 @@
           "type": "string"
         }
       }
+    },
+    "shortcutItem": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the shortcut as it is usually displayed to the user in a context menu.",
+          "type": "string"
+        },
+        "short_name": {
+          "description": "A short version of the name of the shortcut. It is intended to be used where there is insufficient space to display the full name of the shortcut.",
+          "type": "string"
+        },
+        "description": {
+          "description": "Describes the purpose of the shortcut. User agents MAY expose this information to assistive technology",
+          "type": "string"
+        },
+        "url": {
+          "description": "The URL within the application's scope that opens when the associated shortcut is activated.",
+          "type": "string",
+          "format": "uri"
+        },
+        "icons": {
+          "description": "The images to serve as iconic representations of the shortcut in various contexts.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/icon"
+          }
+        }
+      }
     }
   }
 }

lib/manifestTools/manifestCreator/index.js

@@ -39,15 +39,15 @@ function manifestCreator(opts, callback) {
       'Dir',
       'Lang',
       'Name',
+      'Short_name',
       'Icons',
       'Scope',
       'Display',
       'Start_url',
-      'Short_name',
+      'Background_color',
       'Theme_color',
       'Description',
       'Orientation',
-      'Background_color',
       'Related_applications',
       'Prefer_related_applications'
     ].map(function(name) {

lib/manifestTools/manifestLoader.js

@@ -20,15 +20,17 @@ var constants = require('../constants'),
 var manifestCreator = require('./manifestCreator');
 
 // Request settings taken from https://github.com/InternetExplorer/modern.IE-static-code-scan/blob/master/app.js
+// Then the user agent is updated to that of a PWA-capable browser
 var request = request.defaults({
   followAllRedirects: true,
   encoding: null,
   gzip: true,
   jar: false,
+  rejectUnauthorized: false,
   headers: {
     'Accept': 'text/html, application/xhtml+xml, */*',
     'Accept-Language': 'en-US,en;q=0.5',
-    'User-Agent': 'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)'
+    'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36'
   }
 });
 
@@ -48,7 +50,8 @@ function fetchManifestUrlFromSite (siteUrl, callback) {
     if (manifestUrl) {
       var parsedManifestUrl = url.parse(manifestUrl);
       if (!parsedManifestUrl.host) {
-        manifestUrl = url.resolve(siteUrl, parsedManifestUrl.pathname);
+        var searchOrEmpty = parsedManifestUrl.search || "";
+        manifestUrl = url.resolve(siteUrl, parsedManifestUrl.pathname + searchOrEmpty);
       }
     }
 
@@ -218,7 +221,7 @@ function generateImagesForManifest(image, manifest, options, callback) {
     }
   };
 
-  var imgGenerationSvc = options.generationSvcUrl || constants.IMG_GEN_SVC_URL;
+  var imgGenerationSvc = constants.IMG_GEN_SVC_URL || 'https://appimagegenerator-prod.azurewebsites.net';
   log.debug('Generating images from app image generation service: ' + imgGenerationSvc);
   return Q.nfcall(request.post, { url: _url.resolve(imgGenerationSvc, constants.IMG_GEN_SVC_API), formData: formData })
     .then(function(response) {