@realfavicongenerator/check-favicon 0.1.2 → 0.2.2

package/README.md

@@ -20,7 +20,7 @@ const head = root.querySelector('head');
 
 const desktopFaviconReport = await checkDesktopFavicon(pageUrl, head);
 const touchIconFaviconReport = await checkTouchIcon(pageUrl, head);
-const webAppManifestFaviconReport = await checkWebManifest(pageUrl, head);
+const webAppManifestFaviconReport = await checkWebAppManifest(pageUrl, head);
 
 console.log("Analysis and icons", desktopFaviconReport, touchIconFaviconReport, webAppManifestFaviconReport);
 ```

package/dist/check.js

@@ -13,11 +13,11 @@ exports.checkFavicon = void 0;
 const desktop_1 = require("./desktop/desktop");
 const helper_1 = require("./helper");
 const touch_icon_1 = require("./touch-icon");
-const web_manifest_1 = require("./web-manifest");
+const web_app_manifest_1 = require("./web-app-manifest");
 const checkFavicon = (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 desktop = yield (0, desktop_1.checkDesktopFavicon)(baseUrl, head, fetcher);
     const touchIcon = yield (0, touch_icon_1.checkTouchIcon)(baseUrl, head, fetcher);
-    const webAppManifest = yield (0, web_manifest_1.checkWebAppManifest)(baseUrl, head, fetcher);
+    const webAppManifest = yield (0, web_app_manifest_1.checkWebAppManifest)(baseUrl, head, fetcher);
     return {
         desktop,
         touchIcon,

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { CheckerStatus, MessageId, CheckerMessage, DesktopFaviconReport, TouchIconTitleReport, TouchIconIconReport, WebManifestReport, FaviconReport, TouchIconReport } from './types';
+export { CheckerStatus, MessageId, CheckerMessage, DesktopFaviconReport, TouchIconTitleReport, TouchIconIconReport, WebAppManifestReport, FaviconReport, TouchIconReport } from './types';
 export { checkDesktopFavicon, checkSvgFavicon } from "./desktop/desktop";
 export { checkTouchIcon } from "./touch-icon";
-export { checkWebAppManifest } from "./web-manifest";
+export { checkWebAppManifest } from "./web-app-manifest";
 export { checkFavicon } from "./check";

package/dist/index.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "checkDesktopFavicon", { enumerable: true, get: f
 Object.defineProperty(exports, "checkSvgFavicon", { enumerable: true, get: function () { return desktop_1.checkSvgFavicon; } });
 var touch_icon_1 = require("./touch-icon");
 Object.defineProperty(exports, "checkTouchIcon", { enumerable: true, get: function () { return touch_icon_1.checkTouchIcon; } });
-var web_manifest_1 = require("./web-manifest");
-Object.defineProperty(exports, "checkWebAppManifest", { enumerable: true, get: function () { return web_manifest_1.checkWebAppManifest; } });
+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; } });

package/dist/types.d.ts

@@ -97,7 +97,7 @@ export type TouchIconIconReport = {
     messages: CheckerMessage[];
     touchIcon: string | null;
 };
-export type WebManifestReport = {
+export type WebAppManifestReport = {
     messages: CheckerMessage[];
     name?: string;
     shortName?: string;
@@ -108,6 +108,6 @@ export type WebManifestReport = {
 export type FaviconReport = {
     desktop: DesktopFaviconReport;
     touchIcon: TouchIconReport;
-    webAppManifest: WebManifestReport;
+    webAppManifest: WebAppManifestReport;
 };
 export type TouchIconReport = TouchIconIconReport & TouchIconTitleReport;

package/dist/web-app-manifest.d.ts

@@ -0,0 +1,4 @@
+import { HTMLElement } from "node-html-parser";
+import { Fetcher, WebAppManifestReport } from "./types";
+export declare const checkWebAppManifest: (baseUrl: string, head: HTMLElement | null, fetcher?: Fetcher) => Promise<WebAppManifestReport>;
+export declare const checkWebAppManifestFile: (manifest: any, baseUrl: string, fetcher: Fetcher) => Promise<WebAppManifestReport>;

package/dist/web-app-manifest.js

@@ -0,0 +1,262 @@
+"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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkWebAppManifestFile = exports.checkWebAppManifest = void 0;
+const types_1 = require("./types");
+const helper_1 = require("./helper");
+const checkWebAppManifest = (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 = [];
+    let name = undefined;
+    let shortName = undefined;
+    let backgroundColor = undefined;
+    let themeColor = undefined;
+    let icon = null;
+    if (!head) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noHead,
+            text: 'No <head> element'
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    const manifestMarkup = head.querySelectorAll("link[rel='manifest']");
+    if (manifestMarkup.length === 0) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifest,
+            text: 'No web app manifest'
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    const href = manifestMarkup[0].getAttribute('href');
+    if (!href) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestHref,
+            text: 'The web app manifest markup has no `href` attribute'
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    const manifestUrl = (0, helper_1.mergeUrlAndPath)(baseUrl, href);
+    const manifest = yield fetcher(manifestUrl, 'application/json');
+    if (manifest.status === 404) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.manifest404,
+            text: `The web app manifest at \`${href}\` is not found`
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    else if (manifest.status >= 300 || !manifest.readableStream) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.manifestCannotGet,
+            text: `Cannot get the web app manifest at \`${href}\` (${manifest.status} error)`
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    let parsedManifest;
+    try {
+        parsedManifest = yield readableStreamToJson(manifest.readableStream);
+    }
+    catch (e) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.manifestInvalidJson,
+            text: `Cannot parse the web app manifest at \`${href}\``
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    const manifestReport = yield (0, exports.checkWebAppManifestFile)(parsedManifest, manifestUrl, fetcher);
+    return Object.assign(Object.assign({}, manifestReport), { messages: messages.concat(manifestReport.messages) });
+});
+exports.checkWebAppManifest = checkWebAppManifest;
+const readableStreamToJson = (stream) => __awaiter(void 0, void 0, void 0, function* () {
+    const reader = stream.getReader();
+    const decoder = new TextDecoder();
+    let result = '';
+    while (true) {
+        const { done, value } = yield reader.read();
+        if (done) {
+            break;
+        }
+        result += decoder.decode(value);
+    }
+    return JSON.parse(result);
+});
+const checkWebAppManifestFile = (manifest, baseUrl, fetcher) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, e_1, _b, _c;
+    const messages = [];
+    let icon = null;
+    const name = manifest.name || undefined;
+    if (!name) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestName,
+            text: 'The web app manifest has no `name`'
+        });
+    }
+    else {
+        messages.push({
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestName,
+            text: `The web app manifest has the name "${name}"`
+        });
+    }
+    const shortName = manifest.short_name || undefined;
+    if (!shortName) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestShortName,
+            text: 'The web app manifest has no `short_name`'
+        });
+    }
+    else {
+        messages.push({
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestShortName,
+            text: `The web app manifest has the short name "${shortName}"`
+        });
+    }
+    const backgroundColor = manifest.background_color || undefined;
+    if (!backgroundColor) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestBackgroundColor,
+            text: 'The web app manifest has no `background_color`'
+        });
+    }
+    else {
+        messages.push({
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestBackgroundColor,
+            text: `The web app manifest has the background color \`${backgroundColor}\``
+        });
+    }
+    const themeColor = manifest.theme_color || undefined;
+    if (!themeColor) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestThemeColor,
+            text: 'The web app manifest has no `theme_color`'
+        });
+    }
+    else {
+        messages.push({
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestThemeColor,
+            text: `The web app manifest has the theme color \`${themeColor}\``
+        });
+    }
+    const icons = manifest.icons;
+    if (!icons || !Array.isArray(icons) || icons.length === 0) {
+        messages.push({
+            status: types_1.CheckerStatus.Error,
+            id: types_1.MessageId.noManifestIcons,
+            text: 'The web app manifest has no `icons`'
+        });
+        return { messages, name, shortName, backgroundColor, themeColor, icon };
+    }
+    try {
+        for (var _d = true, _e = __asyncValues([192, 512]), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+            _c = _f.value;
+            _d = false;
+            const size = _c;
+            const iconEntry = icons.find((icon) => icon.sizes === `${size}x${size}`);
+            if (!iconEntry) {
+                messages.push({
+                    status: types_1.CheckerStatus.Error,
+                    id: types_1.MessageId.noManifestIcon,
+                    text: `The web app manifest has no ${size}x${size} icon`
+                });
+            }
+            else {
+                messages.push({
+                    status: types_1.CheckerStatus.Ok,
+                    id: types_1.MessageId.manifestIconDeclared,
+                    text: `The web app manifest has a ${size}x${size} icon`
+                });
+                const iconUrl = (0, helper_1.mergeUrlAndPath)(baseUrl, iconEntry.src);
+                const processor = {
+                    cannotGet: (status) => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Error,
+                            id: types_1.MessageId.manifestIconCannotGet,
+                            text: `The ${size}x${size} icon cannot be fetched (${status})`
+                        });
+                    },
+                    downloadable: () => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Ok,
+                            id: types_1.MessageId.manifestIconDownloadable,
+                            text: `The ${size}x${size} icon is downloadable`
+                        });
+                    },
+                    icon404: () => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Error,
+                            id: types_1.MessageId.manifestIcon404,
+                            text: `The ${size}x${size} icon is not found`
+                        });
+                    },
+                    noHref: () => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Error,
+                            id: types_1.MessageId.manifestIconNoHref,
+                            text: `The ${size}x${size} icon has no \`href\` attribute`
+                        });
+                    },
+                    notSquare: () => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Error,
+                            id: types_1.MessageId.manifestIconNotSquare,
+                            text: `The ${size}x${size} icon is not square`
+                        });
+                    },
+                    rightSize: () => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Ok,
+                            id: types_1.MessageId.manifestIconRightSize,
+                            text: `The ${size}x${size} icon has the right size`
+                        });
+                    },
+                    square: () => {
+                        // Ignore this, just check the size
+                    },
+                    wrongSize: (actualSize) => {
+                        messages.push({
+                            status: types_1.CheckerStatus.Error,
+                            id: types_1.MessageId.manifestIconWrongSize,
+                            text: `The ${size}x${size} icon has the wrong size (${actualSize})`
+                        });
+                    }
+                };
+                icon = yield (0, helper_1.checkIcon)(iconUrl, processor, fetcher, iconEntry.type || (0, helper_1.pathToMimeType)(iconEntry.src), size);
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return { messages, name, shortName, backgroundColor, themeColor, icon };
+});
+exports.checkWebAppManifestFile = checkWebAppManifestFile;

