@realfavicongenerator/check-favicon 0.0.1 → 0.1.0

package/dist/touch-icon.test.js

@@ -0,0 +1,195 @@
+"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 types_1 = require("./types");
+const touch_icon_1 = require("./touch-icon");
+const test_helper_1 = require("./test-helper");
+const helper_1 = require("./helper");
+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.parse)(headFragment) : null;
+    const result = yield (0, touch_icon_1.checkTouchIconTitle)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
+    const filteredMessages = result.messages.map(m => ({ status: m.status, id: m.id }));
+    expect({
+        messages: filteredMessages,
+        appTitle: result.appTitle
+    }).toEqual(output);
+});
+test('checkTouchIconTitle - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest(null, { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noHead,
+            }] });
+}));
+test('checkTouchIconTitle - noTouchWebAppTitle', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest('<title>Some text</title>', { messages: [{
+                status: types_1.CheckerStatus.Warning,
+                id: types_1.MessageId.noTouchWebAppTitle,
+            }] });
+}));
+test('checkTouchIconTitle - multipleTouchWebAppTitles', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest(`
+    <meta name="apple-mobile-web-app-title" content="First title">
+    <meta name="apple-mobile-web-app-title" content="Second title">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.multipleTouchWebAppTitles,
+            }] });
+}));
+test('checkTouchIconTitle - touchWebAppTitleDeclared', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTitleTest(`
+    <meta name="apple-mobile-web-app-title" content="The App Name">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchWebAppTitleDeclared,
+            }], appTitle: 'The App Name' });
+}));
+const runCheckTouchIconTest = (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, touch_icon_1.checkTouchIconIcon)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
+    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 }));
+});
+test('checkTouchIcon - noHead', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(null, { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noHead,
+            }] });
+}));
+test('checkTouchIcon - noTouchIcon', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest('<title>Some text</title>', { messages: [{
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.noTouchIcon,
+            }] });
+}));
+test('checkTouchIcon - touchIconWithSize', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(`
+    <link rel="apple-touch-icon" sizes="152x152" href="some-other-icon.png">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Warning,
+                id: types_1.MessageId.touchIconWithSize,
+            }] }, {
+        'https://example.com/some-other-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        }
+    });
+}));
+test('checkTouchIcon - multipleTouchIcon - no size', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(`
+    <link rel="apple-touch-icon" href="some-icon.png">
+    <link rel="apple-touch-icon" href="some-other-icon.png">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.duplicatedTouchIconSizes,
+            }] }, {
+        'https://example.com/some-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        },
+        'https://example.com/some-other-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        }
+    });
+}));
+test('checkTouchIcon - multipleTouchIcon - specific size', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(`
+    <link rel="apple-touch-icon" sizes="180x180" href="some-icon.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="some-other-icon.png">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Warning,
+                id: types_1.MessageId.touchIconWithSize,
+            }, {
+                status: types_1.CheckerStatus.Error,
+                id: types_1.MessageId.duplicatedTouchIconSizes,
+            }] }, {
+        'https://example.com/some-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        },
+        'https://example.com/some-other-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        }
+    });
+}));
+test('checkTouchIcon - touchIconWithSize', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(`
+    <link rel="apple-touch-icon" sizes="180x180" href="some-other-icon.png">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Warning,
+                id: types_1.MessageId.touchIconWithSize,
+            }] }, {
+        'https://example.com/some-other-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: null
+        }
+    });
+}));
+const testIcon = './fixtures/180x180.png';
+test('checkTouchIcon - Regular case', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield runCheckTouchIconTest(`
+    <link rel="apple-touch-icon" href="some-other-icon.png">
+  `, { messages: [{
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDeclared,
+            }, {
+                status: types_1.CheckerStatus.Ok,
+                id: types_1.MessageId.touchIconDownloadable,
+            }, {
+                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')
+    }, {
+        'https://example.com/some-other-icon.png': {
+            status: 200,
+            contentType: 'image/png',
+            readableStream: yield (0, helper_1.filePathToReadableStream)(testIcon)
+        }
+    });
+}));
+test('getDuplicatedSizes', () => {
+    // No duplicates
+    expect((0, touch_icon_1.getDuplicatedSizes)([])).toEqual([]);
+    expect((0, touch_icon_1.getDuplicatedSizes)([undefined])).toEqual([]);
+    expect((0, touch_icon_1.getDuplicatedSizes)(['180x180'])).toEqual([]);
+    expect((0, touch_icon_1.getDuplicatedSizes)([undefined, '180x180'])).toEqual([]);
+    // Duplicates
+    expect((0, touch_icon_1.getDuplicatedSizes)(['152x152', '180x180', '180x180'])).toEqual(['180x180']);
+    expect((0, touch_icon_1.getDuplicatedSizes)([undefined, '180x180', undefined, undefined])).toEqual([undefined]);
+    expect((0, touch_icon_1.getDuplicatedSizes)([
+        '152x152', '180x180', '152x152', undefined, '152x152', undefined
+    ])).toEqual([
+        '152x152', undefined
+    ]);
+});

