@realfavicongenerator/check-favicon 0.4.17 → 0.5.0

package/dist/helper.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Fetcher } from './types';
+import { FaviconReport, Fetcher } from './types';
 export declare const filePathToReadableStream: (path: string) => Promise<ReadableStream>;
 export declare const filePathToString: (path: string) => Promise<string>;
 export declare const stringToReadableStream: (str: string) => ReadableStream;
@@ -28,3 +28,5 @@ export declare const parseSizesAttribute: (sizes: string | undefined | null) =>
 export declare const bufferToDataUrl: (buffer: Buffer, mimeType: string) => string;
 export declare const filePathToDataUrl: (filePath: string) => Promise<string>;
 export declare const fetchFetcher: Fetcher;
+export declare const reportHasErrors: (report: FaviconReport) => boolean;
+export declare const reportHasWarnings: (report: FaviconReport) => boolean;

package/dist/helper.js

@@ -12,8 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchFetcher = exports.filePathToDataUrl = exports.bufferToDataUrl = exports.parseSizesAttribute = exports.mergeUrlAndPath = exports.checkIcon = exports.pathToMimeType = exports.readableStreamToBuffer = exports.readableStreamToString = exports.stringToReadableStream = exports.filePathToString = exports.filePathToReadableStream = void 0;
+exports.reportHasWarnings = exports.reportHasErrors = exports.fetchFetcher = exports.filePathToDataUrl = exports.bufferToDataUrl = exports.parseSizesAttribute = exports.mergeUrlAndPath = exports.checkIcon = exports.pathToMimeType = exports.readableStreamToBuffer = exports.readableStreamToString = exports.stringToReadableStream = exports.filePathToString = exports.filePathToReadableStream = void 0;
 const promises_1 = __importDefault(require("fs/promises"));
+const types_1 = require("./types");
 const sharp_1 = __importDefault(require("sharp"));
 const filePathToReadableStream = (path) => __awaiter(void 0, void 0, void 0, function* () {
     const file = yield promises_1.default.open(path, 'r');
@@ -210,3 +211,15 @@ const fetchFetcher = (url, contentType) => __awaiter(void 0, void 0, void 0, fun
     };
 });
 exports.fetchFetcher = fetchFetcher;
+const reportHasErrors = (report) => {
+    return report.desktop.messages.some(message => message.status === types_1.CheckerStatus.Error) ||
+        report.touchIcon.messages.some(message => message.status === types_1.CheckerStatus.Error) ||
+        report.webAppManifest.messages.some(message => message.status === types_1.CheckerStatus.Error);
+};
+exports.reportHasErrors = reportHasErrors;
+const reportHasWarnings = (report) => {
+    return report.desktop.messages.some(message => message.status === types_1.CheckerStatus.Warning) ||
+        report.touchIcon.messages.some(message => message.status === types_1.CheckerStatus.Warning) ||
+        report.webAppManifest.messages.some(message => message.status === types_1.CheckerStatus.Warning);
+};
+exports.reportHasWarnings = reportHasWarnings;

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { checkDesktopFavicon, checkSvgFavicon } from "./desktop/desktop";
 export { checkTouchIcon } from "./touch-icon";
 export { checkWebAppManifest } from "./web-app-manifest";
 export { checkFavicon } from "./check";
+export { reportHasErrors, reportHasWarnings } from "./helper";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkFavicon = exports.checkWebAppManifest = exports.checkTouchIcon = exports.checkSvgFavicon = exports.checkDesktopFavicon = exports.MessageId = exports.CheckerStatus = void 0;
+exports.reportHasWarnings = exports.reportHasErrors = exports.checkFavicon = exports.checkWebAppManifest = exports.checkTouchIcon = exports.checkSvgFavicon = exports.checkDesktopFavicon = exports.MessageId = exports.CheckerStatus = void 0;
 var types_1 = require("./types");
 Object.defineProperty(exports, "CheckerStatus", { enumerable: true, get: function () { return types_1.CheckerStatus; } });
 Object.defineProperty(exports, "MessageId", { enumerable: true, get: function () { return types_1.MessageId; } });
