verify-image-url 1.4.0 → 1.5.1

package/README.md

@@ -1,6 +1,6 @@
 # verify-image-url
 
-A package to check if a URL is an image URL or not and also get the valid image link from it
+Verify if a URL is an image or extract the image URL from Open Graph meta tags.
 
 ## Install
 
@@ -16,17 +16,22 @@ const { verifyImageURL } = require('verify-image-url');
 await verifyImageURL('https://example.com/example.png');
 // -> { isImage: true, imageURL: 'https://example.com/example.png' }
 
-await verifyImageURL('https://example.com/example.png', { timeout: 10000 }); // Sets timeout to 10 seconds, default is 5
+// HTML page with og:image
+await verifyImageURL('https://giveaway.boats');
+// -> { isImage: true, imageURL: 'https://giveaway.boats/assets/logo.png' }
 
-await verifyImageURL('https://prnt.sc/zrfn0r');
-// -> { isImage: true, imageURL: 'https://image.prntscr.com/image/-ndZGuDMRfu7oDAR-fESzg.png' }
-// This link is from og:image meta tag since prnt.sc is a site where you can upload screenshots and get the web page url from it which isn't your image link but it's in the meta tag
+// Supports custom timeouts (default: 5s)
+await verifyImageURL('https://example.com/example.png', { timeout: 10000 });
 
-// Also works with SVGs
+// Works with SVGs
 await verifyImageURL('https://example.com/example.svg', { allowSVG: true });
 // -> { isImage: true, imageURL: 'https://example.com/example.svg' }
 