package/dist/types.d.ts

@@ -0,0 +1,113 @@
+export declare enum CheckerStatus {
+    Ok = "Ok",
+    Error = "Error",
+    Warning = "Warning"
+}
+export declare enum MessageId {
+    noHead = 0,
+    svgFaviconDeclared = 1,
+    noSvgFavicon = 2,
+    multipleSvgFavicons = 3,
+    noSvgFaviconHref = 4,
+    svgFavicon404 = 5,
+    svgFaviconCannotGet = 6,
+    svgFaviconDownloadable = 7,
+    svgFaviconSquare = 8,
+    svgFaviconNotSquare = 9,
+    noIcoFavicon = 10,
+    multipleIcoFavicons = 11,
+    icoFaviconDeclared = 12,
+    noIcoFaviconHref = 13,
+    icoFavicon404 = 14,
+    icoFaviconCannotGet = 15,
+    icoFaviconDownloadable = 16,
+    icoFaviconExtraSizes = 17,
+    icoFaviconMissingSizes = 18,
+    icoFaviconExpectedSizes = 19,
+    noDesktopPngFavicon = 20,
+    no48x48DesktopPngFavicon = 21,
+    desktopPngFaviconDeclared = 22,
+    noDesktopPngFaviconHref = 23,
+    desktopPngFaviconCannotGet = 24,
+    desktopPngFaviconDownloadable = 25,
+    desktopPngFavicon404 = 26,
+    desktopPngFaviconWrongSize = 27,
+    desktopPngFaviconRightSize = 28,
+    noTouchWebAppTitle = 29,
+    multipleTouchWebAppTitles = 30,
+    emptyTouchWebAppTitle = 31,
+    touchWebAppTitleDeclared = 32,
+    noTouchIcon = 33,
+    duplicatedTouchIconSizes = 34,
+    touchIconWithSize = 35,
+    touchIconDeclared = 36,
+    noTouchIconHref = 37,
+    touchIcon404 = 38,
+    touchIconCannotGet = 39,
+    touchIconDownloadable = 40,
+    touchIconSquare = 41,
+    touchIcon180x180 = 42,
+    touchIconNotSquare = 43,
+    touchIconWrongSize = 44,
+    noManifest = 45,
+    noManifestHref = 46,
+    manifest404 = 47,
+    manifestCannotGet = 48,
+    manifestInvalidJson = 49,
+    manifestName = 50,
+    noManifestName = 51,
+    manifestShortName = 52,
+    noManifestShortName = 53,
+    manifestBackgroundColor = 54,
+    noManifestBackgroundColor = 55,
+    manifestThemeColor = 56,
+    noManifestThemeColor = 57,
+    noManifestIcons = 58,
+    noManifestIcon = 59,
+    manifestIconDeclared = 60,
+    manifestIconCannotGet = 61,
+    manifestIconDownloadable = 62,
+    manifestIcon404 = 63,
+    manifestIconNoHref = 64,
+    manifestIconNotSquare = 65,
+    manifestIconRightSize = 66,
+    manifestIconSquare = 67,
+    manifestIconWrongSize = 68
+}
+export type CheckerMessage = {
+    status: CheckerStatus;
+    id: MessageId;
+    text: string;
+};
+export type FetchResponse = {
+    status: number;
+    contentType: string | null;
+    readableStream?: ReadableStream | null;
+};
+export type Fetcher = (url: string, contentType?: string) => Promise<FetchResponse>;
+export type DesktopFaviconReport = {
+    messages: CheckerMessage[];
+    icon: string | null;
+};
+export type TouchIconTitleReport = {
+    messages: CheckerMessage[];
+    appTitle?: string;
+};
+export type TouchIconIconReport = {
+    messages: CheckerMessage[];
+    touchIcon: string | null;
+};
+export type WebManifestReport = {
+    messages: CheckerMessage[];
+    name?: string;
+    shortName?: string;
+    backgroundColor?: string;
+    themeColor?: string;
+    icon: string | null;
+};
+export type FaviconReport = {
+    desktop: DesktopFaviconReport;
+    touchIcon: TouchIconReport;
+    webAppManifest: WebManifestReport;
+};
+export type TouchIconReport = TouchIconIconReport & TouchIconTitleReport;