@@ -13,3 +13,6 @@ var web_app_manifest_1 = require("./web-app-manifest");
 Object.defineProperty(exports, "checkWebAppManifest", { enumerable: true, get: function () { return web_app_manifest_1.checkWebAppManifest; } });
 var check_1 = require("./check");
 Object.defineProperty(exports, "checkFavicon", { enumerable: true, get: function () { return check_1.checkFavicon; } });
+var helper_1 = require("./helper");
+Object.defineProperty(exports, "reportHasErrors", { enumerable: true, get: function () { return helper_1.reportHasErrors; } });
+Object.defineProperty(exports, "reportHasWarnings", { enumerable: true, get: function () { return helper_1.reportHasWarnings; } });

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,

package/dist/types.d.ts

@@ -118,7 +118,7 @@ export type TouchIconTitleReport = {
 };
 export type TouchIconIconReport = {
     messages: CheckerMessage[];
-    touchIcon: string | null;
+    icon: CheckedIcon | null;
 };
 export type WebAppManifestReport = {
     messages: CheckerMessage[];
@@ -126,7 +126,7 @@ export type WebAppManifestReport = {
     shortName?: string;
     backgroundColor?: string;
     themeColor?: string;
-    icon: string | null;
+    icon: CheckedIcon | null;
 };
 export type FaviconReport = {
     desktop: DesktopFaviconReport;

package/dist/web-app-manifest.js

@@ -257,6 +257,6 @@ const checkWebAppManifestFile = (manifest, baseUrl, fetcher) => __awaiter(void 0
         }
         finally { if (e_1) throw e_1.error; }
     }
-    return { messages, name, shortName, backgroundColor, themeColor, icon: icon ? icon.content : null };
+    return { messages, name, shortName, backgroundColor, themeColor, icon };
 });
 exports.checkWebAppManifestFile = checkWebAppManifestFile;

package/dist/web-app-manifest.test.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realfavicongenerator/check-favicon",
-  "version": "0.4.17",
+  "version": "0.5.0",
   "description": "Check the favicon of a website",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,5 +40,5 @@
     "robots-parser": "^3.0.1",
     "sharp": "^0.32.6"
   },
-  "gitHead": "d1b623a15751d0df89d38fc5fd4915adc2e03646"
+  "gitHead": "f0e219642ecea42c14a567ba6d64bf639871974c"
 }

package/src/helper.ts

@@ -1,6 +1,6 @@
 import fs from 'fs/promises'
 import path from 'path';
-import { Fetcher } from './types';
+import { CheckerStatus, FaviconReport, Fetcher } from './types';
 import sharp, { FormatEnum } from 'sharp';
 
 export const filePathToReadableStream = async (path: string): Promise<ReadableStream> => {
@@ -231,3 +231,15 @@ export const fetchFetcher: Fetcher = async (url, contentType) => {
     readableStream: res.body
   }
 }
+
+export const reportHasErrors = (report: FaviconReport): boolean => {
+  return report.desktop.messages.some(message => message.status === CheckerStatus.Error) ||
+    report.touchIcon.messages.some(message => message.status === CheckerStatus.Error) ||
+    report.webAppManifest.messages.some(message => message.status === CheckerStatus.Error);
+}
+
+export const reportHasWarnings = (report: FaviconReport): boolean => {
+  return report.desktop.messages.some(message => message.status === CheckerStatus.Warning) ||
+    report.touchIcon.messages.some(message => message.status === CheckerStatus.Warning) ||
+    report.webAppManifest.messages.some(message => message.status === CheckerStatus.Warning);
+}

package/src/index.ts

@@ -15,3 +15,4 @@ export { checkDesktopFavicon, checkSvgFavicon } from "./desktop/desktop"
 export { checkTouchIcon } from "./touch-icon"
 export { checkWebAppManifest } from "./web-app-manifest"
 export { checkFavicon } from "./check"
+export { reportHasErrors, reportHasWarnings } from "./helper"

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

@@ -134,7 +134,7 @@ export type TouchIconTitleReport = {
 
 export type TouchIconIconReport = {
   messages: CheckerMessage[],
-  touchIcon: string | null,
+  icon: CheckedIcon | null,
 }
 
 export type WebAppManifestReport = {
@@ -143,7 +143,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 };
 }