-// You can also have it send to a proxy if you want
-await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com', auth: 'super secret auth' } });
-// This sends a POST request to the provided proxy url with the JSON body `{ method: 'GET', url: 'url' }` that the proxy can use to send request and send back the response
+// Route through a proxy
+await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com?url=' } });
+// This sends a GET request to https://proxy.example.com?url=https://example.com/example.png
+
+// Proxy with authentication
+await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com', auth: 'secret' } });
+// This sends a POST request to https://proxy.example.com with the JSON body `{ method: 'GET', url: 'https://example.com/example.png' }` along with Authorization header set to 'secret'
 ```

package/dist/index.js

@@ -1,53 +1,66 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyImageURL = void 0;
-const got_1 = __importDefault(require("got"));
-const image_type_1 = __importDefault(require("image-type"));
-const is_svg_1 = __importDefault(require("is-svg"));
-const is_url_1 = __importDefault(require("is-url"));
-const jsdom_1 = require("jsdom");
-const url_1 = require("url");
-const verifyImageURL = async (url, options) => {
-    var _a, _b;
-    const getReturnValue = (isImage = false, imageURL = url) => ({ isImage, imageURL });
-    if (!(0, is_url_1.default)(url))
-        return getReturnValue();
-    try {
-        const responseBuffer = (options === null || options === void 0 ? void 0 : options.proxy) ? (await (0, got_1.default)(options.proxy.url, { headers: { 'User-Agent': 'got', Authorization: (_a = options === null || options === void 0 ? void 0 : options.proxy) === null || _a === void 0 ? void 0 : _a.auth }, method: 'POST', timeout: 5000, json: { method: 'GET', url } })).rawBody : (await (0, got_1.default)(url, { headers: { 'User-Agent': 'got' }, timeout: (_b = options === null || options === void 0 ? void 0 : options.timeout) !== null && _b !== void 0 ? _b : 5000 })).rawBody;
-        const imageType = (0, image_type_1.default)(responseBuffer);
-        if (!(imageType === null || imageType === void 0 ? void 0 : imageType.mime.startsWith('image'))) {
-            if (responseBuffer.includes('og:image') || responseBuffer.includes('itemprop="image"')) {
-                const dom = new jsdom_1.JSDOM(responseBuffer);
-                const meta = dom.window.document.querySelector('meta[property="og:image"]') || dom.window.document.querySelector('meta[itemprop="image"]');
-                if (!(meta === null || meta === void 0 ? void 0 : meta.content))
-                    return getReturnValue();
-                if (meta.content[0] === '/' && meta.content[1] !== '/')
-                    meta.content = `${new url_1.URL(url).origin}${meta.content}`;
-                if (!(0, is_url_1.default)(meta.content))
-                    return getReturnValue();
-                if (!/^https?:/.test(meta.content)) {
-                    if (/^\/\//.test(meta.content))
-                        meta.content = `http:${meta.content}`;
-                    else if (/^\//.test(meta.content))
-                        meta.content = `http:/${meta.content}`;
-                    else
-                        meta.content = `http://${meta.content}`;
-                }
-                return getReturnValue(true, meta.content);
-            }
-            else if ((options === null || options === void 0 ? void 0 : options.allowSVG) && (0, is_svg_1.default)(responseBuffer))
-                return getReturnValue(true);
-        }
-        else
-            return getReturnValue(true);
-    }
-    catch (err) {
-        if (err.code !== 'ETIMEDOUT' && err.code !== 'ENOTFOUND' && err.message !== 'Response code 404 (Not Found)')
-            console.error(err);
-    }
-    return getReturnValue();
-};
-exports.verifyImageURL = verifyImageURL;
+import * as cheerio from 'cheerio';
+import got from 'got';
+import getImageType from 'image-type';
+import isSvg from 'is-svg';
+import isURL from 'is-url';
+import { URL } from 'url';
+export const verifyImageURL = async (url, options) => {
+    const getReturnValue = (isImage = false, imageURL = url) => ({ isImage, imageURL });
+    if (!isURL(url))
+        return getReturnValue();
+    try {
+        let requestURL;
+        const requestOptions = {
+            headers: {
+                'User-Agent': 'got',
+            },
+            timeout: options?.timeout ?? 5000,
+        };
+        // If proxy auth is provided, send a POST request to the proxy url with the provided auth
+        if (options?.proxy?.auth) {
+            requestURL = options.proxy.url;
+            requestOptions.method = 'POST';
+            requestOptions.json = { method: 'GET', url };
+            requestOptions.headers.Authorization = options.proxy.auth;
+        }
+        // Otherwise, if a proxy url is provided, use it
+        else if (options?.proxy?.url)
+            requestURL = `${options.proxy.url}${encodeURIComponent(url)}`;
+        // Otherwise, send the request directly
+        else
+            requestURL = url;
+        const responseBuffer = (await got.default(requestURL, requestOptions)).rawBody;
+        const imageType = getImageType(responseBuffer);
+        if (!imageType?.mime.startsWith('image')) {
+            if (responseBuffer.includes('og:image') || responseBuffer.includes('itemprop="image"')) {
+                const $ = cheerio.load(responseBuffer);
+                const meta = $('meta[property="og:image"]') || $('meta[itemprop="image"]');
+                let metaContent = meta?.attr('content');
+                if (!metaContent)
+                    return getReturnValue();
+                if (metaContent[0] === '/' && metaContent[1] !== '/')
+                    metaContent = `${new URL(url).origin}${metaContent}`;
+                if (!isURL(metaContent))
+                    return getReturnValue();
+                if (!/^https?:/.test(metaContent)) {
+                    if (/^\/\//.test(metaContent))
+                        metaContent = `http:${metaContent}`;
+                    else if (/^\//.test(metaContent))
+                        metaContent = `http:/${metaContent}`;
+                    else
+                        metaContent = `http://${metaContent}`;
+                }
+                return getReturnValue(true, metaContent);
+            }
+            else if (options?.allowSVG && isSvg(responseBuffer.toString()))
+                return getReturnValue(true);
+        }
+        else
+            return getReturnValue(true);
+    }
+    catch (err) {
+        if (err.code !== 'ETIMEDOUT' && err.code !== 'ENOTFOUND' && err.message !== 'Response code 404 (Not Found)')
+            console.error(err);
+    }
+    return getReturnValue();
+};

package/package.json

@@ -1,39 +1,39 @@
-{
-    "name": "verify-image-url",
-    "version": "1.4.0",
-    "description": "A package to check if a URL is an image URL or not and also get the valid image link from it",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "build": "tsc",
-        "prepare": "npm run build"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/AwesomeStickz/verify-image-url.git"
-    },
-    "keywords": [
-        "image",
-        "url",
-        "check",
-        "verify",
-        "validate"
-    ],
-    "author": "Awesome Stickz",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/AwesomeStickz/verify-image-url/issues"
-    },
-    "homepage": "https://github.com/AwesomeStickz/verify-image-url#readme",
-    "dependencies": {
-        "got": "^11.8.2",
-        "image-type": "^4.1.0",
-        "is-svg": "^4.3.2",
-        "is-url": "^1.2.4",
-        "jsdom": "^16.4.0"
-    },
-    "devDependencies": {
-        "@types/is-url": "^1.2.28",
-        "@types/jsdom": "^16.2.6"
-    }
-}
+{
+    "name": "verify-image-url",
+    "version": "1.5.1",
+    "description": "A package to check if a URL is an image URL or not and also get the valid image link from it",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "scripts": {
+        "build": "tsc",
+        "prepare": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/AwesomeStickz/verify-image-url.git"
+    },
+    "keywords": [
+        "image",
+        "url",
+        "check",
+        "verify",
+        "validate"
+    ],
+    "author": "Awesome Stickz",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/AwesomeStickz/verify-image-url/issues"
+    },
+    "homepage": "https://github.com/AwesomeStickz/verify-image-url#readme",
+    "dependencies": {
+        "cheerio": "^1.2.0",
+        "got": "^11.8.2",
+        "image-type": "^4.1.0",
+        "is-svg": "^6.1.0",
+        "is-url": "^1.2.4"
+    },
+    "devDependencies": {
+        "@types/is-url": "^1.2.28"
+    }
+}

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-export declare const verifyImageURL: (url: string, options?: {
-    allowSVG?: boolean | undefined;
-    proxy?: {
-        url: string;
-        auth: string;
-    } | undefined;
-    timeout?: number | undefined;
-} | undefined) => Promise<{
-    isImage: boolean;
-    imageURL: string;
-}>;