@realfavicongenerator/check-favicon 0.4.18 → 0.5.2

package/dist/desktop/ico.js

@@ -36,21 +36,16 @@ const checkIcoFavicon = (url, head, fetcher) => __awaiter(void 0, void 0, void 0
     ];
     let iconUrl = null;
     let images;
-    if (icos.length === 0) {
-        messages.push({
-            status: types_1.CheckerStatus.Error,
-            id: types_1.MessageId.noIcoFavicon,
-            text: 'There is no ICO favicon'
-        });
-    }
-    else if (icos.length > 1) {
+    let isDeclared = false;
+    if (icos.length > 1) {
         messages.push({
             status: types_1.CheckerStatus.Error,
             id: types_1.MessageId.multipleIcoFavicons,
             text: `There are ${icos.length} ICO favicons`
         });
     }
-    else {
+    else if (icos.length === 1) {
+        isDeclared = true;
         messages.push({
             status: types_1.CheckerStatus.Ok,
             id: types_1.MessageId.icoFaviconDeclared,
@@ -66,15 +61,35 @@ const checkIcoFavicon = (url, head, fetcher) => __awaiter(void 0, void 0, void 0
         }
         else {
             iconUrl = (0, helper_1.mergeUrlAndPath)(url, href);
-            const iconResponse = yield fetcher(iconUrl, 'image/x-icon');
-            if (iconResponse.status === 404) {
+        }
+    }
+    else {
+        // No declared ICO favicon, try the implicit /favicon.ico convention
+        iconUrl = (0, helper_1.mergeUrlAndPath)(url, '/favicon.ico');
+    }
+    // If we have an iconUrl (either from declaration or implicit), try to fetch it
+    if (iconUrl) {
+        const iconResponse = yield fetcher(iconUrl, 'image/x-icon');
+        if (iconResponse.status === 404) {
+            if (isDeclared) {
                 messages.push({
                     status: types_1.CheckerStatus.Error,
                     id: types_1.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: types_1.CheckerStatus.Error,
+                    id: types_1.MessageId.noIcoFavicon,
+                    text: 'There is no ICO favicon'
+                });
+                iconUrl = null;
+            }
+        }
+        else if (iconResponse.status >= 300 || !iconResponse.readableStream) {
+            if (isDeclared) {
                 messages.push({
                     status: types_1.CheckerStatus.Error,
                     id: types_1.MessageId.icoFaviconCannotGet,
@@ -82,42 +97,57 @@ const checkIcoFavicon = (url, head, fetcher) => __awaiter(void 0, void 0, void 0
                 });
             }
             else {
+                // Implicit favicon cannot be fetched, report no ICO favicon
+                messages.push({
+                    status: types_1.CheckerStatus.Error,
+                    id: types_1.MessageId.noIcoFavicon,
+                    text: 'There is no ICO favicon'
+                });
+                iconUrl = null;
+            }
+        }
+        else {
+            if (!isDeclared) {
+                messages.push({
+                    status: types_1.CheckerStatus.Ok,
+                    id: types_1.MessageId.icoFaviconImplicitInRoot,
+                    text: 'An implicit ICO favicon is found at /favicon.ico'
+                });
+            }
+            messages.push({
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDownloadable,
+                text: 'ICO favicon found'
+            });
+            const iconBuffer = yield (0, helper_1.readableStreamToBuffer)(iconResponse.readableStream);
+            images = (0, decode_ico_1.default)(iconBuffer);
+            const imageSizes = images.map(image => `${image.width}x${image.height}`);
+            const expectedSizes = exports.IcoFaviconSizes.map(size => `${size}x${size}`);
+            const extraSizes = imageSizes.filter(size => !expectedSizes.includes(size));
+            if (extraSizes.length > 0) {
+                messages.push({
+                    status: types_1.CheckerStatus.Warning,
+                    id: types_1.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: types_1.CheckerStatus.Warning,
+                    id: types_1.MessageId.icoFaviconMissingSizes,
+                    text: `Missing sizes in ICO favicon: ${missingSizes.join(', ')}`
+                });
+            }
+            if (extraSizes.length === 0 && missingSizes.length === 0) {
                 messages.push({
                     status: types_1.CheckerStatus.Ok,
-                    id: types_1.MessageId.icoFaviconDownloadable,
-                    text: 'ICO favicon found'
+                    id: types_1.MessageId.icoFaviconExpectedSizes,
+                    text: `The ICO favicon has the expected sizes (${imageSizes.join(', ')})`
                 });
-                const iconBuffer = yield (0, helper_1.readableStreamToBuffer)(iconResponse.readableStream);
-                images = yield (0, decode_ico_1.default)(iconBuffer);
-                const imageSizes = images.map(image => `${image.width}x${image.height}`);
-                const expectedSizes = exports.IcoFaviconSizes.map(size => `${size}x${size}`);
-                const extraSizes = imageSizes.filter(size => !expectedSizes.includes(size));
-                if (extraSizes.length > 0) {
-                    messages.push({
-                        status: types_1.CheckerStatus.Warning,
-                        id: types_1.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: types_1.CheckerStatus.Warning,
-                        id: types_1.MessageId.icoFaviconMissingSizes,
-                        text: `Missing sizes in ICO favicon: ${missingSizes.join(', ')}`
-                    });
-                }
-                if (extraSizes.length === 0 && missingSizes.length === 0) {
-                    messages.push({
-                        status: types_1.CheckerStatus.Ok,
-                        id: types_1.MessageId.icoFaviconExpectedSizes,
-                        text: `The ICO favicon has the expected sizes (${imageSizes.join(', ')})`
-                    });
-                }
             }
         }
     }
-    let content = null;
     const theIcon = {
         content: null,
         url: iconUrl,
@@ -127,7 +157,7 @@ const checkIcoFavicon = (url, head, fetcher) => __awaiter(void 0, void 0, void 0
     if (images) {
         const image = images[0];
         const mimeType = (image.type === "bmp") ? "image/bmp" : "image/png";
-        theIcon.content = yield (0, helper_1.bufferToDataUrl)(Buffer.from(image.data), mimeType);
+        theIcon.content = (0, helper_1.bufferToDataUrl)(Buffer.from(image.data.buffer, image.data.byteOffset, image.data.byteLength), mimeType);
         theIcon.width = image.width;
         theIcon.height = image.height;
     }

package/dist/desktop/ico.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/desktop/ico.test.js

@@ -0,0 +1,263 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_html_parser_1 = require("node-html-parser");
+const ico_1 = require("./ico");
+const types_1 = require("../types");
+const helper_1 = require("../helper");
+const test_helper_1 = require("../test-helper");
+const runIcoTest = (headFragment_1, output_1, ...args_1) => __awaiter(void 0, [headFragment_1, output_1, ...args_1], void 0, function* (headFragment, output, fetchDatabase = {}, checkContent = true) {
+    const root = headFragment ? (0, node_html_parser_1.parse)(headFragment) : null;
+    const result = yield (0, ico_1.checkIcoFavicon)('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.messages);
+    // Check icon properties - icon is always returned by checkIcoFavicon
+    const resultIcon = result.icon;
+    const outputIcon = output.icon;
+    expect(resultIcon.url).toEqual(outputIcon.url);
+    expect(resultIcon.width).toEqual(outputIcon.width);
+    expect(resultIcon.height).toEqual(outputIcon.height);
+    // For content, just check if it's null or not null unless exact match is needed
+    if (checkContent && outputIcon.content === null) {
+        expect(resultIcon.content).toBeNull();
+    }
+    else if (checkContent && outputIcon.content !== null) {
+        expect(resultIcon.content).not.toBeNull();
+        expect(resultIcon.content).toMatch(/^data:image\/(png|bmp);base64,/);
+    }
+});
+test('checkIcoFavicon - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(null, {
+        messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noHead,
+            }],
+        icon: {
+            content: null,
+            url: null,
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - noIcoFavicon', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`<title>Some text</title>`, {
+        messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noIcoFavicon,
+            }],
+        icon: {
+            content: null,
+            url: null,
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - implicit /favicon.ico when not declared', () => __awaiter(void 0, void 0, void 0, function* () {
+    const testIconPath = './fixtures/simple-ico.ico';
+    yield runIcoTest(`<title>Some text</title>`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconImplicitInRoot,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDownloadable,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconExpectedSizes,
+            }],
+        icon: {
+            content: "data:image/png;base64,placeholder", // Will be checked for format only
+            url: 'https://example.com/favicon.ico',
+            width: 48,
+            height: 48,
+        }
+    }, {
+        'https://example.com/favicon.ico': {
+            status: 200,
+            contentType: 'image/x-icon',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIconPath)
+        }
+    });
+}));
+test('checkIcoFavicon - multipleIcoFavicons with shortcut icon', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`
+  <link rel="shortcut icon" href="/favicon1.ico" />
+  <link rel="shortcut icon" href="/favicon2.ico" />
+  `, {
+        messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.multipleIcoFavicons,
+            }],
+        icon: {
+            content: null,
+            url: null,
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - multipleIcoFavicons with type="image/x-icon"', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`
+  <link rel="icon" type="image/x-icon" href="/favicon1.ico" />
+  <link rel="icon" type="image/x-icon" href="/favicon2.ico" />
+  `, {
+        messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.multipleIcoFavicons,
+            }],
+        icon: {
+            content: null,
+            url: null,
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - icoFaviconDeclared & noIcoFaviconHref', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`<link rel="shortcut icon" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noIcoFaviconHref,
+            }],
+        icon: {
+            content: null,
+            url: null,
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - icoFaviconDeclared & icoFavicon404', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`<link rel="shortcut icon" href="/favicon.ico" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.icoFavicon404,
+            }],
+        icon: {
+            content: null,
+            url: 'https://example.com/favicon.ico',
+            width: null,
+            height: null,
+        }
+    });
+}));
+test('checkIcoFavicon - icoFaviconDeclared & icoFaviconCannotGet', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runIcoTest(`<link rel="shortcut icon" href="/favicon.ico" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.icoFaviconCannotGet,
+            }],
+        icon: {
+            content: null,
+            url: 'https://example.com/favicon.ico',
+            width: null,
+            height: null,
+        }
+    }, {
+        'https://example.com/favicon.ico': {
+            status: 403,
+            contentType: 'image/x-icon'
+        }
+    });
+}));
+test('checkIcoFavicon - icoFaviconDeclared & icoFaviconDownloadable & icoFaviconExpectedSizes', () => __awaiter(void 0, void 0, void 0, function* () {
+    const testIconPath = './fixtures/simple-ico.ico';
+    yield runIcoTest(`<link rel="shortcut icon" href="/favicon.ico" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDownloadable,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconExpectedSizes,
+            }],
+        icon: {
+            content: "data:image/png;base64,placeholder", // Will be checked for format only
+            url: 'https://example.com/favicon.ico',
+            width: 48,
+            height: 48,
+        }
+    }, {
+        'https://example.com/favicon.ico': {
+            status: 200,
+            contentType: 'image/x-icon',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIconPath)
+        }
+    });
+}));
+test('checkIcoFavicon - using type="image/x-icon"', () => __awaiter(void 0, void 0, void 0, function* () {
+    const testIconPath = './fixtures/simple-ico.ico';
+    yield runIcoTest(`<link rel="icon" type="image/x-icon" href="/favicon.ico" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDownloadable,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconExpectedSizes,
+            }],
+        icon: {
+            content: "data:image/png;base64,placeholder", // Will be checked for format only
+            url: 'https://example.com/favicon.ico',
+            width: 48,
+            height: 48,
+        }
+    }, {
+        'https://example.com/favicon.ico': {
+            status: 200,
+            contentType: 'image/x-icon',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIconPath)
+        }
+    });
+}));
+// For https://github.com/RealFaviconGenerator/core/issues/2
+test('checkIcoFavicon - Protocol-relative URL', () => __awaiter(void 0, void 0, void 0, function* () {
+    const testIconPath = './fixtures/simple-ico.ico';
+    yield runIcoTest(`<link rel="shortcut icon" href="//example.com/favicon.ico" />`, {
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconDownloadable,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.icoFaviconExpectedSizes,
+            }],
+        icon: {
+            content: "data:image/png;base64,placeholder", // Will be checked for format only
+            url: 'https://example.com/favicon.ico',
+            width: 48,
+            height: 48,
+        }
+    }, {
+        'https://example.com/favicon.ico': {
+            status: 200,
+            contentType: 'image/x-icon',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIconPath)
+        }
+    });
+}));

package/dist/touch-icon.js

@@ -59,14 +59,14 @@ const checkTouchIconTitle = (baseUrl_1, head_1, ...args_1) => __awaiter(void 0,
 exports.checkTouchIconTitle = checkTouchIconTitle;
 const checkTouchIconIcon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [baseUrl_2, head_2, ...args_2], void 0, function* (baseUrl, head, fetcher = helper_1.fetchFetcher) {
     const messages = [];
-    let touchIcon = null;
+    let icon = null;
     if (!head) {
         messages.push({
             status: types_1.CheckerStatus.Error,
             id: types_1.MessageId.noHead,
             text: 'No <head> element'
         });
-        return { messages, touchIcon };
+        return { messages, icon };
     }
     const iconMarkup = head.querySelectorAll("link[rel='apple-touch-icon']");
     if (iconMarkup.length === 0) {
@@ -75,7 +75,7 @@ const checkTouchIconIcon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [
             id: types_1.MessageId.noTouchIcon,
             text: 'No touch icon declared'
         });
-        return { messages, touchIcon };
+        return { messages, icon };
     }
     messages.push({
         status: types_1.CheckerStatus.Ok,
@@ -97,7 +97,7 @@ const checkTouchIconIcon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [
             id: types_1.MessageId.noTouchIconHref,
             text: 'The touch icon has no href'
         });
-        return { messages, touchIcon };
+        return { messages, icon };
     }
     const touchIconUrl = (0, helper_1.mergeUrlAndPath)(baseUrl, iconHref);
     const processor = {
@@ -158,8 +158,8 @@ const checkTouchIconIcon = (baseUrl_2, head_2, ...args_2) => __awaiter(void 0, [
             });
         }
     };
-    touchIcon = yield (0, helper_1.checkIcon)(touchIconUrl, processor, fetcher, undefined);
-    return { messages, touchIcon: touchIcon ? touchIcon.content : null };
+    icon = yield (0, helper_1.checkIcon)(touchIconUrl, processor, fetcher, undefined);
+    return { messages, icon };
 });
 exports.checkTouchIconIcon = checkTouchIconIcon;
 const getDuplicatedSizes = (sizes) => {
@@ -173,7 +173,7 @@ const checkTouchIcon = (baseUrl_3, head_3, ...args_3) => __awaiter(void 0, [base
     return {
         messages: [...titleReport.messages, ...iconReport.messages],
         appTitle: titleReport.appTitle,
-        touchIcon: iconReport.touchIcon
+        icon: iconReport.icon
     };
 });
 exports.checkTouchIcon = checkTouchIcon;

package/dist/touch-icon.test.js

@@ -58,8 +58,8 @@ const runCheckTouchIconTest = (headFragment_2, output_2, ...args_2) => __awaiter
     const filteredMessages = result.messages.map(m => ({ status: m.status, id: m.id }));
     expect({
         messages: filteredMessages,
-        touchIcon: result.touchIcon
-    }).toEqual(Object.assign(Object.assign({}, output), { touchIcon: output.touchIcon || null }));
+        icon: result.icon
+    }).toEqual(Object.assign(Object.assign({}, output), { icon: output.icon || null }));
 });
 test('checkTouchIcon - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
     yield runCheckTouchIconTest(null, { messages: [{
@@ -83,7 +83,13 @@ test('checkTouchIcon - multipleTouchIcon - no size', () => __awaiter(void 0, voi
             }, {
                 status: types_1.CheckerStatus.Error,
                 id: types_1.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',
@@ -106,7 +112,14 @@ test('checkTouchIcon - multipleTouchIcon - specific size', () => __awaiter(void
             }, {
                 status: types_1.CheckerStatus.Error,
                 id: types_1.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',
@@ -132,7 +145,12 @@ test('checkTouchIcon - Regular case', () => __awaiter(void 0, void 0, void 0, fu
             }, {
                 status: types_1.CheckerStatus.Ok,
                 id: types_1.MessageId.touchIconSquare
-            }], touchIcon: (0, helper_1.bufferToDataUrl)(yield (0, helper_1.readableStreamToBuffer)(yield (0, helper_1.filePathToReadableStream)(testIcon)), 'image/png')
+            }], icon: {
+            content: (0, helper_1.bufferToDataUrl)(yield (0, helper_1.readableStreamToBuffer)(yield (0, helper_1.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,