@realfavicongenerator/check-favicon 0.4.18 → 0.5.2

package/src/desktop/ico.ts

@@ -28,20 +28,16 @@ export const checkIcoFavicon = async (url: string, head: HTMLElement | null, fet
 
   let iconUrl: string | null = null;
   let images;
+  let isDeclared = false;
 
-  if (icos.length === 0) {
-    messages.push({
-      status: CheckerStatus.Error,
-      id: MessageId.noIcoFavicon,
-      text: 'There is no ICO favicon'
-    });
-  } else if (icos.length > 1) {
+  if (icos.length > 1) {
     messages.push({
       status: CheckerStatus.Error,
       id: MessageId.multipleIcoFavicons,
       text: `There are ${icos.length} ICO favicons`
     });
-  } else {
+  } else if (icos.length === 1) {
+    isDeclared = true;
     messages.push({
       status: CheckerStatus.Ok,
       id: MessageId.icoFaviconDeclared,
@@ -57,63 +53,97 @@ export const checkIcoFavicon = async (url: string, head: HTMLElement | null, fet
       });
     } else {
       iconUrl = mergeUrlAndPath(url, href);
-      const iconResponse = await fetcher(iconUrl, 'image/x-icon');
-      if (iconResponse.status === 404) {
+    }
+  } else {
+    // No declared ICO favicon, try the implicit /favicon.ico convention
+    iconUrl = mergeUrlAndPath(url, '/favicon.ico');
+  }
+
+  // If we have an iconUrl (either from declaration or implicit), try to fetch it
+  if (iconUrl) {
+    const iconResponse = await fetcher(iconUrl, 'image/x-icon');
+    if (iconResponse.status === 404) {
+      if (isDeclared) {
         messages.push({
           status: CheckerStatus.Error,
           id: MessageId.icoFavicon404,
           text: `ICO favicon not found at ${iconUrl}`
         });
-      } else if (iconResponse.status >= 300 || !iconResponse.readableStream) {
+      } else {
+        // Implicit favicon not found, report no ICO favicon
+        messages.push({
+          status: CheckerStatus.Error,
+          id: MessageId.noIcoFavicon,
+          text: 'There is no ICO favicon'
+        });
+        iconUrl = null;
+      }
+    } else if (iconResponse.status >= 300 || !iconResponse.readableStream) {
+      if (isDeclared) {
         messages.push({
           status: CheckerStatus.Error,
           id: MessageId.icoFaviconCannotGet,
           text: `Error fetching ICO favicon at ${iconUrl} (status ${iconResponse.status})`
         });
       } else {
+        // Implicit favicon cannot be fetched, report no ICO favicon
+        messages.push({
+          status: CheckerStatus.Error,
+          id: MessageId.noIcoFavicon,
+          text: 'There is no ICO favicon'
+        });
+        iconUrl = null;
+      }
+    } else {
+      if (!isDeclared) {
         messages.push({
           status: CheckerStatus.Ok,
-          id: MessageId.icoFaviconDownloadable,
-          text: 'ICO favicon found'
+          id: MessageId.icoFaviconImplicitInRoot,
+          text: 'An implicit ICO favicon is found at /favicon.ico'
         });
+      }
+
+      messages.push({
+        status: CheckerStatus.Ok,
+        id: MessageId.icoFaviconDownloadable,
+        text: 'ICO favicon found'
+      });
+
+      const iconBuffer = await readableStreamToBuffer(iconResponse.readableStream);
+      images = decodeIco(iconBuffer);
+
+      const imageSizes = images.map(image => `${image.width}x${image.height}`);
+
+      const expectedSizes = IcoFaviconSizes.map(size => `${size}x${size}`);
+
+      const extraSizes = imageSizes.filter(size => !expectedSizes.includes(size));
+      if (extraSizes.length > 0) {
+        messages.push({
+          status: CheckerStatus.Warning,
+          id: MessageId.icoFaviconExtraSizes,
+          text: `Extra sizes found in ICO favicon: ${extraSizes.join(', ')}`
+        });
+      }
 
-        const iconBuffer = await readableStreamToBuffer(iconResponse.readableStream);
-        images = await decodeIco(iconBuffer);
-
-        const imageSizes = images.map(image => `${image.width}x${image.height}`);
-
-        const expectedSizes = IcoFaviconSizes.map(size => `${size}x${size}`);
-
-        const extraSizes = imageSizes.filter(size => !expectedSizes.includes(size));
-        if (extraSizes.length > 0) {
-          messages.push({
-            status: CheckerStatus.Warning,
-            id: MessageId.icoFaviconExtraSizes,
-            text: `Extra sizes found in ICO favicon: ${extraSizes.join(', ')}`
-          });
-        }
-
-        const missingSizes = expectedSizes.filter(size => !imageSizes.includes(size));
-        if (missingSizes.length > 0) {
-          messages.push({
-            status: CheckerStatus.Warning,
-            id: MessageId.icoFaviconMissingSizes,
-            text: `Missing sizes in ICO favicon: ${missingSizes.join(', ')}`
-          });
-        }
-
-        if (extraSizes.length === 0 && missingSizes.length === 0) {
-          messages.push({
-            status: CheckerStatus.Ok,
-            id: MessageId.icoFaviconExpectedSizes,
-            text: `The ICO favicon has the expected sizes (${imageSizes.join(', ')})`
-          });
-        }
+      const missingSizes = expectedSizes.filter(size => !imageSizes.includes(size));
+      if (missingSizes.length > 0) {
+        messages.push({
+          status: CheckerStatus.Warning,
+          id: MessageId.icoFaviconMissingSizes,
+          text: `Missing sizes in ICO favicon: ${missingSizes.join(', ')}`
+        });
+      }
+
+      if (extraSizes.length === 0 && missingSizes.length === 0) {
+        messages.push({
+          status: CheckerStatus.Ok,
+          id: MessageId.icoFaviconExpectedSizes,
+          text: `The ICO favicon has the expected sizes (${imageSizes.join(', ')})`
+        });
       }
     }
   }
 
-  let content: string | null = null;
   const theIcon: CheckedIcon = {
     content: null,
     url: iconUrl,
@@ -123,7 +153,7 @@ export const checkIcoFavicon = async (url: string, head: HTMLElement | null, fet
   if (images) {
     const image = images[0];
     const mimeType = (image.type === "bmp") ? "image/bmp" : "image/png";
-    theIcon.content = await bufferToDataUrl(Buffer.from(image.data), mimeType);
+    theIcon.content = bufferToDataUrl(Buffer.from(image.data.buffer, image.data.byteOffset, image.data.byteLength), mimeType);
     theIcon.width = image.width;
     theIcon.height = image.height;
   }

package/src/touch-icon.test.ts

@@ -1,5 +1,5 @@
 import { parse } from 'node-html-parser'
-import { CheckerMessage, CheckerStatus, FetchResponse, MessageId } from "./types";
+import { CheckedIcon, CheckerMessage, CheckerStatus, FetchResponse, MessageId } from "./types";
 import { checkTouchIcon, checkTouchIconIcon, checkTouchIconTitle, getDuplicatedSizes } from "./touch-icon";
 import { testFetcher } from './test-helper';
 import { bufferToDataUrl, filePathToReadableStream, readableStreamToBuffer } from './helper';
@@ -7,7 +7,7 @@ import { bufferToDataUrl, filePathToReadableStream, readableStreamToBuffer } fro
 type TestOutput = {
   messages: Pick<CheckerMessage, 'id' | 'status'>[],
   appTitle?: string,
-  touchIcon?: string | null
+  icon?: CheckedIcon | null,
 }
 
 const runCheckTouchIconTitleTest = async (
@@ -67,10 +67,10 @@ const runCheckTouchIconTest = async (
   const filteredMessages = result.messages.map(m => ({ status: m.status, id: m.id }));
   expect({
     messages: filteredMessages,
-    touchIcon: result.touchIcon
+    icon: result.icon
   }).toEqual({
     ...output,
-    touchIcon: output.touchIcon || null
+    icon: output.icon || null
   });
 }
 
@@ -98,7 +98,13 @@ test('checkTouchIcon - multipleTouchIcon - no size', async () => {
   }, {
     status: CheckerStatus.Error,
     id: MessageId.duplicatedTouchIconSizes,
-  }]}, {
+  }], icon: {
+      content: null,
+      url: 'https://example.com/some-icon.png',
+      width: null,
+      height: null
+    },
+  }, {
     'https://example.com/some-icon.png': {
       status: 200,
       contentType: 'image/png',
@@ -122,7 +128,14 @@ test('checkTouchIcon - multipleTouchIcon - specific size', async () => {
   }, {
     status: CheckerStatus.Error,
     id: MessageId.duplicatedTouchIconSizes,
-  }]}, {
+  }],
+    icon: {
+      content: null,
+      url: 'https://example.com/some-icon.png',
+      width: null,
+      height: null
+    },
+  }, {
     'https://example.com/some-icon.png': {
       status: 200,
       contentType: 'image/png',
@@ -150,7 +163,12 @@ test('checkTouchIcon - Regular case', async () => {
   },{
     status: CheckerStatus.Ok,
     id: MessageId.touchIconSquare
-  }], touchIcon: bufferToDataUrl(await readableStreamToBuffer(await filePathToReadableStream(testIcon)), 'image/png')
+  }], icon: {
+      content: bufferToDataUrl(await readableStreamToBuffer(await filePathToReadableStream(testIcon)), 'image/png'),
+      url: 'https://example.com/some-other-icon.png',
+      width: 180,
+      height: 180,
+    }
   }, {
     'https://example.com/some-other-icon.png': {
       status: 200,
@@ -161,7 +179,6 @@ test('checkTouchIcon - Regular case', async () => {
 })
 
 
-
 test('getDuplicatedSizes', () => {
   // No duplicates
   expect(getDuplicatedSizes([])).toEqual([]);

package/src/touch-icon.ts

@@ -59,7 +59,7 @@ export const checkTouchIconTitle = async (baseUrl: string, head: HTMLElement | n
 
 export const checkTouchIconIcon = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<TouchIconIconReport> => {
   const messages: CheckerMessage[] = [];
-  let touchIcon: CheckIconOutput | null = null;
+  let icon: CheckIconOutput | null = null;
 
   if (!head) {
     messages.push({
@@ -68,7 +68,7 @@ export const checkTouchIconIcon = async (baseUrl: string, head: HTMLElement | nu
       text: 'No <head> element'
     });
 
-    return { messages, touchIcon };
+    return { messages, icon };
   }
 
   const iconMarkup = head.querySelectorAll("link[rel='apple-touch-icon']");
@@ -79,7 +79,7 @@ export const checkTouchIconIcon = async (baseUrl: string, head: HTMLElement | nu
       text: 'No touch icon declared'
     });
 
-    return { messages, touchIcon };
+    return { messages, icon };
   }
 
   messages.push({
@@ -105,7 +105,7 @@ export const checkTouchIconIcon = async (baseUrl: string, head: HTMLElement | nu
       text: 'The touch icon has no href'
     });
 
-    return { messages, touchIcon };
+    return { messages, icon };
   }
 
   const touchIconUrl = mergeUrlAndPath(baseUrl, iconHref);
@@ -169,14 +169,14 @@ export const checkTouchIconIcon = async (baseUrl: string, head: HTMLElement | nu
     }
   }
 
-  touchIcon = await checkIcon(
+  icon = await checkIcon(
     touchIconUrl,
     processor,
     fetcher,
     undefined
   );
 
-  return { messages, touchIcon: touchIcon ? touchIcon.content : null };
+  return { messages, icon };
 }
 
 export const getDuplicatedSizes = (sizes: (string | undefined)[]): (string | undefined)[] => {
@@ -191,6 +191,6 @@ export const checkTouchIcon = async (baseUrl: string, head: HTMLElement | null,
   return {
     messages: [...titleReport.messages, ...iconReport.messages],
     appTitle: titleReport.appTitle,
-    touchIcon: iconReport.touchIcon
+    icon: iconReport.icon
   }
 }

package/src/types.ts

@@ -21,6 +21,7 @@ export enum MessageId {
   noIcoFavicon,
   multipleIcoFavicons,
   icoFaviconDeclared,
+  icoFaviconImplicitInRoot,
   noIcoFaviconHref,
   icoFavicon404,
   icoFaviconCannotGet,
@@ -134,7 +135,7 @@ export type TouchIconTitleReport = {
 
 export type TouchIconIconReport = {
   messages: CheckerMessage[],
-  touchIcon: string | null,
+  icon: CheckedIcon | null,
 }
 
 export type WebAppManifestReport = {
@@ -143,7 +144,7 @@ export type WebAppManifestReport = {
   shortName?: string,
   backgroundColor?: string,
   themeColor?: string,
-  icon: string | null
+  icon: CheckedIcon | null
 }
 
 export type FaviconReport = {

package/src/web-app-manifest.test.ts

@@ -191,6 +191,11 @@ test('checkWebAppManifestFile - Everything is fine', async () => {
     shortName: 'Short!',
     backgroundColor: '#123456',
     themeColor: '#abcdef',
-    icon: bufferToDataUrl(await readableStreamToBuffer(await filePathToReadableStream(testIcon512)), 'image/png')
+    icon: {
+      content: bufferToDataUrl(await readableStreamToBuffer(await filePathToReadableStream(testIcon512)), 'image/png'),
+      url: "https://example.com/icon-512.png",
+      width: 512,
+      height: 512,
+    },
   });
 })

package/src/web-app-manifest.ts

@@ -257,5 +257,5 @@ export const checkWebAppManifestFile = async (manifest: any, baseUrl: string, fe
     }
   }
 
-  return { messages, name, shortName, backgroundColor, themeColor, icon: icon ? icon.content : null };
+  return { messages, name, shortName, backgroundColor, themeColor, icon };
 }