@realfavicongenerator/check-favicon 0.0.2 → 0.1.1

package/dist/check.d.ts

@@ -0,0 +1,3 @@
+import { FaviconReport, Fetcher } from "./types";
+import { HTMLElement } from 'node-html-parser';
+export declare const checkFavicon: (baseUrl: string, head: HTMLElement | null, fetcher?: Fetcher) => Promise<FaviconReport>;

package/dist/check.js

@@ -0,0 +1,27 @@
+"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 });
+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 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);
+    return {
+        desktop,
+        touchIcon,
+        webAppManifest
+    };
+});
+exports.checkFavicon = checkFavicon;

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkWebManifest = exports.checkTouchIcon = exports.checkSvgFavicon = exports.checkDesktopFavicon = exports.MessageId = exports.CheckerStatus = void 0;
+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; } });
@@ -10,4 +10,6 @@ Object.defineProperty(exports, "checkSvgFavicon", { enumerable: true, get: funct
 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, "checkWebManifest", { enumerable: true, get: function () { return web_manifest_1.checkWebManifest; } });
+Object.defineProperty(exports, "checkWebAppManifest", { enumerable: true, get: function () { return web_manifest_1.checkWebAppManifest; } });
+var check_1 = require("./check");
+Object.defineProperty(exports, "checkFavicon", { enumerable: true, get: function () { return check_1.checkFavicon; } });

package/dist/web-manifest.d.ts

@@ -1,4 +1,4 @@
 import { HTMLElement } from "node-html-parser";
 import { Fetcher, WebManifestReport } from "./types";
-export declare const checkWebManifest: (baseUrl: string, head: HTMLElement | null, fetcher?: Fetcher) => Promise<WebManifestReport>;
+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

@@ -16,10 +16,10 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     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.checkWebManifest = void 0;
+exports.checkWebManifestFile = exports.checkWebAppManifest = void 0;
 const types_1 = require("./types");
 const helper_1 = require("./helper");
-const checkWebManifest = (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 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;
@@ -85,7 +85,7 @@ const checkWebManifest = (baseUrl_1, head_1, ...args_1) => __awaiter(void 0, [ba
     const manifestReport = yield (0, exports.checkWebManifestFile)(parsedManifest, manifestUrl, fetcher);
     return Object.assign(Object.assign({}, manifestReport), { messages: messages.concat(manifestReport.messages) });
 });
-exports.checkWebManifest = checkWebManifest;
+exports.checkWebAppManifest = checkWebAppManifest;
 const readableStreamToJson = (stream) => __awaiter(void 0, void 0, void 0, function* () {
     const reader = stream.getReader();
     const decoder = new TextDecoder();

package/dist/web-manifest.test.js

@@ -20,7 +20,7 @@ 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_manifest_1.checkWebManifest)('https://example.com/', root, (0, test_helper_1.testFetcher)(fetchDatabase));
+    const result = yield (0, web_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('checkWebManifest - noHead', () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realfavicongenerator/check-favicon",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "Check the favicon of a website",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,6 +36,6 @@
   "dependencies": {
     "decode-ico": "^0.4.1",
     "node-html-parser": "^6.1.13",
-    "sharp": "^0.33.3"
+    "sharp": "^0.32.6"
   }
 }

package/src/check.ts

@@ -0,0 +1,18 @@
+import { checkDesktopFavicon } from "./desktop/desktop";
+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";
+
+export const checkFavicon = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<FaviconReport> => {
+  const desktop = await checkDesktopFavicon(baseUrl, head, fetcher);
+  const touchIcon = await checkTouchIcon(baseUrl, head, fetcher);
+  const webAppManifest = await checkWebAppManifest(baseUrl, head, fetcher);
+
+  return {
+    desktop,
+    touchIcon,
+    webAppManifest
+  }
+}

package/src/index.ts

@@ -13,4 +13,5 @@ export {
 
 export { checkDesktopFavicon, checkSvgFavicon } from "./desktop/desktop"
 export { checkTouchIcon } from "./touch-icon"
-export { checkWebManifest } from "./web-manifest"
+export { checkWebAppManifest } from "./web-manifest"
+export { checkFavicon } from "./check"

package/src/web-manifest.test.ts

@@ -1,6 +1,6 @@
 import parse from "node-html-parser";
 import { CheckerMessage, CheckerStatus, FetchResponse, MessageId, WebManifestReport } from "./types";
-import { checkWebManifest, checkWebManifestFile } from "./web-manifest";
+import { checkWebAppManifest, checkWebManifestFile } from "./web-manifest";
 import { testFetcher } from "./test-helper";
 import { bufferToDataUrl, filePathToReadableStream, readableStreamToBuffer } from "./helper";
 
@@ -24,7 +24,7 @@ const runCheckTouchIconTitleTest = async (
   fetchDatabase: { [url: string]: FetchResponse } = {}
 ) => {
   const root = headFragment ? parse(headFragment) : null;
-  const result = await checkWebManifest('https://example.com/', root, testFetcher(fetchDatabase));
+  const result = await checkWebAppManifest('https://example.com/', root, testFetcher(fetchDatabase));
   expect(filterOutput(result)).toEqual({
     name: undefined,
     shortName: undefined,

package/src/web-manifest.ts

@@ -2,7 +2,7 @@ import { HTMLElement } from "node-html-parser";
 import { CheckerMessage, CheckerStatus, Fetcher, MessageId, WebManifestReport } from "./types";
 import { CheckIconProcessor, checkIcon, fetchFetcher, mergeUrlAndPath, pathToMimeType } from "./helper";
 
-export const checkWebManifest = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<WebManifestReport> => {
+export const checkWebAppManifest = async (baseUrl: string, head: HTMLElement | null, fetcher: Fetcher = fetchFetcher): Promise<WebManifestReport> => {
   const messages: CheckerMessage[] = [];
   let name = undefined;
   let shortName = undefined;