package/dist/types.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageId = exports.CheckerStatus = void 0;
+var CheckerStatus;
+(function (CheckerStatus) {
+    CheckerStatus["Ok"] = "Ok";
+    CheckerStatus["Error"] = "Error";
+    CheckerStatus["Warning"] = "Warning";
+})(CheckerStatus || (exports.CheckerStatus = CheckerStatus = {}));
+var MessageId;
+(function (MessageId) {
+    MessageId[MessageId["noHead"] = 0] = "noHead";
+    MessageId[MessageId["svgFaviconDeclared"] = 1] = "svgFaviconDeclared";
+    MessageId[MessageId["noSvgFavicon"] = 2] = "noSvgFavicon";
+    MessageId[MessageId["multipleSvgFavicons"] = 3] = "multipleSvgFavicons";
+    MessageId[MessageId["noSvgFaviconHref"] = 4] = "noSvgFaviconHref";
+    MessageId[MessageId["svgFavicon404"] = 5] = "svgFavicon404";
+    MessageId[MessageId["svgFaviconCannotGet"] = 6] = "svgFaviconCannotGet";
+    MessageId[MessageId["svgFaviconDownloadable"] = 7] = "svgFaviconDownloadable";
+    MessageId[MessageId["svgFaviconSquare"] = 8] = "svgFaviconSquare";
+    MessageId[MessageId["svgFaviconNotSquare"] = 9] = "svgFaviconNotSquare";
+    MessageId[MessageId["noIcoFavicon"] = 10] = "noIcoFavicon";
+    MessageId[MessageId["multipleIcoFavicons"] = 11] = "multipleIcoFavicons";
+    MessageId[MessageId["icoFaviconDeclared"] = 12] = "icoFaviconDeclared";
+    MessageId[MessageId["noIcoFaviconHref"] = 13] = "noIcoFaviconHref";
+    MessageId[MessageId["icoFavicon404"] = 14] = "icoFavicon404";
+    MessageId[MessageId["icoFaviconCannotGet"] = 15] = "icoFaviconCannotGet";
+    MessageId[MessageId["icoFaviconDownloadable"] = 16] = "icoFaviconDownloadable";
+    MessageId[MessageId["icoFaviconExtraSizes"] = 17] = "icoFaviconExtraSizes";
+    MessageId[MessageId["icoFaviconMissingSizes"] = 18] = "icoFaviconMissingSizes";
+    MessageId[MessageId["icoFaviconExpectedSizes"] = 19] = "icoFaviconExpectedSizes";
+    MessageId[MessageId["noDesktopPngFavicon"] = 20] = "noDesktopPngFavicon";
+    MessageId[MessageId["no48x48DesktopPngFavicon"] = 21] = "no48x48DesktopPngFavicon";
+    MessageId[MessageId["desktopPngFaviconDeclared"] = 22] = "desktopPngFaviconDeclared";
+    MessageId[MessageId["noDesktopPngFaviconHref"] = 23] = "noDesktopPngFaviconHref";
+    MessageId[MessageId["desktopPngFaviconCannotGet"] = 24] = "desktopPngFaviconCannotGet";
+    MessageId[MessageId["desktopPngFaviconDownloadable"] = 25] = "desktopPngFaviconDownloadable";
+    MessageId[MessageId["desktopPngFavicon404"] = 26] = "desktopPngFavicon404";
+    MessageId[MessageId["desktopPngFaviconWrongSize"] = 27] = "desktopPngFaviconWrongSize";
+    MessageId[MessageId["desktopPngFaviconRightSize"] = 28] = "desktopPngFaviconRightSize";
+    MessageId[MessageId["noTouchWebAppTitle"] = 29] = "noTouchWebAppTitle";
+    MessageId[MessageId["multipleTouchWebAppTitles"] = 30] = "multipleTouchWebAppTitles";
+    MessageId[MessageId["emptyTouchWebAppTitle"] = 31] = "emptyTouchWebAppTitle";
+    MessageId[MessageId["touchWebAppTitleDeclared"] = 32] = "touchWebAppTitleDeclared";
+    MessageId[MessageId["noTouchIcon"] = 33] = "noTouchIcon";
+    MessageId[MessageId["duplicatedTouchIconSizes"] = 34] = "duplicatedTouchIconSizes";
+    MessageId[MessageId["touchIconWithSize"] = 35] = "touchIconWithSize";
+    MessageId[MessageId["touchIconDeclared"] = 36] = "touchIconDeclared";
+    MessageId[MessageId["noTouchIconHref"] = 37] = "noTouchIconHref";
+    MessageId[MessageId["touchIcon404"] = 38] = "touchIcon404";
+    MessageId[MessageId["touchIconCannotGet"] = 39] = "touchIconCannotGet";
+    MessageId[MessageId["touchIconDownloadable"] = 40] = "touchIconDownloadable";
+    MessageId[MessageId["touchIconSquare"] = 41] = "touchIconSquare";
+    MessageId[MessageId["touchIcon180x180"] = 42] = "touchIcon180x180";
+    MessageId[MessageId["touchIconNotSquare"] = 43] = "touchIconNotSquare";
+    MessageId[MessageId["touchIconWrongSize"] = 44] = "touchIconWrongSize";
+    MessageId[MessageId["noManifest"] = 45] = "noManifest";
+    MessageId[MessageId["noManifestHref"] = 46] = "noManifestHref";
+    MessageId[MessageId["manifest404"] = 47] = "manifest404";
+    MessageId[MessageId["manifestCannotGet"] = 48] = "manifestCannotGet";
+    MessageId[MessageId["manifestInvalidJson"] = 49] = "manifestInvalidJson";
+    MessageId[MessageId["manifestName"] = 50] = "manifestName";
+    MessageId[MessageId["noManifestName"] = 51] = "noManifestName";
+    MessageId[MessageId["manifestShortName"] = 52] = "manifestShortName";
+    MessageId[MessageId["noManifestShortName"] = 53] = "noManifestShortName";
+    MessageId[MessageId["manifestBackgroundColor"] = 54] = "manifestBackgroundColor";
+    MessageId[MessageId["noManifestBackgroundColor"] = 55] = "noManifestBackgroundColor";
+    MessageId[MessageId["manifestThemeColor"] = 56] = "manifestThemeColor";
+    MessageId[MessageId["noManifestThemeColor"] = 57] = "noManifestThemeColor";
+    MessageId[MessageId["noManifestIcons"] = 58] = "noManifestIcons";
+    MessageId[MessageId["noManifestIcon"] = 59] = "noManifestIcon";
+    MessageId[MessageId["manifestIconDeclared"] = 60] = "manifestIconDeclared";
+    MessageId[MessageId["manifestIconCannotGet"] = 61] = "manifestIconCannotGet";
+    MessageId[MessageId["manifestIconDownloadable"] = 62] = "manifestIconDownloadable";
+    MessageId[MessageId["manifestIcon404"] = 63] = "manifestIcon404";
+    MessageId[MessageId["manifestIconNoHref"] = 64] = "manifestIconNoHref";
+    MessageId[MessageId["manifestIconNotSquare"] = 65] = "manifestIconNotSquare";
+    MessageId[MessageId["manifestIconRightSize"] = 66] = "manifestIconRightSize";
+    MessageId[MessageId["manifestIconSquare"] = 67] = "manifestIconSquare";
+    MessageId[MessageId["manifestIconWrongSize"] = 68] = "manifestIconWrongSize";
+})(MessageId || (exports.MessageId = MessageId = {}));

package/dist/web-manifest.d.ts

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

package/dist/web-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.checkWebManifestFile = 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.checkWebManifestFile)(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 checkWebManifestFile = (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.checkWebManifestFile = checkWebManifestFile;

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

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