webmanifest - Add support for icons in file_handlers (#9152)

parcel-bundler · Sep 27, 2023 · 801de2c · 801de2c
1 parent e0d6f54
commit 801de2c
Show file tree

Hide file tree

Showing 7 changed files with 90 additions and 39 deletions.
diff --git a/.../core/integration-tests/test/integration/webmanifest-json/file-handler-icon.png b/.../core/integration-tests/test/integration/webmanifest-json/file-handler-icon.png
diff --git a/packages/core/integration-tests/test/integration/webmanifest-json/manifest.json b/packages/core/integration-tests/test/integration/webmanifest-json/manifest.json
@@ -16,14 +16,26 @@
   ],
   "shortcuts": [
     {
-        "name": "example-shortcut",
-        "icons": [
-            {
-                "src": "shortcut-icon.png",
-                "sizes": "100x100",
-                "type": "image/png"
-            }
-        ]
+      "name": "example-shortcut",
+      "icons": [
+        {
+          "src": "shortcut-icon.png",
+          "sizes": "100x100",
+          "type": "image/png"
+        }
+      ]
+    }
+  ],
+  "file_handlers": [
+    {
+      "name": "example-file-handler",
+      "icons": [
+        {
+          "src": "file-handler-icon.png",
+          "sizes": "100x100",
+          "type": "image/png"
+        }
+      ]
     }
   ]
 }
diff --git a/packages/core/integration-tests/test/integration/webmanifest-schema/manifest.webmanifest b/packages/core/integration-tests/test/integration/webmanifest-schema/manifest.webmanifest
@@ -31,5 +31,6 @@
         {}
       ]
     }
-  ]
+  ],
+  "file_handlers": {}
 }
diff --git a/packages/core/integration-tests/test/integration/webmanifest/file-handler-icon.png b/packages/core/integration-tests/test/integration/webmanifest/file-handler-icon.png
diff --git a/packages/core/integration-tests/test/integration/webmanifest/manifest.webmanifest b/packages/core/integration-tests/test/integration/webmanifest/manifest.webmanifest
@@ -16,14 +16,26 @@
   ],
   "shortcuts": [
     {
-        "name": "example-shortcut",
-        "icons": [
-            {
-                "src": "shortcut-icon.png",
-                "sizes": "100x100",
-                "type": "image/png"
-            }
-        ]
+      "name": "example-shortcut",
+      "icons": [
+        {
+          "src": "shortcut-icon.png",
+          "sizes": "100x100",
+          "type": "image/png"
+        }
+      ]
+    }
+  ],
+  "file_handlers": [
+    {
+      "name": "example-file-handler",
+      "icons": [
+        {
+          "src": "file-handler-icon.png",
+          "sizes": "100x100",
+          "type": "image/png"
+        }
+      ]
     }
   ]
 }
diff --git a/packages/core/integration-tests/test/webmanifest.js b/packages/core/integration-tests/test/webmanifest.js
@@ -30,6 +30,10 @@ describe('webmanifest', function () {
         type: 'png',
         assets: ['shortcut-icon.png'],
       },
+      {
+        type: 'png',
+        assets: ['file-handler-icon.png'],
+      },
     ]);
 
     const manifest = await outputFS.readFile(
@@ -39,6 +43,7 @@ describe('webmanifest', function () {
     assert(/screenshot\.[0-9a-f]+\.png/.test(manifest));
     assert(/icon\.[0-9a-f]+\.png/.test(manifest));
     assert(/shortcut-icon\.[0-9a-f]+\.png/.test(manifest));
+    assert(/file-handler-icon\.[0-9a-f]+\.png/.test(manifest));
   });
 
   it('should support .json', async function () {
@@ -67,6 +72,10 @@ describe('webmanifest', function () {
         type: 'png',
         assets: ['shortcut-icon.png'],
       },
+      {
+        type: 'png',
+        assets: ['file-handler-icon.png'],
+      },
     ]);
 
     const manifest = await outputFS.readFile(
@@ -76,9 +85,10 @@ describe('webmanifest', function () {
     assert(/screenshot\.[0-9a-f]+\.png/.test(manifest));
     assert(/icon\.[0-9a-f]+\.png/.test(manifest));
     assert(/shortcut-icon\.[0-9a-f]+\.png/.test(manifest));
+    assert(/file-handler-icon\.[0-9a-f]+\.png/.test(manifest));
   });
 
-  it('should throw on malformed icons and screenshots', async function () {
+  it('should throw on malformed icons, screenshots, shortcuts, and file handlers', async function () {
     let manifestPath = path.join(
       __dirname,
       '/integration/webmanifest-schema/manifest.webmanifest',
@@ -167,6 +177,17 @@ describe('webmanifest', function () {
                       line: 31,
                     },
                   },
+                  {
+                    end: {
+                      column: 21,
+                      line: 35,
+                    },
+                    message: 'Expected type array',
+                    start: {
+                      column: 20,
+                      line: 35,
+                    },
+                  },
                 ],
               },
             ],

diff --git a/packages/transformers/webmanifest/src/WebManifestTransformer.js b/packages/transformers/webmanifest/src/WebManifestTransformer.js
@@ -39,6 +39,15 @@ const MANIFEST_SCHEMA: SchemaEntity = {
         },
       },
     },
+    file_handlers: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          icons: RESOURCES_SCHEMA,
+        },
+      },
+    },
   },
 };
 
@@ -54,40 +63,36 @@ export default (new Transformer({
       'Invalid webmanifest',
     );
 
-    for (const key of ['icons', 'screenshots']) {
-      const list = data[key];
+    function addResourceListToAsset(list, parent) {
       if (list) {
         invariant(Array.isArray(list));
         for (let i = 0; i < list.length; i++) {
           const res = list[i];
           res.src = asset.addURLDependency(res.src, {
             loc: {
               filePath: asset.filePath,
-              ...getJSONSourceLocation(pointers[`/${key}/${i}/src`], 'value'),
+              ...getJSONSourceLocation(
+                pointers[`/${parent}/${i}/src`],
+                'value',
+              ),
             },
           });
         }
       }
     }
 
-    if (data.shortcuts) {
-      invariant(Array.isArray(data.shortcuts));
-      for (let i = 0; i < data.shortcuts.length; i++) {
-        const list = data.shortcuts[i].icons;
-        if (list) {
-          invariant(Array.isArray(list));
-          for (let j = 0; j < list.length; j++) {
-            const res = list[j];
-            res.src = asset.addURLDependency(res.src, {
-              loc: {
-                filePath: asset.filePath,
-                ...getJSONSourceLocation(
-                  pointers[`/shortcuts/${i}/icons/${j}/src`],
-                  'value',
-                ),
-              },
-            });
-          }
+    for (const key of ['icons', 'screenshots']) {
+      const list = data[key];
+      addResourceListToAsset(list, key);
+    }
+
+    for (const key of ['shortcuts', 'file_handlers']) {
+      const list = data[key];
+      if (list) {
+        invariant(Array.isArray(list));
+        for (let i = 0; i < list.length; i++) {
+          const iconList = list[i].icons;
+          addResourceListToAsset(iconList, `${key}/${i}/icons`);
         }
       }
     }