package/dist/web-app-manifest.test.d.ts

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

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

@@ -0,0 +1,172 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_html_parser_1 = __importDefault(require("node-html-parser"));
+const types_1 = require("./types");
+const web_app_manifest_1 = require("./web-app-manifest");
+const test_helper_1 = require("./test-helper");
+const helper_1 = require("./helper");
+const filterOutput = (report) => (Object.assign(Object.assign({}, report), { messages: report.messages.map(m => ({ status: m.status, id: m.id })) }));
+const runCheckTouchIconTitleTest = (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.default)(headFragment) : null;
+    const result = yield (0, web_app_manifest_1.checkWebAppManifest)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
+    expect(filterOutput(result)).toEqual(Object.assign({ name: undefined, shortName: undefined, backgroundColor: undefined, themeColor: undefined, icon: null }, output));
+});
+test('checkWebAppManifest - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest(null, { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noHead,
+            }] });
+}));
+test('checkWebAppManifest - noManifest', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<title>Hey</title>', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifest,
+            }] });
+}));
+test('checkWebAppManifest - noManifestHref', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<link rel="manifest" />', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestHref,
+            }] });
+}));
+test('checkWebAppManifest - manifest404', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<link rel="manifest" href="not-found.json" />', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.manifest404,
+            }] });
+}));
+test('checkWebAppManifest - manifestCannotGet', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<link rel="manifest" href="/error.json" />', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.manifestCannotGet,
+            }] }, {
+        'https://example.com/error.json': {
+            status: 500,
+            contentType: 'application/json',
+            readableStream: null
+        }
+    });
+}));
+test('checkWebAppManifest - manifestInvalidJson', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<link rel="manifest" href="/bad-manifest.json" />', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.manifestInvalidJson,
+            }] }, {
+        'https://example.com/bad-manifest.json': {
+            status: 200,
+            contentType: 'application/json',
+            readableStream: stringToReadableStream('{ bad JSON }')
+        }
+    });
+}));
+const stringToReadableStream = (str) => {
+    const stream = new ReadableStream({
+        start(controller) {
+            controller.enqueue(new TextEncoder().encode(str));
+            controller.close();
+        }
+    });
+    return stream;
+};
+test('checkWebAppManifestFile - Missing fields', () => __awaiter(void 0, void 0, void 0, function* () {
+    const report = yield (0, web_app_manifest_1.checkWebAppManifestFile)({
+        name: null,
+        short_name: null,
+        background_color: null,
+        theme_color: null,
+        icons: []
+    }, 'https://example.com/', (0, test_helper_1.testFetcher)({}));
+    expect(filterOutput(report)).toEqual({
+        messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestName,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestShortName,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestBackgroundColor,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestThemeColor,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noManifestIcons,
+            }],
+        name: undefined,
+        shortName: undefined,
+        backgroundColor: undefined,
+        themeColor: undefined,
+        icon: null
+    });
+}));
+const testIcon192 = './fixtures/192x192.png';
+const testIcon512 = './fixtures/512x512.png';
+test('checkWebAppManifestFile - Everything is fine', () => __awaiter(void 0, void 0, void 0, function* () {
+    const report = yield (0, web_app_manifest_1.checkWebAppManifestFile)({
+        name: 'My long name',
+        short_name: 'Short!',
+        background_color: '#123456',
+        theme_color: '#abcdef',
+        icons: [
+            { src: '/icon-192.png', sizes: '192x192', type: 'image/png' },
+            { src: '/icon-512.png', sizes: '512x512', type: 'image/png' }
+        ]
+    }, 'https://example.com/', (0, test_helper_1.testFetcher)({
+        'https://example.com/icon-192.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon192)
+        },
+        'https://example.com/icon-512.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon512)
+        }
+    }));
+    const expectedIconReport = [
+        {
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestIconDeclared,
+        }, {
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestIconDownloadable,
+        }, {
+            status: types_1.CheckerStatus.Ok,
+            id: types_1.MessageId.manifestIconRightSize,
+        }
+    ];
+    expect(filterOutput(report)).toEqual({
+        messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.manifestName,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.manifestShortName,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.manifestBackgroundColor,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.manifestThemeColor,
+            },
+            ...expectedIconReport, ...expectedIconReport], // Two icons
+        name: 'My long name',
+        shortName: 'Short!',
+        backgroundColor: '#123456',
+        themeColor: '#abcdef',
+        icon: (0, helper_1.bufferToDataUrl)(yield (0, helper_1.readableStreamToBuffer)(yield (0, helper_1.filePathToReadableStream)(testIcon512)), 'image/png')
+    });
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realfavicongenerator/check-favicon",
-  "version": "0.1.2",
+  "version": "0.2.2",
   "description": "Check the favicon of a website",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,9 +23,9 @@
   "author": "Philippe Bernard",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/RealFaviconGenerator/check-favicon/issues"
