@realfavicongenerator/check-favicon 0.4.3 → 0.4.6

package/dist/desktop/desktop.d.ts

@@ -1,6 +1,6 @@
 import { CheckerMessage, DesktopFaviconReport, Fetcher } from "../types";
 import { HTMLElement } from 'node-html-parser';
-export declare const PngFaviconFileSize = 48;
+export declare const PngFaviconFileSize = 96;
 export declare const checkSvgFavicon: (baseUrl: string, head: HTMLElement | null, fetcher?: Fetcher) => Promise<CheckerMessage[]>;
 export declare const checkSvgFaviconFile: (baseUrl: string, url: string, fetcher: Fetcher) => Promise<CheckerMessage[]>;
 export declare const checkPngFavicon: (baseUrl: string, head: HTMLElement | null, fetcher?: Fetcher) => Promise<DesktopFaviconReport>;

package/dist/desktop/desktop.js

@@ -17,7 +17,7 @@ const types_1 = require("../types");
 const sharp_1 = __importDefault(require("sharp"));
 const helper_1 = require("../helper");
 const ico_1 = require("./ico");
-exports.PngFaviconFileSize = 48;
+exports.PngFaviconFileSize = 96;
 const checkSvgFavicon = (baseUrl_1, head_1, ...args_1) => __awaiter(void 0, [baseUrl_1, head_1, ...args_1], void 0, function* (baseUrl, head, fetcher = helper_1.fetchFetcher) {
     const messages = [];
     if (!head) {
@@ -133,7 +133,7 @@ const checkPngFavicon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [bas
         if (sizedIconMarkup.length === 0) {
             messages.push({
                 status: types_1.CheckerStatus.Error,
-                id: types_1.MessageId.no48x48DesktopPngFavicon,
+                id: types_1.MessageId.no96x96DesktopPngFavicon,
                 text: `There is no ${size} desktop PNG favicon`
             });
         }
@@ -143,7 +143,7 @@ const checkPngFavicon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [bas
                 id: types_1.MessageId.desktopPngFaviconDeclared,
                 text: `The ${size} desktop PNG favicon is declared`
             });
-            const href = icons[0].attributes.href;
+            const href = sizedIconMarkup[0].attributes.href;
             if (!href) {
                 messages.push({
                     status: types_1.CheckerStatus.Error,

package/dist/desktop/desktop.test.js

@@ -14,26 +14,26 @@ const desktop_1 = require("./desktop");
 const types_1 = require("../types");
 const helper_1 = require("../helper");
 const test_helper_1 = require("../test-helper");
-const runTest = (headFragment_1, output_1, ...args_1) => __awaiter(void 0, [headFragment_1, output_1, ...args_1], void 0, function* (headFragment, output, fetchDatabase = {}) {
+const runSvgTest = (headFragment_1, output_1, ...args_1) => __awaiter(void 0, [headFragment_1, output_1, ...args_1], void 0, function* (headFragment, output, fetchDatabase = {}) {
     const root = headFragment ? (0, node_html_parser_1.parse)(headFragment) : null;
     const result = yield (0, desktop_1.checkSvgFavicon)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
     const filteredMessages = result.map(m => ({ status: m.status, id: m.id }));
     expect(filteredMessages).toEqual(output);
 });
 test('checkSvgFavicon - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(null, [{
+    yield runSvgTest(null, [{
             status: types_1.CheckerStatus.Error,
             id: types_1.MessageId.noHead,
         }]);
 }));
 test('checkSvgFavicon - noSvgFavicon', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(`<title>SOme text</title>`, [{
+    yield runSvgTest(`<title>SOme text</title>`, [{
             status: types_1.CheckerStatus.Error,
             id: types_1.MessageId.noSvgFavicon,
         }]);
 }));
 test('checkSvgFavicon - multipleSvgFavicons', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(`
+    yield runSvgTest(`
   <link rel="icon" type="image/svg+xml" href="/the-icon.svg" />
   <link rel="icon" type="image/svg+xml" href="/another-icon.svg" />
   `, [{
@@ -42,7 +42,7 @@ test('checkSvgFavicon - multipleSvgFavicons', () => __awaiter(void 0, void 0, vo
         }]);
 }));
 test('checkSvgFavicon - svgFaviconDeclared & noSvgFaviconHref', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(`<link rel="icon" type="image/svg+xml" />`, [{
+    yield runSvgTest(`<link rel="icon" type="image/svg+xml" />`, [{
             status: types_1.CheckerStatus.Ok,
             id: types_1.MessageId.svgFaviconDeclared,
         }, {
@@ -51,7 +51,7 @@ test('checkSvgFavicon - svgFaviconDeclared & noSvgFaviconHref', () => __awaiter(
         }]);
 }));
 test('checkSvgFavicon - svgFaviconDeclared & svgFavicon404', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
+    yield runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
             status: types_1.CheckerStatus.Ok,
             id: types_1.MessageId.svgFaviconDeclared,
         }, {
@@ -60,7 +60,7 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFavicon404', () => __awaiter(voi
         }]);
 }));
 test('checkSvgFavicon - svgFaviconDeclared & svgFaviconCannotGet', () => __awaiter(void 0, void 0, void 0, function* () {
-    yield runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
+    yield runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
             status: types_1.CheckerStatus.Ok,
             id: types_1.MessageId.svgFaviconDeclared,
         }, {
@@ -76,7 +76,7 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFaviconCannotGet', () => __await
 test('checkSvgFavicon - svgFaviconDeclared & svgFaviconDownloadable & svgFaviconSquare', () => __awaiter(void 0, void 0, void 0, function* () {
     const testIconPath = './fixtures/happy-face.svg';
     const serpIcon = yield (0, helper_1.filePathToString)(testIconPath);
-    yield runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [
+    yield runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [
         {
             status: types_1.CheckerStatus.Ok,
             id: types_1.MessageId.svgFaviconDeclared,
@@ -95,3 +95,51 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFaviconDownloadable & svgFavicon
         }
     });
 }));
+const runPngTest = (headFragment_2, output_2, ...args_2) => __awaiter(void 0, [headFragment_2, output_2, ...args_2], void 0, function* (headFragment, output, fetchDatabase = {}) {
+    const root = headFragment ? (0, node_html_parser_1.parse)(headFragment) : null;
+    const result = yield (0, desktop_1.checkPngFavicon)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
+    const filteredMessages = result.messages.map(m => ({ status: m.status, id: m.id }));
+    expect(filteredMessages).toEqual(output);
+});
+const testIcon16 = './fixtures/16x16.png';
+const testIcon32 = './fixtures/32x32.png';
+const testIcon48 = './fixtures/48x48.png';
+const testIcon96 = './fixtures/96x96.png';
+test('checkSvgFavicon - Three PNG icons with different sizes', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runPngTest(`
+    <link rel="icon" type="image/png" sizes="16x16" href="/favicon/favicon-16x16.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/favicon/favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="48x48" href="/favicon/favicon-48x48.png">
+    <link rel="icon" type="image/png" sizes="96x96" href="/favicon/favicon-96x96.png">
+  `, [{
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.desktopPngFaviconDeclared,
+        }, {
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.desktopPngFaviconDownloadable,
+        }, {
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.desktopPngFaviconRightSize,
+        }], {
+        'https://example.com/favicon/favicon-16x16.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon16),
+        },
+        'https://example.com/favicon/favicon-32x32.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon32),
+        },
+        'https://example.com/favicon/favicon-48x48.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon48),
+        },
+        'https://example.com/favicon/favicon-96x96.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon96),
+        }
+    });
+}));

package/dist/types.d.ts

@@ -25,7 +25,7 @@ export declare enum MessageId {
     icoFaviconMissingSizes = 18,
     icoFaviconExpectedSizes = 19,
     noDesktopPngFavicon = 20,
-    no48x48DesktopPngFavicon = 21,
+    no96x96DesktopPngFavicon = 21,
     desktopPngFaviconDeclared = 22,
     noDesktopPngFaviconHref = 23,
     desktopPngFaviconCannotGet = 24,

package/dist/types.js

@@ -30,7 +30,7 @@ var MessageId;
     MessageId[MessageId["icoFaviconMissingSizes"] = 18] = "icoFaviconMissingSizes";
     MessageId[MessageId["icoFaviconExpectedSizes"] = 19] = "icoFaviconExpectedSizes";
     MessageId[MessageId["noDesktopPngFavicon"] = 20] = "noDesktopPngFavicon";
-    MessageId[MessageId["no48x48DesktopPngFavicon"] = 21] = "no48x48DesktopPngFavicon";
+    MessageId[MessageId["no96x96DesktopPngFavicon"] = 21] = "no96x96DesktopPngFavicon";
     MessageId[MessageId["desktopPngFaviconDeclared"] = 22] = "desktopPngFaviconDeclared";
     MessageId[MessageId["noDesktopPngFaviconHref"] = 23] = "noDesktopPngFaviconHref";
     MessageId[MessageId["desktopPngFaviconCannotGet"] = 24] = "desktopPngFaviconCannotGet";

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@realfavicongenerator/check-favicon",
-  "version": "0.4.3",
+  "version": "0.4.6",
   "description": "Check the favicon of a website",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest",
+    "test:watch": "jest --watch",
     "build": "tsc",
     "prepublishOnly": "npm run build"
   },
@@ -38,5 +39,5 @@
     "node-html-parser": "^6.1.13",
     "sharp": "^0.32.6"
   },
-  "gitHead": "521809bb438faddd63218e736f20f89ffb2cab71"
+  "gitHead": "f62941a779e6ce1b49ad97bfea8a9eb71e7ceba5"
 }

package/src/desktop/desktop.test.ts

@@ -1,12 +1,12 @@
 import { parse } from 'node-html-parser'
-import { checkSvgFavicon } from "./desktop";
+import { checkPngFavicon, checkSvgFavicon } from "./desktop";
 import { CheckerMessage, CheckerStatus, FetchResponse, MessageId } from '../types';
 import { filePathToReadableStream, filePathToString, stringToReadableStream } from '../helper';
 import { testFetcher } from '../test-helper';
 
 type TestOutput = Pick<CheckerMessage, 'id' | 'status'>[];
 
-const runTest = async (
+const runSvgTest = async (
   headFragment: string | null,
   output: TestOutput,
   fetchDatabase: { [url: string]: FetchResponse } = {}
@@ -18,21 +18,21 @@ const runTest = async (
 }
 
 test('checkSvgFavicon - noHead', async () => {
-  await runTest(null, [{
+  await runSvgTest(null, [{
     status: CheckerStatus.Error,
     id: MessageId.noHead,
   }]);
 })
 
 test('checkSvgFavicon - noSvgFavicon', async () => {
-  await runTest(`<title>SOme text</title>`, [{
+  await runSvgTest(`<title>SOme text</title>`, [{
     status: CheckerStatus.Error,
     id: MessageId.noSvgFavicon,
   }]);
 })
 
 test('checkSvgFavicon - multipleSvgFavicons', async () => {
-  await runTest(`
+  await runSvgTest(`
   <link rel="icon" type="image/svg+xml" href="/the-icon.svg" />
   <link rel="icon" type="image/svg+xml" href="/another-icon.svg" />
   `, [{
@@ -42,7 +42,7 @@ test('checkSvgFavicon - multipleSvgFavicons', async () => {
 })
 
 test('checkSvgFavicon - svgFaviconDeclared & noSvgFaviconHref', async () => {
-  await runTest(`<link rel="icon" type="image/svg+xml" />`, [{
+  await runSvgTest(`<link rel="icon" type="image/svg+xml" />`, [{
     status: CheckerStatus.Ok,
     id: MessageId.svgFaviconDeclared,
   }, {
@@ -52,7 +52,7 @@ test('checkSvgFavicon - svgFaviconDeclared & noSvgFaviconHref', async () => {
 })
 
 test('checkSvgFavicon - svgFaviconDeclared & svgFavicon404', async () => {
-  await runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
+  await runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
     status: CheckerStatus.Ok,
     id: MessageId.svgFaviconDeclared,
   }, {
@@ -62,7 +62,7 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFavicon404', async () => {
 })
 
 test('checkSvgFavicon - svgFaviconDeclared & svgFaviconCannotGet', async () => {
-  await runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
+  await runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [{
     status: CheckerStatus.Ok,
     id: MessageId.svgFaviconDeclared,
   }, {
@@ -81,7 +81,7 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFaviconDownloadable & svgFavicon
 
   const serpIcon = await filePathToString(testIconPath);
 
-  await runTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [
+  await runSvgTest(`<link rel="icon" type="image/svg+xml" href="/the-icon.svg" />`, [
     {
       status: CheckerStatus.Ok,
       id: MessageId.svgFaviconDeclared,
@@ -99,3 +99,59 @@ test('checkSvgFavicon - svgFaviconDeclared & svgFaviconDownloadable & svgFavicon
     }
   });
 })
+
+const runPngTest = async (
+  headFragment: string | null,
+  output: TestOutput,
+  fetchDatabase: { [url: string]: FetchResponse } = {}
+) => {
+  const root = headFragment ? parse(headFragment) : null;
+  const result = await checkPngFavicon('https://example.com/', root, testFetcher(fetchDatabase));
+  const filteredMessages = result.messages.map(m => ({ status: m.status, id: m.id }));
+  expect(filteredMessages).toEqual(output);
+}
+
+const testIcon16 = './fixtures/16x16.png';
+const testIcon32 = './fixtures/32x32.png';
+const testIcon48 = './fixtures/48x48.png';
+const testIcon96 = './fixtures/96x96.png';
+
+test('checkSvgFavicon - Three PNG icons with different sizes', async () => {
+  await runPngTest(`
+    <link rel="icon" type="image/png" sizes="16x16" href="/favicon/favicon-16x16.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/favicon/favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="48x48" href="/favicon/favicon-48x48.png">
+    <link rel="icon" type="image/png" sizes="96x96" href="/favicon/favicon-96x96.png">
+  `, [{
+    status: CheckerStatus.Ok,
+    id: MessageId.desktopPngFaviconDeclared,
+  }, {
+    status: CheckerStatus.Ok,
+    id: MessageId.desktopPngFaviconDownloadable,
+  }, {
+    status: CheckerStatus.Ok,
+    id: MessageId.desktopPngFaviconRightSize,
+  }],
+  {
+    'https://example.com/favicon/favicon-16x16.png': {
+      status: 200,
+      contentType: 'image/png',
+      readableStream: await filePathToReadableStream(testIcon16),
+    },
+    'https://example.com/favicon/favicon-32x32.png': {
+      status: 200,
+      contentType: 'image/png',
+      readableStream: await filePathToReadableStream(testIcon32),
+    },
+    'https://example.com/favicon/favicon-48x48.png': {
+      status: 200,
+      contentType: 'image/png',
+      readableStream: await filePathToReadableStream(testIcon48),
+    },
+    'https://example.com/favicon/favicon-96x96.png': {
+      status: 200,
+      contentType: 'image/png',
+      readableStream: await filePathToReadableStream(testIcon96),
+    }
+  });
+})

package/src/desktop/desktop.ts

@@ -4,7 +4,7 @@ import sharp from 'sharp'
 import { CheckIconProcessor, checkIcon, fetchFetcher, mergeUrlAndPath, readableStreamToString } from "../helper";
 import { checkIcoFavicon } from "./ico";
 
-export const PngFaviconFileSize = 48;
+export const PngFaviconFileSize = 96;
 
 export const checkSvgFavicon = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<CheckerMessage[]> => {
   const messages: CheckerMessage[] = [];
@@ -128,7 +128,7 @@ export const checkPngFavicon = async (baseUrl: string, head: HTMLElement | null,
     if (sizedIconMarkup.length === 0) {
       messages.push({
         status: CheckerStatus.Error,
-        id: MessageId.no48x48DesktopPngFavicon,
+        id: MessageId.no96x96DesktopPngFavicon,
         text: `There is no ${size} desktop PNG favicon`
       });
     } else {
@@ -137,8 +137,8 @@ export const checkPngFavicon = async (baseUrl: string, head: HTMLElement | null,
         id: MessageId.desktopPngFaviconDeclared,
         text: `The ${size} desktop PNG favicon is declared`
       });
-  
-      const href = icons[0].attributes.href;
+
+      const href = sizedIconMarkup[0].attributes.href;
       if (!href) {
         messages.push({
           status: CheckerStatus.Error,

package/src/types.ts

@@ -30,7 +30,7 @@ export enum MessageId {
   icoFaviconExpectedSizes,
 
   noDesktopPngFavicon,
-  no48x48DesktopPngFavicon,
+  no96x96DesktopPngFavicon,
   desktopPngFaviconDeclared,
   noDesktopPngFaviconHref,
   desktopPngFaviconCannotGet,