+    "url": "https://github.com/RealFaviconGenerator/core/issues"
   },
-  "homepage": "https://github.com/RealFaviconGenerator/check-favicon#readme",
+  "homepage": "https://github.com/RealFaviconGenerator/core#readme",
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.30",
@@ -38,5 +38,5 @@
     "node-html-parser": "^6.1.13",
     "sharp": "^0.32.6"
   },
-  "gitHead": "0aa4b14e46460471a3e1cf9d984b716198d15214"
+  "gitHead": "c6fb830f9f1aef0013f6dc013e6d2387a384d268"
 }

package/src/check.ts

@@ -3,7 +3,7 @@ import { fetchFetcher } from "./helper";
 import { checkTouchIcon } from "./touch-icon";
 import { FaviconReport, Fetcher } from "./types";
 import { HTMLElement } from 'node-html-parser'
-import { checkWebAppManifest } from "./web-manifest";
+import { checkWebAppManifest } from "./web-app-manifest";
 
 export const checkFavicon = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<FaviconReport> => {
   const desktop = await checkDesktopFavicon(baseUrl, head, fetcher);

package/src/index.ts

@@ -6,12 +6,12 @@ export {
   DesktopFaviconReport,
   TouchIconTitleReport,
   TouchIconIconReport,
-  WebManifestReport,
+  WebAppManifestReport,
   FaviconReport,
   TouchIconReport
 } from './types';
 
 export { checkDesktopFavicon, checkSvgFavicon } from "./desktop/desktop"
 export { checkTouchIcon } from "./touch-icon"
-export { checkWebAppManifest } from "./web-manifest"
+export { checkWebAppManifest } from "./web-app-manifest"
 export { checkFavicon } from "./check"

package/src/types.ts

@@ -111,7 +111,7 @@ export type TouchIconIconReport = {
   touchIcon: string | null,
 }
 
-export type WebManifestReport = {
+export type WebAppManifestReport = {
   messages: CheckerMessage[],
   name?: string,
   shortName?: string,
@@ -123,7 +123,7 @@ export type WebManifestReport = {
 export type FaviconReport = {
   desktop: DesktopFaviconReport,
   touchIcon: TouchIconReport,
-  webAppManifest: WebManifestReport
+  webAppManifest: WebAppManifestReport
 }
 
 export type TouchIconReport = TouchIconIconReport & TouchIconTitleReport;

package/src/{web-manifest.test.ts → web-app-manifest.test.ts}

@@ -1,6 +1,6 @@
 import parse from "node-html-parser";
-import { CheckerMessage, CheckerStatus, FetchResponse, MessageId, WebManifestReport } from "./types";
-import { checkWebAppManifest, checkWebManifestFile } from "./web-manifest";
+import { CheckerMessage, CheckerStatus, FetchResponse, MessageId, WebAppManifestReport } from "./types";
+import { checkWebAppManifest, checkWebAppManifestFile } from "./web-app-manifest";
 import { testFetcher } from "./test-helper";
 import { bufferToDataUrl, filePathToReadableStream, readableStreamToBuffer } from "./helper";
 
@@ -13,7 +13,7 @@ type TestOutput = {
   icon?: string | null
 }
 
-const filterOutput = (report: WebManifestReport): any => ({
+const filterOutput = (report: WebAppManifestReport): any => ({
   ...report,
   messages: report.messages.map(m => ({ status: m.status, id: m.id }))
 })
@@ -35,35 +35,35 @@ const runCheckTouchIconTitleTest = async (
   });
 }
 
-test('checkWebManifest - noHead', async () => {
+test('checkWebAppManifest - noHead', async () => {
   await runCheckTouchIconTitleTest(null, { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.noHead,
   }]});
 })
 
-test('checkWebManifest - noManifest', async () => {
+test('checkWebAppManifest - noManifest', async () => {
   await runCheckTouchIconTitleTest('<title>Hey</title>', { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.noManifest,
   }]});
 })
 
-test('checkWebManifest - noManifestHref', async () => {
+test('checkWebAppManifest - noManifestHref', async () => {
   await runCheckTouchIconTitleTest('<link rel="manifest" />', { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.noManifestHref,
   }]});
 })
 
-test('checkWebManifest - manifest404', async () => {
+test('checkWebAppManifest - manifest404', async () => {
   await runCheckTouchIconTitleTest('<link rel="manifest" href="not-found.json" />', { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.manifest404,
   }]});
 })
 
-test('checkWebManifest - manifestCannotGet', async () => {
+test('checkWebAppManifest - manifestCannotGet', async () => {
   await runCheckTouchIconTitleTest('<link rel="manifest" href="/error.json" />', { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.manifestCannotGet,
@@ -76,7 +76,7 @@ test('checkWebManifest - manifestCannotGet', async () => {
   });
 })
 
-test('checkWebManifest - manifestInvalidJson', async () => {
+test('checkWebAppManifest - manifestInvalidJson', async () => {
   await runCheckTouchIconTitleTest('<link rel="manifest" href="/bad-manifest.json" />', { messages: [{
     status: CheckerStatus.Error,
     id: MessageId.manifestInvalidJson,
@@ -99,8 +99,8 @@ const stringToReadableStream = (str: string) => {
   return stream;
 }
 
-test('checkWebManifestFile - Missing fields', async () => {
-  const report = await checkWebManifestFile({
+test('checkWebAppManifestFile - Missing fields', async () => {
+  const report = await checkWebAppManifestFile({
     name: null,
     short_name: null,
     background_color: null,
@@ -136,8 +136,8 @@ test('checkWebManifestFile - Missing fields', async () => {
 const testIcon192 = './fixtures/192x192.png';
 const testIcon512 = './fixtures/512x512.png';
 
-test('checkWebManifestFile - Everything is fine', async () => {
-  const report = await checkWebManifestFile({
+test('checkWebAppManifestFile - Everything is fine', async () => {
+  const report = await checkWebAppManifestFile({
     name: 'My long name',
     short_name: 'Short!',
     background_color: '#123456',

package/src/{web-manifest.ts → web-app-manifest.ts}

@@ -1,8 +1,8 @@
 import { HTMLElement } from "node-html-parser";
-import { CheckerMessage, CheckerStatus, Fetcher, MessageId, WebManifestReport } from "./types";
+import { CheckerMessage, CheckerStatus, Fetcher, MessageId, WebAppManifestReport } from "./types";
 import { CheckIconProcessor, checkIcon, fetchFetcher, mergeUrlAndPath, pathToMimeType } from "./helper";
 
-export const checkWebAppManifest = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<WebManifestReport> => {
+export const checkWebAppManifest = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<WebAppManifestReport> => {
   const messages: CheckerMessage[] = [];
   let name = undefined;
   let shortName = undefined;
@@ -77,7 +77,7 @@ export const checkWebAppManifest = async (baseUrl: string, head: HTMLElement | n
     return { messages, name, shortName, backgroundColor, themeColor, icon };
   }
 
-  const manifestReport = await checkWebManifestFile(parsedManifest, manifestUrl, fetcher);
+  const manifestReport = await checkWebAppManifestFile(parsedManifest, manifestUrl, fetcher);
 
   return {
     ...manifestReport,
@@ -99,7 +99,7 @@ const readableStreamToJson = async (stream: ReadableStream): Promise<any> => {
   return JSON.parse(result);
 }
 
-export const checkWebManifestFile = async (manifest: any, baseUrl: string, fetcher: Fetcher): Promise<WebManifestReport> => {
+export const checkWebAppManifestFile = async (manifest: any, baseUrl: string, fetcher: Fetcher): Promise<WebAppManifestReport> => {
   const messages: CheckerMessage[] = [];
   let icon = null;